build: Move generated files out of the normal build tree

[kai/samba.git] / examples / VFS / README

diff --git a/examples/VFS/README b/examples/VFS/README
index c2f39f9727d36c39a9246b52588b7daefb4a53e7..dc99e20c450f25da8a93fcd5d5def4f89cdf0822 100644 (file)
--- a/examples/VFS/README
+++ b/examples/VFS/README
@@ -1,35 +1,20 @@
-README for Samba Virtual File System (VFS) Examples
+README for Samba Virtual File System (VFS) Example
 ===================================================
 
-This directory contains some sample code to demonstrate VFS
-construction.  The following VFS modules are given:
+This directory contains skeleton VFS modules.  When used,
+this module simply passes all requests back to the disk functions
+(i.e it operates as a passthrough filter).  It should be
+useful as a starting point for developing new VFS
+modules. 
 
-       skel
-               A skeleton VFS module.  When used, this module simply
-               passes all requests back to the disk functions (i.e it
-               operates as a passthrough filter).  It should be
-               useful as a starting point for developing new VFS
-               modules. 
+Please look at skel_opaque.c when you want your module to provide
+final functions, like a database filesystem.
 
-       audit
-               A simple module to audit file access to the syslog
-               facility.  The following operations are logged: share
-               connect/disconnect, directory opens/create/remove,
-               file open/close/rename/unlink/chmod.
+Please look at skel_transparent.c when you want your module to provide
+passthrough functions, like audit modules. 
 
-The libtool program, available from your favourite GNU software
-archive, is required to compile these programs.
-
-To use the VFS modules, create a share similar to the one below.  The
-important parameter is the 'vfs object' parameter which must point to
-the exact pathname of the shared library object.
-
-       [audit]
-                comment = Audited /data directory
-                path = /data
-                vfs object = /path/to/audit.so
-                writeable = yes
-                browseable = yes
+Please read the VFS chapter in the HOWTO collection for general help 
+on the usage of VFS modules.
 
 Further documentation on writing VFS modules for Samba can be found in
-docs directory of the Samba source distribution.
+Samba Developers Guide.