Final bits of smb.conf(5) are converted!
authorAlexander Bokovoy <ab@samba.org>
Tue, 15 Apr 2003 11:46:16 +0000 (11:46 +0000)
committerAlexander Bokovoy <ab@samba.org>
Tue, 15 Apr 2003 11:46:16 +0000 (11:46 +0000)
docs/docbook/smbdotconf/misc/deletereadonly.xml
docs/docbook/smbdotconf/misc/dosfilemode.xml
docs/docbook/smbdotconf/misc/dosfiletimeresolution.xml
docs/docbook/smbdotconf/misc/dosfiletimes.xml
docs/docbook/smbdotconf/misc/fakedirectorycreatetimes.xml
docs/docbook/smbdotconf/misc/hidelocalusers.xml
docs/docbook/smbdotconf/misc/magicoutput.xml
docs/docbook/smbdotconf/misc/magicscript.xml
docs/docbook/smbdotconf/misc/panicaction.xml

index 8e86b5b00b83d1d2c1b495303907d7451c0c621c..cfffceedcbb9426f9bfdbeb1a1ed5fff5a2be6fb 100644 (file)
@@ -1,11 +1,14 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
-               <term><anchor id="DELETEREADONLY"/>delete readonly (S)</term>
-               <listitem><para>This parameter allows readonly files to be deleted.  
-               This is not normal DOS semantics, but is allowed by UNIX.</para>
+<samba:parameter name="delete readonly"
+                context="S"
+                xmlns:samba="http://samba.org/common">
+<listitem>
+       <para>This parameter allows readonly files to be deleted.  
+       This is not normal DOS semantics, but is allowed by UNIX.</para>
                
-               <para>This option may be useful for running applications such 
-               as rcs, where UNIX file ownership prevents changing file 
-               permissions, and DOS semantics prevent deletion of a read only file.</para>
+       <para>This option may be useful for running applications such 
+       as rcs, where UNIX file ownership prevents changing file 
+       permissions, and DOS semantics prevent deletion of a read only file.</para>
 
-               <para>Default: <command moreinfo="none">delete readonly = no</command></para></listitem>
-               </samba:parameter>
+       <para>Default: <command moreinfo="none">delete readonly = no</command></para>
+</listitem>
+</samba:parameter>
index e8aec3b78d7e5488948b04dd60bf5459a2a20621..2628dc45b0db1744b4723fb30af248f322ed7698 100644 (file)
@@ -1,16 +1,18 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
-               <term><anchor id="DOSFILEMODE"/>dos filemode (S)</term>
-               <listitem><para> The default behavior in Samba is to provide 
-               UNIX-like behavior where only the owner of a file/directory is 
-               able to change the permissions on it.  However, this behavior
-               is often confusing to  DOS/Windows users.  Enabling this parameter 
-               allows a user who has write access to the file (by whatever 
-               means) to modify the permissions on it.  Note that a user
-               belonging to the group owning the file will not be allowed to
-               change permissions if the group is only granted read access.
-               Ownership of the file/directory is not changed, only the permissions 
-               are modified.</para>
+<samba:parameter name="dos filemode"
+                context="S"
+                xmlns:samba="http://samba.org/common">
+<listitem>
+       <para> The default behavior in Samba is to provide 
+       UNIX-like behavior where only the owner of a file/directory is 
+       able to change the permissions on it.  However, this behavior
+       is often confusing to  DOS/Windows users.  Enabling this parameter 
+       allows a user who has write access to the file (by whatever 
+       means) to modify the permissions on it.  Note that a user
+       belonging to the group owning the file will not be allowed to
+       change permissions if the group is only granted read access.
+       Ownership of the file/directory is not changed, only the permissions 
+       are modified.</para>
                
-               <para>Default: <command moreinfo="none">dos filemode = no</command></para>
-               </listitem>
-               </samba:parameter>
+       <para>Default: <command moreinfo="none">dos filemode = no</command></para>
+</listitem>
+</samba:parameter>
index bc82582c87be550097ee673aac71a8db79e1b0ce..600294d4428157103070a86af7d9bd34f04aae8a 100644 (file)
@@ -1,23 +1,25 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
-               <term><anchor id="DOSFILETIMERESOLUTION"/>dos filetime resolution (S)</term>
-               <listitem><para>Under the DOS and Windows FAT filesystem, the finest 
-               granularity on time resolution is two seconds. Setting this parameter 
-               for a share causes Samba to round the reported time down to the 
-               nearest two second boundary when a query call that requires one second 
-               resolution is made to <citerefentry><refentrytitle>smbd</refentrytitle>
-               <manvolnum>8</manvolnum></citerefentry>.</para>
+<samba:parameter name="dos filetime resolution"
+                context="S"
+                xmlns:samba="http://samba.org/common">
+<listitem>
+       <para>Under the DOS and Windows FAT filesystem, the finest 
+       granularity on time resolution is two seconds. Setting this parameter 
+       for a share causes Samba to round the reported time down to the 
+       nearest two second boundary when a query call that requires one second 
+       resolution is made to <citerefentry><refentrytitle>smbd</refentrytitle>
+       <manvolnum>8</manvolnum></citerefentry>.</para>
 
