Standardised on 'var = value' when referencing smb.conf parameters, rather
authorTim Potter <tpot@samba.org>
Tue, 11 Sep 2001 05:19:10 +0000 (05:19 +0000)
committerTim Potter <tpot@samba.org>
Tue, 11 Sep 2001 05:19:10 +0000 (05:19 +0000)
than 'var=value'.

Fixed up some dodgy quoting on the way.
(This used to be commit 0606c194d6e3aba0c1aac883fe04e0c6e9e9a578)

docs/docbook/manpages/smb.conf.5.sgml

index 08938fa153216bc05eade35f52e7ffce587c7ec4..ea32a05c67b7737e9c57b9f895b5a06b3dc6eef2 100644 (file)
@@ -92,7 +92,7 @@
        <para>Sections other than guest services will require a password 
        to access them. The client provides the username. As older clients 
        only provide passwords and not usernames, you may specify a list 
-       of usernames to check against the password using the "user=" 
+       of usernames to check against the password using the "user =" 
        option in the share definition. For modern clients such as 
        Windows 95/98/ME/NT/2000, this should not be necessary.</para>
 
                the user's home directory.</para></listitem>
                </itemizedlist>
 
-               <para>If you decide to use a <emphasis>path=</emphasis> line 
+               <para>If you decide to use a <emphasis>path =</emphasis> line 
                in your [homes] section then you may find it useful 
                to use the %S macro. For example :</para>
 
-               <para><userinput>path=/data/pchome/%S</userinput></para>
+               <para><userinput>path = /data/pchome/%S</userinput></para>
 
                <para>would be useful if you have different home directories 
                for your PCs than for UNIX access.</para>
                <para>Note that the <emphasis>browseable</emphasis> flag for 
                auto home directories will be inherited from the global browseable 
                flag, not the [homes] browseable flag. This is useful as 
-               it means setting browseable=no in the [homes] section 
-               will hide the [homes] share but make any auto home 
-               directories visible.</para>
+               it means setting <emphasis>browseable = no</emphasis> in
+               the [homes] section will hide the [homes] share but make
+               any auto home directories visible.</para>
        </refsect2>
        
        <refsect2>
        <variablelist>
        
        <varlistentry>
