lfs-book/chapter06/libnl.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;
]>

<sect1 id="ch-system-libnl" role="wrap">
  <?dbhtml filename="libnl.html"?>

  <sect1info condition="script">
    <productname>libnl</productname>
    <productnumber>&libnl-version;</productnumber>
    <address>&libnl-url;</address>
  </sect1info>

  <title>Libnl-&libnl-version;</title>

  <indexterm zone="ch-system-libnl">
    <primary sortas="a-Libnl">Libnl</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Libnl package contains a collection of libraries providing APIs to netlink protocol based
    Linux kernel interfaces.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>

      <seglistitem>
        <seg>&libnl-ch6-sbu;</seg>
        <seg>&libnl-ch6-du;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

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

    <para>Prepare Libnl for compilation:</para>

<screen><userinput remap="configure">./configure --prefix=/usr --sysconfdir=/etc</userinput></screen>

    <para>Compile the package:</para>

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

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

    <para>Install the package:</para>

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

  </sect2>

  <sect2 id="contents-libnl" role="content">
    <title>Contents of Libnl</title>

    <segmentedlist>
      <segtitle>Installed libraries</segtitle>
      <segtitle>Installed directories</segtitle>

      <seglistitem>
        <seg>libnl-cli.so,libnl-genl.so,libnl-nf.so,libnl-route.so,
        libnl.so</seg>
        <seg>/etc/libnl,/usr/include/netlink,/usr/include/netlink/genl,
        /usr/include/netlink/netfilter,/usr/include/netlink/route</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libnl-cli">
        <term><filename class="libraryfile">libnl-cli</filename></term>
        <listitem>
          <para></para>
          <indexterm zone="ch-system-libnl">
            <primary sortas="c-libnl-cli">libnl-cli</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnl-genl">
        <term><filename class="libraryfile">libnl-genl</filename></term>
        <listitem>
          <para>Contains support for the generic netlink protocol, an extended version of the netlink
          protocol</para>
          <indexterm zone="ch-system-libnl">
            <primary sortas="c-libnl-genl">libnl-genl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnl-nf">
        <term><filename class="libraryfile">libnl-nf</filename></term>
        <listitem>
          <para>Contains support for netlink based netfilter configuration and monitoring interfaces
          (conntrack, log, queue)</para>
          <indexterm zone="ch-system-libnl">
            <primary sortas="c-libnl-nf">libnl-nf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnl-route">
        <term><filename class="libraryfile">libnl-route</filename></term>
        <listitem>
          <para>Contains support for the configuration of interfaces of the NETLINK_ROUTE family including
          network interfaces, routes, addresses, neighbours, and traffic control</para>
          <indexterm zone="ch-system-libnl">
            <primary sortas="c-libnl-route">libnl-route</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnl">
        <term><filename class="libraryfile">libnl</filename></term>
        <listitem>
          <para>Contains support for implementing the fundamentals required to use the netlink protocol
          such as socket handling, message construction and parsing, and sending and receiving of
          data.</para>
          <indexterm zone="ch-system-libnl">
            <primary sortas="c-libnl">libnl</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>