-               <para>This option is mainly used as a compatibility option for Visual 
-               C++ when used against Samba shares. If oplocks are enabled on a 
-               share, Visual C++ uses two different time reading calls to check if a 
-               file has changed since it was last read. One of these calls uses a
-               one-second granularity, the other uses a two second granularity. As
-               the two second call rounds any odd second down, then if the file has a
-               timestamp of an odd number of seconds then the two timestamps will not
-               match and Visual C++ will keep reporting the file has changed. Setting
-               this option causes the two timestamps to match, and Visual C++ is
-               happy.</para>
+       <para>This option is mainly used as a compatibility option for Visual 
+       C++ when used against Samba shares. If oplocks are enabled on a 
+       share, Visual C++ uses two different time reading calls to check if a 
+       file has changed since it was last read. One of these calls uses a
+       one-second granularity, the other uses a two second granularity. As
+       the two second call rounds any odd second down, then if the file has a
+       timestamp of an odd number of seconds then the two timestamps will not
+       match and Visual C++ will keep reporting the file has changed. Setting
+       this option causes the two timestamps to match, and Visual C++ is
+       happy.</para>
 
-               <para>Default: <command moreinfo="none">dos filetime resolution = no</command></para>
-               </listitem>
-               </samba:parameter>
+       <para>Default: <command moreinfo="none">dos filetime resolution = no</command></para>
+</listitem>
+</samba:parameter>
index d9b9f3b08b84063d0bf565577e426bfe3fef4a41..a201d2d8322c5304317e029eaa11f747b8fbc640 100644 (file)
@@ -1,14 +1,17 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
-               <term><anchor id="DOSFILETIMES"/>dos filetimes (S)</term>
-               <listitem><para>Under DOS and Windows, if a user can write to a 
-               file they can change the timestamp on it. Under POSIX semantics, 
-               only the owner of the file or root may change the timestamp. By 
-               default, Samba runs with POSIX semantics and refuses to change the 
-               timestamp on a file if the user <command moreinfo="none">smbd</command> is acting 
-               on behalf of is not the file owner. Setting this option to <constant>
-               yes</constant> allows DOS semantics and <citerefentry><refentrytitle>smbd</refentrytitle>
-               <manvolnum>8</manvolnum></citerefentry> will change the file 
-               timestamp as DOS requires.</para>
+<samba:parameter name="dos filetimes"
+                context="S"
+                xmlns:samba="http://samba.org/common">
+<listitem>
+       <para>Under DOS and Windows, if a user can write to a 
+       file they can change the timestamp on it. Under POSIX semantics, 
+       only the owner of the file or root may change the timestamp. By 
+       default, Samba runs with POSIX semantics and refuses to change the 
+       timestamp on a file if the user <command moreinfo="none">smbd</command> is acting 
+       on behalf of is not the file owner. Setting this option to <constant>
+       yes</constant> allows DOS semantics and <citerefentry><refentrytitle>smbd</refentrytitle>
+       <manvolnum>8</manvolnum></citerefentry> will change the file 
+       timestamp as DOS requires.</para>
 
-               <para>Default: <command moreinfo="none">dos filetimes = no</command></para></listitem>
-               </samba:parameter>
+       <para>Default: <command moreinfo="none">dos filetimes = no</command></para>
+</listitem>
+</samba:parameter>
index 81773606ee02a49948e5cb4f71cd85a8d4b07db5..f0a0d392307d05ac67f5b1b90992a85686d18da4 100644 (file)
@@ -1,31 +1,33 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
-               <term><anchor id="FAKEDIRECTORYCREATETIMES"/>fake directory create times (S)</term>
-               <listitem><para>NTFS and Windows VFAT file systems keep a create 
-               time for all files and directories. This is not the same as the 
-               ctime - status change time - that Unix keeps, so Samba by default 
-               reports the earliest of the various times Unix does keep. Setting 
-               this parameter for a share causes Samba to always report midnight 
-               1-1-1980 as the create time for directories.</para>
+<samba:parameter name="fake directory create times"
+                context="S"
+                xmlns:samba="http://samba.org/common">
+<listitem>
+       <para>NTFS and Windows VFAT file systems keep a create 
+       time for all files and directories. This is not the same as the 
+       ctime - status change time - that Unix keeps, so Samba by default 
+       reports the earliest of the various times Unix does keep. Setting 
+       this parameter for a share causes Samba to always report midnight 
+       1-1-1980 as the create time for directories.</para>
 
