From 96f2699a2f22a5bdcf37a48d0a20fd85c96bcc81 Mon Sep 17 00:00:00 2001 From: Sam Therapy Date: Mon, 5 Sep 2022 01:32:09 +0200 Subject: [PATCH] update wiki Signed-off-by: Sam Therapy --- Dig.md | 23 +++++++++++---------- Doggo.md | 32 ++++++++++++++--------------- Q.md | 4 ++-- awl.1.md | 62 ++++++++++++++++++++++++++++++++++++-------------------- 4 files changed, 70 insertions(+), 51 deletions(-) diff --git a/Dig.md b/Dig.md index 682e71d..8b1e0bb 100644 --- a/Dig.md +++ b/Dig.md @@ -37,9 +37,9 @@ Flags and `-flags` taken from the | `+[no]authority` | Yes, 0.2.0 and newer | | `+[no]badcookie` | No | | `+[no]besteffort` | No | -| `+bufsize` | Yes, | +| `+bufsize` | Yes, 0.3.0 and newer | | `+[no]cdflag` | Yes, 0.2.0 and newer | -| `+[no]class` | No | +| `+[no]class` | Yes | | `+[no]cmd` | No | | `+[no]comments` | Yes, | | `+[no]cookie` | Yes, | @@ -48,34 +48,35 @@ Flags and `-flags` taken from the | `+[no]dnssec` | Yes, 0.2.0 and newer | | `+[no]domain` | No | | `+[no]edns` | Yes, setting versions as well | -| `+ednsflags` | Yes | +| `+ednsflags` | Yes, 0.3.0 and newer | | `+[no]expire` | Yes, not displayed | | `+[no]fail` | No, will not query more on SERVFAIL | -| `+[no]idnout` | Somewhat, only JSON/XML/YAML | +| `+[no]idnin` | Yes, automatically (no flag set) | +| `+[no]idnout` | Yes | | `+[no]ignore` | Yes, 0.2.0 and newer | -| `+[no]keepopen` | Yes, | +| `+[no]keepopen` | Yes, 0.3.0 and newer | | `+[no]multiline` | No | | `+ndots` | No | -| `+[no]nsid` | Yes, | +| `+[no]nsid` | Yes, 0.3.0 and newer | | `+[no]nssearch` | No | | `+[no]onesoa` | No | | `+[no]opcode` | No | -| `+[no]qr` | Yes, | +| `+[no]qr` | Yes, 0.3.0 and newer | | `+[no]question` | Yes, 0.2.0 and newer | | `+[no]rdflag` | Yes, 0.2.0 and newer | | `+[no]recurse` | Yes, 0.2.0 and newer | -| `+[no]retry` | Yes, 0.2.0 and newer | +| `+retry` | Yes, 0.2.0 and newer | | `+[no]rrcomments` | No | | `+[no]search` | No | | `+[no]short` | Yes, 0.2.0 and newer | | `+[no]showsearch` | No | | `+[no]split` | No | | `+[no]stats` | Yes, 0.2.0 and newer | -| `+[no]subnet` | Yes | +| `+[no]subnet` | Yes, 0.3.0 and newer | | `+[no]tcp` | Yes, 0.2.0 and newer | | `+timeout` | Yes, 0.2.0 and newer | | `+[no]trace` | No | | `+tries` | Yes, 0.2.0 and newer | -| `+[no]ttlid` | Somewhat, only JSON/XML/YAML | -| `+[no]ttlunits` | Yes, | +| `+[no]ttlid` | Yes | +| `+[no]ttlunits` | Yes | | `+[no]vc` | Yes, 0.2.0 and newer | diff --git a/Doggo.md b/Doggo.md index 143d49f..5add54c 100644 --- a/Doggo.md +++ b/Doggo.md @@ -4,13 +4,13 @@ ### Query Options -| Option | Supported? | -| -------------------- | ----------------------------------------- | -| `-q`, `--query` | Yes, 0.2.0 and newer | -| `-t`, `--type` | Yes, as `--q`, `--qType`, 0.2.0 and newer | -| `-n`, `--nameserver` | No | -| `-c`, `--class` | Yes, 0.2.0 and newer | -| `-x`, `--reverse` | Yes, 0.2.0 and newer | +| Option | Supported? | +| -------------------- | ---------------------------------------- | +| `-q`, `--query` | Yes, 0.2.0 and newer | +| `-t`, `--type` | Yes, as `-t`, `--qType`, 0.2.0 and newer | +| `-n`, `--nameserver` | No | +| `-c`, `--class` | Yes, 0.2.0 and newer | +| `-x`, `--reverse` | Yes, 0.2.0 and newer | ### Resolver Options @@ -20,15 +20,15 @@ | `--ndots` | No | | `--search` | No | | `--timeout` | Yes, 0.2.0 and newer | -| `--tls-hostname` | No | -| `--skip-hostname-verification` | No | +| `--tls-hostname` | Yes, 0.3.0 and newer | +| `--skip-hostname-verification` | Yes, 0.3.0 and newer | ### Output Options -| Option | Supported? | -| ------------- | ------------------------------------------ | -| `-J`, `-json` | Yes, `-j`,instead of `-J`, 0.2.0 and newer | -| `--short` | Yes, 0.2.0 and newer | -| `--color` | NO | -| `--debug` | No, use `-v` for verbosity instead | -| `--time` | No | +| Option | Supported? | +| ------------- | ---------------------------------- | +| `-J`, `-json` | Yes, `-j`,instead, 0.2.0 and newer | +| `--short` | Yes, 0.2.0 and newer | +| `--color` | NO | +| `--debug` | No, use `-v` for verbosity instead | +| `--time` | No | diff --git a/Q.md b/Q.md index 2945bed..80490a5 100644 --- a/Q.md +++ b/Q.md @@ -11,8 +11,8 @@ | `-t` | Yes, 0.2.0 and newer | | `-x` | Yes, 0.2.0 and newer | | `-d` | Yes, as -D, 0.2.0 and newer | -| `-n` | Yes | -| `--subnet` | Yes, as `+subnet` | +| `-n` | Yes, 0.3.0 and newer | +| `--subnet` | Yes, as `+subnet`, 0.3.0 and newer | | `-c` | No, use `-t` CH instead | | `-p` | No | | `--timeout` | Yes, 0.2.0 and newer | diff --git a/awl.1.md b/awl.1.md index 5b56f0c..0994e2d 100644 --- a/awl.1.md +++ b/awl.1.md @@ -44,8 +44,10 @@ Anything in \[brackets\] is optional. > - *2*: Log information **Default when specifying just** *-v*. > > - *3*: Log information useful for debugging. - -Setting a value lower than 0 disables logging entirely. +> +> Setting a value lower than 0 disables logging entirely. +> +> By default, specifying just **-v** sets the verbosity to 2 (info). **-V** @@ -93,7 +95,7 @@ Setting a value lower than 0 disables logging entirely. **--tcp**, **+tcp**, **+vc** -> Use TCP for the query (see **RFC 7766**). +> Use TCP for the query (see RFC 7766). **--dnscrypt**, **+dnscrypt** @@ -101,7 +103,7 @@ Setting a value lower than 0 disables logging entirely. **-T**, **--tls**, **+tls** -> Use DNS-over-TLS, implies *--tcp* (see **RFC 7858**) +> Use DNS-over-TLS, implies **--tcp** (see RFC 7858) **--tls-host** *string* @@ -114,11 +116,11 @@ Setting a value lower than 0 disables logging entirely. **-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** @@ -136,41 +138,41 @@ Setting a value lower than 0 disables logging entirely. ## 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** @@ -209,9 +211,8 @@ All of these options except disabling EDNS imply *+edns*. **--subnet** *ip*\[*/prefix*\], **+\[no\]subnet**=*ip*\[*/prefix*\] -> Send an EDNS Client Subnet option with the specified address. +> 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. @@ -260,6 +261,11 @@ All of these options except disabling EDNS imply *+edns*. > 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 awl grumbulon.xyz -j +cd @@ -278,11 +284,23 @@ 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. + +Some features only work when outputting to JSON/XML/YAML. + +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*