<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="mbstring.installation" xmlns="http://docbook.org/ns/docbook">
  &reftitle.install;
  <para>
   <literal>mbstring</literal> is a non-default extension. This means it
   is not enabled by default. You must explicitly enable the module with
   the <literal>configure</literal> option. See the
   <link linkend="install">Install</link> section for details.
  </para>
  <simpara>
   The following configure options are related to the
   <literal>mbstring</literal> module.
  </simpara>
  <para>
   <itemizedlist>
    <listitem>
     <para>
      <option role="configure">--enable-mbstring</option>: Enable
      <literal>mbstring</literal> functions. This option is
      required to use <literal>mbstring</literal> functions.
     </para>
     <para>
      <productname>libmbfl</productname> is necessary for <literal>mbstring</literal>.
      <productname>libmbfl</productname> is bundled with <literal>mbstring</literal>.
      Prior to PHP 7.3.0, if <productname>libmbfl</productname> is already installed on the system,
      <option role="configure">--with-libmbfl[=DIR]</option> can be specified to use 
      the installed library.
     </para>
    </listitem>
    <listitem>
     <para>
      <option role="configure">--disable-mbregex</option>: Disable
      regular expression functions with multibyte character support.
     </para>
     <para>
      <productname>Oniguruma</productname> is necessary for the regular
      expression functions with multibyte character support.
      As of PHP 7.4.0, pkg-config is used to detect the libonig library.
      Prior to PHP 7.4.0, <productname>Oniguruma</productname> was bundled with
      <literal>mbstring</literal>, but it was possible to build against an already
      installed libonig by passing <option role="configure">--with-onig[=DIR]</option>.
     </para>
     <para>
      It is possible to disable the multibyte regex backtrack
      check by specifying <option
      role="configure">--disable-mbregex-backtrack</option>.
     </para>
    </listitem>
   </itemizedlist>
  </para>
</section>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
