Document the full_audit VFS module.
[abartlet/samba.git/.git] / docs / manpages-3 / smb-vfs-fam_notify.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="smb-vfs-fam_notify.8">
4
5 <refmeta>
6         <refentrytitle>smb-vfs-fam_notify</refentrytitle>
7         <manvolnum>8</manvolnum>
8 </refmeta>
9
10
11 <refnamediv>
12         <refname>fam_notify</refname>
13         <refpurpose>FAM support for file change notifications</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17         <cmdsynopsis>
18                 <command>vfs objects = fam_notify</command>
19         </cmdsynopsis>
20 </refsynopsisdiv>
21
22 <refsect1>
23         <title>DESCRIPTION</title>
24
25         <para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
26         <manvolnum>7</manvolnum></citerefentry> suite.</para>
27
28         <para>The <command>fam_notify</command> module makes use of
29         the system FAM (File Alteration Monitor) daemon to implement
30         file change notifications for Windows clients. FAM is generally
31         present only on IRIX and some BSD systems.</para>
32
33         <para>This module is not stackable.</para>
34
35 </refsect1>
36
37 <refsect1>
38         <title>EXAMPLES</title>
39
40         <para>Support FAM notifications globally:</para>
41
42 <programlisting>
43         <smbconfsection name="[global]"/>
44         <smbconfoption name="vfs objects">fam_notify</smbconfoption>
45 </programlisting>
46
47 </refsect1>
48
49 <refsect1>
50         <title>VERSION</title>
51
52         <para>This man page is correct for version 3.0.25 of the Samba suite.
53         </para>
54 </refsect1>
55
56 <refsect1>
57         <title>AUTHOR</title>
58
59         <para>The original Samba software and related utilities
60         were created by Andrew Tridgell. Samba is now developed
61         by the Samba Team as an Open Source project similar
62         to the way the Linux kernel is developed.</para>
63
64 </refsect1>
65
66 </refentry>