chapter06/libpipeline.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-libpipeline" role="wrap">
   9   <?dbhtml filename="libpipeline.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>libpipeline</productname>
  13     <productnumber>&libpipeline-version;</productnumber>
  14     <address>&libpipeline-url;</address>
  15   </sect1info>
  16
  17   <title>Libpipeline-&libpipeline-version;</title>
  18
  19   <indexterm zone="ch-system-libpipeline">
  20     <primary sortas="a-Libpipeline">Libpipeline</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Libpipeline package contains a library for manipulating pipelines
  27     of subprocesses in a flexible and convenient way.</para>
  28
  29     <segmentedlist>
  30       <segtitle>&buildtime;</segtitle>
  31       <segtitle>&diskspace;</segtitle>
  32
  33       <seglistitem>
  34         <seg>&libpipeline-ch6-sbu;</seg>
  35         <seg>&libpipeline-ch6-du;</seg>
  36       </seglistitem>
  37     </segmentedlist>
  38
  39   </sect2>
  40
  41   <sect2 role="installation">
  42     <title>Installation of Libpipeline</title>
  43
  44     <para>Prepare Libpipeline for compilation:</para>
  45
  46 <screen><userinput remap="configure">PKG_CONFIG_PATH=/tools/lib/pkgconfig ./configure --prefix=/usr</userinput></screen>
  47
  48     <variablelist>
  49       <title>The meaning of the configure options:</title>
  50
  51       <varlistentry>
  52         <term><parameter>PKG_CONFIG_PATH</parameter></term>
  53         <listitem>
  54           <para>Use pkg-config to obtain the location of the test
  55           library metadata built in <xref linkend="ch-tools-check"/>.</para>
  56         </listitem>
  57       </varlistentry>
  58
  59     </variablelist>
  60
  61     <para>Compile the package:</para>
  62
  63 <screen><userinput remap="make">make</userinput></screen>
  64
  65     <para>To test the results, issue:</para>
  66
  67 <screen><userinput remap="test">make check</userinput></screen>
  68
  69     <para>Install the package:</para>
  70
  71 <screen><userinput remap="install">make install</userinput></screen>
  72
  73   </sect2>
  74
  75   <sect2 id="contents-libpipeline" role="content">
  76     <title>Contents of Libpipeline</title>
  77
  78     <segmentedlist>
  79       <segtitle>Installed library</segtitle>
  80
  81       <seglistitem>
  82         <seg>libpipeline.so</seg>
  83       </seglistitem>
  84     </segmentedlist>
  85
  86     <variablelist>
  87       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  88       <?dbfo list-presentation="list"?>
  89       <?dbhtml list-presentation="table"?>
  90
  91       <varlistentry id="libpipeline">
  92         <term><filename class="libraryfile">libpipeline</filename></term>
  93         <listitem>
  94           <para>This library is used to safely construct pipelines between
  95           subprocesses</para>
  96           <indexterm zone="ch-system-libpipeline">
  97             <primary sortas="c-libpipeline">libpipeline</primary>
  98           </indexterm>
  99         </listitem>
 100       </varlistentry>
 101     </variablelist>
 102
 103   </sect2>
 104
 105 </sect1>