summaryrefslogtreecommitdiff
path: root/man/khost.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'man/khost.1.in')
-rw-r--r--man/khost.1.in65
1 files changed, 38 insertions, 27 deletions
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).