Make --with-ldapsam 'go away'. This is now a standard, stable, feature
[kai/samba.git] / docs / docbook / manpages / smb.conf.5.sgml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2 <refentry id="smb.conf">
3
4 <refmeta>
5         <refentrytitle>smb.conf</refentrytitle>
6         <manvolnum>5</manvolnum>
7 </refmeta>
8
9
10 <refnamediv>
11         <refname>smb.conf</refname>
12         <refpurpose>The configuration file for the Samba suite</refpurpose>
13 </refnamediv>
14
15 <refsect1>
16         <title>SYNOPSIS</title>
17
18         <para>The <filename>smb.conf</filename> file is a configuration 
19         file for the Samba suite. <filename>smb.conf</filename> contains 
20         runtime configuration information for the Samba programs. The
21         <filename>smb.conf</filename> file is designed to be configured and 
22         administered by the <ulink url="swat.8.html"><command>swat(8)</command>
23         </ulink> program. The complete description of the file format and 
24         possible parameters held within are here for reference purposes.</para>
25 </refsect1>
26
27 <refsect1>
28         <title id="FILEFORMATSECT">FILE FORMAT</title>
29
30         <para>The file consists of sections and parameters. A section 
31         begins with the name of the section in square brackets and continues 
32         until the next section begins. Sections contain parameters of the 
33         form</para>
34
35         <para><replaceable>name</replaceable> = <replaceable>value
36         </replaceable></para>
37
38         <para>The file is line-based - that is, each newline-terminated 
39         line represents either a comment, a section name or a parameter.</para>
40
41         <para>Section and parameter names are not case sensitive.</para>
42
43         <para>Only the first equals sign in a parameter is significant. 
44         Whitespace before or after the first equals sign is discarded.
45         Leading, trailing and internal whitespace in section and parameter 
46         names is irrelevant. Leading and trailing whitespace in a parameter 
47         value is discarded. Internal whitespace within a parameter value 
48         is retained verbatim.</para>
49
50         <para>Any line beginning with a semicolon (';') or a hash ('#') 
51         character is ignored, as are lines containing only whitespace.</para>
52
53         <para>Any line ending in a '\' is continued
54         on the next line in the customary UNIX fashion.</para>
55
56         <para>The values following the equals sign in parameters are all 
57         either a string (no quotes needed) or a boolean, which may be given 
58         as yes/no, 0/1 or true/false. Case is not significant in boolean 
59         values, but is preserved in string values. Some items such as 
60         create modes are numeric.</para>
61 </refsect1>
62
63 <refsect1>
64         <title>SECTION DESCRIPTIONS</title>
65
66         <para>Each section in the configuration file (except for the
67         [global] section) describes a shared resource (known
68         as a "share"). The section name is the name of the 
69         shared resource and the parameters within the section define 
70         the shares attributes.</para>
71
72         <para>There are three special sections, [global],
73         [homes] and [printers], which are
74         described under <emphasis>special sections</emphasis>. The
75         following notes apply to ordinary section descriptions.</para>
76
77         <para>A share consists of a directory to which access is being 
78         given plus a description of the access rights which are granted 
79         to the user of the service. Some housekeeping options are 
80         also specifiable.</para>
81         
82         <para>Sections are either file share services (used by the 
83         client as an extension of their native file systems) or 
84         printable services (used by the client to access print services 
85         on the host running the server).</para>
86         
87         <para>Sections may be designated <emphasis>guest</emphasis> services,
88         in which case no password is required to access them. A specified 
89         UNIX <emphasis>guest account</emphasis> is used to define access
90         privileges in this case.</para>
91
92         <para>Sections other than guest services will require a password 
93         to access them. The client provides the username. As older clients 
94         only provide passwords and not usernames, you may specify a list 
95         of usernames to check against the password using the "user =" 
96         option in the share definition. For modern clients such as 
97         Windows 95/98/ME/NT/2000, this should not be necessary.</para>
98
99         <para>Note that the access rights granted by the server are 
100         masked by the access rights granted to the specified or guest 
101         UNIX user by the host system. The server does not grant more
102         access than the host system grants.</para>
103         
104         <para>The following sample section defines a file space share. 
105         The user has write access to the path <filename>/home/bar</filename>. 
106         The share is accessed via the share name "foo":</para>
107
108         <screen>
109         <computeroutput>
110         [foo]
111                 path = /home/bar
112                 writeable = true
113         </computeroutput>
114         </screen>
115
116         <para>The following sample section defines a printable share. 
117         The share is readonly, but printable. That is, the only write 
118         access permitted is via calls to open, write to and close a 
119         spool file. The <emphasis>guest ok</emphasis> parameter means 
120         access will be permitted as the default guest user (specified 
121         elsewhere):</para>
122
123         <screen>
124         <computeroutput>
125         [aprinter]
126                 path = /usr/spool/public
127                 writeable = false
128                 printable = true
129                 guest ok = true
130         </computeroutput>
131         </screen>
132 </refsect1>
133
134 <refsect1>
135         <title>SPECIAL SECTIONS</title>
136         
137         <refsect2>
138                 <title>The [global] section</title>
139                 
140                 <para>parameters in this section apply to the server 
141                 as a whole, or are defaults for sections which do not 
142                 specifically define certain items. See the notes
143                 under PARAMETERS for more information.</para>
144         </refsect2>
145         
146         <refsect2>
147                 <title id="HOMESECT">The [homes] section</title>
148                 
149                 <para>If a section called homes is included in the 
150                 configuration file, services connecting clients to their 
151                 home directories can be created on the fly by the server.</para>
152
153                 <para>When the connection request is made, the existing 
154                 sections are scanned. If a match is found, it is used. If no 
155                 match is found, the requested section name is treated as a 
156                 user name and looked up in the local password file. If the 
157                 name exists and the correct password has been given, a share is 
158                 created by cloning the [homes] section.</para>
159                 
160                 <para>Some modifications are then made to the newly 
161                 created share:</para>
162                 
163                 <itemizedlist>
164                 <listitem><para>The share name is changed from homes to 
165                 the located username.</para></listitem>
166
167                 <listitem><para>If no path was given, the path is set to
168                 the user's home directory.</para></listitem>
169                 </itemizedlist>
170
171                 <para>If you decide to use a <emphasis>path =</emphasis> line 
172                 in your [homes] section then you may find it useful 
173                 to use the %S macro. For example :</para>
174
175                 <para><userinput>path = /data/pchome/%S</userinput></para>
176
177                 <para>would be useful if you have different home directories 
178                 for your PCs than for UNIX access.</para>
179
180                 <para>This is a fast and simple way to give a large number 
181                 of clients access to their home directories with a minimum 
182                 of fuss.</para>
183
184                 <para>A similar process occurs if the requested section 
185                 name is "homes", except that the share name is not 
186                 changed to that of the requesting user. This method of using
187                 the [homes] section works well if different users share 
188                 a client PC.</para>
189                 
190                 <para>The [homes] section can specify all the parameters 
191                 a normal service section can specify, though some make more sense 
192                 than others. The following is a typical and suitable [homes]
193                 section:</para>
194
195                 <screen>
196                 <computeroutput>
197                 [homes]
198                         writeable = yes
199                 </computeroutput>
200                 </screen>
201         
202                 <para>An important point is that if guest access is specified 
203                 in the [homes] section, all home directories will be 
204                 visible to all clients <emphasis>without a password</emphasis>. 
205                 In the very unlikely event that this is actually desirable, it 
206                 would be wise to also specify <emphasis>read only
207                 access</emphasis>.</para>
208
209                 <para>Note that the <emphasis>browseable</emphasis> flag for 
210                 auto home directories will be inherited from the global browseable 
211                 flag, not the [homes] browseable flag. This is useful as 
212                 it means setting <emphasis>browseable = no</emphasis> in
213                 the [homes] section will hide the [homes] share but make
214                 any auto home directories visible.</para>
215         </refsect2>
216
217         <refsect2>
218                 <title id="PRINTERSSECT">The [printers] section</title>
219                 
220                 <para>This section works like [homes], 
221                 but for printers.</para>
222
223                 <para>If a [printers] section occurs in the 
224                 configuration file, users are able to connect to any printer 
225                 specified in the local host's printcap file.</para>
226
227                 <para>When a connection request is made, the existing sections 
228                 are scanned. If a match is found, it is used. If no match is found, 
229                 but a [homes] section exists, it is used as described
230                 above. Otherwise, the requested section name is treated as a
231                 printer name and the appropriate printcap file is scanned to see 
232                 if the requested section name is a valid printer share name. If 
233                 a match is found, a new printer share is created by cloning 
234                 the [printers] section.</para>
235
236                 <para>A few modifications are then made to the newly created 
237                 share:</para>
238
239                 <itemizedlist>
240                 <listitem><para>The share name is set to the located printer 
241                 name</para></listitem>
242
243                 <listitem><para>If no printer name was given, the printer name 
244                 is set to the located printer name</para></listitem>
245
246                 <listitem><para>If the share does not permit guest access and 
247                 no username was given, the username is set to the located 
248                 printer name.</para></listitem>
249                 </itemizedlist>
250
251                 <para>Note that the [printers] service MUST be 
252                 printable - if you specify otherwise, the server will refuse 
253                 to load the configuration file.</para>
254                 
255                 <para>Typically the path specified would be that of a 
256                 world-writeable spool directory with the sticky bit set on 
257                 it. A typical [printers] entry would look like 
258                 this:</para>
259
260                 <screen><computeroutput>
261                 [printers]
262                         path = /usr/spool/public
263                         guest ok = yes
264                         printable = yes 
265                 </computeroutput></screen>
266
267                 <para>All aliases given for a printer in the printcap file 
268                 are legitimate printer names as far as the server is concerned. 
269                 If your printing subsystem doesn't work like that, you will have 
270                 to set up a pseudo-printcap. This is a file consisting of one or 
271                 more lines like this:</para>
272
273                 <screen>
274                 <computeroutput>
275                 alias|alias|alias|alias...    
276                 </computeroutput>
277                 </screen>
278
279                 <para>Each alias should be an acceptable printer name for 
280                 your printing subsystem. In the [global] section, specify 
281                 the new file as your printcap.  The server will then only recognize 
282                 names found in your pseudo-printcap, which of course can contain 
283                 whatever aliases you like. The same technique could be used 
284                 simply to limit access to a subset of your local printers.</para>
285
286                 <para>An alias, by the way, is defined as any component of the 
287                 first entry of a printcap record. Records are separated by newlines,
288                 components (if there are more than one) are separated by vertical 
289                 bar symbols ('|').</para>
290                 
291                 <para>NOTE: On SYSV systems which use lpstat to determine what 
292                 printers are defined on the system you may be able to use
293                 "printcap name = lpstat" to automatically obtain a list 
294                 of printers. See the "printcap name" option 
295                 for more details.</para>
296         </refsect2>
297 </refsect1>
298
299 <refsect1>
300         <title>PARAMETERS</title>
301
302         <para>parameters define the specific attributes of sections.</para>
303
304         <para>Some parameters are specific to the [global] section
305         (e.g., <emphasis>security</emphasis>).  Some parameters are usable 
306         in all sections (e.g., <emphasis>create mode</emphasis>). All others 
307         are permissible only in normal sections. For the purposes of the 
308         following descriptions the [homes] and [printers]
309         sections will be considered normal.  The letter <emphasis>G</emphasis> 
310         in parentheses indicates that a parameter is specific to the
311         [global] section. The letter <emphasis>S</emphasis>
312         indicates that a parameter can be specified in a service specific
313         section. Note that all <emphasis>S</emphasis> parameters can also be specified in 
314         the [global] section - in which case they will define
315         the default behavior for all services.</para>
316
317         <para>parameters are arranged here in alphabetical order - this may 
318         not create best bedfellows, but at least you can find them! Where
319         there are synonyms, the preferred synonym is described, others refer 
320         to the preferred synonym.</para>
321 </refsect1>
322
323 <refsect1>
324         <title>VARIABLE SUBSTITUTIONS</title>
325
326         <para>Many of the strings that are settable in the config file 
327         can take substitutions. For example the option "path =
328         /tmp/%u" would be interpreted as "path = 
329         /tmp/john" if the user connected with the username john.</para>
330
331         <para>These substitutions are mostly noted in the descriptions below, 
332         but there are some general substitutions which apply whenever they 
333         might be relevant. These are:</para>
334
335         <variablelist>
336                 <varlistentry>
337                 <term>%S</term>
338                 <listitem><para>the name of the current service, if any.</para>
339                 </listitem>
340                 </varlistentry>
341                 
342                 <varlistentry>
343                 <term>%P</term>
344                 <listitem><para>the root directory of the current service, 
345                 if any.</para></listitem>
346                 </varlistentry>
347                 
348                 <varlistentry>
349                 <term>%u</term>
350                 <listitem><para>user name of the current service, if any.</para>
351                 </listitem>
352                 </varlistentry>
353                 
354                 <varlistentry>
355                 <term>%g</term>
356                 <listitem><para>primary group name of %u.</para></listitem>
357                 </varlistentry>
358                 
359                 <varlistentry>
360                 <term>%U</term>
361                 <listitem><para>session user name (the user name that the client 
362                 wanted, not necessarily the same as the one they got).</para></listitem>
363                 </varlistentry>
364                 
365                 <varlistentry>
366                 <term>%G</term>
367                 <listitem><para>primary group name of %U.</para></listitem>
368                 </varlistentry>
369
370                 <varlistentry>
371                 <term>%H</term>
372                 <listitem><para>the home directory of the user given 
373                 by %u.</para></listitem>
374                 </varlistentry>
375                 
376                 <varlistentry>
377                 <term>%v</term>
378                 <listitem><para>the Samba version.</para></listitem>
379                 </varlistentry>
380                 
381                 <varlistentry>
382                 <term>%h</term>
383                 <listitem><para>the Internet hostname that Samba is running 
384                 on.</para></listitem>
385                 </varlistentry>
386
387                 <varlistentry>
388                 <term>%m</term>
389                 <listitem><para>the NetBIOS name of the client machine 
390                 (very useful).</para></listitem>
391                 </varlistentry>
392                 
393                 <varlistentry>
394                 <term>%L</term>
395                 <listitem><para>the NetBIOS name of the server. This allows you 
396                 to change your config based on what the client calls you. Your 
397                 server can have a "dual personality".</para>
398
399                 <para>Note that this paramater is not available when Samba listens
400                 on port 445, as clients no longer send this information </para>
401                 </listitem>
402
403                 </varlistentry>
404                 
405                 <varlistentry>
406                 <term>%M</term>
407                 <listitem><para>the Internet name of the client machine.
408                 </para></listitem>
409                 </varlistentry>
410                 
411                 <varlistentry>
412                 <term>%N</term>
413                 <listitem><para>the name of your NIS home directory server.  
414                 This is obtained from your NIS auto.map entry.  If you have 
415                 not compiled Samba with the <emphasis>--with-automount</emphasis> 
416                 option then this value will be the same as %L.</para>
417                 </listitem>
418                 </varlistentry>
419                 
420                 <varlistentry>
421                 <term>%p</term>
422                 <listitem><para>the path of the service's home directory, 
423                 obtained from your NIS auto.map entry. The NIS auto.map entry 
424                 is split up as "%N:%p".</para></listitem>
425                 </varlistentry>
426                 
427                 <varlistentry>
428                 <term>%R</term>
429                 <listitem><para>the selected protocol level after 
430                 protocol negotiation. It can be one of CORE, COREPLUS, 
431                 LANMAN1, LANMAN2 or NT1.</para></listitem>
432                 </varlistentry>
433
434                 <varlistentry>
435                 <term>%d</term>
436                 <listitem><para>The process id of the current server
437                 process.</para></listitem>
438                 </varlistentry>
439                 
440                 <varlistentry>
441                 <term>%a</term>
442                 <listitem><para>the architecture of the remote
443                 machine. Only some are recognized, and those may not be 
444                 100% reliable. It currently recognizes Samba, WfWg, Win95,
445                 WinNT and Win2k. Anything else will be known as 
446                 "UNKNOWN". If it gets it wrong then sending a level 
447                 3 log to <ulink url="mailto:samba@samba.org">samba@samba.org
448                 </ulink> should allow it to be fixed.</para></listitem>
449                 </varlistentry>
450                 
451                 <varlistentry>
452                 <term>%I</term>
453                 <listitem><para>The IP address of the client machine.</para>
454                 </listitem>
455                 </varlistentry>
456
457                 <varlistentry>
458                 <term>%T</term>
459                 <listitem><para>the current date and time.</para></listitem>
460                 </varlistentry>
461                 
462                 <varlistentry>
463                 <term>%$(<replaceable>envvar</replaceable>)</term>
464                 <listitem><para>The value of the environment variable
465                 <replaceable>envar</replaceable>.</para></listitem>
466                 </varlistentry>
467         </variablelist>
468
469         <para>There are some quite creative things that can be done 
470         with these substitutions and other smb.conf options.</para
471 </refsect1>
472
473 <refsect1>
474         <title id="NAMEMANGLINGSECT">NAME MANGLING</title>
475         
476         <para>Samba supports "name mangling" so that DOS and 
477         Windows clients can use files that don't conform to the 8.3 format. 
478         It can also be set to adjust the case of 8.3 format filenames.</para>
479
480         <para>There are several options that control the way mangling is 
481         performed, and they are grouped here rather than listed separately. 
482         For the defaults look at the output of the testparm program. </para>
483
484         <para>All of these options can be set separately for each service 
485         (or globally, of course). </para>
486
487         <para>The options are: </para>
488         
489         <variablelist>
490         
491         <varlistentry>
492                 <term>mangle case = yes/no</term>
493                 <listitem><para> controls if names that have characters that 
494                 aren't of the "default" case are mangled. For example, 
495                 if this is yes then a name like "Mail" would be mangled. 
496                 Default <emphasis>no</emphasis>.</para></listitem>
497                 </varlistentry> 
498         
499                 <varlistentry>
500                 <term>case sensitive = yes/no</term>
501                 <listitem><para>controls whether filenames are case sensitive. If 
502                 they aren't then Samba must do a filename search and match on passed 
503                 names. Default <emphasis>no</emphasis>.</para></listitem>
504                 </varlistentry> 
505
506                 <varlistentry>
507                 <term>default case = upper/lower</term>
508                 <listitem><para>controls what the default case is for new 
509                 filenames. Default <emphasis>lower</emphasis>.</para></listitem>
510                 </varlistentry> 
511         
512                 <varlistentry>
513                 <term>preserve case = yes/no</term>
514                 <listitem><para>controls if new files are created with the 
515                 case that the client passes, or if they are forced to be the 
516                 "default" case. Default <emphasis>yes</emphasis>.
517                 </para></listitem>
518                 </varlistentry> 
519
520                 <varlistentry>
521                 <term>short preserve case = yes/no</term>
522                 <listitem><para>controls if new files which conform to 8.3 syntax,
523                 that is all in upper case and of suitable length, are created 
524                 upper case, or if they are forced to be the "default" 
525                 case. This option can be use with "preserve case = yes" 
526                 to permit long filenames to retain their case, while short names 
527                 are lowercased. Default <emphasis>yes</emphasis>.</para></listitem>
528                 </varlistentry> 
529         </variablelist>
530         
531         <para>By default, Samba 2.2 has the same semantics as a Windows 
532         NT server, in that it is case insensitive but case preserving.</para>
533         
534 </refsect1>
535
536 <refsect1>
537         <title id="VALIDATIONSECT">NOTE ABOUT USERNAME/PASSWORD VALIDATION</title>
538
539         <para>There are a number of ways in which a user can connect 
540         to a service. The server uses the following steps in determining 
541         if it will allow a connection to a specified service. If all the 
542         steps fail, then the connection request is rejected.  However, if one of the 
543         steps succeeds, then the following steps are not checked.</para>
544
545         <para>If the service is marked "guest only = yes" and the
546         server is running with share-level security ("security = share")
547         then steps 1 to 5 are skipped.</para>
548
549
550         <orderedlist numeration="Arabic">
551                 <listitem><para>If the client has passed a username/password 
552                 pair and that username/password pair is validated by the UNIX 
553                 system's password programs then the connection is made as that 
554                 username. Note that this includes the 
555                 \\server\service%<replaceable>username</replaceable> method of passing 
556                 a username.</para></listitem>
557
558                 <listitem><para>If the client has previously registered a username 
559                 with the system and now supplies a correct password for that 
560                 username then the connection is allowed.</para></listitem>
561                 
562                 <listitem><para>The client's NetBIOS name and any previously 
563                 used user names are checked against the supplied password, if 
564                 they match then the connection is allowed as the corresponding 
565                 user.</para></listitem>
566                 
567                 <listitem><para>If the client has previously validated a
568                 username/password pair with the server and the client has passed 
569                 the validation token then that username is used. </para></listitem>
570
571                 <listitem><para>If a "user = " field is given in the
572                 <filename>smb.conf</filename> file for the service and the client 
573                 has supplied a password, and that password matches (according to 
574                 the UNIX system's password checking) with one of the usernames 
575                 from the "user =" field then the connection is made as 
576                 the username in the "user =" line. If one 
577                 of the username in the "user =" list begins with a
578                 '@' then that name expands to a list of names in 
579                 the group of the same name.</para></listitem>
580
581                 <listitem><para>If the service is a guest service then a 
582                 connection is made as the username given in the "guest 
583                 account =" for the service, irrespective of the 
584                 supplied password.</para></listitem>
585         </orderedlist>
586
587 </refsect1>
588
589 <refsect1>
590         <title>COMPLETE LIST OF GLOBAL PARAMETERS</title>
591
592         <para>Here is a list of all global parameters. See the section of 
593         each parameter for details.  Note that some are synonyms.</para>
594
595         <itemizedlist>
596                 <listitem><para><link linkend="ABORTSHUTDOWNSCRIPT"><parameter>abort shutdown script</parameter></link></para></listitem>
597                 <listitem><para><link linkend="ADDPRINTERCOMMAND"><parameter>add printer command</parameter></link></para></listitem>
598                 <listitem><para><link linkend="ADDSHARECOMMAND"><parameter>add share command</parameter></link></para></listitem>
599                 <listitem><para><link linkend="ADDUSERSCRIPT"><parameter>add user script</parameter></link></para></listitem>
600                 <listitem><para><link linkend="ADDMACHINESCRIPT"><parameter>add machine script</parameter></link></para></listitem>
601                 <listitem><para><link linkend="ALGORITHMICRIDBASE"><parameter>algorithmic rid base</parameter></link></para></listitem>
602                 <listitem><para><link linkend="ALLOWTRUSTEDDOMAINS"><parameter>allow trusted domains</parameter></link></para></listitem>
603                 <listitem><para><link linkend="ANNOUNCEAS"><parameter>announce as</parameter></link></para></listitem>
604                 <listitem><para><link linkend="ANNOUNCEVERSION"><parameter>announce version</parameter></link></para></listitem>
605                 <listitem><para><link linkend="AUTHMETHODS"><parameter>auth methods</parameter></link></para></listitem>
606                 <listitem><para><link linkend="AUTOSERVICES"><parameter>auto services</parameter></link></para></listitem>
607                 <listitem><para><link linkend="BINDINTERFACESONLY"><parameter>bind interfaces only</parameter></link></para></listitem>
608                 <listitem><para><link linkend="BROWSELIST"><parameter>browse list</parameter></link></para></listitem>
609                 <listitem><para><link linkend="CHANGENOTIFYTIMEOUT"><parameter>change notify timeout</parameter></link></para></listitem>
610                 <listitem><para><link linkend="CHANGESHARECOMMAND"><parameter>change share command</parameter></link></para></listitem>
611                 <listitem><para><link linkend="CONFIGFILE"><parameter>config file</parameter></link></para></listitem>
612                 <listitem><para><link linkend="DEADTIME"><parameter>deadtime</parameter></link></para></listitem>
613                 <listitem><para><link linkend="DEBUGHIRESTIMESTAMP"><parameter>debug hires timestamp</parameter></link></para></listitem>
614                 <listitem><para><link linkend="DEBUGPID"><parameter>debug pid</parameter></link></para></listitem>
615                 <listitem><para><link linkend="DEBUGTIMESTAMP"><parameter>debug timestamp</parameter></link></para></listitem>
616                 <listitem><para><link linkend="DEBUGUID"><parameter>debug uid</parameter></link></para></listitem>
617                 <listitem><para><link linkend="DEBUGLEVEL"><parameter>debuglevel</parameter></link></para></listitem>
618                 <listitem><para><link linkend="DEFAULT"><parameter>default</parameter></link></para></listitem>
619                 <listitem><para><link linkend="DEFAULTSERVICE"><parameter>default service</parameter></link></para></listitem>
620                 <listitem><para><link linkend="DELETEPRINTERCOMMAND"><parameter>delete printer command</parameter></link></para></listitem>
621                 <listitem><para><link linkend="DELETESHARECOMMAND"><parameter>delete share command</parameter></link></para></listitem>
622                 <listitem><para><link linkend="DELETEUSERSCRIPT"><parameter>delete user script</parameter></link></para></listitem>
623                 <listitem><para><link linkend="DFREECOMMAND"><parameter>dfree command</parameter></link></para></listitem>
624                 <listitem><para><link linkend="DISABLESPOOLSS"><parameter>disable spoolss</parameter></link></para></listitem>
625                 <listitem><para><link linkend="DNSPROXY"><parameter>dns proxy</parameter></link></para></listitem>
626                 <listitem><para><link linkend="DOMAINADMINGROUP"><parameter>domain admin group</parameter></link></para></listitem>
627                 <listitem><para><link linkend="DOMAINGUESTGROUP"><parameter>domain guest group</parameter></link></para></listitem>
628                 <listitem><para><link linkend="DOMAINLOGONS"><parameter>domain logons</parameter></link></para></listitem>
629                 <listitem><para><link linkend="DOMAINMASTER"><parameter>domain master</parameter></link></para></listitem>
630                 <listitem><para><link linkend="ENCRYPTPASSWORDS"><parameter>encrypt passwords</parameter></link></para></listitem>
631                 <listitem><para><link linkend="ENHANCEDBROWSING"><parameter>enhanced browsing</parameter></link></para></listitem>
632                 <listitem><para><link linkend="ENUMPORTSCOMMAND"><parameter>enumports command</parameter></link></para></listitem>
633                 <listitem><para><link linkend="GETWDCACHE"><parameter>getwd cache</parameter></link></para></listitem>
634                 <listitem><para><link linkend="HIDELOCALUSERS"><parameter>hide local users</parameter></link></para></listitem>
635                 <listitem><para><link linkend="HIDEUNREADABLE"><parameter>hide unreadable</parameter></link></para></listitem>
636                 <listitem><para><link linkend="HOMEDIRMAP"><parameter>homedir map</parameter></link></para></listitem>
637                 <listitem><para><link linkend="HOSTMSDFS"><parameter>host msdfs</parameter></link></para></listitem>
638                 <listitem><para><link linkend="HOSTSEQUIV"><parameter>hosts equiv</parameter></link></para></listitem>
639                 <listitem><para><link linkend="INTERFACES"><parameter>interfaces</parameter></link></para></listitem>
640                 <listitem><para><link linkend="KEEPALIVE"><parameter>keepalive</parameter></link></para></listitem>
641                 <listitem><para><link linkend="KERNELOPLOCKS"><parameter>kernel oplocks</parameter></link></para></listitem>
642                 <listitem><para><link linkend="LANMANAUTH"><parameter>lanman auth</parameter></link></para></listitem>
643                 <listitem><para><link linkend="LARGEREADWRITE"><parameter>large readwrite</parameter></link></para></listitem>
644                 
645                 <listitem><para><link linkend="LDAPADMINDN"><parameter>ldap admin dn</parameter></link></para></listitem>
646                 <listitem><para><link linkend="LDAPFILTER"><parameter>ldap filter</parameter></link></para></listitem>
647                 <listitem><para><link linkend="LDAPSSL"><parameter>ldap ssl</parameter></link></para></listitem>
648                 <listitem><para><link linkend="LDAPSUFFIX"><parameter>ldap suffix</parameter></link></para></listitem>
649                 <listitem><para><link linkend="LDAPUSERSUFFIX"><parameter>ldap suffix</parameter></link></para></listitem>
650                 <listitem><para><link linkend="LDAPMACHINESUFFIX"><parameter>ldap suffix</parameter></link></para></listitem>
651
652                 <listitem><para><link linkend="LMANNOUNCE"><parameter>lm announce</parameter></link></para></listitem>
653                 <listitem><para><link linkend="LMINTERVAL"><parameter>lm interval</parameter></link></para></listitem>
654                 <listitem><para><link linkend="LOADPRINTERS"><parameter>load printers</parameter></link></para></listitem>
655                 <listitem><para><link linkend="LOCALMASTER"><parameter>local master</parameter></link></para></listitem>
656                 <listitem><para><link linkend="LOCKDIR"><parameter>lock dir</parameter></link></para></listitem>
657                 <listitem><para><link linkend="LOCKDIRECTORY"><parameter>lock directory</parameter></link></para></listitem>
658                 <listitem><para><link linkend="LOCKSPINCOUNT"><parameter>lock spin count</parameter></link></para></listitem>
659                 <listitem><para><link linkend="LOCKSPINTIME"><parameter>lock spin time</parameter></link></para></listitem>
660                 <listitem><para><link linkend="PIDDIRECTORY"><parameter>pid directory</parameter></link></para></listitem>
661                 <listitem><para><link linkend="LOGFILE"><parameter>log file</parameter></link></para></listitem>
662                 <listitem><para><link linkend="LOGLEVEL"><parameter>log level</parameter></link></para></listitem>
663                 <listitem><para><link linkend="LOGONDRIVE"><parameter>logon drive</parameter></link></para></listitem>
664                 <listitem><para><link linkend="LOGONHOME"><parameter>logon home</parameter></link></para></listitem>
665                 <listitem><para><link linkend="LOGONPATH"><parameter>logon path</parameter></link></para></listitem>
666                 <listitem><para><link linkend="LOGONSCRIPT"><parameter>logon script</parameter></link></para></listitem>
667                 <listitem><para><link linkend="LPQCACHETIME"><parameter>lpq cache time</parameter></link></para></listitem>
668                 <listitem><para><link linkend="MACHINEPASSWORDTIMEOUT"><parameter>machine password timeout</parameter></link></para></listitem>
669                 <listitem><para><link linkend="MANGLEDSTACK"><parameter>mangled stack</parameter></link></para></listitem>
670                 <listitem><para><link linkend="MAPTOGUEST"><parameter>map to guest</parameter></link></para></listitem>
671                 <listitem><para><link linkend="MAXDISKSIZE"><parameter>max disk size</parameter></link></para></listitem>
672                 <listitem><para><link linkend="MAXLOGSIZE"><parameter>max log size</parameter></link></para></listitem>
673                 <listitem><para><link linkend="MAXMUX"><parameter>max mux</parameter></link></para></listitem>
674                 <listitem><para><link linkend="MAXOPENFILES"><parameter>max open files</parameter></link></para></listitem>
675                 <listitem><para><link linkend="MAXPROTOCOL"><parameter>max protocol</parameter></link></para></listitem>
676                 <listitem><para><link linkend="MAXSMBDPROCESSES"><parameter>max smbd processes</parameter></link></para></listitem>
677                 <listitem><para><link linkend="MAXTTL"><parameter>max ttl</parameter></link></para></listitem>
678                 <listitem><para><link linkend="MAXWINSTTL"><parameter>max wins ttl</parameter></link></para></listitem>
679                 <listitem><para><link linkend="MAXXMIT"><parameter>max xmit</parameter></link></para></listitem>
680                 <listitem><para><link linkend="MESSAGECOMMAND"><parameter>message command</parameter></link></para></listitem>
681                 <listitem><para><link linkend="MINPASSWDLENGTH"><parameter>min passwd length</parameter></link></para></listitem>
682                 <listitem><para><link linkend="MINPASSWORDLENGTH"><parameter>min password length</parameter></link></para></listitem>
683                 <listitem><para><link linkend="MINPROTOCOL"><parameter>min protocol</parameter></link></para></listitem>
684                 <listitem><para><link linkend="MINWINSTTL"><parameter>min wins ttl</parameter></link></para></listitem>
685                 <listitem><para><link linkend="NAMERESOLVEORDER"><parameter>name resolve order</parameter></link></para></listitem>
686                 <listitem><para><link linkend="NETBIOSALIASES"><parameter>netbios aliases</parameter></link></para></listitem>
687                 <listitem><para><link linkend="NETBIOSNAME"><parameter>netbios name</parameter></link></para></listitem>
688                 <listitem><para><link linkend="NETBIOSSCOPE"><parameter>netbios scope</parameter></link></para></listitem>
689                 <listitem><para><link linkend="NISHOMEDIR"><parameter>nis homedir</parameter></link></para></listitem>
690                 <listitem><para><link linkend="NONUNIXACCOUNTRANGE"><parameter>non unix account range</parameter></link></para></listitem>
691                 <listitem><para><link linkend="NTPIPESUPPORT"><parameter>nt pipe support</parameter></link></para></listitem>
692                 <listitem><para><link linkend="NTSTATUSSUPPORT"><parameter>nt status support</parameter></link></para></listitem>
693                 <listitem><para><link linkend="NULLPASSWORDS"><parameter>null passwords</parameter></link></para></listitem>
694                 <listitem><para><link linkend="OBEYPAMRESTRICTIONS"><parameter>obey pam restrictions</parameter></link></para></listitem>
695                 <listitem><para><link linkend="OPLOCKBREAKWAITTIME"><parameter>oplock break wait time</parameter></link></para></listitem>
696                 <listitem><para><link linkend="OSLEVEL"><parameter>os level</parameter></link></para></listitem>
697                 <listitem><para><link linkend="OS2DRIVERMAP"><parameter>os2 driver map</parameter></link></para></listitem>
698                 <listitem><para><link linkend="PAMPASSWORDCHANGE"><parameter>pam password change</parameter></link></para></listitem>
699                 <listitem><para><link linkend="PANICACTION"><parameter>panic action</parameter></link></para></listitem>
700                 <listitem><para><link linkend="PASSDBBACKEND"><parameter>passdb backend</parameter></link></para></listitem>
701                 <listitem><para><link linkend="PASSWDCHAT"><parameter>passwd chat</parameter></link></para></listitem>
702                 <listitem><para><link linkend="PASSWDCHATDEBUG"><parameter>passwd chat debug</parameter></link></para></listitem>
703                 <listitem><para><link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter></link></para></listitem>
704                 <listitem><para><link linkend="PASSWORDLEVEL"><parameter>password level</parameter></link></para></listitem>
705                 <listitem><para><link linkend="PASSWORDSERVER"><parameter>password server</parameter></link></para></listitem>
706                 <listitem><para><link linkend="PREFEREDMASTER"><parameter>prefered master</parameter></link></para></listitem>
707                 <listitem><para><link linkend="PREFERREDMASTER"><parameter>preferred master</parameter></link></para></listitem>
708                 <listitem><para><link linkend="PRELOAD"><parameter>preload</parameter></link></para></listitem>
709                 <listitem><para><link linkend="PRINTCAP"><parameter>printcap</parameter></link></para></listitem>
710                 <listitem><para><link linkend="PRINTCAPNAME"><parameter>printcap name</parameter></link></para></listitem>
711                 <listitem><para><link linkend="PRINTERDRIVERFILE"><parameter>printer driver file</parameter></link></para></listitem>
712                 <listitem><para><link linkend="PRIVATEDIR"><parameter>private dir</parameter></link></para></listitem>
713                 <listitem><para><link linkend="PROTOCOL"><parameter>protocol</parameter></link></para></listitem>
714                 <listitem><para><link linkend="READBMPX"><parameter>read bmpx</parameter></link></para></listitem>
715                 <listitem><para><link linkend="READRAW"><parameter>read raw</parameter></link></para></listitem>
716                 <listitem><para><link linkend="READSIZE"><parameter>read size</parameter></link></para></listitem>
717                 <listitem><para><link linkend="REMOTEANNOUNCE"><parameter>remote announce</parameter></link></para></listitem>
718                 <listitem><para><link linkend="REMOTEBROWSESYNC"><parameter>remote browse sync</parameter></link></para></listitem>
719                 <listitem><para><link linkend="RESTRICTANONYMOUS"><parameter>restrict anonymous</parameter></link></para></listitem>
720                 <listitem><para><link linkend="ROOT"><parameter>root</parameter></link></para></listitem>
721                 <listitem><para><link linkend="ROOTDIR"><parameter>root dir</parameter></link></para></listitem>
722                 <listitem><para><link linkend="ROOTDIRECTORY"><parameter>root directory</parameter></link></para></listitem>
723                 <listitem><para><link linkend="SECURITY"><parameter>security</parameter></link></para></listitem>
724                 <listitem><para><link linkend="SERVERSTRING"><parameter>server string</parameter></link></para></listitem>
725                 <listitem><para><link linkend="SHOWADDPRINTERWIZARD"><parameter>show add printer wizard</parameter></link></para></listitem>
726                 <listitem><para><link linkend="SHUTDOWNSCRIPT"><parameter>shutdown script</parameter></link></para></listitem>
727                 <listitem><para><link linkend="SMBPASSWDFILE"><parameter>smb passwd file</parameter></link></para></listitem>
728                 <listitem><para><link linkend="SOCKETADDRESS"><parameter>socket address</parameter></link></para></listitem>
729                 <listitem><para><link linkend="SOCKETOPTIONS"><parameter>socket options</parameter></link></para></listitem>
730                 <listitem><para><link linkend="SOURCEENVIRONMENT"><parameter>source environment</parameter></link></para></listitem>
731
732                 <listitem><para><link linkend="STATCACHE"><parameter>stat cache</parameter></link></para></listitem>
733                 <listitem><para><link linkend="STATCACHESIZE"><parameter>stat cache size</parameter></link></para></listitem>
734                 <listitem><para><link linkend="STRIPDOT"><parameter>strip dot</parameter></link></para></listitem>
735                 <listitem><para><link linkend="SYSLOG"><parameter>syslog</parameter></link></para></listitem>
736                 <listitem><para><link linkend="SYSLOGONLY"><parameter>syslog only</parameter></link></para></listitem>
737                 <listitem><para><link linkend="TEMPLATEHOMEDIR"><parameter>template homedir</parameter></link></para></listitem>
738                 <listitem><para><link linkend="TEMPLATESHELL"><parameter>template shell</parameter></link></para></listitem>
739                 <listitem><para><link linkend="TIMEOFFSET"><parameter>time offset</parameter></link></para></listitem>
740                 <listitem><para><link linkend="TIMESERVER"><parameter>time server</parameter></link></para></listitem>
741                 <listitem><para><link linkend="TIMESTAMPLOGS"><parameter>timestamp logs</parameter></link></para></listitem>
742                 <listitem><para><link linkend="TOTALPRINTJOBS"><parameter>total print jobs</parameter></link></para></listitem>
743                 <listitem><para><link linkend="UNIXEXTENSIONS"><parameter>unix extensions</parameter></link></para></listitem>
744                 <listitem><para><link linkend="UNIXPASSWORDSYNC"><parameter>unix password sync</parameter></link></para></listitem>
745                 <listitem><para><link linkend="UPDATEENCRYPTED"><parameter>update encrypted</parameter></link></para></listitem>
746                 <listitem><para><link linkend="USEMMAP"><parameter>use mmap</parameter></link></para></listitem>
747                 <listitem><para><link linkend="USERHOSTS"><parameter>use rhosts</parameter></link></para></listitem>
748                 <listitem><para><link linkend="USERNAMELEVEL"><parameter>username level</parameter></link></para></listitem>
749                 <listitem><para><link linkend="USERNAMEMAP"><parameter>username map</parameter></link></para></listitem>
750                 <listitem><para><link linkend="UTMP"><parameter>utmp</parameter></link></para></listitem>
751                 <listitem><para><link linkend="UTMPDIRECTORY"><parameter>utmp directory</parameter></link></para></listitem>
752                 <listitem><para><link linkend="WINBINDCACHETIME"><parameter>winbind cache time</parameter></link></para></listitem>
753                 <listitem><para><link linkend="WINBINDENUMUSERS"><parameter>winbind enum users</parameter></link></para></listitem>
754                 <listitem><para><link linkend="WINBINDENUMGROUPS"><parameter>winbind enum groups</parameter></link></para></listitem>
755                 <listitem><para><link linkend="WINBINDGID"><parameter>winbind gid</parameter></link></para></listitem>
756                 <listitem><para><link linkend="WINBINDSEPARATOR"><parameter>winbind separator</parameter></link></para></listitem>
757                 <listitem><para><link linkend="WINBINDUID"><parameter>winbind uid</parameter></link></para></listitem>
758                 <listitem><para><link linkend="WINBINDUSEDEFAULTDOMAIN"><parameter>winbind use default domain</parameter></link></para></listitem>
759                 <listitem><para><link linkend="WINSHOOK"><parameter>wins hook</parameter></link></para></listitem>
760                 <listitem><para><link linkend="WINSPROXY"><parameter>wins proxy</parameter></link></para></listitem>
761                 <listitem><para><link linkend="WINSSERVER"><parameter>wins server</parameter></link></para></listitem>
762                 <listitem><para><link linkend="WINSSUPPORT"><parameter>wins support</parameter></link></para></listitem>
763                 <listitem><para><link linkend="WORKGROUP"><parameter>workgroup</parameter></link></para></listitem>
764                 <listitem><para><link linkend="WRITERAW"><parameter>write raw</parameter></link></para></listitem>
765         </itemizedlist>
766
767 </refsect1>
768
769 <refsect1>
770         <title>COMPLETE LIST OF SERVICE PARAMETERS</title>
771         
772         <para>Here is a list of all service parameters. See the section on 
773         each parameter for details. Note that some are synonyms.</para>
774         
775         <itemizedlist>
776                 <listitem><para><link linkend="ADMINUSERS"><parameter>admin users</parameter></link></para></listitem>
777                 <listitem><para><link linkend="ALLOWHOSTS"><parameter>allow hosts</parameter></link></para></listitem>
778                 <listitem><para><link linkend="AVAILABLE"><parameter>available</parameter></link></para></listitem>
779                 <listitem><para><link linkend="BLOCKINGLOCKS"><parameter>blocking locks</parameter></link></para></listitem>
780                 <listitem><para><link linkend="BROWSABLE"><parameter>browsable</parameter></link></para></listitem>
781                 <listitem><para><link linkend="BROWSEABLE"><parameter>browseable</parameter></link></para></listitem>
782                 <listitem><para><link linkend="CASESENSITIVE"><parameter>case sensitive</parameter></link></para></listitem>
783                 <listitem><para><link linkend="CASESIGNAMES"><parameter>casesignames</parameter></link></para></listitem>
784                 <listitem><para><link linkend="COMMENT"><parameter>comment</parameter></link></para></listitem>
785                 <listitem><para><link linkend="COPY"><parameter>copy</parameter></link></para></listitem>
786                 <listitem><para><link linkend="CREATEMASK"><parameter>create mask</parameter></link></para></listitem>
787                 <listitem><para><link linkend="CREATEMODE"><parameter>create mode</parameter></link></para></listitem>
788                 <listitem><para><link linkend="CSCPOLICY"><parameter>csc policy</parameter></link></para></listitem>
789                 
790                 <listitem><para><link linkend="DEFAULTCASE"><parameter>default case</parameter></link></para></listitem>
791                 <listitem><para><link linkend="DEFAULTDEVMODE"><parameter>default devmode</parameter></link></para></listitem>
792                 <listitem><para><link linkend="DELETEREADONLY"><parameter>delete readonly</parameter></link></para></listitem>
793                 <listitem><para><link linkend="DELETEVETOFILES"><parameter>delete veto files</parameter></link></para></listitem>
794                 <listitem><para><link linkend="DENYHOSTS"><parameter>deny hosts</parameter></link></para></listitem>
795                 <listitem><para><link linkend="DIRECTORY"><parameter>directory</parameter></link></para></listitem>
796                 <listitem><para><link linkend="DIRECTORYMASK"><parameter>directory mask</parameter></link></para></listitem>
797                 <listitem><para><link linkend="DIRECTORYMODE"><parameter>directory mode</parameter></link></para></listitem>
798                 <listitem><para><link linkend="DIRECTORYSECURITYMASK"><parameter>directory security mask</parameter></link></para></listitem>
799                 <listitem><para><link linkend="DONTDESCEND"><parameter>dont descend</parameter></link></para></listitem>
800                 <listitem><para><link linkend="DOSFILEMODE"><parameter>dos filemode</parameter></link></para></listitem>
801                 <listitem><para><link linkend="DOSFILETIMERESOLUTION"><parameter>dos filetime resolution</parameter></link></para></listitem>
802                 <listitem><para><link linkend="DOSFILETIMES"><parameter>dos filetimes</parameter></link></para></listitem>
803                 <listitem><para><link linkend="EXEC"><parameter>exec</parameter></link></para></listitem>
804                 <listitem><para><link linkend="FAKEDIRECTORYCREATETIMES"><parameter>fake directory create times</parameter></link></para></listitem>
805                 <listitem><para><link linkend="FAKEOPLOCKS"><parameter>fake oplocks</parameter></link></para></listitem>
806                 <listitem><para><link linkend="FOLLOWSYMLINKS"><parameter>follow symlinks</parameter></link></para></listitem>
807                 <listitem><para><link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link></para></listitem>
808                 <listitem><para><link linkend="FORCEDIRECTORYMODE"><parameter>force directory mode</parameter></link></para></listitem>
809                 <listitem><para><link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>force directory security mode</parameter></link></para></listitem>
810                 <listitem><para><link linkend="FORCEGROUP"><parameter>force group</parameter></link></para></listitem>
811                 <listitem><para><link linkend="FORCESECURITYMODE"><parameter>force security mode</parameter></link></para></listitem>
812                 <listitem><para><link linkend="FORCEUSER"><parameter>force user</parameter></link></para></listitem>
813                 <listitem><para><link linkend="FSTYPE"><parameter>fstype</parameter></link></para></listitem>
814                 <listitem><para><link linkend="GROUP"><parameter>group</parameter></link></para></listitem>
815                 <listitem><para><link linkend="GUESTACCOUNT"><parameter>guest account</parameter></link></para></listitem>
816                 <listitem><para><link linkend="GUESTOK"><parameter>guest ok</parameter></link></para></listitem>
817                 <listitem><para><link linkend="GUESTONLY"><parameter>guest only</parameter></link></para></listitem>
818                 <listitem><para><link linkend="HIDEDOTFILES"><parameter>hide dot files</parameter></link></para></listitem>
819                 <listitem><para><link linkend="HIDEFILES"><parameter>hide files</parameter></link></para></listitem>
820                 <listitem><para><link linkend="HOSTSALLOW"><parameter>hosts allow</parameter></link></para></listitem>
821                 <listitem><para><link linkend="HOSTSDENY"><parameter>hosts deny</parameter></link></para></listitem>
822                 <listitem><para><link linkend="INCLUDE"><parameter>include</parameter></link></para></listitem>
823                 <listitem><para><link linkend="INHERITACLS"><parameter>inherit acls</parameter></link></para></listitem>
824                 <listitem><para><link linkend="INHERITPERMISSIONS"><parameter>inherit permissions</parameter></link></para></listitem>
825                 <listitem><para><link linkend="INVALIDUSERS"><parameter>invalid users</parameter></link></para></listitem>
826                 <listitem><para><link linkend="LEVEL2OPLOCKS"><parameter>level2 oplocks</parameter></link></para></listitem>
827                 <listitem><para><link linkend="LOCKING"><parameter>locking</parameter></link></para></listitem>
828                 <listitem><para><link linkend="LPPAUSECOMMAND"><parameter>lppause command</parameter></link></para></listitem>
829                 <listitem><para><link linkend="LPQCOMMAND"><parameter>lpq command</parameter></link></para></listitem>
830                 <listitem><para><link linkend="LPRESUMECOMMAND"><parameter>lpresume command</parameter></link></para></listitem>
831                 <listitem><para><link linkend="LPRMCOMMAND"><parameter>lprm command</parameter></link></para></listitem>
832                 <listitem><para><link linkend="MAGICOUTPUT"><parameter>magic output</parameter></link></para></listitem>
833                 <listitem><para><link linkend="MAGICSCRIPT"><parameter>magic script</parameter></link></para></listitem>
834                 <listitem><para><link linkend="MANGLECASE"><parameter>mangle case</parameter></link></para></listitem>
835                 <listitem><para><link linkend="MANGLEDMAP"><parameter>mangled map</parameter></link></para></listitem>
836                 <listitem><para><link linkend="MANGLEDNAMES"><parameter>mangled names</parameter></link></para></listitem>
837                 <listitem><para><link linkend="MANGLINGCHAR"><parameter>mangling char</parameter></link></para></listitem>
838                 <listitem><para><link linkend="MAPARCHIVE"><parameter>map archive</parameter></link></para></listitem>
839                 <listitem><para><link linkend="MAPHIDDEN"><parameter>map hidden</parameter></link></para></listitem>
840                 <listitem><para><link linkend="MAPSYSTEM"><parameter>map system</parameter></link></para></listitem>
841                 <listitem><para><link linkend="MAXCONNECTIONS"><parameter>max connections</parameter></link></para></listitem>
842                 <listitem><para><link linkend="MAXPRINTJOBS"><parameter>max print jobs</parameter></link></para></listitem>
843                 <listitem><para><link linkend="MINPRINTSPACE"><parameter>min print space</parameter></link></para></listitem>
844                 <listitem><para><link linkend="MSDFSROOT"><parameter>msdfs root</parameter></link></para></listitem>
845                 <listitem><para><link linkend="NTACLSUPPORT"><parameter>nt acl support</parameter></link></para></listitem>
846                 <listitem><para><link linkend="ONLYGUEST"><parameter>only guest</parameter></link></para></listitem>
847                 <listitem><para><link linkend="ONLYUSER"><parameter>only user</parameter></link></para></listitem>
848                 <listitem><para><link linkend="OPLOCKCONTENTIONLIMIT"><parameter>oplock contention limit</parameter></link></para></listitem>
849                 <listitem><para><link linkend="OPLOCKS"><parameter>oplocks</parameter></link></para></listitem>
850                 <listitem><para><link linkend="PATH"><parameter>path</parameter></link></para></listitem>
851                 <listitem><para><link linkend="POSIXLOCKING"><parameter>posix locking</parameter></link></para></listitem>
852                 <listitem><para><link linkend="POSTEXEC"><parameter>postexec</parameter></link></para></listitem>
853                 <listitem><para><link linkend="POSTSCRIPT"><parameter>postscript</parameter></link></para></listitem>
854                 <listitem><para><link linkend="PREEXEC"><parameter>preexec</parameter></link></para></listitem>
855                 <listitem><para><link linkend="PREEXECCLOSE"><parameter>preexec close</parameter></link></para></listitem>
856                 <listitem><para><link linkend="PRESERVECASE"><parameter>preserve case</parameter></link></para></listitem>
857                 <listitem><para><link linkend="PRINTCOMMAND"><parameter>print command</parameter></link></para></listitem>
858                 <listitem><para><link linkend="PRINTOK"><parameter>print ok</parameter></link></para></listitem>
859                 <listitem><para><link linkend="PRINTABLE"><parameter>printable</parameter></link></para></listitem>
860                 <listitem><para><link linkend="PRINTER"><parameter>printer</parameter></link></para></listitem>
861                 <listitem><para><link linkend="PRINTERADMIN"><parameter>printer admin</parameter></link></para></listitem>
862                 <listitem><para><link linkend="PRINTERDRIVER"><parameter>printer driver</parameter></link></para></listitem>
863                 <listitem><para><link linkend="PRINTERDRIVERLOCATION"><parameter>printer driver location</parameter></link></para></listitem>
864                 <listitem><para><link linkend="PRINTERNAME"><parameter>printer name</parameter></link></para></listitem>
865                 <listitem><para><link linkend="PRINTING"><parameter>printing</parameter></link></para></listitem>
866                 <listitem><para><link linkend="PUBLIC"><parameter>public</parameter></link></para></listitem>
867                 <listitem><para><link linkend="QUEUEPAUSECOMMAND"><parameter>queuepause command</parameter></link></para></listitem>
868                 <listitem><para><link linkend="QUEUERESUMECOMMAND"><parameter>queueresume command</parameter></link></para></listitem>
869                 <listitem><para><link linkend="READLIST"><parameter>read list</parameter></link></para></listitem>
870                 <listitem><para><link linkend="READONLY"><parameter>read only</parameter></link></para></listitem>
871                 <listitem><para><link linkend="ROOTPOSTEXEC"><parameter>root postexec</parameter></link></para></listitem>
872                 <listitem><para><link linkend="ROOTPREEXEC"><parameter>root preexec</parameter></link></para></listitem>
873                 <listitem><para><link linkend="ROOTPREEXECCLOSE"><parameter>root preexec close</parameter></link></para></listitem>
874                 <listitem><para><link linkend="SECURITYMASK"><parameter>security mask</parameter></link></para></listitem>
875                 <listitem><para><link linkend="SETDIRECTORY"><parameter>set directory</parameter></link></para></listitem>
876                 <listitem><para><link linkend="SHAREMODES"><parameter>share modes</parameter></link></para></listitem>
877                 <listitem><para><link linkend="SHORTPRESERVECASE"><parameter>short preserve case</parameter></link></para></listitem>
878                 <listitem><para><link linkend="STATUS"><parameter>status</parameter></link></para></listitem>
879                 <listitem><para><link linkend="STRICTALLOCATE"><parameter>strict allocate</parameter></link></para></listitem>
880                 <listitem><para><link linkend="STRICTLOCKING"><parameter>strict locking</parameter></link></para></listitem>
881                 <listitem><para><link linkend="STRICTSYNC"><parameter>strict sync</parameter></link></para></listitem>
882                 <listitem><para><link linkend="SYNCALWAYS"><parameter>sync always</parameter></link></para></listitem>
883                 <listitem><para><link linkend="USECLIENTDRIVER"><parameter>use client driver</parameter></link></para></listitem>
884                 <listitem><para><link linkend="USER"><parameter>user</parameter></link></para></listitem>
885                 <listitem><para><link linkend="USERNAME"><parameter>username</parameter></link></para></listitem>
886                 <listitem><para><link linkend="USERS"><parameter>users</parameter></link></para></listitem>
887                 <listitem><para><link linkend="VALIDUSERS"><parameter>valid users</parameter></link></para></listitem>
888                 <listitem><para><link linkend="VETOFILES"><parameter>veto files</parameter></link></para></listitem>
889                 <listitem><para><link linkend="VETOOPLOCKFILES"><parameter>veto oplock files</parameter></link></para></listitem>
890                 <listitem><para><link linkend="VFSOBJECT"><parameter>vfs object</parameter></link></para></listitem>
891                 <listitem><para><link linkend="VFSOPTIONS"><parameter>vfs options</parameter></link></para></listitem>
892                 <listitem><para><link linkend="VOLUME"><parameter>volume</parameter></link></para></listitem>
893                 <listitem><para><link linkend="WIDELINKS"><parameter>wide links</parameter></link></para></listitem>
894                 <listitem><para><link linkend="WRITABLE"><parameter>writable</parameter></link></para></listitem>
895                 <listitem><para><link linkend="WRITECACHESIZE"><parameter>write cache size</parameter></link></para></listitem>
896                 <listitem><para><link linkend="WRITELIST"><parameter>write list</parameter></link></para></listitem>
897                 <listitem><para><link linkend="WRITEOK"><parameter>write ok</parameter></link></para></listitem>
898                 <listitem><para><link linkend="WRITEABLE"><parameter>writeable</parameter></link></para></listitem>
899         </itemizedlist>
900
901 </refsect1>
902
903 <refsect1>
904         <title>EXPLANATION OF EACH PARAMETER</title>
905         
906         <variablelist>
907
908                 <varlistentry>
909                 <term><anchor id="ABORTSHUTDOWNSCRIPT">abort shutdown script (G)</term>
910                 <listitem><para><emphasis>This parameter only exists in the HEAD cvs branch</emphasis>
911                 This a full path name to a script called by
912                 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>  that
913                 should stop a shutdown procedure issued by the <link 
914                 linkend="SHUTDOWNSCRIPT"><parameter>shutdown script</parameter></link>.</para>
915                 
916                 <para>This command will be run as user.</para>
917
918                 <para>Default: <emphasis>None</emphasis>.</para>
919                 <para>Example: <command>abort shutdown script = /sbin/shutdown -c</command></para>
920                 </listitem>
921                 </varlistentry>
922
923
924                 <varlistentry>
925                 <term><anchor id="ADDPRINTERCOMMAND">add printer command (G)</term>
926                 <listitem><para>With the introduction of MS-RPC based printing
927                 support for Windows NT/2000 clients in Samba 2.2, The MS Add
928                 Printer Wizard (APW) icon is now also available in the 
929                 "Printers..." folder displayed a share listing.  The APW
930                 allows for printers to be add remotely to a Samba or Windows 
931                 NT/2000 print server.</para>
932                 
933                 <para>For a Samba host this means that the printer must be 
934                 physically added to the underlying printing system.  The <parameter>add 
935                 printer command</parameter> defines a script to be run which 
936                 will perform the necessary operations for adding the printer
937                 to the print system and to add the appropriate service definition 
938                 to the  <filename>smb.conf</filename> file in order that it can be 
939                 shared by <ulink url="smbd.8.html"><command>smbd(8)</command>
940                 </ulink>.</para>
941                 
942                 <para>The <parameter>add printer command</parameter> is
943                 automatically invoked with the following parameter (in 
944                 order:</para>
945                 
946                 <itemizedlist>
947                         <listitem><para><parameter>printer name</parameter></para></listitem>
948                         <listitem><para><parameter>share name</parameter></para></listitem>
949                         <listitem><para><parameter>port name</parameter></para></listitem>
950                         <listitem><para><parameter>driver name</parameter></para></listitem>
951                         <listitem><para><parameter>location</parameter></para></listitem>
952                         <listitem><para><parameter>Windows 9x driver location</parameter>
953                         </para></listitem>
954                 </itemizedlist>
955                 
956                 <para>All parameters are filled in from the PRINTER_INFO_2 structure sent 
957                 by the Windows NT/2000 client with one exception.  The "Windows 9x
958                 driver location" parameter is included for backwards compatibility
959                 only.  The remaining fields in the structure are generated from answers
960                 to the APW questions.</para>
961                 
962                 <para>Once the <parameter>add printer command</parameter> has 
963                 been executed, <command>smbd</command> will reparse the <filename>
964                 smb.conf</filename> to determine if the share defined by the APW
965                 exists.  If the sharename is still invalid, then <command>smbd
966                 </command> will return an ACCESS_DENIED error to the client.</para>
967                 
968                 <para>See also <link linkend="DELETEPRINTERCOMMAND"><parameter>
969                 delete printer command</parameter></link>, <link 
970                 linkend="printing"><parameter>printing</parameter></link>,
971                 <link linkend="SHOWADDPRINTERWIZARD"><parameter>show add
972                 printer wizard</parameter></link></para>
973                 
974                 <para>Default: <emphasis>none</emphasis></para>
975                 <para>Example: <command>addprinter command = /usr/bin/addprinter
976                 </command></para>
977                 </listitem>
978                 </varlistentry>
979
980
981
982                 <varlistentry>
983                 <term><anchor id="ADDSHARECOMMAND">add share command (G)</term>
984                 <listitem><para>Samba 2.2.0 introduced the ability to dynamically 
985                 add and delete shares via the Windows NT 4.0 Server Manager.  The 
986                 <parameter>add share command</parameter> is used to define an 
987                 external program or script which will add a new service definition 
988                 to <filename>smb.conf</filename>.  In order to successfully 
989                 execute the <parameter>add share command</parameter>, <command>smbd</command>
990                 requires that the administrator be connected using a root account (i.e. 
991                 uid == 0).
992                 </para>
993                 
994                 <para>
995                 When executed, <command>smbd</command> will automatically invoke the 
996                 <parameter>add share command</parameter> with four parameters.
997                 </para>
998                 
999                 <itemizedlist>
1000                         <listitem><para><parameter>configFile</parameter> - the location 
1001                         of the global <filename>smb.conf</filename> file. 
1002                         </para></listitem>
1003                         
1004                         <listitem><para><parameter>shareName</parameter> - the name of the new 
1005                         share.
1006                         </para></listitem>
1007                         
1008                         <listitem><para><parameter>pathName</parameter> - path to an **existing**
1009                         directory on disk.
1010                         </para></listitem>
1011                         
1012                         <listitem><para><parameter>comment</parameter> - comment string to associate 
1013                         with the new share.
1014                         </para></listitem>
1015                 </itemizedlist>
1016                 
1017                 <para>
1018                 This parameter is only used for add file shares.  To add printer shares, 
1019                 see the <link linkend="ADDPRINTERCOMMAND"><parameter>add printer 
1020                 command</parameter></link>.
1021                 </para>
1022                 
1023                 <para>
1024                 See also <link linkend="CHANGESHARECOMMAND"><parameter>change share 
1025                 command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter>delete share
1026                 command</parameter></link>.
1027                 </para>
1028                 
1029                 <para>Default: <emphasis>none</emphasis></para>
1030                 <para>Example: <command>add share command = /usr/local/bin/addshare</command></para>
1031                 </listitem>
1032                 </varlistentry>
1033
1034
1035
1036                 <varlistentry>
1037                 <term><anchor id="ADDMACHINESCRIPT">add machine script (G)</term>
1038                 <listitem><para>This is the full pathname to a script that will 
1039                 be run by <ulink url="smbd.8.html">smbd(8)</ulink>  when a machine is added
1040                 to it's domain using the administrator username and password method. </para>
1041
1042                 <para>This option is only required when using sam back-ends tied to the
1043                 Unix uid method of RID calculation such as smbpasswd.  This option is only
1044                 available in Samba 3.0.</para>
1045
1046                 <para>Default: <command>add machine script = &lt;empty string&gt;
1047                 </command></para>       
1048
1049                 <para>Example: <command>add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u
1050                 </command></para>
1051                 </listitem>
1052                 </varlistentry>
1053
1054
1055                 <varlistentry>
1056                 <term><anchor id="ADDUSERSCRIPT">add user script (G)</term>
1057                 <listitem><para>This is the full pathname to a script that will 
1058                 be run <emphasis>AS ROOT</emphasis> by <ulink url="smbd.8.html">smbd(8)
1059                 </ulink> under special circumstances described below.</para>
1060
1061                 <para>Normally, a Samba server requires that UNIX users are 
1062                 created for all users accessing files on this server. For sites 
1063                 that use Windows NT account databases as their primary user database 
1064                 creating these users and keeping the user list in sync with the 
1065                 Windows NT PDC is an onerous task. This option allows <ulink 
1066                 url="smbd.8.html">smbd</ulink> to create the required UNIX users 
1067                 <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.</para>
1068
1069                 <para>In order to use this option, <ulink url="smbd.8.html">smbd</ulink> 
1070                 must <emphasis>NOT</emphasis> be set to <parameter>security = share</parameter>
1071                 and <parameter>add user script</parameter>
1072                 must be set to a full pathname for a script that will create a UNIX 
1073                 user given one argument of <parameter>%u</parameter>, which expands into 
1074                 the UNIX user name to create.</para>
1075
1076                 <para>When the Windows user attempts to access the Samba server, 
1077                 at login (session setup in the SMB protocol) time, <ulink url="smbd.8.html">
1078                 smbd</ulink> contacts the <parameter>password server</parameter> and 
1079                 attempts to authenticate the given user with the given password. If the 
1080                 authentication succeeds then <command>smbd</command> 
1081                 attempts to find a UNIX user in the UNIX password database to map the 
1082                 Windows user into. If this lookup fails, and <parameter>add user script
1083                 </parameter> is set then <command>smbd</command> will
1084                 call the specified script <emphasis>AS ROOT</emphasis>, expanding 
1085                 any <parameter>%u</parameter> argument to be the user name to create.</para>
1086
1087                 <para>If this script successfully creates the user then <command>smbd
1088                 </command> will continue on as though the UNIX user
1089                 already existed. In this way, UNIX users are dynamically created to
1090                 match existing Windows NT accounts.</para>
1091
1092                 <para>See also <link linkend="SECURITY"><parameter>
1093                 security</parameter></link>, <link linkend="PASSWORDSERVER">
1094                 <parameter>password server</parameter></link>, 
1095                 <link linkend="DELETEUSERSCRIPT"><parameter>delete user 
1096                 script</parameter></link>.</para>
1097
1098                 <para>Default: <command>add user script = &lt;empty string&gt;
1099                 </command></para>       
1100
1101                 <para>Example: <command>add user script = /usr/local/samba/bin/add_user 
1102                 %u</command></para>
1103                 </listitem>
1104                 </varlistentry>
1105
1106
1107
1108                 <varlistentry>
1109                 <term><anchor id="ADMINUSERS">admin users (S)</term>
1110                 <listitem><para>This is a list of users who will be granted 
1111                 administrative privileges on the share. This means that they 
1112                 will do all file operations as the super-user (root).</para>
1113
1114                 <para>You should use this option very carefully, as any user in 
1115                 this list will be able to do anything they like on the share, 
1116                 irrespective of file permissions.</para>
1117
1118                 <para>Default: <emphasis>no admin users</emphasis></para>
1119
1120                 <para>Example: <command>admin users = jason</command></para>
1121                 </listitem>
1122                 </varlistentry>
1123                 
1124
1125
1126                 <varlistentry>
1127                 <term><anchor id="ALLOWHOSTS">allow hosts (S)</term>
1128                 <listitem><para>Synonym for <link linkend="HOSTSALLOW">
1129                 <parameter>hosts allow</parameter></link>.</para></listitem>
1130                 </varlistentry>
1131                 
1132                 <varlistentry>
1133                 <term><anchor id="ALGORITHMICRIDBASE">algorithmic rid base (G)</term>
1134                 <listitem><para>This determines how Samba will use its
1135                 algorithmic mapping from uids/gid to the RIDs needed to construct
1136                 NT Security Identifiers.</para>
1137
1138                 <para>Setting this option to a larger value could be useful to sites
1139                 transitioning from WinNT and Win2k, as existing user and 
1140                 group rids would otherwise clash with sytem users etc. 
1141                 </para>
1142
1143                 <para>All UIDs and GIDs must be able to be resolved into SIDs for  
1144                 the correct operation of ACLs on the server.  As such the algorithmic
1145                 mapping can't be 'turned off', but pushing it 'out of the way' should
1146                 resolve the issues.  Users and groups can then be assigned 'low' RIDs
1147                 in arbitary-rid supporting backends. </para>
1148
1149                 <para>Default: <command>algorithmic rid base = 1000</command></para>
1150
1151                 <para>Example: <command>algorithmic rid base = 100000</command></para>
1152                 </listitem>
1153                 </varlistentry>
1154                 
1155                 <varlistentry>
1156                 <term><anchor id="ALLOWTRUSTEDDOMAINS">allow trusted domains (G)</term>
1157                 <listitem><para>This option only takes effect when the <link 
1158                 linkend="SECURITY"><parameter>security</parameter></link> option is set to 
1159                 <constant>server</constant> or <constant>domain</constant>.  
1160                 If it is set to no, then attempts to connect to a resource from 
1161                 a domain or workgroup other than the one which <ulink url="smbd.8.html">smbd</ulink> is running 
1162                 in will fail, even if that domain is trusted by the remote server 
1163                 doing the authentication.</para>
1164                 
1165                 <para>This is useful if you only want your Samba server to 
1166                 serve resources to users in the domain it is a member of. As 
1167                 an example, suppose that there are two domains DOMA and DOMB.  DOMB 
1168                 is trusted by DOMA, which contains the Samba server.  Under normal 
1169                 circumstances, a user with an account in DOMB can then access the 
1170                 resources of a UNIX account with the same account name on the 
1171                 Samba server even if they do not have an account in DOMA.  This 
1172                 can make implementing a security boundary difficult.</para>
1173
1174                 <para>Default: <command>allow trusted domains = yes</command></para>
1175
1176                 </listitem>
1177                 </varlistentry>
1178                 
1179
1180
1181                 <varlistentry>
1182                 <term><anchor id="ANNOUNCEAS">announce as (G)</term>
1183                 <listitem><para>This specifies what type of server 
1184                 <ulink url="nmbd.8.html"><command>nmbd</command></ulink> 
1185                 will announce itself as, to a network neighborhood browse 
1186                 list. By default this is set to Windows NT. The valid options 
1187                 are : "NT Server" (which can also be written as "NT"), 
1188                 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, 
1189                 Windows NT Workstation, Windows 95 and Windows for Workgroups 
1190                 respectively. Do not change this parameter unless you have a 
1191                 specific need to stop Samba appearing as an NT server as this 
1192                 may prevent Samba servers from participating as browser servers 
1193                 correctly.</para>
1194
1195                 <para>Default: <command>announce as = NT Server</command></para>
1196                 
1197                 <para>Example: <command>announce as = Win95</command></para>
1198                 </listitem>
1199                 </varlistentry>
1200                 
1201
1202
1203                 <varlistentry>
1204                 <term><anchor id="ANNOUNCEVERSION">announce version (G)</term>
1205                 <listitem><para>This specifies the major and minor version numbers 
1206                 that nmbd will use when announcing itself as a server. The default 
1207                 is 4.2.  Do not change this parameter unless you have a specific 
1208                 need to set a Samba server to be a downlevel server.</para>
1209
1210                 <para>Default: <command>announce version = 4.5</command></para>
1211
1212                 <para>Example: <command>announce version = 2.0</command></para>
1213                 </listitem>
1214                 </varlistentry>
1215
1216
1217
1218                 <varlistentry>
1219                 <term><anchor id="AUTOSERVICES">auto services (G)</term>
1220                 <listitem><para>This is a synonym for the <link linkend="PRELOAD">
1221                 <parameter>preload</parameter></link>.</para>
1222                 </listitem>
1223                 </varlistentry>
1224                 
1225
1226
1227                 <varlistentry>
1228                 <term><anchor id="AUTHMETHODS">auth methods (G)</term>
1229                 <listitem><para>This option allows the administrator to chose what
1230                 authentication methods <command>smbd</command> will use when authenticating
1231                 a user.  This option defaults to sensible values based on <link linkend="SECURITY"><parameter>
1232                 security</parameter></link>.
1233
1234                 Each entry in the list attempts to authenticate the user in turn, until
1235                 the user authenticates.  In practice only one method will ever actually 
1236                 be able to complete the authentication.
1237                 </para>
1238
1239                 <para>Default: <command>auth methods = &lt;empty string&gt;</command></para>
1240                 <para>Example: <command>auth methods = guest sam ntdomain</command></para>
1241                 </listitem>
1242                 </varlistentry>
1243
1244
1245                 <varlistentry>
1246                 <term><anchor id="AVAILABLE">available (S)</term>
1247                 <listitem><para>This parameter lets you "turn off" a service. If 
1248                 <parameter>available = no</parameter>, then <emphasis>ALL</emphasis> 
1249                 attempts to connect to the service will fail. Such failures are 
1250                 logged.</para>
1251
1252                 <para>Default: <command>available = yes</command></para>
1253                 
1254                 </listitem>
1255                 </varlistentry>
1256                 
1257
1258
1259                 <varlistentry>
1260                 <term><anchor id="BINDINTERFACESONLY">bind interfaces only (G)</term>
1261                 <listitem><para>This global parameter allows the Samba admin 
1262                 to limit what interfaces on a machine will serve SMB requests. If 
1263                 affects file service <ulink url="smbd.8.html">smbd(8)</ulink> and 
1264                 name service <ulink url="nmbd.8.html">nmbd(8)</ulink> in slightly 
1265                 different ways.</para>
1266
1267                 <para>For name service it causes <command>nmbd</command> to bind 
1268                 to ports 137 and 138 on the interfaces listed in the <link 
1269                 linkend="INTERFACES">interfaces</link> parameter. <command>nmbd
1270                 </command> also binds to the "all addresses" interface (0.0.0.0) 
1271                 on ports 137 and 138 for the purposes of reading broadcast messages. 
1272                 If this option is not set then <command>nmbd</command> will service 
1273                 name requests on all of these sockets. If <parameter>bind interfaces
1274                 only</parameter> is set then <command>nmbd</command> will check the 
1275                 source address of any packets coming in on the broadcast sockets 
1276                 and discard any that don't match the broadcast addresses of the 
1277                 interfaces in the <parameter>interfaces</parameter> parameter list. 
1278                 As unicast packets are received on the other sockets it allows 
1279                 <command>nmbd</command> to refuse to serve names to machines that 
1280                 send packets that arrive through any interfaces not listed in the
1281                 <parameter>interfaces</parameter> list.  IP Source address spoofing
1282                 does defeat this simple check, however so it must not be used
1283                 seriously as a security feature for <command>nmbd</command>.</para>
1284
1285                 <para>For file service it causes <ulink url="smbd.8.html">smbd(8)</ulink>
1286                 to bind only to the interface list given in the <link linkend="INTERFACES">
1287                 interfaces</link> parameter. This restricts the networks that 
1288                 <command>smbd</command> will serve to packets coming in those 
1289                 interfaces.  Note that you should not use this parameter for machines 
1290                 that are serving PPP or other intermittent or non-broadcast network 
1291                 interfaces as it will not cope with non-permanent interfaces.</para>
1292
1293                 <para>If <parameter>bind interfaces only</parameter> is set then 
1294                 unless the network address <emphasis>127.0.0.1</emphasis> is added 
1295                 to the <parameter>interfaces</parameter> parameter list <ulink
1296                 url="smbpasswd.8.html"><command>smbpasswd(8)</command></ulink> 
1297                 and <ulink url="swat.8.html"><command>swat(8)</command></ulink> may 
1298                 not work as expected due to the reasons covered below.</para>
1299
1300                 <para>To change a users SMB password, the <command>smbpasswd</command>
1301                 by default connects to the <emphasis>localhost - 127.0.0.1</emphasis> 
1302                 address as an SMB client to issue the password change request. If 
1303                 <parameter>bind interfaces only</parameter> is set then unless the 
1304                 network address <emphasis>127.0.0.1</emphasis> is added to the
1305                 <parameter>interfaces</parameter> parameter list then <command>
1306                 smbpasswd</command> will fail to connect in it's default mode. 
1307                 <command>smbpasswd</command> can be forced to use the primary IP interface 
1308                 of the local host by using its <ulink url="smbpasswd.8.html#minusr">
1309                 <parameter>-r <replaceable>remote machine</replaceable></parameter>
1310                 </ulink> parameter, with <replaceable>remote machine</replaceable> set 
1311                 to the IP name of the primary interface of the local host.</para>
1312
1313                 <para>The <command>swat</command> status page tries to connect with
1314                 <command>smbd</command> and <command>nmbd</command> at the address 
1315                 <emphasis>127.0.0.1</emphasis> to determine if they are running.  
1316                 Not adding <emphasis>127.0.0.1</emphasis>  will cause <command>
1317                 smbd</command> and <command>nmbd</command> to always show
1318                 "not running" even if they really are.  This can prevent <command>
1319                 swat</command> from starting/stopping/restarting <command>smbd</command>
1320                 and <command>nmbd</command>.</para>
1321
1322                 <para>Default: <command>bind interfaces only = no</command></para>
1323                 
1324                 </listitem>
1325                 </varlistentry>
1326
1327
1328
1329                 <varlistentry>
1330                 <term><anchor id="BLOCKINGLOCKS">blocking locks (S)</term>
1331                 <listitem><para>This parameter controls the behavior of <ulink 
1332                 url="smbd.8.html">smbd(8)</ulink> when given a request by a client 
1333                 to obtain a byte range lock on a region of an open file, and the 
1334                 request has a time limit associated with it.</para>
1335                 
1336                 <para>If this parameter is set and the lock range requested 
1337                 cannot be immediately satisfied, Samba 2.2 will internally 
1338                 queue the lock request, and periodically attempt to obtain 
1339                 the lock until the timeout period expires.</para>
1340
1341                 <para>If this parameter is set to <constant>false</constant>, then 
1342                 Samba 2.2 will behave as previous versions of Samba would and 
1343                 will fail the lock request immediately if the lock range 
1344                 cannot be obtained.</para>
1345
1346                 <para>Default: <command>blocking locks = yes</command></para>
1347
1348                 </listitem>
1349                 </varlistentry>
1350                 
1351
1352
1353                 <varlistentry>
1354                 <term><anchor id="BROWSABLE">browsable (S)</term>
1355                 <listitem><para>See the <link linkend="BROWSEABLE"><parameter>
1356                 browseable</parameter></link>.</para></listitem>
1357                 </varlistentry>
1358                 
1359
1360
1361                 <varlistentry>
1362                 <term><anchor id="BROWSELIST">browse list (G)</term>
1363                 <listitem><para>This controls whether <ulink url="smbd.8.html">
1364                 <command>smbd(8)</command></ulink> will serve a browse list to 
1365                 a client doing a <command>NetServerEnum</command> call. Normally 
1366                 set to <constant>true</constant>. You should never need to change 
1367                 this.</para>
1368                 
1369                 <para>Default: <command>browse list = yes</command></para></listitem>
1370                 </varlistentry>
1371                 
1372
1373
1374                 <varlistentry>
1375                 <term><anchor id="BROWSEABLE">browseable (S)</term>
1376                 <listitem><para>This controls whether this share is seen in 
1377                 the list of available shares in a net view and in the browse list.</para>
1378
1379                 <para>Default: <command>browseable = yes</command></para>
1380                 </listitem>
1381                 </varlistentry>
1382                 
1383
1384
1385                 <varlistentry>
1386                 <term><anchor id="CASESENSITIVE">case sensitive (S)</term>
1387                 <listitem><para>See the discussion in the section <link 
1388                 linkend="NAMEMANGLINGSECT">NAME MANGLING</link>.</para>
1389                 
1390                 <para>Default: <command>case sensitive = no</command></para>
1391                 </listitem>
1392                 </varlistentry>
1393
1394
1395
1396                 <varlistentry>
1397                 <term><anchor id="CASESIGNAMES">casesignames (S)</term>
1398                 <listitem><para>Synonym for <link linkend="CASESENSITIVE">case 
1399                 sensitive</link>.</para></listitem>
1400                 </varlistentry>
1401                 
1402                 
1403                 
1404                 <varlistentry>
1405                 <term><anchor id="CHANGENOTIFYTIMEOUT">change notify timeout (G)</term>
1406                 <listitem><para>This SMB allows a client to tell a server to 
1407                 "watch" a particular directory for any changes and only reply to
1408                 the SMB request when a change has occurred. Such constant scanning of
1409                 a directory is expensive under UNIX, hence an <ulink url="smbd.8.html">
1410                 <command>smbd(8)</command></ulink> daemon only performs such a scan 
1411                 on each requested directory once every <parameter>change notify 
1412                 timeout</parameter> seconds.</para>
1413
1414                 <para>Default: <command>change notify timeout = 60</command></para>
1415                 <para>Example: <command>change notify timeout = 300</command></para>
1416
1417                 <para>Would change the scan time to every 5 minutes.</para></listitem>
1418                 </varlistentry>
1419                 
1420
1421
1422                 <varlistentry>
1423                 <term><anchor id="CHANGESHARECOMMAND">change share command (G)</term>
1424                 <listitem><para>Samba 2.2.0 introduced the ability to dynamically 
1425                 add and delete shares via the Windows NT 4.0 Server Manager.  The 
1426                 <parameter>change share command</parameter> is used to define an 
1427                 external program or script which will modify an existing service definition 
1428                 in <filename>smb.conf</filename>.  In order to successfully 
1429                 execute the <parameter>change share command</parameter>, <command>smbd</command>
1430                 requires that the administrator be connected using a root account (i.e. 
1431                 uid == 0).
1432                 </para>
1433                 
1434                 <para>
1435                 When executed, <command>smbd</command> will automatically invoke the 
1436                 <parameter>change share command</parameter> with four parameters.
1437                 </para>
1438                 
1439                 <itemizedlist>
1440                         <listitem><para><parameter>configFile</parameter> - the location 
1441                         of the global <filename>smb.conf</filename> file. 
1442                         </para></listitem>
1443                         
1444                         <listitem><para><parameter>shareName</parameter> - the name of the new 
1445                         share.
1446                         </para></listitem>
1447                         
1448                         <listitem><para><parameter>pathName</parameter> - path to an **existing**
1449                         directory on disk.
1450                         </para></listitem>
1451                         
1452                         <listitem><para><parameter>comment</parameter> - comment string to associate 
1453                         with the new share.
1454                         </para></listitem>
1455                 </itemizedlist>
1456                 
1457                 <para>
1458                 This parameter is only used modify existing file shares definitions.  To modify 
1459                 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
1460                 </para>
1461                 
1462                 <para>
1463                 See also <link linkend="ADDSHARECOMMAND"><parameter>add share
1464                 command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter>delete 
1465                 share command</parameter></link>.
1466                 </para>
1467                 
1468                 <para>Default: <emphasis>none</emphasis></para>
1469                 <para>Example: <command>change share command = /usr/local/bin/addshare</command></para>
1470                 </listitem>
1471                 </varlistentry>
1472
1473
1474                 
1475
1476                 
1477                 <varlistentry>
1478                 <term><anchor id="COMMENT">comment (S)</term>
1479                 <listitem><para>This is a text field that is seen next to a share 
1480                 when a client does a queries the server, either via the network 
1481                 neighborhood or via <command>net view</command> to list what shares 
1482                 are available.</para>
1483
1484                 <para>If you want to set the string that is displayed next to the 
1485                 machine name then see the <link linkend="SERVERSTRING"><parameter>
1486                 server string</parameter></link> parameter.</para>
1487
1488                 <para>Default: <emphasis>No comment string</emphasis></para>
1489                 <para>Example: <command>comment = Fred's Files</command></para></listitem>
1490                 </varlistentry>
1491                 
1492                 
1493                 
1494                 <varlistentry>
1495                 <term><anchor id="CONFIGFILE">config file (G)</term>
1496                 <listitem><para>This allows you to override the config file 
1497                 to use, instead of the default (usually <filename>smb.conf</filename>). 
1498                 There is a chicken and egg problem here as this option is set 
1499                 in the config file!</para>
1500
1501                 <para>For this reason, if the name of the config file has changed 
1502                 when the parameters are loaded then it will reload them from 
1503                 the new config file.</para>
1504
1505                 <para>This option takes the usual substitutions, which can 
1506                 be very useful.</para>
1507
1508                 <para>If the config file doesn't exist then it won't be loaded 
1509                 (allowing you to special case the config files of just a few 
1510                 clients).</para>
1511
1512                 <para>Example: <command>config file = /usr/local/samba/lib/smb.conf.%m
1513                 </command></para></listitem>
1514                 </varlistentry>
1515                 
1516                 
1517                 
1518                 <varlistentry>
1519                 <term><anchor id="COPY">copy (S)</term>
1520                 <listitem><para>This parameter allows you to "clone" service 
1521                 entries. The specified service is simply duplicated under the 
1522                 current service's name. Any parameters specified in the current 
1523                 section will override those in the section being copied.</para>
1524
1525                 <para>This feature lets you set up a 'template' service and 
1526                 create similar services easily. Note that the service being 
1527                 copied must occur earlier in the configuration file than the 
1528                 service doing the copying.</para>
1529
1530                 <para>Default: <emphasis>no value</emphasis></para>
1531                 <para>Example: <command>copy = otherservice</command></para></listitem>
1532                 </varlistentry>
1533                 
1534                 
1535                 
1536                 <varlistentry>
1537                 <term><anchor id="CREATEMASK">create mask (S)</term>
1538                 <listitem><para>A synonym for this parameter is 
1539                 <link linkend="CREATEMODE"><parameter>create mode</parameter>
1540                 </link>.</para>
1541
1542                 <para>When a file is created, the necessary permissions are 
1543                 calculated according to the mapping from DOS modes to UNIX 
1544                 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed 
1545                 with this parameter. This parameter may be thought of as a bit-wise 
1546                 MASK for the UNIX modes of a file. Any bit <emphasis>not</emphasis> 
1547                 set here will be removed from the modes set on a file when it is 
1548                 created.</para>
1549
1550                 <para>The default value of this parameter removes the 
1551                 'group' and 'other' write and execute bits from the UNIX modes.</para>
1552
1553                 <para>Following this Samba will bit-wise 'OR' the UNIX mode created 
1554                 from this parameter with the value of the <link
1555                 linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>
1556                 parameter which is set to 000 by default.</para>
1557
1558                 <para>This parameter does not affect directory modes. See the 
1559                 parameter <link linkend="DIRECTORYMODE"><parameter>directory mode
1560                 </parameter></link> for details.</para>
1561
1562                 <para>See also the <link linkend="FORCECREATEMODE"><parameter>force 
1563                 create mode</parameter></link> parameter for forcing particular mode 
1564                 bits to be set on created files. See also the <link linkend="DIRECTORYMODE">
1565                 <parameter>directory mode</parameter></link> parameter for masking 
1566                 mode bits on created directories.  See also the <link linkend="INHERITPERMISSIONS">
1567                 <parameter>inherit permissions</parameter></link> parameter.</para>
1568
1569                 <para>Note that this parameter does not apply to permissions
1570                 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
1571                 a mask on access control lists also, they need to set the <link 
1572                 linkend="SECURITYMASK"><parameter>security mask</parameter></link>.</para>
1573
1574                 <para>Default: <command>create mask = 0744</command></para>
1575                 <para>Example: <command>create mask = 0775</command></para></listitem>
1576                 </varlistentry>
1577                 
1578                 
1579                 
1580                 <varlistentry>
1581                 <term><anchor id="CREATEMODE">create mode (S)</term>
1582                 <listitem><para>This is a synonym for <link linkend="CREATEMASK"><parameter>
1583                 create mask</parameter></link>.</para></listitem>
1584                 </varlistentry>
1585                 
1586                 
1587                 <varlistentry>
1588                 <term><anchor id="CSCPOLICY">csc policy (S)</term>
1589                 <listitem><para>This stands for <emphasis>client-side caching 
1590                 policy</emphasis>, and specifies how clients capable of offline
1591                 caching will cache the files in the share. The valid values
1592                 are: manual, documents, programs, disable.</para>
1593
1594                 <para>These values correspond to those used on Windows
1595                 servers.</para>
1596
1597                 <para>For example, shares containing roaming profiles can have
1598                 offline caching disabled using <command>csc policy = disable
1599                 </command>.</para>
1600
1601                 <para>Default: <command>csc policy = manual</command></para>
1602                 <para>Example: <command>csc policy = programs</command></para>
1603                 </listitem>
1604                 </varlistentry>
1605                 
1606                 <varlistentry>
1607                 <term><anchor id="DEADTIME">deadtime (G)</term>
1608                 <listitem><para>The value of the parameter (a decimal integer) 
1609                 represents the number of minutes of inactivity before a connection 
1610                 is considered dead, and it is disconnected. The deadtime only takes 
1611                 effect if the number of open files is zero.</para>
1612                 
1613                 <para>This is useful to stop a server's resources being 
1614                 exhausted by a large number of inactive connections.</para>
1615
1616                 <para>Most clients have an auto-reconnect feature when a 
1617                 connection is broken so in most cases this parameter should be 
1618                 transparent to users.</para>
1619
1620                 <para>Using this parameter with a timeout of a few minutes 
1621                 is recommended for most systems.</para>
1622
1623                 <para>A deadtime of zero indicates that no auto-disconnection 
1624                 should be performed.</para>
1625
1626                 <para>Default: <command>deadtime = 0</command></para>
1627                 <para>Example: <command>deadtime = 15</command></para></listitem>
1628                 </varlistentry>
1629
1630
1631
1632                 <varlistentry>
1633                 <term><anchor id="DEBUGHIRESTIMESTAMP">debug hires timestamp (G)</term>
1634                 <listitem><para>Sometimes the timestamps in the log messages 
1635                 are needed with a resolution of higher that seconds, this 
1636                 boolean parameter adds microsecond resolution to the timestamp 
1637                 message header when turned on.</para>
1638
1639                 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1640                 debug timestamp</parameter></link> must be on for this to have an 
1641                 effect.</para>
1642
1643                 <para>Default: <command>debug hires timestamp = no</command></para>
1644                 </listitem>
1645                 </varlistentry>
1646                 
1647
1648
1649                 <varlistentry>
1650                 <term><anchor id="DEBUGPID">debug pid (G)</term>
1651                 <listitem><para>When using only one log file for more then one 
1652                 forked <ulink url="smbd.8.html">smbd</ulink>-process there may be hard to follow which process 
1653                 outputs which message. This boolean parameter is adds the process-id 
1654                 to the timestamp message headers in the logfile when turned on.</para>
1655
1656                 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1657                 debug timestamp</parameter></link> must be on for this to have an 
1658                 effect.</para>
1659
1660                 <para>Default: <command>debug pid = no</command></para></listitem>
1661                 </varlistentry>
1662
1663
1664                 <varlistentry>
1665                 <term><anchor id="DEBUGTIMESTAMP">debug timestamp (G)</term>
1666                 <listitem><para>Samba 2.2 debug log messages are timestamped 
1667                 by default. If you are running at a high <link linkend="DEBUGLEVEL">
1668                 <parameter>debug level</parameter></link> these timestamps
1669                 can be distracting. This boolean parameter allows timestamping 
1670                 to be turned off.</para>
1671
1672                 <para>Default: <command>debug timestamp = yes</command></para></listitem>
1673                 </varlistentry>
1674
1675
1676
1677                 <varlistentry>
1678                 <term><anchor id="DEBUGUID">debug uid (G)</term>
1679                 <listitem><para>Samba is sometimes run as root and sometime 
1680                 run as the connected user, this boolean parameter inserts the 
1681                 current euid, egid, uid and gid to the timestamp message headers 
1682                 in the log file if turned on.</para>
1683                 
1684                 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1685                 debug timestamp</parameter></link> must be on for this to have an 
1686                 effect.</para>
1687
1688                 <para>Default: <command>debug uid = no</command></para></listitem>
1689                 </varlistentry>
1690
1691
1692
1693                 <varlistentry>
1694                 <term><anchor id="DEBUGLEVEL">debuglevel (G)</term>
1695                 <listitem><para>Synonym for <link linkend="LOGLEVEL"><parameter>
1696                 log level</parameter></link>.</para>
1697                 </listitem>
1698                 </varlistentry>
1699
1700
1701
1702                 <varlistentry>
1703                 <term><anchor id="DEFAULT">default (G)</term>
1704                 <listitem><para>A synonym for <link linkend="DEFAULTSERVICE"><parameter>
1705                 default service</parameter></link>.</para></listitem>
1706                 </varlistentry>
1707                 
1708                 
1709                 
1710                 <varlistentry>
1711                 <term><anchor id="DEFAULTCASE">default case (S)</term>
1712                 <listitem><para>See the section on <link linkend="NAMEMANGLINGSECT">
1713                 NAME MANGLING</link>. Also note the <link linkend="SHORTPRESERVECASE">
1714                 <parameter>short preserve case</parameter></link> parameter.</para>
1715
1716                 <para>Default: <command>default case = lower</command></para>
1717                 </listitem>
1718                 </varlistentry>
1719
1720
1721
1722                 <varlistentry>
1723                 <term><anchor id="DEFAULTDEVMODE">default devmode (S)</term>
1724                 <listitem><para>This parameter is only applicable to <link
1725                 linkend="PRINTOK">printable</link> services.  When smbd is serving
1726                 Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba
1727                 server has a Device Mode which defines things such as paper size and
1728                 orientation and duplex settings.  The device mode can only correctly be
1729                 generated by the printer driver itself (which can only be executed on a
1730                 Win32 platform).  Because smbd is unable to execute the driver code
1731                 to generate the device mode, the default behavior is to set this field
1732                 to NULL.
1733                 </para>
1734
1735                 <para>Most problems with serving printer drivers to Windows NT/2k/XP clients
1736                 can be traced to a problem with the generated device mode.  Certain drivers
1737                 will do things such as crashing the client's Explorer.exe with a NULL devmode.
1738                 However, other printer drivers can cause the client's spooler service
1739                 (spoolsv.exe) to die if the devmode was not created by the driver itself
1740                 (i.e. smbd generates a default devmode).
1741                 </para>
1742
1743                 <para>This parameter should be used with care and tested with the printer
1744                 driver in question.  It is better to leave the device mode to NULL
1745                 and let the Windows client set the correct values.  Because drivers do not
1746                 do this all the time, setting <command>default devmode = yes</command>
1747                 will instruct smbd to generate a default one.
1748                 </para>
1749
1750                 <para>For more information on Windows NT/2k printing and Device Modes,
1751                 see the <ulink url="http://msdn.microsoft.com/">MSDN documentation</ulink>.
1752                 </para>
1753
1754                 <para>Default: <command>default devmode = no</command></para>
1755                 </listitem>
1756                 </varlistentry>
1757
1758
1759
1760                 <varlistentry>
1761                 <term><anchor id="DEFAULTSERVICE">default service (G)</term>
1762                 <listitem><para>This parameter specifies the name of a service
1763                 which will be connected to if the service actually requested cannot
1764                 be found. Note that the square brackets are <emphasis>NOT</emphasis>
1765                 given in the parameter value (see example below).</para>
1766
1767                 <para>There is no default value for this parameter. If this 
1768                 parameter is not given, attempting to connect to a nonexistent 
1769                 service results in an error.</para>
1770
1771                 <para>Typically the default service would be a <link linkend="GUESTOK">
1772                 <parameter>guest ok</parameter></link>, <link linkend="READONLY">
1773                 <parameter>read-only</parameter></link> service.</para>
1774
1775                 <para>Also note that the apparent service name will be changed 
1776                 to equal that of the requested service, this is very useful as it 
1777                 allows you to use macros like <parameter>%S</parameter> to make 
1778                 a wildcard service.</para>
1779
1780                 <para>Note also that any "_" characters in the name of the service 
1781                 used in the default service will get mapped to a "/". This allows for
1782                 interesting things.</para>
1783
1784
1785                 <para>Example:</para>
1786                 
1787                 <para><programlisting>
1788 [global]
1789         default service = pub
1790         
1791 [pub]
1792         path = /%S
1793                 </programlisting></para>
1794                 </listitem>
1795                 </varlistentry>
1796                 
1797
1798
1799                 <varlistentry>
1800                 <term><anchor id="DELETEPRINTERCOMMAND">delete printer command (G)</term>
1801                 <listitem><para>With the introduction of MS-RPC based printer
1802                 support for Windows NT/2000 clients in Samba 2.2, it is now 
1803                 possible to delete printer at run time by issuing the 
1804                 DeletePrinter() RPC call.</para>
1805                 
1806                 <para>For a Samba host this means that the printer must be 
1807                 physically deleted from underlying printing system.  The <parameter>
1808                 deleteprinter command</parameter> defines a script to be run which 
1809                 will perform the necessary operations for removing the printer
1810                 from the print system and from <filename>smb.conf</filename>.
1811                 </para>
1812                 
1813                 <para>The <parameter>delete printer command</parameter> is 
1814                 automatically called with only one parameter: <parameter>
1815                 "printer name"</parameter>.</para>
1816                 
1817                                 
1818                 <para>Once the <parameter>delete printer command</parameter> has 
1819                 been executed, <command>smbd</command> will reparse the <filename>
1820                 smb.conf</filename> to associated printer no longer exists.  
1821                 If the sharename is still valid, then <command>smbd
1822                 </command> will return an ACCESS_DENIED error to the client.</para>
1823                 
1824                 <para>See also <link linkend="ADDPRINTERCOMMAND"><parameter>
1825                 add printer command</parameter></link>, <link 
1826                 linkend="printing"><parameter>printing</parameter></link>,
1827                 <link linkend="SHOWADDPRINTERWIZARD"><parameter>show add
1828                 printer wizard</parameter></link></para>
1829                 
1830                 <para>Default: <emphasis>none</emphasis></para>
1831                 <para>Example: <command>deleteprinter command = /usr/bin/removeprinter
1832                 </command></para>
1833                 </listitem>
1834                 </varlistentry>
1835
1836
1837
1838
1839
1840
1841                 <varlistentry>
1842                 <term><anchor id="DELETEREADONLY">delete readonly (S)</term>
1843                 <listitem><para>This parameter allows readonly files to be deleted.  
1844                 This is not normal DOS semantics, but is allowed by UNIX.</para>
1845                 
1846                 <para>This option may be useful for running applications such 
1847                 as rcs, where UNIX file ownership prevents changing file 
1848                 permissions, and DOS semantics prevent deletion of a read only file.</para>
1849
1850                 <para>Default: <command>delete readonly = no</command></para></listitem>
1851                 </varlistentry>
1852
1853
1854
1855                 <varlistentry>
1856                 <term><anchor id="DELETESHARECOMMAND">delete share command (G)</term>
1857                 <listitem><para>Samba 2.2.0 introduced the ability to dynamically 
1858                 add and delete shares via the Windows NT 4.0 Server Manager.  The 
1859                 <parameter>delete share command</parameter> is used to define an 
1860                 external program or script which will remove an existing service 
1861                 definition from <filename>smb.conf</filename>.  In order to successfully 
1862                 execute the <parameter>delete share command</parameter>, <command>smbd</command>
1863                 requires that the administrator be connected using a root account (i.e. 
1864                 uid == 0).
1865                 </para>
1866                 
1867                 <para>
1868                 When executed, <command>smbd</command> will automatically invoke the 
1869                 <parameter>delete share command</parameter> with two parameters.
1870                 </para>
1871                 
1872                 <itemizedlist>
1873                         <listitem><para><parameter>configFile</parameter> - the location 
1874                         of the global <filename>smb.conf</filename> file. 
1875                         </para></listitem>
1876                         
1877                         <listitem><para><parameter>shareName</parameter> - the name of 
1878                         the existing service.
1879                         </para></listitem>
1880                 </itemizedlist>
1881                 
1882                 <para>
1883                 This parameter is only used to remove file shares.  To delete printer shares, 
1884                 see the <link linkend="DELETEPRINTERCOMMAND"><parameter>delete printer 
1885                 command</parameter></link>.
1886                 </para>
1887                 
1888                 <para>
1889                 See also <link linkend="ADDSHARECOMMAND"><parameter>add share
1890                 command</parameter></link>, <link linkend="CHANGESHARECOMMAND"><parameter>change 
1891                 share command</parameter></link>.
1892                 </para>
1893                 
1894                 <para>Default: <emphasis>none</emphasis></para>
1895                 <para>Example: <command>delete share command = /usr/local/bin/delshare</command></para>
1896                 
1897                 </listitem>
1898                 </varlistentry>
1899
1900
1901                 
1902                 
1903                 <varlistentry>
1904                 <term><anchor id="DELETEUSERSCRIPT">delete user script (G)</term>
1905                 <listitem><para>This is the full pathname to a script that will 
1906                 be run <emphasis>AS ROOT</emphasis> by <ulink url="smbd.8.html">
1907                 <command>smbd(8)</command></ulink> under special circumstances 
1908                 described below.</para>
1909
1910                 <para>Normally, a Samba server requires that UNIX users are 
1911                 created for all users accessing files on this server. For sites 
1912                 that use Windows NT account databases as their primary user database 
1913                 creating these users and keeping the user list in sync with the 
1914                 Windows NT PDC is an onerous task. This option allows <command>
1915                 smbd</command> to delete the required UNIX users <emphasis>ON 
1916                 DEMAND</emphasis> when a user accesses the Samba server and the 
1917                 Windows NT user no longer exists.</para>
1918                 
1919                 <para>In order to use this option, <command>smbd</command> must be 
1920                 set to <parameter>security = domain</parameter> or <parameter>security =
1921                 user</parameter> and <parameter>delete user script</parameter> 
1922                 must be set to a full pathname for a script 
1923                 that will delete a UNIX user given one argument of <parameter>%u</parameter>, 
1924                 which expands into the UNIX user name to delete.</para>
1925
1926                 <para>When the Windows user attempts to access the Samba server, 
1927                 at <emphasis>login</emphasis> (session setup in the SMB protocol) 
1928                 time, <command>smbd</command> contacts the <link linkend="PASSWORDSERVER">
1929                 <parameter>password server</parameter></link> and attempts to authenticate 
1930                 the given user with the given password. If the authentication fails 
1931                 with the specific Domain error code meaning that the user no longer 
1932                 exists then <command>smbd</command> attempts to find a UNIX user in 
1933                 the UNIX password database that matches the Windows user account. If 
1934                 this lookup succeeds, and <parameter>delete user script</parameter> is 
1935                 set then <command>smbd</command> will all the specified script 
1936                 <emphasis>AS ROOT</emphasis>, expanding any <parameter>%u</parameter> 
1937                 argument to be the user name to delete.</para>
1938
1939                 <para>This script should delete the given UNIX username. In this way, 
1940                 UNIX users are dynamically deleted to match existing Windows NT 
1941                 accounts.</para>
1942
1943                 <para>See also <link linkend="SECURITYEQUALSDOMAIN">security = domain</link>,
1944                 <link linkend="PASSWORDSERVER"><parameter>password server</parameter>
1945                 </link>, <link linkend="ADDUSERSCRIPT"><parameter>add user script</parameter>
1946                 </link>.</para>
1947
1948                 <para>Default: <command>delete user script = &lt;empty string&gt;
1949                 </command></para>
1950                 <para>Example: <command>delete user script = /usr/local/samba/bin/del_user 
1951                 %u</command></para></listitem>
1952                 </varlistentry>
1953
1954
1955
1956
1957
1958                 <varlistentry>
1959                 <term><anchor id="DELETEVETOFILES">delete veto files (S)</term>
1960                 <listitem><para>This option is used when Samba is attempting to 
1961                 delete a directory that contains one or more vetoed directories 
1962                 (see the <link linkend="VETOFILES"><parameter>veto files</parameter></link>
1963                 option).  If this option is set to <constant>false</constant> (the default) then if a vetoed 
1964                 directory contains any non-vetoed files or directories then the 
1965                 directory delete will fail. This is usually what you want.</para>
1966
1967                 <para>If this option is set to <constant>true</constant>, then Samba 
1968                 will attempt to recursively delete any files and directories within 
1969                 the vetoed directory. This can be useful for integration with file 
1970                 serving systems such as NetAtalk which create meta-files within 
1971                 directories you might normally veto DOS/Windows users from seeing 
1972                 (e.g. <filename>.AppleDouble</filename>)</para>
1973
1974                 <para>Setting <command>delete veto files = yes</command> allows these 
1975                 directories to be  transparently deleted when the parent directory 
1976                 is deleted (so long as the user has permissions to do so).</para>
1977
1978                 <para>See also the <link linkend="VETOFILES"><parameter>veto 
1979                 files</parameter></link> parameter.</para>
1980
1981                 <para>Default: <command>delete veto files = no</command></para></listitem>
1982                 </varlistentry>
1983
1984
1985
1986
1987                 <varlistentry>
1988                 <term><anchor id="DENYHOSTS">deny hosts (S)</term>
1989                 <listitem><para>Synonym for <link linkend="HOSTSDENY"><parameter>hosts 
1990                 deny</parameter></link>.</para></listitem>
1991                 </varlistentry>
1992
1993                 
1994                 
1995                 
1996                 <varlistentry>
1997                 <term><anchor id="DFREECOMMAND">dfree command (G)</term>
1998                 <listitem><para>The <parameter>dfree command</parameter> setting should 
1999                 only be used on systems where a problem occurs with the internal 
2000                 disk space calculations. This has been known to happen with Ultrix, 
2001                 but may occur with other operating systems. The symptom that was 
2002                 seen was an error of "Abort Retry Ignore" at the end of each 
2003                 directory listing.</para>
2004                 
2005                 <para>This setting allows the replacement of the internal routines to
2006                 calculate the total disk space and amount available with an external
2007                 routine. The example below gives a possible script that might fulfill
2008                 this function.</para>
2009
2010                 <para>The external program will be passed a single parameter indicating 
2011                 a directory in the filesystem being queried. This will typically consist
2012                 of the string <filename>./</filename>. The script should return two 
2013                 integers in ASCII. The first should be the total disk space in blocks, 
2014                 and the second should be the number of available blocks. An optional 
2015                 third return value can give the block size in bytes. The default 
2016                 blocksize is 1024 bytes.</para>
2017
2018                 <para>Note: Your script should <emphasis>NOT</emphasis> be setuid or 
2019                 setgid and should be owned by (and writeable only by) root!</para>
2020
2021                 <para>Default: <emphasis>By default internal routines for 
2022                 determining the disk capacity and remaining space will be used.
2023                 </emphasis></para>
2024
2025                 <para>Example: <command>dfree command = /usr/local/samba/bin/dfree
2026                 </command></para>
2027
2028                 <para>Where the script dfree (which must be made executable) could be:</para>
2029
2030                 <para><programlisting> 
2031                 #!/bin/sh
2032                 df $1 | tail -1 | awk '{print $2" "$4}'
2033                 </programlisting></para>
2034
2035                 <para>or perhaps (on Sys V based systems):</para>
2036
2037                 <para><programlisting> 
2038                 #!/bin/sh
2039                 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2040                 </programlisting></para>
2041                 
2042                 <para>Note that you may have to replace the command names 
2043                 with full path names on some systems.</para>
2044                 </listitem>
2045                 </varlistentry>
2046                 
2047                 
2048                 
2049                 
2050                 <varlistentry>
2051                 <term><anchor id="DIRECTORY">directory (S)</term>
2052                 <listitem><para>Synonym for <link linkend="PATH"><parameter>path
2053                 </parameter></link>.</para></listitem>
2054                 </varlistentry>
2055                 
2056                 
2057                 
2058                 <varlistentry>
2059                 <term><anchor id="DIRECTORYMASK">directory mask (S)</term>
2060                 <listitem><para>This parameter is the octal modes which are 
2061                 used when converting DOS modes to UNIX modes when creating UNIX 
2062                 directories.</para>
2063
2064                 <para>When a directory is created, the necessary permissions are 
2065                 calculated according to the mapping from DOS modes to UNIX permissions, 
2066                 and the resulting UNIX mode is then bit-wise 'AND'ed with this 
2067                 parameter. This parameter may be thought of as a bit-wise MASK for 
2068                 the UNIX modes of a directory. Any bit <emphasis>not</emphasis> set 
2069                 here will be removed from the modes set on a directory when it is 
2070                 created.</para>
2071
2072                 <para>The default value of this parameter removes the 'group' 
2073                 and 'other' write bits from the UNIX mode, allowing only the 
2074                 user who owns the directory to modify it.</para>
2075                 
2076                 <para>Following this Samba will bit-wise 'OR' the UNIX mode 
2077                 created from this parameter with the value of the <link
2078                 linkend="FORCEDIRECTORYMODE"><parameter>force directory mode
2079                 </parameter></link> parameter. This parameter is set to 000 by 
2080                 default (i.e. no extra mode bits are added).</para>
2081
2082                 <para>Note that this parameter does not apply to permissions
2083                 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2084                 a mask on access control lists also, they need to set the <link 
2085                 linkend="DIRECTORYSECURITYMASK"><parameter>directory security mask</parameter></link>.</para>
2086
2087                 <para>See the <link linkend="FORCEDIRECTORYMODE"><parameter>force 
2088                 directory mode</parameter></link> parameter to cause particular mode 
2089                 bits to always be set on created directories.</para>
2090
2091                 <para>See also the <link linkend="CREATEMODE"><parameter>create mode
2092                 </parameter></link> parameter for masking mode bits on created files, 
2093                 and the <link linkend="DIRECTORYSECURITYMASK"><parameter>directory 
2094                 security mask</parameter></link> parameter.</para>
2095
2096                 <para>Also refer to the <link linkend="INHERITPERMISSIONS"><parameter>
2097                 inherit permissions</parameter></link> parameter.</para>
2098
2099                 <para>Default: <command>directory mask = 0755</command></para>
2100                 <para>Example: <command>directory mask = 0775</command></para>
2101                 </listitem>
2102                 </varlistentry>
2103
2104
2105
2106                 <varlistentry>
2107                 <term><anchor id="DIRECTORYMODE">directory mode (S)</term>
2108                 <listitem><para>Synonym for <link linkend="DIRECTORYMASK"><parameter>
2109                 directory mask</parameter></link></para></listitem>
2110                 </varlistentry>
2111                 
2112                 
2113                 
2114                 <varlistentry>
2115                 <term><anchor id="DIRECTORYSECURITYMASK">directory security mask (S)</term>
2116                 <listitem><para>This parameter controls what UNIX permission bits 
2117                 can be modified when a Windows NT client is manipulating the UNIX 
2118                 permission on a directory using the native NT security dialog 
2119                 box.</para>
2120
2121                 <para>This parameter is applied as a mask (AND'ed with) to 
2122                 the changed permission bits, thus preventing any bits not in 
2123                 this mask from being modified. Essentially, zero bits in this 
2124                 mask may be treated as a set of bits the user is not allowed 
2125                 to change.</para>
2126
2127                 <para>If not set explicitly this parameter is set to 0777
2128                 meaning a user is allowed to modify all the user/group/world
2129                 permissions on a directory.</para>
2130
2131                 <para><emphasis>Note</emphasis> that users who can access the 
2132                 Samba server through other means can easily bypass this restriction, 
2133                 so it is primarily useful for standalone "appliance" systems.  
2134                 Administrators of most normal systems will probably want to leave
2135                 it as the default of <constant>0777</constant>.</para>
2136
2137                 <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>
2138                 force directory security mode</parameter></link>, <link
2139                 linkend="SECURITYMASK"><parameter>security mask</parameter></link>, 
2140                 <link linkend="FORCESECURITYMODE"><parameter>force security mode
2141                 </parameter></link> parameters.</para>
2142
2143                 <para>Default: <command>directory security mask = 0777</command></para>
2144                 <para>Example: <command>directory security mask = 0700</command></para>
2145                 </listitem>
2146                 </varlistentry>
2147
2148
2149
2150                 <varlistentry>
2151                 <term><anchor id="DISABLESPOOLSS">disable spoolss (G)</term>
2152                 <listitem><para>Enabling this parameter will disables Samba's support
2153                 for the SPOOLSS set of MS-RPC's and will yield identical behavior
2154                 as Samba 2.0.x.  Windows NT/2000 clients will downgrade to using
2155                 Lanman style printing commands. Windows 9x/ME will be uneffected by
2156                 the parameter. However, this will also disable the ability to upload
2157                 printer drivers to a Samba server via the Windows NT Add Printer
2158                 Wizard or by using the NT printer properties dialog window.  It will
2159                 also disable the capability of Windows NT/2000 clients to download
2160                 print drivers from the Samba host upon demand.
2161                 <emphasis>Be very careful about enabling this parameter.</emphasis>
2162                 </para>
2163
2164                 <para>See also <link linkend="USECLIENTDRIVER">use client driver</link>
2165                 </para>
2166  
2167                 <para>Default : <command>disable spoolss = no</command></para>
2168                 </listitem>
2169                 </varlistentry>
2170                 
2171                 
2172                 
2173                 <varlistentry>
2174                 <term><anchor id="DNSPROXY">dns proxy (G)</term>
2175                 <listitem><para>Specifies that <ulink url="nmbd.8.html">nmbd(8)</ulink> 
2176                 when acting as a WINS server and finding that a NetBIOS name has not 
2177                 been registered, should treat the NetBIOS name word-for-word as a DNS 
2178                 name and do a lookup with the DNS server for that name on behalf of 
2179                 the name-querying client.</para>
2180
2181                 <para>Note that the maximum length for a NetBIOS name is 15 
2182                 characters, so the DNS name (or DNS alias) can likewise only be 
2183                 15 characters, maximum.</para>
2184
2185                 <para><command>nmbd</command> spawns a second copy of itself to do the
2186                 DNS name lookup requests, as doing a name lookup is a blocking 
2187                 action.</para>
2188
2189                 <para>See also the parameter <link linkend="WINSSUPPORT"><parameter>
2190                 wins support</parameter></link>.</para>
2191
2192                 <para>Default: <command>dns proxy = yes</command></para></listitem>
2193                 </varlistentry>
2194
2195
2196
2197                 <varlistentry>
2198                 <term><anchor id="DOMAINADMINGROUP">domain admin group (G)</term>
2199                 <listitem><para>This parameter is intended as a temporary solution
2200                 to enable users to be a member of the "Domain Admins" group when 
2201                 a Samba host is acting as a PDC.  A complete solution will be provided
2202                 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2203                 Please note that this parameter has a somewhat confusing name.  It 
2204                 accepts a list of usernames and of group names in standard 
2205                 <filename>smb.conf</filename>   notation.
2206                 </para>
2207                 
2208                 <para>See also <link linkend="DOMAINGUESTGROUP"><parameter>domain
2209                 guest group</parameter></link>, <link linkend="DOMAINLOGONS"><parameter>domain
2210                 logons</parameter></link>
2211                 </para>
2212                 
2213                 <para>Default: <emphasis>no domain administrators</emphasis></para>
2214                 <para>Example: <command>domain admin group = root @wheel</command></para>
2215                 </listitem>
2216                 </varlistentry>
2217
2218
2219
2220
2221                 <varlistentry>
2222                 <term><anchor id="DOMAINGUESTGROUP">domain guest group (G)</term>
2223                 <listitem><para>This parameter is intended as a temporary solution
2224                 to enable users to be a member of the "Domain Guests" group when 
2225                 a Samba host is acting as a PDC.  A complete solution will be provided
2226                 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2227                 Please note that this parameter has a somewhat confusing name.  It 
2228                 accepts a list of usernames and of group names in standard 
2229                 <filename>smb.conf</filename>   notation.
2230                 </para>
2231                 
2232                 <para>See also <link linkend="DOMAINADMINGROUP"><parameter>domain
2233                 admin group</parameter></link>, <link linkend="DOMAINLOGONS"><parameter>domain
2234                 logons</parameter></link>
2235                 </para>         
2236                 
2237                 <para>Default: <emphasis>no domain guests</emphasis></para>
2238                 <para>Example: <command>domain guest group = nobody @guest</command></para>
2239                 </listitem>
2240                 </varlistentry>
2241
2242
2243                 <varlistentry>
2244                 <term><anchor id="DOMAINLOGONS">domain logons (G)</term>
2245                 <listitem><para>If set to <constant>true</constant>, the Samba server will serve 
2246                 Windows 95/98 Domain logons for the <link linkend="WORKGROUP">
2247                 <parameter>workgroup</parameter></link> it is in. Samba 2.2 also 
2248                 has limited capability to act as a domain controller for Windows 
2249                 NT 4 Domains.  For more details on setting up this feature see 
2250                 the Samba-PDC-HOWTO included in the <filename>htmldocs/</filename>
2251                 directory shipped with the source code.</para>
2252                 
2253                 <para>Default: <command>domain logons = no</command></para></listitem>
2254                 </varlistentry>
2255                 
2256                 
2257                 
2258                 <varlistentry>
2259                 <term><anchor id="DOMAINMASTER">domain master (G)</term>
2260                 <listitem><para>Tell <ulink url="nmbd.8.html"><command>
2261                 nmbd(8)</command></ulink> to enable WAN-wide browse list
2262                 collation. Setting this option causes <command>nmbd</command> to
2263                 claim a special domain specific NetBIOS name that identifies 
2264                 it as a domain master browser for its given <link linkend="WORKGROUP">
2265                 <parameter>workgroup</parameter></link>. Local master browsers 
2266                 in the same <parameter>workgroup</parameter> on broadcast-isolated 
2267                 subnets will give this <command>nmbd</command> their local browse lists, 
2268                 and then ask <ulink url="smbd.8.html"><command>smbd(8)</command></ulink> 
2269                 for a complete copy of the browse list for the whole wide area 
2270                 network.  Browser clients will then contact their local master browser, 
2271                 and will receive the domain-wide browse list, instead of just the list 
2272                 for their broadcast-isolated subnet.</para>
2273
2274                 <para>Note that Windows NT Primary Domain Controllers expect to be 
2275                 able to claim this <parameter>workgroup</parameter> specific special 
2276                 NetBIOS name that identifies them as domain master browsers for 
2277                 that <parameter>workgroup</parameter> by default (i.e. there is no 
2278                 way to prevent a Windows NT PDC from attempting to do this). This 
2279                 means that if this parameter is set and <command>nmbd</command> claims 
2280                 the special name for a <parameter>workgroup</parameter> before a Windows 
2281                 NT PDC is able to do so then cross subnet browsing will behave 
2282                 strangely and may fail.</para>
2283                 
2284                 <para>If <link linkend="DOMAINLOGONS"><command>domain logons = yes</command>
2285                 </link>, then the default behavior is to enable the <parameter>domain 
2286                 master</parameter> parameter.  If <parameter>domain logons</parameter> is 
2287                 not enabled (the default setting), then neither will <parameter>domain 
2288                 master</parameter> be enabled by default.</para>
2289
2290                 <para>Default: <command>domain master = auto</command></para></listitem>
2291                 </varlistentry>
2292                 
2293                 
2294                 
2295                 
2296                 <varlistentry>
2297                 <term><anchor id="DONTDESCEND">dont descend (S)</term>
2298                 <listitem><para>There are certain directories on some systems 
2299                 (e.g., the <filename>/proc</filename> tree under Linux) that are either not 
2300                 of interest to clients or are infinitely deep (recursive). This 
2301                 parameter allows you to specify a comma-delimited list of directories 
2302                 that the server should always show as empty.</para>
2303
2304                 <para>Note that Samba can be very fussy about the exact format 
2305                 of the "dont descend" entries. For example you may need <filename>
2306                 ./proc</filename> instead of just <filename>/proc</filename>. 
2307                 Experimentation is the best policy :-)  </para>
2308                 
2309                 <para>Default: <emphasis>none (i.e., all directories are OK 
2310                 to descend)</emphasis></para>
2311                 <para>Example: <command>dont descend = /proc,/dev</command></para>
2312                 </listitem>
2313                 </varlistentry>
2314                 
2315
2316
2317                 <varlistentry>
2318                 <term><anchor id="DOSFILEMODE">dos filemode (S)</term>
2319                 <listitem><para> The default behavior in Samba is to provide 
2320                 UNIX-like behavior where only the owner of a file/directory is 
2321                 able to change the permissions on it.  However, this behavior
2322                 is often confusing to  DOS/Windows users.  Enabling this parameter 
2323                 allows a user who has write access to the file (by whatever 
2324                 means) to modify the permissions on it.  Note that a user
2325                 belonging to the group owning the file will not be allowed to
2326                 change permissions if the group is only granted read access.
2327                 Ownership of the file/directory is not changed, only the permissions 
2328                 are modified.</para>
2329                 
2330                 <para>Default: <command>dos filemode = no</command></para>
2331                 </listitem>
2332                 </varlistentry>
2333
2334                 
2335                 
2336                 <varlistentry>
2337                 <term><anchor id="DOSFILETIMERESOLUTION">dos filetime resolution (S)</term>
2338                 <listitem><para>Under the DOS and Windows FAT filesystem, the finest 
2339                 granularity on time resolution is two seconds. Setting this parameter 
2340                 for a share causes Samba to round the reported time down to the 
2341                 nearest two second boundary when a query call that requires one second 
2342                 resolution is made to <ulink url="smbd.8.html"><command>smbd(8)</command>
2343                 </ulink>.</para>
2344
2345                 <para>This option is mainly used as a compatibility option for Visual 
2346                 C++ when used against Samba shares. If oplocks are enabled on a 
2347                 share, Visual C++ uses two different time reading calls to check if a 
2348                 file has changed since it was last read. One of these calls uses a
2349                 one-second granularity, the other uses a two second granularity. As
2350                 the two second call rounds any odd second down, then if the file has a
2351                 timestamp of an odd number of seconds then the two timestamps will not
2352                 match and Visual C++ will keep reporting the file has changed. Setting
2353                 this option causes the two timestamps to match, and Visual C++ is
2354                 happy.</para>
2355
2356                 <para>Default: <command>dos filetime resolution = no</command></para>
2357                 </listitem>
2358                 </varlistentry>
2359
2360
2361
2362                 <varlistentry>
2363                 <term><anchor id="DOSFILETIMES">dos filetimes (S)</term>
2364                 <listitem><para>Under DOS and Windows, if a user can write to a 
2365                 file they can change the timestamp on it. Under POSIX semantics, 
2366                 only the owner of the file or root may change the timestamp. By 
2367                 default, Samba runs with POSIX semantics and refuses to change the 
2368                 timestamp on a file if the user <command>smbd</command> is acting 
2369                 on behalf of is not the file owner. Setting this option to <constant>
2370                 true</constant> allows DOS semantics and <ulink url="smbd.8.html">smbd</ulink> will change the file 
2371                 timestamp as DOS requires.</para>
2372
2373                 <para>Default: <command>dos filetimes = no</command></para></listitem>
2374                 </varlistentry>
2375
2376                 
2377
2378                 <varlistentry>
2379                 <term><anchor id="ENCRYPTPASSWORDS">encrypt passwords (G)</term>
2380                 <listitem><para>This boolean controls whether encrypted passwords 
2381                 will be negotiated with the client. Note that Windows NT 4.0 SP3 and 
2382                 above and also Windows 98 will by default expect encrypted passwords 
2383                 unless a registry entry is changed. To use encrypted passwords in 
2384                 Samba see the file ENCRYPTION.txt in the Samba documentation 
2385                 directory <filename>docs/</filename> shipped with the source code.</para>
2386
2387                 <para>In order for encrypted passwords to work correctly
2388                 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink> must either 
2389                 have access to a local <ulink url="smbpasswd.5.html"><filename>smbpasswd(5)
2390                 </filename></ulink> file (see the <ulink url="smbpasswd.8.html"><command>
2391                 smbpasswd(8)</command></ulink> program for information on how to set up 
2392                 and maintain this file), or set the <link
2393                 linkend="SECURITY">security = [server|domain|ads]</link> parameter which 
2394                 causes <command>smbd</command> to authenticate against another 
2395                 server.</para>
2396                 
2397                 <para>Default: <command>encrypt passwords = yes</command></para></listitem>
2398                 </varlistentry>
2399
2400
2401                 <varlistentry>
2402                 <term><anchor id="ENHANCEDBROWSING">enhanced browsing (G)</term>
2403                 <listitem><para>This option enables a couple of enhancements to 
2404                 cross-subnet browse propagation that have been added in Samba 
2405                 but which are not standard in Microsoft implementations.  
2406                 </para>
2407
2408                 <para>The first enhancement to browse propagation consists of a regular
2409                 wildcard query to a Samba WINS server for all Domain Master Browsers,
2410                 followed by a browse synchronization with each of the returned
2411                 DMBs. The second enhancement consists of a regular randomised browse
2412                 synchronization with all currently known DMBs.</para>
2413
2414                 <para>You may wish to disable this option if you have a problem with empty
2415                 workgroups not disappearing from browse lists. Due to the restrictions
2416                 of the browse protocols these enhancements can cause a empty workgroup
2417                 to stay around forever which can be annoying.</para>
2418
2419                 <para>In general you should leave this option enabled as it makes
2420                 cross-subnet browse propagation much more reliable.</para>
2421
2422                 <para>Default: <command>enhanced browsing = yes</command></para>
2423                 </listitem>
2424                 </varlistentry>
2425
2426
2427                 <varlistentry>
2428                 <term><anchor id="ENUMPORTSCOMMAND">enumports command (G)</term>
2429                 <listitem><para>The concept of a "port" is fairly foreign
2430                 to UNIX hosts.  Under Windows NT/2000 print servers, a port
2431                 is associated with a port monitor and generally takes the form of
2432                 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
2433                 (i.e. LPD Port Monitor, etc...).  By default, Samba has only one
2434                 port defined--<constant>"Samba Printer Port"</constant>.  Under 
2435                 Windows NT/2000, all printers must have a valid port name.  
2436                 If you wish to have a list of ports displayed (<command>smbd
2437                 </command> does not use a port name for anything) other than 
2438                 the default <constant>"Samba Printer Port"</constant>, you 
2439                 can define <parameter>enumports command</parameter> to point to
2440                 a program which should generate a list of ports, one per line,
2441                 to standard output.  This listing will then be used in response
2442                 to the level 1 and 2 EnumPorts() RPC.</para>
2443                 
2444                 <para>Default: <emphasis>no enumports command</emphasis></para>
2445                 <para>Example: <command>enumports command = /usr/bin/listports
2446                 </command></para>
2447                 </listitem>
2448                 </varlistentry>
2449                 
2450                 <varlistentry>
2451                 <term><anchor id="EXEC">exec (S)</term>
2452                 <listitem><para>This is a synonym for <link linkend="PREEXEC">
2453                 <parameter>preexec</parameter></link>.</para></listitem>
2454                 </varlistentry>
2455
2456
2457
2458                 <varlistentry>
2459                 <term><anchor id="FAKEDIRECTORYCREATETIMES">fake directory create times (S)</term>
2460                 <listitem><para>NTFS and Windows VFAT file systems keep a create 
2461                 time for all files and directories. This is not the same as the 
2462                 ctime - status change time - that Unix keeps, so Samba by default 
2463                 reports the earliest of the various times Unix does keep. Setting 
2464                 this parameter for a share causes Samba to always report midnight 
2465                 1-1-1980 as the create time for directories.</para>
2466
2467                 <para>This option is mainly used as a compatibility option for 
2468                 Visual C++ when used against Samba shares. Visual C++ generated 
2469                 makefiles have the object directory as a dependency for each object 
2470                 file, and a make rule to create the directory. Also, when NMAKE 
2471                 compares timestamps it uses the creation time when examining a 
2472                 directory. Thus the object directory will be created if it does not 
2473                 exist, but once it does exist it will always have an earlier 
2474                 timestamp than the object files it contains.</para>
2475
2476                 <para>However, Unix time semantics mean that the create time 
2477                 reported by Samba will be updated whenever a file is created or 
2478                 or deleted in the directory.  NMAKE finds all object files in 
2479                 the object directory.  The timestamp of the last one built is then 
2480                 compared to the timestamp of the object directory.  If the 
2481                 directory's timestamp if newer, then all object files
2482                 will be rebuilt.  Enabling this option 
2483                 ensures directories always predate their contents and an NMAKE build 
2484                 will proceed as expected.</para>
2485
2486                 <para>Default: <command>fake directory create times = no</command></para>
2487                 </listitem>
2488                 </varlistentry>
2489
2490
2491
2492                 <varlistentry>
2493                 <term><anchor id="FAKEOPLOCKS">fake oplocks (S)</term>
2494                 <listitem><para>Oplocks are the way that SMB clients get permission 
2495                 from a server to locally cache file operations. If a server grants 
2496                 an oplock (opportunistic lock) then the client is free to assume 
2497                 that it is the only one accessing the file and it will aggressively 
2498                 cache file data. With some oplock types the client may even cache 
2499                 file open/close operations. This can give enormous performance benefits.
2500                 </para>
2501
2502                 <para>When you set <command>fake oplocks = yes</command>, <ulink 
2503                 url="smbd.8.html"><command>smbd(8)</command></ulink> will
2504                 always grant oplock requests no matter how many clients are using 
2505                 the file.</para>
2506
2507                 <para>It is generally much better to use the real <link 
2508                 linkend="OPLOCKS"><parameter>oplocks</parameter></link> support rather 
2509                 than this parameter.</para>
2510                 
2511                 <para>If you enable this option on all read-only shares or 
2512                 shares that you know will only be accessed from one client at a 
2513                 time such as physically read-only media like CDROMs, you will see 
2514                 a big performance improvement on many operations. If you enable 
2515                 this option on shares where multiple clients may be accessing the 
2516                 files read-write at the same time you can get data corruption. Use 
2517                 this option carefully!</para>
2518                 
2519                 <para>Default: <command>fake oplocks = no</command></para></listitem>
2520                 </varlistentry>
2521
2522
2523
2524                 <varlistentry>
2525                 <term><anchor id="FOLLOWSYMLINKS">follow symlinks (S)</term>
2526                 <listitem><para>This parameter allows the Samba administrator 
2527                 to stop <ulink url="smbd.8.html"><command>smbd(8)</command></ulink> 
2528                 from following symbolic links in a particular share. Setting this 
2529                 parameter to <constant>no</constant> prevents any file or directory 
2530                 that is a symbolic link from being followed (the user will get an 
2531                 error).  This option is very useful to stop users from adding a 
2532                 symbolic link to <filename>/etc/passwd</filename> in their home 
2533                 directory for instance.  However it will slow filename lookups 
2534                 down slightly.</para>
2535
2536                 <para>This option is enabled (i.e. <command>smbd</command> will 
2537                 follow symbolic links) by default.</para>
2538                 
2539                 <para>Default: <command>follow symlinks = yes</command></para></listitem>
2540                 </varlistentry>
2541                 
2542                 
2543                 
2544                 <varlistentry>
2545                 <term><anchor id="FORCECREATEMODE">force create mode (S)</term>
2546                 <listitem><para>This parameter specifies a set of UNIX mode bit 
2547                 permissions that will <emphasis>always</emphasis> be set on a 
2548                 file created by Samba. This is done by bitwise 'OR'ing these bits onto 
2549                 the mode bits of a file that is being created or having its 
2550                 permissions changed. The default for this parameter is (in octal) 
2551                 000. The modes in this parameter are bitwise 'OR'ed onto the file 
2552                 mode after the mask set in the <parameter>create mask</parameter> 
2553                 parameter is applied.</para>
2554                 
2555                 <para>See also the parameter <link linkend="CREATEMASK"><parameter>create 
2556                 mask</parameter></link> for details on masking mode bits on files.</para>
2557
2558                 <para>See also the <link linkend="INHERITPERMISSIONS"><parameter>inherit 
2559                 permissions</parameter></link> parameter.</para>
2560
2561                 <para>Default: <command>force create mode = 000</command></para>
2562                 <para>Example: <command>force create mode = 0755</command></para>
2563
2564                 <para>would force all created files to have read and execute 
2565                 permissions set for 'group' and 'other' as well as the 
2566                 read/write/execute bits set for the 'user'.</para>
2567                 </listitem>
2568                 </varlistentry>
2569
2570
2571
2572                 <varlistentry>
2573                 <term><anchor id="FORCEDIRECTORYMODE">force directory mode (S)</term>
2574                 <listitem><para>This parameter specifies a set of UNIX mode bit 
2575                 permissions that will <emphasis>always</emphasis> be set on a directory 
2576                 created by Samba. This is done by bitwise 'OR'ing these bits onto the 
2577                 mode bits of a directory that is being created. The default for this 
2578                 parameter is (in octal) 0000 which will not add any extra permission 
2579                 bits to a created directory. This operation is done after the mode 
2580                 mask in the parameter <parameter>directory mask</parameter> is 
2581                 applied.</para>
2582
2583                 <para>See also the parameter <link linkend="DIRECTORYMASK"><parameter>
2584                 directory mask</parameter></link> for details on masking mode bits 
2585                 on created directories.</para>
2586                 
2587                 <para>See also the <link linkend="INHERITPERMISSIONS"><parameter>
2588                 inherit permissions</parameter></link> parameter.</para>
2589
2590                 <para>Default: <command>force directory mode = 000</command></para>
2591                 <para>Example: <command>force directory mode = 0755</command></para>
2592
2593                 <para>would force all created directories to have read and execute
2594                 permissions set for 'group' and 'other' as well as the
2595                 read/write/execute bits set for the 'user'.</para>
2596                 </listitem>
2597                 </varlistentry>
2598                 
2599                 
2600                 
2601                 <varlistentry>
2602                 <term><anchor id="FORCEDIRECTORYSECURITYMODE">force directory 
2603                 security mode (S)</term>
2604                 <listitem><para>This parameter controls what UNIX permission bits 
2605                 can be modified when a Windows NT client is manipulating the UNIX 
2606                 permission on a directory using the native NT security dialog box.</para>
2607
2608                 <para>This parameter is applied as a mask (OR'ed with) to the 
2609                 changed permission bits, thus forcing any bits in this mask that 
2610                 the user may have modified to be on. Essentially, one bits in this 
2611                 mask may be treated as a set of bits that, when modifying security 
2612                 on a directory, the user has always set to be 'on'.</para>
2613
2614                 <para>If not set explicitly this parameter is 000, which 
2615                 allows a user to modify all the user/group/world permissions on a 
2616                 directory without restrictions.</para>
2617
2618                 <para><emphasis>Note</emphasis> that users who can access the 
2619                 Samba server through other means can easily bypass this restriction, 
2620                 so it is primarily useful for standalone "appliance" systems.  
2621                 Administrators of most normal systems will probably want to leave
2622                 it set as 0000.</para>
2623
2624                 <para>See also the <link linkend="DIRECTORYSECURITYMASK"><parameter>
2625                 directory security mask</parameter></link>, <link linkend="SECURITYMASK">
2626                 <parameter>security mask</parameter></link>, 
2627                 <link linkend="FORCESECURITYMODE"><parameter>force security mode
2628                 </parameter></link> parameters.</para>
2629
2630                 <para>Default: <command>force directory security mode = 0</command></para>
2631                 <para>Example: <command>force directory security mode = 700</command></para>
2632                 </listitem>
2633                 </varlistentry>
2634
2635
2636
2637
2638                 <varlistentry>
2639                 <term><anchor id="FORCEGROUP">force group (S)</term>
2640                 <listitem><para>This specifies a UNIX group name that will be 
2641                 assigned as the default primary group for all users connecting 
2642                 to this service. This is useful for sharing files by ensuring 
2643                 that all access to files on service will use the named group for 
2644                 their permissions checking. Thus, by assigning permissions for this 
2645                 group to the files and directories within this service the Samba 
2646                 administrator can restrict or allow sharing of these files.</para>
2647
2648                 <para>In Samba 2.0.5 and above this parameter has extended 
2649                 functionality in the following way. If the group name listed here 
2650                 has a '+' character prepended to it then the current user accessing 
2651                 the share only has the primary group default assigned to this group 
2652