s3: smbd: Change open_streams_for_delete() to take a struct smb_filename *.
[samba.git] / examples / VFS / README
index dc7398892dfaa413a97eeebb53fbad497ca671b7..dc99e20c450f25da8a93fcd5d5def4f89cdf0822 100644 (file)
@@ -1,31 +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. 
 
-       streamer
-               Stream file writes to a network address instead of to
-               disk.
-
-       perlfs
-               A wrapper for writing Samba VFS modules in Perl.
-
-The modules need only to be compiled with -I/samba/source/dir added to
-CFLAGS.
+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.