Commit a437d4e2 authored by Jeremy C. Reed's avatar Jeremy C. Reed
Browse files

[jreed-host] write manual page

Document existing b10-host command.

Regenerate the roff file.
parent 0338dd8c
......@@ -2,12 +2,12 @@
.\" Title: b10-host
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: May 24, 2010
.\" Date: May 4, 2011
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "B10\-HOST" "1" "May 24, 2010" "BIND10" "BIND10"
.TH "B10\-HOST" "1" "May 4, 2011" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -22,17 +22,101 @@
b10-host \- DNS lookup utility
.SH "SYNOPSIS"
.HP \w'\fBb10\-host\fR\ 'u
\fBb10\-host\fR [\fB\-v\fR]
\fBb10\-host\fR [\fB\-a\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-d\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-r\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-v\fR] [\fIname\fR] [\fB\fIserver\fR\fR]
.SH "DESCRIPTION"
.PP
The
\fBb10\-host\fR
utility does DNS lookups\&. Its initial goal is to be a
\fBhost\fR(1)
clone, but also add a few features useful for BIND 10 development testing\&.
.PP
By default, it looks up the A, AAAA, and MX record sets for the
\fIname\fR\&. Optionally, you may select a name server to query against by adding the
\fIserver\fR
argument\&.
.SH "OPTIONS"
.PP
The arguments are as follows:
.PP
\fB\-a\fR
.RS 4
Enable verbose mode and do a query for type ANY\&. (If the
\fB\-t\fR
option is also set, then the ANY query is not done, but it still uses verbose mode\&.)
.RE
.PP
\fB\-c \fR\fB\fIclass\fR\fR
.RS 4
Define the class for the query\&. The default is IN (Internet)\&.
.RE
.PP
\fB\-d\fR
.RS 4
Enable verbose output mode, including elapsed time in milliseconds\&. Verbose mode shows the header, question, answer, authority, and additional sections (if provided)\&. (Same as
\fB\-v\fR\&.)
.RE
.PP
\fB\-p \fR\fB\fIport\fR\fR
.RS 4
Select an alternative port for the query\&. This may be a number or a service name\&. The default is 53 (domain)\&. This is not a standard feature of
\fBhost\fR(1)\&.
.RE
.PP
\fB\-r\fR
.RS 4
Disable recursive processing by not setting the Recursion Desired flag in the query\&.
.RE
.PP
\fB\-t \fR\fB\fItype\fR\fR
.RS 4
Select a specific resource record type for the query\&. By default, it looks up the A, AAAA, and MX record sets\&.
(This overrides the
\fB\-a\fR
option\&.)
.RE
.PP
\fB\-v\fR
.RS 4
Same as
\fB\-d\fR
option\&.
.RE
.SH "COMPATIBILITY / BUGS"
.PP
\fBb10\-host\fR
does not do reverse lookups by default yet (by detecting if name is a IPv4 or IPv6 address)\&.
.PP
Unknown
\fB\-c\fR
class or
\fB\-t\fR
type causes
\fBb10\-host\fR
to Abort\&.
.PP
Not all types are supported yet for formatting\&. Not all switches are supported yet\&.
.PP
It doesn\'t use
/etc/resolv\&.conf
at this time\&. The default name server used is 127\&.0\&.0\&.1\&.
.PP
\fBb10\-host\fR
does not do reverse lookups by default yet (by detecting if name is a IPv4 or IPv6 address)\&.
.PP
\fB\-p\fR
is not a standard feature\&.
.SH "HISTORY"
.PP
The C++ version of
\fBb10\-host\fR
was started in October 2009 by Jeremy C\&. Reed of ISC\&. Its usage and output are based on the standard
was started in October 2009 by Jeremy C\&. Reed of ISC\&. Its usage and output were based on the standard
\fBhost\fR
command\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2010 Internet Systems Consortium, Inc. ("ISC")
Copyright \(co 2011 Internet Systems Consortium, Inc. ("ISC")
.br
......@@ -2,7 +2,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]>
<!--
- Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
- Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
......@@ -21,7 +21,7 @@
<refentry>
<refentryinfo>
<date>May 24, 2010</date>
<date>May 4, 2011</date>
</refentryinfo>
<refmeta>
......@@ -37,7 +37,7 @@
<docinfo>
<copyright>
<year>2010</year>
<year>2011</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
......@@ -45,40 +45,152 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>b10-host</command>
<arg><option>-a</option></arg>
<arg><option>-c <replaceable>class</replaceable></option></arg>
<arg><option>-d</option></arg>
<arg><option>-p <replaceable>port</replaceable></option></arg>
<arg><option>-r</option></arg>
<arg><option>-t <replaceable>type</replaceable></option></arg>
<arg><option>-v</option></arg>
<arg><replaceable>name</replaceable></arg>
<arg><option><replaceable>server</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
The <command>b10-host</command> utility does DNS lookups.
Its initial goal is to be a
<citerefentry><refentrytitle>host</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>
clone, but also add a few features useful for BIND 10 development
testing.
</para>
<para>
By default, it looks up the A, AAAA, and MX record sets for the
<replaceable>name</replaceable>.
Optionally, you may select a name server to query against by adding
the <replaceable>server</replaceable> argument.
</para>
</refsect1>
<!--
<refsect1>
<title>OPTIONS</title>
<para>The arguments are as follows:</para>
<variablelist>
<varlistentry>
<term><option>-a</option></term>
<listitem><para>
Enable verbose mode and do a query for type ANY.
(If the <option>-t</option> option is also set, then the
ANY query is not done, but it still uses verbose mode.)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-c <replaceable>class</replaceable></option></term>
<listitem><para>
Define the class for the query.
The default is IN (Internet).
<!-- TODO: bug if class is unknown causes seg fault and possible core dump -->
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<listitem><para>
Enable verbose output mode, including elapsed time in
milliseconds.
Verbose mode shows the header, question, answer, authority,
and additional sections (if provided).
(Same as <option>-v</option>.)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p <replaceable>port</replaceable></option></term>
<listitem><para>
Select an alternative port for the query.
This may be a number or a service name.
The default is 53 (domain).
This is not a standard feature of
<citerefentry><refentrytitle>host</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option></term>
<listitem><para>
Disable recursive processing by not setting the
Recursion Desired flag in the query.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-t <replaceable>type</replaceable></option></term>
<listitem><para>
Select a specific resource record type for the query.
By default, it looks up the A, AAAA, and MX record sets.
<!-- TODO: bug if class is unknown causes seg fault and possible core dump -->
(This overrides the <option>-a</option> option.)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option></option></term>
<term><option>-v</option></term>
<listitem><para>
Same as <option>-d</option> option.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
-->
<refsect1>
<title>COMPATIBILITY / BUGS</title>
<para>
<command>b10-host</command> does not do reverse lookups by
default yet (by detecting if name is a IPv4 or IPv6 address).
</para>
<para>
Unknown <option>-c</option> class or <option>-t</option> type
causes <command>b10-host</command> to Abort.
</para>
<para>
Not all types are supported yet for formatting.
Not all switches are supported yet.
</para>
<para>
It doesn't use <filename>/etc/resolv.conf</filename> at this time.
The default name server used is 127.0.0.1.
</para>
<para>
<command>b10-host</command> does not do reverse lookups by
default yet (by detecting if name is a IPv4 or IPv6 address).
</para>
<para>
<option>-p</option> is not a standard feature.
</para>
</refsect1>
<refsect1>
<title>HISTORY</title>
<para>
The C++ version of <command>b10-host</command> was started in
October 2009 by Jeremy C. Reed of ISC.
Its usage and output are based on the standard <command>host</command>
Its usage and output were based on the standard <command>host</command>
command.
</para>
</refsect1>
......
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