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

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

  <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>

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

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

  </sect2>

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

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

<screen><userinput remap="configure">./configure CHECK_CFLAGS=-I/tools/include \
    CHECK_LIBS="-L/tools/lib -lcheck" --prefix=/usr</userinput></screen>

    <variablelist>
      <title>The meaning of the configure options:</title>

      <varlistentry>
        <term><parameter>CHECK_CFLAGS=, CHECK_LIBS=</parameter></term>
        <listitem>
          <para>These environment variables specify the location of the test
          library built in <xref linkend="ch-tools-check"/>.</para>
        </listitem>
      </varlistentry>

    </variablelist>

    <para>Compile the package:</para>

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

    <para>To test the results, issue:</para>

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

    <para>Install the package:</para>

<screen><userinput remap="install">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 pipelines between
          subprocesses</para>
          <indexterm zone="ch-system-libpipeline">
            <primary sortas="c-libpipeline">libpipeline</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>