some more infos on FAM

constants in extra file, bit of description


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@155128 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Friedhelm Betz 2004-04-01 08:58:57 +00:00
parent c1dbc50daa
commit 9e66649af8
2 changed files with 113 additions and 87 deletions

103
reference/fam/constants.xml Normal file
View file

@ -0,0 +1,103 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="fam.constants">
&reftitle.constants;
&extension.constants;
<table>
<title>FAM event constants</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<constant>FAMChanged</constant> (<type>integer</type>)
</entry>
<entry>
Some value which can be obtained with fstat(1) changed for a
file or directory.
</entry>
</row>
<row>
<entry>
<constant>FAMDeleted</constant> (<type>integer</type>)
</entry>
<entry>A file or directory was deleted or renamed.</entry>
</row>
<row>
<entry>
<constant>FAMStartExecuting</constant> (<type>integer</type>)
</entry>
<entry>An executable file started executing.</entry>
</row>
<row>
<entry>
<constant>FAMStopExecuting</constant> (<type>integer</type>)
</entry>
<entry>An executable file that was running finished.</entry>
</row>
<row>
<entry>
<constant>FAMCreated</constant> (<type>integer</type>)
</entry>
<entry>A file was created in a directory.</entry>
</row>
<row>
<entry>
<constant>FAMMoved</constant> (<type>integer</type>)
</entry>
<entry>A file was moved.</entry>
</row>
<row>
<entry>
<constant>FAMAcknowledge</constant> (<type>integer</type>)
</entry>
<entry>
An event in response to <function>fam_cancel_monitor</function>.
</entry>
</row>
<row>
<entry>
<constant>FAMExists</constant> (<type>integer</type>)
</entry>
<entry>
An event upon request to monitor a file or directory. When a
directory is monitored, an event for that directory and every file
contained in that directory is issued.
</entry>
</row>
<row>
<entry>
<constant>FAMEndExist</constant> (<type>integer</type>)
</entry>
<entry>Event after the last FAMEExists event.</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<!-- 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
-->

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<reference id="ref.fam">
<title>File Alteration Monitor Functions</title>
<titleabbrev>fam</titleabbrev>
@ -8,15 +8,16 @@
<section id="fam.intro">
&reftitle.intro;
<para>
FAM monitors files and directories, notifying interested
applications of changes.
FAM monitors files and directories, notifying interested applications of
changes. More information about FAM is available at
<ulink url="&url.fam;">&url.fam;</ulink>.
</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
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>
@ -26,13 +27,9 @@
<section id="fam.requirements">
&reftitle.required;
<para>
This extension requires ... version ... as available on ...
</para>
</section>
<section id="fam.installation">
&reftitle.install;
<para>
This extension uses the functions of the <ulink url="&url.fam.download;">
FAM</ulink> library, devoloped by SGI.
<!-- This extension requires ... version ... as available on ... -->
</para>
</section>
@ -50,82 +47,8 @@
</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>
&reference.fam.constants;
</partintro>
&reference.fam.functions;