From 99bde6889d3d8b7a9e950c86c30e82662e1dacdd Mon Sep 17 00:00:00 2001 From: Gerald Carter Date: Tue, 9 Sep 2003 02:58:53 +0000 Subject: syncing files from 3.0 into HEAD again (This used to be commit bca0bba209255d0effbae6a3d3b6d298f0952c3a) --- docs/docbook/projdoc/VFS.xml | 110 +++++++++++++++++++++++-------------------- 1 file changed, 60 insertions(+), 50 deletions(-) (limited to 'docs/docbook/projdoc/VFS.xml') diff --git a/docs/docbook/projdoc/VFS.xml b/docs/docbook/projdoc/VFS.xml index 67f1b39a99..c949055371 100644 --- a/docs/docbook/projdoc/VFS.xml +++ b/docs/docbook/projdoc/VFS.xml @@ -33,18 +33,19 @@ on different systems. They currently have been tested against GNU/Linux and IRI To use the VFS modules, create a share similar to the one below. The -important parameter is the vfs objects parameter where +important parameter is the vfs objects parameter where you can list one or more VFS modules by name. For example, to log all access to files and put deleted files in a recycle bin: - -[audit] - comment = Audited /data directory - path = /data - vfs objects = audit recycle - writeable = yes - browseable = yes - + + smb.conf with VFS modules + [audit] +commentAudited /data directory +path/data +vfs objectsaudit recycle +writeableyes +browseableyes + @@ -62,17 +63,18 @@ directory in the root directory of the samba installation (usually Some modules can be used twice for the same share. This can be done using a configuration similar to the one below. - -[test] - comment = VFS TEST - path = /data - writeable = yes - browseable = yes - vfs objects = example:example1 example example:test - example1: parameter = 1 - example: parameter = 5 - test: parameter = 7 - + + smb.conf with multiple VFS modules +[test] +commentVFS TEST +path/data +writeableyes +browseableyes +vfs objectsexample:example1 example example:test +example1: parameter1 +example: parameter5 +test: parameter7 + @@ -86,12 +88,12 @@ This can be done using a configuration similar to the one below. 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 - + + share + connect/disconnect + directory opens/create/remove + file open/close/rename/unlink/chmod + @@ -107,7 +109,7 @@ This can be done using a configuration similar to the one below. The logging information that will be written to the smbd log file is controlled by - the log level parameter in smb.conf. The + the log level parameter in &smb.conf;. The following information will be recorded: @@ -144,49 +146,65 @@ This can be done using a configuration similar to the one below. A recycle-bin like module. When used any unlink call will be intercepted and files moved to the recycle - directory instead of being deleted. + directory instead of being deleted. This gives the same + effect as the "Recycle Bin" on Windows computers. Supported options: recycle:repository - FIXME + Relative path of the directory where deleted files should be moved to recycle:keeptree - FIXME + Specifies whether the directory structure should + be kept or if the files in the directory that is being + deleted should be kept seperately in the recycle bin. + recycle:versions - FIXME + If this option is set, two files + with the same name that are deleted will both + be kept in the recycle bin. Newer deleted versions + of a file will be called "Copy #x of filename". recycle:touch - FIXME + Specifies whether a file's access + date should be touched when the file is moved to + the recycle bin. recycle:maxsize - FIXME + Files that are larger than the number + of bytes specified by this parameter will + not be put into the recycle bin. recycle:exclude - FIXME + List of files that should not + be put into the recycle bin when deleted, but deleted + in the regular way. recycle:exclude_dir - FIXME + Contains a list of directories. When files from + these directories are deleted, they are not put into the + recycle bin, but deleted in the regular way. + recycle:noversions - FIXME + Opposite of recycle:versions. If both options are specified, this one takes precedence. @@ -202,10 +220,10 @@ This can be done using a configuration similar to the one below. Advantages compared to the old netatalk module: - - it doesn't care about creating of .AppleDouble forks, just keeps them in sync - if a share in &smb.conf; doesn't contain .AppleDouble item in hide or veto list, it will be added automatically - + + it doesn't care about creating of .AppleDouble forks, just keeps them in sync + if a share in &smb.conf; doesn't contain .AppleDouble item in hide or veto list, it will be added automatically + @@ -231,7 +249,7 @@ should be implied due to its presence here. DatabaseFS - URL: http://www.css.tayloru.edu/~elorimer/databasefs/index.php + URL: http://www.css.tayloru.edu/~elorimer/databasefs/index.php By Eric Lorimer. @@ -258,7 +276,7 @@ should be implied due to its presence here. vscan - URL: http://www.openantivirus.org/ + URL: http://www.openantivirus.org/ samba-vscan is a proof-of-concept module for Samba, which @@ -271,12 +289,4 @@ should be implied due to its presence here. - -Common Errors - - -There must be some gotchas we should record here! Jelmer??? - - - -- cgit