diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/Makefile.in | 2 | ||||
-rw-r--r-- | man/kdig.1 | 180 | ||||
-rw-r--r-- | man/kdig.1.in | 180 | ||||
-rw-r--r-- | man/khost.1 | 65 | ||||
-rw-r--r-- | man/khost.1.in | 65 | ||||
-rw-r--r-- | man/knot.conf.5 | 4 | ||||
-rw-r--r-- | man/knot.conf.5.in | 4 | ||||
-rw-r--r-- | man/knotc.8 | 22 | ||||
-rw-r--r-- | man/knotc.8.in | 22 | ||||
-rw-r--r-- | man/knotd.8 | 2 | ||||
-rw-r--r-- | man/knotd.8.in | 2 | ||||
-rw-r--r-- | man/knsupdate.1 | 146 | ||||
-rw-r--r-- | man/knsupdate.1.in | 146 |
13 files changed, 450 insertions, 390 deletions
diff --git a/man/Makefile.in b/man/Makefile.in index 3c98806..67abfaa 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -185,6 +185,7 @@ PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ RAGEL = @RAGEL@ RANLIB = @RANLIB@ +RELEASE_DATE = @RELEASE_DATE@ SED = @SED@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ @@ -212,6 +213,7 @@ build_cpu = @build_cpu@ build_os = @build_os@ build_vendor = @build_vendor@ builddir = @builddir@ +config_dir = @config_dir@ datadir = @datadir@ datarootdir = @datarootdir@ docdir = @docdir@ @@ -1,176 +1,202 @@ -.TH "kdig" "1" "April 2013" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc3" +.TH "kdig" "1" "15 July 2013" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc4" .SH NAME +.TP 5 .B kdig \- 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 +.B kdig \-h .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 +.I query +\fIname\fR | \fB\-q\fR \fIname\fR | \fB\-x\fR \fIaddress\fR .TP -\fIcommon-settings, settings +.I common\-settings, settings [\fIclass\fR] [\fItype\fR] [\fB@\fIserver\fR]... [\fIoptions\fR] .TP -\fIname\fR +.I name Is a domain name that is to be looked up. .TP -\fIserver\fR -Is a name or an address of the nameserver to send a query to. The address -can be specified using [address]:port notation. If no server is specified +.I server +Is a domain name or an IPv4 or IPv6 address of the nameserver to send a query to. +The address can be specified using [address]:port notation. If no server is specified, the servers from \fB/etc/resolv.conf\fR are used. .TP -If no arguments are provided, \fBkdig\fR sends \fINS\fR query for root zone. +If no arguments are provided, \fBkdig\fR sends \fINS\fR query for the root zone. .SH OPTIONS .TP 4 -.BI -4 +.B \-4 Use IPv4 protocol only. .TP -.BI -6 +.B \-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. +must be a valid address for local interface or :: or 0.0.0.0. +Optional port can be specified using [address]:port notation. .TP -.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. +.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 +.B \-d Enable debug messages if any. .TP -\fB\-h\fR, \fB\-\-help\fR +.BR \-h ,\ \-\-help 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 +.BR \-v ,\ \-\-version Print program version. .TP -.BI -x \ address -Send \fIPTR\fR query for IPv4 or IPv6 \fIaddress\fR. +.BI \-x \ address +Send reverse (\fIPTR\fR) query for IPv4 or IPv6 \fIaddress\fR. Correct name, +class and type is set automatically. .TP -.BI -y \ \fR[\fIalgo:\fR]\fIkeyname:key\fR +.B \-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. .TP -\fB+\fR[\fBno\fR]\fBmultiline\fR -Wrap long records to more lines. +.BR + [ no ] multiline +Wrap long records to more lines and improve human readability. .TP -\fB+\fR[\fBno\fR]\fBshort\fR +.BR + [ no ] short Show record data only. .TP -\fB+\fR[\fBno\fR]\fBaaflag\fR +.BR + [ no ] aaflag Set AA flag. .TP -\fB+\fR[\fBno\fR]\fBtcflag\fR +.BR + [ no ] tcflag Set TC flag. .TP -\fB+\fR[\fBno\fR]\fBrdflag\fR +.BR + [ no ] rdflag Set RD flag. .TP -\fB+\fR[\fBno\fR]\fBrecurse\fR -Same as +\fR[\fBno\fR]\fBrdflag\fR +.BR + [ no ] recurse +.RB "Same as " + [ no ] rdflag .TP -\fB+\fR[\fBno\fR]\fBrec\fR -Same as +\fR[\fBno\fR]\fBrdflag\fR +.BR + [ no ] rec +.RB "Same as " + [ no ] rdflag .TP -\fB+\fR[\fBno\fR]\fBraflag\fR +.BR + [ no ] raflag Set RA flag. .TP -\fB+\fR[\fBno\fR]\fBzflag\fR +.BR + [ no ] zflag Set zero flag bit. .TP -\fB+\fR[\fBno\fR]\fBadflag\fR +.BR + [ no ] adflag Set AD flag. .TP -\fB+\fR[\fBno\fR]\fBcdflag\fR +.BR + [ no ] cdflag Set CD flag. .TP -\fB+\fR[\fBno\fR]\fBdnssec\fR +.BR + [ no ] dnssec Set DO flag. .TP -\fB+\fR[\fBno\fR]\fBall\fR +.BR + [ no ] all Show all packet sections. .TP -\fB+\fR[\fBno\fR]\fBqr\fR +.BR + [ no ] qr Show query packet. .TP -\fB+\fR[\fBno\fR]\fBheader\fR +.BR + [ no ] header Show packet header. .TP -\fB+\fR[\fBno\fR]\fBedns\fR -Show EDNS pseudosectio. +.BR + [ no ] edns +Show EDNS pseudosection. .TP -\fB+\fR[\fBno\fR]\fBquestion\fR +.BR + [ no ] question Show question section. .TP -\fB+\fR[\fBno\fR]\fBanswer\fR +.BR + [ no ] answer Show answer section. .TP -\fB+\fR[\fBno\fR]\fBauthority\fR +.BR + [ no ] authority Show authority section. .TP -\fB+\fR[\fBno\fR]\fBadditional\fR +.BR + [ no ] additional Show additional section. .TP -\fB+\fR[\fBno\fR]\fBstats\fR +.BR + [ no ] stats Show trailing packet statistics. .TP -\fB+\fR[\fBno\fR]\fBcl\fR +.BR + [ no ] cl Show DNS class. .TP -\fB+\fR[\fBno\fR]\fBttl\fR +.BR + [ no ] ttl Show TTL value. .TP -\fB+time=\fIT\fR +.BI +time= T Set wait for reply interval in seconds (default is 5 seconds). +This timeout applies to each query try. .TP -\fB+retries=\fIN\fR -Set number of retries (default is 2). This doesn't apply to AXFR or IXFR. +.BI +retry= N +Set number (>=0) of UDP retries (default is 2). This doesn't apply to AXFR/IXFR. .TP -\fB+bufsize=\fIB\fR +.BI +bufsize= B Set EDNS buffer size in bytes (default is 512 bytes). .TP -\fB+\fR[\fBno\fR]\fBtcp\fR -Use TCP protocol. +.BR + [ no ] tcp +Use TCP protocol (default is UDP for standard query and TCP for AXFR/IXFR). .TP -\fB+\fR[\fBno\fR]\fBfail\fR -Stop if SERVFAIL. +.BR + [ no ] fail +Stop quering next nameserver if SERVFAIL response is received. .TP -\fB+\fR[\fBno\fR]\fBignore\fR +.BR + [ no ] ignore Don't use TCP automatically if truncated reply is received. .TP -\fB+\fR[\fBno\fR]\fBnsid\fR +.BR + [ no ] nsid 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. +.SS Missing features with regard to ISC dig +Options \fB\-f\fR and \fB\-m\fR and query options: +.br +.BR +split=\fIW\fR ,\ +tries=\fIT\fR ,\ +ndots=\fID\fR , +.br +.BR +domain=\fIsomename\fR , +trusted\-key=\fI####\fR , +.br +.BR + [ no ] vc ,\ + [ no ] search ,\ + [ no ] showsearch , +.br +.BR + [ no ] defname ,\ + [ no ] aaonly ,\ + [ no ] cmd , +.br +.BR + [ no ] identify ,\ + [ no ] comments ,\ + [ no ] rrcomments , +.br +.BR + [ no ] onesoa ,\ + [ no ] besteffort ,\ + [ no ] sigchase , +.br +.BR + [ no ] topdown ,\ + [ no ] nssearch ,\ + [ no ] trace. +.TP +Per-user file configuration via ${HOME}/.digrc. +.SS Differences with regard to ISC dig +Optional port specification has a form of [address]:port instead of address#port. +.TP +.BR + [ no ] ttl " instead of " + [ no ] ttlid +.TP +Trailing information is formatted slightly different. .SH EXAMPLES .B Example 1. Get A record for example.com: .TP @@ -178,18 +204,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 -.TP 12 +# kdig example.com \-t AXFR @192.0.2.1 +.TP .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 +.I /etc/resolv.conf .SH AUTHOR -Daniel Salzman (\fBhttp://knot-dns.cz\fR) +Daniel Salzman (\fBwww.knot\-dns.cz\fR) .TP -Please send any bugs or comments to \fBknot-dns@labs.nic.cz\fR +Please send any bug reports or comments to \fBknot\-dns@labs.nic.cz\fR .SH SEE ALSO -.BI khost\fR(8), -.BI knsupdate\fR(8). +.BR khost (1), +.BR knsupdate (1). diff --git a/man/kdig.1.in b/man/kdig.1.in index 473bf69..4679abf 100644 --- a/man/kdig.1.in +++ b/man/kdig.1.in @@ -1,176 +1,202 @@ -.TH "kdig" "1" "April 2013" "CZ.NIC Labs" "Knot DNS, version @VERSION@" +.TH "kdig" "1" "@RELEASE_DATE@" "CZ.NIC Labs" "Knot DNS, version @VERSION@" .SH NAME +.TP 5 .B kdig \- 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 +.B kdig \-h .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 +.I query +\fIname\fR | \fB\-q\fR \fIname\fR | \fB\-x\fR \fIaddress\fR .TP -\fIcommon-settings, settings +.I common\-settings, settings [\fIclass\fR] [\fItype\fR] [\fB@\fIserver\fR]... [\fIoptions\fR] .TP -\fIname\fR +.I name Is a domain name that is to be looked up. .TP -\fIserver\fR -Is a name or an address of the nameserver to send a query to. The address -can be specified using [address]:port notation. If no server is specified +.I server +Is a domain name or an IPv4 or IPv6 address of the nameserver to send a query to. +The address can be specified using [address]:port notation. If no server is specified, the servers from \fB/etc/resolv.conf\fR are used. .TP -If no arguments are provided, \fBkdig\fR sends \fINS\fR query for root zone. +If no arguments are provided, \fBkdig\fR sends \fINS\fR query for the root zone. .SH OPTIONS .TP 4 -.BI -4 +.B \-4 Use IPv4 protocol only. .TP -.BI -6 +.B \-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. +must be a valid address for local interface or :: or 0.0.0.0. +Optional port can be specified using [address]:port notation. .TP -.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. +.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 +.B \-d Enable debug messages if any. .TP -\fB\-h\fR, \fB\-\-help\fR +.BR \-h ,\ \-\-help 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 +.BR \-v ,\ \-\-version Print program version. .TP -.BI -x \ address -Send \fIPTR\fR query for IPv4 or IPv6 \fIaddress\fR. +.BI \-x \ address +Send reverse (\fIPTR\fR) query for IPv4 or IPv6 \fIaddress\fR. Correct name, +class and type is set automatically. .TP -.BI -y \ \fR[\fIalgo:\fR]\fIkeyname:key\fR +.B \-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. .TP -\fB+\fR[\fBno\fR]\fBmultiline\fR -Wrap long records to more lines. +.BR + [ no ] multiline +Wrap long records to more lines and improve human readability. .TP -\fB+\fR[\fBno\fR]\fBshort\fR +.BR + [ no ] short Show record data only. .TP -\fB+\fR[\fBno\fR]\fBaaflag\fR +.BR + [ no ] aaflag Set AA flag. .TP -\fB+\fR[\fBno\fR]\fBtcflag\fR +.BR + [ no ] tcflag Set TC flag. .TP -\fB+\fR[\fBno\fR]\fBrdflag\fR +.BR + [ no ] rdflag Set RD flag. .TP -\fB+\fR[\fBno\fR]\fBrecurse\fR -Same as +\fR[\fBno\fR]\fBrdflag\fR +.BR + [ no ] recurse +.RB "Same as " + [ no ] rdflag .TP -\fB+\fR[\fBno\fR]\fBrec\fR -Same as +\fR[\fBno\fR]\fBrdflag\fR +.BR + [ no ] rec +.RB "Same as " + [ no ] rdflag .TP -\fB+\fR[\fBno\fR]\fBraflag\fR +.BR + [ no ] raflag Set RA flag. .TP -\fB+\fR[\fBno\fR]\fBzflag\fR +.BR + [ no ] zflag Set zero flag bit. .TP -\fB+\fR[\fBno\fR]\fBadflag\fR +.BR + [ no ] adflag Set AD flag. .TP -\fB+\fR[\fBno\fR]\fBcdflag\fR +.BR + [ no ] cdflag Set CD flag. .TP -\fB+\fR[\fBno\fR]\fBdnssec\fR +.BR + [ no ] dnssec Set DO flag. .TP -\fB+\fR[\fBno\fR]\fBall\fR +.BR + [ no ] all Show all packet sections. .TP -\fB+\fR[\fBno\fR]\fBqr\fR +.BR + [ no ] qr Show query packet. .TP -\fB+\fR[\fBno\fR]\fBheader\fR +.BR + [ no ] header Show packet header. .TP -\fB+\fR[\fBno\fR]\fBedns\fR -Show EDNS pseudosectio. +.BR + [ no ] edns +Show EDNS pseudosection. .TP -\fB+\fR[\fBno\fR]\fBquestion\fR +.BR + [ no ] question Show question section. .TP -\fB+\fR[\fBno\fR]\fBanswer\fR +.BR + [ no ] answer Show answer section. .TP -\fB+\fR[\fBno\fR]\fBauthority\fR +.BR + [ no ] authority Show authority section. .TP -\fB+\fR[\fBno\fR]\fBadditional\fR +.BR + [ no ] additional Show additional section. .TP -\fB+\fR[\fBno\fR]\fBstats\fR +.BR + [ no ] stats Show trailing packet statistics. .TP -\fB+\fR[\fBno\fR]\fBcl\fR +.BR + [ no ] cl Show DNS class. .TP -\fB+\fR[\fBno\fR]\fBttl\fR +.BR + [ no ] ttl Show TTL value. .TP -\fB+time=\fIT\fR +.BI +time= T Set wait for reply interval in seconds (default is 5 seconds). +This timeout applies to each query try. .TP -\fB+retries=\fIN\fR -Set number of retries (default is 2). This doesn't apply to AXFR or IXFR. +.BI +retry= N +Set number (>=0) of UDP retries (default is 2). This doesn't apply to AXFR/IXFR. .TP -\fB+bufsize=\fIB\fR +.BI +bufsize= B Set EDNS buffer size in bytes (default is 512 bytes). .TP -\fB+\fR[\fBno\fR]\fBtcp\fR -Use TCP protocol. +.BR + [ no ] tcp +Use TCP protocol (default is UDP for standard query and TCP for AXFR/IXFR). .TP -\fB+\fR[\fBno\fR]\fBfail\fR -Stop if SERVFAIL. +.BR + [ no ] fail +Stop quering next nameserver if SERVFAIL response is received. .TP -\fB+\fR[\fBno\fR]\fBignore\fR +.BR + [ no ] ignore Don't use TCP automatically if truncated reply is received. .TP -\fB+\fR[\fBno\fR]\fBnsid\fR +.BR + [ no ] nsid 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. +.SS Missing features with regard to ISC dig +Options \fB\-f\fR and \fB\-m\fR and query options: +.br +.BR +split=\fIW\fR ,\ +tries=\fIT\fR ,\ +ndots=\fID\fR , +.br +.BR +domain=\fIsomename\fR , +trusted\-key=\fI####\fR , +.br +.BR + [ no ] vc ,\ + [ no ] search ,\ + [ no ] showsearch , +.br +.BR + [ no ] defname ,\ + [ no ] aaonly ,\ + [ no ] cmd , +.br +.BR + [ no ] identify ,\ + [ no ] comments ,\ + [ no ] rrcomments , +.br +.BR + [ no ] onesoa ,\ + [ no ] besteffort ,\ + [ no ] sigchase , +.br +.BR + [ no ] topdown ,\ + [ no ] nssearch ,\ + [ no ] trace. +.TP +Per-user file configuration via ${HOME}/.digrc. +.SS Differences with regard to ISC dig +Optional port specification has a form of [address]:port instead of address#port. +.TP +.BR + [ no ] ttl " instead of " + [ no ] ttlid +.TP +Trailing information is formatted slightly different. .SH EXAMPLES .B Example 1. Get A record for example.com: .TP @@ -178,18 +204,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 -.TP 12 +# kdig example.com \-t AXFR @192.0.2.1 +.TP .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 +.I /etc/resolv.conf .SH AUTHOR -Daniel Salzman (\fBhttp://knot-dns.cz\fR) +Daniel Salzman (\fBwww.knot\-dns.cz\fR) .TP -Please send any bugs or comments to \fBknot-dns@labs.nic.cz\fR +Please send any bug reports or comments to \fBknot\-dns@labs.nic.cz\fR .SH SEE ALSO -.BI khost\fR(8), -.BI knsupdate\fR(8). +.BR khost (1), +.BR knsupdate (1). diff --git a/man/khost.1 b/man/khost.1 index f68519a..9d4a2c4 100644 --- a/man/khost.1 +++ b/man/khost.1 @@ -1,5 +1,6 @@ -.TH "khost" "1" "April 2013" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc3" +.TH "khost" "1" "15 July 2013" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc4" .SH NAME +.TP 6 .B khost \- Simple DNS lookup utility (libknot equivalent of ISC host) .SH SYNOPSIS @@ -7,13 +8,13 @@ [\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 +.I name Is a domain name that is to be looked up. If the \fIname\fR is IPv4 or IPv6 address the \fIPTR\fR query type is used. .TP -\fI server\fR +.I server Is a name or an address of the nameserver to send a query to. The address can be specified using [address]:port notation. If no server is specified the servers from \fB/etc/resolv.conf\fR are used. @@ -21,51 +22,61 @@ 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 +.B \-4 Use IPv4 protocol only. .TP -.BI -6 +.B \-6 Use IPv6 protocol only. .TP -.BI -a +.B \-a Send ANY query with verbose mode. .TP -.BI -d +.B \-d Enable debug messages if any. .TP -\fB\-h\fR, \fB\-\-help\fR +.BR \-h ,\ \-\-help Print help. .TP -.BI -r +.B \-r Disable recursion. .TP -.BI -s +.B \-s Stop quering next nameserver if SERVFAIL response is received. .TP -.BI -T +.B \-T Use TCP protocol. .TP -.BI -v +.B \-v Enable verbose output. .TP -\fB\-V\fR, \fB\-\-version\fR +.BR \-V ,\ \-\-version Print program version. .TP -.BI -w +.B \-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 -The number of UDP retries to query a nameserver. The default is \fI1\fR. +.BI \-R \ retries +The number (>=0) of UDP retries to query a nameserver. The default is \fI1\fR. .TP -.BI -W \ wait -The time to wait for a reply in seconds. The default is \fI2\fR seconds. +.BI \-W \ wait +The time to wait for a reply in seconds. This timeout applies to each query try. +The default is \fI2\fR seconds. +.SH NOTES +.SS Missing features with regard to ISC host +Options \fB\-C, \-i, \-l, \-m, \-N\fR. +.SS Differences with regard to ISC host +Option \fB\-d\fR is not equivalent to \fB-v\fR, but enables debug messages. +.TP +The number of retries can be set to zero. +.TP +Verbose mode has slightly different format (same as \fBkdig\fR). .SH EXAMPLES .B Example 1. Get A, AAAA and MX records for example.com: .TP @@ -77,13 +88,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 +.I /etc/resolv.conf .SH AUTHOR -Daniel Salzman (\fBhttp://knot-dns.cz\fR) +Daniel Salzman (\fBwww.knot\-dns.cz\fR) .TP -Please send any bugs or comments to \fBknot-dns@labs.nic.cz\fR +Please send any bug reports or comments to \fBknot\-dns@labs.nic.cz\fR .SH SEE ALSO -.BI kdig\fR(8), -.BI knsupdate\fR(8). +.BR kdig (1), +.BR knsupdate (1). diff --git a/man/khost.1.in b/man/khost.1.in index a931968..e25ba35 100644 --- a/man/khost.1.in +++ b/man/khost.1.in @@ -1,5 +1,6 @@ -.TH "khost" "1" "April 2013" "CZ.NIC Labs" "Knot DNS, version @VERSION@" +.TH "khost" "1" "@RELEASE_DATE@" "CZ.NIC Labs" "Knot DNS, version @VERSION@" .SH NAME +.TP 6 .B khost \- Simple DNS lookup utility (libknot equivalent of ISC host) .SH SYNOPSIS @@ -7,13 +8,13 @@ [\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 +.I name Is a domain name that is to be looked up. If the \fIname\fR is IPv4 or IPv6 address the \fIPTR\fR query type is used. .TP -\fI server\fR +.I server Is a name or an address of the nameserver to send a query to. The address can be specified using [address]:port notation. If no server is specified the servers from \fB/etc/resolv.conf\fR are used. @@ -21,51 +22,61 @@ 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 +.B \-4 Use IPv4 protocol only. .TP -.BI -6 +.B \-6 Use IPv6 protocol only. .TP -.BI -a +.B \-a Send ANY query with verbose mode. .TP -.BI -d +.B \-d Enable debug messages if any. .TP -\fB\-h\fR, \fB\-\-help\fR +.BR \-h ,\ \-\-help Print help. .TP -.BI -r +.B \-r Disable recursion. .TP -.BI -s +.B \-s Stop quering next nameserver if SERVFAIL response is received. .TP -.BI -T +.B \-T Use TCP protocol. .TP -.BI -v +.B \-v Enable verbose output. .TP -\fB\-V\fR, \fB\-\-version\fR +.BR \-V ,\ \-\-version Print program version. .TP -.BI -w +.B \-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 -The number of UDP retries to query a nameserver. The default is \fI1\fR. +.BI \-R \ retries +The number (>=0) of UDP retries to query a nameserver. The default is \fI1\fR. .TP -.BI -W \ wait -The time to wait for a reply in seconds. The default is \fI2\fR seconds. +.BI \-W \ wait +The time to wait for a reply in seconds. This timeout applies to each query try. +The default is \fI2\fR seconds. +.SH NOTES +.SS Missing features with regard to ISC host +Options \fB\-C, \-i, \-l, \-m, \-N\fR. +.SS Differences with regard to ISC host +Option \fB\-d\fR is not equivalent to \fB-v\fR, but enables debug messages. +.TP +The number of retries can be set to zero. +.TP +Verbose mode has slightly different format (same as \fBkdig\fR). .SH EXAMPLES .B Example 1. Get A, AAAA and MX records for example.com: .TP @@ -77,13 +88,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 +.I /etc/resolv.conf .SH AUTHOR -Daniel Salzman (\fBhttp://knot-dns.cz\fR) +Daniel Salzman (\fBwww.knot\-dns.cz\fR) .TP -Please send any bugs or comments to \fBknot-dns@labs.nic.cz\fR +Please send any bug reports or comments to \fBknot\-dns@labs.nic.cz\fR .SH SEE ALSO -.BI kdig\fR(8), -.BI knsupdate\fR(8). +.BR kdig (1), +.BR knsupdate (1). diff --git a/man/knot.conf.5 b/man/knot.conf.5 index 00d7542..de5ce64 100644 --- a/man/knot.conf.5 +++ b/man/knot.conf.5 @@ -1,4 +1,4 @@ -.TH "knot.conf" "5" "September 2012" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc3" +.TH "knot.conf" "5" "15 July 2013" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc4" .SH "NAME" .LP .B knot.conf @@ -190,7 +190,7 @@ serves as an example of the configuration for knotc(8) and knotd(8). control { # Specifies interface, syntax is exactly the same as in 'interfaces' section - # Default: OFF + # Default: $(run_dir)/knot.sock listen-on "knot.sock"; # As an alternative, you can use an IPv4/v6 address and port diff --git a/man/knot.conf.5.in b/man/knot.conf.5.in index d8a0d67..2ccc767 100644 --- a/man/knot.conf.5.in +++ b/man/knot.conf.5.in @@ -1,4 +1,4 @@ -.TH "knot.conf" "5" "September 2012" "CZ.NIC Labs" "Knot DNS, version @VERSION@" +.TH "knot.conf" "5" "@RELEASE_DATE@" "CZ.NIC Labs" "Knot DNS, version @VERSION@" .SH "NAME" .LP .B knot.conf @@ -190,7 +190,7 @@ serves as an example of the configuration for knotc(8) and knotd(8). control { # Specifies interface, syntax is exactly the same as in 'interfaces' section - # Default: OFF + # Default: $(run_dir)/knot.sock listen-on "knot.sock"; # As an alternative, you can use an IPv4/v6 address and port diff --git a/man/knotc.8 b/man/knotc.8 index 7864cff..3d5c398 100644 --- a/man/knotc.8 +++ b/man/knotc.8 @@ -1,4 +1,4 @@ -.TH knotc "8" "September 2012" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc3" +.TH knotc "8" "15 July 2013" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc4" .SH NAME .B knotc \- Knot DNS control utility @@ -10,15 +10,15 @@ .HP \fB\-c\fR [file], \fB\-\-config\fR=\fI[file]\fR Select configuration file. .TP -\fB\-s\fR [server]\fR Remote UNIX socket/IP address (default @rundir@/knot.sock) +\fB\-s\fR [server]\fR Remote UNIX socket/IP address (default ${prefix}/var/run/knot/knot.sock) .TP \fB\-p\fR [port]\fR Remote server port (only for IP). .TP \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. @@ -30,7 +30,7 @@ Verbose mode \- additional runtime information. Print knot server version. .TP \fB\-w\fR, \fB\-\-wait\fR -Wait for the server to finish start/stop operations. +Wait for the server to finish stop operation. .TP \fB\-i\fR, \fB\-\-interactive\fR Interactive mode (do not daemonize). @@ -39,15 +39,9 @@ Interactive mode (do not daemonize). Print help and usage. .SS "Actions:" .TP -start -Start knot server daemon (no\-op if running). -.TP stop Stop knot server daemon (no\-op if not running). .TP -restart -Stops and then starts knot server daemon. -.TP reload Reload knot configuration and zones. .TP @@ -76,17 +70,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 diff --git a/man/knotc.8.in b/man/knotc.8.in index f845c96..343fd02 100644 --- a/man/knotc.8.in +++ b/man/knotc.8.in @@ -1,4 +1,4 @@ -.TH knotc "8" "September 2012" "CZ.NIC Labs" "Knot DNS, version @VERSION@" +.TH knotc "8" "@RELEASE_DATE@" "CZ.NIC Labs" "Knot DNS, version @VERSION@" .SH NAME .B knotc \- Knot DNS control utility @@ -10,15 +10,15 @@ .HP \fB\-c\fR [file], \fB\-\-config\fR=\fI[file]\fR Select configuration file. .TP -\fB\-s\fR [server]\fR Remote UNIX socket/IP address (default @rundir@/knot.sock) +\fB\-s\fR [server]\fR Remote UNIX socket/IP address (default @run_dir@/knot.sock) .TP \fB\-p\fR [port]\fR Remote server port (only for IP). .TP \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. @@ -30,7 +30,7 @@ Verbose mode \- additional runtime information. Print knot server version. .TP \fB\-w\fR, \fB\-\-wait\fR -Wait for the server to finish start/stop operations. +Wait for the server to finish stop operation. .TP \fB\-i\fR, \fB\-\-interactive\fR Interactive mode (do not daemonize). @@ -39,15 +39,9 @@ Interactive mode (do not daemonize). Print help and usage. .SS "Actions:" .TP -start -Start knot server daemon (no\-op if running). -.TP stop Stop knot server daemon (no\-op if not running). .TP -restart -Stops and then starts knot server daemon. -.TP reload Reload knot configuration and zones. .TP @@ -76,17 +70,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 diff --git a/man/knotd.8 b/man/knotd.8 index 1809c9c..59ff8b5 100644 --- a/man/knotd.8 +++ b/man/knotd.8 @@ -1,4 +1,4 @@ -.TH "knotd" "8" "September 2012" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc3" +.TH "knotd" "8" "15 July 2013" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc4" .SH NAME .B knotd \- Knot DNS daemon diff --git a/man/knotd.8.in b/man/knotd.8.in index 83088c5..d587315 100644 --- a/man/knotd.8.in +++ b/man/knotd.8.in @@ -1,4 +1,4 @@ -.TH "knotd" "8" "September 2012" "CZ.NIC Labs" "Knot DNS, version @VERSION@" +.TH "knotd" "8" "@RELEASE_DATE@" "CZ.NIC Labs" "Knot DNS, version @VERSION@" .SH NAME .B knotd \- Knot DNS daemon diff --git a/man/knsupdate.1 b/man/knsupdate.1 index 5d2bd32..c402b31 100644 --- a/man/knsupdate.1 +++ b/man/knsupdate.1 @@ -1,4 +1,4 @@ -.TH "knsupdate" "1" "April 2013" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc3" +.TH "knsupdate" "1" "15 July 2013" "CZ.NIC Labs" "Knot DNS, version 1.3.0-rc4" .SH NAME .TP 10 .B knsupdate @@ -6,142 +6,140 @@ .SH SYNOPSIS .B knsupdate [\fIoptions\fR] [\fIfilename\fR] - .SH DESCRIPTION - The utility sends Dynamic DNS update message to DNS server. Update content is read from a file (if the parameter \fIfilename\fR is given) or from standard input. The format of the update is described in \fBINPUT FORMAT\fR section. - .SH OPTIONS .TP 4 -.BI -d +.B \-d Enable debugging messages. .TP -.BI -v +.B \-v Use TCP protocol instead of the default UDP. .TP -.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. +.BI \-p \ port +Set the port to use for connections to a server (if not explicitly +specified in the update). The default is \fI53\fR. .TP -.BI -t \ timeout -The timeout of the update request in seconds. The default is 12. If set to +.BI \-t \ timeout +The total timeout (all UDP update tries) of the update request in seconds. The default is \fI12\fR. If set to zero, the timeout is infinite. .TP -.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). +.BI \-r \ retries +The number of retries for UDP requests. The default is \fI3\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 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. - .TP -\fB\-\-help\fR +.BR \-h ,\ \-\-help Print help. - .TP -\fB\-\-version\fR +.BR \-V ,\ \-\-version Print program version. - -.TP -Options \fB-k\fR and \fB-y\fR cannot be used mutually. - +.SH NOTE +Options \fB\-k\fR and \fB\-y\fR cannot be used mutually. .SH INPUT FORMAT - The input format is textual and is made up of commands. Every command is placed on a separate line of the input. Lines starting with a semicolon are comments and are not processed. - +.TP List of commands format and their description: - .TP -\fBserver\fR \fIname\fR [\fIport\fR] - +.BI server \ name \ \fR[\fIport\fR] 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 +.BI local \ address \ \fR[\fIport\fR] +Specifies outgoing \fIaddress\fR and \fIport\fR. If no local is specified, +the address and port are set by the system automatically. Default port number +is \fI0\fR. .TP -\fBzone\fR \fIname\fR - +.BI zone \ name Specifies that all updates are done within a zone named \fIname\fR. If not used, the default zone is the root zone. - .TP -\fBorigin\fR \fIname\fR - +.BI origin \ name 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 - +.BI class \ name Sets \fIname\fR as a default class for all updates. If not used, the default -class is IN. - +class is \fIIN\fR. .TP -\fBttl\fR \fIvalue\fR - +.BI ttl \ value Sets \fIvalue\fR as a default TTL (time to live) in seconds. If not used, the -default value is zero. - +default value is \fI0\fR. .TP -\fBkey\fB \fIname\fR \fIkey\fR - +.BI key \ name \ \fIkey\fR Specifies TSIG key to authenticate the request. This command has the same semantics as the program option \fB\-y\fR, except that the MAC algorithm cannot be set. - .TP -[\fBupdate\fR] \fBadd\fR \fIname\fR \fIttl\fR [\fIclass\fR] \fItype\fR \fIdata\fR - +[\fBupdate\fR] \fBadd\fR \fIname\fR [\fIttl\fR] [\fIclass\fR] \fItype\fR \fIdata\fR Adds a request to add a new resource record into the zone. Please note that if the \fIname\fR is not fully qualified domain name, current \fIorigin\fR name is appended to it. - .TP [\fBupdate\fR] \fBdel\fR[\fBete\fR] \fIname\fR [\fIttl\fR] [\fIclass\fR] [\fItype\fR] [\fIdata\fR] - Adds a request to remove all (or matching \fIclass\fR, \fItype\fR, \fIdata\fR) resource records from the zone. There is the same requirement for the \fIname\fR parameter as in the \fBupdate add\fR command. The \fIttl\fR item is ignored. - .TP -\fBshow\fR - +.B show Displays current content of the update message. - .TP -\fBsend\fR - +.B send Sends the current update message and cleans the list of updates. - .TP -\fBanswer\fR - +.B answer Displays the last answer from the server. - .TP -\fBdebug\fR - +.B debug Enable debugging. This command has the same meaning as program option \fB\-d\fR. - -.SH BUGS - -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. +.SH NOTE +.SS Missing features with regard to ISC nsupdate +Options \fB\-D\fR, \fB\-g\fR, \fB\-o\fR, \fB\-l\fR, \fB\-L\fR, \fB\-R\fR, \fB\-u\fR. +.TP +Commands: \fBgsstsig\fR, \fBoldgsstsig\fR, \fBrealm\fR, \fBprereq\fR (\fBnxdomain\fR, \fByxdomain\fR, \fBnxrrset\fR, \fByxrrset\fR). +.SS Differences with regard to ISC nsupdate +Zone name/server guessing, if the zone name/server is not specified. +.TP 0 +Empty line doesn't send an update. +.TP +Bind-like key format (\fBddns\-confgen\fR output) is not supported. +.TP +Command \fBadd\fR doesn't require \fIttl\fR item to be set. In such case, +the default ttl value is used. +.SH EXAMPLES +.B Example 1. Add two records to the zone example.com.: +.TP 0 +.nf +knsupdate +server 192.168.1.1 +zone example.com. +origin example.com. +ttl 3600 +add test1.example.com. 7200 A 192.168.2.2 +add test2 TXT "hello" +show +send +answer +.fi +.SH AUTHOR +Marek Vavruša, Daniel Salzman, Jan Včelák (\fBwww.knot\-dns.cz\fR) +.TP +Please send any bug reports or comments to \fBknot\-dns@labs.nic.cz\fR .SH SEE ALSO -.BI khost\fR(8), -.BI kdig\fR(8). +.BR kdig (1), +.BR khost (1). diff --git a/man/knsupdate.1.in b/man/knsupdate.1.in index 847475b..b7857df 100644 --- a/man/knsupdate.1.in +++ b/man/knsupdate.1.in @@ -1,4 +1,4 @@ -.TH "knsupdate" "1" "April 2013" "CZ.NIC Labs" "Knot DNS, version @VERSION@" +.TH "knsupdate" "1" "@RELEASE_DATE@" "CZ.NIC Labs" "Knot DNS, version @VERSION@" .SH NAME .TP 10 .B knsupdate @@ -6,142 +6,140 @@ .SH SYNOPSIS .B knsupdate [\fIoptions\fR] [\fIfilename\fR] - .SH DESCRIPTION - The utility sends Dynamic DNS update message to DNS server. Update content is read from a file (if the parameter \fIfilename\fR is given) or from standard input. The format of the update is described in \fBINPUT FORMAT\fR section. - .SH OPTIONS .TP 4 -.BI -d +.B \-d Enable debugging messages. .TP -.BI -v +.B \-v Use TCP protocol instead of the default UDP. .TP -.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. +.BI \-p \ port +Set the port to use for connections to a server (if not explicitly +specified in the update). The default is \fI53\fR. .TP -.BI -t \ timeout -The timeout of the update request in seconds. The default is 12. If set to +.BI \-t \ timeout +The total timeout (all UDP update tries) of the update request in seconds. The default is \fI12\fR. If set to zero, the timeout is infinite. .TP -.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). +.BI \-r \ retries +The number of retries for UDP requests. The default is \fI3\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 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. - .TP -\fB\-\-help\fR +.BR \-h ,\ \-\-help Print help. - .TP -\fB\-\-version\fR +.BR \-V ,\ \-\-version Print program version. - -.TP -Options \fB-k\fR and \fB-y\fR cannot be used mutually. - +.SH NOTE +Options \fB\-k\fR and \fB\-y\fR cannot be used mutually. .SH INPUT FORMAT - The input format is textual and is made up of commands. Every command is placed on a separate line of the input. Lines starting with a semicolon are comments and are not processed. - +.TP List of commands format and their description: - .TP -\fBserver\fR \fIname\fR [\fIport\fR] - +.BI server \ name \ \fR[\fIport\fR] 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 +.BI local \ address \ \fR[\fIport\fR] +Specifies outgoing \fIaddress\fR and \fIport\fR. If no local is specified, +the address and port are set by the system automatically. Default port number +is \fI0\fR. .TP -\fBzone\fR \fIname\fR - +.BI zone \ name Specifies that all updates are done within a zone named \fIname\fR. If not used, the default zone is the root zone. - .TP -\fBorigin\fR \fIname\fR - +.BI origin \ name 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 - +.BI class \ name Sets \fIname\fR as a default class for all updates. If not used, the default -class is IN. - +class is \fIIN\fR. .TP -\fBttl\fR \fIvalue\fR - +.BI ttl \ value Sets \fIvalue\fR as a default TTL (time to live) in seconds. If not used, the -default value is zero. - +default value is \fI0\fR. .TP -\fBkey\fB \fIname\fR \fIkey\fR - +.BI key \ name \ \fIkey\fR Specifies TSIG key to authenticate the request. This command has the same semantics as the program option \fB\-y\fR, except that the MAC algorithm cannot be set. - .TP -[\fBupdate\fR] \fBadd\fR \fIname\fR \fIttl\fR [\fIclass\fR] \fItype\fR \fIdata\fR - +[\fBupdate\fR] \fBadd\fR \fIname\fR [\fIttl\fR] [\fIclass\fR] \fItype\fR \fIdata\fR Adds a request to add a new resource record into the zone. Please note that if the \fIname\fR is not fully qualified domain name, current \fIorigin\fR name is appended to it. - .TP [\fBupdate\fR] \fBdel\fR[\fBete\fR] \fIname\fR [\fIttl\fR] [\fIclass\fR] [\fItype\fR] [\fIdata\fR] - Adds a request to remove all (or matching \fIclass\fR, \fItype\fR, \fIdata\fR) resource records from the zone. There is the same requirement for the \fIname\fR parameter as in the \fBupdate add\fR command. The \fIttl\fR item is ignored. - .TP -\fBshow\fR - +.B show Displays current content of the update message. - .TP -\fBsend\fR - +.B send Sends the current update message and cleans the list of updates. - .TP -\fBanswer\fR - +.B answer Displays the last answer from the server. - .TP -\fBdebug\fR - +.B debug Enable debugging. This command has the same meaning as program option \fB\-d\fR. - -.SH BUGS - -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. +.SH NOTE +.SS Missing features with regard to ISC nsupdate +Options \fB\-D\fR, \fB\-g\fR, \fB\-o\fR, \fB\-l\fR, \fB\-L\fR, \fB\-R\fR, \fB\-u\fR. +.TP +Commands: \fBgsstsig\fR, \fBoldgsstsig\fR, \fBrealm\fR, \fBprereq\fR (\fBnxdomain\fR, \fByxdomain\fR, \fBnxrrset\fR, \fByxrrset\fR). +.SS Differences with regard to ISC nsupdate +Zone name/server guessing, if the zone name/server is not specified. +.TP 0 +Empty line doesn't send an update. +.TP +Bind-like key format (\fBddns\-confgen\fR output) is not supported. +.TP +Command \fBadd\fR doesn't require \fIttl\fR item to be set. In such case, +the default ttl value is used. +.SH EXAMPLES +.B Example 1. Add two records to the zone example.com.: +.TP 0 +.nf +knsupdate +server 192.168.1.1 +zone example.com. +origin example.com. +ttl 3600 +add test1.example.com. 7200 A 192.168.2.2 +add test2 TXT "hello" +show +send +answer +.fi +.SH AUTHOR +Marek Vavruša, Daniel Salzman, Jan Včelák (\fBwww.knot\-dns.cz\fR) +.TP +Please send any bug reports or comments to \fBknot\-dns@labs.nic.cz\fR .SH SEE ALSO -.BI khost\fR(8), -.BI kdig\fR(8). +.BR kdig (1), +.BR khost (1). |