kea/examples/host/b10-host.xml

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
	       [<!ENTITY mdash "&#8212;">]>
<!--
 - 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
 - copyright notice and this permission notice appear in all copies.
 -
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
-->

<!-- $Id$ -->
<refentry>

  <refentryinfo>
    <date>May 4, 2011</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>b10-host</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo>BIND10</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>b10-host</refname>
    <refpurpose>DNS lookup utility</refpurpose>
  </refnamediv>

  <docinfo>
    <copyright>
      <year>2011</year>
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <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>-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>
      <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 were based on the standard <command>host</command>
      command.
    </para>
  </refsect1>
</refentry><!--
 - Local variables:
 - mode: sgml
 - End:
-->