(feat)Completions and documentation #78

Merged
sam merged 10 commits from completions-et-al into master 2022-09-04 23:28:48 +00:00
Showing only changes of commit 3a4256fb37 - Show all commits

View file

@ -41,8 +41,11 @@ Anything in [brackets] is optional.
- _1_: Log warnings. *This is the default.*
- _2_: Log information *Default when specifying just* _-v_.
- _3_: Log information useful for debugging.
Setting a value lower than 0 disables logging entirely.
By default, specifying just *-v* sets the verbosity to 2 (info).
*-V*
Print the version and exit.
@ -78,13 +81,13 @@ Anything in [brackets] is optional.
Ignore UDP truncation (by default, awl *retries with TCP*).
*--tcp*, *+tcp*, *+vc*
Use TCP for the query (see *RFC 7766*).
Use TCP for the query (see RFC 7766).
*--dnscrypt*, *+dnscrypt*
Use DNSCrypt.
*-T*, *--tls*, *+tls*
Use DNS-over-TLS, implies _--tcp_ (see *RFC 7858*)
Use DNS-over-TLS, implies *--tcp* (see RFC 7858)
*--tls-host* _string_
Set hostname to use for TLS certificate validation.
@ -94,10 +97,10 @@ Anything in [brackets] is optional.
Ignore TLS validation when performing a DNS query.
*-H*. *--https*, *+https*
Use DNS-over-HTTPS (see *RFC 8484*).
Use DNS-over-HTTPS (see RFC 8484).
*-Q*. *--quic*, *+quic*
Use DNS-over-QUIC (see *RFC 9250*).
Use DNS-over-QUIC (see RFC 9250).
*-x*, *--reverse*
Do a reverse lookup. Sets default *type* to PTR.
@ -113,32 +116,32 @@ Anything in [brackets] is optional.
## DNS Flags
*--aa*=[_false_], *+[no]aaflag*
*--aa*[=_bool_], *+[no]aaflag*
(Set, Unset) AA (Authoritative Answer) flag.
*--ad*=[_false_], *+[no]adflag*
*--ad*[=_bool_], *+[no]adflag*
(Set, Unset) AD (Authenticated Data) flag.
*--tc*=[_false_], *+[no]tcflag*
*--tc*[=_bool_], *+[no]tcflag*
(Set, Unset) TC (TrunCated) flag
*-z*=[_false_], *+[no]zflag*
*-z*[=_bool_], *+[no]zflag*
(Set, Unset) Z (Zero) flag.
*--cd*=[_false_], *+[no]cdflag*
*--cd*[=_bool_], *+[no]cdflag*
(Set, Unset) CD (Checking Disabled) flag.
*--qr*=[_false_], *+[no]qrflag*
*--qr*[=_bool_], *+[no]qrflag*
(Set, Unset) QR (QueRy) flag.
*--rd*=[_true_], *+[no]rdflag*
*--rd*[=_bool_], *+[no]rdflag*
(Set, Unset) RD (Recursion Desired) flag.
*--ra*=[_false_], *+[no]raflag*
*--ra*[=_bool_], *+[no]raflag*
(Set, Unset) RA (Recursion Available) flag.
## EDNS
All of these options except disabling EDNS imply _+edns_.
All of these options except disabling EDNS imply *+edns*.
*--no-edns*, *+noedns*
Disable EDNS.
@ -172,9 +175,9 @@ All of these options except disabling EDNS imply _+edns_.
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.
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
@ -210,6 +213,11 @@ Like *dig*(1), setting the IP to _0.0.0.0/0_, _::/0_ or _0_ will signal the reso
*-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.
# EXAMPLES
```
@ -233,10 +241,22 @@ Query dns.google over TLS for the PTR record to the IP address 8.8.4.4
# SEE ALSO
*drill*(1), *dig*(1), the many DNS RFCs
(https://www.statdns.com/rfc/)
*drill*(1), *dig*(1)
# STANDARDS
RFC 1034,1035 (UDP), 7766 (TCP), 7858 (TLS), 8484 (HTTPS), 9230 (QUIC)
Probably more, _https://www.statdns.com/rfc_
# BUGS
Likely numerous, report them either to https://git.froth.zone/sam/awl/issues
or via email ~sammefishe/awl-dev@lists.sr.ht
OPT records are only printed when using a standard output, not JSON/XML/YAML.
Full parity with *dig*(1) is not complete.
This man page is probably 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_