Commit 576d5169 authored by Daniel Salzman's avatar Daniel Salzman

man: add slash before hyphen

parent 398ec9af
......@@ -4,19 +4,19 @@
\- Advanced DNS lookup utility (libknot equivalent of ISC dig)
.SH SYNOPSIS
.B kdig
[\fIcommon-settings\fR] [\fIquery\fR [\fIsettings\fR]]...
[\fIcommon\-settings\fR] [\fIquery\fR [\fIsettings\fR]]...
.TP 5
.B kdig
\fB-h\fR
\fB\-h\fR
.SH DESCRIPTION
This utility sends one or more DNS \fIqueries\fR to a nameserver. Each query can
have individual \fIsettings\fR, or it can be specified globally via \fIcommon-settings\fR,
have individual \fIsettings\fR, or it can be specified globally via \fIcommon\-settings\fR,
which must precede \fIquery\fR specification.
.TP 4
\fIquery
\fIname\fR | \fB-q\fR \fIname\fR | \fB-x\fR \fIaddress\fR
\fIname\fR | \fB\-q\fR \fIname\fR | \fB\-x\fR \fIaddress\fR
.TP
\fIcommon-settings, settings
\fIcommon\-settings, settings
[\fIclass\fR] [\fItype\fR] [\fB@\fIserver\fR]... [\fIoptions\fR]
.TP
\fIname\fR
......@@ -30,52 +30,52 @@ the servers from \fB/etc/resolv.conf\fR are used.
If no arguments are provided, \fBkdig\fR sends \fINS\fR query for root zone.
.SH OPTIONS
.TP 4
.BI -4
.BI \-4
Use IPv4 protocol only.
.TP
.BI -6
.BI \-6
Use IPv6 protocol only.
.TP
.BI -b \ address
.BI \-b \ address
Set the source IP address of the query to \fIaddress\fR. The address
can be specified using [address]:port notation.
.TP
.BI -c \ class
.BI \-c \ class
Set query class (e.g. \fICH\fR, \fICLASS4\fR).
An explicit variant of \fIclass\fR specification.
The default class is \fIIN\fR.
.TP
.BI -d
.BI \-d
Enable debug messages if any.
.TP
\fB\-h\fR, \fB\-\-help\fR
Print short help.
.TP
.BI -k \ keyfile
.BI \-k \ keyfile
Use TSIG or SIG\-0 key stored in a file \fIkeyfile\fR to authenticate the request.
Supported file format is the same as generated by ISC \fBdnssec\-keygen\fR.
The key comprises of public (.key extension) and private part (.private extension).
Either of these file names or a name without the extension can be specified as \fIkeyfile\fR
parameter.
.TP
.BI -p \ port
.BI \-p \ port
Set nameserver port number or service name to send a query to.
The default port is \fI53\fR.
.TP
.BI -q \ name
.BI \-q \ name
Set query name. An explicit variant of \fIname\fR specification.
.TP
.BI -t \ type
.BI \-t \ type
Set query type (e.g. \fINS\fR, \fIIXFR=12345\fR, \fITYPE65535\fR).
An explicit variant of \fItype\fR specification. The default type is \fIA\fR.
.TP
\fB\-v\fR, \fB\-\-version\fR
Print program version.
.TP
.BI -x \ address
.BI \-x \ address
Send \fIPTR\fR query for IPv4 or IPv6 \fIaddress\fR.
.TP
.BI -y \ \fR[\fIalgo:\fR]\fIkeyname:key\fR
.BI \-y \ \fR[\fIalgo:\fR]\fIkeyname:key\fR
Use TSIG key with a name \fIkeyname\fR to authenticate the request. The \fIalgo\fR
part specifies the algorithm (the default is hmac\-md5) and \fIkey\fR specifies
the shared secret encoded in Base64.
......@@ -170,7 +170,7 @@ Don't use TCP automatically if truncated reply is received.
\fB+\fR[\fBno\fR]\fBnsid\fR
Request nameserver identifier (NSID).
.SH NOTE
Options \fB-k\fR and \fB-y\fR cannot be used mutually.
Options \fB\-k\fR and \fB\-y\fR cannot be used mutually.
.SH EXAMPLES
.B Example 1. Get A record for example.com:
.TP
......@@ -178,18 +178,18 @@ Options \fB-k\fR and \fB-y\fR cannot be used mutually.
.TP
.B Example 2. Perform AXFR for zone example.com from the server 192.0.2.1:
.TP
# kdig example.com -t AXFR @192.0.2.1
# kdig example.com \-t AXFR @192.0.2.1
.TP 12
.B Example 3. Send one A query for example.com from 192.0.2.1 and one reverse \
lookup for address 2001:DB8::1 from 192.0.2.2. Both using TCP protocol:
.TP
# kdig +tcp example.com -t A @192.0.2.1 -x 2001:DB8::1 @192.0.2.2
# kdig +tcp example.com \-t A @192.0.2.1 \-x 2001:DB8::1 @192.0.2.2
.SH FILES
.BI /etc/resolv.conf
.SH AUTHOR
Daniel Salzman (\fBhttp://knot-dns.cz\fR)
Daniel Salzman (\fBhttp://knot\-dns.cz\fR)
.TP
Please send any bugs or comments to \fBknot-dns@labs.nic.cz\fR
Please send any bugs or comments to \fBknot\-dns@labs.nic.cz\fR
.SH SEE ALSO
.BI khost\fR(1),
.BI knsupdate\fR(1).
......@@ -7,7 +7,7 @@
[\fIoptions\fR] \fIname\fR [\fIserver\fR]
.SH DESCRIPTION
This utility sends a DNS query for the \fIname\fR to the \fIserver\fR and prints
a reply in more user-readable form. For more advanced DNS queries use \fBkdig\fR instead.
a reply in more user\-readable form. For more advanced DNS queries use \fBkdig\fR instead.
.TP 4
\fI name\fR
Is a domain name that is to be looked up.
......@@ -21,50 +21,50 @@ the servers from \fB/etc/resolv.conf\fR are used.
If no arguments are provided, \fBkhost\fR prints short help.
.SH OPTIONS
.TP 4
.BI -4
.BI \-4
Use IPv4 protocol only.
.TP
.BI -6
.BI \-6
Use IPv6 protocol only.
.TP
.BI -a
.BI \-a
Send ANY query with verbose mode.
.TP
.BI -d
.BI \-d
Enable debug messages if any.
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help.
.TP
.BI -r
.BI \-r
Disable recursion.
.TP
.BI -s
.BI \-s
Stop quering next nameserver if SERVFAIL response is received.
.TP
.BI -T
.BI \-T
Use TCP protocol.
.TP
.BI -v
.BI \-v
Enable verbose output.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print program version.
.TP
.BI -w
.BI \-w
Wait forever for the reply.
.TP
.BI -c \ class
.BI \-c \ class
Set query class (e.g. \fICH\fR, \fICLASS4\fR). The default class is \fIIN\fR.
.TP
.BI -t \ type
.BI \-t \ type
Set query type (e.g. \fINS\fR, \fIIXFR=12345\fR, \fITYPE65535\fR).
The default is to send 3 queries (\fIA\fR, \fIAAAA\fR and \fIMX\fR).
.TP
.BI -R \ retries
.BI \-R \ retries
The number of UDP retries to query a nameserver. The default is \fI1\fR.
.TP
.BI -W \ wait
.BI \-W \ wait
The time to wait for a reply in seconds. The default is \fI2\fR seconds.
.SH EXAMPLES
.B Example 1. Get A, AAAA and MX records for example.com:
......@@ -77,13 +77,13 @@ The time to wait for a reply in seconds. The default is \fI2\fR seconds.
.TP
.B Example 3. Perform verbose zone transfer for zone example.com:
.TP
# khost -t AXFR -v example.com
# khost \-t AXFR \-v example.com
.SH FILES
.BI /etc/resolv.conf
.SH AUTHOR
Daniel Salzman (\fBhttp://knot-dns.cz\fR)
Daniel Salzman (\fBhttp://knot\-dns.cz\fR)
.TP
Please send any bugs or comments to \fBknot-dns@labs.nic.cz\fR
Please send any bugs or comments to \fBknot\-dns@labs.nic.cz\fR
.SH SEE ALSO
.BI kdig\fR(1),
.BI knsupdate\fR(1).
......@@ -17,8 +17,8 @@
\fB\-y\fR [hmac:]name:key]\fR Use key_id for specified on the command line.
.TP
\fB\-k\fR [file]\fR Use key file (as in config section 'keys').
f.e. echo "knotc-key hmac-md5 Wg==" > knotc.key
If you omit algorithm, hmac-md5 will be used as default.
f.e. echo "knotc\-key hmac\-md5 Wg==" > knotc.key
If you omit algorithm, hmac\-md5 will be used as default.
.TP
\fB\-f\fR, \fB\-\-force\fR
Force operation \- override some checks.
......@@ -76,17 +76,17 @@ Estimate memory consumption for zone files. Useful mainly for big zones.
.B Setup a keyfile for remote control
.TP
1. Generate keys
dnssec-keygen -a hmac-md5 -b 256 -n HOST knotc-key
dnssec\-keygen \-a hmac\-md5 \-b 256 \-n HOST knotc\-key
.TP
2. Extract secret in base64 format and create keyfile
echo "knotc-key hmac-md5 <secret>" > knotc.key
echo "knotc\-key hmac\-md5 <secret>" > knotc.key
Make sure the key can be read/written only by owner for
security reasons.
.TP
.B Reload server remotely
knotc -s 127.0.0.1 -k knotc.key reload
knotc \-s 127.0.0.1 \-k knotc.key reload
.SH "SEE ALSO"
The full documentation for
.B Knot
......
......@@ -15,25 +15,25 @@ input. The format of the update is described in \fBINPUT FORMAT\fR section.
.SH OPTIONS
.TP 4
.BI -d
.BI \-d
Enable debugging messages.
.TP
.BI -v
.BI \-v
Use TCP protocol instead of the default UDP.
.TP
.BI -p \ port
.BI \-p \ port
Set the port to use when connecting to server and the port was not explicitly
specified in the update. The default is 53.
.TP
.BI -t \ timeout
.BI \-t \ timeout
The timeout of the update request in seconds. The default is 12. If set to
zero, the timeout is infinite.
.TP
.BI -r \ retries
.BI \-r \ retries
The number of retries for UDP requests. The default is 3. Partial timeout for
each try is computed from total timeout (option \fB-t\fR).
each try is computed from total timeout (option \fB\-t\fR).
.TP
.BI -k \ keyfile
.BI \-k \ keyfile
Use TSIG or SIG\-0 key stored in file to authenticate the request. The tool
supports keys generated by ISC \fBdnssec\-keygen\fR. The key comprises of
public (.key extension) and private part (.private extension). Either of these
......@@ -41,7 +41,7 @@ file names or a name without the extension can be specified as \fIkeyfile\fR
parameter.
.TP
.BI -y \ \fR[\fIhmac:\fR]\fIname:key
.BI \-y \ \fR[\fIhmac:\fR]\fIname:key
Use TSIG key to authenticate the request. The \fIhmac\fR part specifies the
algorithm (the default is hmac\-md5), \fIname\fR specifies the key name, and
\fIkey\fR specifies the shared secret encoded in Base64.
......@@ -55,7 +55,7 @@ Print help.
Print program version.
.TP
Options \fB-k\fR and \fB-y\fR cannot be used mutually.
Options \fB\-k\fR and \fB\-y\fR cannot be used mutually.
.SH INPUT FORMAT
......@@ -71,7 +71,7 @@ List of commands format and their description:
Specifies a receiving server of the dynamic update message. Parameter \fIname\fR
can be either a host name or an IP address. If the \fIport\fR is not specified,
default port is used. The default port value can be controlled using program
option \fB-p\fR.
option \fB\-p\fR.
.TP
\fBzone\fR \fIname\fR
......@@ -83,7 +83,7 @@ the default zone is the root zone.
\fBorigin\fR \fIname\fR
Specifies fully qualified domain name suffix which is appended to
non-fqd owners in update commands. The default origin is the root zone.
non\-fqd owners in update commands. The default origin is the root zone.
.TP
\fBclass\fR \fIname\fR
......@@ -141,7 +141,7 @@ Enable debugging. This command has the same meaning as program option \fB\-d\fR.
Please note that there are slight differences from ISC nsupdate and some
features are not supported. Any bugs, comments, or feature requests can be sent
to \fBknot-dns@labs.nic.cz\fR.
to \fBknot\-dns@labs.nic.cz\fR.
.SH SEE ALSO
.BI khost\fR(1),
.BI kdig\fR(1).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment