diff options
| author | James Peach <jpeach@samba.org> | 2007-02-28 00:56:47 +0000 |
|---|---|---|
| committer | Gerald W. Carter <jerry@samba.org> | 2008-04-23 08:47:26 -0500 |
| commit | 996429f5a1f6007cbf5d21d4a4580ea92fd7cd25 (patch) | |
| tree | 2ec32b3de89352d893bff7b7ee7db4f78664ac67 /docs | |
| parent | ea5c9c980ef307b412b48bd50090f556e55bee35 (diff) | |
| download | samba-996429f5a1f6007cbf5d21d4a4580ea92fd7cd25.tar.gz samba-996429f5a1f6007cbf5d21d4a4580ea92fd7cd25.tar.bz2 samba-996429f5a1f6007cbf5d21d4a4580ea92fd7cd25.zip | |
Document audit vfs module.
(This used to be commit 1cfa1a0921ca2601128ea678a142727112002086)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manpages-3/smb-vfs-audit.8.xml | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/docs/manpages-3/smb-vfs-audit.8.xml b/docs/manpages-3/smb-vfs-audit.8.xml new file mode 100644 index 0000000000..b88bb5943a --- /dev/null +++ b/docs/manpages-3/smb-vfs-audit.8.xml @@ -0,0 +1,118 @@ +<?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-readonly.8"> + +<refmeta> + <refentrytitle>smb-vfs-audit</refentrytitle> + <manvolnum>8</manvolnum> +</refmeta> + + +<refnamediv> + <refname>audit</refname> + <refpurpose>record selected Samba VFS operations in the system log</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>vfs objects = audit</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>audit</command> VFS module records selected + client operations to the system log using + <citerefentry><refentrytitle>syslog</refentrytitle> + <manvolnum>3</manvolnum></citerefentry> suite.</para> + + <para>The following Samba VFS operations are recorded:</para> + <simplelist> + <member>connect</member> + <member>disconnect</member> + <member>opendir</member> + <member>mkdir</member> + <member>rmdir</member> + <member>open</member> + <member>close</member> + <member>rename</member> + <member>unlink</member> + <member>chmod</member> + <member>fchmod</member> + <member>chmod_acl</member> + <member>fchmod_acl</member> + </simplelist> + + <para>This module is stackable.</para> + +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + + <varlistentry> + <term>audit:facility = FACILITY</term> + <listitem> + <para>Log messages to the named + <citerefentry><refentrytitle>syslog</refentrytitle> + <manvolnum>3</manvolnum></citerefentry> facility. + + </para> + + </listitem> + </varlistentry> + + <varlistentry> + <term>audit:priority = PRIORITY</term> + <listitem> + <para>Log messages with the named + <citerefentry><refentrytitle>syslog</refentrytitle> + <manvolnum>3</manvolnum></citerefentry> priority. + </para> + + </listitem> + </varlistentry> + + </variablelist> +</refsect1> + +<refsect1> + <title>EXAMPLES</title> + + <para>Log operations on all shares using the LOCAL1 facility + and NOTICE priority:</para> + +<programlisting> + <smbconfsection name="[global]"/> + <smbconfoption name="vfs objects">audit</smbconfoption> + <smbconfoption name="audit:facility">LOCAL1</smbconfoption> + <smbconfoption name="audit:priority">NOTICE</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> |