-               <term>mangle case= yes/no</term>
+               <term>mangle case = yes/no</term>
                <listitem><para> controls if names that have characters that 
                aren't of the "default" case are mangled. For example, 
                if this is yes then a name like "Mail" would be mangled. 
                <filename>smb.conf</filename> file for the service and the client 
                has supplied a password, and that password matches (according to 
                the UNIX system's password checking) with one of the usernames 
-               from the "user=" field then the connection is made as 
-               the username in the "user=" line. If one 
-               of the username in the "user=" list begins with a
+               from the "user =" field then the connection is made as 
+               the username in the "user =" line. If one 
+               of the username in the "user =" list begins with a
                '@' then that name expands to a list of names in 
                the group of the same name.</para></listitem>
 
                <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.</para>
 
                <para>In order to use this option, <ulink url="smbd.8.html">smbd</ulink> 
-               must be set to <parameter>security=server</parameter> or <parameter>
-               security=domain</parameter> and <parameter>add user script</parameter>
+               must be set to <parameter>security = server</parameter> or <parameter>
+               security = domain</parameter> and <parameter>add user script</parameter>
                must be set to a full pathname for a script that will create a UNIX 
                user given one argument of <parameter>%u</parameter>, which expands into 
                the UNIX user name to create.</para>
                <para>See also the <link linkend="FORCECREATEMODE"><parameter>force 
                create mode</parameter></link> parameter for forcing particular mode 
                bits to be set on created files. See also the <link linkend="DIRECTORYMODE">
-               <parameter>directory mode"</parameter></link> parameter for masking 
+               <parameter>directory mode</parameter></link> parameter for masking 
                mode bits on created directories.  See also the <link linkend="INHERITPERMISSIONS">
                <parameter>inherit permissions</parameter></link> parameter.</para>
 
                <term><anchor id="DEFAULTCASE">default case (S)</term>
                <listitem><para>See the section on <link linkend="NAMEMANGLINGSECT">
                NAME MANGLING</link>. Also note the <link linkend="SHORTPRESERVECASE">
-               <parameter>short preserve case"</parameter></link> parameter.</para>
+               <parameter>short preserve case</parameter></link> parameter.</para>
 
                <para>Default: <command>default case = lower</command></para>
                </listitem>
                Windows NT user no longer exists.</para>
                
                <para>In order to use this option, <command>smbd</command> must be 
-               set to <parameter>security=domain</parameter> and <parameter>delete 
+               set to <parameter>security = domain</parameter> and <parameter>delete 
                user script</parameter> must be set to a full pathname for a script 
                that will delete a UNIX user given one argument of <parameter>%u
                </parameter>, which expands into the UNIX user name to delete.
                <emphasis>NOTE</emphasis> that this is different to the <link
                linkend="ADDUSERSCRIPT"><parameter>add user script</parameter></link>
-               which will work with the <parameter>security=server</parameter> option 
-               as well as <parameter>security=domain</parameter>. The reason for this
+               which will work with the <parameter>security = server</parameter> option 
+               as well as <parameter>security = domain</parameter>. The reason for this
                is only when Samba is a domain member does it get the information
                on an attempted user logon that a user no longer exists. In the
-               <parameter>security=server</parameter> mode a missing user
+               <parameter>security = server</parameter> mode a missing user
                is treated the same as an invalid password logon attempt. Deleting
                the user in this circumstance would not be a good idea.</para>
 
                UNIX users are dynamically deleted to match existing Windows NT 
                accounts.</para>
 
-               <para>See also <link linkend="SECURITYEQUALSDOMAIN">security=domain</link>,
+               <para>See also <link linkend="SECURITYEQUALSDOMAIN">security = domain</link>,
                <link linkend="PASSWORDSERVER"><parameter>password server</parameter>
                </link>, <link linkend="ADDUSERSCRIPT"><parameter>add user script</parameter>
                </link>.</para>
                </filename></ulink> file (see the <ulink url="smbpasswd.8.html"><command>
                smbpasswd(8)</command></ulink> program for information on how to set up 
                and maintain this file), or set the <link
-               linkend="SECURITY">security=[serve|domain]</link> parameter which 
+               linkend="SECURITY">security = [server|domain]</link> parameter which 
                causes <command>smbd</command> to authenticate against another 
                server.</para>
                
 
                <para>If a <parameter>%p</parameter> is given then the printername 
                is put in its place. A <parameter>%j</parameter> is replaced with 
-               the job number (an integer).  On HPUX (see <parameter>printing=hpux
+               the job number (an integer).  On HPUX (see <parameter>printing = hpux
                </parameter>), if the <parameter>-p%p</parameter> option is added 
                to the lpq command, the job will show up with the correct status, i.e. 
                if the job priority is lower than the set fence priority it will 
                <varlistentry>
                <term><anchor id="MACHINEPASSWORDTIMEOUT">machine password timeout (G)</term>
                <listitem><para>If a Samba server is a member of an Windows 
-               NT Domain (see the <link linkend="SECURITYEQUALSDOMAIN">security=domain</link>) 
+               NT Domain (see the <link linkend="SECURITYEQUALSDOMAIN">security = domain</link>) 
                parameter) then periodically a running <ulink url="smbd.8.html">
                smbd(8)</ulink> process will try and change the MACHINE ACCOUNT 
                PASSWORD stored in the TDB called <filename>private/secrets.tdb
 
                <para>See also <ulink url="smbpasswd.8.html"><command>smbpasswd(8)
                </command></ulink>, and the <link linkend="SECURITYEQUALSDOMAIN">
-               security=domain</link>) parameter.</para>
+               security = domain</link>) parameter.</para>
 
                <para>Default: <command>machine password timeout = 604800</command></para>
                </listitem>
                <varlistentry>
                <term><anchor id="MAPTOGUEST">map to guest (G)</term>
                <listitem><para>This parameter is only useful in <link linkend="SECURITY">
-               security</link> modes other than <parameter>security=share</parameter> 
+               security</link> modes other than <parameter>security = share</parameter> 
                - i.e. <constant>user</constant>, <constant>server</constant>, 
                and <constant>domain</constant>.</para>
 
                <term><anchor id="MAXWINSTTL">max wins ttl (G)</term>
                <listitem><para>This option tells <ulink url="nmbd.8.html">nmbd(8)
                </ulink> when acting as a WINS server (<link linkend="WINSSUPPORT">
-               <parameter>wins support=yes</parameter></link>) what the maximum
+               <parameter>wins support = yes</parameter></link>) what the maximum
                'time to live' of NetBIOS names that <command>nmbd</command> 
                will grant will be (in seconds). You should never need to change this
                parameter.  The default is 6 days (518400 seconds).</para>
 
                <para>See also the <link linkend="MINWINSTTL"><parameter>min 
