source: general/genlib/pcre.xml@ aab13c9

<?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 "https://ftp.pcre.org/pub/pcre/pcre-&pcre-version;.tar.bz2">
  <!ENTITY pcre-download-ftp  "ftp://ftp.pcre.org/pub/pcre/pcre-&pcre-version;.tar.bz2">
  <!ENTITY pcre-md5sum        "cf7326204cc46c755b5b2608033d9d24">
  <!ENTITY pcre-size          "1.5 MB">
  <!ENTITY pcre-buildsize     "20 MB (with tests)">
  <!ENTITY pcre-time          "0.3 SBU (with tests)">
]>

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

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

    &lfs101_checked;

    <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">PCRE Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="valgrind"/>
    </para>

    <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>./configure --prefix=/usr                     \
            --docdir=/usr/share/doc/pcre-&pcre-version; \
            --enable-unicode-properties       \
            --enable-pcre16                   \
            --enable-pcre32                   \
            --enable-pcregrep-libz            \
            --enable-pcregrep-libbz2          \
            --enable-pcretest-libreadline     \
            --disable-static                 &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

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

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

  </sect2>

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

    <para>
      <parameter>--enable-unicode-properties</parameter>: This switch enables
      Unicode properties support and includes the code for handling UTF-8/16/32
      character strings in the library. You need this switch if you are going to
      build <xref linkend="glib2"/> with the
      <parameter>--with-pcre=system</parameter> switch.
    </para>

    <para>
      <parameter>--enable-pcre16</parameter>: This switch enables 16 bit
      character support.
    </para>

    <para>
      <parameter>--enable-pcre32</parameter>: This switch enables 32 bit
      character support.
    </para>

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

    <para>
      <parameter>--enable-pcretest-libreadline</parameter>: This switch adds line
      editing and history features to <command>pcretest</command> program.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <!-- FIXME: Removed due to merged-/usr setup
    <para>
      <command>mv -v /usr/lib/libpcre.so.* /lib</command>: Moves the
      <application>PCRE</application> library on the root filesystem
      so that it is available in case <command>grep</command>
      gets reinstalled with <application>PCRE</application> support.
    </para>
    -->

    <para>
      <option>--enable-jit</option>: this option enables Just-in-time
      compiling, which can greatly speed up pattern matching.
    </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, libpcre16.so, libpcre32.so,
          libpcrecpp.so and libpcreposix.so
        </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>