sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Help unify PECL documentation, by using the PECL entities.

Browse source 
First stage in closing PHP bug #37315


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@295182 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2010-02-16 19:36:02 +00:00
parent 9f2a09bdbf
commit 6bb80ceb9a
15 changed files with 109 additions and 228 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
reference/apd/setup.xml
View file

@ -12,27 +12,10 @@
<section xml:id="apd.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
APD is currently available as a PECL extension from
&pecl.info;
<link xlink:href="&url.pecl.package;apd">&url.pecl.package;apd</link>.
</para>
<para>
Run the following command to download, build, and install the latest stable
version of APD:
<screen>
<![CDATA[
pear install apd
]]>
</screen>
</para>
<para>
This automatically installs the APD Zend module into your PHP
extensions directory. It is not mandatory to keep it there; you can
store the module in any directory PHP can read as long as you set
the zend_extension parameter accordingly.
</para>
<para>
Windows users will enable <filename>php_apd.dll</filename> inside
of &php.ini; in order to use these functions.
&pecl.windows.download;
</para>
<para>

83
reference/bcompiler/configure.xml
View file

@ -2,79 +2,16 @@
<!-- $Revision$ -->
<section xml:id="bcompiler.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
short installation note:
<itemizedlist>
<listitem>
<simpara>You need at least PHP 4.3.0 for the compression to work</simpara>
</listitem>
<listitem>
<simpara>
To install on PHP 4.3.0 and later at the Unix command prompt type
<command>pear install bcompiler</command>
</simpara>
</listitem>
<listitem>
<simpara>
To install on Windows, until the binary package distribution
mechanism is finished please search the archives of the pear-general
mailing list for pre-built packages. (or send an email to it if you could
not find a reference)
</simpara>
</listitem>
<listitem>
<simpara>
To install on older versions you need to make some slight changes to the
build.
</simpara>
</listitem>
<listitem>
<simpara>
untar the <filename>bcompiler.tgz</filename> archive into
<filename class="directory">php4/ext</filename>.(Get it directly from
PECL <link xlink:href="&url.pecl.package.get;bcompiler">&url.pecl.package.get;bcompiler</link>)
</simpara>
</listitem>
<listitem>
<simpara>
If the new directory is now called something like bcompiler-0.x, then you
should rename it to bcompiler (except you only want to build it as
self-contained php-module).
</simpara>
</listitem>
<listitem>
<simpara>
If you are using versions before PHP 4.3.0, the you will need to copy the
<filename>Makefile.in.old</filename> to <filename>Makefile.in</filename>
and <filename>config.m4.old</filename> to <filename>config.m4</filename>.
</simpara>
</listitem>
<listitem>
<simpara>
run <command>phpize</command> in <filename class="directory">
ext/bcompiler</filename>
</simpara>
</listitem>
<listitem>
<simpara>
run <command>./buildconf</command> in <filename class="directory">php4
</filename>
</simpara>
</listitem>
<listitem>
<simpara>
run <command>configure</command> with <option role="configure">
--enable-bcompiler</option> (and your other options)
</simpara>
</listitem>
<listitem>
<simpara>
<command>make; make install</command>
</simpara>
</listitem>
<listitem><simpara>that's it.</simpara></listitem>
</itemizedlist>
</para>
<para>
&pecl.moved;
</para>
<para>
&pecl.info;
<link xlink:href="&url.pecl.package;bcompiler">&url.pecl.package;bcompiler</link>.
</para>
<para>
&pecl.windows.download;
</para>
</section>
<!-- Keep this comment at the end of the file

18
reference/cairo/setup.xml
View file

@ -24,7 +24,16 @@
<section xml:id="cairo.installation">
&reftitle.install;
<para>Installation on Windows</para>
<para>
&pecl.info;
<link xlink:href="&url.pecl.package;cairo">&url.pecl.package;cairo</link>.
</para>
<para>
&pecl.windows.download;
</para>
<para>
Notes specific to installation on Windows
</para>
<para>
Binary builds of the extension can be found at
<link xlink:href="&url.cairo.dl;">&url.cairo.dl;</link>.
@ -34,13 +43,6 @@
Non-Thread Safe NTS), the architecture (x86 or x64), and the compiler
version (VC6 or VC9) match or the extension will not load.
</para>
<para>
&pecl.moved;
</para>
<para>
&pecl.info;
<link xlink:href="&url.pecl.package;cairo">&url.pecl.package;cairo</link>.
</para>
</section>
<!-- {{{ Configuration -->

12
reference/dio/configure.xml
View file

@ -1,10 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<section xml:id="dio.installation" xmlns="http://docbook.org/ns/docbook">
<section xml:id="dio.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
To get these functions to work, you have to configure PHP with
<option role="configure">--enable-dio</option>.
&pecl.moved;
</para>
<para>
&pecl.info;
<link xlink:href="&url.pecl.package;dio">&url.pecl.package;dio</link>.
</para>
<para>
&pecl.windows.download;
</para>
</section>

9
reference/id3/setup.xml
View file

@ -15,10 +15,11 @@
<section xml:id="id3.installation">
&reftitle.install;
<para>
id3 is part of PECL and can be installed using the PEAR installer.
To compile PHP with id3 support, download the sourcecode, put it in
<filename>php-src/ext/id3</filename> and compile PHP using
<literal>--enable-id3</literal>.
&pecl.info;
<link xlink:href="&url.pecl.package;id3">&url.pecl.package;id3</link>.
</para>
<para>
&pecl.windows.download;
</para>
</section>
<!-- }}} -->

