CVS update: phpdoc/chapters

Date: Saturday June 19, 1999 @ 17:58 Author: jim Update of /repository/phpdoc/chapters In directory php:/tmp/cvs-serv29128/chapters Modified Files: config.sgml install.sgml intro.sgml lang-syntax.sgml Log Message: Various cleanups (mainly PHP3 -> PHP). Index: phpdoc/chapters/config.sgml diff -u phpdoc/chapters/config.sgml:1.1.1.1 phpdoc/chapters/config.sgml:1.2 --- phpdoc/chapters/config.sgml:1.1.1.1 Sun Jun 6 14:50:34 1999 +++ phpdoc/chapters/config.sgml Sat Jun 19 17:58:55 1999 @@ -205,12 +205,14 @@ be used as base-directory. </para> <para> - From PHP 3.0.7, it is possible to supply more than one directory. Under Windows, separate the directories with a semicolon. On all other systems, separate the directories with a colon. As an Apache module, open_basedir paths from parent directories are now automatically inherited. </para> + <note> + <para>Support for multiple directories was added in 3.0.7.</para> + </note> <para> The default is to allow all files to be opened. </para> Index: phpdoc/chapters/install.sgml diff -u phpdoc/chapters/install.sgml:1.2 phpdoc/chapters/install.sgml:1.3 --- phpdoc/chapters/install.sgml:1.2 Mon Jun 7 10:43:42 1999 +++ phpdoc/chapters/install.sgml Sat Jun 19 17:58:55 1999 @@ -3,26 +3,26 @@ <abstract> <para> This chapter will guide you through the configuration and - installation of PHP3. Prerequisite knowledge and software: + installation of PHP. Prerequisite knowledge and software: <itemizedlist> <listitem><simpara>Basic UNIX skills (being able to operate "make" and a C compiler)</simpara></listitem> <listitem><simpara>An ANSI C compiler</simpara></listitem> - <listitem><simpara>A web server (obviously)</simpara></listitem> + <listitem><simpara>A web server</simpara></listitem> </itemizedlist> </para> </abstract> <sect1 id="install-unix"> - <title>Installing From Source on UNIX</title> + <title>Installation from Source on UNIX systems</title> <sect2> <title>Downloading Source</title> <simpara> The source code for the latest version can be found at <literal><ulink - url="http://www.php.net">http://www.php.net</ulink></literal>. + url="http://www.php.net/">http://www.php.net/</ulink></literal>. </simpara> </sect2> @@ -78,12 +78,12 @@ <sect2> <title>Configuration</title> <para> - There are two ways of configuring PHP3. + There are two ways of configuring PHP. <itemizedlist> <listitem> <para> - Using the "setup" script that comes with PHP3. This script + Using the "setup" script that comes with PHP. This script asks you a series of questions (almost like the "install" script of PHP/FI 2.0) and runs "configure" in the end. To run this script, type <command>./setup</command>. @@ -109,7 +109,7 @@ <title>Apache module</title> <para> - To build PHP3 as an Apache module, answer "yes" to "Build as an + To build PHP as an Apache module, answer "yes" to "Build as an Apache module?" (the <option><link linkend="with-apache"> --with-apache</link>=<replaceable>DIR</replaceable></option> option to configure) and specify the Apache distribution base @@ -123,7 +123,7 @@ <title>fhttpd module</title> <para> - To build PHP3 as an fhttpd module, answer "yes" to "Build as an + To build PHP as an fhttpd module, answer "yes" to "Build as an fhttpd module?" (the <option><link linkend="with-fhttpd"> --with-fhttpd</link>=<replaceable>DIR</replaceable></option> option to configure) and specify the fhttpd source base @@ -136,11 +136,11 @@ <title>CGI version</title> <para> - The default is to build PHP3 as a CGI program. If you are - running a web server PHP3 has module support for, you should + The default is to build PHP as a CGI program. If you are + running a web server PHP has module support for, you should generally go for that solution for performance reasons. However, the CGI version enables Apache users to run different - PHP3-enabled pages under different user-ids. Please make sure + PHP-enabled pages under different user-ids. Please make sure you read through the <link linkend="config-security">Security chapter</link> if you are going to run PHP as a CGI. @@ -148,7 +148,7 @@ <title>Database Support Options</title> <para> - PHP3 has native support for a number of databases (as well as + PHP has native support for a number of databases (as well as ODBC): @@ -196,8 +196,8 @@ class=directory>/usr/local/Hughes</filename>. This is the default directory of the mSQL 2.0 distribution. <command>configure</command> automatically detects which mSQL - version you are running and PHP3 supports both 1.0 and 2.0, but - if you compile PHP3 with mSQL 1.0, you can only access mSQL 1.0 + version you are running and PHP supports both 1.0 and 2.0, but + if you compile PHP with mSQL 1.0, you can only access mSQL 1.0 databases, and vice-versa. <simpara> See also <link linkend="ini.sect.msql">mSQL Configuration</link> @@ -475,7 +475,7 @@ </synopsis> <simpara> Turns on extra dependencies and compiler warnings used by some - of the PHP3 developers. + of the PHP developers. </sect3> <sect3 id="with-system-regex"> @@ -485,8 +485,8 @@ </synopsis> <simpara> Uses the system's regular expression library rather than the - bundled one. If you are building PHP3 as a server module, you - must use the same library when building PHP3 as when linking the + bundled one. If you are building PHP as a server module, you + must use the same library when building PHP as when linking the server. Enable this if the system's library provides special features you need. It is recommended that you use the bundled library if possible. @@ -516,16 +516,16 @@ file</link> later. </sect3> - <sect3 id="disable-debug"> - <title>--disable-debug</title> + <sect3 id="enable-debug"> + <title>--enable-debug</title> <synopsis> - <option>--disable-debug</option> + <option>--enable-debug</option> </synopsis> <simpara> - Does not include debug information in the library or executable. - The debug information makes it easier to pinpoint bugs, so it is - a good idea to leave debug on as long as PHP3 is in alpha or - beta state. + Enables extra debug information. This makes it possible to gather + more detailed information when there are problems with PHP. + (Note that this doesn't have anything to do with debugging + facilities or information available to PHP scripts.) </sect3> <sect3 id="enable-safe-mode"> @@ -550,7 +550,7 @@ <option>--enable-track-vars</option> </synopsis> <simpara> - Makes PHP3 keep track of where GET/POST/cookie variables come + Makes PHP keep track of where GET/POST/cookie variables come from in the arrays HTTP_GET_VARS, HTTP_POST_VARS and HTTP_COOKIE_VARS. This option only sets the default, it may be enabled or disabled with the <link @@ -581,7 +581,7 @@ <option>--enable-debugger</option> </synopsis> <simpara> - Enables the internal PHP3 debugger support. This feature is + 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 @@ -652,10 +652,10 @@ <option>--disable-short-tags</option> </synopsis> <simpara> - Disables the short form <literal>&lt;? ?&gt;</literal> PHP3 - tags. You must disable the short form if you want to use PHP3 + Disables the short form <literal>&lt;? ?&gt;</literal> PHP + tags. You must disable the short form if you want to use PHP with <acronym>XML</acronym>. With short tags disabled, the only - PHP3 code tag is <literal>&lt;?php ?&gt;</literal>. This option + 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 @@ -669,7 +669,7 @@ </synopsis> <simpara> Makes it possible to run code on other HTTP or FTP servers - directly from PHP3 with <link + 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>. @@ -687,7 +687,7 @@ <sect3> <title>CPPFLAGS and LDFLAGS</title> <para> - To make the PHP3 installation look for header or library files + To make the PHP installation look for header or library files in different directories, modify the <envar>CPPFLAGS</envar> and <envar>LDFLAGS</envar> environment variables, respectively. If you are using a sensible shell, you should be able to do @@ -702,8 +702,8 @@ <sect2> <title>Building</title> <simpara> - When PHP3 is configured, you are ready to build the CGI - executable or the PHP3 library. The command + When PHP is configured, you are ready to build the CGI + executable or the PHP library. The command <command>make</command> should take care of this. If it fails and you can't figure out why, see the <link linkend="install-problems">Problems section</link>. @@ -718,9 +718,9 @@ <sect2> <title>Testing</title> <simpara> - If you have built PHP3 as a CGI program, you may test your build + If you have built PHP as a CGI program, you may test your build by typing <command>make test</command>. It is always a good idea - to test your build. This way you may catch a problem with PHP3 + to test your build. This way you may catch a problem with PHP on your platform early instead of having to struggle with it later. </sect2> @@ -728,7 +728,7 @@ <sect2> <title>Benchmarking</title> <simpara> - If you have built PHP3 as a CGI program, you may benchmark your + If you have built PHP as a CGI program, you may benchmark your build by typing <command>make bench</command>. Note that if safe mode is on by default, the benchmark may not be able to finish if it takes longer then the 30 seconds allowed. This is because the @@ -743,17 +743,17 @@ </sect1> <sect1 id="install-windows95-nt"> - <title>PHP3 Installation Guide for Windows</title> + <title>Installation on Windows 95/98/NT systems</title> <simpara> - This install guide will help you install and configure PHP3 on - your Windows 9x/NT webservers. This guide was compiled by - &link.bob;. The latest revision can be found at <ulink + This install guide will help you install and configure PHP + on your Windows 9x/NT webservers. This guide was compiled + by &link.bob;. The latest revision can be found at <ulink url="&url.win32install">&url.win32install</ulink>. <para> This guide provides installation support for: - <simplelist> + <itemizedlist> <member> Personal Web Server (Newest version recommended) </member> @@ -765,11 +765,10 @@ </member> <member>Omni HTTPd 2.0b1 </member> - </simplelist> - + </itemizedlist> <sect2> - <title>Configuration Changes for PHP3</title> + <title>Configuration Changes for PHP</title> <simpara> All modules are now prefixed with 'php3_'. You will need to @@ -1006,7 +1005,7 @@ <title>Windows NT and IIS 4</title> <simpara> - To install PHP3 on an NT Server running IIS 4, follow these + To install PHP on an NT Server running IIS 4, follow these instructions: </simpara> @@ -1247,7 +1246,7 @@ <title>Read the FAQ</title> <simpara> Some problems are more common than others. The most common ones - are listed in the PHP3 FAQ, found at <ulink + are listed in the PHP FAQ, found at <ulink url="&url.php3.faq;">&url.php3.faq;</ulink> </sect2> @@ -1255,23 +1254,23 @@ <title>Bug reports</title> <simpara> - If you think you have found a bug in PHP3, please report it. The - PHP3 developers probably don't know about it, and unless you - report it, chances are it won't be fixed. A form for reporting - bugs is available on the PHP3 network of sites, the main form is - at <ulink url="&url.php3.bugs;" >&url.php3.bugs;</ulink>. + If you think you have found a bug in PHP, please report + it. The PHP developers probably don't know about it, and + unless you report it, chances are it won't be fixed. You + can report bugs using the bug-tracking system at <ulink + url="&url.php3.bugs;">&url.php3.bugs;</ulink>. </sect2> <sect2> <title>Other problems</title> <simpara> - If you are still stuck, someone on the PHP3 mailing list may be + If you are still stuck, someone on the PHP mailing list may be able to help you. You should check out the archive first, in case someone already answered someone else who had the same problem as you. The archive is available at <ulink url="&url.php3.archive;">&url.php3.archive;</ulink>. To - subscribe to the PHP3 mailing list, send an empty mail to <ulink + subscribe to the PHP mailing list, send an empty mail to <ulink url="mailto:&email.php3.subscribe;">&email.php3.subscribe;</ulink>. The mailing list address is <literal>&email.php3;</literal>. Index: phpdoc/chapters/intro.sgml diff -u phpdoc/chapters/intro.sgml:1.1.1.1 phpdoc/chapters/intro.sgml:1.2 --- phpdoc/chapters/intro.sgml:1.1.1.1 Sun Jun 6 14:50:36 1999 +++ phpdoc/chapters/intro.sgml Sat Jun 19 17:58:55 1999 @@ -9,17 +9,18 @@ <para> Simple answer, but what does that mean? An example: - <example> - <title>An introductory example</title> - <programlisting> + + <para> + <example> + <title>An introductory example</title> + <programlisting> &lt;html>&lt;head>&lt;title>Example&lt;/title> &lt;body> &lt;?php echo "Hi, I'm a PHP script!"; ?> &lt;/body>&lt;/html> - </programlisting> - </example> + </programlisting> + </example> - <para> Notice how this is different from a CGI script written in other languages like Perl or C -- instead of writing a program with lots of commands to output HTML, you write an HTML script with a some @@ -70,7 +71,7 @@ <para> PHP also has support for talking to other services using protocols - such as IMAP, SNMP, NNTP, POP3, or even HTTP. You can even open raw + such as IMAP, SNMP, NNTP, POP3, or even HTTP. You can also open raw network sockets and interact using other protocols. <sect1 id="intro-history"> Index: phpdoc/chapters/lang-syntax.sgml diff -u phpdoc/chapters/lang-syntax.sgml:1.2 phpdoc/chapters/lang-syntax.sgml:1.3 --- phpdoc/chapters/lang-syntax.sgml:1.2 Fri Jun 18 20:43:17 1999 +++ phpdoc/chapters/lang-syntax.sgml Sat Jun 19 17:58:55 1999 @@ -5,8 +5,10 @@ PHP's syntax is borrowed primarily from C. Java and Perl have also influenced the syntax. + <beginpage> + <sect1 id="basic-syntax"> - <title>Basic Syntax</title> + <title>Basic syntax</title> <sect2 id="basic-syntax.phpmode"> <title>Escaping from HTML</title> @@ -28,7 +30,7 @@ like processing instructions"); &lt;/script> -4. &lt;% echo ("As of PHP 3.0.4 you may optionally use ASP-style tags"); %> +4. &lt;% echo ("You may optionally use ASP-style tags"); %> &lt;%= $variable; # This is a shortcut for "&lt;%echo .." %> </programlisting> </example> @@ -44,6 +46,10 @@ The fourth way is only available if ASP-style tags have been enabled using either the asp_tags configuration setting or the --enable-asp-tags compile-time configuration setting. + + <note> + <para>Support for ASP-style tags was added in 3.0.4.</para> + </note> <para> The closing "bracket" for the block will include the immediately