From d3d61c7d78297920dd92edc6f5ad4ab93ecc6d3f Mon Sep 17 00:00:00 2001 From: Friedhelm Betz Date: Mon, 25 Nov 2002 23:49:22 +0000 Subject: [PATCH] rsusi.txt: reflect changes configure.xml files added, linking from refernce.xml files git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@105723 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/bc/configure.xml | 33 +++++++++ reference/bc/reference.xml | 14 +--- reference/bzip2/configure.xml | 31 +++++++++ reference/bzip2/reference.xml | 17 ++--- reference/calendar/configure.xml | 30 ++++++++ reference/calendar/reference.xml | 13 ++-- reference/cpdf/configure.xml | 35 ++++++++++ reference/cpdf/reference.xml | 32 ++++++--- reference/crack/configure.xml | 30 ++++++++ reference/crack/reference.xml | 10 +-- reference/ctype/configure.xml | 32 +++++++++ reference/ctype/reference.xml | 18 ++--- reference/curl/configure.xml | 46 ++++++++++++ reference/curl/reference.xml | 26 +------ reference/cybermut/configure.xml | 35 ++++++++++ reference/cybermut/reference.xml | 19 ++--- reference/cyrus/configure.xml | 31 +++++++++ reference/cyrus/reference.xml | 7 +- reference/dba/configure.xml | 116 +++++++++++++++++++++++++++++++ reference/dba/reference.xml | 98 +------------------------- reference/dbase/configure.xml | 31 +++++++++ reference/dbase/reference.xml | 10 +-- reference/dbm/configure.xml | 32 +++++++++ reference/dbm/reference.xml | 14 +--- reference/mysql/configure.xml | 49 +++++++++++++ reference/mysql/reference.xml | 27 +------ reference/rsusi.txt | 38 +++++----- 27 files changed, 614 insertions(+), 260 deletions(-) create mode 100644 reference/bc/configure.xml create mode 100644 reference/bzip2/configure.xml create mode 100644 reference/calendar/configure.xml create mode 100644 reference/cpdf/configure.xml create mode 100644 reference/crack/configure.xml create mode 100644 reference/ctype/configure.xml create mode 100644 reference/curl/configure.xml create mode 100644 reference/cybermut/configure.xml create mode 100644 reference/cyrus/configure.xml create mode 100644 reference/dba/configure.xml create mode 100644 reference/dbase/configure.xml create mode 100644 reference/dbm/configure.xml create mode 100644 reference/mysql/configure.xml diff --git a/reference/bc/configure.xml b/reference/bc/configure.xml new file mode 100644 index 0000000000..d066d17456 --- /dev/null +++ b/reference/bc/configure.xml @@ -0,0 +1,33 @@ + + +
+ &reftitle.install; + + In PHP 4, these functions are only available if PHP was + configured with . + In PHP 3, these functions are only available if PHP was + NOT configured with . + + &windows.builtin; +
+ + diff --git a/reference/bc/reference.xml b/reference/bc/reference.xml index 35c173746c..26288d300d 100644 --- a/reference/bc/reference.xml +++ b/reference/bc/reference.xml @@ -1,5 +1,5 @@ - + BCMath Arbitrary Precision Mathematics Functions BC math @@ -20,16 +20,8 @@ external libraries for this extension. - -
- &reftitle.install; - - In PHP 4, these functions are only available if PHP was configured with - . - In PHP 3, these functions are only available if PHP was not configured with - . - -
+ + &reference.bc.configure; &reference.bc.ini; diff --git a/reference/bzip2/configure.xml b/reference/bzip2/configure.xml new file mode 100644 index 0000000000..57e0381491 --- /dev/null +++ b/reference/bzip2/configure.xml @@ -0,0 +1,31 @@ + + +
+ &reftitle.install; + + Bzip2 support in PHP is not enabled by default. You will + need to use the + configuration option when compiling PHP to enable bzip2 support. + +
+ + diff --git a/reference/bzip2/reference.xml b/reference/bzip2/reference.xml index 4c91313237..b9d5432dab 100644 --- a/reference/bzip2/reference.xml +++ b/reference/bzip2/reference.xml @@ -1,5 +1,5 @@ - + Bzip2 Compression Functions Bzip2 @@ -16,20 +16,13 @@
&reftitle.required; - This module uses the functions of the bzip2 library by Julian Seward + This module uses the functions of the bzip2 + library by Julian Seward. This module requires bzip2/libbzip2 + version >= 1.0.x.
-
- &reftitle.install; - - Bzip2 support in PHP is not enabled by default. You will need to - use the --with-bz2 configuration - option when compiling PHP to enable bzip2 support. This module - requires bzip2/libbzip2 version >= 1.0.x. - -
+ &reference.bzip2.configure;
&reftitle.runtime; diff --git a/reference/calendar/configure.xml b/reference/calendar/configure.xml new file mode 100644 index 0000000000..b30814baad --- /dev/null +++ b/reference/calendar/configure.xml @@ -0,0 +1,30 @@ + + +
+ &reftitle.install; + + To get these functions to work, you have to compile PHP with + . + + &windows.builtin; +
+ \ No newline at end of file diff --git a/reference/calendar/reference.xml b/reference/calendar/reference.xml index d8e5642e36..2470bc115e 100644 --- a/reference/calendar/reference.xml +++ b/reference/calendar/reference.xml @@ -1,5 +1,5 @@ - + Calendar functions Calendar @@ -20,17 +20,14 @@ included in these instructions, and are in quotes.
-
- &reftitle.install; - - To get these functions to work, you have to compile PHP with - . - -
+ + &reference.calendar.configure; +
&reftitle.runtime; &no.config;
+
&reftitle.resources; &no.resource; diff --git a/reference/cpdf/configure.xml b/reference/cpdf/configure.xml new file mode 100644 index 0000000000..2a4c47a115 --- /dev/null +++ b/reference/cpdf/configure.xml @@ -0,0 +1,35 @@ + + +
+ &reftitle.install; + + To get these functions to work, you have to compile PHP with + . DIR is the cpdflib + install directory, defaults to /usr. In addition you + can specify the jpeg library and the tiff library for ClibPDF to use. To do + so add to your configure line the options + + . + +
+ + \ No newline at end of file diff --git a/reference/cpdf/reference.xml b/reference/cpdf/reference.xml index 9f05ddc9c0..786a4d972a 100644 --- a/reference/cpdf/reference.xml +++ b/reference/cpdf/reference.xml @@ -1,5 +1,5 @@ - + ClibPDF functions ClibPDF @@ -8,15 +8,10 @@
&reftitle.intro; - ClibPDF lets you create PDF documents with PHP. It is available for - download from FastIO, but - requires that you purchase a license for commercial use. ClibPDF - functionality and API are similar to PDFlib. - - + ClibPDF lets you create PDF documents with PHP. ClibPDF functionality + and API are similar to PDFlib. This documentation should be read alongside the ClibPDF manual since it - explains the library in much greater detail. + explains the library in much greater detail. Many functions in the native ClibPDF and the PHP module, as well @@ -29,7 +24,7 @@ not support the creation of several PDF documents at the same time. Actually, you should not even try it, the results are unpredictable. I can't oversee what the consequences in a multi threaded environment - are. According to the author of ClibPDF this will change in one of + are. According to the author of ClibPDF this will change in one of the next releases (current version when this was written is 1.10). If you need this functionality use the pdflib module. @@ -57,6 +52,23 @@
+
+ &reftitle.required; + + In order to use the ClibPDF functions you need to install the ClibPDF + package. It is available for download from + FastIO, but requires that you purchase a license for commercial + use. PHP requires that you use cpdflib >= 2. + +
+ + &reference.cpdf.configure; + +
+ &reftitle.runtime; + &no.config; +
+ &reference.cpdf.constants;
diff --git a/reference/crack/configure.xml b/reference/crack/configure.xml new file mode 100644 index 0000000000..311289e8b5 --- /dev/null +++ b/reference/crack/configure.xml @@ -0,0 +1,30 @@ + + +
+ &reftitle.install; + + In order to use these functions, you must compile PHP with Crack support + by using the option. + +
+ + diff --git a/reference/crack/reference.xml b/reference/crack/reference.xml index a604fbaa7c..ec9e804f77 100644 --- a/reference/crack/reference.xml +++ b/reference/crack/reference.xml @@ -1,5 +1,5 @@ - + Crack functions Crack functions @@ -24,13 +24,7 @@
-
- &reftitle.install; - - In order to use these functions, you must compile PHP with Crack support - by using the option. - -
+ &reference.crack.configure; &reference.crack.ini; diff --git a/reference/ctype/configure.xml b/reference/ctype/configure.xml new file mode 100644 index 0000000000..2b614ed182 --- /dev/null +++ b/reference/ctype/configure.xml @@ -0,0 +1,32 @@ + + +
+ &reftitle.install; + + Beginning with PHP 4.2.0 these functions are enabled by default. + For older versions you have to configure and compile PHP with + . You can disable + ctype support with . + +
+ + \ No newline at end of file diff --git a/reference/ctype/reference.xml b/reference/ctype/reference.xml index ec76cd8279..f031621531 100644 --- a/reference/ctype/reference.xml +++ b/reference/ctype/reference.xml @@ -1,5 +1,5 @@ - + Character type functions ctype @@ -14,7 +14,8 @@ When called with an integer argument these functions - behave exactly like their C counterparts from "ctype.h". + behave exactly like their C counterparts from + ctype.h. When called with a string argument they will check @@ -24,7 +25,7 @@ the result will always be &true;. - Passing anything else but a string or integer will + Passing anything else but a string or integer will return &false; immediately.
@@ -36,15 +37,8 @@ always available. - -
- &reftitle.install; - - Beginning with PHP 4.2.0 these functions are enabled by default. - For older versions you have to configure and compile PHP - with . - -
+ + &reference.ctype.configure;
&reftitle.runtime; diff --git a/reference/curl/configure.xml b/reference/curl/configure.xml new file mode 100644 index 0000000000..3ec7eebfe4 --- /dev/null +++ b/reference/curl/configure.xml @@ -0,0 +1,46 @@ + + +
+ &reftitle.install; + + To use PHP's CURL support you must also compile PHP where DIR is the + location of the directory containing the lib and include + directories. In the "include" directory there should be a folder + named "curl" which should contain the easy.h and + curl.h files. There should be a file named + libcurl.a located in the "lib" directory. Beginning + with PHP 4.3.0 you can configure PHP to use CURL for url streams + . + + + Note to Win32 Users + + In order to enable this module on a Windows environment, you must copy + libeay32.dll and ssleay32.dll + from the DLL folder of the PHP/Win32 binary package to the SYSTEM32 + folder of your windows machine. (Ex: C:\WINNT\SYSTEM32 or C:\WINDOWS\SYSTEM32) + + +
+ + diff --git a/reference/curl/reference.xml b/reference/curl/reference.xml index 29de7c03b6..1a849d7330 100644 --- a/reference/curl/reference.xml +++ b/reference/curl/reference.xml @@ -1,5 +1,5 @@ - + CURL, Client URL Library Functions CURL @@ -18,7 +18,7 @@ user+password authentication. - These functions have been added in PHP 4.0.2. + These functions have been added in PHP 4.0.2.
@@ -33,27 +33,7 @@ -
- &reftitle.install; - - To use PHP's CURL support you must also compile PHP where DIR is the - location of the directory containing the lib and include - directories. In the "include" directory there should be a folder - named "curl" which should contain the easy.h and curl.h files. - There should be a file named "libcurl.a" located in the "lib" - directory. - - - Note to Win32 Users - - In order to enable this module on a Windows environment, you must copy - libeay32.dll and ssleay32.dll - from the DLL folder of the PHP/Win32 binary package to the SYSTEM32 - folder of your windows machine. (Ex: C:\WINNT\SYSTEM32 or C:\WINDOWS\SYSTEM32) - - -
+ &reference.curl.configure; &reference.curl.constants; diff --git a/reference/cybermut/configure.xml b/reference/cybermut/configure.xml new file mode 100644 index 0000000000..8585090d80 --- /dev/null +++ b/reference/cybermut/configure.xml @@ -0,0 +1,35 @@ + + +
+ &reftitle.install; + + These functions are only available if PHP has been compiled with the + option, where DIR + is the location of libcm-mac.a and cm-mac.h + . You will require the appropriate SDK for your platform, which + may be sent to you after your CyberMUT's subscription (contact + them via Web, or go to the nearest Crédit Mutuel). + + ¬e.no-windows.extension; +
+ + diff --git a/reference/cybermut/reference.xml b/reference/cybermut/reference.xml index 656ad618a8..a819c1792f 100644 --- a/reference/cybermut/reference.xml +++ b/reference/cybermut/reference.xml @@ -1,5 +1,5 @@ - + Crédit Mutuel CyberMUT functions CyberMUT @@ -32,20 +32,9 @@ - -
- &reftitle.install; - - These functions are only available if PHP has been compiled with the - - option, where DIR is the location of libcm-mac.a - and cm-mac.h. - You will require the appropriate SDK for your platform, which - may be sent to you after your CyberMUT's subscription (contact - them via Web, or go to the nearest Crédit Mutuel). - -
+ + &reference.cybermut.configure; + diff --git a/reference/cyrus/configure.xml b/reference/cyrus/configure.xml new file mode 100644 index 0000000000..167d16e71c --- /dev/null +++ b/reference/cyrus/configure.xml @@ -0,0 +1,31 @@ + + +
+ &reftitle.install; + + To enable Cyrus IMAP support and to use these functions you have to compile + PHP with the option. + + ¬e.no-windows.extension; +
+ + diff --git a/reference/cyrus/reference.xml b/reference/cyrus/reference.xml index 3fc91266a6..79098b17e7 100644 --- a/reference/cyrus/reference.xml +++ b/reference/cyrus/reference.xml @@ -1,5 +1,5 @@ - + Cyrus IMAP administration functions Cyradm functions @@ -10,9 +10,12 @@ &reftitle.intro; &warn.undocumented.func; + ¬e.no-windows.extension; - + + &reference.cyrus.configure; + &reference.cyrus.constants; diff --git a/reference/dba/configure.xml b/reference/dba/configure.xml new file mode 100644 index 0000000000..6a4e5546cd --- /dev/null +++ b/reference/dba/configure.xml @@ -0,0 +1,116 @@ + + +
+ &reftitle.install; + + By using the + configuration option you can build a dynamic loadable modul to enable PHP + for basic support of dbm-style databases. You also have to add support + for at least one of the following handlers by specifying the + --with-XXXX configure switch to your PHP configure + line. + + Supported DBA handlers + + + + Handler + Configure Switch + + + + + dbm + + To enable support for dbm add + . + + + + + ndbm + + To enable support for ndbm add + . + + + + + gdbm + + To enable support for gdbm add + . + + + + + db2 + + To enable support for db2 add + . + + + + + db3 + + To enable support for db3 add + . + + + + + cdb + + To enable support for cdb add + . + + + Since PHP 4.3.0 you can omit DIR to use the bundeled cdb library + that adds the cdb_make handler which allows creation of cdb files + and allows to access cdb files on the network using php's streams. + + + + + + flatfile + + To enable support for flatfile add + . + + + This was added in PHP 4.3.0 to add compatibility with deprecated + dbm extension. Uee this handler only + when you cannot install one of the libraries required by the other + handlers and when you cannot use bundeled cdb handler. + + + + + + +
+ +
+ + diff --git a/reference/dba/reference.xml b/reference/dba/reference.xml index 624bfdde3c..795b3b7630 100644 --- a/reference/dba/reference.xml +++ b/reference/dba/reference.xml @@ -1,5 +1,5 @@ - + Database (dbm-style) abstraction layer functions dba @@ -127,101 +127,7 @@ -
- &reftitle.install; - - By using the - configuration option you can build a dynamic loadable modul to enable PHP - for basic support of dbm-style databases. You also have to add support - for at least one of the following handlers by specifying the - --with-XXXX configure switch to your PHP configure - line. - - Supported DBA handlers - - - - Handler - Configure Switch - - - - - dbm - - To enable support for dbm add - . - - - - - ndbm - - To enable support for ndbm add - . - - - - - gdbm - - To enable support for gdbm add - . - - - - - db2 - - To enable support for db2 add - . - - - - - db3 - - To enable support for db3 add - . - - - - - cdb - - To enable support for cdb add - . - - - Since PHP 4.3.0 you can omit DIR to use the bundeled cdb library - that adds the cdb_make handler which allows creation of cdb files - and allows to access cdb files on the network using php's streams. - - - - - - - flatfile - - To enable support for flatfile add - . - - - This was added in PHP 4.3.0 to add compatibility with deprecated - dbm extension. Uee this handler only - when you cannot install one of the libraries required by the other - handlers and when you cannot use bundeled cdb handler. - - - - - - - -
- -
+ &reference.dba.configure;
&reftitle.runtime; diff --git a/reference/dbase/configure.xml b/reference/dbase/configure.xml new file mode 100644 index 0000000000..b83b5e9ca2 --- /dev/null +++ b/reference/dbase/configure.xml @@ -0,0 +1,31 @@ + + +
+ &reftitle.install; + + In order to enable the bundled dbase library and to use these functions, + you must compile PHP with the option. + +
+ + diff --git a/reference/dbase/reference.xml b/reference/dbase/reference.xml index 1daf7b10fc..3e854b01bd 100644 --- a/reference/dbase/reference.xml +++ b/reference/dbase/reference.xml @@ -1,5 +1,5 @@ - + dBase functions dBase @@ -32,13 +32,7 @@
-
- &reftitle.install; - - In order to use these functions, you must compile - PHP with the option. - -
+ &reference.dbase.configure;
&reftitle.runtime; diff --git a/reference/dbm/configure.xml b/reference/dbm/configure.xml new file mode 100644 index 0000000000..64e30fa642 --- /dev/null +++ b/reference/dbm/configure.xml @@ -0,0 +1,32 @@ + + +
+ &reftitle.install; + + In order to use these functions, you must compile PHP with dbm support + by using the option. In + addition you must ensure support + for an underlying database or you can use some sytem libraries. + +
+ + diff --git a/reference/dbm/reference.xml b/reference/dbm/reference.xml index 6e06973ca1..f544881cc2 100644 --- a/reference/dbm/reference.xml +++ b/reference/dbm/reference.xml @@ -1,7 +1,7 @@ - + - DBM Functions + DBM Functions [deprecated] DBM @@ -33,15 +33,7 @@
-
- &reftitle.install; - - In order to use these functions, you must compile PHP with dbm support - by using the option. In - addtion you must ensure support - for an underlying database or you can use some sytem libraries. - -
+ &reference.dbm.configure;
&reftitle.runtime; diff --git a/reference/mysql/configure.xml b/reference/mysql/configure.xml new file mode 100644 index 0000000000..aa4c5584f5 --- /dev/null +++ b/reference/mysql/configure.xml @@ -0,0 +1,49 @@ + + +
+ &reftitle.install; + + By using the + configuration option you enable PHP to access MySQL + databases. If you use this option without specifying the path to MySQL, + PHP will use the built-in MySQL client libraries. With + PHP 4 MySQL support is always enabled; if you don't specify the configure + option, the bundled libraries are used. Users who run other applications + that use MySQL (for example, running PHP 3 and PHP 4 as concurrent apache + modules, or auth-mysql) should always specify the path to MySQL: + . + This will force PHP to use the client libraries installed + by MySQL, avoiding any conflicts. + + &windows.builtin; + + + Crashes and startup problems of PHP may be encountered + when loading this extension in conjunction with the recode extension. + See the recode extension for more + information. + + +
+ + + diff --git a/reference/mysql/reference.xml b/reference/mysql/reference.xml index 32dd818426..44e133e086 100644 --- a/reference/mysql/reference.xml +++ b/reference/mysql/reference.xml @@ -1,5 +1,5 @@ - + MySQL Functions MySQL @@ -26,30 +26,7 @@
-
- &reftitle.install; - - By using the configuration - option you enable PHP to access MySQL databases. If you use this option - without specifying the path to MySQL, PHP will use the built-in MySQL - client libraries. With PHP4 MySQL support is always enabled; if you don't - specify the configure option, the bundled libraries are used. Users who - run other applications that use MySQL (for example, running PHP 3 and PHP - 4 as concurrent apache modules, or auth-mysql) should always specify the - path to MySQL: . This will force - PHP to use the client libraries installed by MySQL, avoiding any - conflicts. - - - - Crashes and startup problems of PHP may be encountered - when loading this extension in conjunction with the recode extension. - See the recode extension for more - information. - - -
+ &reference.mysql.configure; &reference.mysql.ini; diff --git a/reference/rsusi.txt b/reference/rsusi.txt index 42cbffb4d6..584ccc4242 100644 --- a/reference/rsusi.txt +++ b/reference/rsusi.txt @@ -17,26 +17,26 @@ table. One may also add more columns for ini and configure stuff reorganization. Extension New Ref Struct ini configure -------------------------------------------------------------------------------- -apache yes -array -aspell -bc yes -bzip2 -calendar +apache yes none +array none none +aspell deprecated +bc yes yes +bzip2 none yes +calendar none yes ccvs -classobj -com yes -cpdf -crack yes -ctype -curl +classobj none none +com yes none +cpdf none yes +crack yes yes +ctype none yes +curl none yes cybercash ~ -cybermut -cyrus ~ -datetime -dba -dbase -dbm +cybermut none yes +cyrus ~ none yes +datetime none none +dba none yes +dbase none yes +dbm none yes dbplus dbx dio @@ -85,7 +85,7 @@ msession ~ msql ~ yes mssql yes muscat ~ -mysql yes +mysql yes yes ncurses yes network ~ yes nis