libpipeline.xml 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  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. <sect1 id="ch-system-libpipeline" role="wrap">
  8. <?dbhtml filename="libpipeline.html"?>
  9. <sect1info condition="script">
  10. <productname>libpipeline</productname>
  11. <productnumber>&libpipeline-version;</productnumber>
  12. <address>&libpipeline-url;</address>
  13. </sect1info>
  14. <title>Libpipeline-&libpipeline-version;</title>
  15. <indexterm zone="ch-system-libpipeline">
  16. <primary sortas="a-Libpipeline">Libpipeline</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The Libpipeline package contains a library for manipulating pipelines
  21. of subprocesses in a flexible and convenient way.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&libpipeline-ch6-sbu;</seg>
  27. <seg>&libpipeline-ch6-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. </sect2>
  31. <sect2 role="installation">
  32. <title>Installation of Libpipeline</title>
  33. <para>Prepare Libpipeline for compilation:</para>
  34. <screen><userinput remap="configure">./configure --prefix=/usr</userinput></screen>
  35. <!--
  36. <screen><userinput remap="configure">PKG_CONFIG_PATH=/tools/lib/pkgconfig ./configure - -prefix=/usr</userinput></screen>
  37. <variablelist>
  38. <title>The meaning of the configure options:</title>
  39. <varlistentry>
  40. <term><parameter>PKG_CONFIG_PATH</parameter></term>
  41. <listitem>
  42. <para>Use pkg-config to obtain the location of the test
  43. library metadata built in <xref linkend="ch-tools-check"/>.</para>
  44. </listitem>
  45. </varlistentry>
  46. </variablelist>
  47. -->
  48. <para>Compile the package:</para>
  49. <screen><userinput remap="make">make</userinput></screen>
  50. <para>To test the results, issue:</para>
  51. <screen><userinput remap="test">make check</userinput></screen>
  52. <para>Install the package:</para>
  53. <screen><userinput remap="install">make install</userinput></screen>
  54. </sect2>
  55. <sect2 id="contents-libpipeline" role="content">
  56. <title>Contents of Libpipeline</title>
  57. <segmentedlist>
  58. <segtitle>Installed library</segtitle>
  59. <seglistitem>
  60. <seg>libpipeline.so</seg>
  61. </seglistitem>
  62. </segmentedlist>
  63. <variablelist>
  64. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  65. <?dbfo list-presentation="list"?>
  66. <?dbhtml list-presentation="table"?>
  67. <varlistentry id="libpipeline">
  68. <term><filename class="libraryfile">libpipeline</filename></term>
  69. <listitem>
  70. <para>This library is used to safely construct pipelines between
  71. subprocesses</para>
  72. <indexterm zone="ch-system-libpipeline">
  73. <primary sortas="c-libpipeline">libpipeline</primary>
  74. </indexterm>
  75. </listitem>
  76. </varlistentry>
  77. </variablelist>
  78. </sect2>
  79. </sect1>