source: BOOK/final-system/common/libpipeline.xml@ 47925ee

<?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-libpipeline" role="wrap">
  <?dbhtml filename="libpipeline.html"?>

  <title>Libpipeline-&libpipeline-version;</title>

  <indexterm zone="ch-system-libpipeline">
    <primary sortas="a-Libpipeline">Libpipeline</primary>
  </indexterm>

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

    <para>The Libpipeline package contains a library for manipulating pipelines
    of subprocesses in a flexible and convenient way.</para>

  </sect2>

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

    <para os="a">Prepare Libpipeline for compilation:</para>

<screen os="b"><userinput>PKG_CONFIG_PATH=/tools/lib/pkgconfig ./configure --prefix=/usr</userinput></screen>

    <variablelist os="c">
      <title>The meaning of the configure option:</title>

      <varlistentry>
        <term><envar>PKG_CONFIG_PATH</envar></term>
        <listitem>
          <para>Use pkg-config to obtain the location of the test library
          metadata built in <xref linkend="ch-temp-system-check"/>.</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <para os="d">Compile the package:</para>

<screen os="e"><userinput>make</userinput></screen>

    <para os="f">To test the results, issue:</para>

<screen os="g"><userinput remap="test">make check</userinput></screen>

    <para os="h">Install the package:</para>

<screen os="i"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 id="contents-libpipeline" role="content">
    <title>Contents of Libpipeline</title>

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

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

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

      <varlistentry id="libpipeline">
        <term><filename class="libraryfile">libpipeline</filename></term>
        <listitem>
          <para>This library is used to safely construct pipeline between
          subprocesses</para>
          <indexterm zone="ch-system-libpipeline libpipeline">
            <primary sortas="c-libpipeline">libpipeline</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>