diff options
author | Gerald W. Carter <jerry@samba.org> | 2008-04-22 10:09:40 -0500 |
---|---|---|
committer | Gerald W. Carter <jerry@samba.org> | 2008-04-23 08:47:48 -0500 |
commit | 8f8a9f01909ba29e2b781310baeeaaddc3f15f0d (patch) | |
tree | 90c6b720ad3a7bc815245c0ef28820424f89d658 /docs-xml/smbdotconf/filename | |
parent | 197238246389c40edc60c6630d18d6913086e630 (diff) | |
download | samba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.tar.gz samba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.tar.bz2 samba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.zip |
Moving docs tree to docs-xml to make room for generated docs in the release tarball.
(This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14)
Diffstat (limited to 'docs-xml/smbdotconf/filename')
24 files changed, 549 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/filename/casesensitive.xml b/docs-xml/smbdotconf/filename/casesensitive.xml new file mode 100644 index 0000000000..ed770501cd --- /dev/null +++ b/docs-xml/smbdotconf/filename/casesensitive.xml @@ -0,0 +1,12 @@ +<samba:parameter name="case sensitive" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<synonym>casesignames</synonym> + +<description> + <para>See the discussion in the section <smbconfoption name="name mangling"/>.</para> +</description> + +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/defaultcase.xml b/docs-xml/smbdotconf/filename/defaultcase.xml new file mode 100644 index 0000000000..1efb37c8b5 --- /dev/null +++ b/docs-xml/smbdotconf/filename/defaultcase.xml @@ -0,0 +1,9 @@ +<samba:parameter name="default case" + context="S" + type="string" xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>See the section on <smbconfoption name="name mangling"/>. + Also note the <smbconfoption name="short preserve case"/> parameter.</para> +</description> +<value type="default">lower</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/deletevetofiles.xml b/docs-xml/smbdotconf/filename/deletevetofiles.xml new file mode 100644 index 0000000000..31138aa8e2 --- /dev/null +++ b/docs-xml/smbdotconf/filename/deletevetofiles.xml @@ -0,0 +1,26 @@ +<samba:parameter name="delete veto files" + type="boolean" + context="S" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This option is used when Samba is attempting to + delete a directory that contains one or more vetoed directories + (see the <smbconfoption name="veto files"/> + option). If this option is set to <constant>no</constant> (the default) then if a vetoed + directory contains any non-vetoed files or directories then the + directory delete will fail. This is usually what you want.</para> + + <para>If this option is set to <constant>yes</constant>, then Samba + will attempt to recursively delete any files and directories within + the vetoed directory. This can be useful for integration with file + serving systems such as NetAtalk which create meta-files within + directories you might normally veto DOS/Windows users from seeing + (e.g. <filename moreinfo="none">.AppleDouble</filename>)</para> + + <para>Setting <smbconfoption name="delete veto files">yes</smbconfoption> allows these + directories to be transparently deleted when the parent directory + is deleted (so long as the user has permissions to do so).</para> +</description> +<related>veto files</related> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/hidedotfiles.xml b/docs-xml/smbdotconf/filename/hidedotfiles.xml new file mode 100644 index 0000000000..9f31f2cd5d --- /dev/null +++ b/docs-xml/smbdotconf/filename/hidedotfiles.xml @@ -0,0 +1,10 @@ +<samba:parameter name="hide dot files" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This is a boolean parameter that controls whether + files starting with a dot appear as hidden files.</para> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/hidefiles.xml b/docs-xml/smbdotconf/filename/hidefiles.xml new file mode 100644 index 0000000000..0b475053ee --- /dev/null +++ b/docs-xml/smbdotconf/filename/hidefiles.xml @@ -0,0 +1,46 @@ +<samba:parameter name="hide files" + type="string" + context="S" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This is a list of files or directories that are not + visible but are accessible. The DOS 'hidden' attribute is applied + to any files or directories that match.</para> + + <para>Each entry in the list must be separated by a '/', + which allows spaces to be included in the entry. '*' + and '?' can be used to specify multiple files or directories + as in DOS wildcards.</para> + + <para>Each entry must be a Unix path, not a DOS path and must + not include the Unix directory separator '/'.</para> + + <para>Note that the case sensitivity option is applicable + in hiding files.</para> + + <para>Setting this parameter will affect the performance of Samba, + as it will be forced to check all files and directories for a match + as they are scanned.</para> + + <para> + The example shown above is based on files that the Macintosh + SMB client (DAVE) available from <ulink url="http://www.thursby.com"> + Thursby</ulink> creates for internal use, and also still hides + all files beginning with a dot. + </para> + + <para> + An example of us of this parameter is: +<programlisting> +hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/ +</programlisting> + </para> +</description> + +<related>hide dot files</related> +<related>veto files</related> +<related>case sensitive</related> + +<value type="default"><comment>no file are hidden</comment></value> + +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/hidespecialfiles.xml b/docs-xml/smbdotconf/filename/hidespecialfiles.xml new file mode 100644 index 0000000000..ea2b68a66c --- /dev/null +++ b/docs-xml/smbdotconf/filename/hidespecialfiles.xml @@ -0,0 +1,14 @@ +<samba:parameter name="hide special files" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + + <para> + This parameter prevents clients from seeing special files such as sockets, devices and + fifo's in directory listings. + </para> + +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/hideunreadable.xml b/docs-xml/smbdotconf/filename/hideunreadable.xml new file mode 100644 index 0000000000..c2c1654c1c --- /dev/null +++ b/docs-xml/smbdotconf/filename/hideunreadable.xml @@ -0,0 +1,10 @@ +<samba:parameter name="hide unreadable" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para>This parameter prevents clients from seeing the + existance of files that cannot be read. Defaults to off.</para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/hideunwriteablefiles.xml b/docs-xml/smbdotconf/filename/hideunwriteablefiles.xml new file mode 100644 index 0000000000..831e8c69c9 --- /dev/null +++ b/docs-xml/smbdotconf/filename/hideunwriteablefiles.xml @@ -0,0 +1,12 @@ +<samba:parameter name="hide unwriteable files" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This parameter prevents clients from seeing the existance of files that cannot be written to. + Defaults to off. Note that unwriteable directories are shown as usual. + </para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/mangledmap.xml b/docs-xml/smbdotconf/filename/mangledmap.xml new file mode 100644 index 0000000000..b4be3a80d2 --- /dev/null +++ b/docs-xml/smbdotconf/filename/mangledmap.xml @@ -0,0 +1,33 @@ +<samba:parameter name="mangled map" + type="string" + context="S" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This is for those who want to directly map UNIX file names which cannot be represented on + Windows/DOS. The mangling of names is not always what is needed. In particular you may have + documents with file extensions that differ between DOS and UNIX. + For example, under UNIX it is common to use <filename moreinfo="none">.html</filename> + for HTML files, whereas under Windows/DOS <filename moreinfo="none">.htm</filename> + is more commonly used. + </para> + + <para> + So to map <filename moreinfo="none">html</filename> to <filename moreinfo="none">htm</filename> + you would use: + </para> + + <para> + <smbconfoption name="mangled map">(*.html *.htm)</smbconfoption>. + </para> + + <para> + One very useful case is to remove the annoying <filename moreinfo="none">;1</filename> off + the ends of filenames on some CDROMs (only visible under some UNIXes). To do this use a map of + (*;1 *;). + </para> +</description> + +<value type="default"><comment>no mangled map</comment></value> +<value type="example">(*;1 *;)</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/manglednames.xml b/docs-xml/smbdotconf/filename/manglednames.xml new file mode 100644 index 0000000000..90bbc58667 --- /dev/null +++ b/docs-xml/smbdotconf/filename/manglednames.xml @@ -0,0 +1,58 @@ +<samba:parameter name="mangled names" + type="boolean" + context="S" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This controls whether non-DOS names under UNIX + should be mapped to DOS-compatible names ("mangled") and made visible, + or whether non-DOS names should simply be ignored.</para> + + <para>See the section on <smbconfoption name="name mangling"/> for + details on how to control the mangling process.</para> + + <para>If mangling is used then the mangling algorithm is as follows:</para> + + <itemizedlist> + <listitem> + <para>The first (up to) five alphanumeric characters + before the rightmost dot of the filename are preserved, forced + to upper case, and appear as the first (up to) five characters + of the mangled name.</para> + </listitem> + + <listitem> + <para>A tilde "~" is appended to the first part of the mangled + name, followed by a two-character unique sequence, based on the + original root name (i.e., the original filename minus its final + extension). The final extension is included in the hash calculation + only if it contains any upper case characters or is longer than three + characters.</para> + + <para>Note that the character to use may be specified using + the <smbconfoption name="mangling char"/> + option, if you don't like '~'.</para> + </listitem> + + <listitem> + <para>Files whose UNIX name begins with a dot will be + presented as DOS hidden files. The mangled name will be created as + for other filenames, but with the leading dot removed and "___" as + its extension regardless of actual original extension (that's three + underscores).</para> + </listitem> + </itemizedlist> + + <para>The two-digit hash value consists of upper case alphanumeric characters.</para> + + <para>This algorithm can cause name collisions only if files + in a directory share the same first five alphanumeric characters. + The probability of such a clash is 1/1300.</para> + + <para>The name mangling (if enabled) allows a file to be + copied between UNIX directories from Windows/DOS while retaining + the long UNIX filename. UNIX files can be renamed to a new extension + from Windows/DOS and will retain the same basename. Mangled names + do not change between sessions.</para> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/mangleprefix.xml b/docs-xml/smbdotconf/filename/mangleprefix.xml new file mode 100644 index 0000000000..fd96c2c4fe --- /dev/null +++ b/docs-xml/smbdotconf/filename/mangleprefix.xml @@ -0,0 +1,19 @@ +<samba:parameter name="mangle prefix" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> controls the number of prefix + characters from the original name used when generating + the mangled names. A larger value will give a weaker + hash and therefore more name collisions. The minimum + value is 1 and the maximum value is 6.</para> + + <para> + mangle prefix is effective only when mangling method is hash2. + </para> +</description> +<value type="default">1</value> +<value type="example">4</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/manglingchar.xml b/docs-xml/smbdotconf/filename/manglingchar.xml new file mode 100644 index 0000000000..95b47794d1 --- /dev/null +++ b/docs-xml/smbdotconf/filename/manglingchar.xml @@ -0,0 +1,13 @@ +<samba:parameter name="mangling char" + context="S" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para>This controls what character is used as + the <emphasis>magic</emphasis> character in <smbconfoption name="name mangling"/>. The + default is a '~' but this may interfere with some software. Use this option to set + it to whatever you prefer. This is effective only when mangling method is hash.</para> +</description> +<value type="default">~</value> +<value type="example">^</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/manglingmethod.xml b/docs-xml/smbdotconf/filename/manglingmethod.xml new file mode 100644 index 0000000000..f6e2edaac3 --- /dev/null +++ b/docs-xml/smbdotconf/filename/manglingmethod.xml @@ -0,0 +1,18 @@ +<samba:parameter name="mangling method" + context="G" + type="string" + advanced="1" developer="1" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> controls the algorithm used for the generating + the mangled names. Can take two different values, "hash" and + "hash2". "hash" is the algorithm that was used + used in Samba for many years and was the default in Samba 2.2.x "hash2" is + now the default and is newer and considered a better algorithm (generates less collisions) in + the names. Many Win32 applications store the mangled names and so + changing to algorithms must not be done lightly as these applications + may break unless reinstalled.</para> +</description> +<value type="default">hash2</value> +<value type="example">hash</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/maparchive.xml b/docs-xml/smbdotconf/filename/maparchive.xml new file mode 100644 index 0000000000..ead72cf25a --- /dev/null +++ b/docs-xml/smbdotconf/filename/maparchive.xml @@ -0,0 +1,23 @@ +<samba:parameter name="map archive" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This controls whether the DOS archive attribute + should be mapped to the UNIX owner execute bit. The DOS archive bit + is set when a file has been modified since its last backup. One + motivation for this option is to keep Samba/your PC from making + any file it touches from becoming executable under UNIX. This can + be quite annoying for shared source code, documents, etc... + </para> + + <para> + Note that this requires the <smbconfoption name="create mask"/> parameter to be set such that owner + execute bit is not masked out (i.e. it must include 100). See the parameter + <smbconfoption name="create mask"/> for details. + </para> +</description> + +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/maphidden.xml b/docs-xml/smbdotconf/filename/maphidden.xml new file mode 100644 index 0000000000..841c6876e6 --- /dev/null +++ b/docs-xml/smbdotconf/filename/maphidden.xml @@ -0,0 +1,18 @@ +<samba:parameter name="map hidden" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This controls whether DOS style hidden files should be mapped to the UNIX world execute bit. + </para> + + <para> + Note that this requires the <smbconfoption name="create mask"/> to be set such that the world execute + bit is not masked out (i.e. it must include 001). See the parameter <smbconfoption name="create mask"/> + for details. + </para> + +</description> +<value type="boolean">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/mapreadonly.xml b/docs-xml/smbdotconf/filename/mapreadonly.xml new file mode 100644 index 0000000000..3ec2d3bf27 --- /dev/null +++ b/docs-xml/smbdotconf/filename/mapreadonly.xml @@ -0,0 +1,43 @@ +<samba:parameter name="map read only" + context="S" + type="enum" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This controls how the DOS read only attribute should be mapped from a UNIX filesystem. + </para> + + <para> + This parameter can take three different values, which tell <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> how to display the read only attribute on files, where either + <smbconfoption name="store dos attributes"/> is set to <constant>No</constant>, or no extended attribute is + present. If <smbconfoption name="store dos attributes"/> is set to <constant>yes</constant> then this + parameter is <emphasis>ignored</emphasis>. This is a new parameter introduced in Samba version 3.0.21. + </para> + + <para>The three settings are :</para> + + <itemizedlist> + <listitem><para> + <constant>Yes</constant> - The read only DOS attribute is mapped to the inverse of the user + or owner write bit in the unix permission mode set. If the owner write bit is not set, the + read only attribute is reported as being set on the file. + </para></listitem> + + <listitem><para> + <constant>Permissions</constant> - The read only DOS attribute is mapped to the effective permissions of + the connecting user, as evaluated by <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> by reading the unix permissions and POSIX ACL (if present). + If the connecting user does not have permission to modify the file, the read only attribute + is reported as being set on the file. + </para></listitem> + + <listitem><para> + <constant>No</constant> - The read only DOS attribute is unaffected by permissions, and can only be set by + the <smbconfoption name="store dos attributes"/> method. This may be useful for exporting mounted CDs. + </para></listitem> + </itemizedlist> + +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/mapsystem.xml b/docs-xml/smbdotconf/filename/mapsystem.xml new file mode 100644 index 0000000000..021602d578 --- /dev/null +++ b/docs-xml/smbdotconf/filename/mapsystem.xml @@ -0,0 +1,17 @@ +<samba:parameter name="map system" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This controls whether DOS style system files should be mapped to the UNIX group execute bit. + </para> + + <para> + Note that this requires the <smbconfoption name="create mask"/> to be set such that the group + execute bit is not masked out (i.e. it must include 010). See the parameter + <smbconfoption name="create mask"/> for details. + </para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/maxstatcachesize.xml b/docs-xml/smbdotconf/filename/maxstatcachesize.xml new file mode 100644 index 0000000000..607fe5840f --- /dev/null +++ b/docs-xml/smbdotconf/filename/maxstatcachesize.xml @@ -0,0 +1,18 @@ +<samba:parameter name="max stat cache size" + context="G" + developer="1" + type="integer" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter limits the size in memory of any + <parameter moreinfo="none">stat cache</parameter> being used + to speed up case insensitive name mappings. This parameter is + the number of kilobyte (1024) units the stat cache can use. + A value of zero means unlimited which is not advised aѕ it can + use a lot of memory. + You should not need to change this parameter.</para> +</description> +<related>stat cache</related> +<value type="default">256</value> +<value type="example">100</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/preservecase.xml b/docs-xml/smbdotconf/filename/preservecase.xml new file mode 100644 index 0000000000..875900d4c2 --- /dev/null +++ b/docs-xml/smbdotconf/filename/preservecase.xml @@ -0,0 +1,17 @@ +<samba:parameter name="preserve case" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This controls if new filenames are created with the case that the client passes, or if + they are forced to be the <smbconfoption name="default case"/>. + </para> + + <para> + See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link> for a fuller discussion. + </para> +</description> + +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/shortpreservecase.xml b/docs-xml/smbdotconf/filename/shortpreservecase.xml new file mode 100644 index 0000000000..90188a076e --- /dev/null +++ b/docs-xml/smbdotconf/filename/shortpreservecase.xml @@ -0,0 +1,16 @@ +<samba:parameter name="short preserve case" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + This boolean parameter controls if new files which conform to 8.3 syntax, that is all in upper case and of + suitable length, are created upper case, or if they are forced to be the <smbconfoption name="default case"/>. + This option can be use with <smbconfoption name="preserve case">yes</smbconfoption> to permit long filenames + to retain their case, while short names are lowered. + </para> + + <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link>.</para> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/statcache.xml b/docs-xml/smbdotconf/filename/statcache.xml new file mode 100644 index 0000000000..c38fb11a88 --- /dev/null +++ b/docs-xml/smbdotconf/filename/statcache.xml @@ -0,0 +1,13 @@ +<samba:parameter name="stat cache" + context="G" + developer="1" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para>This parameter determines if <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will use a cache in order to + speed up case insensitive name mappings. You should never need + to change this parameter.</para> +</description> +<value type="default">yes</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/storedosattributes.xml b/docs-xml/smbdotconf/filename/storedosattributes.xml new file mode 100644 index 0000000000..6fcab82f9c --- /dev/null +++ b/docs-xml/smbdotconf/filename/storedosattributes.xml @@ -0,0 +1,20 @@ +<samba:parameter name="store dos attributes" + context="S" + type="boolean" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> +<description> + <para> + If this parameter is set Samba attempts to first read DOS attributes (SYSTEM, HIDDEN, ARCHIVE or + READ-ONLY) from a filesystem extended attribute, before mapping DOS attributes to UNIX permission bits (such + as occurs with <smbconfoption name="map hidden"/> and <smbconfoption name="map readonly"/>). When set, DOS + attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or + directory. For no other mapping to occur as a fall-back, the parameters <smbconfoption name="map hidden"/>, + <smbconfoption name="map system"/>, <smbconfoption name="map archive"/> and <smbconfoption name="map + readonly"/> must be set to off. This parameter writes the DOS attributes as a string into the extended + attribute named "user.DOSATTRIB". This extended attribute is explicitly hidden from smbd clients requesting an + EA list. On Linux the filesystem must have been mounted with the mount option user_xattr in order for + extended attributes to work, also extended attributes must be compiled into the Linux kernel. + </para> +</description> +<value type="default">no</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/vetofiles.xml b/docs-xml/smbdotconf/filename/vetofiles.xml new file mode 100644 index 0000000000..48e0c40fff --- /dev/null +++ b/docs-xml/smbdotconf/filename/vetofiles.xml @@ -0,0 +1,52 @@ +<samba:parameter name="veto files" + context="S" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + This is a list of files and directories that are neither visible nor accessible. Each entry in + the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?' + can be used to specify multiple files or directories as in DOS wildcards. + </para> + + <para> + Each entry must be a unix path, not a DOS path and must <emphasis>not</emphasis> include the + unix directory separator '/'. + </para> + + <para> + Note that the <smbconfoption name="case sensitive"/> option is applicable in vetoing files. + </para> + + <para> + One feature of the veto files parameter that it is important to be aware of is Samba's behaviour when + trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this + deletion will <emphasis>fail</emphasis> unless you also set the <smbconfoption name="delete veto files"/> + parameter to <parameter moreinfo="none">yes</parameter>. + </para> + + <para> + Setting this parameter will affect the performance of Samba, as it will be forced to check all files + and directories for a match as they are scanned. + </para> + + <para> + Examples of use include: +<programlisting> +; Veto any files containing the word Security, +; any ending in .tmp, and any directory containing the +; word root. +veto files = /*Security*/*.tmp/*root*/ + +; Veto the Apple specific files that a NetAtalk server +; creates. +veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ +</programlisting> + </para> + +</description> +<related>hide files</related> +<related>case sensitive</related> + +<value type="default">No files or directories are vetoed.</value> +</samba:parameter> diff --git a/docs-xml/smbdotconf/filename/vetooplockfiles.xml b/docs-xml/smbdotconf/filename/vetooplockfiles.xml new file mode 100644 index 0000000000..b99ab00385 --- /dev/null +++ b/docs-xml/smbdotconf/filename/vetooplockfiles.xml @@ -0,0 +1,32 @@ +<samba:parameter name="veto oplock files" + context="S" + type="string" + xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> + <description> + <para> + This parameter is only valid when the <smbconfoption name="oplocks"/> + parameter is turned on for a share. It allows the Samba administrator + to selectively turn off the granting of oplocks on selected files that + match a wildcarded list, similar to the wildcarded list used in the + <smbconfoption name="veto files"/> parameter. + </para> + + + <para> + You might want to do this on files that you know will be heavily contended + for by clients. A good example of this is in the NetBench SMB benchmark + program, which causes heavy client contention for files ending in + <filename moreinfo="none">.SEM</filename>. To cause Samba not to grant + oplocks on these files you would use the line (either in the [global] + section or in the section for the particular NetBench share. + </para> + + <para> + An example of use is: +<programlisting> +veto oplock files = /.*SEM/ +</programlisting> + </para> +</description> +<value type="default"><comment>No files are vetoed for oplock grants</comment></value> +</samba:parameter> |