source: networking/netlibs/ldns.xml@ 8558044

<?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 ldns-download-http "https://www.nlnetlabs.nl/downloads/ldns/ldns-&ldns-version;.tar.gz">
  <!ENTITY ldns-download-ftp  " ">
  <!ENTITY ldns-md5sum        "166262a46995d9972aba417fd091acd5">
  <!ENTITY ldns-size          "1.2 MB">
  <!ENTITY ldns-buildsize     "28 MB (with docs)">
  <!ENTITY ldns-time          "0.2 SBU (with docs)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>ldns-&ldns-version;</title>

  <indexterm zone="ldns">
    <primary sortas="a-ldns">ldns</primary>
  </indexterm>

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

    <para>
      <application>ldns</application> is a fast DNS library with the goal to
      simplify DNS programming and to allow developers to easily create software
      conforming to current RFCs and Internet drafts. This packages also
      includes the <command>drill</command> tool.
    </para>

    &lfs110a_checked;

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

    <bridgehead renderas="sect3">ldns Dependencies</bridgehead>
<!--
    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="openssl"/>
    </para>
-->
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="make-ca"/> and
      <xref linkend="libpcap"/> (for example programs),
      <xref linkend="python2"/> and
      <xref linkend="swig"/> (for Python bindings), and
      <xref linkend="doxygen"/> (for html documentation)
    </para>

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

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

    <para>
      Install <application>ldns</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr           \
            --sysconfdir=/etc       \
            --disable-static        \
            --with-drill            &amp;&amp;
make</userinput></screen>

    <para>
      If you have <xref linkend="doxygen"/> installed and want to build
      html documentation, run the following command:
    </para>

<screen remap="doc"><userinput>make doc</userinput></screen>

    <para>
      This package does not come with a working test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>
      If you built html documentation, install it by running the following
      commands as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"
        remap="doc"><userinput>install -v -m755 -d /usr/share/doc/ldns-&ldns-version; &amp;&amp;
install -v -m644 doc/html/* /usr/share/doc/ldns-&ldns-version;</userinput></screen>

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <para>
      <parameter>--with-drill</parameter>: This option enables building of the
      <command>drill</command> tool (used for obtaining debug information
      from DNS(SEC))
    </para>

    <para>
      <option>--disable-dane-ta-usage</option>: This option disables DANE-TA
      (DNS-Based Authentication of Named Entities) support.  It is only needed
      if OpenSSL-1.1.0 or later is not installed.
    </para>

    <para>
      <option>--with-examples</option>: This option enables building of the
      example programs.
    </para>

    <para>
      <option>--with-pyldns</option>: This option enables building of the Python
      bindings.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          drill and ldns-config
        </seg>
        <seg>
          libldns.so and
          /usr/lib/python&python2-majorver;/site-packages/_ldns.so
        </seg>
        <seg>
          /usr/include/ldns and /usr/share/doc/ldns-&ldns-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="drill">
        <term><command>drill</command></term>
        <listitem>
          <para>
            is a tool like <command>dig</command> from
            <xref linkend="bind-utils"/> designed to get all sorts of
            information out of the DNS
          </para>
          <indexterm zone="ldns drill">
            <primary sortas="b-drill">drill</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ldns-config">
        <term><command>ldns-config</command></term>
        <listitem>
          <para>
            shows compiler and linker flags for ldns usage
          </para>
          <indexterm zone="ldns ldns-config">
            <primary sortas="b-ldns-config">ldns-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libldns">
        <term><filename class="libraryfile">libldns.so</filename></term>
        <listitem>
          <para>
            provides the <application>ldns</application> API functions to
            programs
          </para>
          <indexterm zone="ldns libldns">
            <primary sortas="c-libldns">libldns.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>