source: general/genlib/npth.xml@ 3c0e3458

<?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 npth-download-http "&gnupg-http;/npth/npth-&npth-version;.tar.bz2">
  <!ENTITY npth-download-ftp  " ">
  <!ENTITY npth-md5sum        "375d1a15ad969f32d25f1a7630929854">
  <!ENTITY npth-size          "296 KB">
  <!ENTITY npth-buildsize     "2.6 MB (with checks)">
  <!ENTITY npth-time          "less than 0.1 SBU (with checks)">
]>

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


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

  <indexterm zone="npth">
    <primary sortas="a-NPth">NPth</primary>
  </indexterm>

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

    <para>
      The <application>NPth</application> package contains a very portable
      POSIX/ANSI-C based library for Unix platforms which provides
      non-preemptive priority-based scheduling for multiple threads of
      execution (multithreading) inside event-driven applications. All threads
      run in the same address space of the server application, but each thread
      has its own individual program-counter, run-time stack, signal mask and
      errno variable.
    </para>

    &lfs120_checked;

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

  </sect2>

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

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

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

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

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

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>
<!--
  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>sed -i 's#$(LOBJS) ...</command>: This <command>sed</command>
      fixes a race condition in the <filename>Makefile</filename>. It allows
      running <command>make</command> with multiple jobs (e.g., <command>make
      -j4</command>).
    </para>

    <para>
      <option>-\-disable-static</option>: This option stops it compiling a
      static version of the library.
    </para>

    <para>
      <option>-\-mandir=/usr/share/man</option>: This option puts the man
      pages in <filename class="directory">/usr/share/man</filename> and not
      <filename class="directory">/usr/man</filename>.
    </para>
  </sect2>-->

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>npth-config</seg>
        <seg>libnpth.so</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="npth-config">
        <term><command>npth-config</command></term>
        <listitem>
          <para>
            is a utility used to configure and build applications based on
            the npth library. It can be used to query the C compiler and
            linker flags which are required to correctly compile and link the
            application against the npth library
          </para>
          <indexterm zone="npth npth-config">
            <primary sortas="b-npth-config">npth-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnpth">
        <term><filename class="libraryfile">libnpth.so</filename></term>
        <listitem>
          <para>
            contains the API functions used by the New Portable Threads
            Library
          </para>
          <indexterm zone="npth libnpth">
            <primary sortas="c-libnpth">libnpth.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>