sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2024-12-23 17:34:34 +03:00
Code

Make sure all the modules are referred to as vfs_module_name to avoid

Browse Source 
collisions with existing man pages.
This commit is contained in:
James Peach 2007-02-28 23:14:41 +00:00 committed by Gerald W. Carter
parent e2e8104462
commit 2c7722ac9e
14 changed files with 89 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/manpages-3/vfs_audit.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-audit.8">
<refentry id="vfs_audit.8">
<refmeta>
<refentrytitle>smb-vfs-audit</refentrytitle>
<refentrytitle>vfs_audit</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>audit</refname>
<refname>vfs_audit</refname>
<refpurpose>record selected Samba VFS operations in the system log</refpurpose>
</refnamediv>
@ -22,10 +22,11 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>audit</command> VFS module records selected
<para>The <command>vfs_audit</command> VFS module records selected
client operations to the system log using
<citerefentry><refentrytitle>syslog</refentrytitle>
<manvolnum>3</manvolnum></citerefentry>.</para>

13
docs/manpages-3/vfs_cacheprime.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-cacheprime.8">
<refentry id="vfs_cacheprime.8">
<refmeta>
<refentrytitle>smb-vfs-cacheprime</refentrytitle>
<refentrytitle>vfs_cacheprime</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>cacheprime</refname>
<refname>vfs_cacheprime</refname>
<refpurpose>prime the kernel file data cache</refpurpose>
</refnamediv>
@ -22,16 +22,17 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>cacheprime</command> VFS module reads chunks
<para>The <command>vfs_cacheprime</command> 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. </para>
<para>The size of the disk read operations performed
by <command>cacheprime</command> is determined by the
by <command>vfs_cacheprime</command> 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

11
docs/manpages-3/vfs_cap.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-cap.8">
<refentry id="vfs_cap.8">
<refmeta>
<refentrytitle>smb-vfs-cap</refentrytitle>
<refentrytitle>vfs_cap</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>cap</refname>
<refname>vfs_cap</refname>
<refpurpose>CAP encode filenames</refpurpose>
</refnamediv>
@ -22,12 +22,13 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>CAP (Columbia Appletalk Protocol) encoding is a
technique for representing non-ASCII filenames in ASCII. The
<command>cap</command> VFS module translates filenames to and
<command>vfs_cap</command> VFS module translates filenames to and
from CAP format, allowing users to name files in their native
encoding. </para>

11
docs/manpages-3/vfs_catia.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-catia.8">
<refentry id="vfs_catia.8">
<refmeta>
<refentrytitle>smb-vfs-catia</refentrytitle>
<refentrytitle>vfs_catia</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>catia</refname>
<refname>vfs_catia</refname>
<refpurpose>translate illegal characters in Catia filenames</refpurpose>
</refnamediv>
@ -22,12 +22,13 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The Catia CAD package commonly creates filenames that
use characters that are illegal in CIFS filenames. The
<command>catia</command> VFS module implements a fixed character
<command>vfs_catia</command> VFS module implements a fixed character
mapping so that these files can be shared with CIFS clients.
</para>

13
docs/manpages-3/vfs_commit.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-commit.8">
<refentry id="vfs_commit.8">
<refmeta>
<refentrytitle>smb-vfs-commit</refentrytitle>
<refentrytitle>vfs_commit</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>commit</refname>
<refname>vfs_commit</refname>
<refpurpose>flush dirty data at specified intervals</refpurpose>
</refnamediv>
@ -22,15 +22,16 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>commit</command> VFS module keeps track of
<para>The <command>vfs_commit</command> VFS module keeps track of
the amount of data written to a file and synchronizes it to
disk when a specified amount accumulates.
</para>
<para><command>commit</command> is useful in two
<para><command>vfs_commit</command> 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

15
docs/manpages-3/vfs_default_quota.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-default_quota.8">
<refentry id="vfs_default_quota.8">
<refmeta>
<refentrytitle>smb-vfs-default_quota</refentrytitle>
<refentrytitle>vfs_default_quota</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>default_quota</refname>
<refname>vfs_default_quota</refname>
<refpurpose>store default quota records for Windows clients</refpurpose>
</refnamediv>
@ -22,19 +22,20 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the
<citerefentry><refentrytitle>samba</refentrytitle><manvolnum>7</manvolnum></citerefentry>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry>
suite.</para>
<para>Many common quota implementations only store
quotas for users and groups, but do not store a default quota. The
<command>default_quota</command> module allows Samba to store
<command>vfs_default_quota</command> module allows Samba to store
default quota values which can be examined using the Windows
Explorer interface.
</para>
<para>By default, Samba returns NO_LIMIT the default quota and
refuses to update them. <command>default_quota</command> maps
refuses to update them. <command>vfs_default_quota</command> 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.</para>

3
docs/manpages-3/vfs_extd_audit.8.xml
View File

@ -22,7 +22,8 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>extd_audit</command> VFS module records selected

