awl/doc/awl.1
Sam Therapy 1b5d5a3fed
Some checks failed
continuous-integration/drone/push Build is failing
Do "a few things"
Signed-off-by: Sam Therapy <sam@samtherapy.net>
2022-07-20 23:14:15 +02:00

168 lines
No EOL
3.4 KiB
Groff

.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "AWL" "1" "2022-07-20"
.PP
.SH NAME
awl - drill, writ small
.PP
.SH SYNOPSIS
\fBawl\fR [ \fIOPTIONS\fR ] \fIname\fR [ \fI@server\fR ] [ \fItype\fR ]
.br
where
.PP
\fIname\fR is the query to make (\fBexample: froth.\&zone\fR)
.br
\fI@server\fR is the server to query (\fBexample: dns.\&froth.\&zone\fR)
.br
\fItype\fR is the DNS resource type (\fBexample: AAAA\fR)
.PP
.SH DESCRIPTION
.PP
\fBawl\fR (\fBa\fRwls \fBw\fRant \fBl\fRicorice) is a simple tool designed to make DNS queries, much like the venerable \fIdig\fR(1).\&
An awl is a tool used to make small holes, typically used in tannery (leatherworking).\&
.PP
Written in Go, \fBawl\fR is designed to be a more "modern" version of \fIdrill\fR(1) by including some more RFCs and output options.\&
\fBawl\fR is still heavily Work-In-Progress so some features may get added or removed.\&
.PP
.SH OPTIONS
.RS 4
\fB-D\fR, \fB--dnssec\fR
.br
Enable DNSSEC.\& This needs to be manually enabled.\&
.PP
\fB--debug\fR
.br
Enable debug logging (currently WIP).\&
.PP
\fB-v\fR
.br
Print the version and exit.\&
.PP
\fB-h\fR
.br
Show a "short" help message.\&
.PP
.RE
.SS Query Options
.RS 4
\fB-4\fR
.br
Only make query over IPv4
.PP
\fB-6\fR
.br
Only make query over IPv6
.PP
\fB-p\fR, \fB--port\fR \fIport\fR
.br
Sets the port to query.\&
.br
.br
\fIDefault Ports\fR:
.RS 4
.PD 0
.IP \(bu 4
\fI53\fR for \fBUDP\fR and \fBTCP\fR
.IP \(bu 4
\fI853\fR for \fBTLS\fR and \fBQUIC\fR
.IP \(bu 4
\fI443\fR for \fBHTTPS\fR
.PD
.PP
.RE
\fB--no-truncate\fR
.br
Ignore UDP truncation (by default, awl \fIretries with TCP\fR)
.PP
\fB-t\fR, \fB--tcp\fR
.br
Use TCP for the query (see \fIRFC 7766\fR)
.PP
\fB-u\fR, \fB--udp\fR
.br
Use UDP for the query (default)
.PP
\fB-T\fR, \fB--tls\fR
.br
Use DNS-over-TLS, implies \fB-t\fR (see \fIRFC 7858\fR)
.PP
\fB-H\fR.\& \fB--https\fR
.br
Use DNS-over-HTTPS (see \fIRFC 8484\fR)
.PP
\fB-Q\fR.\& \fB--quic\fR
.br
Use DNS-over-QUIC (see \fIRFC 9250\fR)
.PP
\fB-x\fR, \fB--reverse\fR
.br
Do a reverse lookup.\& Sets default \fItype\fR to PTR.\&
.br
\fBawl\fR automatically makes an IP or phone number canonical.\&
.PP
.RE
.SS DNS Flags
.PP
.RS 4
\fB--aa\fR
.br
\fISET\fR Authoritative Answer (default: unset)
.PP
\fB--ad\fR
.br
\fISET\fR Authenticated Data (default: unset)
.PP
\fB--tc\fR
.br
\fISET\fR TC (TrunCated) flag (default: not set)
.PP
\fB-z\fR
.br
\fISET\fR Z (Zero) flag (default: not set)
.PP
\fB--cd\fR
.br
\fISET\fR CD (Checking Disabled) flag (default: not set)
.PP
\fB--no-qr\fR
.br
\fIUNSET\fR QR (QueRy) flag (default: set)
.PP
\fB--no-rd\fR
.br
\fIUNSET\fR RD (Recursion Desired) flag (default: set)
.PP
\fB--no-ra\fR
.br
\fIUNSET\fR RA (Recursion Available) flag (default: set)
.PP
.RE
.SS Output Options
.RS 4
\fB-j\fR, \fB--json\fR
.br
Print the query results as JSON.\&
.PP
\fB-X\fR, \fB--xml\fR
.br
Print the query results as XML.\&
.PP
\fB-y\fR, \fB--yaml\fR
.br
Print the query results as YAML.\&
.PP
\fB-s\fR, \fB--short\fR
.br
Print just the results.\&
.br
Equivalent to \fBdig +short\fR
.PP
.RE
.SH SEE ALSO
\fIdrill\fR(1), \fIdig\fR(1), the many DNS RFCs