From 4f3f874a6dc168351adb266a7a9f636ad8c3c240 Mon Sep 17 00:00:00 2001 From: James Peach Date: Wed, 28 Feb 2007 23:14:41 +0000 Subject: Make sure all the modules are referred to as vfs_module_name to avoid collisions with existing man pages. (This used to be commit 2c7722ac9ed62bfb4670aa61e382a4cf1653a3ba) --- docs/manpages-3/vfs_audit.8.xml | 11 ++++++----- docs/manpages-3/vfs_cacheprime.8.xml | 13 +++++++------ docs/manpages-3/vfs_cap.8.xml | 11 ++++++----- docs/manpages-3/vfs_catia.8.xml | 11 ++++++----- docs/manpages-3/vfs_commit.8.xml | 13 +++++++------ docs/manpages-3/vfs_default_quota.8.xml | 15 ++++++++------- docs/manpages-3/vfs_extd_audit.8.xml | 3 ++- docs/manpages-3/vfs_fake_perms.8.xml | 11 ++++++----- docs/manpages-3/vfs_fam_notify.8.xml | 11 ++++++----- docs/manpages-3/vfs_netatalk.8.xml | 11 ++++++----- docs/manpages-3/vfs_prealloc.8.xml | 13 +++++++------ docs/manpages-3/vfs_readonly.8.xml | 11 ++++++----- docs/manpages-3/vfs_recycle.8.xml | 11 ++++++----- docs/manpages-3/vfs_shadow_copy.8.xml | 19 ++++++++++--------- 14 files changed, 89 insertions(+), 75 deletions(-) diff --git a/docs/manpages-3/vfs_audit.8.xml b/docs/manpages-3/vfs_audit.8.xml index bee1ad00e5..1a500da20c 100644 --- a/docs/manpages-3/vfs_audit.8.xml +++ b/docs/manpages-3/vfs_audit.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-audit + vfs_audit 8 - audit + vfs_audit record selected Samba VFS operations in the system log @@ -22,10 +22,11 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. - The audit VFS module records selected + The vfs_audit VFS module records selected client operations to the system log using syslog 3. diff --git a/docs/manpages-3/vfs_cacheprime.8.xml b/docs/manpages-3/vfs_cacheprime.8.xml index 1aafec0198..d08c67c957 100644 --- a/docs/manpages-3/vfs_cacheprime.8.xml +++ b/docs/manpages-3/vfs_cacheprime.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-cacheprime + vfs_cacheprime 8 - cacheprime + vfs_cacheprime prime the kernel file data cache @@ -22,16 +22,17 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. - The cacheprime VFS module reads chunks + The vfs_cacheprime VFS module reads chunks of file data near the range requested by clients in order to make sure the data is present in the kernel file data cache at the time when it is actually requested by clients. The size of the disk read operations performed - by cacheprime is determined by the + by vfs_cacheprime is determined by the cacheprime:rsize option. All disk read operations are aligned on boundaries that are a multiple of this size. Each range of the file data is primed at most once during the time the client diff --git a/docs/manpages-3/vfs_cap.8.xml b/docs/manpages-3/vfs_cap.8.xml index dc54978ad9..08e63a3468 100644 --- a/docs/manpages-3/vfs_cap.8.xml +++ b/docs/manpages-3/vfs_cap.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-cap + vfs_cap 8 - cap + vfs_cap CAP encode filenames @@ -22,12 +22,13 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. CAP (Columbia Appletalk Protocol) encoding is a technique for representing non-ASCII filenames in ASCII. The - cap VFS module translates filenames to and + vfs_cap VFS module translates filenames to and from CAP format, allowing users to name files in their native encoding. diff --git a/docs/manpages-3/vfs_catia.8.xml b/docs/manpages-3/vfs_catia.8.xml index e807c769d3..e2d135d9a1 100644 --- a/docs/manpages-3/vfs_catia.8.xml +++ b/docs/manpages-3/vfs_catia.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-catia + vfs_catia 8 - catia + vfs_catia translate illegal characters in Catia filenames @@ -22,12 +22,13 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. The Catia CAD package commonly creates filenames that use characters that are illegal in CIFS filenames. The - catia VFS module implements a fixed character + vfs_catia VFS module implements a fixed character mapping so that these files can be shared with CIFS clients. diff --git a/docs/manpages-3/vfs_commit.8.xml b/docs/manpages-3/vfs_commit.8.xml index 7650e75a97..2bac3b758d 100644 --- a/docs/manpages-3/vfs_commit.8.xml +++ b/docs/manpages-3/vfs_commit.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-commit + vfs_commit 8 - commit + vfs_commit flush dirty data at specified intervals @@ -22,15 +22,16 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. - The commit VFS module keeps track of + The vfs_commit VFS module keeps track of the amount of data written to a file and synchronizes it to disk when a specified amount accumulates. - commit is useful in two + vfs_commit is useful in two circumstances. First, if you have very precious data, the impact of unexpected power loss can be minimized by a small commit:dthresh value. Secondly, write performance can be diff --git a/docs/manpages-3/vfs_default_quota.8.xml b/docs/manpages-3/vfs_default_quota.8.xml index 7ea11f1177..03f11379f0 100644 --- a/docs/manpages-3/vfs_default_quota.8.xml +++ b/docs/manpages-3/vfs_default_quota.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-default_quota + vfs_default_quota 8 - default_quota + vfs_default_quota store default quota records for Windows clients @@ -22,19 +22,20 @@ DESCRIPTION - This module is part of the - samba7 + This VFS module is part of the + samba + 7 suite. Many common quota implementations only store quotas for users and groups, but do not store a default quota. The - default_quota module allows Samba to store + vfs_default_quota module allows Samba to store default quota values which can be examined using the Windows Explorer interface. By default, Samba returns NO_LIMIT the default quota and - refuses to update them. default_quota maps + refuses to update them. vfs_default_quota maps the default quota to the quota record of a user. By default the root user is taken because quota limits for root are typically not enforced. diff --git a/docs/manpages-3/vfs_extd_audit.8.xml b/docs/manpages-3/vfs_extd_audit.8.xml index 6681b49dad..475bf849ab 100644 --- a/docs/manpages-3/vfs_extd_audit.8.xml +++ b/docs/manpages-3/vfs_extd_audit.8.xml @@ -22,7 +22,8 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. The extd_audit VFS module records selected diff --git a/docs/manpages-3/vfs_fake_perms.8.xml b/docs/manpages-3/vfs_fake_perms.8.xml index 95b5b97d4f..81d11d0c84 100644 --- a/docs/manpages-3/vfs_fake_perms.8.xml +++ b/docs/manpages-3/vfs_fake_perms.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-fake_perms + vfs_fake_perms 8 - fake_perms + vfs_fake_perms enable read only Roaming Profiles @@ -22,10 +22,11 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. - The fake_perms VFS module was created + The vfs_fake_perms VFS module was created to allow Roaming Profile files and directories to be set (on the Samba server under UNIX) as read only. This module will, if installed on the Profiles share, report to the client that diff --git a/docs/manpages-3/vfs_fam_notify.8.xml b/docs/manpages-3/vfs_fam_notify.8.xml index 703002904b..6c3bb6858e 100644 --- a/docs/manpages-3/vfs_fam_notify.8.xml +++ b/docs/manpages-3/vfs_fam_notify.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-fam_notify + vfs_fam_notify 8 - fam_notify + vfs_fam_notify FAM support for file change notifications @@ -22,10 +22,11 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. - The fam_notify module makes use of + The vfs_fam_notify module makes use of the system FAM (File Alteration Monitor) daemon to implement file change notifications for Windows clients. FAM is generally present only on IRIX and some BSD systems. diff --git a/docs/manpages-3/vfs_netatalk.8.xml b/docs/manpages-3/vfs_netatalk.8.xml index ffae4681b5..a3339a86de 100644 --- a/docs/manpages-3/vfs_netatalk.8.xml +++ b/docs/manpages-3/vfs_netatalk.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-netatalk + vfs_netatalk 8 - netatalk + vfs_netatalk hide .AppleDouble files from CIFS clients @@ -22,10 +22,11 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. - The netatalk VFS module dynamically + The vfs_netatalk VFS module dynamically hides .AppleDouble files, preventing spurious errors on some CIFS clients. .AppleDouble files may be created by historic implementations of AFP (Apple Filing Protocol) on servers. diff --git a/docs/manpages-3/vfs_prealloc.8.xml b/docs/manpages-3/vfs_prealloc.8.xml index 1d8f6db75c..a05f8d1ee1 100644 --- a/docs/manpages-3/vfs_prealloc.8.xml +++ b/docs/manpages-3/vfs_prealloc.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-prealloc + vfs_prealloc 8 - prealloc + vfs_prealloc preallocate matching files to a predetermined size @@ -22,10 +22,11 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. - The prealloc VFS module preallocates + The vfs_prealloc VFS module preallocates files to a specified size each time a new file is created. This is useful in environments where files are of a predetermined size will be written to a disk subsystem where extending file @@ -78,7 +79,7 @@ CAVEATS - preallocate is not supported on all + vfs_prealloc is not supported on all platforms and filesystems. Currently only XFS filesystems on Linux and IRIX are supported. diff --git a/docs/manpages-3/vfs_readonly.8.xml b/docs/manpages-3/vfs_readonly.8.xml index b1886bdf90..73ac1c3c8c 100644 --- a/docs/manpages-3/vfs_readonly.8.xml +++ b/docs/manpages-3/vfs_readonly.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-readonly + vfs_readonly 8 - readonly + vfs_readonly make a Samba share read only for a specified time period @@ -22,10 +22,11 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. - The readonly VFS module marks a share + The vfs_readonly VFS module marks a share as read only for all clients connecting within the configured time period. Clients connecting during this time will be denied write access to all files in the share, irrespective of ther diff --git a/docs/manpages-3/vfs_recycle.8.xml b/docs/manpages-3/vfs_recycle.8.xml index 923550de75..106813e127 100644 --- a/docs/manpages-3/vfs_recycle.8.xml +++ b/docs/manpages-3/vfs_recycle.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-recycle + vfs_recycle 8 - recycle + vfs_recycle Samba VFS recycle bin @@ -22,10 +22,11 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. - The recycle intercepts file deletion + The vfs_recycle intercepts file deletion requests and moves the affected files to a temporary repository rather than deleting them immediately. This gives the same effect as the Recycle Bin on Windows computers. diff --git a/docs/manpages-3/vfs_shadow_copy.8.xml b/docs/manpages-3/vfs_shadow_copy.8.xml index e735b881ce..ac569e8500 100644 --- a/docs/manpages-3/vfs_shadow_copy.8.xml +++ b/docs/manpages-3/vfs_shadow_copy.8.xml @@ -1,15 +1,15 @@ - + - smb-vfs-shadow_copy + vfs_shadow_copy 8 - shadow_copy + vfs_shadow_copy Make a Samba share read only for a specified time period @@ -22,10 +22,11 @@ DESCRIPTION - This module is part of the samba + This VFS module is part of the + samba 7 suite. - The shadow_copy VFS module functionality + The vfs_shadow_copy VFS module functionality that is similar to Microsoft Shadow Copy services. When setup properly, this module allows Microsoft Shadow Copy clients to browse "shadow copies" on Samba shares. @@ -38,14 +39,14 @@ CONFIGURATION - shadow_copy relies on a filesystem + vfs_shadow_copy relies on a filesystem snapshot implementation. Many common filesystems have native support for this. Filesystem snapshots must be mounted on specially named directories in order to be recognized by - shadow_copy. The snapshot mount points must + vfs_shadow_copy. The snapshot mount points must be immediate children of a the directory being shared. The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss, @@ -60,7 +61,7 @@ - The shadow_copy snapshot naming convention can be produced with the following + The vfs_shadow_copy snapshot naming convention can be produced with the following date 1 command: @@ -87,7 +88,7 @@ With Samba or Windows servers, - shadow_copy is designed to be an end-user + vfs_shadow_copy is designed to be an end-user tool only. It does not replace or enhance your backup and archival solutions and should in no way be considered as such. Additionally, if you need version control, implement a -- cgit