Hopefully these changes will actually stick.
[sfrench/samba-autobuild/.git] / examples / VFS / README
1 README for Samba Virtual File System (VFS) Examples
2 ===================================================
3
4 This directory contains some sample code to demonstrate VFS
5 construction.  The following VFS modules are given:
6
7         skel
8                 A skeleton VFS module.  When used, this module simply
9                 passes all requests back to the disk functions (i.e it
10                 operates as a passthrough filter).  It should be
11                 useful as a starting point for developing new VFS
12                 modules. 
13
14         audit
15                 A simple module to audit file access to the syslog
16                 facility.  The following operations are logged: share
17                 connect/disconnect, directory opens/create/remove,
18                 file open/close/rename/unlink/chmod.
19
20 The libtool program, available from your favourite GNU software
21 archive, is required to compile these programs.
22
23 To use the VFS modules, create a share similar to the one below.  The
24 important parameter is the 'vfs object' parameter which must point to
25 the exact pathname of the shared library object.
26
27        [audit]
28                 comment = Audited /data directory
29                 path = /data
30                 vfs object = /path/to/audit.so
31                 writeable = yes
32                 browseable = yes
33
34 Further documentation on writing VFS modules for Samba can be found in
35 docs directory of the Samba source distribution.