11
docs/manpages-3/vfs_fake_perms.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-fake_perms.8">
<refentry id="vfs_fake_perms.8">
<refmeta>
<refentrytitle>smb-vfs-fake_perms</refentrytitle>
<refentrytitle>vfs_fake_perms</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>fake_perms</refname>
<refname>vfs_fake_perms</refname>
<refpurpose>enable read only Roaming Profiles</refpurpose>
</refnamediv>
@ -22,10 +22,11 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>fake_perms</command> VFS module was created
<para>The <command>vfs_fake_perms</command> 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

11
docs/manpages-3/vfs_fam_notify.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-fam_notify.8">
<refentry id="vfs_fam_notify.8">
<refmeta>
<refentrytitle>smb-vfs-fam_notify</refentrytitle>
<refentrytitle>vfs_fam_notify</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>fam_notify</refname>
<refname>vfs_fam_notify</refname>
<refpurpose>FAM support for file change notifications</refpurpose>
</refnamediv>
@ -22,10 +22,11 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>fam_notify</command> module makes use of
<para>The <command>vfs_fam_notify</command> 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.</para>

11
docs/manpages-3/vfs_netatalk.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-netatalk.8">
<refentry id="vfs_netatalk.8">
<refmeta>
<refentrytitle>smb-vfs-netatalk</refentrytitle>
<refentrytitle>vfs_netatalk</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>netatalk</refname>
<refname>vfs_netatalk</refname>
<refpurpose>hide .AppleDouble files from CIFS clients</refpurpose>
</refnamediv>
@ -22,10 +22,11 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>netatalk</command> VFS module dynamically
<para>The <command>vfs_netatalk</command> 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. </para>

13
docs/manpages-3/vfs_prealloc.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-prealloc.8">
<refentry id="vfs_prealloc.8">
<refmeta>
<refentrytitle>smb-vfs-prealloc</refentrytitle>
<refentrytitle>vfs_prealloc</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>prealloc</refname>
<refname>vfs_prealloc</refname>
<refpurpose>preallocate matching files to a predetermined size</refpurpose>
</refnamediv>
@ -22,10 +22,11 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>prealloc</command> VFS module preallocates
<para>The <command>vfs_prealloc</command> 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 @@
<refsect1>
<title>CAVEATS</title>
<para><command>preallocate</command> is not supported on all
<para><command>vfs_prealloc</command> is not supported on all
platforms and filesystems. Currently only XFS filesystems on
Linux and IRIX are supported.
</para>

11
docs/manpages-3/vfs_readonly.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-readonly.8">
<refentry id="vfs_readonly.8">
<refmeta>
<refentrytitle>smb-vfs-readonly</refentrytitle>
<refentrytitle>vfs_readonly</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>readonly</refname>
<refname>vfs_readonly</refname>
<refpurpose>make a Samba share read only for a specified time period</refpurpose>
</refnamediv>
@ -22,10 +22,11 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>readonly</command> VFS module marks a share
<para>The <command>vfs_readonly</command> 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

11
docs/manpages-3/vfs_recycle.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-recycle.8">
<refentry id="vfs_recycle.8">
<refmeta>
<refentrytitle>smb-vfs-recycle</refentrytitle>
<refentrytitle>vfs_recycle</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>recycle</refname>
<refname>vfs_recycle</refname>
<refpurpose>Samba VFS recycle bin</refpurpose>
</refnamediv>
@ -22,10 +22,11 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>recycle</command> intercepts file deletion
<para>The <command>vfs_recycle</command> 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. </para>

19
docs/manpages-3/vfs_shadow_copy.8.xml
View File

@ -1,15 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smb-vfs-shadow_copy.8">
<refentry id="vfs_shadow_copy.8">
<refmeta>
<refentrytitle>smb-vfs-shadow_copy</refentrytitle>
<refentrytitle>vfs_shadow_copy</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>shadow_copy</refname>
<refname>vfs_shadow_copy</refname>
<refpurpose>Make a Samba share read only for a specified time period</refpurpose>
</refnamediv>
@ -22,10 +22,11 @@
<refsect1>
<title>DESCRIPTION</title>
<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>shadow_copy</command> VFS module functionality
<para>The <command>vfs_shadow_copy</command> 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 @@
<refsect1>
<title>CONFIGURATION</title>
<para><command>shadow_copy</command> relies on a filesystem
<para><command>vfs_shadow_copy</command> relies on a filesystem
snapshot implementation. Many common filesystems have native
support for this.
</para>
<para>Filesystem snapshots must be mounted on
specially named directories in order to be recognized by
<command>shadow_copy</command>. The snapshot mount points must
<command>vfs_shadow_copy</command>. The snapshot mount points must
be immediate children of a the directory being shared.</para>
<para>The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss,
@ -60,7 +61,7 @@
</itemizedlist>
</para>
<para>The <command>shadow_copy</command> snapshot naming convention can be produced with the following
<para>The <command>vfs_shadow_copy</command> snapshot naming convention can be produced with the following
<citerefentry><refentrytitle>date</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> command:
<programlisting>
@ -87,7 +88,7 @@
</para>
<para>With Samba or Windows servers,
<command>shadow_copy</command> is designed to be an end-user
<command>vfs_shadow_copy</command> 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