24
reference/kadm5/setup.xml
View file

@ -15,15 +15,21 @@
<section xml:id="kadm5.installation">
&reftitle.install;
<para>
These functions allow you to access Kerberos administration servers. In
order to have these functions available, you must compile PHP with KADM5
support by using the <literal>--with-kadm5</literal> configurable option.
If you use this option without specifying the path to KADM5, PHP will
use the built-in KADM5 client libraries. Users who run other applications
that use KADM5 (for example, running PHP 4 and PHP 5 as concurrent apache
modules, or auth-kadm5) should always specify the path to KADM5:
<literal>--with-kadm5=/path/to/kadm5</literal>. This will force PHP to use
the client libraries installed by KADM5, avoiding any conflicts.
&pecl.info;
<link xlink:href="&url.pecl.package;kadm5">&url.pecl.package;kadm5</link>.
</para>
<note>
<para>
If this option is used without specifying the path to KADM5, PHP will
use the built-in KADM5 client libraries. Users who run other applications
that use KADM5 (for example, running PHP 4 and PHP 5 as concurrent apache
modules, or auth-kadm5) should always specify the path to KADM5:
<literal>--with-kadm5=/path/to/kadm5</literal>. This will force PHP to use
the client libraries installed by KADM5, avoiding any conflicts.
</para>
</note>
<para>
&pecl.windows.download;
</para>
</section>
<!-- }}} -->

14
reference/ktaglib/configure.xml
View file

@ -1,16 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<section xml:id="ktaglib.installation" xmlns="http://docbook.org/ns/docbook">
<section xml:id="ktaglib.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
KTaglib support in PHP is not enabled by default. You will need to
configure PHP <option role="configure">--with-ktaglib[=DIR]</option>
&pecl.info;
<link xlink:href="&url.pecl.package;ktaglib">&url.pecl.package;ktaglib</link>.
</para>
<para>
&pecl.windows.download;
</para>
<note>
<simpara>
KTaglib is part of PECL.
</simpara>
</note>
</section>
<!-- Keep this comment at the end of the file

21
reference/mcve/configure.xml
View file

@ -3,11 +3,17 @@
<section xml:id="mcve.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
To enable MCVE (Monetra) Support in PHP, first verify your LibMonetra
(formerly libmcve) installation directory. If you are compiling
MCVE/Monetra support directly into PHP, you will then need to configure
PHP with the <option role="configure">--with-mcve</option> option. If you
use this option without specifying the path to your libmonetra installation,
&pecl.moved;
</para>
<para>
&pecl.info;
<link xlink:href="&url.pecl.package;mcve">&url.pecl.package;mcve</link>.
</para>
<para>
&pecl.windows.download;
</para>
<para>
If installing without specifying the libmonetra path,
PHP will attempt to look in the default LibMonetra Install location
(<filename>/usr/local</filename>). If Monetra (MCVE) is in a non-standard
location, run configure with: <option
@ -20,11 +26,6 @@
and/or <filename>libmonetra.so</filename> and/or
<filename>libmonetra.a</filename> under the lib directory.
</para>
<para>
If you want to install MCVE/Monetra support as a module, you can do
so by using the PECL repository, and issuing the 'pecl install mcve'
command if you are running a PEAR version of at least 1.4.0.
</para>
<para>
Since MCVE/Monetra has true server/client separation, there are no
additional requirements for running PHP with MCVE support. To test

4
reference/mcve/setup.xml
View file

@ -7,7 +7,9 @@
<!-- {{{ Requirements -->
<section xml:id="mcve.requirements">
&reftitle.required;
&no.requirement;
<para>
The LibMonetra (formerly libmcve) library.
</para>
</section>
<!-- }}} -->

28
reference/phar/installation.xml
View file

@ -2,28 +2,16 @@
<!-- $Revision$ -->
<section xml:id="phar.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
The Phar extension is built into PHP as of PHP version 5.3.0. Phar may be installed
via the PECL extension with previous PHP versions, and the
<link xlink:href="&url.pecl.package;phar">Phar PECL page</link> contains
further information and history.
</para>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;phar">&url.pecl.package;phar</link>.
Windows users must include the <filename>php_phar.dll</filename> file within
&php.ini; to use this extension.
</simpara>
<simpara>
To install on Windows, follow the instructions above, modify your php.ini and restart your web server.
</simpara>
<screen>
<![CDATA[
extension_dir=c:/php5/exts/
extension=php_phar.dll
;; optional extensions
extension=php_bz2.dll
]]>
</screen>
<simpara>
Since PHP 5.3.0, Phar extension is built-in, no DLL is needed.
</simpara>
</section>
<!-- Keep this comment at the end of the file

