sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WS, prepare for new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227299 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-01-15 15:04:16 +00:00
parent 3d533f0250
commit c81a2adede
10 changed files with 271 additions and 271 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
reference/fam/functions/fam-cancel-monitor.xml
View file

@ -1,31 +1,31 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.fam-cancel-monitor">
<refnamediv>
<refname>fam_cancel_monitor</refname>
<refpurpose>Terminate monitoring</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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
<literal>fam_monitor_</literal> functions.
In addition an <constant>FAMAcknowledge</constant> event occurs.
</para>
<para>
See also <function>fam_monitor_file</function>,
<function>fam_monitor_directory</function>,
<function>fam_monitor_collection</function>, and
<function>fam_suspend_monitor</function>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry id="function.fam-cancel-monitor">
<refnamediv>
<refname>fam_cancel_monitor</refname>
<refpurpose>Terminate monitoring</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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
<literal>fam_monitor_</literal> functions.
In addition an <constant>FAMAcknowledge</constant> event occurs.
</para>
<para>
See also <function>fam_monitor_file</function>,
<function>fam_monitor_directory</function>,
<function>fam_monitor_collection</function>, and
<function>fam_suspend_monitor</function>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

36
reference/fam/functions/fam-close.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.fam-close">
<refnamediv>
<refname>fam_close</refname>
<refpurpose>Close FAM connection</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<methodsynopsis>
<type>void</type><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>
<!-- $Revision: 1.4 $ -->
<refentry id="function.fam-close">
<refnamediv>
<refname>fam_close</refname>
<refpurpose>Close FAM connection</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<methodsynopsis>
<type>void</type><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:

74
reference/fam/functions/fam-monitor-collection.xml
View file

@ -1,41 +1,41 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<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>
&reftitle.description;
<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_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
<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>,
<function>fam_suspend_monitor</function>, and
<function>fam_resume_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<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>
&reftitle.description;
<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_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
<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>,
<function>fam_suspend_monitor</function>, and
<function>fam_resume_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/fam/functions/fam-monitor-directory.xml
View file

@ -1,38 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.fam-monitor-directory">
<refnamediv>
<refname>fam_monitor_directory</refname>
<refpurpose>Monitor a directory for changes</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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_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>)
change.
<!-- 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>,
<function>fam_suspend_monitor</function>, and
<function>fam_resume_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry id="function.fam-monitor-directory">
<refnamediv>
<refname>fam_monitor_directory</refname>
<refpurpose>Monitor a directory for changes</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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_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>)
change.
<!-- 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>,
<function>fam_suspend_monitor</function>, and
<function>fam_resume_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

64
reference/fam/functions/fam-monitor-file.xml
View file

@ -1,36 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.fam-monitor-file">
<refnamediv>
<refname>fam_monitor_file</refname>
<refpurpose>Monitor a regular file for changes</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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>
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>,
<function>fam_suspend_monitor</function>, and
<function>fam_resume_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry id="function.fam-monitor-file">
<refnamediv>
<refname>fam_monitor_file</refname>
<refpurpose>Monitor a regular file for changes</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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>
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>,
<function>fam_suspend_monitor</function>, and
<function>fam_resume_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

64
reference/fam/functions/fam-next-event.xml
View file

@ -1,36 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.fam-next-event">
<refnamediv>
<refname>fam_next_event</refname>
<refpurpose>Get next pending FAM event</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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_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="fam.constants">constants part</link> of this section.
</para>
<para>
See also <function>fam_pending</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry id="function.fam-next-event">
<refnamediv>
<refname>fam_next_event</refname>
<refpurpose>Get next pending FAM event</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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_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="fam.constants">constants 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:

44
reference/fam/functions/fam-open.xml
View file

@ -1,26 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.fam-open">
<refnamediv>
<refname>fam_open</refname>
<refpurpose>Open connection to FAM daemon</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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>
<!-- $Revision: 1.3 $ -->
<refentry id="function.fam-open">
<refnamediv>
<refname>fam_open</refname>
<refpurpose>Open connection to FAM daemon</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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:

42
reference/fam/functions/fam-pending.xml
View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.fam-pending">
<refnamediv>
<refname>fam_pending</refname>
<refpurpose>Check for pending FAM events</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fam_pending</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_pending</function> returns non-zero 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>
<!-- $Revision: 1.4 $ -->
<refentry id="function.fam-pending">
<refnamediv>
<refname>fam_pending</refname>
<refpurpose>Check for pending FAM events</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fam_pending</methodname>
<methodparam><type>resource</type><parameter>fam</parameter></methodparam>
</methodsynopsis>
<para>
<function>fam_pending</function> returns non-zero 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:

44
reference/fam/functions/fam-resume-monitor.xml
View file

@ -1,26 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.fam-resume-monitor">
<refnamediv>
<refname>fam_resume_monitor</refname>
<refpurpose>Resume suspended monitoring</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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>
<!-- $Revision: 1.3 $ -->
<refentry id="function.fam-resume-monitor">
<refnamediv>
<refname>fam_resume_monitor</refname>
<refpurpose>Resume suspended monitoring</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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:

52
reference/fam/functions/fam-suspend-monitor.xml
View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.fam-suspend-monitor">
<refnamediv>
<refname>fam_suspend_monitor</refname>
<refpurpose>Temporarily suspend monitoring</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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
<literal>fam_monitor_</literal> 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>, and
<function>fam_cancel_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry id="function.fam-suspend-monitor">
<refnamediv>
<refname>fam_suspend_monitor</refname>
<refpurpose>Temporarily suspend monitoring</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<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
<literal>fam_monitor_</literal> 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>, and
<function>fam_cancel_monitor</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: