hholzgra Mon Sep 15 05:29:05 2003 EDT
Added files:
/phpdoc/en/reference/fam reference.xml
/phpdoc/en/reference/fam/functions fam-cancel-monitor.xml
fam-close.xml
fam-monitor-collection.xml
fam-monitor-directory.xml
fam-monitor-file.xml
fam-next-event.xml fam-open.xml
fam-pending.xml
fam-resume-monitor.xml
fam-suspend-monitor.xml
Modified files:
/phpdoc manual.xml.in
Log:
documentation for FAM extension started
Index: phpdoc/manual.xml.in
diff -u phpdoc/manual.xml.in:1.154 phpdoc/manual.xml.in:1.155
--- phpdoc/manual.xml.in:1.154 Tue Jul 15 04:08:35 2003
+++ phpdoc/manual.xml.in Mon Sep 15 05:29:04 2003
@@ -120,6 +120,7 @@
&reference.domxml.reference;
&reference.dotnet.reference;
&reference.errorfunc.reference;
+ &reference.fam.reference;
&reference.fbsql.reference;
&reference.filepro.reference;
&reference.filesystem.reference;
Index: phpdoc/en/reference/fam/reference.xml
+++ phpdoc/en/reference/fam/reference.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<reference id="ref.fam">
<title>File alteration monitor functions</title>
<titleabbrev>fam</titleabbrev>
<partintro>
<section id="fam.intro">
&reftitle.intro;
<para>
FAM monitors files and directories, notifying interested
applications of changes.
</para>
<para>
A PHP script may specify a list of files for FAM to monitor
using the functions provided by this extension.
</para>
<para>
The FAM process is started when the first connection
from any application to it is opened. It exits after all
connections to it have been closed.
</para>
</section>
<section id="fam.requirements">
&reftitle.required;
<para>
This extension requires ... version ... as available on ...
</para>
</section>
<section id="fam.installation">
&reftitle.install;
<para>
</para>
</section>
<section id="fam.configuration">
&reftitle.runtime;
&no.config;
</section>
<section id="fam.resources">
&reftitle.resources;
<section id="fam.resources.fam">
<title>FAM resource</title>
<para>
</para>
</section>
</section>
<section id="fam.constants">
&reftitle.constants;
&extension.constants;
<para>
<table>
<title>FAM constants</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<constant>FAMChanged</constant> (<type>integer</type>)
</entry>
<entry>
The status of
</entry>
</row>
<row>
<entry>
<constant>FAMDeleted</constant> (<type>integer</type>)
</entry>
<entry></entry>
</row>
<row>
<entry>
<constant>FAMStartExecuting</constant> (<type>integer</type>)
</entry>
<entry></entry>
</row>
<row>
<entry>
<constant>FAMStopExecuting</constant> (<type>integer</type>)
</entry>
<entry></entry>
</row>
<row>
<entry>
<constant>FAMCreated</constant> (<type>integer</type>)
</entry>
<entry></entry>
</row>
<row>
<entry>
<constant>FAMMoved</constant> (<type>integer</type>)
</entry>
<entry></entry>
</row>
<row>
<entry>
<constant>FAMAcknowledge</constant> (<type>integer</type>)
</entry>
<entry></entry>
</row>
<row>
<entry>
<constant>FAMExists</constant> (<type>integer</type>)
</entry>
<entry></entry>
</row>
<row>
<entry>
<constant>FAMEndExist</constant> (<type>integer</type>)
</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</section>
</partintro>
&reference.fam.functions;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml
+++ phpdoc/en/reference/fam/functions/fam-cancel-monitor.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.fam-cancel-monitor">
<refnamediv>
<refname>fam_cancel_monitor</refname>
<refpurpose>Terminate monitoring</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>fam_cancel_monitor</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
<methodparam><type>resource</type><parameter>fam_monitor</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_cancel_monitor</function> terminates monitoring on
a resource previously requested using one of the
<function>fam_monitor_...</function>.
</para>
<para>
See also <function>fam_monitor_file</function>,
<function>fam_monitor_directory</function>,
<function>fam_monitor_collection</function>,
<function>fam_suspend_monitor</function>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/fam/functions/fam-close.xml
+++ phpdoc/en/reference/fam/functions/fam-close.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.fam-close">
<refnamediv>
<refname>fam_close</refname>
<refpurpose>Close FAM connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<void/><methodname>fam_close</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_close</function> closes a connection to the FAM service
previously opened using <function>fam_open</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/fam/functions/fam-monitor-collection.xml
+++ phpdoc/en/reference/fam/functions/fam-monitor-collection.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.fam-monitor-collection">
<refnamediv>
<refname>fam_monitor_collection</refname>
<refpurpose>Monitor a collection of files in a directory for changes</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>fam_monitor_collection</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
<methodparam><type>string</type><parameter>dirname</parameter></methodparam>
<methodparam><type>int</type><parameter>depth</parameter></methodparam>
<methodparam><type>string</type><parameter>mask</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_monitor_file</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.
<!-- TODO: go a bit more into details here -->
</para>
<para>
See also <function>fam_monitor_file</function>,
<function>fam_monitor_directory</function>,
<function>fam_cancel_monitor</function>,
<function>fam_suspend_monitor</function>,
<function>fam_resume_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/fam/functions/fam-monitor-directory.xml
+++ phpdoc/en/reference/fam/functions/fam-monitor-directory.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.fam-monitor-directory">
<refnamediv>
<refname>fam_monitor_directory</refname>
<refpurpose>Monitor a directory for changes</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>fam_monitor_directory</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
<methodparam><type>string</type><parameter>dirname</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_monitor_file</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 (ie. the results of <function>readdir</function>)
change.
<!-- TODO: go a bit more into details here -->
</para>
<para>
See also <function>fam_monitor_file</function>,
<function>fam_monitor_collection</function>,
<function>fam_cancel_monitor</function>,
<function>fam_suspend_monitor</function>,
<function>fam_resume_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/fam/functions/fam-monitor-file.xml
+++ phpdoc/en/reference/fam/functions/fam-monitor-file.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.fam-monitor-file">
<refnamediv>
<refname>fam_monitor_file</refname>
<refpurpose>Monitor a regular file for changes</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>fam_monitor_file</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_monitor_file</function> requests monitoring for a single
file. A FAM event will be generated whenever the file status
(i.e. the result of function <function>stat</function> on that file)
changes.
</para>
<para>
See also <function>fam_monitor_directory</function>,
<function>fam_monitor_collection</function>,
<function>fam_cancel_monitor</function>,
<function>fam_suspend_monitor</function>,
<function>fam_resume_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/fam/functions/fam-next-event.xml
+++ phpdoc/en/reference/fam/functions/fam-next-event.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.fam-next-event">
<refnamediv>
<refname>fam_next_event</refname>
<refpurpose>...</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>fam_next_event</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_next_event</function> returns the next pending FAM
event. The function will block until an event is available which can
be checked for using <function>fam_pending</function>.
</para>
<para>
<function>fam_ext_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
optionaly a hostname in element '<literal>hostname</literal>'.
</para>
<para>
The possible event codes are described in detail in the
<link linkend="reference.fam">introduction part</link> of this section.
</para>
<para>
See also <function>fam_pending</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/fam/functions/fam-open.xml
+++ phpdoc/en/reference/fam/functions/fam-open.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.fam-open">
<refnamediv>
<refname>fam_open</refname>
<refpurpose>Open connection to FAM daemon</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>fam_open</methodname>
<methodparam
choice='opt'><type>string</type><parameter>appname</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_open</function> opens a connection to the FAM service
daemon. The optional parameter <parameter>appname</parameter> should
be set to a string identifying the application for logging reasons.
</para>
<para>
See also <function>fam_close</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/fam/functions/fam-pending.xml
+++ phpdoc/en/reference/fam/functions/fam-pending.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.fam-pending">
<refnamediv>
<refname>fam_pending</refname>
<refpurpose>Check for pending FAM events</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>fam_pending</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_pending</function> returns &true; if events are
available to be fetched using <function>fam_next_event</function>.
</para>
<para>
See also <function>fam_next_event</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/fam/functions/fam-resume-monitor.xml
+++ phpdoc/en/reference/fam/functions/fam-resume-monitor.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.fam-resume-monitor">
<refnamediv>
<refname>fam_resume_monitor</refname>
<refpurpose>Resume suspended monitoring</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>fam_resume_monitor</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
<methodparam><type>resource</type><parameter>fam_monitor</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_resume_monitor</function> resumes monitoring
of a resource previously suspend using <function>fam_suspend_monitor</function>.
</para>
<para>
See also <function>fam_suspend_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/fam/functions/fam-suspend-monitor.xml
+++ phpdoc/en/reference/fam/functions/fam-suspend-monitor.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.fam-suspend-monitor">
<refnamediv>
<refname>fam_suspend_monitor</refname>
<refpurpose>Temporarily suspend monitoring</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>fam_suspend_monitor</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
<methodparam><type>resource</type><parameter>fam_monitor</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_suspend_monitor</function> temporarily suspend monitoring
of a resource previously requested using one of the
<function>fam_monitor_...</function>
functions. Monitoring can later be continued using
<function>fam_resume_monitor</function>
without the need of requesting a complete new monitor.
</para>
<para>
See also <function>fam_resume_monitor</function>,
<function>fam_cancel_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