25
reference/radius/configure.xml
View file

@ -3,27 +3,14 @@
<section xml:id="radius.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
Howto install the package?
<itemizedlist>
<listitem><simpara>untar the package (usually into php4/ext)</simpara></listitem>
<listitem><simpara>rename radius-x.x to radius</simpara></listitem>
<listitem><simpara>run <command>./buildconf</command> in php4</simpara></listitem>
<listitem><simpara>run <command>./configure --enable-radius</command></simpara></listitem>
<listitem><simpara><command>make; make install</command></simpara></listitem>
</itemizedlist>
or if you would like to have it as <filename>.so</filename>:
<itemizedlist>
<listitem><simpara>untar the package </simpara></listitem>
<listitem><simpara>run <command>phpize</command> in the radius-x.x directory</simpara></listitem>
<listitem><simpara>run <command>./configure</command> in the radius-x.x directory</simpara></listitem>
<listitem><simpara><command>make; make install</command></simpara></listitem>
</itemizedlist>
&pecl.moved;
</para>
<para>
For Windows I recommend to use the
<filename class="libraryfile">php_radius.dll</filename> from
<link xlink:href="&url.php.snapshots;">&url.php.snapshots;</link>.
&pecl.windows.download.unbundled;
&pecl.info;
<link xlink:href="&url.pecl.package;radius">&url.pecl.package;radius</link>.
</para>
<para>
&pecl.windows.download;
</para>
</section>

24
reference/spplus/setup.xml
View file

@ -25,20 +25,18 @@
<section xml:id="spplus.installation">
&reftitle.install;
<para>
short installation note:
<itemizedlist>
<listitem>
<simpara>You need at least PHP 4.3.0 for the compression to work</simpara>
</listitem>
<listitem>
<simpara>
To install on PHP 4.3.0 and later at the Unix command prompt type
<command>pear install pecl/spplus</command>
</simpara>
</listitem>
</itemizedlist>
&pecl.info;
<link xlink:href="&url.pecl.package;spplus">&url.pecl.package;spplus</link>.
</para>
</section>
<para>
&pecl.windows.download;
</para>
<note>
<para>
PHP 4.3.0 or greater is required for the compression to work.
</para>
</note>
</section>
<!-- }}} -->
<!-- {{{ Configuration -->

14
reference/vpopmail/configure.xml
View file

@ -1,10 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<section xml:id="vpopmail.installation" xmlns="http://docbook.org/ns/docbook">
<section xml:id="vpopmail.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para xml:id="vpopmail.configure">
These functions are only available if PHP was configured with
<option role="configure">--with-vpopmail[=DIR]</option>.
<para>
&pecl.moved;
</para>
<para>
&pecl.info;
<link xlink:href="&url.pecl.package;vpopmail">&url.pecl.package;vpopmail</link>.
</para>
<para>
&pecl.windows.download;
</para>
</section>

21
reference/xattr/configure.xml
View file

@ -3,28 +3,11 @@
<section xml:id="xattr.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
xattr is currently available through PECL
&pecl.info;
<link xlink:href="&url.pecl.package;xattr">&url.pecl.package;xattr</link>.
</para>
<para>
If <link xlink:href="&url.php.pear;">PEAR</link> is available on your *nix-like
system you can use the pear installer to install the xattr extension, by the
following command: <command>pear -v install xattr</command>.
</para>
<para>
You can always download the tar.gz package and install xattr by hand:
<example>
<title>xattr install by hand</title>
<programlisting role="shell">
<![CDATA[
gunzip xattr-xxx.tgz
tar -xvf xattr-xxx.tar
cd xattr-xxx
phpize
./configure && make && make install
]]>
</programlisting>
</example>
&pecl.windows.download;
</para>
</section>

21
reference/xdiff/configure.xml
View file

@ -3,28 +3,11 @@
<section xml:id="xdiff.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
xdiff is currently available through PECL
&pecl.info;
<link xlink:href="&url.pecl.package;xdiff">&url.pecl.package;xdiff</link>.
</para>
<para>
If <link xlink:href="&url.php.pear;">PEAR</link> is available on your *nix-like
system you can use the pear installer to install the xdiff extension, by the
following command: <command>pear -v install xdiff</command>.
</para>
<para>
You can always download the tar.gz package and install xdiff by hand:
<example>
<title>xdiff install by hand</title>
<programlisting role="shell">
<![CDATA[
gunzip xdiff-xxx.tgz
tar -xvf xdiff-xxx.tar
cd xdiff-xxx
phpize
./configure && make && make install
]]>
</programlisting>
</example>
&pecl.windows.download;
</para>
</section>