cvs: phpdoc /en/reference/fam constants.xml /en/reference/fam/functions fam-cancel-monitor.xml fam-monitor-collection.xml fam-monitor-directory.xml
fam-monitor-file.xml fam-next-event.xml
| From: | Friedhelm Betz | Date: | Fri, 02 Apr 2004 00:41:30 +0000 |
| Subject: | cvs: phpdoc /en/reference/fam constants.xml /en/reference/fam/functions fam-cancel-monitor.xml fam-monitor-collection.xml fam-monitor-directory.xml fam-monitor-file.xml fam-next-event.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969359893@lists.php.net to get a copy of this message | ||
betz Thu Apr 1 19:41:30 2004 EDT
Modified files:
/phpdoc/en/reference/fam constants.xml
/phpdoc/en/reference/fam/functions fam-cancel-monitor.xml
fam-monitor-collection.xml
fam-monitor-directory.xml
fam-monitor-file.xml
fam-next-event.xml
Log:
typos,
refpurpose for fam-next-event
FAMMoved event correction
link to event constants
http://cvs.php.net/diff.php/phpdoc/en/reference/fam/constants.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/fam/constants.xml diff -u phpdoc/en/reference/fam/constants.xml:1.1 phpdoc/en/reference/fam/constants.xml:1.2 --- phpdoc/en/reference/fam/constants.xml:1.1 Thu Apr 1 03:58:57 2004 +++ phpdoc/en/reference/fam/constants.xml Thu Apr 1 19:41:30 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <section id="fam.constants"> &reftitle.constants; &extension.constants; @@ -50,7 +50,7 @@ <entry> <constant>FAMMoved</constant> (<type>integer</type>) </entry> - <entry>A file was moved.</entry> + <entry>This event never occurs.</entry> </row> <row> <entry> http://cvs.php.net/diff.php/phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml diff -u phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml:1.2 phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml:1.3 --- phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml:1.2 Mon Sep 29 06:14:07 2003 +++ phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml Thu Apr 1 19:41:30 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.fam-cancel-monitor"> <refnamediv> <refname>fam_cancel_monitor</refname> @@ -14,7 +14,8 @@ </methodsynopsis> <para> <function>fam_cancel_monitor</function> terminates monitoring on - a resource previously requested using one of the <function>fam_monitor_...</function>. + a resource previously requested using one of the <function>fam_monitor_...</function>. + In addition an <constant>FAMAcknowledge</constant> event occurs. </para> <para> See also <function>fam_monitor_file</function>, http://cvs.php.net/diff.php/phpdoc/en/reference/fam/functions/fam-monitor-collection.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/fam/functions/fam-monitor-collection.xml diff -u phpdoc/en/reference/fam/functions/fam-monitor-collection.xml:1.2 phpdoc/en/reference/fam/functions/fam-monitor-collection.xml:1.3 --- phpdoc/en/reference/fam/functions/fam-monitor-collection.xml:1.2 Mon Sep 29 06:14:07 2003 +++ phpdoc/en/reference/fam/functions/fam-monitor-collection.xml Thu Apr 1 19:41:30 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.fam-monitor-collection"> <refnamediv> <refname>fam_monitor_collection</refname> @@ -15,14 +15,19 @@ <methodparam><type>string</type><parameter>mask</parameter></methodparam> </methodsynopsis> <para> - <function>fam_monitor_file</function> requests monitoring for a collection of + <function>fam_monitor_collection</function> requests monitoring for a collection of files within a directory. The actual files to be monitored are specified by a directory path in <parameter>dirname</parameter>, the maximum search <parameter>depth</parameter> starting from this directory and a shell pattern - restricting the file names to look for. + <parameter>mask</parameter> restricting the file names to look for. <!-- TODO: go a bit more into details here --> </para> <para> + A FAM event will be generated whenever the status of the files change. + The possible event codes are described in detail in the + <link linkend="fam.constants">constants part</link> of this section. + </para> + <para> See also <function>fam_monitor_file</function>, <function>fam_monitor_directory</function>, <function>fam_cancel_monitor</function>, http://cvs.php.net/diff.php/phpdoc/en/reference/fam/functions/fam-monitor-directory.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/fam/functions/fam-monitor-directory.xml diff -u phpdoc/en/reference/fam/functions/fam-monitor-directory.xml:1.3 phpdoc/en/reference/fam/functions/fam-monitor-directory.xml:1.4 --- phpdoc/en/reference/fam/functions/fam-monitor-directory.xml:1.3 Wed Dec 17 09:32:11 2003 +++ phpdoc/en/reference/fam/functions/fam-monitor-directory.xml Thu Apr 1 19:41:30 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.fam-monitor-directory"> <refnamediv> <refname>fam_monitor_directory</refname> @@ -13,7 +13,7 @@ <methodparam><type>string</type><parameter>dirname</parameter></methodparam> </methodsynopsis> <para> - <function>fam_monitor_file</function> requests monitoring for a directory + <function>fam_monitor_directory</function> requests monitoring for a directory and all contained files. A FAM event will be generated whenever the status of the directory (i.e. the result of function <function>stat</function> on that directory) or its content (i.e. the results of <function>readdir</function>) @@ -21,6 +21,10 @@ <!-- TODO: go a bit more into details here --> </para> <para> + The possible event codes are described in detail in the + <link linkend="fam.constants">constants part</link> of this section. + </para> + <para> See also <function>fam_monitor_file</function>, <function>fam_monitor_collection</function>, <function>fam_cancel_monitor</function>, http://cvs.php.net/diff.php/phpdoc/en/reference/fam/functions/fam-monitor-file.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/fam/functions/fam-monitor-file.xml diff -u phpdoc/en/reference/fam/functions/fam-monitor-file.xml:1.2 phpdoc/en/reference/fam/functions/fam-monitor-file.xml:1.3 --- phpdoc/en/reference/fam/functions/fam-monitor-file.xml:1.2 Mon Sep 29 06:14:07 2003 +++ phpdoc/en/reference/fam/functions/fam-monitor-file.xml Thu Apr 1 19:41:30 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.fam-monitor-file"> <refnamediv> <refname>fam_monitor_file</refname> @@ -19,6 +19,10 @@ changes. </para> <para> + The possible event codes are described in detail in the + <link linkend="fam.constants">constants part</link> of this section. + </para> + <para> See also <function>fam_monitor_directory</function>, <function>fam_monitor_collection</function>, <function>fam_cancel_monitor</function>, http://cvs.php.net/diff.php/phpdoc/en/reference/fam/functions/fam-next-event.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/fam/functions/fam-next-event.xml diff -u phpdoc/en/reference/fam/functions/fam-next-event.xml:1.3 phpdoc/en/reference/fam/functions/fam-next-event.xml:1.4 --- phpdoc/en/reference/fam/functions/fam-next-event.xml:1.3 Wed Dec 17 09:32:11 2003 +++ phpdoc/en/reference/fam/functions/fam-next-event.xml Thu Apr 1 19:41:30 2004 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.fam-next-event"> <refnamediv> <refname>fam_next_event</refname> - <refpurpose>...</refpurpose> + <refpurpose>Get next pending FAM event</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -17,14 +17,14 @@ be checked for using <function>fam_pending</function>. </para> <para> - <function>fam_ext_event</function> will return an array that contains + <function>fam_next_event</function> will return an array that contains a FAM event code in element '<literal>code</literal>', the path of the file this event applies to in element '<literal>filename</literal>' and optionally a hostname in element '<literal>hostname</literal>'. </para> <para> The possible event codes are described in detail in the - <link linkend="ref.fam">introduction part</link> of this section. + <link linkend="fam.constants">constants part</link> of this section. </para> <para> See also <function>fam_pending</function>.
http://cvs.php.net/diff.php/phpdoc/en/reference/fam/constants.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/fam/constants.xml diff -u phpdoc/en/reference/fam/constants.xml:1.1 phpdoc/en/reference/fam/constants.xml:1.2 --- phpdoc/en/reference/fam/constants.xml:1.1 Thu Apr 1 03:58:57 2004 +++ phpdoc/en/reference/fam/constants.xml Thu Apr 1 19:41:30 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <section id="fam.constants"> &reftitle.constants; &extension.constants; @@ -50,7 +50,7 @@ <entry> <constant>FAMMoved</constant> (<type>integer</type>) </entry> - <entry>A file was moved.</entry> + <entry>This event never occurs.</entry> </row> <row> <entry> http://cvs.php.net/diff.php/phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml diff -u phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml:1.2 phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml:1.3 --- phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml:1.2 Mon Sep 29 06:14:07 2003 +++ phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml Thu Apr 1 19:41:30 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.fam-cancel-monitor"> <refnamediv> <refname>fam_cancel_monitor</refname> @@ -14,7 +14,8 @@ </methodsynopsis> <para> <function>fam_cancel_monitor</function> terminates monitoring on - a resource previously requested using one of the <function>fam_monitor_...</function>. + a resource previously requested using one of the <function>fam_monitor_...</function>. + In addition an <constant>FAMAcknowledge</constant> event occurs. </para> <para> See also <function>fam_monitor_file</function>, http://cvs.php.net/diff.php/phpdoc/en/reference/fam/functions/fam-monitor-collection.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/fam/functions/fam-monitor-collection.xml diff -u phpdoc/en/reference/fam/functions/fam-monitor-collection.xml:1.2 phpdoc/en/reference/fam/functions/fam-monitor-collection.xml:1.3 --- phpdoc/en/reference/fam/functions/fam-monitor-collection.xml:1.2 Mon Sep 29 06:14:07 2003 +++ phpdoc/en/reference/fam/functions/fam-monitor-collection.xml Thu Apr 1 19:41:30 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.fam-monitor-collection"> <refnamediv> <refname>fam_monitor_collection</refname> @@ -15,14 +15,19 @@ <methodparam><type>string</type><parameter>mask</parameter></methodparam> </methodsynopsis> <para> - <function>fam_monitor_file</function> requests monitoring for a collection of + <function>fam_monitor_collection</function> requests monitoring for a collection of files within a directory. The actual files to be monitored are specified by a directory path in <parameter>dirname</parameter>, the maximum search <parameter>depth</parameter> starting from this directory and a shell pattern - restricting the file names to look for. + <parameter>mask</parameter> restricting the file names to look for. <!-- TODO: go a bit more into details here --> </para> <para> + A FAM event will be generated whenever the status of the files change. + The possible event codes are described in detail in the + <link linkend="fam.constants">constants part</link> of this section. + </para> + <para> See also <function>fam_monitor_file</function>, <function>fam_monitor_directory</function>, <function>fam_cancel_monitor</function>, http://cvs.php.net/diff.php/phpdoc/en/reference/fam/functions/fam-monitor-directory.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/fam/functions/fam-monitor-directory.xml diff -u phpdoc/en/reference/fam/functions/fam-monitor-directory.xml:1.3 phpdoc/en/reference/fam/functions/fam-monitor-directory.xml:1.4 --- phpdoc/en/reference/fam/functions/fam-monitor-directory.xml:1.3 Wed Dec 17 09:32:11 2003 +++ phpdoc/en/reference/fam/functions/fam-monitor-directory.xml Thu Apr 1 19:41:30 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.fam-monitor-directory"> <refnamediv> <refname>fam_monitor_directory</refname> @@ -13,7 +13,7 @@ <methodparam><type>string</type><parameter>dirname</parameter></methodparam> </methodsynopsis> <para> - <function>fam_monitor_file</function> requests monitoring for a directory + <function>fam_monitor_directory</function> requests monitoring for a directory and all contained files. A FAM event will be generated whenever the status of the directory (i.e. the result of function <function>stat</function> on that directory) or its content (i.e. the results of <function>readdir</function>) @@ -21,6 +21,10 @@ <!-- TODO: go a bit more into details here --> </para> <para> + The possible event codes are described in detail in the + <link linkend="fam.constants">constants part</link> of this section. + </para> + <para> See also <function>fam_monitor_file</function>, <function>fam_monitor_collection</function>, <function>fam_cancel_monitor</function>, http://cvs.php.net/diff.php/phpdoc/en/reference/fam/functions/fam-monitor-file.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/fam/functions/fam-monitor-file.xml diff -u phpdoc/en/reference/fam/functions/fam-monitor-file.xml:1.2 phpdoc/en/reference/fam/functions/fam-monitor-file.xml:1.3 --- phpdoc/en/reference/fam/functions/fam-monitor-file.xml:1.2 Mon Sep 29 06:14:07 2003 +++ phpdoc/en/reference/fam/functions/fam-monitor-file.xml Thu Apr 1 19:41:30 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.fam-monitor-file"> <refnamediv> <refname>fam_monitor_file</refname> @@ -19,6 +19,10 @@ changes. </para> <para> + The possible event codes are described in detail in the + <link linkend="fam.constants">constants part</link> of this section. + </para> + <para> See also <function>fam_monitor_directory</function>, <function>fam_monitor_collection</function>, <function>fam_cancel_monitor</function>, http://cvs.php.net/diff.php/phpdoc/en/reference/fam/functions/fam-next-event.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/fam/functions/fam-next-event.xml diff -u phpdoc/en/reference/fam/functions/fam-next-event.xml:1.3 phpdoc/en/reference/fam/functions/fam-next-event.xml:1.4 --- phpdoc/en/reference/fam/functions/fam-next-event.xml:1.3 Wed Dec 17 09:32:11 2003 +++ phpdoc/en/reference/fam/functions/fam-next-event.xml Thu Apr 1 19:41:30 2004 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.fam-next-event"> <refnamediv> <refname>fam_next_event</refname> - <refpurpose>...</refpurpose> + <refpurpose>Get next pending FAM event</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -17,14 +17,14 @@ be checked for using <function>fam_pending</function>. </para> <para> - <function>fam_ext_event</function> will return an array that contains + <function>fam_next_event</function> will return an array that contains a FAM event code in element '<literal>code</literal>', the path of the file this event applies to in element '<literal>filename</literal>' and optionally a hostname in element '<literal>hostname</literal>'. </para> <para> The possible event codes are described in detail in the - <link linkend="ref.fam">introduction part</link> of this section. + <link linkend="fam.constants">constants part</link> of this section. </para> <para> See also <function>fam_pending</function>.