infrastructure
/
dns-landing-page
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update manpage 

Signed-off-by: Sam Therapy <sam@samtherapy.net>
This commit is contained in:
Sam Therapy 2022-10-13 16:41:52 +02:00
parent ccbb39bbea
commit 8c70232b4b
Signed by: sam
GPG Key ID: 4D8B07C18F31ACBD
1 changed files with 225 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

366
awl/man.txt
View File

@ -1,225 +1,309 @@
awl(1) General Commands Manual awl(1)
NAME
awl - DNS lookup tool
awl - DNS lookup tool
SYNOPSIS
awl [ OPTIONS ] name [ @server ] [ type ], where
name is the query to make (example: froth.zone)
@server is the server to query (example: dns.froth.zone)
type is the DNS resource type (example: AAAA)
awl [ OPTIONS ] name [ @server ] [ type ], where
name is the query to make (example: froth.zone)
@server is the server to query (example: dns.froth.zone)
type is the DNS resource type (example: AAAA)
DESCRIPTION
awl (awls want licorice) is a simple tool designed to make DNS queries, much like the venerable dig(1). An awl is a tool used to make small holes, typically used in leatherworking.
awl is designed to be a more "modern" version of drill(1) by including some more recent RFCs and output options.
awl (awls want licorice) is a simple tool designed to make DNS queries,
much like the venerable dig(1). An awl is a tool used to make small
holes, typically used in leatherworking.
When no arguments are given, awl will perform an NS query on the root ('.').
awl is designed to be a more "modern" version of drill(1) by including
some more recent RFCs and output options.
When a nameserver is not given, awl will query a random system nameserver. If one cannot be found, awl will query localhost.
When no arguments are given, awl will perform an NS query on the root
('.').
When a nameserver is not given, awl will query a random system
nameserver. If one cannot be found, awl will query localhost.
OPTIONS
Anything in [brackets] is optional.
-D, --dnssec, +dnssec
Enable DNSSEC. This needs to be manually enabled.
Anything in [brackets] is optional.
-v[=int]
Set verbosity Accepted values are as follows:
o 0: Only log errors.
o 1: Log warnings. This is the default.
o 2: Log information Default when specifying just -v.
o 3: Log information useful for debugging.
-D, --dnssec, +dnssec
Setting a value lower than 0 disables logging entirely.
Enable DNSSEC. This needs to be manually enabled.
By default, specifying just -v sets the verbosity to 2 (info).
-v[=int]
-V
Print the version and exit.
Set verbosity Accepted values are as follows:
-h
Show a "short" help message.
- 0: Only log errors.
Query Options
-4
Only make query over IPv4
- 1: Log warnings. This is the default.
-6
Only make query over IPv6
- 2: Log information Default when specifying just -v.
-p, --port port
Sets the port to query. Default ports listed below.
o 53 for UDP and TCP
o 853 for TLS and QUIC
o 443 for HTTPS
- 3: Log information useful for debugging.
-q, --query domain
Domain to query (eg. example.com)
Setting a value lower than 0 disables logging entirely.
-c, --class class
DNS class to query (eg. IN, CH) The default is IN.
By default, specifying just -v sets the verbosity to 2 (info).
-t, --qType type
DNS type to query (eg. A, AAAA, NS) The default is A.
-V
--no-truncate, +ignore
Ignore UDP truncation (by default, awl retries with TCP).
Print the version and exit.
--no-bad-cookie, +[no]badcookie
[Do not] ignore BADCOOKIE responses
-h
--tcp, +tcp, +vc
Use TCP for the query (see RFC 7766).
Show a "short" help message.
--dnscrypt, +dnscrypt
Use DNSCrypt.
Query Options
-T, --tls, +tls
Use DNS-over-TLS, implies --tcp (see RFC 7858)
-4
--tls-host string
Set hostname to use for TLS certificate validation. Default is the name of the domain when querying over TLS, and empty for IPs.
Only make query over IPv4
--tls-no-verify
Ignore TLS validation when performing a DNS query.
-6
-H. --https, +https
Use DNS-over-HTTPS (see RFC 8484).
Only make query over IPv6
-Q. --quic, +quic
Use DNS-over-QUIC (see RFC 9250).
-p, --port port
-x, --reverse
Do a reverse lookup. Sets default type to PTR. awl automatically makes an IP or phone number canonical.
Sets the port to query. Default ports listed below.
--timeout seconds, +timeout=seconds
Set the timeout period. Floating point numbers are accepted. 0.5 seconds is the minimum.
- 53 for UDP and TCP
--retries int, +tries=int, +retry=int
Set the number of retries. Retry is one more than tries, dig style.
- 853 for TLS and QUIC
DNS Flags
--aa[=bool], +[no]aaflag
(Set, Unset) AA (Authoritative Answer) flag.
- 443 for HTTPS
--ad[=bool], +[no]adflag
(Set, Unset) AD (Authenticated Data) flag.
-q, --query domain
--tc[=bool], +[no]tcflag
(Set, Unset) TC (TrunCated) flag
Domain to query (eg. example.com)
-z[=bool], +[no]zflag
(Set, Unset) Z (Zero) flag.
-c, --class class
--cd[=bool], +[no]cdflag
(Set, Unset) CD (Checking Disabled) flag.
DNS class to query (eg. IN, CH) The default is IN.
--qr[=bool], +[no]qrflag
(Set, Unset) QR (QueRy) flag.
-t, --qType type
--rd[=bool], +[no]rdflag
(Set, Unset) RD (Recursion Desired) flag.
DNS type to query (eg. A, AAAA, NS) The default is A.
--ra[=bool], +[no]raflag
(Set, Unset) RA (Recursion Available) flag.
--no-truncate, +ignore
EDNS
All of these options except disabling EDNS imply +edns.
Ignore UDP truncation (by default, awl retries with TCP).
--no-edns, +noedns
Disable EDNS.
--no-bad-cookie, +[no]badcookie
--edns-ver, +edns[=int]
Enable EDNS and set EDNS version. The maximum value is 255, and the minimum (default) value is 0.
[Do not] ignore BADCOOKIE responses
--expire. +[no]expire
Send an EDNS Expire.
--tcp, +tcp, +vc
--nsid, +[no]nsid
Send an EDNS name server ID request.
Use TCP for the query (see RFC 7766).
--no-cookie, +[no]cookie[=string]
Send an EDNS cookie. This is enabled by default with a random string.
--dnscrypt, +dnscrypt
--keep-alive, +[no]keepalive, +[no]keepopen
Send an EDNS keep-alive. This does nothing unless using TCP.
Use DNSCrypt.
--buffer-size int, +bufize=int
Set the UDP message buffer size, using EDNS. Max is 65535, minimum is zero. The default value is 1232.
-T, --tls, +tls
--zflag int, +ednsflags=int
Set the must-be-zero EDNS flags. Decimal, hexadecimal and octal are supported. Trying to set DO will be ignored.
Use DNS-over-TLS, implies --tcp (see RFC 7858)
--subnet ip[/prefix], +[no]subnet=ip[/prefix]
Send an EDNS Client Subnet option with the specified address.
--tls-host string
Like dig(1), setting the IP to 0.0.0.0/0, ::/0 or 0 will signal the resolver to not use any client information when returning the query.
Set hostname to use for TLS certificate validation. Default is the
name of the domain when querying over TLS, and empty for IPs.
Output Display
--no-question, +[no]question
Toggle the display of the Question section.
--tls-no-verify
--no-answer, +[no]answer
Toggle the display of the Answer section.
Ignore TLS validation when performing a DNS query.
--no-answer, +[no]answer
Toggle the display of the Answer section.
-H. --https, +https
--no-authority, +[no]authority
Toggle the display of the Authority section.
Use DNS-over-HTTPS (see RFC 8484).
--no-additional, +[no]additional
Toggle the display of the Additional section.
-Q. --quic, +quic
--no-statistics, +[no]stats
Toggle the display of the Statistics (additional comments) section.
Use DNS-over-QUIC (see RFC 9250).
Output Formats
-j, --json, +json
Print the query results as JSON.
-x, --reverse
-X, --xml, +xml
Print the query results as XML.
Do a reverse lookup. Sets default type to PTR. awl automatically makes
an IP or phone number canonical.
-y, --yaml, +yaml
Print the query results as YAML.
--timeout seconds, +timeout=seconds
-s, --short, +short
Print just the address of the answer.
Set the timeout period. Floating point numbers are accepted. 0.5
seconds is the minimum.
--retries int, +tries=int, +retry=int
Set the number of retries. Retry is one more than tries, dig style.
DNS Flags
--aa[=bool], +[no]aaflag
(Set, Unset) AA (Authoritative Answer) flag.
--ad[=bool], +[no]adflag
(Set, Unset) AD (Authenticated Data) flag.
--tc[=bool], +[no]tcflag
(Set, Unset) TC (TrunCated) flag
-z[=bool], +[no]zflag
(Set, Unset) Z (Zero) flag.
--cd[=bool], +[no]cdflag
(Set, Unset) CD (Checking Disabled) flag.
--qr[=bool], +[no]qrflag
(Set, Unset) QR (QueRy) flag.
--rd[=bool], +[no]rdflag
(Set, Unset) RD (Recursion Desired) flag.
--ra[=bool], +[no]raflag
(Set, Unset) RA (Recursion Available) flag.
EDNS
All of these options except disabling EDNS imply +edns.
--no-edns, +noedns
Disable EDNS.
--edns-ver, +edns[=int]
Enable EDNS and set EDNS version. The maximum value is 255, and the
minimum (default) value is 0.
--expire. +[no]expire
Send an EDNS Expire.
--nsid, +[no]nsid
Send an EDNS name server ID request.
--no-cookie, +[no]cookie[=string]
Send an EDNS cookie. This is enabled by default with a random string.
--keep-alive, +[no]keepalive, +[no]keepopen
Send an EDNS keep-alive. This does nothing unless using TCP.
--buffer-size int, +bufize=int
Set the UDP message buffer size, using EDNS. Max is 65535, minimum is
zero. The default value is 1232.
--zflag int, +ednsflags=int
Set the must-be-zero EDNS flags. Decimal, hexadecimal and octal are
supported. Trying to set DO will be ignored.
--subnet ip[/prefix], +[no]subnet=ip[/prefix]
Send an EDNS Client Subnet option with the specified address.
Like dig(1), setting the IP to 0.0.0.0/0, ::/0 or 0 will signal the
resolver to not use any client information when returning the query.
Output Display
--no-question, +[no]question
Toggle the display of the Question section.
--no-answer, +[no]answer
Toggle the display of the Answer section.
--no-answer, +[no]answer
Toggle the display of the Answer section.
--no-authority, +[no]authority
Toggle the display of the Authority section.
--no-additional, +[no]additional
Toggle the display of the Additional section.
--no-statistics, +[no]stats
Toggle the display of the Statistics (additional comments) section.
Output Formats
-j, --json, +json
Print the query results as JSON.
-X, --xml, +xml
Print the query results as XML.
-y, --yaml, +yaml
Print the query results as YAML.
-s, --short, +short
Print just the address of the answer.
EXIT STATUS
The exit code is 0 when a query is successfully made and received. This includes SERVFAILs, NOTIMPL among others.
The exit code is 0 when a query is successfully made and received. This
includes SERVFAILs, NOTIMPL among others.
EXAMPLES
awl grumbulon.xyz -j +cd
Run a query of your local resolver for the A records of grumbulon.xyz, print them as JSON and disable DNSSEC verification.
awl grumbulon.xyz -j +cd
awl +short example.com AAAA @1.1.1.1
Run a query of your local resolver for the A records of grumbulon.xyz,
print them as JSON and disable DNSSEC verification.
Query 1.1.1.1 for the AAAA records of example.com, print just the answers
awl +short example.com AAAA @1.1.1.1
awl -xT PTR 8.8.4.4 @dns.google
Query 1.1.1.1 for the AAAA records of example.com, print just the
answers
Query dns.google over TLS for the PTR record to the IP address 8.8.4.4
awl -xT PTR 8.8.4.4 @dns.google
Query dns.google over TLS for the PTR record to the IP address 8.8.4.4
SEE ALSO
drill(1), dig(1)
drill(1), dig(1)
STANDARDS
RFC 1034,1035 (UDP), 7766 (TCP), 7858 (TLS), 8484 (HTTPS), 9230 (QUIC)
Probably more, https://www.statdns.com/rfc
RFC 1034,1035 (UDP), 7766 (TCP), 7858 (TLS), 8484 (HTTPS), 9230 (QUIC)
Probably more, https://www.statdns.com/rfc
BUGS
OPT records are only printed when using a standard output, not JSON/XML/YAML.
Full parity with dig(1) is not complete.
OPT records are only printed when using a standard output, not
JSON/XML/YAML.
This man page is probably not complete.
Full parity with dig(1) is not complete.
Likely numerous more, report them either to the tracker https://git.froth.zone/sam/awl/issues or via email ~sammefishe/awl-dev@lists.sr.ht
This man page is probably not complete.
2022-09-24 awl(1)
Likely numerous more, report them either to the tracker
https://git.froth.zone/sam/awl/issues or via email
~sammefishe/awl-dev@lists.sr.ht