From ea8725b305f796b4343d5a3e3c2b77d73c9333c9 Mon Sep 17 00:00:00 2001 From: James Peach Date: Wed, 28 Feb 2007 22:51:22 +0000 Subject: Rename module manpages for consistency. (This used to be commit e2e8104462cf32a1ef29778f7d10bee8aa6dcb3e) --- docs/manpages-3/smb-vfs-audit.8.xml | 118 ------------- docs/manpages-3/smb-vfs-cacheprime.8.xml | 106 ----------- docs/manpages-3/smb-vfs-cap.8.xml | 74 -------- docs/manpages-3/smb-vfs-catia.8.xml | 69 -------- docs/manpages-3/smb-vfs-commit.8.xml | 106 ----------- docs/manpages-3/smb-vfs-default_quota.8.xml | 132 -------------- docs/manpages-3/smb-vfs-extd_audit.8.xml | 64 ------- docs/manpages-3/smb-vfs-fake_perms.8.xml | 69 -------- docs/manpages-3/smb-vfs-fam_notify.8.xml | 66 ------- docs/manpages-3/smb-vfs-full_audit.8.xml | 262 ---------------------------- docs/manpages-3/smb-vfs-netatalk.8.xml | 73 -------- docs/manpages-3/smb-vfs-prealloc.8.xml | 103 ----------- docs/manpages-3/smb-vfs-readonly.8.xml | 97 ---------- docs/manpages-3/smb-vfs-recycle.8.xml | 202 --------------------- docs/manpages-3/smb-vfs-shadow_copy.8.xml | 117 ------------- docs/manpages-3/vfs_audit.8.xml | 118 +++++++++++++ docs/manpages-3/vfs_cacheprime.8.xml | 106 +++++++++++ docs/manpages-3/vfs_cap.8.xml | 74 ++++++++ docs/manpages-3/vfs_catia.8.xml | 69 ++++++++ docs/manpages-3/vfs_commit.8.xml | 106 +++++++++++ docs/manpages-3/vfs_default_quota.8.xml | 132 ++++++++++++++ docs/manpages-3/vfs_extd_audit.8.xml | 64 +++++++ docs/manpages-3/vfs_fake_perms.8.xml | 69 ++++++++ docs/manpages-3/vfs_fam_notify.8.xml | 66 +++++++ docs/manpages-3/vfs_full_audit.8.xml | 262 ++++++++++++++++++++++++++++ docs/manpages-3/vfs_netatalk.8.xml | 73 ++++++++ docs/manpages-3/vfs_prealloc.8.xml | 103 +++++++++++ docs/manpages-3/vfs_readonly.8.xml | 97 ++++++++++ docs/manpages-3/vfs_recycle.8.xml | 202 +++++++++++++++++++++ docs/manpages-3/vfs_shadow_copy.8.xml | 117 +++++++++++++ 30 files changed, 1658 insertions(+), 1658 deletions(-) delete mode 100644 docs/manpages-3/smb-vfs-audit.8.xml delete mode 100644 docs/manpages-3/smb-vfs-cacheprime.8.xml delete mode 100644 docs/manpages-3/smb-vfs-cap.8.xml delete mode 100644 docs/manpages-3/smb-vfs-catia.8.xml delete mode 100644 docs/manpages-3/smb-vfs-commit.8.xml delete mode 100644 docs/manpages-3/smb-vfs-default_quota.8.xml delete mode 100644 docs/manpages-3/smb-vfs-extd_audit.8.xml delete mode 100644 docs/manpages-3/smb-vfs-fake_perms.8.xml delete mode 100644 docs/manpages-3/smb-vfs-fam_notify.8.xml delete mode 100644 docs/manpages-3/smb-vfs-full_audit.8.xml delete mode 100644 docs/manpages-3/smb-vfs-netatalk.8.xml delete mode 100644 docs/manpages-3/smb-vfs-prealloc.8.xml delete mode 100644 docs/manpages-3/smb-vfs-readonly.8.xml delete mode 100644 docs/manpages-3/smb-vfs-recycle.8.xml delete mode 100644 docs/manpages-3/smb-vfs-shadow_copy.8.xml create mode 100644 docs/manpages-3/vfs_audit.8.xml create mode 100644 docs/manpages-3/vfs_cacheprime.8.xml create mode 100644 docs/manpages-3/vfs_cap.8.xml create mode 100644 docs/manpages-3/vfs_catia.8.xml create mode 100644 docs/manpages-3/vfs_commit.8.xml create mode 100644 docs/manpages-3/vfs_default_quota.8.xml create mode 100644 docs/manpages-3/vfs_extd_audit.8.xml create mode 100644 docs/manpages-3/vfs_fake_perms.8.xml create mode 100644 docs/manpages-3/vfs_fam_notify.8.xml create mode 100644 docs/manpages-3/vfs_full_audit.8.xml create mode 100644 docs/manpages-3/vfs_netatalk.8.xml create mode 100644 docs/manpages-3/vfs_prealloc.8.xml create mode 100644 docs/manpages-3/vfs_readonly.8.xml create mode 100644 docs/manpages-3/vfs_recycle.8.xml create mode 100644 docs/manpages-3/vfs_shadow_copy.8.xml diff --git a/docs/manpages-3/smb-vfs-audit.8.xml b/docs/manpages-3/smb-vfs-audit.8.xml deleted file mode 100644 index bee1ad00e5..0000000000 --- a/docs/manpages-3/smb-vfs-audit.8.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - smb-vfs-audit - 8 - - - - - audit - record selected Samba VFS operations in the system log - - - - - vfs objects = audit - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The audit VFS module records selected - client operations to the system log using - syslog - 3. - - The following Samba VFS operations are recorded: - - connect - disconnect - opendir - mkdir - rmdir - open - close - rename - unlink - chmod - fchmod - chmod_acl - fchmod_acl - - - This module is stackable. - - - - - - OPTIONS - - - - - audit:facility = FACILITY - - Log messages to the named - syslog - 3 facility. - - - - - - - - audit:priority = PRIORITY - - Log messages with the named - syslog - 3 priority. - - - - - - - - - - EXAMPLES - - Log operations on all shares using the LOCAL1 facility - and NOTICE priority: - - - - audit - LOCAL1 - NOTICE - - - - - - VERSION - - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-cacheprime.8.xml b/docs/manpages-3/smb-vfs-cacheprime.8.xml deleted file mode 100644 index 1aafec0198..0000000000 --- a/docs/manpages-3/smb-vfs-cacheprime.8.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - smb-vfs-cacheprime - 8 - - - - - cacheprime - prime the kernel file data cache - - - - - vfs objects = cacheprime - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The 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 - 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 - has the file open. - - This module is stackable. - - - - OPTIONS - - - - - cacheprime:rsize = BYTES - - The number of bytes with which to prime - the kernel data cache. - The following suffixes may be applied to BYTES: - - K - BYTES is a number of kilobytes - M - BYTES is a number of megabytes - G - BYTES is a number of gigabytes - - - - - - - - - - EXAMPLES - - For a hypothetical disk array, it is necessary to ensure - that all read operations are of size 1 megabyte (1048576 bytes), - and aligned on 1 megabyte boundaries: - - - - cacheprime - 1M - - - - - - CAVEATS - cacheprime is not a a substitute for - a general-purpose readahead mechanism. It is intended for use - only in very specific environments where disk operations must - be aligned and sized to known values (as much as that is possible). - - - - - VERSION - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-cap.8.xml b/docs/manpages-3/smb-vfs-cap.8.xml deleted file mode 100644 index dc54978ad9..0000000000 --- a/docs/manpages-3/smb-vfs-cap.8.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - smb-vfs-cap - 8 - - - - - cap - CAP encode filenames - - - - - vfs objects = cap - - - - - DESCRIPTION - - This 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 - from CAP format, allowing users to name files in their native - encoding. - - CAP encoding is most commonly - used in Japanese language environments. - - This module is stackable. - - - - - - EXAMPLES - - On a system using GNU libiconv, use CAP encoding to support - users in the Shift_JIS locale: - - - - CP932 - CP932 - cap - - - - - - VERSION - - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-catia.8.xml b/docs/manpages-3/smb-vfs-catia.8.xml deleted file mode 100644 index e807c769d3..0000000000 --- a/docs/manpages-3/smb-vfs-catia.8.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - smb-vfs-catia - 8 - - - - - catia - translate illegal characters in Catia filenames - - - - - vfs objects = catia - - - - - DESCRIPTION - - This 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 - mapping so that these files can be shared with CIFS clients. - - - This module is stackable. - - - - - - EXAMPLES - - Map Catia filenames on the [CAD] share: - - - - /data/cad - catia - - - - - - VERSION - - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-commit.8.xml b/docs/manpages-3/smb-vfs-commit.8.xml deleted file mode 100644 index 7650e75a97..0000000000 --- a/docs/manpages-3/smb-vfs-commit.8.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - smb-vfs-commit - 8 - - - - - commit - flush dirty data at specified intervals - - - - - vfs objects = commit - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The 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 - 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 - improved on some systems by flushing file data early and at - regular intervals. - - This module is stackable. - - - - - - OPTIONS - - - - - commit:dthresh = BYTES - - Synchronize file data each time the specified - number of bytes has been written. - - - The following suffixes may be applied to BYTES: - - K - BYTES is a number of kilobytes - M - BYTES is a number of megabytes - G - BYTES is a number of gigabytes - - - - - - - - - - EXAMPLES - - Synchronize the file data on the [precious] share after - every 512 kilobytes (524288 bytes) of data is written: - - - /data/precious - commit - 512K - - - - - CAVEATS - On some systems, the data synchronization performed by - commit may reduce performance. - - - - - VERSION - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-default_quota.8.xml b/docs/manpages-3/smb-vfs-default_quota.8.xml deleted file mode 100644 index 7ea11f1177..0000000000 --- a/docs/manpages-3/smb-vfs-default_quota.8.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - smb-vfs-default_quota - 8 - - - - - default_quota - store default quota records for Windows clients - - - - - vfs objects = default_quota - - - - - DESCRIPTION - - This module is part of the - samba7 - 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 - 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 - 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. - - This module is stackable. - - - - - - OPTIONS - - - - - default_quota:uid = UID - - UID specifies the user ID of the quota record where the - default user quota values are stored. - - - - - - - default_quota:gid = GID - - GID specifies the group ID of the quota record where the - default group quota values are stored. - - - - - - - default_quota:uid nolimit = BOOL - - If this parameter is True, then the user whose - quota record is storing the default user quota will - be reported as having a quota of NO_LIMIT. Otherwise, - the stored values will be reported. - - - - - - - default_quota:gid nolimit = BOOL - - If this parameter is True, then the group whose - quota record is storing the default group quota will - be reported as having a quota of NO_LIMIT. Otherwise, - the stored values will be reported. - - - - - - - - - - EXAMPLES - - Store the default quota record in the quota record for - the user with ID 65535 and report that user as having no quota - limits: - - - - default_quota - 65535 - yes - - - - - - VERSION - - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-extd_audit.8.xml b/docs/manpages-3/smb-vfs-extd_audit.8.xml deleted file mode 100644 index 6681b49dad..0000000000 --- a/docs/manpages-3/smb-vfs-extd_audit.8.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - vfs_extd_audit - 8 - - - - - vfs_extd_audit - record selected Samba VFS operations - - - - - vfs objects = extd_audit - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The extd_audit VFS module records selected - client operations to both the - smbd - 8 log and - system log (using - syslog - 3). - - Other than logging to the - smbd - 8 log, - vfs_ext_audit is identical to - vfs_ext_audit - 8. - - - This module is stackable. - - - - - VERSION - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-fake_perms.8.xml b/docs/manpages-3/smb-vfs-fake_perms.8.xml deleted file mode 100644 index 95b5b97d4f..0000000000 --- a/docs/manpages-3/smb-vfs-fake_perms.8.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - smb-vfs-fake_perms - 8 - - - - - fake_perms - enable read only Roaming Profiles - - - - - vfs objects = fake_perms - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The 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 - the Profile files and directories are writeable. This satisfies - the client even though the files will never be overwritten as - the client logs out or shuts down. - - - This module is stackable. - - - - - EXAMPLES - - - - /profiles - fake_perms - - - - - - VERSION - - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-fam_notify.8.xml b/docs/manpages-3/smb-vfs-fam_notify.8.xml deleted file mode 100644 index 703002904b..0000000000 --- a/docs/manpages-3/smb-vfs-fam_notify.8.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - smb-vfs-fam_notify - 8 - - - - - fam_notify - FAM support for file change notifications - - - - - vfs objects = fam_notify - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The 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. - - This module is not stackable. - - - - - EXAMPLES - - Support FAM notifications globally: - - - - fam_notify - - - - - - VERSION - - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-full_audit.8.xml b/docs/manpages-3/smb-vfs-full_audit.8.xml deleted file mode 100644 index 656f36e9cb..0000000000 --- a/docs/manpages-3/smb-vfs-full_audit.8.xml +++ /dev/null @@ -1,262 +0,0 @@ - - - - - - vfs_full_audit - 8 - - - - - vfs_full_audit - record Samba VFS operations in the system log - - - - - vfs objects = full_audit - - - - - DESCRIPTION - - This VFS module is part of the - samba - 7 suite. - - The vfs_full_audit VFS module records selected - client operations to the system log using - syslog - 3. - - vfs_full_audit is able to record the - complete set of Samba VFS operations: - - - connect - disconnect - disk_free - get_quota - set_quota - get_shadow_copy_data - statvfs - opendir - readdir - seekdir - telldir - rewinddir - mkdir - rmdir - closedir - open - close - read - pread - write - pwrite - lseek - sendfile - rename - fsync - stat - fstat - lstat - unlink - chmod - fchmod - chown - fchown - chdir - getwd - utime - ftruncate - lock - kernel_flock - linux_setlease - getlock - symlink - readlink - link - mknod - realpath - fget_nt_acl - get_nt_acl - fset_nt_acl - set_nt_acl - chmod_acl - fchmod_acl - sys_acl_get_entry - sys_acl_get_tag_type - sys_acl_get_permset - sys_acl_get_qualifier - sys_acl_get_file - sys_acl_get_fd - sys_acl_clear_perms - sys_acl_add_perm - sys_acl_to_text - sys_acl_init - sys_acl_create_entry - sys_acl_set_tag_type - sys_acl_set_qualifier - sys_acl_set_permset - sys_acl_valid - sys_acl_set_file - sys_acl_set_fd - sys_acl_delete_def_file - sys_acl_get_perm - sys_acl_free_text - sys_acl_free_acl - sys_acl_free_qualifier - getxattr - lgetxattr - fgetxattr - listxattr - llistxattr - flistxattr - removexattr - lremovexattr - fremovexattr - setxattr - lsetxattr - fsetxattr - aio_read - aio_write - aio_return - aio_cancel - aio_error - aio_fsync - aio_suspend - - - In addition to these operations, - vfs_full_audit recognizes the special operation - names "all" and "none ", which refer to all - the VFS operations and none of the VFS operations respectively. - - - vfs_full_audit records operations in fixed - format consisting of fields separated by '|' characters. The - format is: - - smbd_audit: PREFIX|OPERATION|RESULT|FILE - - - The record fields are: - - - PREFIX - the result of the full_audit:prefix string after variable substitutions - OPERATION - the name of the VFS operation - RESULT - whether the operation succeeded or failed - FILE - the name of the file or directory the operation was performed on - - - - This module is stackable. - - - - - - OPTIONS - - - - - vfs_full_audit:prefix = STRING - - Prepend audit messages with STRING. STRING is - processed for standard substitution variables listed in - smb.conf - 5. The default - prefix is "%u|%I". - - - - - - vfs_full_audit:success = LIST - - LIST is a list of VFS operations that should be - recorded if they succeed. Operations are specified using - the names listed above. - - - - - - - vfs_full_audit:failure = LIST - - LIST is a list of VFS operations that should be - recorded if they failed. Operations are specified using - the names listed above. - - - - - - - full_audit:facility = FACILITY - - Log messages to the named - syslog - 3 facility. - - - - - - - - full_audit:priority = PRIORITY - - Log messages with the named - syslog - 3 priority. - - - - - - - - - - EXAMPLES - - Log file and directory open operations on the [records] - share using the LOCAL7 facility and ALERT priority, including - the username and IP address: - - - - /data/records - full_audit - %u|%I - open opendir - all - LOCAL7 - ALERT - - - - - - VERSION - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-netatalk.8.xml b/docs/manpages-3/smb-vfs-netatalk.8.xml deleted file mode 100644 index ffae4681b5..0000000000 --- a/docs/manpages-3/smb-vfs-netatalk.8.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - smb-vfs-netatalk - 8 - - - - - netatalk - hide .AppleDouble files from CIFS clients - - - - - vfs objects = netatalk - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The 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. - - This module is stackable. - - - - - EXAMPLES - - Hide .AppleDouble files on the [data] share: - - - netatalk - - - - - - CAVEATS - This module is largely historic and unlikely to be of use - in modern networks since current Apple systems are able to mount CIFS - shares natively. - - - - - - VERSION - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-prealloc.8.xml b/docs/manpages-3/smb-vfs-prealloc.8.xml deleted file mode 100644 index 1d8f6db75c..0000000000 --- a/docs/manpages-3/smb-vfs-prealloc.8.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - smb-vfs-prealloc - 8 - - - - - prealloc - preallocate matching files to a predetermined size - - - - - vfs objects = prealloc - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The 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 - allocations is expensive. - - This module is stackable. - - - - - - OPTIONS - - - - - prealloc:EXT = BYTES - - Preallocate all files with the extension EXT to - the size specified by BYTES. - - - The following suffixes may be applied to BYTES: - - K - BYTES is a number of kilobytes - M - BYTES is a number of megabytes - G - BYTES is a number of gigabytes - - - - - - - - - - EXAMPLES - - A process writes TIFF files to a Samba share, and the - is known these files will almost always be around 4 megabytes - (4194304 bytes): - - - - /data/frames - prealloc - 4M - - - - - CAVEATS - preallocate is not supported on all - platforms and filesystems. Currently only XFS filesystems on - Linux and IRIX are supported. - - - - - VERSION - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-readonly.8.xml b/docs/manpages-3/smb-vfs-readonly.8.xml deleted file mode 100644 index b1886bdf90..0000000000 --- a/docs/manpages-3/smb-vfs-readonly.8.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - smb-vfs-readonly - 8 - - - - - readonly - make a Samba share read only for a specified time period - - - - - vfs objects = readonly - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The 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 - actual access privileges. - - This module is stackable. - - - - - - OPTIONS - - - - - readonly:period = BEGIN, END - - Only mark the share as read only if the client - connection was made between the times marked by the - BEGIN and END date specifiers. - The syntax of these date specifiers is the - same as that accepted by the -d option of GNU - date - 1. - - - - - - - - - - EXAMPLES - - Mark all shares read only: - - - readonly - - - Mark the [backup] share as read only during business hours: - - - /readonly - readonly - readonly:period = "today 9:00","today 17:00" - - - - - VERSION - - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-recycle.8.xml b/docs/manpages-3/smb-vfs-recycle.8.xml deleted file mode 100644 index 923550de75..0000000000 --- a/docs/manpages-3/smb-vfs-recycle.8.xml +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - smb-vfs-recycle - 8 - - - - - recycle - Samba VFS recycle bin - - - - - vfs objects = recycle - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The 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. - - The Recycle Bin will not appear in Windows Explorer - views of the network file system (share) nor on any mapped - drive. Instead, a directory called .recycle will be automatically - created when the first file is deleted and recycle:repository is - not configured. If recycle:repository is configured, the name - of the created directory depends on recycle:repository. Users - can recover files from the recycle bin. If the recycle:keeptree - option has been specified, deleted files will be found in a path - identical with that from which the file was deleted. - - - This module is stackable. - - - - - - OPTIONS - - - - - recycle:repository = PATH - - Path of the directory where deleted files should be moved. - - If this option is not set, the default path .recycle - is used. - - - - - recycle:directory_mode = MODE - - Set MODE to the octal mode the recycle repository - should be created with. The recycle repository will be - created when first file is deleted. If recycle:subdir_mode - is not set, MODE also applies to subdirectories. - - If this option is not set, the default mode - 0700 is used. - - - - - recycle:subdir_mode = MODE - - Set MODE to the octal mode with which - sub directories of the recycle repository should be created. - - If this option is not set, subdirectories - will be created with the mode from recycle:directory_mode. - - - - - - recycle:keeptree = BOOL - - Specifies whether the directory structure should - be preserved or whether the files in a directory that is being - deleted should be kept separately in the repository. - - - - - - recycle:versions = BOOL - - If this option is True, two files with the same - name that are deleted will both be kept in the repository. - Newer deleted versions of a file will be called - "Copy #x of filename". - - - - - - recycle:touch = BOOL - - Specifies whether a file's access date should be - updated when the file is moved to the repository. - - - - - - recycle:touch_mtime = BOOL - - Specifies whether a file's last modified date should be - updated when the file is moved to the repository. - - - - - - recycle:maxsize = BYTES - - Files that are larger than the number of bytes - specified by this parameter will not be put into the - repository. - - - - - - recycle:exclude = LIST - - List of files that should not be put into the - repository when deleted, but deleted in the normal way. - - - - - - recycle:exclude_dir = LIST - - List of directories whose files should not be put - into the repository when deleted, but deleted in the - normal way. - - - - - - recycle:noversions = LIST - - Specifies a list of paths (wildcards such as * - and ? are supported) for which no versioning should - be used. Only useful when recycle:versions is enabled. - - - - - - - - - EXAMPLES - - Log operations on all shares using the LOCAL1 facility - and NOTICE priority: - - - - recycle - LOCAL1 - NOTICE - - - - - - VERSION - - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/smb-vfs-shadow_copy.8.xml b/docs/manpages-3/smb-vfs-shadow_copy.8.xml deleted file mode 100644 index e735b881ce..0000000000 --- a/docs/manpages-3/smb-vfs-shadow_copy.8.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - smb-vfs-shadow_copy - 8 - - - - - shadow_copy - Make a Samba share read only for a specified time period - - - - - vfs objects = shadow_copy - - - - - DESCRIPTION - - This module is part of the samba - 7 suite. - - The 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. - - - This module is stackable. - - - - - CONFIGURATION - - 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 - be immediate children of a the directory being shared. - - The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss, - where: - - YYYY is the 4 digit year - MM is the 2 digit month - DD is the 2 digit day - hh is the 2 digit hour - mm is the 2 digit minute - ss is the 2 digit second. - - - - The shadow_copy snapshot naming convention can be produced with the following - date - 1 command: - - TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S - - - - - - EXAMPLES - - Add shadow copy support to user home directories: - - - shadow_copy - - - - - - CAVEATS - - This is not a backup, archival, or version control solution. - - - With Samba or Windows servers, - 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 - version control system. - - - - - - - VERSION - - This man page is correct for version 3.0.25 of the Samba suite. - - - - - AUTHOR - - The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. - - - - diff --git a/docs/manpages-3/vfs_audit.8.xml b/docs/manpages-3/vfs_audit.8.xml new file mode 100644 index 0000000000..bee1ad00e5 --- /dev/null +++ b/docs/manpages-3/vfs_audit.8.xml @@ -0,0 +1,118 @@ + + + + + + smb-vfs-audit + 8 + + + + + audit + record selected Samba VFS operations in the system log + + + + + vfs objects = audit + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The audit VFS module records selected + client operations to the system log using + syslog + 3. + + The following Samba VFS operations are recorded: + + connect + disconnect + opendir + mkdir + rmdir + open + close + rename + unlink + chmod + fchmod + chmod_acl + fchmod_acl + + + This module is stackable. + + + + + + OPTIONS + + + + + audit:facility = FACILITY + + Log messages to the named + syslog + 3 facility. + + + + + + + + audit:priority = PRIORITY + + Log messages with the named + syslog + 3 priority. + + + + + + + + + + EXAMPLES + + Log operations on all shares using the LOCAL1 facility + and NOTICE priority: + + + + audit + LOCAL1 + NOTICE + + + + + + VERSION + + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_cacheprime.8.xml b/docs/manpages-3/vfs_cacheprime.8.xml new file mode 100644 index 0000000000..1aafec0198 --- /dev/null +++ b/docs/manpages-3/vfs_cacheprime.8.xml @@ -0,0 +1,106 @@ + + + + + + smb-vfs-cacheprime + 8 + + + + + cacheprime + prime the kernel file data cache + + + + + vfs objects = cacheprime + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The 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 + 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 + has the file open. + + This module is stackable. + + + + OPTIONS + + + + + cacheprime:rsize = BYTES + + The number of bytes with which to prime + the kernel data cache. + The following suffixes may be applied to BYTES: + + K - BYTES is a number of kilobytes + M - BYTES is a number of megabytes + G - BYTES is a number of gigabytes + + + + + + + + + + EXAMPLES + + For a hypothetical disk array, it is necessary to ensure + that all read operations are of size 1 megabyte (1048576 bytes), + and aligned on 1 megabyte boundaries: + + + + cacheprime + 1M + + + + + + CAVEATS + cacheprime is not a a substitute for + a general-purpose readahead mechanism. It is intended for use + only in very specific environments where disk operations must + be aligned and sized to known values (as much as that is possible). + + + + + VERSION + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_cap.8.xml b/docs/manpages-3/vfs_cap.8.xml new file mode 100644 index 0000000000..dc54978ad9 --- /dev/null +++ b/docs/manpages-3/vfs_cap.8.xml @@ -0,0 +1,74 @@ + + + + + + smb-vfs-cap + 8 + + + + + cap + CAP encode filenames + + + + + vfs objects = cap + + + + + DESCRIPTION + + This 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 + from CAP format, allowing users to name files in their native + encoding. + + CAP encoding is most commonly + used in Japanese language environments. + + This module is stackable. + + + + + + EXAMPLES + + On a system using GNU libiconv, use CAP encoding to support + users in the Shift_JIS locale: + + + + CP932 + CP932 + cap + + + + + + VERSION + + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_catia.8.xml b/docs/manpages-3/vfs_catia.8.xml new file mode 100644 index 0000000000..e807c769d3 --- /dev/null +++ b/docs/manpages-3/vfs_catia.8.xml @@ -0,0 +1,69 @@ + + + + + + smb-vfs-catia + 8 + + + + + catia + translate illegal characters in Catia filenames + + + + + vfs objects = catia + + + + + DESCRIPTION + + This 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 + mapping so that these files can be shared with CIFS clients. + + + This module is stackable. + + + + + + EXAMPLES + + Map Catia filenames on the [CAD] share: + + + + /data/cad + catia + + + + + + VERSION + + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_commit.8.xml b/docs/manpages-3/vfs_commit.8.xml new file mode 100644 index 0000000000..7650e75a97 --- /dev/null +++ b/docs/manpages-3/vfs_commit.8.xml @@ -0,0 +1,106 @@ + + + + + + smb-vfs-commit + 8 + + + + + commit + flush dirty data at specified intervals + + + + + vfs objects = commit + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The 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 + 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 + improved on some systems by flushing file data early and at + regular intervals. + + This module is stackable. + + + + + + OPTIONS + + + + + commit:dthresh = BYTES + + Synchronize file data each time the specified + number of bytes has been written. + + + The following suffixes may be applied to BYTES: + + K - BYTES is a number of kilobytes + M - BYTES is a number of megabytes + G - BYTES is a number of gigabytes + + + + + + + + + + EXAMPLES + + Synchronize the file data on the [precious] share after + every 512 kilobytes (524288 bytes) of data is written: + + + /data/precious + commit + 512K + + + + + CAVEATS + On some systems, the data synchronization performed by + commit may reduce performance. + + + + + VERSION + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_default_quota.8.xml b/docs/manpages-3/vfs_default_quota.8.xml new file mode 100644 index 0000000000..7ea11f1177 --- /dev/null +++ b/docs/manpages-3/vfs_default_quota.8.xml @@ -0,0 +1,132 @@ + + + + + + smb-vfs-default_quota + 8 + + + + + default_quota + store default quota records for Windows clients + + + + + vfs objects = default_quota + + + + + DESCRIPTION + + This module is part of the + samba7 + 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 + 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 + 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. + + This module is stackable. + + + + + + OPTIONS + + + + + default_quota:uid = UID + + UID specifies the user ID of the quota record where the + default user quota values are stored. + + + + + + + default_quota:gid = GID + + GID specifies the group ID of the quota record where the + default group quota values are stored. + + + + + + + default_quota:uid nolimit = BOOL + + If this parameter is True, then the user whose + quota record is storing the default user quota will + be reported as having a quota of NO_LIMIT. Otherwise, + the stored values will be reported. + + + + + + + default_quota:gid nolimit = BOOL + + If this parameter is True, then the group whose + quota record is storing the default group quota will + be reported as having a quota of NO_LIMIT. Otherwise, + the stored values will be reported. + + + + + + + + + + EXAMPLES + + Store the default quota record in the quota record for + the user with ID 65535 and report that user as having no quota + limits: + + + + default_quota + 65535 + yes + + + + + + VERSION + + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_extd_audit.8.xml b/docs/manpages-3/vfs_extd_audit.8.xml new file mode 100644 index 0000000000..6681b49dad --- /dev/null +++ b/docs/manpages-3/vfs_extd_audit.8.xml @@ -0,0 +1,64 @@ + + + + + + vfs_extd_audit + 8 + + + + + vfs_extd_audit + record selected Samba VFS operations + + + + + vfs objects = extd_audit + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The extd_audit VFS module records selected + client operations to both the + smbd + 8 log and + system log (using + syslog + 3). + + Other than logging to the + smbd + 8 log, + vfs_ext_audit is identical to + vfs_ext_audit + 8. + + + This module is stackable. + + + + + VERSION + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_fake_perms.8.xml b/docs/manpages-3/vfs_fake_perms.8.xml new file mode 100644 index 0000000000..95b5b97d4f --- /dev/null +++ b/docs/manpages-3/vfs_fake_perms.8.xml @@ -0,0 +1,69 @@ + + + + + + smb-vfs-fake_perms + 8 + + + + + fake_perms + enable read only Roaming Profiles + + + + + vfs objects = fake_perms + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The 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 + the Profile files and directories are writeable. This satisfies + the client even though the files will never be overwritten as + the client logs out or shuts down. + + + This module is stackable. + + + + + EXAMPLES + + + + /profiles + fake_perms + + + + + + VERSION + + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_fam_notify.8.xml b/docs/manpages-3/vfs_fam_notify.8.xml new file mode 100644 index 0000000000..703002904b --- /dev/null +++ b/docs/manpages-3/vfs_fam_notify.8.xml @@ -0,0 +1,66 @@ + + + + + + smb-vfs-fam_notify + 8 + + + + + fam_notify + FAM support for file change notifications + + + + + vfs objects = fam_notify + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The 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. + + This module is not stackable. + + + + + EXAMPLES + + Support FAM notifications globally: + + + + fam_notify + + + + + + VERSION + + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_full_audit.8.xml b/docs/manpages-3/vfs_full_audit.8.xml new file mode 100644 index 0000000000..656f36e9cb --- /dev/null +++ b/docs/manpages-3/vfs_full_audit.8.xml @@ -0,0 +1,262 @@ + + + + + + vfs_full_audit + 8 + + + + + vfs_full_audit + record Samba VFS operations in the system log + + + + + vfs objects = full_audit + + + + + DESCRIPTION + + This VFS module is part of the + samba + 7 suite. + + The vfs_full_audit VFS module records selected + client operations to the system log using + syslog + 3. + + vfs_full_audit is able to record the + complete set of Samba VFS operations: + + + connect + disconnect + disk_free + get_quota + set_quota + get_shadow_copy_data + statvfs + opendir + readdir + seekdir + telldir + rewinddir + mkdir + rmdir + closedir + open + close + read + pread + write + pwrite + lseek + sendfile + rename + fsync + stat + fstat + lstat + unlink + chmod + fchmod + chown + fchown + chdir + getwd + utime + ftruncate + lock + kernel_flock + linux_setlease + getlock + symlink + readlink + link + mknod + realpath + fget_nt_acl + get_nt_acl + fset_nt_acl + set_nt_acl + chmod_acl + fchmod_acl + sys_acl_get_entry + sys_acl_get_tag_type + sys_acl_get_permset + sys_acl_get_qualifier + sys_acl_get_file + sys_acl_get_fd + sys_acl_clear_perms + sys_acl_add_perm + sys_acl_to_text + sys_acl_init + sys_acl_create_entry + sys_acl_set_tag_type + sys_acl_set_qualifier + sys_acl_set_permset + sys_acl_valid + sys_acl_set_file + sys_acl_set_fd + sys_acl_delete_def_file + sys_acl_get_perm + sys_acl_free_text + sys_acl_free_acl + sys_acl_free_qualifier + getxattr + lgetxattr + fgetxattr + listxattr + llistxattr + flistxattr + removexattr + lremovexattr + fremovexattr + setxattr + lsetxattr + fsetxattr + aio_read + aio_write + aio_return + aio_cancel + aio_error + aio_fsync + aio_suspend + + + In addition to these operations, + vfs_full_audit recognizes the special operation + names "all" and "none ", which refer to all + the VFS operations and none of the VFS operations respectively. + + + vfs_full_audit records operations in fixed + format consisting of fields separated by '|' characters. The + format is: + + smbd_audit: PREFIX|OPERATION|RESULT|FILE + + + The record fields are: + + + PREFIX - the result of the full_audit:prefix string after variable substitutions + OPERATION - the name of the VFS operation + RESULT - whether the operation succeeded or failed + FILE - the name of the file or directory the operation was performed on + + + + This module is stackable. + + + + + + OPTIONS + + + + + vfs_full_audit:prefix = STRING + + Prepend audit messages with STRING. STRING is + processed for standard substitution variables listed in + smb.conf + 5. The default + prefix is "%u|%I". + + + + + + vfs_full_audit:success = LIST + + LIST is a list of VFS operations that should be + recorded if they succeed. Operations are specified using + the names listed above. + + + + + + + vfs_full_audit:failure = LIST + + LIST is a list of VFS operations that should be + recorded if they failed. Operations are specified using + the names listed above. + + + + + + + full_audit:facility = FACILITY + + Log messages to the named + syslog + 3 facility. + + + + + + + + full_audit:priority = PRIORITY + + Log messages with the named + syslog + 3 priority. + + + + + + + + + + EXAMPLES + + Log file and directory open operations on the [records] + share using the LOCAL7 facility and ALERT priority, including + the username and IP address: + + + + /data/records + full_audit + %u|%I + open opendir + all + LOCAL7 + ALERT + + + + + + VERSION + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_netatalk.8.xml b/docs/manpages-3/vfs_netatalk.8.xml new file mode 100644 index 0000000000..ffae4681b5 --- /dev/null +++ b/docs/manpages-3/vfs_netatalk.8.xml @@ -0,0 +1,73 @@ + + + + + + smb-vfs-netatalk + 8 + + + + + netatalk + hide .AppleDouble files from CIFS clients + + + + + vfs objects = netatalk + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The 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. + + This module is stackable. + + + + + EXAMPLES + + Hide .AppleDouble files on the [data] share: + + + netatalk + + + + + + CAVEATS + This module is largely historic and unlikely to be of use + in modern networks since current Apple systems are able to mount CIFS + shares natively. + + + + + + VERSION + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_prealloc.8.xml b/docs/manpages-3/vfs_prealloc.8.xml new file mode 100644 index 0000000000..1d8f6db75c --- /dev/null +++ b/docs/manpages-3/vfs_prealloc.8.xml @@ -0,0 +1,103 @@ + + + + + + smb-vfs-prealloc + 8 + + + + + prealloc + preallocate matching files to a predetermined size + + + + + vfs objects = prealloc + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The 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 + allocations is expensive. + + This module is stackable. + + + + + + OPTIONS + + + + + prealloc:EXT = BYTES + + Preallocate all files with the extension EXT to + the size specified by BYTES. + + + The following suffixes may be applied to BYTES: + + K - BYTES is a number of kilobytes + M - BYTES is a number of megabytes + G - BYTES is a number of gigabytes + + + + + + + + + + EXAMPLES + + A process writes TIFF files to a Samba share, and the + is known these files will almost always be around 4 megabytes + (4194304 bytes): + + + + /data/frames + prealloc + 4M + + + + + CAVEATS + preallocate is not supported on all + platforms and filesystems. Currently only XFS filesystems on + Linux and IRIX are supported. + + + + + VERSION + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_readonly.8.xml b/docs/manpages-3/vfs_readonly.8.xml new file mode 100644 index 0000000000..b1886bdf90 --- /dev/null +++ b/docs/manpages-3/vfs_readonly.8.xml @@ -0,0 +1,97 @@ + + + + + + smb-vfs-readonly + 8 + + + + + readonly + make a Samba share read only for a specified time period + + + + + vfs objects = readonly + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The 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 + actual access privileges. + + This module is stackable. + + + + + + OPTIONS + + + + + readonly:period = BEGIN, END + + Only mark the share as read only if the client + connection was made between the times marked by the + BEGIN and END date specifiers. + The syntax of these date specifiers is the + same as that accepted by the -d option of GNU + date + 1. + + + + + + + + + + EXAMPLES + + Mark all shares read only: + + + readonly + + + Mark the [backup] share as read only during business hours: + + + /readonly + readonly + readonly:period = "today 9:00","today 17:00" + + + + + VERSION + + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_recycle.8.xml b/docs/manpages-3/vfs_recycle.8.xml new file mode 100644 index 0000000000..923550de75 --- /dev/null +++ b/docs/manpages-3/vfs_recycle.8.xml @@ -0,0 +1,202 @@ + + + + + + smb-vfs-recycle + 8 + + + + + recycle + Samba VFS recycle bin + + + + + vfs objects = recycle + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The 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. + + The Recycle Bin will not appear in Windows Explorer + views of the network file system (share) nor on any mapped + drive. Instead, a directory called .recycle will be automatically + created when the first file is deleted and recycle:repository is + not configured. If recycle:repository is configured, the name + of the created directory depends on recycle:repository. Users + can recover files from the recycle bin. If the recycle:keeptree + option has been specified, deleted files will be found in a path + identical with that from which the file was deleted. + + + This module is stackable. + + + + + + OPTIONS + + + + + recycle:repository = PATH + + Path of the directory where deleted files should be moved. + + If this option is not set, the default path .recycle + is used. + + + + + recycle:directory_mode = MODE + + Set MODE to the octal mode the recycle repository + should be created with. The recycle repository will be + created when first file is deleted. If recycle:subdir_mode + is not set, MODE also applies to subdirectories. + + If this option is not set, the default mode + 0700 is used. + + + + + recycle:subdir_mode = MODE + + Set MODE to the octal mode with which + sub directories of the recycle repository should be created. + + If this option is not set, subdirectories + will be created with the mode from recycle:directory_mode. + + + + + + recycle:keeptree = BOOL + + Specifies whether the directory structure should + be preserved or whether the files in a directory that is being + deleted should be kept separately in the repository. + + + + + + recycle:versions = BOOL + + If this option is True, two files with the same + name that are deleted will both be kept in the repository. + Newer deleted versions of a file will be called + "Copy #x of filename". + + + + + + recycle:touch = BOOL + + Specifies whether a file's access date should be + updated when the file is moved to the repository. + + + + + + recycle:touch_mtime = BOOL + + Specifies whether a file's last modified date should be + updated when the file is moved to the repository. + + + + + + recycle:maxsize = BYTES + + Files that are larger than the number of bytes + specified by this parameter will not be put into the + repository. + + + + + + recycle:exclude = LIST + + List of files that should not be put into the + repository when deleted, but deleted in the normal way. + + + + + + recycle:exclude_dir = LIST + + List of directories whose files should not be put + into the repository when deleted, but deleted in the + normal way. + + + + + + recycle:noversions = LIST + + Specifies a list of paths (wildcards such as * + and ? are supported) for which no versioning should + be used. Only useful when recycle:versions is enabled. + + + + + + + + + EXAMPLES + + Log operations on all shares using the LOCAL1 facility + and NOTICE priority: + + + + recycle + LOCAL1 + NOTICE + + + + + + VERSION + + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs/manpages-3/vfs_shadow_copy.8.xml b/docs/manpages-3/vfs_shadow_copy.8.xml new file mode 100644 index 0000000000..e735b881ce --- /dev/null +++ b/docs/manpages-3/vfs_shadow_copy.8.xml @@ -0,0 +1,117 @@ + + + + + + smb-vfs-shadow_copy + 8 + + + + + shadow_copy + Make a Samba share read only for a specified time period + + + + + vfs objects = shadow_copy + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The 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. + + + This module is stackable. + + + + + CONFIGURATION + + 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 + be immediate children of a the directory being shared. + + The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss, + where: + + YYYY is the 4 digit year + MM is the 2 digit month + DD is the 2 digit day + hh is the 2 digit hour + mm is the 2 digit minute + ss is the 2 digit second. + + + + The shadow_copy snapshot naming convention can be produced with the following + date + 1 command: + + TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S + + + + + + EXAMPLES + + Add shadow copy support to user home directories: + + + shadow_copy + + + + + + CAVEATS + + This is not a backup, archival, or version control solution. + + + With Samba or Windows servers, + 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 + version control system. + + + + + + + VERSION + + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + -- cgit