diff options
Diffstat (limited to 'docs/smbdotconf/filename')
| -rw-r--r-- | docs/smbdotconf/filename/deletevetofiles.xml | 2 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/hidefiles.xml | 4 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/hidespecialfiles.xml | 10 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/hideunwriteablefiles.xml | 8 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/mangledmap.xml | 27 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/manglednames.xml | 2 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/maparchive.xml | 14 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/maphidden.xml | 13 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/mapsystem.xml | 18 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/preservecase.xml | 12 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/storedosattributes.xml | 20 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/vetofiles.xml | 46 | ||||
| -rw-r--r-- | docs/smbdotconf/filename/vetooplockfiles.xml | 27 |
13 files changed, 114 insertions, 89 deletions
diff --git a/docs/smbdotconf/filename/deletevetofiles.xml b/docs/smbdotconf/filename/deletevetofiles.xml index b8809bacd7..31138aa8e2 100644 --- a/docs/smbdotconf/filename/deletevetofiles.xml +++ b/docs/smbdotconf/filename/deletevetofiles.xml @@ -17,7 +17,7 @@ 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 + <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> diff --git a/docs/smbdotconf/filename/hidefiles.xml b/docs/smbdotconf/filename/hidefiles.xml index 1d83860fca..0b475053ee 100644 --- a/docs/smbdotconf/filename/hidefiles.xml +++ b/docs/smbdotconf/filename/hidefiles.xml @@ -31,9 +31,9 @@ <para> An example of us of this parameter is: -<screen> +<programlisting> hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/ -</screen> +</programlisting> </para> </description> diff --git a/docs/smbdotconf/filename/hidespecialfiles.xml b/docs/smbdotconf/filename/hidespecialfiles.xml index 4714131c06..ea2b68a66c 100644 --- a/docs/smbdotconf/filename/hidespecialfiles.xml +++ b/docs/smbdotconf/filename/hidespecialfiles.xml @@ -3,10 +3,12 @@ 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> + + <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/smbdotconf/filename/hideunwriteablefiles.xml b/docs/smbdotconf/filename/hideunwriteablefiles.xml index e450cf05b5..831e8c69c9 100644 --- a/docs/smbdotconf/filename/hideunwriteablefiles.xml +++ b/docs/smbdotconf/filename/hideunwriteablefiles.xml @@ -3,10 +3,10 @@ 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> + <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/smbdotconf/filename/mangledmap.xml b/docs/smbdotconf/filename/mangledmap.xml index cbcec9b1df..b4be3a80d2 100644 --- a/docs/smbdotconf/filename/mangledmap.xml +++ b/docs/smbdotconf/filename/mangledmap.xml @@ -3,22 +3,29 @@ 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 + <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> + 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><smbconfoption name="mangled map">(*.html *.htm)</smbconfoption>.</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> + <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> diff --git a/docs/smbdotconf/filename/manglednames.xml b/docs/smbdotconf/filename/manglednames.xml index 64bc4a9412..90bbc58667 100644 --- a/docs/smbdotconf/filename/manglednames.xml +++ b/docs/smbdotconf/filename/manglednames.xml @@ -7,7 +7,7 @@ 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 + <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> diff --git a/docs/smbdotconf/filename/maparchive.xml b/docs/smbdotconf/filename/maparchive.xml index 1110ec943b..35169f97f3 100644 --- a/docs/smbdotconf/filename/maparchive.xml +++ b/docs/smbdotconf/filename/maparchive.xml @@ -3,16 +3,20 @@ type="boolean" xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> - <para>This controls whether the DOS archive attribute + <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> + 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> + <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> diff --git a/docs/smbdotconf/filename/maphidden.xml b/docs/smbdotconf/filename/maphidden.xml index da40f7ff3e..841c6876e6 100644 --- a/docs/smbdotconf/filename/maphidden.xml +++ b/docs/smbdotconf/filename/maphidden.xml @@ -3,12 +3,15 @@ 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> + 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> + <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> diff --git a/docs/smbdotconf/filename/mapsystem.xml b/docs/smbdotconf/filename/mapsystem.xml index 35b7dc7cfe..021602d578 100644 --- a/docs/smbdotconf/filename/mapsystem.xml +++ b/docs/smbdotconf/filename/mapsystem.xml @@ -3,13 +3,15 @@ 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> + 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> + <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/smbdotconf/filename/preservecase.xml b/docs/smbdotconf/filename/preservecase.xml index e84cb56461..875900d4c2 100644 --- a/docs/smbdotconf/filename/preservecase.xml +++ b/docs/smbdotconf/filename/preservecase.xml @@ -3,10 +3,14 @@ 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> + <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> diff --git a/docs/smbdotconf/filename/storedosattributes.xml b/docs/smbdotconf/filename/storedosattributes.xml index bedf185c2f..e6075c4ccf 100644 --- a/docs/smbdotconf/filename/storedosattributes.xml +++ b/docs/smbdotconf/filename/storedosattributes.xml @@ -3,16 +3,16 @@ type="boolean" xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> - <para>If this parameter is set Samba no longer attempts to - map DOS attributes like SYSTEM, HIDDEN, ARCHIVE or READ-ONLY - to UNIX permission bits (such as the <smbconfoption name="map hidden"/>. Instead, DOS attributes will be stored onto an extended - attribute in the UNIX filesystem, associated with the file or directory. - For this to operate correctly, the parameters <smbconfoption name="map hidden"/>, <smbconfoption name="map system"/>, <smbconfoption name="map archive"/> 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 + <para> + If this parameter is set Samba no longer attempts to map DOS attributes like SYSTEM, HIDDEN, + ARCHIVE or READ-ONLY to UNIX permission bits (such as the <smbconfoption name="map hidden"/>. + Instead, DOS attributes will be stored onto an extended attribute in the UNIX filesystem, + associated with the file or directory. For this to operate correctly, the parameters + <smbconfoption name="map hidden"/>, <smbconfoption name="map system"/>, + <smbconfoption name="map archive"/> 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.i 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> diff --git a/docs/smbdotconf/filename/vetofiles.xml b/docs/smbdotconf/filename/vetofiles.xml index 637e82449f..48e0c40fff 100644 --- a/docs/smbdotconf/filename/vetofiles.xml +++ b/docs/smbdotconf/filename/vetofiles.xml @@ -3,34 +3,36 @@ 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> + 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 <smbconfoption name="case sensitive"/> option - is applicable in vetoing files.</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> + 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> + 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: -<screen> +<programlisting> ; Veto any files containing the word Security, ; any ending in .tmp, and any directory containing the ; word root. @@ -39,7 +41,7 @@ veto files = /*Security*/*.tmp/*root*/ ; Veto the Apple specific files that a NetAtalk server ; creates. veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ -</screen> +</programlisting> </para> </description> diff --git a/docs/smbdotconf/filename/vetooplockfiles.xml b/docs/smbdotconf/filename/vetooplockfiles.xml index b5ef0df5a6..b99ab00385 100644 --- a/docs/smbdotconf/filename/vetooplockfiles.xml +++ b/docs/smbdotconf/filename/vetooplockfiles.xml @@ -3,28 +3,29 @@ type="string" xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> - <para>This parameter is only valid when the - <smbconfoption name="oplocks"/> + <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> + <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> + 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: -<screen> +<programlisting> veto oplock files = /.*SEM/ -</screen> +</programlisting> </para> </description> <value type="default"><comment>No files are vetoed for oplock grants</comment></value> |