source: networking/netlibs/c-ares.xml@ 3f2db3a6

<?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 c-ares-download-http "https://c-ares.haxx.se/download/c-ares-&c-ares-version;.tar.gz">
  <!ENTITY c-ares-download-ftp  " ">
  <!ENTITY c-ares-md5sum        "bf770c0d3131ec0dd0575a0d2dcab226">
  <!ENTITY c-ares-size          "1.5 MB">
  <!ENTITY c-ares-buildsize     "12 MB">
  <!ENTITY c-ares-time          "less than 0.1 SBU">
]>

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


  <title>c-ares-&c-ares-version;</title>

  <indexterm zone="c-ares">
    <primary sortas="a-c-ares">c-ares</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to c-ares</title>

    <para>
      <application>c-ares</application> is a C library for asynchronous DNS
      requests.
    </para>

    &lfs112_checked;

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

    <bridgehead renderas="sect3">c-ares Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of c-ares</title>

    <para>
      Install <application>c-ares</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake  -DCMAKE_INSTALL_PREFIX=/usr .. &amp;&amp;
make</userinput></screen>

    <para>
      This package does not include a test suite.
    </para>

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

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

  </sect2>

<!-- Since moving to CMake, we don't need this anymore.
  <sect2 role="commands">
    <title>Command Explanations</title>

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

  </sect2>
-->

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

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

      <seglistitem>
        <seg>
          acountry, adig, and ahost
        </seg>
        <seg>
          libcares.so
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="acountry">
        <term><command>acountry</command></term>
        <listitem>
          <para>
            prints the country where an IPv4 address or host is located
          </para>
          <indexterm zone="c-ares acountry">
            <primary sortas="b-acountry">acountry</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="adig">
        <term><command>adig</command></term>
        <listitem>
          <para>
            queries information from DNS servers
          </para>
          <indexterm zone="c-ares adig">
            <primary sortas="b-adig">adig</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ahost">
        <term><command>ahost</command></term>
        <listitem>
          <para>
            prints the A or AAAA record associated with a hostname
            or IP address
          </para>
          <indexterm zone="c-ares ahost">
            <primary sortas="b-ahost">ahost</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="c-ares-lib">
        <term><filename class="libraryfile">libcares.so</filename></term>
        <listitem>
          <para>
            is a C library for asynchronous DNS requests
          </para>
          <indexterm zone="c-ares c-ares-lib">
            <primary sortas="c-c-ares">c-ares.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>