source: networking/netutils/whois.xml@ e6fb085

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY whois-download-http "http://ftp.debian.org/debian/pool/main/w/whois/whois_&whois-version;.tar.xz">
  <!ENTITY whois-download-ftp  "ftp://ftp.debian.org/debian/pool/main/w/whois/whois_&whois-version;.tar.xz">
  <!ENTITY whois-md5sum        "5dfcf14c7c00a01f34966a920c8b97c2">
  <!ENTITY whois-size          "84 KB">
  <!ENTITY whois-buildsize     "1.2 MB">
  <!ENTITY whois-time          "less than 0.1 SBU">
]>

<sect1 id="whois" xreflabel="Whois-&whois-version;">
  <?dbhtml filename="whois.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Whois-&whois-version;</title>

  <indexterm zone="whois">
    <primary sortas="a-Whois">Whois</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Whois</title>

    <para><application>Whois</application> is a client-side application which
    queries the whois directory service for information pertaining to a
    particular domain name. This package will install two programs by default:
    <command>whois</command> and <command>mkpasswd</command>. The
    <command>mkpasswd</command> command is also installed by the
    <xref linkend="expect"/> package.</para>

    &lfs81_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&whois-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&whois-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &whois-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &whois-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &whois-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &whois-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Whois Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="libidn"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/whois"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Whois</title>

    <para>Build the application with:</para>

<screen><userinput>make</userinput></screen>

    <para>You can install the <command>whois</command> program, the
    <command>mkpasswd</command> program, and the locale files independently.
    Control your choice of what is installed with the following commands issued
    as the <systemitem class="username">root</systemitem> user:</para>

    <note><para>Installing this version of <command>mkpasswd</command> will
    overwrite the same command installed by <xref
    linkend="expect"/>.</para></note>

<!-- dev note: make BASEDIR=<DESTDIR> prefix=/usr install-whois -->

<screen role="root"><userinput>make prefix=/usr install-whois
make prefix=/usr install-mkpasswd
make prefix=/usr install-pos</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <option>HAVE_LIBIDN=1</option>: This make variable adds internationalized
      string handling support to <command>whois</command>.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>whois and mkpasswd</seg>
        <seg>None</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="whois-prog">
        <term><command>whois</command></term>
        <listitem>
          <para>is a client-side application which queries the whois directory
          service for information pertaining to a particular domain name.</para>
          <indexterm zone="whois whois-prog">
            <primary sortas="b-whois">whois</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="mkpasswd-whois">
        <term><command>mkpasswd</command></term>
        <listitem>
          <para>
            generates a new password, and optionally applies it to a user.
          </para>
          <indexterm zone="whois mkpasswd-whois">
            <primary sortas="b-mkpasswd-whois">mkpasswd</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>