1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
<?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>
<!-- 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
-->
|
