diff options
Diffstat (limited to 'docs/docbook')
| -rw-r--r-- | docs/docbook/smbdotconf/filename/mangledmap.xml | 41 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/filename/manglednames.xml | 71 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/filename/maparchive.xml | 32 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/filename/maphidden.xml | 24 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/filename/mapsystem.xml | 24 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/filename/statcache.xml | 21 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/filename/vetofiles.xml | 60 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/filename/vetooplockfiles.xml | 43 |
8 files changed, 170 insertions, 146 deletions
diff --git a/docs/docbook/smbdotconf/filename/mangledmap.xml b/docs/docbook/smbdotconf/filename/mangledmap.xml index abe6c031e0..e790fa877d 100644 --- a/docs/docbook/smbdotconf/filename/mangledmap.xml +++ b/docs/docbook/smbdotconf/filename/mangledmap.xml @@ -1,23 +1,26 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MANGLEDMAP"/>mangled map (S)</term> - <listitem><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> +<samba:parameter name="mangled map" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <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>So to map <filename moreinfo="none">html</filename> to <filename moreinfo="none">htm</filename> + you would use:</para> - <para><command moreinfo="none">mangled map = (*.html *.htm)</command></para> + <para><command moreinfo="none">mangled map = (*.html *.htm)</command></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> + <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> - <para>Default: <emphasis>no mangled map</emphasis></para> - <para>Example: <command moreinfo="none">mangled map = (*;1 *;)</command></para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>no mangled map</emphasis></para> + + <para>Example: <command moreinfo="none">mangled map = (*;1 *;)</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/manglednames.xml b/docs/docbook/smbdotconf/filename/manglednames.xml index 41592b3159..4ec088d16f 100644 --- a/docs/docbook/smbdotconf/filename/manglednames.xml +++ b/docs/docbook/smbdotconf/filename/manglednames.xml @@ -1,21 +1,26 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MANGLEDNAMES"/>mangled names (S)</term> - <listitem><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> +<samba:parameter name="mangled names" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <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 <link linkend="NAMEMANGLINGSECT"> - NAME MANGLING</link> for details on how to control the mangling process.</para> + <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link> for + details on how to control the mangling process.</para> - <para>If mangling is used then the mangling algorithm is as follows:</para> + <para>If mangling is used then the mangling algorithm is as follows:</para> - <itemizedlist> - <listitem><para>The first (up to) five alphanumeric characters + <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> + of the mangled name.</para> + </listitem> - <listitem><para>A tilde "~" is appended to the first part of the mangled + <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 @@ -24,35 +29,39 @@ <para>Note that the character to use may be specified using the <link linkend="MANGLINGCHAR"><parameter moreinfo="none">mangling char</parameter> - </link> option, if you don't like '~'.</para></listitem> + </link> option, if you don't like '~'.</para> + </listitem> - <listitem><para>The first three alphanumeric characters of the final + <listitem> + <para>The first three alphanumeric characters of the final extension are preserved, forced to upper case and appear as the extension of the mangled name. The final extension is defined as that part of the original filename after the rightmost dot. If there are no dots in the filename, the mangled name will have no extension (except - in the case of "hidden files" - see below).</para></listitem> + in the case of "hidden files" - see below).</para> + </listitem> - <listitem><para>Files whose UNIX name begins with a dot will be + <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> + underscores).</para> + </listitem> + </itemizedlist> - <para>The two-digit hash value consists of upper case - alphanumeric characters.</para> + <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>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> + <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> - <para>Default: <command moreinfo="none">mangled names = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">mangled names = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/maparchive.xml b/docs/docbook/smbdotconf/filename/maparchive.xml index 18f39791aa..b44088efe3 100644 --- a/docs/docbook/smbdotconf/filename/maparchive.xml +++ b/docs/docbook/smbdotconf/filename/maparchive.xml @@ -1,17 +1,19 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAPARCHIVE"/>map archive (S)</term> - <listitem><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 it 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> +<samba:parameter name="map archive" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <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 it 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 <parameter moreinfo="none">create mask</parameter> - parameter to be set such that owner execute bit is not masked out - (i.e. it must include 100). See the parameter <link linkend="CREATEMASK"> - <parameter moreinfo="none">create mask</parameter></link> for details.</para> + <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> + parameter to be set such that owner execute bit is not masked out + (i.e. it must include 100). See the parameter <link linkend="CREATEMASK"> + <parameter moreinfo="none">create mask</parameter></link> for details.</para> - <para>Default: <command moreinfo="none">map archive = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">map archive = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/maphidden.xml b/docs/docbook/smbdotconf/filename/maphidden.xml index 2b0266c23e..4c1a932788 100644 --- a/docs/docbook/smbdotconf/filename/maphidden.xml +++ b/docs/docbook/smbdotconf/filename/maphidden.xml @@ -1,13 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAPHIDDEN"/>map hidden (S)</term> - <listitem><para>This controls whether DOS style hidden files - should be mapped to the UNIX world execute bit.</para> +<samba:parameter name="map hidden" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls whether DOS style hidden files + should be mapped to the UNIX world execute bit.</para> - <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> - to be set such that the world execute bit is not masked out (i.e. - it must include 001). See the parameter <link linkend="CREATEMASK"> - <parameter moreinfo="none">create mask</parameter></link> for details.</para> + <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> + to be set such that the world execute bit is not masked out (i.e. + it must include 001). See the parameter <link linkend="CREATEMASK"> + <parameter moreinfo="none">create mask</parameter></link> for details.</para> - <para>Default: <command moreinfo="none">map hidden = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">map hidden = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/mapsystem.xml b/docs/docbook/smbdotconf/filename/mapsystem.xml index ead629971a..7fe50bb19f 100644 --- a/docs/docbook/smbdotconf/filename/mapsystem.xml +++ b/docs/docbook/smbdotconf/filename/mapsystem.xml @@ -1,13 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="MAPSYSTEM"/>map system (S)</term> - <listitem><para>This controls whether DOS style system files - should be mapped to the UNIX group execute bit.</para> +<samba:parameter name="map system" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls whether DOS style system files + should be mapped to the UNIX group execute bit.</para> - <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> - to be set such that the group execute bit is not masked out (i.e. - it must include 010). See the parameter <link linkend="CREATEMASK"> - <parameter moreinfo="none">create mask</parameter></link> for details.</para> + <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> + to be set such that the group execute bit is not masked out (i.e. + it must include 010). See the parameter <link linkend="CREATEMASK"> + <parameter moreinfo="none">create mask</parameter></link> for details.</para> - <para>Default: <command moreinfo="none">map system = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">map system = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/statcache.xml b/docs/docbook/smbdotconf/filename/statcache.xml index ee94081483..ee2a48732e 100644 --- a/docs/docbook/smbdotconf/filename/statcache.xml +++ b/docs/docbook/smbdotconf/filename/statcache.xml @@ -1,10 +1,13 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="STATCACHE"/>stat cache (G)</term> - <listitem><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> +<samba:parameter name="stat cache" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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> - <para>Default: <command moreinfo="none">stat cache = yes</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">stat cache = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/vetofiles.xml b/docs/docbook/smbdotconf/filename/vetofiles.xml index faef2040b9..073645c611 100644 --- a/docs/docbook/smbdotconf/filename/vetofiles.xml +++ b/docs/docbook/smbdotconf/filename/vetofiles.xml @@ -1,36 +1,38 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="VETOFILES"/>veto files(S)</term> - <listitem><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> +<samba:parameter name="veto files" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <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>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 <parameter moreinfo="none">case sensitive</parameter> option - is applicable in vetoing files.</para> + <para>Note that the <parameter moreinfo="none">case sensitive</parameter> 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 <parameter moreinfo="none">delete veto files</parameter> parameter to - <parameter moreinfo="none">yes</parameter>.</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 <parameter moreinfo="none">delete veto files</parameter> 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>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>See also <link linkend="HIDEFILES"><parameter moreinfo="none">hide files - </parameter></link> and <link linkend="CASESENSITIVE"><parameter moreinfo="none"> - case sensitive</parameter></link>.</para> + <para>See also <link linkend="HIDEFILES"><parameter moreinfo="none">hide files + </parameter></link> and <link linkend="CASESENSITIVE"><parameter moreinfo="none"> + case sensitive</parameter></link>.</para> - <para>Default: <emphasis>No files or directories are vetoed. - </emphasis></para> + <para>Default: <emphasis>No files or directories are vetoed. + </emphasis></para> <para>Examples:<programlisting format="linespecific"> ; Veto any files containing the word Security, @@ -42,5 +44,5 @@ veto files = /*Security*/*.tmp/*root*/ ; creates. veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ </programlisting></para> - </listitem> - </samba:parameter> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/filename/vetooplockfiles.xml b/docs/docbook/smbdotconf/filename/vetooplockfiles.xml index 0c817c97f8..e7c683a518 100644 --- a/docs/docbook/smbdotconf/filename/vetooplockfiles.xml +++ b/docs/docbook/smbdotconf/filename/vetooplockfiles.xml @@ -1,24 +1,25 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="VETOOPLOCKFILES"/>veto oplock files (S)</term> - <listitem><para>This parameter is only valid when the <link linkend="OPLOCKS"><parameter moreinfo="none">oplocks</parameter></link> - 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 - <link linkend="VETOFILES"><parameter moreinfo="none">veto files</parameter></link> - parameter.</para> +<samba:parameter name="veto oplock files" + context="S" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter is only valid when the <link linkend="OPLOCKS"> + <parameter moreinfo="none">oplocks</parameter></link> + 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 + <link linkend="VETOFILES"><parameter moreinfo="none">veto files</parameter></link> + parameter.</para> - <para>Default: <emphasis>No files are vetoed for oplock - grants</emphasis></para> + <para>Default: <emphasis>No files are vetoed for oplock grants</emphasis></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>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>Example: <command moreinfo="none">veto oplock files = /*.SEM/ - </command></para> - </listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">veto oplock files = /*.SEM/</command></para> +</listitem> +</samba:parameter> |