php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Replace PECL <link> with entity &link.pecl; (#2580)

Browse Source 
And also:

* Remove obsolete paragraph

* Remove personalization (usage of 'you' and 'your')

* Update autoconf version


Co-authored-by: Adiel Cristo <adiel@php.net>
Co-authored-by: George Peter Banyard <girgias@php.net>
This commit is contained in:
Adiel Cristo
2023-07-31 11:17:32 -03:00
committed by GitHub
parent 9bef3400f8
commit 9e2d8231b5
14 changed files with 307 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
extensions.ent
View File

@@ -74,9 +74,11 @@ extensions are bundled with PHP.</para>'>
<!ENTITY extcat.membership.external '<title xmlns="http://docbook.org/ns/docbook">External Extensions</title><para xmlns="http://docbook.org/ns/docbook">These
extensions are bundled with PHP but in order to compile them, external libraries will be needed.</para>'>
<!ENTITY extcat.membership.pecl '<title xmlns="http://docbook.org/ns/docbook">PECL Extensions</title><para xmlns="http://docbook.org/ns/docbook">These
extensions are available from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.pecl;">PECL</link>. They may require external libraries. More PECL
extensions exist but they are not documented in the PHP manual yet.</para>'>
<!ENTITY extcat.membership.pecl '<title xmlns="http://docbook.org/ns/docbook">
PECL Extensions</title>
<para xmlns="http://docbook.org/ns/docbook">These extensions are available from
&link.pecl;. They may require external libraries. More PECL extensions exist but
they are not documented in the PHP manual yet.</para>'>
<!-- ======================================================================= -->

8
features/dtrace.xml
View File

@@ -43,14 +43,6 @@
features are available in all DTrace implementations.
</para>
<para>
DTrace static probes are included in PHP 5.4. Prior to this they
were available via a <link xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="&url.pecl;">PECL</link> extension, which is now
obsolete.
</para>
<para>
The static DTrace probes in PHP can alternatively be used with the
SystemTap facility on some Linux distributions.

368
install/pecl.xml
View File

@@ -7,32 +7,40 @@
<sect1 xml:id="install.pecl.intro">
<title>Introduction to PECL Installations</title>
<simpara>
<link xlink:href="&url.pecl;">PECL</link> is a repository of PHP extensions that
are made available to you via the <link xlink:href="&url.php.pear;">PEAR</link>
packaging system. This section of the manual is intended to demonstrate
how to obtain and install PECL extensions.
&link.pecl; is a repository of PHP extensions that are made available via the
<link xlink:href="&url.php.pear;">PEAR</link>
packaging system.
This section of the manual is intended to demonstrate how to obtain and
install PECL extensions.
</simpara>
<simpara>
These instructions assume <literal>/your/phpsrcdir/</literal> is the path
to the PHP source distribution, and that <literal>extname</literal> is the name of the
PECL extension. Adjust accordingly. These instructions also assume a
familiarity with the <link xlink:href="&url.php.pear.cli;">pear command</link>.
The information in the PEAR manual for the <literal>pear</literal> command also
applies to the <literal>pecl</literal> command.
These instructions assume <literal>/path/to/php/src/dir/</literal> is the
path to the PHP source distribution and that <literal>extname</literal> is
the name of the PECL extension. Adjust accordingly.
These instructions also assume a familiarity with the
<link xlink:href="&url.php.pear.cli;">pear command</link>.
The information in the PEAR manual for the
<command>pear</command>
command also applies to the
<command>pecl</command>
command.
</simpara>
<simpara>
To be useful, a shared extension must be built, installed, and loaded. The
methods described below provide you with various instructions on how to
build and install the extensions, but they do not automatically load them.
Extensions can be loaded by adding an <link
linkend="ini.extension">extension</link> directive to the &php.ini;
file, or through the use of the <function>dl</function> function.
A shared extension must be built, installed, and loaded to be useful.
The methods described below provide various instructions on how to build and
install the extensions, but they do not automatically load them.
Extensions can be loaded by adding an
<link linkend="ini.extension">extension</link>
directive to the &php.ini; file or through the use of the
<function>dl</function>
function.
</simpara>
<simpara>
When building PHP modules, it's important to have known-good versions
of the required tools (autoconf, automake, libtool, etc.) See the
<link xlink:href="&url.php.anongit;">Anonymous Git Instructions</link> for
details on the required tools, and required versions.
When building PHP modules, it's important to have known-good versions of the
required tools (autoconf, automake, libtool, etc.).
See the
<link xlink:href="&url.php.anongit;">Anonymous Git Instructions</link>
for details on the required tools and required versions.
</simpara>
</sect1>
@@ -44,9 +52,9 @@
<itemizedlist>
<listitem>
<simpara>
The <literal>pecl install extname</literal> command downloads the
extensions code automatically, so in this case there is no need
for a separate download.
The <command>pecl install extname</command> command downloads the
extensions code automatically, so in this case, there is no need for a
separate download.
</simpara>
</listitem>
<listitem>
@@ -54,20 +62,20 @@
<link xlink:href="&url.pecl;">&url.pecl;</link>
</simpara>
<simpara>
The PECL web site contains information about the different extensions
that are offered by the PHP Development Team. The information available
here includes: ChangeLog, release notes, requirements and other similar
details.
The PECL website contains information about the different extensions that
are offered by the PHP Development Team.
The information available here includes: changelog, release notes,
requirements, and other similar details.
</simpara>
</listitem>
<listitem>
<simpara>
<literal>pecl download extname</literal>
<command>pecl download extname</command>
</simpara>
<simpara>
PECL extensions that have releases listed on the PECL web site are
available for download and installation using the <link
xlink:href="&url.php.pear.cli;">pecl command</link>.
PECL extensions that have releases listed on the PECL website are available
for download and installation using the
<link xlink:href="&url.php.pear.cli;">pecl command</link>.
Specific revisions may also be specified.
</simpara>
</listitem>
@@ -85,14 +93,15 @@
<acronym>SVN</acronym>
</simpara>
<simpara>
Some PECL extensions also reside in <acronym>SVN</acronym>. A web-based view may
be seen at <link xlink:href="&url.php.svn;pecl/">&url.php.svn;pecl/</link>.
To download straight from <acronym>SVN</acronym>, the following
sequence of commands may be used:
Some PECL extensions also reside in <acronym>SVN</acronym>.
A web-based view may be seen at
<link xlink:href="&url.php.svn;pecl/">&url.php.svn;pecl/</link>.
To download straight from <acronym>SVN</acronym>,
the following sequence of commands may be used:
</simpara>
<para>
<screen>
$ svn checkout http://svn.php.net/repository/pecl/extname/trunk extname
$ svn checkout https://svn.php.net/repository/pecl/extname/trunk extname
</screen>
</para>
</listitem>
@@ -101,8 +110,8 @@ $ svn checkout http://svn.php.net/repository/pecl/extname/trunk extname
Windows downloads
</simpara>
<simpara>
The PHP project compiles and offers Windows DLLs for most
PECL extensions on the respective package page.
The PHP project compiles and offers Windows DLLs for most PECL extensions
on the package page.
</simpara>
</listitem>
</itemizedlist>
@@ -111,45 +120,54 @@ $ svn checkout http://svn.php.net/repository/pecl/extname/trunk extname
<sect1 xml:id="install.pecl.windows">
<title>Installing a PHP extension on Windows</title>
<para>
On Windows, you have two ways to load a PHP extension: either compile it into PHP, or
load the DLL. Loading a pre-compiled extension is the easiest and preferred way.
There are two ways to load a PHP extension on Windows: either compile it into
PHP, or load the DLL.
Loading a pre-compiled extension is the easiest and preferred way.
</para>
<para>
To load an extension, you need to have it available as a ".dll" file on your system.
All the extensions are automatically and periodically compiled by the PHP Group
(see next section for the download).
To load an extension, it has to be available as a
<filename>.dll</filename>
file on the system.
All the extensions are automatically and periodically compiled by the PHP
Group (see next section for the download).
</para>
<para>
To compile an extension into PHP, please refer to <link linkend="install.windows.building">
building from source</link> documentation.
To compile an extension into PHP, please refer to the
<link linkend="install.windows.building">building from source</link>
documentation.
</para>
<para>
To compile a standalone extension (aka a DLL file), please refer to <link linkend="install.windows.building">
building from source</link> documentation. If the DLL file is available neither with your
PHP distribution nor in PECL, you may have to compile it before you can start using the
extension.
To compile a standalone extension (aka a DLL file), please refer to the
<link linkend="install.windows.building">building from source</link>
documentation.
If the DLL file is available neither with the PHP distribution nor in PECL,
it may be necessary to compile it before the extension can be used.
</para>
<sect2 xml:id="install.pecl.windows.find">
<title>Where to find an extension?</title>
<para>
PHP extensions are usually called "php_*.dll" (where the star represents the name of
the extension) and they are located under the "PHP\ext" folder.
PHP extensions are usually called <filename>php_*.dll</filename> (where the
star represents the name of the extension), and they are located under the
<filename>PHP\ext</filename>
folder.
</para>
<para>
PHP ships with the extensions most useful to the majority of developers. They are
called "core" extensions.
PHP ships with the extensions most useful to the majority of developers.
They are called <emphasis>bundled</emphasis> extensions.
</para>
<para>
However, if you need functionality not provided by any core extension, you may still be
able to find one in <link xlink:href="&url.pecl;">PECL</link>. The PHP Extension Community Library (PECL) is a repository for
PHP Extensions, providing a directory of all known extensions and hosting facilities for
downloading and development of PHP extensions.
However, if the bundled extensions do not provide the needed functionality,
one extension that does may still be found in &link.pecl;.
The PHP Extension Community Library (PECL) is a repository for PHP
Extensions, providing a directory of all known extensions and hosting
facilities for downloading and developing PHP extensions.
</para>
<para>
If you have developed an extension for your own uses, you might want to think about hosting
it on PECL so that others with the same needs can benefit from your time. A nice side effect
is that you give them a good chance to give you feedback, (hopefully) thanks, bug reports
and even fixes/patches. Before you submit your extension for hosting on PECL, please read
If an extension has been developed for particular uses, it may be hosted on
PECL so that others with the same needs can benefit from it.
A nice side effect is that it's a good chance to receive feedback,
(hopefully) thanks, bug reports and even fixes/patches.
Before submitting an extension for hosting on PECL, please read
<link xlink:href="&url.pecl.submit;">PECL submit</link>.
</para>
</sect2>
@@ -157,7 +175,9 @@ $ svn checkout http://svn.php.net/repository/pecl/extname/trunk extname
<sect2 xml:id="install.pecl.windows.which">
<title>Which extension to download?</title>
<para>
<emphasis>Many times, you will find several versions of each DLL:</emphasis>
<emphasis>
Many times, there will be several versions of each DLL available:
</emphasis>
<itemizedlist>
<listitem>
<simpara>
@@ -187,13 +207,17 @@ $ svn checkout http://svn.php.net/repository/pecl/extname/trunk extname
</itemizedlist>
</para>
<para>
You should keep in mind that your extension settings should match all the
settings of the PHP executable you are using. The following PHP script will
tell you <emphasis>all</emphasis> about your PHP settings:
Keep in mind that the extension settings should match all the settings of
the PHP executable being used.
The following PHP script will tell <emphasis>all</emphasis> about the PHP
settings:
</para>
<para>
<example>
<title><function>phpinfo</function> call</title>
<title>
<function>phpinfo</function>
call
</title>
<programlisting role="php">
<![CDATA[
<?php
@@ -207,7 +231,7 @@ phpinfo();
Or from the command line, run:
<screen>
<![CDATA[
drive:\\path\to\php\executable\php.exe -i
drive:\path\to\php\executable\php.exe -i
]]>
</screen>
</para>
@@ -216,12 +240,17 @@ drive:\\path\to\php\executable\php.exe -i
<sect2 xml:id="install.pecl.windows.loading">
<title>Loading an extension</title>
<para>
The most common way to load a PHP extension is to include it in your <filename>php.ini</filename>
configuration file. Please note that many extensions are already present in your
<filename>php.ini</filename> and that you only need to remove the semicolon to activate them.
The most common way to load a PHP extension is to include it in
the &php.ini; configuration file.
Please note that many extensions are already present in the &php.ini; and
that the semicolon only needs to be removed to activate them.
</para>
<para>
Note that, on PHP version 7.2.0 and up, the extension name may be used instead of the extension's file name. As this is OS-independent and easier, especially for newcomers, it becomes the recommended way of specifying extensions to load. File names remain supported for compatibility with prior versions.
Note that, as of PHP 7.2.0, the extension name may be used
instead of the extension's file name.
As this is OS-independent and easier, especially for newcomers, it becomes
the recommended way of specifying extensions to load.
File names remain supported for compatibility with prior versions.
</para>
<screen>
<![CDATA[
@@ -235,15 +264,16 @@ extension=php_extname.dll
</screen>
<screen>
<![CDATA[
; On PHP version 7.2 and up, prefer :
; As of PHP 7.2.0, prefer:
extension=extname
zend_extension=another_extension
]]>
</screen>
<para>
However, some web servers are confusing because they do not use the <filename>php.ini</filename> located alongside
your PHP executable. To find out where your actual <filename>php.ini</filename> resides, look
for its path in <function>phpinfo</function>:
However, some web servers are confusing because they do not use
the &php.ini; located alongside the PHP executable.
To find out where the actual &php.ini; resides, look for its path
in <function>phpinfo</function>:
</para>
<screen>
<![CDATA[
@@ -252,38 +282,42 @@ Configuration File (php.ini) Path C:\WINDOWS
</screen>
<screen>
<![CDATA[
Loaded Configuration File C:\Program Files\PHP\5.2\php.ini
Loaded Configuration File C:\Program Files\PHP\8.2\php.ini
]]>
</screen>
<para>
After activating an extension, save <filename>php.ini</filename>, restart the web server and check
<function>phpinfo</function> again. The new extension should now have its own section.
After activating an extension, save &php.ini;, restart the web server, and
check <function>phpinfo</function> again.
The new extension should now have its own section.
</para>
</sect2>
<sect2 xml:id="install.pecl.windows.problemsolving">
<title>Resolving problems</title>
<para>
If the extension does not appear in <function>phpinfo</function>, you should check your logs to
learn where the problem comes from.
If the extension does not appear in <function>phpinfo</function>,
the logs should be checked to learn where the problem comes from.
</para>
<para>
If you are using PHP from the command line (CLI), the extension loading error can be read
directly on screen.
If PHP is being used from the command line (CLI), the extension loading
error can be read directly on the screen.
</para>
<para>
If you are using PHP with a web server, the location and format of the logs vary depending on
your software. Please read your web server documentation to locate the logs, as it does not
have anything to do with PHP itself.
If PHP is being used with a web server, the location and format of the logs
vary depending on the software.
Please read the web server documentation to locate the logs, as it has
nothing to do with PHP itself.
</para>
<para>
Common problems are the location of the DLL and the DLLs it depends on, the value of the "<link linkend="ini.extension-dir">
extension_dir</link>" setting inside <filename>php.ini</filename> and compile-time setting mismatches.
Common problems are the location of the DLL and the DLLs it depends on, the
value of the "<link linkend="ini.extension-dir">extension_dir</link>"
setting inside &php.ini; and compile-time setting mismatches.
</para>
<para>
If the problem lies in a compile-time setting mismatch, you probably didn't download the right DLL.
Try downloading again the extension with the right settings. Again, <function>phpinfo</function>
can be of great help.
If the problem lies in a compile-time setting mismatch, probably the DLL
downloaded is not the right one.
Try downloading the extension again with the proper settings.
Again, <function>phpinfo</function> can be of great help.
</para>
</sect2>
@@ -292,8 +326,10 @@ Loaded Configuration File C:\Program Files\PHP\5.2\php.ini
<sect1 xml:id="install.pecl.pear">
<title>Compiling shared PECL extensions with the pecl command</title>
<simpara>
PECL makes it easy to create shared PHP extensions. Using the
<link xlink:href="&url.php.pear.cli;">pecl command</link>, do the following:
PECL makes it easy to create shared PHP extensions.
Using the
<link xlink:href="&url.php.pear.cli;">pecl command</link>,
do the following:
</simpara>
<para>
<screen>
@@ -302,16 +338,19 @@ $ pecl install extname
</para>
<simpara>
This will download the source for <emphasis>extname</emphasis>,
compile, and install <filename>extname.so</filename> into your <link
linkend="ini.extension-dir">extension_dir</link>.
<filename>extname.so</filename> may then be loaded via &php.ini;
compile, and install <filename>extname.so</filename> into the
<link linkend="ini.extension-dir">extension_dir</link>.
<filename>extname.so</filename>
may then be loaded via &php.ini;.
</simpara>
<simpara>
By default, the <literal>pecl</literal> command will not install
packages that are marked with the <literal>alpha</literal> or
<literal>beta</literal> state. If no <literal>stable</literal> packages
are available, you may install a <literal>beta</literal> package using the
following command:
By default, the <command>pecl</command> command will not install packages
that are marked with the <literal>alpha</literal> or
<literal>beta</literal>
state.
If no <literal>stable</literal> packages are available,
a <literal>beta</literal> package may be installed using the following
command:
</simpara>
<para>
<screen>
@@ -319,7 +358,7 @@ $ pecl install extname-beta
</screen>
</para>
<para>
You may also install a specific version using this variant:
A specific version may also be installed using this variant:
</para>
<para>
<screen>
@@ -337,17 +376,18 @@ $ pecl install extname-0.1
<sect1 xml:id="install.pecl.phpize">
<title>Compiling shared PECL extensions with phpize</title>
<simpara>
Sometimes, using the <literal>pecl</literal> installer is not an option.
This could be because you're behind a firewall, or it could be because the
extension you want to install is not available as a PECL compatible
package, such as unreleased extensions from git. If you need to build such
an extension, you can use the lower-level build tools to perform the build
manually.
Sometimes, using the <command>pecl</command> installer is not an option.
This could be because there is a firewall or because the extension being
installed is unavailable as a PECL-compatible package, such as unreleased
extensions from git.
If such an extension needs to be built, the lower-level build tools can be
used to perform the build manually.
</simpara>
<simpara>
The <literal>phpize</literal> command is used to prepare the build
environment for a PHP extension. In the following sample, the sources for
an extension are in a directory named <filename>extname</filename>:
The <command>phpize</command> command is used to prepare the build
environment for a PHP extension.
In the following sample, the sources for an extension are in a directory
named <filename>extname</filename>:
</simpara>
<para>
<screen>
@@ -361,42 +401,52 @@ $ make
</screen>
</para>
<simpara>
A successful install will have created <filename>extname.so</filename> and put it
into the PHP
<link linkend="ini.extension-dir">extensions directory</link>. You'll need
to adjust &php.ini; and add an <literal>extension=extname.so</literal>
line before you can use the extension.
A successful install will have created <filename>extname.so</filename> and
put it into the PHP
<link linkend="ini.extension-dir">extensions directory</link>.
The &php.ini; will need to be adjusted, and an
<literal>extension=extname.so</literal>
line will need to be added before the extension can be used.
</simpara>
<simpara>
If the system is missing the <literal>phpize</literal> command, and precompiled
packages (like RPM's) are used, be sure to also install the appropriate
devel version of the PHP package as they often include the
<literal>phpize</literal> command along with the appropriate header files to
build PHP and its extensions.
If the system is missing the <command>phpize</command> command, and
precompiled packages (like RPM's) are used, be sure to install also the
appropriate development version of the PHP package as they often include the
<command>phpize</command>
command along with the proper header files to build PHP and its extensions.
</simpara>
<simpara>
Execute <command>phpize --help</command> to display additional usage information.
Execute <command>phpize --help</command> to display additional usage
information.
</simpara>
</sect1>
<sect1 xml:id="install.pecl.php-config">
<title>php-config</title>
<title>
<command>php-config</command>
</title>
<para>
php-config is a simple shell script for obtaining information about the
installed PHP configuration.
<command>php-config</command>
is a simple shell script for obtaining information about the installed PHP
configuration.
</para>
<para>
When compiling extensions, if you have multiple PHP versions installed, you
may specify for which installation you'd like to build by using the
<literal>--with-php-config</literal> option during configuration, specifying
the path of the respective php-config script.
When the extensions are being compiled, if multiple PHP versions are
installed, the installation for which to build can be specified by using the
<option role="configure">--with-php-config</option>
option during configuration, setting the path of the respective
<command>php-config</command>
script.
</para>
<para>
The list of command line options provided by the php-config script can be queried
anytime by running php-config with the <option>-h</option> switch:
The list of command line options provided by the
<command>php-config</command>
script can be queried anytime by running
<command>php-config</command>
with the <option>-h</option> switch:
<screen>
<![CDATA[
Usage: /usr/local/bin/php-config [OPTION]
@@ -433,11 +483,16 @@ Options:
</row>
<row>
<entry>--includes</entry>
<entry>List of -I options with all include files</entry>
<entry>
List of <literal>-I</literal> options with all include files
</entry>
</row>
<row>
<entry>--ldflags</entry>
<entry>LD Flags which PHP was compiled with</entry>
<entry>
<literal>LD</literal>
flags which PHP was compiled with
</entry>
</row>
<row>
<entry>--libs</entry>
@@ -449,7 +504,9 @@ Options:
</row>
<row>
<entry>--include-dir</entry>
<entry>Directory prefix where header files are installed by default</entry>
<entry>
Directory prefix where header files are installed by default
</entry>
</row>
<row>
<entry>--php-binary</entry>
@@ -461,7 +518,9 @@ Options:
</row>
<row>
<entry>--configure-options</entry>
<entry>Configure options to recreate configuration of current PHP installation</entry>
<entry>
Configure options to recreate configuration of current PHP installation
</entry>
</row>
<row>
<entry>--version</entry>
@@ -480,15 +539,16 @@ Options:
<sect1 xml:id="install.pecl.static">
<title>Compiling PECL extensions statically into PHP</title>
<simpara>
You might find that you need to build a PECL extension statically into your
PHP binary. To do this, you'll need to place the extension source under
the <filename>/your/phpsrcdir/ext/</filename> directory and tell the PHP build
system to regenerate its configure script.
It may be necessary to build a PECL extension statically into the PHP binary.
To do this, the extension source will need to be placed under the
<filename>/path/to/php/src/dir/ext/</filename>
directory, and the PHP build system will be required to regenerate its
configure script.
</simpara>
<para>
<screen>
<![CDATA[
$ cd /your/phpsrcdir/ext
$ cd /path/to/php/src/dir/ext
$ pecl download extname
$ gzip -d < extname.tgz | tar -xvf -
$ mv extname-x.x.x extname
@@ -500,15 +560,16 @@ $ mv extname-x.x.x extname
</simpara>
<para>
<screen>
/your/phpsrcdir/ext/extname
/path/to/php/src/dir/ext/extname
</screen>
</para>
<simpara>
From here, force PHP to rebuild the configure script, and then build PHP as normal:
From here, PHP needs to be forced to rebuild the configure script, and then
it can be built as normal:
</simpara>
<para>
<screen>
$ cd /your/phpsrcdir
$ cd /path/to/php/src/dir
$ rm configure
$ ./buildconf --force
$ ./configure --help
@@ -519,15 +580,26 @@ $ make install
</para>
<note>
<simpara>
To run the 'buildconf' script you need autoconf 2.13 and automake 1.4+
(newer versions of autoconf may work, but are not supported).
To run the <command>buildconf</command> script, the
<command>autoconf</command>
<literal>2.68</literal>
and
<command>automake</command>
<literal>1.4+</literal>
will be needed.
Newer versions of <command>autoconf</command> may work but are not
supported.
</simpara>
</note>
<simpara>
Whether <literal>--enable-extname</literal> or <literal>--with-extname
</literal> is used depends on the extension. Typically an extension that
does not require external libraries uses <literal>--enable</literal>. To be
sure, run the following after buildconf:
Whether
<option role="configure">--enable-extname</option>
or
<option role="configure">--with-extname</option>
is used depends on the extension.
Typically, an extension that does not require external libraries uses
<option role="configure">--enable</option>.
To be sure, run the following after <command>buildconf</command>:
</simpara>
<para>
<screen>

11
language-snippets.ent
View File

@@ -1882,11 +1882,9 @@ is set to <constant>PDO::ERRMODE_EXCEPTION</constant>.
</para>'>
<!-- PECL entities -->
<!ENTITY pecl.moved 'This <link xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.pecl;">PECL</link> extension
is not bundled with PHP.'>
<!ENTITY pecl.moved 'This &link.pecl; extension is not bundled with PHP.'>
<!ENTITY pecl.bundled 'This <link xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.pecl;">PECL</link> extension
is bundled with PHP.'>
<!ENTITY pecl.bundled 'This &link.pecl; extension is bundled with PHP.'>
<!ENTITY pecl.info 'Information for installing this PECL extension may be
found in the manual chapter titled <link xmlns="http://docbook.org/ns/docbook" linkend="install.pecl">Installation
@@ -1912,9 +1910,8 @@ for this <acronym xmlns="http://docbook.org/ns/docbook">PECL</acronym> extension
<!ENTITY pecl.windows.download.unbundled '&pecl.windows.download;'>
<!ENTITY pecl.moved-ver 'This extension has been moved to the
<link xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.pecl;">PECL</link> repository and is no longer bundled with
PHP as of PHP '>
<!ENTITY pecl.moved-ver 'This extension has been moved to the &link.pecl;
repository and is no longer bundled with PHP as of PHP '>
<!-- PGSQL entities -->

7
language/wrappers/audio.xml
View File

@@ -28,9 +28,10 @@
<note>
<title>This wrapper is not enabled by default</title>
<simpara>
In order to use the <filename>ogg://</filename> wrapper you must install
the <link xlink:href="&url.pecl.package;oggvorbis">OGG/Vorbis</link> extension
available from <link xlink:href="&url.pecl;">PECL</link>.
In order to use the <filename>ogg://</filename> wrapper,
the
<link xlink:href="&url.pecl.package;oggvorbis">OGG/Vorbis</link>
extension available from &link.pecl; must be installed.
</simpara>
</note>
</refsect1><!-- }}} -->

7
language/wrappers/expect.xml
View File

@@ -16,9 +16,10 @@
<note>
<title>This wrapper is not enabled by default</title>
<simpara>
In order to use the <filename>expect://</filename> wrapper you must install
the <link xlink:href="&url.pecl.package;expect">Expect</link> extension
available from <link xlink:href="&url.pecl;">PECL</link>.
In order to use the <filename>expect://</filename> wrapper,
the
<link xlink:href="&url.pecl.package;expect">Expect</link>
extension available from &link.pecl; must be installed.
</simpara>
</note>
<simpara><filename>expect://</filename> (PECL)</simpara>

9
language/wrappers/rar.xml
View File

@@ -11,7 +11,7 @@
&reftitle.description;
<para>
The wrapper takes the url encoded path to the RAR archive (relative or absolute),
an optional asterik (<literal>*</literal>), an optional number sign
an optional asterisk (<literal>*</literal>), an optional number sign
(<literal>#</literal>) and an optional url encoded entry name, as stored in the
archive. Specifying an entry name requires the number sign; a leading forward
slash in the entry name is optional.
@@ -38,9 +38,10 @@
<note>
<title>This wrapper is not enabled by default</title>
<simpara>
In order to use the <filename>rar://</filename> wrapper, you must install
the <link xlink:href="&url.pecl.package;rar">rar</link> extension
available from <link xlink:href="&url.pecl;">PECL</link>.
In order to use the <filename>rar://</filename> wrapper,
the
<link xlink:href="&url.pecl.package;rar">rar</link>
extension available from &link.pecl; must be installed.
</simpara>
</note>
<simpara>

13
language/wrappers/ssh2.xml
View File

@@ -21,9 +21,10 @@
<note>
<title>This wrapper is not enabled by default</title>
<simpara>
In order to use the <filename>ssh2.*://</filename> wrappers you must install
the <link xlink:href="&url.pecl.package;ssh2">SSH2</link> extension
available from <link xlink:href="&url.pecl;">PECL</link>.
In order to use the <filename>ssh2.*://</filename> wrappers,
the
<link xlink:href="&url.pecl.package;ssh2">SSH2</link>
extension available from &link.pecl; must be installed.
</simpara>
</note>
@@ -249,9 +250,9 @@ $stream = fopen("ssh2.tunnel://$session/remote.example.com:1234", 'r');
<example>
<title>This <varname>$session</varname> variable must be kept available!</title>
<simpara>
In order to use the <filename>ssh2.*://$session</filename> wrappers you must
keep the <varname>$session</varname> resource variable. The code below will not
have the desired effect:
In order to use the <filename>ssh2.*://$session</filename> wrappers,
the <varname>$session</varname> resource variable must be kept.
The code below will not have the desired effect:
</simpara>
<programlisting role="php">
<![CDATA[

33
reference/ibm_db2/configure.xml
View File

@@ -3,24 +3,25 @@
<section xml:id="ibm-db2.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
To build the ibm_db2 extension, the DB2 application development header
files and libraries must be installed on your system. DB2 does not install
these by default, so you may have to return to your DB2 installer and add
this option. The header files are included with the DB2 Application
Development Client freely available for download from the IBM DB2 Universal
Database <link xlink:href="&url.ibm.db2.client;">support site</link>.
To build the ibm_db2 extension, the DB2 application development header files
and libraries must be installed on the system.
DB2 does not install these by default, so it may be necessary to return to the
DB2 installer and add this option.
The DB2 Application Development Client includes the header files and is freely
available for download from the IBM DB2 Universal Database
<link xlink:href="&url.ibm.db2.client;">support site</link>.
</para>
<para>
If you add the DB2 application development header files and libraries to
a Linux or Unix operating system on which DB2 was already installed, you
must issue the command <command>db2iupdt -e</command> to update the symbolic
links to the header files and libraries in your DB2 instances.
If the DB2 application development header files and libraries are added to a
Linux or Unix operating system on which DB2 was already installed, the command
<command>db2iupdt -e</command> must be issued to update the symbolic links to
the header files and libraries in the DB2 instances.
</para>
<para>
ibm_db2 is a <link xlink:href="&url.pecl;">PECL</link> extension, so follow the
instructions in <xref linkend='install.pecl' /> to install the ibm_db2
extension for PHP. Issue the <command>configure</command> command to point
to the location of your DB2 header files and libraries as follows:
ibm_db2 is a &link.pecl; extension, so follow the instructions in
<xref linkend='install.pecl' /> to install the ibm_db2 extension for PHP.
Issue the <command>configure</command> command to point to the location of
the DB2 header files and libraries as follows:
<screen>
<![CDATA[
bash$ ./configure --with-IBM_DB2=/path/to/DB2
@@ -33,8 +34,8 @@ bash$ ./configure --with-IBM_DB2=/path/to/DB2
<note>
<title>Note for IIS users</title>
<para>
If you are using the ibm_db2 driver with Microsoft Internet Information Server (IIS)
you may have to do the following:
If the ibm_db2 driver is being used with Microsoft Internet Information
Server (IIS), it may be necessary to do the following:
</para>
<para>
<simplelist>

9
reference/oci8/setup.xml
View File

@@ -8,13 +8,8 @@
<section xml:id="oci8.requirements">
&reftitle.required;
<para>
OCI8 3.0 is included with PHP 8. It is also available
from <link xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="&url.pecl;">PECL</link>. For PHP 7, use OCI8 2.2
from <link xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="&url.pecl;">PECL</link>. OCI8 requires Oracle
OCI8 3.0 is included with PHP 8. It is also available from &link.pecl;. For
PHP 7, use OCI8 2.2 from &link.pecl;. OCI8 requires Oracle
10<emphasis>g</emphasis> or later Oracle client libraries.
</para>
<para>

12
reference/pdo_cubrid/configure.xml
View File

@@ -6,17 +6,19 @@
To build the PDO_CUBRID extension, the CUBRID DBMS must be installed on the
same system as PHP.
PDO_CUBRID is a <link xlink:href="&url.pecl;">PECL</link> extension, so
follow the instructions in <xref linkend='install.pecl' /> to install the
PDO_CUBRID extension. Issue the <command>configure</command> command to
point to the location of your CUBRID base dir as follows:
PDO_CUBRID is a &link.pecl; extension, so follow the instructions in
<xref linkend='install.pecl' />
to install the PDO_CUBRID extension.
Issue the <command>configure</command> command to point to the location of the
CUBRID base dir as follows:
<screen>
<![CDATA[
$ ./configure --with-pdo-cubrid=/path/to/CUBRID[,shared]
]]>
</screen>
The <command>configure</command> command defaults to the value of the
<literal>CUBRID</literal> environment variable.
<envar>CUBRID</envar>
environment variable.
</para>
<para>
&pecl.windows.download; Detailed information about installation on Linux and

10
reference/pdo_ibm/configure.xml
View File

@@ -21,17 +21,17 @@
</para>
</note>
<para>
PDO_IBM is a <link xlink:href="&url.pecl;">PECL</link> extension, so follow the
instructions in <xref linkend='install.pecl' /> to install the PDO_IBM
extension. Issue the <command>configure</command> command to point to the
location of your DB2 Client header files and libraries as follows:
PDO_IBM is a &link.pecl; extension, so follow the instructions in
<xref linkend='install.pecl' /> to install the PDO_IBM extension.
Issue the <command>configure</command> command to point to the location of the
DB2 Client header files and libraries as follows:
<screen>
<![CDATA[
bash$ ./configure --with-pdo-ibm=/path/to/sqllib[,shared]
]]>
</screen>
The <command>configure</command> command defaults to the value of the
<literal>DB2DIR</literal> environment variable.
<envar>DB2DIR</envar> environment variable.
</para>
</section>

11
reference/pdo_informix/configure.xml
View File

@@ -9,18 +9,17 @@
Support Site</link>.
</para>
<para>
PDO_INFORMIX is a <link xlink:href="&url.pecl;">PECL</link> extension, so
follow the instructions in <xref linkend='install.pecl' /> to install the
PDO_INFORMIX extension. Issue the <command>configure</command> command
to point to the location of your Informix Client SDK header files and
libraries as follows:
PDO_INFORMIX is a &link.pecl; extension, so follow the instructions in
<xref linkend='install.pecl' /> to install the PDO_INFORMIX extension.
Issue the <command>configure</command> command to point to the location of the
Informix Client SDK header files and libraries as follows:
<screen>
<![CDATA[
bash$ ./configure --with-pdo-informix=/path/to/SDK[,shared]
]]>
</screen>
The <command>configure</command> command defaults to the value of the
<literal>INFORMIXDIR</literal> environment variable.
<envar>INFORMIXDIR</envar> environment variable.
</para>
</section>

11
reference/pdo_sqlsrv/configure.xml
View File

@@ -12,12 +12,15 @@
<link xlink:href="&url.sqlsrv.system.requirements;">SQLSRV System Requirements</link>.
</para>
<para>
On Windows the PDO_SQLSRV extension is enabled by downloading and adding appropriate DLL files to your PHP
extension directory and the corresponding entry to the &php.ini; file.
On Windows the PDO_SQLSRV extension is enabled by downloading and adding
appropriate DLL files to the PHP extension directory and the corresponding
entry to the &php.ini; file.
</para>
<para>
On Linux and macOS, the PDO_SQLSRV extension can be installed using <link xlink:href="&url.pecl;">PECL</link>.
See the <link xlink:href="&url.sqlsrv.linux-mac;">installation tutorial</link> for details.
On Linux and macOS, the PDO_SQLSRV extension can be installed using
&link.pecl;.
See the <link xlink:href="&url.sqlsrv.linux-mac;">installation tutorial</link>
for details.
</para>
</section>