mirror of
https://github.com/dguglielmi/sunny-overlay.git
synced 2025-12-06 18:12:39 +01:00
143 lines
3.6 KiB
Diff
143 lines
3.6 KiB
Diff
diff '--color=auto' -dNur a/man/dog.1.md b/man/dog.1.md
|
||
--- a/man/dog.1.md 2021-10-07 23:48:48.000000000 +0200
|
||
+++ b/man/dog.1.md 2024-10-26 15:13:28.969309039 +0200
|
||
@@ -1,27 +1,16 @@
|
||
-% dog(1) v0.1.0
|
||
-
|
||
-<!-- This is the dog(1) man page, written in Markdown. -->
|
||
-<!-- To generate the roff version, run `just man`, -->
|
||
-<!-- and the man page will appear in the ‘target’ directory. -->
|
||
-
|
||
-
|
||
-NAME
|
||
-====
|
||
+# dog(1) - a command-line DNS client
|
||
|
||
-dog — a command-line DNS client
|
||
|
||
+## SYNOPSIS
|
||
|
||
-SYNOPSIS
|
||
-========
|
||
+**dog** [<OPTIONS>]... [<DOMAINS>]...
|
||
|
||
-`dog [options] [domains...]`
|
||
+## DESCRIPTION
|
||
|
||
**dog** is a command-line DNS client.
|
||
It has colourful output, supports the DNS-over-TLS and DNS-over-HTTPS protocols, and can emit JSON.
|
||
|
||
-
|
||
-EXAMPLES
|
||
-========
|
||
+## EXAMPLES
|
||
|
||
`dog example.net`
|
||
: Query the `A` record of a domain using default settings
|
||
@@ -38,9 +27,7 @@
|
||
`dog -q example.net -t MX -n 1.1.1.1 -T`
|
||
: As above, but using explicit arguments
|
||
|
||
-
|
||
-QUERY OPTIONS
|
||
-=============
|
||
+## QUERY OPTIONS
|
||
|
||
`-q`, `--query=HOST`
|
||
: Host name or domain name to query.
|
||
@@ -62,9 +49,7 @@
|
||
|
||
DNS traditionally uses port 53 for both TCP and UDP. To use a resolver with a different port, include the port number after a colon (`:`) in the nameserver address.
|
||
|
||
-
|
||
-SENDING OPTIONS
|
||
-===============
|
||
+## SENDING OPTIONS
|
||
|
||
`--edns=SETTING`
|
||
: Whether to opt in to DNS. This can be ‘`disable`’, ‘`hide`’, or ‘`show`’.
|
||
@@ -76,8 +61,7 @@
|
||
: Set uncommon protocol-level tweaks.
|
||
|
||
|
||
-TRANSPORT OPTIONS
|
||
-=================
|
||
+## TRANSPORT OPTIONS
|
||
|
||
`-U`, `--udp`
|
||
: Use the DNS protocol over UDP.
|
||
@@ -100,8 +84,7 @@
|
||
Unlike the others, the HTTPS transport type requires an entire URL, complete with protocol, domain name, and path.
|
||
|
||
|
||
-OUTPUT OPTIONS
|
||
-==============
|
||
+## OUTPUT OPTIONS
|
||
|
||
`-1`, `--short`
|
||
: Short mode: display nothing but the first result.
|
||
@@ -119,8 +102,7 @@
|
||
: Print how long the response took to arrive.
|
||
|
||
|
||
-META OPTIONS
|
||
-============
|
||
+## META OPTIONS
|
||
|
||
`--help`
|
||
: Displays an overview of the command-line options.
|
||
@@ -129,18 +111,15 @@
|
||
: Displays the version of dog being invoked.
|
||
|
||
|
||
-ENVIRONMENT VARIABLES
|
||
-=====================
|
||
+## ENVIRONMENT VARIABLES
|
||
|
||
dog responds to the following environment variables:
|
||
|
||
-## `DOG_DEBUG`
|
||
-
|
||
-Set this to any non-empty value to have dog emit debugging information to standard error. For more in-depth output, set this to the exact string ‘`trace`’.
|
||
+`DOG_DEBUG`
|
||
+: Set this to any non-empty value to have dog emit debugging information to standard error. For more in-depth output, set this to the exact string ‘`trace`’.
|
||
|
||
|
||
-RECORD TYPES
|
||
-============
|
||
+## RECORD TYPES
|
||
|
||
dog understands and can interpret the following record types:
|
||
|
||
@@ -199,8 +178,7 @@
|
||
dog also contains a list of record type names that it knows the type number of, but is not able to interpret, such as `IXFR` or `ANY` or `AFSDB`. These are acceptable as command-line arguments, meaning you can send an AFSDB request with ‘`dog AFSDB`’. However, their response contents will still be displayed as numbers. They may be supported in future versions of dog.
|
||
|
||
|
||
-PROTOCOL TWEAKS
|
||
-===============
|
||
+## PROTOCOL TWEAKS
|
||
|
||
The `-Z` command-line argument can be used one or more times to set some protocol-level options in the DNS queries that get sent. It accepts the following values:
|
||
|
||
@@ -217,8 +195,7 @@
|
||
: Sets the `CD` (Checking Disabled) bit in the query.
|
||
|
||
|
||
-EXIT STATUSES
|
||
-=============
|
||
+## EXIT STATUSES
|
||
|
||
0
|
||
: If everything goes OK.
|
||
@@ -235,9 +212,7 @@
|
||
4
|
||
: If there was a problem obtaining the system nameserver information.
|
||
|
||
-
|
||
-AUTHOR
|
||
-======
|
||
+## AUTHOR
|
||
|
||
dog is maintained by Benjamin ‘ogham’ Sago.
|
||
|