source: general/genlib/pcre.xml@ f77b0b9

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

  <!ENTITY pcre-download-http "http://downloads.sourceforge.net/pcre/pcre-&pcre-version;.tar.bz2">
  <!ENTITY pcre-download-ftp  "ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-&pcre-version;.tar.bz2">
  <!ENTITY pcre-md5sum        "2af38e083fb90ef60fa9eda7cc290e86">
  <!ENTITY pcre-size          "780 KB">
  <!ENTITY pcre-buildsize     "11 MB">
  <!ENTITY pcre-time          "0.3 SBU">
]>

<sect1 id="pcre" xreflabel="PCRE-&pcre-version;">
  <?dbhtml filename="pcre.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>PCRE-&pcre-version;</title>

  <indexterm zone="pcre">
    <primary sortas="a-PCRE">PCRE</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to PCRE</title>

    <para>The <application>PCRE</application> package contains
    <application>Perl</application> Compatible Regular Expression
    libraries. These are useful for implementing regular expression pattern
    matching using the same syntax and semantics as
    <application>Perl</application> 5.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&pcre-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&pcre-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &pcre-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &pcre-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &pcre-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &pcre-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required Patch: <ulink
          url="&patch-root;/pcre-&pcre-version;-abi_breakage-1.patch"/></para>
      </listitem>
      <listitem>
        <para>Required Patch: <ulink
          url="&patch-root;/pcre-&pcre-version;-security_fix-1.patch"/></para>
      </listitem>
    </itemizedlist>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/pcre"/></para>

  </sect2>

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

    <para>Install <application>PCRE</application> by running
    the following commands:</para>

<screen><userinput>patch -Np1 -i ../pcre-&pcre-version;-abi_breakage-1.patch &amp;&amp;
./configure --prefix=/usr \
            --docdir=/usr/share/doc/pcre-&pcre-version; \
            --enable-utf8 \
            --enable-pcregrep-libz \
            --enable-pcregrep-libbz2 &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>. Note:
    The third set of the tests cannot be run if the "fr_FR" locale is missing
    from the system.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>If you reinstall <application>Grep</application> after installing
    <application>PCRE</application>, <application>Grep</application> will get
    linked against <application>PCRE</application> and may cause problems if
    <filename class="directory">/usr</filename> is a separate mount point. To avoid
    this, either pass the option <option>--disable-perl-regexp</option> when executing
    <command>./configure</command> for <application>Grep</application> or move
    <filename class="libraryfile">libpcre</filename> to <filename
    class="directory">/lib</filename> as follows.</para>

<screen role="root"><userinput>mv -v /usr/lib/libpcre.so.* /lib/ &amp;&amp;
ln -v -sf ../../lib/libpcre.so.0 /usr/lib/libpcre.so</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--enable-utf8</parameter>: This switch includes the code for
    handling UTF-8 character strings in the library.</para>

    <para><parameter>--enable-unicode-properties</parameter>: This switch
    enables Unicode properties support.</para>

    <!-- [ag] Glib-2.12.* hasn't yet has this switch. Un-comment for
    glib-2.16.* and newer and merge the note in the above para.
    Also for consistency, replace (&dash;&dash;) with two dashes.

    Note: You need this switch if you are going to build
    <xref linkend="glib2"/> with the
    <parameter>&dash;&dash;with-pcre=system</parameter> switch. -->

    <para><parameter>--enable-pcregrep-libz</parameter>: This switch adds
    support to <command>pcregrep</command> to read
    <filename class='extension'>.gz</filename> compressed files.</para>

    <para><parameter>--enable-pcregrep-libbz2</parameter>: This switch adds
    support to <command>pcregrep</command> to read
    <filename class='extension'>.bz2</filename> compressed files.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>pcregrep, pcretest, and pcre-config</seg>
        <seg>libpcre.{so,a}, libpcrecpp.{so,a} and libpcreposix.{so,a}</seg>
        <seg>/usr/share/doc/pcre-&pcre-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="pcregrep">
        <term><command>pcregrep</command></term>
        <listitem>
          <para>is a <command>grep</command> that understands
          <application>Perl</application> compatible regular expressions.</para>
          <indexterm zone="pcre pcregrep">
            <primary sortas="b-pcregrep">pcregrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pcretest">
        <term><command>pcretest</command></term>
        <listitem>
          <para>can test a <application>Perl</application> compatible
          regular expression.</para>
          <indexterm zone="pcre pcretest">
            <primary sortas="b-pcretest">pcretest</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pcre-config">
        <term><command>pcre-config</command></term>
        <listitem>
          <para>is used during the compile process of programs linking to
          the <application>PCRE</application> libraries.</para>
          <indexterm zone="pcre pcre-config">
            <primary sortas="b-pcre-config">pcre-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>