-               wins ttl"</parameter></link> parameter.</para>
+               wins ttl</parameter></link> parameter.</para>
 
                <para>Default: <command>max wins ttl = 518400</command></para>
                </listitem>
                        <command>smbd</command> makes a connection to a password server, 
                        and then the password server fails, no more users will be able 
                        to be authenticated from this <command>smbd</command>.  This is a 
-                       restriction of the SMB/CIFS protocol when in <command>security=server
+                       restriction of the SMB/CIFS protocol when in <command>security = server
                        </command> mode and cannot be fixed in Samba.</para></listitem>
 
                        <listitem><para>If you are using a Windows NT server as your 
                        password server then you will have to ensure that your users 
                        are able to login from the Samba server, as when in <command>
-                       security=server</command>  mode the network logon will appear to 
+                       security = server</command>  mode the network logon will appear to 
                        come from there rather than from the users workstation.</para></listitem>
                </itemizedlist>
 
                the parameter varies depending on the setting of the <link linkend="PRINTING">
                <parameter>printing</parameter></link> parameter.</para>
 
-               <para>Default: For <command>printing= BSD, AIX, QNX, LPRNG 
+               <para>Default: For <command>printing = BSD, AIX, QNX, LPRNG 
                or PLP :</command></para>
                <para><command>print command = lpr -r -P%p %s</command></para>
 
-               <para>For <command>printing= SYS or HPUX :</command></para>
+               <para>For <command>printing = SYS or HPUX :</command></para>
                <para><command>print command = lp -c -d%p %s; rm %s</command></para>
 
-               <para>For <command>printing=SOFTQ :</command></para>
+               <para>For <command>printing = SOFTQ :</command></para>
                <para><command>print command = lp -d%p -s %s; rm %s</command></para>
 
                <para>Example: <command>print command = /usr/local/samba/bin/myprintscript
                Windows NT.</para>
 
                <para>The alternatives are <command>security = share</command>,
-               <command>security = server</command> or <command>security=domain
+               <command>security = server</command> or <command>security = domain
                </command>.</para>
 
                <para>In versions of Samba prior to 2..0, the default was 
                </emphasis></para>
 
                <para>This is the default security setting in Samba 2.2. 
-               With user-level security a client must first "log=on" with a 
+               With user-level security a client must first "log-on" with a 
                valid username and password (which can be mapped using the <link
                linkend="USERNAMEMAP"><parameter>username map</parameter></link> 
                parameter). Encrypted passwords (see the <link linkend="ENCRYPTPASSWORDS">
                <term><anchor id="SERVERSTRING">server string (G)</term>
                <listitem><para>This controls what string will show up in the 
                printer comment box in print manager and next to the IPC connection 
-               in <command>net view"</command>. It can be any string that you wish 
+               in <command>net view</command>. It can be any string that you wish 
                to show to your users.</para>
                
                <para>It also sets what will appear in browse lists next 
                or disable the option, by default they will be enabled if you 
                don't specify 1 or 0.</para>
 
-               <para>To specify an argument use the syntax SOME_OPTION=VALUE 
-               for example <command>SO_SNDBUF=8192</command>. Note that you must 
+               <para>To specify an argument use the syntax SOME_OPTION = VALUE 
+               for example <command>SO_SNDBUF = 8192</command>. Note that you must 
                not have any spaces before or after the = sign.</para>
 
                <para>If you are on a local network then a sensible option 
                be formatted as the output of the standard Unix <command>env(1)
                </command> command. This is of the form :</para>
                <para>Example environment entry:</para>
-               <para><command>SAMBA_NETBIOS_NAME=myhostname</command></para>
+               <para><command>SAMBA_NETBIOS_NAME = myhostname</command></para>
 
                <para>Default: <emphasis>No default value</emphasis></para>
                <para>Examples: <command>source environment = |/etc/smb.conf.sh
                <parameter>ssl hosts resign</parameter></link> whether an SSL 
                connection will be required.</para>
 
-               <para>Default: <command>ssl=no</command></para>
+               <para>Default: <command>ssl = no</command></para>
                </listitem>
                </varlistentry>
 
                <listitem><para>This controls what workgroup your server will 
                appear to be in when queried by clients. Note that this parameter 
                also controls the Domain name used with the <link 
-               linkend="SECURITYEQUALSDOMAIN"><command>security=domain</command></link>
+               linkend="SECURITYEQUALSDOMAIN"><command>security = domain</command></link>
                setting.</para>
 
                <para>Default: <emphasis>set at compile time to WORKGROUP</emphasis></para>