-               <para>This option is mainly used as a compatibility option for 
-               Visual C++ when used against Samba shares. Visual C++ generated 
-               makefiles have the object directory as a dependency for each object 
-               file, and a make rule to create the directory. Also, when NMAKE 
-               compares timestamps it uses the creation time when examining a 
-               directory. Thus the object directory will be created if it does not 
-               exist, but once it does exist it will always have an earlier 
-               timestamp than the object files it contains.</para>
+       <para>This option is mainly used as a compatibility option for 
+       Visual C++ when used against Samba shares. Visual C++ generated 
+       makefiles have the object directory as a dependency for each object 
+       file, and a make rule to create the directory. Also, when NMAKE 
+       compares timestamps it uses the creation time when examining a 
+       directory. Thus the object directory will be created if it does not 
+       exist, but once it does exist it will always have an earlier 
+       timestamp than the object files it contains.</para>
 
-               <para>However, Unix time semantics mean that the create time 
-               reported by Samba will be updated whenever a file is created or 
-               or deleted in the directory.  NMAKE finds all object files in 
-               the object directory.  The timestamp of the last one built is then 
-               compared to the timestamp of the object directory.  If the 
-               directory's timestamp if newer, then all object files
-               will be rebuilt.  Enabling this option 
-               ensures directories always predate their contents and an NMAKE build 
-               will proceed as expected.</para>
+       <para>However, Unix time semantics mean that the create time 
+       reported by Samba will be updated whenever a file is created or 
+       or deleted in the directory.  NMAKE finds all object files in 
+       the object directory.  The timestamp of the last one built is then 
+       compared to the timestamp of the object directory.  If the 
+       directory's timestamp if newer, then all object files
+       will be rebuilt.  Enabling this option 
+       ensures directories always predate their contents and an NMAKE build 
+       will proceed as expected.</para>
 
-               <para>Default: <command moreinfo="none">fake directory create times = no</command></para>
-               </listitem>
-               </samba:parameter>
+       <para>Default: <command moreinfo="none">fake directory create times = no</command></para>
+</listitem>
+</samba:parameter>
index d0468ead6b74a5e6e60bb0bf558e9377f70751c0..18a1c817c1697e83f0624c3ad887fdb9746337c7 100644 (file)
@@ -1,7 +1,11 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
-               <term><anchor id="HIDELOCALUSERS"/>hide local users(G)</term>
-               <listitem><para>This parameter toggles the hiding of local UNIX 
-               users (root, wheel, floppy, etc) from remote clients.</para>
+<samba:parameter name="hide local users"
+                context="G"
+                advanced="1" developer="1"
+                xmlns:samba="http://samba.org/common">
+<listitem>
+       <para>This parameter toggles the hiding of local UNIX 
+       users (root, wheel, floppy, etc) from remote clients.</para>
 
-               <para>Default: <command moreinfo="none">hide local users = no</command></para></listitem>
-               </samba:parameter>
+       <para>Default: <command moreinfo="none">hide local users = no</command></para>
+</listitem>
+</samba:parameter>
index 8208d5bd4c6ca354fd6758c546b8d0e98e69a4fb..c321f12b99c28a1bd22d9beaae6ac2e75395fa77 100644 (file)
@@ -1,17 +1,18 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
-               <term><anchor id="MAGICOUTPUT"/>magic output (S)</term>
-               <listitem><para>This parameter specifies the name of a file 
-               which will contain output created by a magic script (see the 
-               <link linkend="MAGICSCRIPT"><parameter moreinfo="none">magic script</parameter></link>
-               parameter below).</para>
+<samba:parameter name="magic output"
+                context="S"
+                xmlns:samba="http://samba.org/common">
+<listitem>
+       <para>This parameter specifies the name of a file 
+       which will contain output created by a magic script (see the 
+       <link linkend="MAGICSCRIPT"><parameter moreinfo="none">magic script</parameter></link>
+       parameter below).</para>
 
-               <para>Warning: If two clients use the same <parameter moreinfo="none">magic script
-               </parameter> in the same directory the output file content
-               is undefined.</para>
+       <para>Warning: If two clients use the same <parameter moreinfo="none">magic script
+       </parameter> in the same directory the output file content
+       is undefined.</para>
 
-               <para>Default: <command moreinfo="none">magic output = &lt;magic script name&gt;.out
-               </command></para>
+       <para>Default: <command moreinfo="none">magic output = &lt;magic script name&gt;.out</command></para>
 
