source: networking/netlibs/libmnl.xml@ 868811b

<?xml version="1.0" encoding="UTF-8"?>
<!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 libmnl-download-http "https://netfilter.org/projects/libmnl/files/libmnl-&libmnl-version;.tar.bz2">
  <!ENTITY libmnl-download-ftp  " ">
  <!ENTITY libmnl-md5sum        "0bbb70573119ec5d49435114583e7a49">
  <!ENTITY libmnl-size          "308 KB">
  <!ENTITY libmnl-buildsize     "2.9 MB">
  <!ENTITY libmnl-time          "less than 0.1 SBU">
]>

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


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

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

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

    <para>
      The <application>libmnl</application> library provides a minimalistic
      userspace library oriented to Netlink developers. There are a lot of
      common tasks in the parsing, validating, and constructing of both the Netlink
      header and TLVs that are repetitive and easy to get wrong. This library
      aims to provide simple helpers that allow you to re-use code and to
      avoid re-inventing the wheel.
    </para>

    &lfs121_checked;

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

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

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>
      This 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 install</userinput></screen>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Library</segtitle>

      <seglistitem>
        <seg>
          libmnl.so
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libmnl-lib">
        <term><filename class="libraryfile">libmnl.so</filename></term>
        <listitem>
          <para>
            provides functions for parsing, validating, constructing of both
            the Netlink header and TLVs
          </para>
          <indexterm zone="libmnl libmnl-lib">
            <primary sortas="c-libmnl">libmnl.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>