cvs: /phpdoc/appendices debugger.sgml /phpdoc/chapters config.sgml install.sgml intro.sgml security.sgml /phpdoc/functions ifx.sgml image.sgml
info.sgml sem.sgml

jim Sat Jul 31 20:37:08 1999 EDT Modified files: /phpdoc/appendices debugger.sgml /phpdoc/chapters config.sgml install.sgml intro.sgml security.sgml /phpdoc/functions ifx.sgml image.sgml info.sgml sem.sgml Log: Document Apache directives for configuration in PHP4. Make lots of little "php3.ini" -> "configuration file" changes, and make sure they're all links to that section of the manual. Index: phpdoc/appendices/debugger.sgml diff -u phpdoc/appendices/debugger.sgml:1.1 phpdoc/appendices/debugger.sgml:1.2 --- phpdoc/appendices/debugger.sgml:1.1 Sun Jun 6 14:50:31 1999 +++ phpdoc/appendices/debugger.sgml Sat Jul 31 20:37:07 1999 @@ -16,8 +16,8 @@ <para> How to set up the debugger: <orderedlist> - <listitem><simpara> Set up a TCP port for the debugger in <link - linkend="php3.ini">php3.ini</link> (<link + <listitem><simpara> Set up a TCP port for the debugger in the <link + linkend="configuration.file">configuration file</link> (<link linkend="ini.debugger.port">debugger.port</link>) and enable it (<link linkend="ini.debugger.enabled">debugger.enabled</link>). Index: phpdoc/chapters/config.sgml diff -u phpdoc/chapters/config.sgml:1.4 phpdoc/chapters/config.sgml:1.5 --- phpdoc/chapters/config.sgml:1.4 Sat Jul 31 20:03:40 1999 +++ phpdoc/chapters/config.sgml Sat Jul 31 20:37:07 1999 @@ -1,25 +1,84 @@ <chapter id="configuration"> <title>Configuration</title> - <sect1 id="php3.ini"> - <title>The php3.ini file</title> + <sect1 id="configuration.file"> + <title>The configuration file</title> <simpara> - The <filename>php3.ini</filename> file is read when PHP's parser - starts up. For the server module versions of PHP, this happens - only once when the web server is started. For the + The configuration file (called <filename>php3.ini</filename> in + PHP 3.0, and simply <filename>php.ini</filename> as of PHP 4.0) + is read when PHP starts up. For the server module versions of PHP, + this happens only once when the web server is started. For the <acronym>CGI</acronym> version, it happens on every invocation. <simpara> - Just about every directive listed here has a corresponding Apache - <filename>httpd.conf</filename> directive. Simply prepend - <emphasis>php3_</emphasis> to the start of the directive names - listed here. + When using PHP as an Apache module, you can also change the + configuration settings using directives in Apache configuration + files and .htaccess files. <simpara> - You can view the settings of most of the configuration values in - the output of <function>phpinfo</function>. + With PHP 3.0, there are Apache directives that correspond to each + configuration setting in the <filename>php3.ini</filename> name, + except the name is prefixed by "php3_". + <para> + With PHP 4.0, there are just a few Apache directives that allow you + to change the PHP configuration settings. + <variablelist> + <varlistentry> + <term> + <systemitem role="directive">php_value</systemitem> + <parameter>name</parameter> + <parameter>value</parameter> + </term> + <listitem> + <para> + This sets the value of the specified variable. + </listitem> + </varlistentry> + <varlistentry> + <term> + <systemitem role="directive">php_flag</systemitem> + <parameter>name</parameter> + <parameter>on|off</parameter> + </term> + <listitem> + <para> + This is used to set a Boolean configuration option. + </listitem> + </varlistentry> + <varlistentry> + <term> + <systemitem role="directive">php_admin_value</systemitem> + <parameter>name</parameter> + <parameter>value</parameter> + </term> + <listitem> + <para> + This sets the value of the specified variable. "Admin" + configuration settings can only be set from within the + main Apache configuration files, and not from .htaccess + files. + </listitem> + </varlistentry> + <varlistentry> + <term> + <systemitem role="directive">php_admin_flag</systemitem> + <parameter>name</parameter> + <parameter>on|off</parameter> + </term> + <listitem> + <para> + This is used to set a Boolean configuration option. + </listitem> + </varlistentry> + </variablelist> + + <simpara> + You can view the settings of the configuration values in + the output of <function>phpinfo</function>. You can also + access the values of individial configuration settings using + <function>get_cfg_var</function>. <sect2 id="ini.sect.general"> <title>General Configuration Directives</title> Index: phpdoc/chapters/install.sgml diff -u phpdoc/chapters/install.sgml:1.8 phpdoc/chapters/install.sgml:1.9 --- phpdoc/chapters/install.sgml:1.8 Mon Jul 19 14:38:30 1999 +++ phpdoc/chapters/install.sgml Sat Jul 31 20:37:07 1999 @@ -200,7 +200,7 @@ databases, and vice-versa. <simpara> See also <link linkend="ini.sect.msql">mSQL Configuration</link> - Directives in the <link linkend="php3.ini">configuration + Directives in the <link linkend="configuration.file">configuration file</link>. <simpara> <ulink url="http://www.hughes.com.au">mSQL home page</ulink> @@ -219,7 +219,7 @@ <simpara> See also <link linkend="ini.sect.mysql">MySQL Configuration</link> Directives in the <link - linkend="php3.ini">configuration file</link>. + linkend="configuration.file">configuration file</link>. <simpara> <ulink url="http://www.tcx.se">MySQL home page</ulink> </sect3> @@ -281,7 +281,7 @@ <simpara> See also <link linkend="ini.sect.pgsql">Postgres Configuration</link> Directives in the <link - linkend="php3.ini">configuration file</link>. + linkend="configuration.file">configuration file</link>. <simpara> <ulink url="http://www.postgreSQL.org/">PostgreSQL home page</ulink> @@ -312,7 +312,7 @@ <simpara> See also <link linkend="ini.sect.sybase">Sybase Configuration</link> Directives in the <link - linkend="php3.ini">configuration file</link>. + linkend="configuration.file">configuration file</link>. <simpara> <ulink url="http://www.sybase.com">Sybase home page</ulink> </sect3> @@ -329,7 +329,7 @@ <simpara> See also <link linkend="ini.sect.sybct">Sybase-CT Configuration</link> Directives in the <link - linkend="php3.ini">configuration file</link>. + linkend="configuration.file">configuration file</link>. </sect3> <sect3 id="with-velocis"> @@ -392,7 +392,7 @@ <simpara> See also <link linkend="ini.sect.uodbc">Unified ODBC Configuration</link> Directives in the <link - linkend="php3.ini">configuration file</link>. + linkend="configuration.file">configuration file</link>. </sect3> <sect3 id="with-ldap"> @@ -497,7 +497,7 @@ <option>--with-config-file-path=DIR</option> </synopsis> <simpara> - The path used to look for <link linkend="php3.ini">the php3.ini + The path used to look for <link linkend="configuration.file">the configuration file</link> when PHP starts up. </sect3> @@ -511,7 +511,7 @@ Defaults to <filename class=directory>/usr/local/bin</filename>. This option only sets the default, it may be changed with the <link linkend="ini.safe-mode-exec-dir">safe_mode_exec_dir</link> - directive in the <link linkend="php3.ini">configuration + directive in the <link linkend="configuration.file">configuration file</link> later. </sect3> @@ -540,7 +540,7 @@ information. CGI users should always enable secure mode. This option only sets the default, it may be enabled or disabled with the <link linkend="ini.safe-mode">safe_mode</link> directive in - the <link linkend="php3.ini">configuration file</link> later. + the <link linkend="configuration.file">configuration file</link> later. </sect3> <sect3 id="enable-track-vars"> @@ -554,7 +554,7 @@ HTTP_COOKIE_VARS. This option only sets the default, it may be enabled or disabled with the <link linkend="ini.track-vars">track_vars</link> directive in the - <link linkend="php3.ini">configuration file</link> later. + <link linkend="configuration.file">configuration file</link> later. </sect3> <sect3 id="enable-magic-quotes"> @@ -566,7 +566,7 @@ Enable magic quotes by default. This option only sets the default, it may be enabled or disabled with the <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> - directive in the <link linkend="php3.ini">configuration + directive in the <link linkend="configuration.file">configuration file</link> later. See also the <link linkend="ini.magic-quotes-gpc"> magic_quotes_gpc</link> and the <link @@ -583,7 +583,7 @@ Enables the internal PHP debugger support. This feature is still in an experimental state. See also the <link linkend="ini.sect.debugger">Debugger Configuration</link> - directives in the <link linkend="php3.ini">configuration + directives in the <link linkend="configuration.file">configuration file</link>. </sect3> @@ -609,7 +609,7 @@ Enables <command>bc</command> style arbitrary precision math functions. See also the <link linkend="ini.sect.bcmath">bcmath.scale </link> option in the - <link linkend="php3.ini">configuration file</link>. + <link linkend="configuration.file">configuration file</link>. </sect3> <sect3 id="enable-force-cgi-redirect"> @@ -657,7 +657,7 @@ PHP code tag is <literal>&lt;?php ?&gt;</literal>. This option only sets the default, it may be enabled or disabled with the <link linkend="ini.short-open-tag">short_open_tag</link> - directive in the <link linkend="php3.ini">configuration + directive in the <link linkend="configuration.file">configuration file</link> later. </sect3> @@ -671,7 +671,7 @@ directly from PHP with <link linkend="function.include">include()</link>. See also the <link linkend="ini.include-path">include_path</link> option in the - <link linkend="php3.ini">configuration file</link>. + <link linkend="configuration.file">configuration file</link>. </sect3> <sect3 id="disable-syntax-hl"> @@ -707,11 +707,6 @@ and you can't figure out why, see the <link linkend="install-problems">Problems section</link>. - <sect3> <!--not sure--> - <title>VPATH</title> - <simpara> - </sect3> - </sect2> <sect2> @@ -733,10 +728,10 @@ it takes longer then the 30 seconds allowed. This is because the <function>set_time_limit</function> can not be used in safe mode. Use the <link - linkend="ini.max-execution-time">max_execution_time</link> to - control this time for you own scripts. <command>make - bench</command> ignores the <link - linkend="php3.ini">configuration file</link>. + linkend="ini.max-execution-time">max_execution_time</link> + configuration setting to control this time for you own + scripts. <command>make bench</command> ignores the <link + linkend="configuration.file">configuration file</link>. </sect2> </sect1> @@ -767,23 +762,6 @@ </itemizedlist> <sect2> - <title>Configuration Changes for PHP</title> - - <simpara> - All modules are now prefixed with 'php3_'. You will need to - change your <link linkend="php3.ini">php3.ini</link> file and/or - any scripts loading extensions with the <function>dl</function> - function (or you could always remove the 'php3_' prefix). This - will prevent confusion between php modules and their supporting - libraries. - <simpara> - The <ulink url="&url.php.changelog;">ChangeLog</ulink>, <ulink - url="&url.php.faq;">FAQ</ulink> and updated documentation can - always be found at the offical PHP website or any of its mirrors. - - </sect2> - - <sect2> <title>General Installation Steps</title> <para> @@ -854,6 +832,10 @@ </para> </listitem> </itemizedlist> + + <simpara> + The DLLs for PHP extensions are prefixed with 'php3_'. This prevents + confusion between PHP extensions and their supporting libraries. </sect2> Index: phpdoc/chapters/intro.sgml diff -u phpdoc/chapters/intro.sgml:1.3 phpdoc/chapters/intro.sgml:1.4 --- phpdoc/chapters/intro.sgml:1.3 Sat Jun 19 21:21:16 1999 +++ phpdoc/chapters/intro.sgml Sat Jul 31 20:37:07 1999 @@ -76,7 +76,7 @@ network sockets and interact using other protocols. <sect1 id="intro-history"> - <title>A Brief History of PHP</title> + <title>A brief history of PHP</title> <simpara> PHP was conceived sometime in the fall of 1994 by Rasmus Lerdorf. Early non-released versions were used on his home page to keep track Index: phpdoc/chapters/security.sgml diff -u phpdoc/chapters/security.sgml:1.1 phpdoc/chapters/security.sgml:1.2 --- phpdoc/chapters/security.sgml:1.1 Mon Jul 12 20:18:43 1999 +++ phpdoc/chapters/security.sgml Sat Jul 31 20:37:07 1999 @@ -160,14 +160,14 @@ <simpara> You can set the PHP script document root by the configuration - directive <link linkend="ini.doc-root">doc_root</link> in the - <link linkend="php3.ini">php3.ini</link> file, or you can set - the environment variable <envar>PHP_DOCUMENT_ROOT</envar>. If - it is set, the CGI version of PHP will always construct the file - name to open with this <parameter>doc_root</parameter> and the - path information in the request, so you can be sure no script is - executed outside this directory (except for - <parameter>user_dir</parameter> below). + directive <link linkend="ini.doc-root">doc_root</link> in the <link + linkend="configuration.file">configuration file</link>, or you + can set the environment variable <envar>PHP_DOCUMENT_ROOT</envar>. + If it is set, the CGI version of PHP will always construct the file + name to open with this <parameter>doc_root</parameter> and the path + information in the request, so you can be sure no script is executed + outside this directory (except for <parameter>user_dir</parameter> + below). <simpara> Another option usable here is <link Index: phpdoc/functions/ifx.sgml diff -u phpdoc/functions/ifx.sgml:1.3 phpdoc/functions/ifx.sgml:1.4 --- phpdoc/functions/ifx.sgml:1.3 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/ifx.sgml Sat Jul 31 20:37:07 1999 @@ -141,9 +141,9 @@ </para><para> <function>ifx_connect</function> establishes a connection to an Informix server. All of the arguments are optional, and if they're - missing, defaults are taken from values supplied in php3.ini + missing, defaults are taken from values supplied in <link linkend="configuration.file">configuration file</link> (ifx.default_host for the host (Informix libraries will use - $INFORMIXSERVER environment value if not defined), ifx.default_user + <envar>INFORMIXSERVER</envar> environment value if not defined), ifx.default_user for user, ifx.default_password for the password (none if not defined). </para><para> In case a second call is made to Index: phpdoc/functions/image.sgml diff -u phpdoc/functions/image.sgml:1.2 phpdoc/functions/image.sgml:1.3 --- phpdoc/functions/image.sgml:1.2 Fri Jul 16 16:38:45 1999 +++ phpdoc/functions/image.sgml Sat Jul 31 20:37:07 1999 @@ -1177,9 +1177,11 @@ described in T1libs documentation. T1lib comes with two ready-to-use files, IsoLatin1.enc and IsoLatin2.enc. <para> - If you find yourself using this function all the time, a much better way - to define the encoding is to set ps.default_encoding in php3.ini to point to the right - encoding file and all fonts you load will automatically have the right encoding. + If you find yourself using this function all the time, a much + better way to define the encoding is to set ps.default_encoding in + the <link linkend="configuration.file">configuration file</link> + to point to the right encoding file and all fonts you load will + automatically have the right encoding. </refsect1> </refentry> Index: phpdoc/functions/info.sgml diff -u phpdoc/functions/info.sgml:1.3 phpdoc/functions/info.sgml:1.4 --- phpdoc/functions/info.sgml:1.3 Fri Jun 18 23:17:25 1999 +++ phpdoc/functions/info.sgml Sat Jul 31 20:37:07 1999 @@ -196,9 +196,10 @@ php3_configuration_option directives). <simpara> - To check whether the system is using a php3.ini file, try retrieving - the value of the cfg_file_path configuration setting. If this is - available, a php3.ini file is being used. + To check whether the system is using a <link + linkend="configuration.file">configuration file</link>, + try retrieving the value of the cfg_file_path configuration + setting. If this is available, a configuration file is being used. </refsect1> </refentry> @@ -561,7 +562,8 @@ Set the number of seconds a script is allowed to run. If this is reached, the script returns a fatal error. The default limit is 30 seconds or, if it exists, the max_execution_time value defined in - php3.ini. If seconds is set to zero, no time limit is imposed. + the <link linkend="configuration.file">configuration file</link>. + If seconds is set to zero, no time limit is imposed. <simpara> When called, <function>set_time_limit</function> restarts the timeout Index: phpdoc/functions/sem.sgml diff -u phpdoc/functions/sem.sgml:1.2 phpdoc/functions/sem.sgml:1.3 --- phpdoc/functions/sem.sgml:1.2 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/sem.sgml Sat Jul 31 20:37:07 1999 @@ -152,11 +152,12 @@ <parameter><optional>perm</optional></parameter></paramdef> </funcsynopsis> <para> - <function>shm_attach</function> returns an id that that can be - used to access the System V shared memory with the given key, the - first call creates the shared memory segment with mem_size - (default: sysvshm.init_mem in php3.ini, otherwise 10000 bytes) - and the optional perm-bits (default: 666). + <function>shm_attach</function> returns an id that that + can be used to access the System V shared memory with + the given key, the first call creates the shared memory + segment with mem_size (default: sysvshm.init_mem in the <link + linkend="configuration.file">configuration file</link>, otherwise + 10000 bytes) and the optional perm-bits (default: 0666). <para> A second call to <function>shm_attach</function> for the same <parameter>key</parameter> will return a different shared memory