Document fam_notify module.
authorJames Peach <jpeach@samba.org>
Wed, 28 Feb 2007 17:11:03 +0000 (17:11 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 13:47:26 +0000 (08:47 -0500)
(This used to be commit 1ba0ed90b05dfc1b51abcdfa1be21a25829870b8)

docs/manpages-3/smb-vfs-fam_notify.8.xml [new file with mode: 0644]

diff --git a/docs/manpages-3/smb-vfs-fam_notify.8.xml b/docs/manpages-3/smb-vfs-fam_notify.8.xml
new file mode 100644 (file)
index 0000000..7030029
--- /dev/null
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="smb-vfs-fam_notify.8">
+
+<refmeta>
+       <refentrytitle>smb-vfs-fam_notify</refentrytitle>
+       <manvolnum>8</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+       <refname>fam_notify</refname>
+       <refpurpose>FAM support for file change notifications</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+       <cmdsynopsis>
+               <command>vfs objects = fam_notify</command>
+       </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+       <title>DESCRIPTION</title>
+
+       <para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+       <manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+       <para>The <command>fam_notify</command> module makes use of
+       the system FAM (File Alteration Monitor) daemon to implement
+       file change notifications for Windows clients. FAM is generally
+       present only on IRIX and some BSD systems.</para>
+
+       <para>This module is not stackable.</para>
+
+</refsect1>
+
+<refsect1>
+       <title>EXAMPLES</title>
+
+       <para>Support FAM notifications globally:</para>
+
+<programlisting>
+        <smbconfsection name="[global]"/>
+       <smbconfoption name="vfs objects">fam_notify</smbconfoption>
+</programlisting>
+
+</refsect1>
+
+<refsect1>
+       <title>VERSION</title>
+
+       <para>This man page is correct for version 3.0.25 of the Samba suite.
+       </para>
+</refsect1>
+
+<refsect1>
+       <title>AUTHOR</title>
+
+       <para>The original Samba software and related utilities
+       were created by Andrew Tridgell. Samba is now developed
+       by the Samba Team as an Open Source project similar
+       to the way the Linux kernel is developed.</para>
+
+</refsect1>
+
+</refentry>