Move VFS documentation to the HOWTO collection
authorJelmer Vernooij <jelmer@samba.org>
Wed, 13 Nov 2002 13:08:56 +0000 (13:08 +0000)
committerJelmer Vernooij <jelmer@samba.org>
Wed, 13 Nov 2002 13:08:56 +0000 (13:08 +0000)
examples/VFS/README
examples/VFS/README.OtherModules [deleted file]
examples/VFS/README.netatalk [deleted file]

index 1b09929059112ee37c5483c73aee4b6cace1500b..25254c1ffc607c9332dcb7079e78d1856a8ef38d 100644 (file)
@@ -1,53 +1,14 @@
-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 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. 
 
-       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. 
-
-       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.
-
-       recycle
-               A recycle-bin like modules. When used any unlink call
-               will be intercepted and files moved to the recycle
-               directory nstead of beeing deleted.
-
-       block
-               A simple module to block access to certain mount points or 
-               directories. This module only hides the specified directories 
-               and all directories beneath them. It should NOT be used to
-               secure directories. If the name of a file in one of those
-               directories is known, the file can still be opened.
-
-       netatalk
-               A netatalk module, that will ease co-existence of samba and
-               netatalk file sharing services.
-               Looka t the README for more informations.
-
-You may have problems to compile these modules, as shared libraries are
-compiled and linked in different ways on different systems.
-I currently tested them against GNU/linux and IRIX.
-
-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.
diff --git a/examples/VFS/README.OtherModules b/examples/VFS/README.OtherModules
deleted file mode 100644 (file)
index 5693d2e..0000000
+++ /dev/null
@@ -1,51 +0,0 @@
-This file contains a listing of various other VFS modules that 
-have been posted but don't currently reside in the Samba CVS 
-tree for one reason ot another (e.g. it is easy for the maintainer 
-to have his or her own CVS tree).
-
-No statemets about the stability or functionality any module
-should be implied due to its presence here.
-
-
-------------------------------------------------------------
-URL: http://www.css.tayloru.edu/~elorimer/databasefs/index.php
-
-Date: Sat, 28 Sep 2002 23:41:31 -0500
-From: Eric Lorimer <elorimer@css.tayloru.edu>
-To: samba-technical@lists.samba.org
-Subject: DatabaseFS VFS module
-
-Hello,
-
-I have created a VFS module which implements a fairly complete read-only
-filesystem.  It presents information from a database as a filesystem in
-a modular and generic way to allow different databases to be used
-(originally designed for organizing MP3s under directories such as
-"Artists," "Song Keywords," etc... I have since applied it to a student
-roster database very easily).  The directory structure is stored in the
-database itself and the module makes no assumptions about the database
-structure beyond the table it requires to run.  You can find it at:
-
-http://www.css.tayloru.edu/~elorimer/databasefs/index.php
-
-
-Any feedback would be appreciated: comments, suggestions, patches,
-etc...  If nothing else, hopefully it might prove useful for someone
-else who wishes to create a virtual filesystem.
-
-Thanks for the great product and keep up the good work.
-
-
-- Eric Lorimer
-
-------------------------------------------------------------
-URL: http://www.openantivirus.org/
-
-"samba-vscan is a proof-of-concept module for Samba, which
-uses the VFS (virtual file system) features of Samba 2.2.x/3.0
-alphaX. Of couse, Samba has to be compiled with VFS support. 
-samba-vscan supports various virus scanners and is maintained 
-by Rainer Link".
-
-------------------------------------------------------------
-
diff --git a/examples/VFS/README.netatalk b/examples/VFS/README.netatalk
deleted file mode 100644 (file)
index 70f6eea..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-There is the new netatalk module both for HEAD.
-This one has some difference from previous module:
-
--- it doesn't care about creating of .AppleDouble forks, just keeps ones in
-sync;
-
--- if share in smb.conf doesn't contain .AppleDouble item in hide or veto 
-list, it will be added automatically.
-
-To my way of thinking, module became more lightweight and speedy.
-
-How to compile: 
-
-you should place proper netatalk.c into examples/VFS/ then run 'configure'
-from source/ and then run 'make' from examples/VFS/.
-
-add string 'vfs object = <path_to_netatalk_so>/netatlk.so' to smb.conf. It may
-be defined either as global or as share-specific parameter.