-               <para>Example: <command moreinfo="none">magic output = myfile.txt</command></para>
-               </listitem>
-               </samba:parameter>
+       <para>Example: <command moreinfo="none">magic output = myfile.txt</command></para>
+</listitem>
+</samba:parameter>
index 73abb50fc522b5db8e9c62b0b67b6442482575aa..67f39d918e84e5540f8e38bdef6cd1a285580cc3 100644 (file)
@@ -1,28 +1,31 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
-               <term><anchor id="MAGICSCRIPT"/>magic script (S)</term>
-               <listitem><para>This parameter specifies the name of a file which, 
-               if opened, will be executed by the server when the file is closed. 
-               This allows a UNIX script to be sent to the Samba host and 
-               executed on behalf of the connected user.</para>
+<samba:parameter name="magic script"
+                context="S"
+                xmlns:samba="http://samba.org/common">
+<listitem>
+       <para>This parameter specifies the name of a file which, 
+       if opened, will be executed by the server when the file is closed. 
+       This allows a UNIX script to be sent to the Samba host and 
+       executed on behalf of the connected user.</para>
 
-               <para>Scripts executed in this way will be deleted upon 
-               completion assuming that the user has the appropriate level 
-               of privilege and the file permissions allow the deletion.</para>
+       <para>Scripts executed in this way will be deleted upon 
+       completion assuming that the user has the appropriate level 
+       of privilege and the file permissions allow the deletion.</para>
 
-               <para>If the script generates output, output will be sent to 
-               the file specified by the <link linkend="MAGICOUTPUT"><parameter moreinfo="none">
-               magic output</parameter></link> parameter (see above).</para>
+       <para>If the script generates output, output will be sent to 
+       the file specified by the <link linkend="MAGICOUTPUT"><parameter moreinfo="none">
+       magic output</parameter></link> parameter (see above).</para>
 
-               <para>Note that some shells are unable to interpret scripts 
-               containing CR/LF instead of CR as 
-               the end-of-line marker. Magic scripts must be executable 
-               <emphasis>as is</emphasis> on the host, which for some hosts and 
-               some shells will require filtering at the DOS end.</para>
+       <para>Note that some shells are unable to interpret scripts 
+       containing CR/LF instead of CR as 
+       the end-of-line marker. Magic scripts must be executable 
+       <emphasis>as is</emphasis> on the host, which for some hosts and 
+       some shells will require filtering at the DOS end.</para>
 
-               <para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and 
-               should <emphasis>NOT</emphasis> be relied upon.</para>
+       <para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and 
+       should <emphasis>NOT</emphasis> be relied upon.</para>
 
-               <para>Default: <emphasis>None. Magic scripts disabled.</emphasis></para>
-               <para>Example: <command moreinfo="none">magic script = user.csh</command></para>
-               </listitem>
-               </samba:parameter>
+       <para>Default: <emphasis>None. Magic scripts disabled.</emphasis></para>
+
+       <para>Example: <command moreinfo="none">magic script = user.csh</command></para>
+</listitem>
+</samba:parameter>
index 6de37c2c175a72875fe0f7c494e6a166865dc739..04b7aab8c8cb194c5157444781c4590a367bd21b 100644 (file)
@@ -1,12 +1,16 @@
-<samba:parameter xmlns:samba="http://samba.org/common">
-               <term><anchor id="PANICACTION"/>panic action (G)</term>
-               <listitem><para>This is a Samba developer option that allows a 
-               system command to be called when either <citerefentry><refentrytitle>smbd</refentrytitle>
-               <manvolnum>8</manvolnum></citerefentry> or <citerefentry><refentrytitle>smbd</refentrytitle>
-               <manvolnum>8</manvolnum></citerefentry> crashes. This is usually used to 
-               draw attention to the fact that a problem occurred.</para>
+<samba:parameter name="panic action"
+                context="G"
+                advanced="1" developer="1"
+                xmlns:samba="http://samba.org/common">
+<listitem>
+       <para>This is a Samba developer option that allows a 
+       system command to be called when either <citerefentry><refentrytitle>smbd</refentrytitle>
+       <manvolnum>8</manvolnum></citerefentry> or <citerefentry><refentrytitle>smbd</refentrytitle>
+       <manvolnum>8</manvolnum></citerefentry> crashes. This is usually used to 
+       draw attention to the fact that a problem occurred.</para>
 
-               <para>Default: <command moreinfo="none">panic action = &lt;empty string&gt;</command></para>
-               <para>Example: <command moreinfo="none">panic action = &quot;/bin/sleep 90000&quot;</command></para>
-               </listitem>
-               </samba:parameter>
+       <para>Default: <command moreinfo="none">panic action = &lt;empty string&gt;</command></para>
+
+       <para>Example: <command moreinfo="none">panic action = &quot;/bin/sleep 90000&quot;</command></para>
+</listitem>
+</samba:parameter>