BOOK/chapter06/pcre.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-pcre" role="wrap">
   9   <?dbhtml filename="pcre.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>pcre</productname>
  13     <productnumber>&pcre-version;</productnumber>
  14     <address>&pcre-url;</address>
  15   </sect1info>
  16
  17   <title>PCRE-&pcre-version;</title>
  18
  19   <indexterm zone="ch-system-pcre">
  20     <primary sortas="a-PCRE">PCRE</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The PCRE package contains Perl Compatible Regular Expression
  27     libraries. These are useful for implementing regular expression pattern
  28     matching using the same syntax and semantics as Perl 5.</para>
  29
  30     <segmentedlist>
  31       <segtitle>&buildtime;</segtitle>
  32       <segtitle>&diskspace;</segtitle>
  33
  34       <seglistitem>
  35         <seg>&pcre-ch6-sbu;</seg>
  36         <seg>&pcre-ch6-du;</seg>
  37       </seglistitem>
  38     </segmentedlist>
  39
  40   </sect2>
  41
  42   <sect2 role="installation">
  43     <title>Installation of PCRE</title>
  44
  45     <para>Prepare PCRE for compilation:</para>
  46
  47 <screen><userinput remap="configure">./configure --prefix=/usr \
  48             --docdir=/usr/share/doc/pcre-&pcre-version; \
  49             --enable-utf8 \
  50             --enable-unicode-properties \
  51             --enable-pcregrep-libz \
  52             --enable-pcregrep-libbz2</userinput></screen>
  53
  54     <variablelist>
  55       <title>The meaning of the configure options:</title>
  56
  57       <varlistentry>
  58         <term><parameter>--enable-utf8</parameter></term>
  59         <listitem>
  60           <para>This switch includes the code for handling UTF-8 character
  61                 strings in the library.</para>
  62         </listitem>
  63       </varlistentry>
  64       <varlistentry>
  65         <term><parameter>--enable-unicode-properties</parameter></term>
  66         <listitem>
  67           <para>This switch enables Unicode properties support.</para>
  68         </listitem>
  69       </varlistentry>
  70       <varlistentry>
  71         <term><parameter>--enable-pcregrep-lib*</parameter></term>
  72         <listitem>
  73           <para>These switches enable the PCRE library to read files compressed
  74           with <command>gzip</command> and <command>bzip2</command>.</para>
  75         </listitem>
  76       </varlistentry>
  77     </variablelist>
  78
  79     <para>Compile the package:</para>
  80
  81 <screen><userinput remap="make">make</userinput></screen>
  82
  83     <para>To test the results, issue:</para>
  84
  85 <screen><userinput remap="test">make check</userinput></screen>
  86
  87     <para>Install the package:</para>
  88
  89 <screen><userinput remap="install">make install</userinput></screen>
  90
  91     <para>The <command>grep</command> binary will be installed in <filename class="directory">/bin</filename> and will link against the PCRE library; as such,
  92 move the library to <filename class="directory">/lib</filename>:</para>
  93
  94 <screen><userinput remap="install">mv -v /usr/lib/libpcre.so.* /lib/
  95 ln -v -sf ../../lib/libpcre.so.0 /usr/lib/libpcre.so</userinput></screen>
  96
  97   </sect2>
  98
  99   <sect2 id="contents-pcre" role="content">
 100     <title>Contents of PCRE</title>
 101
 102     <segmentedlist>
 103       <segtitle>Installed programs</segtitle>
 104       <segtitle>Installed libraries</segtitle>
 105       <segtitle>Installed directories</segtitle>
 106
 107       <seglistitem>
 108         <seg>pcregrep, pcretest, and pcre-config</seg>
 109         <seg>libpcre.{a,so}, libpcrecpp.{a,so} and libpcreposix.{a,so}</seg>
 110         <seg>/usr/share/doc/pcre-&pcre-version;</seg>
 111       </seglistitem>
 112     </segmentedlist>
 113
 114     <variablelist>
 115       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 116       <?dbfo list-presentation="list"?>
 117       <?dbhtml list-presentation="table"?>
 118
 119       <varlistentry id="pcregrep">
 120         <term><command>pcregrep</command></term>
 121         <listitem>
 122           <para>A grep that understands Perl compatible regular
 123           expressions.</para>
 124           <indexterm zone="ch-system-pcre pcregrep">
 125             <primary sortas="b-pcre">pcregrep</primary>
 126           </indexterm>
 127         </listitem>
 128       </varlistentry>
 129
 130       <varlistentry id="pcretest">
 131         <term><command>pcretest</command></term>
 132         <listitem>
 133           <para>Tests a Perl compatible regular expression</para>
 134           <indexterm zone="ch-system-pcre pcretest">
 135             <primary sortas="b-pcretest">pcretest</primary>
 136           </indexterm>
 137         </listitem>
 138       </varlistentry>
 139
 140       <varlistentry id="pcre-config">
 141         <term><command>pcre-config</command></term>
 142         <listitem>
 143           <para>Used during the compilation process of programs linking to the
 144           PCRE libraries</para>
 145           <indexterm zone="ch-system-pcre pcre-config">
 146             <primary sortas="b-pcre-config">pcre-config</primary>
 147           </indexterm>
 148         </listitem>
 149       </varlistentry>
 150
 151       <varlistentry id="libpcre">
 152         <term><filename class="libraryfile">libpcre</filename></term>
 153         <listitem>
 154           <para>Provides functions useful for working with regular
 155           expressions</para>
 156           <indexterm zone="ch-system-pcre libpcre">
 157             <primary sortas="c-libpcre">libpcre</primary>
 158           </indexterm>
 159         </listitem>
 160       </varlistentry>
 161
 162       <varlistentry id="libpcrecpp">
 163         <term><filename class="libraryfile">libpcrecpp</filename></term>
 164         <listitem>
 165           <para>Provides C++ wrapper functions for the libpcre library</para>
 166           <indexterm zone="ch-system-pcre libpcrecpp">
 167             <primary sortas="c-libpcrecpp">libpcrecpp</primary>
 168           </indexterm>
 169         </listitem>
 170       </varlistentry>
 171
 172       <varlistentry id="libpcreposix">
 173         <term><filename class="libraryfile">libpcreposix</filename></term>
 174         <listitem>
 175           <para>Provides wrapper functions based on the POSIX regular expression
 176           API</para>
 177           <indexterm zone="ch-system-pcre libpcreposix">
 178             <primary sortas="c-libpcreposix">libpcreposix</primary>
 179           </indexterm>
 180         </listitem>
 181       </varlistentry>
 182
 183     </variablelist>
 184
 185   </sect2>
 186
 187 </sect1>