cvs: phpdoc /en/reference/exec/functions proc-open.xml /en/reference/filesystem/functions fopen.xml fstat.xml stat.xml
/en/reference/stream/functions stream-set-blocking.xml
| From: | Wez Furlong | Date: | Sat, 24 May 2003 20:43:53 +0000 |
| Subject: | cvs: phpdoc /en/reference/exec/functions proc-open.xml /en/reference/filesystem/functions fopen.xml fstat.xml stat.xml /en/reference/stream/functions stream-set-blocking.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969353861@lists.php.net to get a copy of this message | ||
wez Sat May 24 16:43:53 2003 EDT
Modified files:
/phpdoc/en/reference/exec/functions proc-open.xml
/phpdoc/en/reference/filesystem/functions fopen.xml fstat.xml
stat.xml
/phpdoc/en/reference/stream/functions stream-set-blocking.xml
Log:
Tweak some of the docs.
Index: phpdoc/en/reference/exec/functions/proc-open.xml diff -u phpdoc/en/reference/exec/functions/proc-open.xml:1.3 phpdoc/en/reference/exec/functions/proc-open.xml:1.4 --- phpdoc/en/reference/exec/functions/proc-open.xml:1.3 Sun Mar 30 11:46:49 2003 +++ phpdoc/en/reference/exec/functions/proc-open.xml Sat May 24 16:43:53 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/exec.xml, last change in rev 1.28 --> <refentry id='function.proc-open'> <refnamediv> @@ -33,6 +33,7 @@ <informalexample> <programlisting role="php"> <![CDATA[ +<?php $descriptorspec = array( 0 => array("pipe", "r"), // stdin is a pipe that the child will read from 1 => array("pipe", "w"), // stdout is a pipe that the child will write to @@ -58,6 +59,7 @@ echo "command returned $return_value\n"; } +?> ]]> </programlisting> </informalexample> @@ -94,7 +96,8 @@ </note> <para> - See also <function>exec</function>, <function>system</function>, + See also <function>stream_select</function>, <function>exec</function>, + <function>system</function>, <function>passthru</function>, <function>popen</function>, <function>escapeshellcmd</function>, and the <link linkend="language.operators.execution">backtick operator</link>. Index: phpdoc/en/reference/filesystem/functions/fopen.xml diff -u phpdoc/en/reference/filesystem/functions/fopen.xml:1.12 phpdoc/en/reference/filesystem/functions/fopen.xml:1.13 --- phpdoc/en/reference/filesystem/functions/fopen.xml:1.12 Wed May 21 06:34:23 2003 +++ phpdoc/en/reference/filesystem/functions/fopen.xml Sat May 24 16:43:53 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.fopen"> <refnamediv> @@ -105,7 +105,7 @@ <entry><literal>'a'</literal></entry> <entry> Open for writing only; place the file pointer at the end of - the file. If the file does not exist, attempt to create it. + the file. If the file does not exist, attempt to create it. </entry> </row> <row> @@ -122,11 +122,25 @@ </para> <note> <para> - The <parameter>mode</parameter> may contain the letter - 'b'. This is useful only on systems which differentiate between - binary and text files (i.e. Windows. It's useless on Unix). - If not needed, this will be ignored. You are encouraged to - include the 'b' flag in order to make your scripts more portable. + On systems that differentiate between binary ('b') and text ('t') mode + translation (such as Windows), the <parameter>mode</parameter> may contain + either the letter 'b' or the letter 't' as the last character to force + the translation mode to be either binary or text mode respectively. + </para> + <para> + The default translation mode depends on the SAPI that you are using, so + you are encouraged to always specify the appropriate flag; you will + usually always want to specify 'b' if you intend for your script to be + portable between different platforms. + </para> + <para> + If you do not specify the 'b' flag when working with binary files, you + will experience strange problems with your data, including broken image + files and strange problems with <literal>\r\n</literal> characters. + </para> + <para> + <emphasis>It is strongly recommended that you always use the 'b' flag + when opening files with <function>fopen</function></emphasis>. </para> </note> <para> Index: phpdoc/en/reference/filesystem/functions/fstat.xml diff -u phpdoc/en/reference/filesystem/functions/fstat.xml:1.6 phpdoc/en/reference/filesystem/functions/fstat.xml:1.7 --- phpdoc/en/reference/filesystem/functions/fstat.xml:1.6 Sat Feb 22 13:55:36 2003 +++ phpdoc/en/reference/filesystem/functions/fstat.xml Sat May 24 16:43:53 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.24 --> <refentry id="function.fstat"> <refnamediv> @@ -19,24 +19,8 @@ on an open file pointer instead of a filename. </para> <para> - Returns an array with the statistics of the file with the - following elements: - <orderedlist> - <listitem><simpara>device</simpara></listitem> - <listitem><simpara>inode</simpara></listitem> - <listitem><simpara>number of links</simpara></listitem> - <listitem><simpara>user id of owner</simpara></listitem> - <listitem><simpara>group id owner</simpara></listitem> - <listitem><simpara>device type if inode device *</simpara></listitem> - <listitem><simpara>size in bytes</simpara></listitem> - <listitem><simpara>time of last access</simpara></listitem> - <listitem><simpara>time of last modification</simpara></listitem> - <listitem><simpara>time of last change</simpara></listitem> - <listitem><simpara>blocksize for filesystem I/O *</simpara></listitem> - <listitem><simpara>number of blocks allocated</simpara></listitem> - </orderedlist> - * - only valid on systems supporting the st_blksize type--other - systems (i.e. Windows) return -1 + Returns an array with the statistics of the file; the format of the array + is described in detail on the <function>stat</function> manual page. </para> ¬e.clearstatcache; Index: phpdoc/en/reference/filesystem/functions/stat.xml diff -u phpdoc/en/reference/filesystem/functions/stat.xml:1.6 phpdoc/en/reference/filesystem/functions/stat.xml:1.7 --- phpdoc/en/reference/filesystem/functions/stat.xml:1.6 Fri May 9 19:18:26 2003 +++ phpdoc/en/reference/filesystem/functions/stat.xml Sat May 24 16:43:53 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.stat"> <refnamediv> @@ -30,77 +30,89 @@ returning these attributes in a numeric array, they can be accessed with associative indices, as noted next to each parameter; this is available since PHP 4.0.6: - <itemizedlist> - <listitem> - <simpara> - 0 : device (can also be accessed as <literal>dev</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 1 : inode (can also be accessed as <literal>ino</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 2 : inode protection mode (can also be accessed as <literal>mode</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 3 : number of links (can also be accessed as <literal>nlink</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 4 : user id of owner (can also be accessed as <literal>uid</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 5 : group id owner (can also be accessed as <literal>gid</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 6 : device type if inode device (can also be accessed as <literal>rdev - </literal>) * - </simpara> - </listitem> - <listitem> - <simpara> - 7 : size in bytes (can also be accessed as <literal>size</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 8 : time of last access (can also be accessed as <literal>atime</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 9 : time of last modification (can also be accessed as <literal>mtime - </literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 10 : time of last change (can also be accessed as <literal>ctime</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 11 : blocksize for filesystem I/O (can also be accessed as - <literal>blksize</literal>) * - </simpara> - </listitem> - <listitem> - <simpara> - 12 : number of blocks allocated (can also be accessed as - <literal>blocks</literal>) - </simpara> - </listitem> - </itemizedlist> + + <table> + <title><function>stat</function> and <function>fstat</function> result + format</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Numeric</entry> + <entry>Associative (since PHP 4.0.6)</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>0</entry> + <entry>dev</entry> + <entry>device number</entry> + </row> + <row> + <entry>1</entry> + <entry>ino</entry> + <entry>inode number</entry> + </row> + <row> + <entry>2</entry> + <entry>mode</entry> + <entry>inode protection mode</entry> + </row> + <row> + <entry>3</entry> + <entry>nlink</entry> + <entry>number of links</entry> + </row> + <row> + <entry>4</entry> + <entry>uid</entry> + <entry>userid of owner</entry> + </row> + <row> + <entry>5</entry> + <entry>gid</entry> + <entry>groupid of owner</entry> + </row> + <row> + <entry>6</entry> + <entry>rdev</entry> + <entry>device type, if inode device *</entry> + </row> + <row> + <entry>7</entry> + <entry>size</entry> + <entry>size in bytes</entry> + </row> + <row> + <entry>8</entry> + <entry>atime</entry> + <entry>time of last access (unix timestamp)</entry> + </row> + <row> + <entry>9</entry> + <entry>mtime</entry> + <entry>time of last modification (unix timestamp)</entry> + </row> + <row> + <entry>10</entry> + <entry>ctime</entry> + <entry>time of last change (unix timestamp)</entry> + </row> + <row> + <entry>11</entry> + <entry>blksize</entry> + <entry>blocksize of filesystem IO *</entry> + </row> + <row> + <entry>12</entry> + <entry>blocks</entry> + <entry>number of blocks allocated</entry> + </row> + + </tbody> + </tgroup> + </table> + * - only valid on systems supporting the st_blksize type--other systems (i.e. Windows) return -1. </para> @@ -111,6 +123,7 @@ <para> See also <function>lstat</function>, + <function>fstat</function>, <function>filemtime</function>, and <function>filegroup</function>. </para> Index: phpdoc/en/reference/stream/functions/stream-set-blocking.xml diff -u phpdoc/en/reference/stream/functions/stream-set-blocking.xml:1.1 phpdoc/en/reference/stream/functions/stream-set-blocking.xml:1.2 --- phpdoc/en/reference/stream/functions/stream-set-blocking.xml:1.1 Thu Jan 2 21:41:14 2003 +++ phpdoc/en/reference/stream/functions/stream-set-blocking.xml Sat May 24 16:43:53 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/network.xml, last change in rev 1.2 --> <refentry id="function.stream-set-blocking"> <refnamediv> @@ -35,6 +35,10 @@ non-blocking mode (currently, regular files and socket streams). </simpara> </note> + <para> + See also + <function>stream_select</function> + </para> </refsect1> </refentry>
Index: phpdoc/en/reference/exec/functions/proc-open.xml diff -u phpdoc/en/reference/exec/functions/proc-open.xml:1.3 phpdoc/en/reference/exec/functions/proc-open.xml:1.4 --- phpdoc/en/reference/exec/functions/proc-open.xml:1.3 Sun Mar 30 11:46:49 2003 +++ phpdoc/en/reference/exec/functions/proc-open.xml Sat May 24 16:43:53 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/exec.xml, last change in rev 1.28 --> <refentry id='function.proc-open'> <refnamediv> @@ -33,6 +33,7 @@ <informalexample> <programlisting role="php"> <![CDATA[ +<?php $descriptorspec = array( 0 => array("pipe", "r"), // stdin is a pipe that the child will read from 1 => array("pipe", "w"), // stdout is a pipe that the child will write to @@ -58,6 +59,7 @@ echo "command returned $return_value\n"; } +?> ]]> </programlisting> </informalexample> @@ -94,7 +96,8 @@ </note> <para> - See also <function>exec</function>, <function>system</function>, + See also <function>stream_select</function>, <function>exec</function>, + <function>system</function>, <function>passthru</function>, <function>popen</function>, <function>escapeshellcmd</function>, and the <link linkend="language.operators.execution">backtick operator</link>. Index: phpdoc/en/reference/filesystem/functions/fopen.xml diff -u phpdoc/en/reference/filesystem/functions/fopen.xml:1.12 phpdoc/en/reference/filesystem/functions/fopen.xml:1.13 --- phpdoc/en/reference/filesystem/functions/fopen.xml:1.12 Wed May 21 06:34:23 2003 +++ phpdoc/en/reference/filesystem/functions/fopen.xml Sat May 24 16:43:53 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.fopen"> <refnamediv> @@ -105,7 +105,7 @@ <entry><literal>'a'</literal></entry> <entry> Open for writing only; place the file pointer at the end of - the file. If the file does not exist, attempt to create it. + the file. If the file does not exist, attempt to create it. </entry> </row> <row> @@ -122,11 +122,25 @@ </para> <note> <para> - The <parameter>mode</parameter> may contain the letter - 'b'. This is useful only on systems which differentiate between - binary and text files (i.e. Windows. It's useless on Unix). - If not needed, this will be ignored. You are encouraged to - include the 'b' flag in order to make your scripts more portable. + On systems that differentiate between binary ('b') and text ('t') mode + translation (such as Windows), the <parameter>mode</parameter> may contain + either the letter 'b' or the letter 't' as the last character to force + the translation mode to be either binary or text mode respectively. + </para> + <para> + The default translation mode depends on the SAPI that you are using, so + you are encouraged to always specify the appropriate flag; you will + usually always want to specify 'b' if you intend for your script to be + portable between different platforms. + </para> + <para> + If you do not specify the 'b' flag when working with binary files, you + will experience strange problems with your data, including broken image + files and strange problems with <literal>\r\n</literal> characters. + </para> + <para> + <emphasis>It is strongly recommended that you always use the 'b' flag + when opening files with <function>fopen</function></emphasis>. </para> </note> <para> Index: phpdoc/en/reference/filesystem/functions/fstat.xml diff -u phpdoc/en/reference/filesystem/functions/fstat.xml:1.6 phpdoc/en/reference/filesystem/functions/fstat.xml:1.7 --- phpdoc/en/reference/filesystem/functions/fstat.xml:1.6 Sat Feb 22 13:55:36 2003 +++ phpdoc/en/reference/filesystem/functions/fstat.xml Sat May 24 16:43:53 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.24 --> <refentry id="function.fstat"> <refnamediv> @@ -19,24 +19,8 @@ on an open file pointer instead of a filename. </para> <para> - Returns an array with the statistics of the file with the - following elements: - <orderedlist> - <listitem><simpara>device</simpara></listitem> - <listitem><simpara>inode</simpara></listitem> - <listitem><simpara>number of links</simpara></listitem> - <listitem><simpara>user id of owner</simpara></listitem> - <listitem><simpara>group id owner</simpara></listitem> - <listitem><simpara>device type if inode device *</simpara></listitem> - <listitem><simpara>size in bytes</simpara></listitem> - <listitem><simpara>time of last access</simpara></listitem> - <listitem><simpara>time of last modification</simpara></listitem> - <listitem><simpara>time of last change</simpara></listitem> - <listitem><simpara>blocksize for filesystem I/O *</simpara></listitem> - <listitem><simpara>number of blocks allocated</simpara></listitem> - </orderedlist> - * - only valid on systems supporting the st_blksize type--other - systems (i.e. Windows) return -1 + Returns an array with the statistics of the file; the format of the array + is described in detail on the <function>stat</function> manual page. </para> ¬e.clearstatcache; Index: phpdoc/en/reference/filesystem/functions/stat.xml diff -u phpdoc/en/reference/filesystem/functions/stat.xml:1.6 phpdoc/en/reference/filesystem/functions/stat.xml:1.7 --- phpdoc/en/reference/filesystem/functions/stat.xml:1.6 Fri May 9 19:18:26 2003 +++ phpdoc/en/reference/filesystem/functions/stat.xml Sat May 24 16:43:53 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 --> <refentry id="function.stat"> <refnamediv> @@ -30,77 +30,89 @@ returning these attributes in a numeric array, they can be accessed with associative indices, as noted next to each parameter; this is available since PHP 4.0.6: - <itemizedlist> - <listitem> - <simpara> - 0 : device (can also be accessed as <literal>dev</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 1 : inode (can also be accessed as <literal>ino</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 2 : inode protection mode (can also be accessed as <literal>mode</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 3 : number of links (can also be accessed as <literal>nlink</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 4 : user id of owner (can also be accessed as <literal>uid</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 5 : group id owner (can also be accessed as <literal>gid</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 6 : device type if inode device (can also be accessed as <literal>rdev - </literal>) * - </simpara> - </listitem> - <listitem> - <simpara> - 7 : size in bytes (can also be accessed as <literal>size</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 8 : time of last access (can also be accessed as <literal>atime</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 9 : time of last modification (can also be accessed as <literal>mtime - </literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 10 : time of last change (can also be accessed as <literal>ctime</literal>) - </simpara> - </listitem> - <listitem> - <simpara> - 11 : blocksize for filesystem I/O (can also be accessed as - <literal>blksize</literal>) * - </simpara> - </listitem> - <listitem> - <simpara> - 12 : number of blocks allocated (can also be accessed as - <literal>blocks</literal>) - </simpara> - </listitem> - </itemizedlist> + + <table> + <title><function>stat</function> and <function>fstat</function> result + format</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Numeric</entry> + <entry>Associative (since PHP 4.0.6)</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>0</entry> + <entry>dev</entry> + <entry>device number</entry> + </row> + <row> + <entry>1</entry> + <entry>ino</entry> + <entry>inode number</entry> + </row> + <row> + <entry>2</entry> + <entry>mode</entry> + <entry>inode protection mode</entry> + </row> + <row> + <entry>3</entry> + <entry>nlink</entry> + <entry>number of links</entry> + </row> + <row> + <entry>4</entry> + <entry>uid</entry> + <entry>userid of owner</entry> + </row> + <row> + <entry>5</entry> + <entry>gid</entry> + <entry>groupid of owner</entry> + </row> + <row> + <entry>6</entry> + <entry>rdev</entry> + <entry>device type, if inode device *</entry> + </row> + <row> + <entry>7</entry> + <entry>size</entry> + <entry>size in bytes</entry> + </row> + <row> + <entry>8</entry> + <entry>atime</entry> + <entry>time of last access (unix timestamp)</entry> + </row> + <row> + <entry>9</entry> + <entry>mtime</entry> + <entry>time of last modification (unix timestamp)</entry> + </row> + <row> + <entry>10</entry> + <entry>ctime</entry> + <entry>time of last change (unix timestamp)</entry> + </row> + <row> + <entry>11</entry> + <entry>blksize</entry> + <entry>blocksize of filesystem IO *</entry> + </row> + <row> + <entry>12</entry> + <entry>blocks</entry> + <entry>number of blocks allocated</entry> + </row> + + </tbody> + </tgroup> + </table> + * - only valid on systems supporting the st_blksize type--other systems (i.e. Windows) return -1. </para> @@ -111,6 +123,7 @@ <para> See also <function>lstat</function>, + <function>fstat</function>, <function>filemtime</function>, and <function>filegroup</function>. </para> Index: phpdoc/en/reference/stream/functions/stream-set-blocking.xml diff -u phpdoc/en/reference/stream/functions/stream-set-blocking.xml:1.1 phpdoc/en/reference/stream/functions/stream-set-blocking.xml:1.2 --- phpdoc/en/reference/stream/functions/stream-set-blocking.xml:1.1 Thu Jan 2 21:41:14 2003 +++ phpdoc/en/reference/stream/functions/stream-set-blocking.xml Sat May 24 16:43:53 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/network.xml, last change in rev 1.2 --> <refentry id="function.stream-set-blocking"> <refnamediv> @@ -35,6 +35,10 @@ non-blocking mode (currently, regular files and socket streams). </simpara> </note> + <para> + See also + <function>stream_select</function> + </para> </refsect1> </refentry>