glfs/networking/netutils/bind-utils.xml
Pierre Labastie 9eb48607cf Reinstate doc building for bind-utils:
Doc building does not use sphinx if it is not available, but still
generate manual pages, which may be very useful for complex
applications such as dig.
Note that if sphinx is available, more detailed docs are generated,
but with our current instructions, they are not installed.
2022-11-19 15:35:56 +01:00

188 lines
5.6 KiB
XML

<?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 bind-download-http "https://ftp.isc.org/isc/bind9/&bind-version;/bind-&bind-version;.tar.xz">
<!ENTITY bind-download-ftp "ftp://ftp.isc.org/isc/bind9/&bind-version;/bind-&bind-version;.tar.xz">
<!ENTITY bind-md5sum "542ba7a0ae0cb2de151186bd7de4e9cb">
<!ENTITY bind-size "5.0 MB">
<!ENTITY bind-utils-buildsize "102 MB">
<!ENTITY bind-utils-time "0.2 SBU">
]>
<sect1 id="bind-utils" xreflabel="BIND Utilities-&bind-version;">
<?dbhtml filename="bind-utils.html"?>
<sect1info>
<date>$Date$</date>
</sect1info>
<title>BIND Utilities-&bind-version;</title>
<indexterm zone="bind-utils">
<primary sortas="a-BIND-Utilities">BIND Utilities</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to BIND Utilities</title>
<para>
<application>BIND Utilities</application> is not a separate
package, it is a collection of the client side programs that are included
with <xref linkend="bind"/>. The <application>BIND</application>
package includes the client side programs <command>nslookup</command>,
<command>dig</command> and <command>host</command>. If you install
<application>BIND</application> server, these programs will be installed
automatically. This section is for those users who don't need the complete
<application>BIND</application> server, but need these
client side applications.</para>
&lfs112_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&bind-download-http;"/></para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&bind-download-ftp;"/></para>
</listitem>
<listitem>
<para>
Download MD5 sum: &bind-md5sum;</para>
</listitem>
<listitem>
<para>
Download size: &bind-size;</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &bind-utils-buildsize;</para>
</listitem>
<listitem>
<para>
Estimated build time: &bind-utils-time;</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">BIND Utilities Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="libuv"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="json-c"/> and
<xref linkend="nghttp2"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="libcap-pam"/>,
<xref linkend="libxml2"/>, and
<ulink url="https://www.sphinx-doc.org/en/master/">Sphinx</ulink>
</para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/bind-utils"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of BIND Utilities</title>
<para>
Install <application>BIND Utilities</application> by
running the following commands:</para>
<screen><userinput>./configure --prefix=/usr &amp;&amp;
make -C lib/isc &amp;&amp;
make -C lib/dns &amp;&amp;
make -C lib/ns &amp;&amp;
make -C lib/isccfg &amp;&amp;
make -C lib/bind9 &amp;&amp;
make -C lib/irs &amp;&amp;
make -C bin/dig &amp;&amp;
make -C doc</userinput></screen>
<para>
This portion of the package does not come with a test suite.</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:</para>
<screen role='root'><userinput>make -C lib/isc install &amp;&amp;
make -C lib/dns install &amp;&amp;
make -C lib/ns install &amp;&amp;
make -C lib/isccfg install &amp;&amp;
make -C lib/bind9 install &amp;&amp;
make -C lib/irs install &amp;&amp;
make -C bin/dig install &amp;&amp;
cp -v doc/man/{dig.1,host.1,nslookup.1} /usr/share/man/man1</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<option>--disable-doh</option>: Use this option if you have not installed
<xref linkend="nghttp2" role="nodep"/> and you don't need DNS over HTTPS
support.
</para>
<para>
<command>make -C lib/...</command>: These commands build the
libraries that are needed for the client programs.
</para>
<para>
<command>make -C bin/dig</command>: This command builds the
client programs.
</para>
<para>
<command>make -C doc</command>: This command builds the
manual pages if the optional Python module
<ulink url="https://www.sphinx-doc.org/en/master/">Sphinx</ulink>
is installed.
</para>
<para>
Use <command>cp -v doc/man/{dig.1,host.1,nslookup.1} /usr/share/man/man1</command>
to install the the manual pages if they have been built.
</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>dig, host, and nslookup</seg>
<seg>None</seg>
<seg>None</seg>
</seglistitem>
</segmentedlist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<para>
See the program descriptions in the <xref linkend="bind"/> section.
</para>
</sect2>
</sect1>