few updates. Nothing major.....
[Samba.git] / docs / docbook / manpages / smb.conf.5.sgml
blob9174c365e0d3292cef923134ce783c3efb3d4891
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2 <refentry id="smb.conf">
4 <refmeta>
5 <refentrytitle>smb.conf</refentrytitle>
6 <manvolnum>5</manvolnum>
7 </refmeta>
10 <refnamediv>
11 <refname>smb.conf</refname>
12 <refpurpose>The configuration file for the Samba suite</refpurpose>
13 </refnamediv>
15 <refsect1>
16 <title>SYNOPSIS</title>
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>
27 <refsect1>
28 <title id="FILEFORMATSECT">FILE FORMAT</title>
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>
35 <para><replaceable>name</replaceable> = <replaceable>value
36 </replaceable></para>
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>
41 <para>Section and parameter names are not case sensitive.</para>
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>
50 <para>Any line beginning with a semicolon (';') or a hash ('#')
51 character is ignored, as are lines containing only whitespace.</para>
53 <para>Any line ending in a '\' is continued
54 on the next line in the customary UNIX fashion.</para>
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>
63 <refsect1>
64 <title>SECTION DESCRIPTIONS</title>
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>
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>
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>
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>
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>
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>
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>
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>
108 <screen>
109 <computeroutput>
110 [foo]
111 path = /home/bar
112 writeable = true
113 </computeroutput>
114 </screen>
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>
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>
134 <refsect1>
135 <title>SPECIAL SECTIONS</title>
137 <refsect2>
138 <title>The [global] section</title>
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>
146 <refsect2>
147 <title id="HOMESECT">The [homes] section</title>
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>
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>
160 <para>Some modifications are then made to the newly
161 created share:</para>
163 <itemizedlist>
164 <listitem><para>The share name is changed from homes to
165 the located username.</para></listitem>
167 <listitem><para>If no path was given, the path is set to
168 the user's home directory.</para></listitem>
169 </itemizedlist>
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>
175 <para><userinput>path=/data/pchome/%S</userinput></para>
177 <para>would be useful if you have different home directories
178 for your PCs than for UNIX access.</para>
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>
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>
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>
195 <screen>
196 <computeroutput>
197 [homes]
198 writeable = yes
199 </computeroutput>
200 </screen>
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>
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 browseable=no in the [homes] section
213 will hide the [homes] share but make any auto home
214 directories visible.</para>
215 </refsect2>
217 <refsect2>
218 <title id="PRINTERSSECT">The [printers] section</title>
220 <para>This section works like [homes],
221 but for printers.</para>
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>
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>
236 <para>A few modifications are then made to the newly created
237 share:</para>
239 <itemizedlist>
240 <listitem><para>The share name is set to the located printer
241 name</para></listitem>
243 <listitem><para>If no printer name was given, the printer name
244 is set to the located printer name</para></listitem>
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>
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>
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>
260 <screen><computeroutput>
261 [printers]
262 path = /usr/spool/public
263 guest ok = yes
264 printable = yes
265 </computeroutput></screen>
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>
273 <screen>
274 <computeroutput>
275 alias|alias|alias|alias...
276 </computeroutput>
277 </screen>
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>
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>
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>
299 <refsect1>
300 <title>PARAMETERS</title>
302 <para>parameters define the specific attributes of sections.</para>
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>
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>
323 <refsect1>
324 <title>VARIABLE SUBSTITUTIONS</title>
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>
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>
335 <variablelist>
336 <varlistentry>
337 <term>%S</term>
338 <listitem><para>the name of the current service, if any.</para>
339 </listitem>
340 </varlistentry>
342 <varlistentry>
343 <term>%P</term>
344 <listitem><para>the root directory of the current service,
345 if any.</para></listitem>
346 </varlistentry>
348 <varlistentry>
349 <term>%u</term>
350 <listitem><para>user name of the current service, if any.</para>
351 </listitem>
352 </varlistentry>
354 <varlistentry>
355 <term>%g</term>
356 <listitem><para>primary group name of %u.</para></listitem>
357 </varlistentry>
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>
365 <varlistentry>
366 <term>%G</term>
367 <listitem><para>primary group name of %U.</para></listitem>
368 </varlistentry>
370 <varlistentry>
371 <term>%H</term>
372 <listitem><para>the home directory of the user given
373 by %u.</para></listitem>
374 </varlistentry>
376 <varlistentry>
377 <term>%v</term>
378 <listitem><para>the Samba version.</para></listitem>
379 </varlistentry>
381 <varlistentry>
382 <term>%h</term>
383 <listitem><para>the Internet hostname that Samba is running
384 on.</para></listitem>
385 </varlistentry>
387 <varlistentry>
388 <term>%m</term>
389 <listitem><para>the NetBIOS name of the client machine
390 (very useful).</para></listitem>
391 </varlistentry>
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></listitem>
398 </varlistentry>
400 <varlistentry>
401 <term>%M</term>
402 <listitem><para>the Internet name of the client machine.
403 </para></listitem>
404 </varlistentry>
406 <varlistentry>
407 <term>%N</term>
408 <listitem><para>the name of your NIS home directory server.
409 This is obtained from your NIS auto.map entry. If you have
410 not compiled Samba with the <emphasis>--with-automount</emphasis>
411 option then this value will be the same as %.</para>
412 </listitem>
413 </varlistentry>
415 <varlistentry>
416 <term>%p</term>
417 <listitem><para>the path of the service's home directory,
418 obtained from your NIS auto.map entry. The NIS auto.map entry
419 is split up as "%N:%p".</para></listitem>
420 </varlistentry>
422 <varlistentry>
423 <term>%R</term>
424 <listitem><para>the selected protocol level after
425 protocol negotiation. It can be one of CORE, COREPLUS,
426 LANMAN1, LANMAN2 or NT1.</para></listitem>
427 </varlistentry>
429 <varlistentry>
430 <term>%d</term>
431 <listitem><para>The process id of the current server
432 process.</para></listitem>
433 </varlistentry>
435 <varlistentry>
436 <term>%a</term>
437 <listitem><para>the architecture of the remote
438 machine. Only some are recognized, and those may not be
439 100% reliable. It currently recognizes Samba, WfWg,
440 WinNT and Win95. Anything else will be known as
441 "UNKNOWN". If it gets it wrong then sending a level
442 3 log to <ulink url="mailto:samba@samba.org">samba@samba.org
443 </ulink> should allow it to be fixed.</para></listitem>
444 </varlistentry>
446 <varlistentry>
447 <term>%I</term>
448 <listitem><para>The IP address of the client machine.</para>
449 </listitem>
450 </varlistentry>
452 <varlistentry>
453 <term>%T</term>
454 <listitem><para>the current date and time.</para></listitem>
455 </varlistentry>
457 <varlistentry>
458 <term>%$(<replaceable>envvar</replaceable>)</term>
459 <listitem><para>The value of the environment variable
460 <replaceable>envar</replaceable>.</para></listitem>
461 </varlistentry>
462 </variablelist>
464 <para>There are some quite creative things that can be done
465 with these substitutions and other smb.conf options.</para
466 </refsect1>
468 <refsect1>
469 <title id="NAMEMANGLINGSECT">NAME MANGLING</title>
471 <para>Samba supports "name mangling" so that DOS and
472 Windows clients can use files that don't conform to the 8.3 format.
473 It can also be set to adjust the case of 8.3 format filenames.</para>
475 <para>There are several options that control the way mangling is
476 performed, and they are grouped here rather than listed separately.
477 For the defaults look at the output of the testparm program. </para>
479 <para>All of these options can be set separately for each service
480 (or globally, of course). </para>
482 <para>The options are: </para>
484 <variablelist>
486 <varlistentry>
487 <term>mangle case= yes/no</term>
488 <listitem><para> controls if names that have characters that
489 aren't of the "default" case are mangled. For example,
490 if this is yes then a name like "Mail" would be mangled.
491 Default <emphasis>no</emphasis>.</para></listitem>
492 </varlistentry>
494 <varlistentry>
495 <term>case sensitive = yes/no</term>
496 <listitem><para>controls whether filenames are case sensitive. If
497 they aren't then Samba must do a filename search and match on passed
498 names. Default <emphasis>no</emphasis>.</para></listitem>
499 </varlistentry>
501 <varlistentry>
502 <term>default case = upper/lower</term>
503 <listitem><para>controls what the default case is for new
504 filenames. Default <emphasis>lower</emphasis>.</para></listitem>
505 </varlistentry>
507 <varlistentry>
508 <term>preserve case = yes/no</term>
509 <listitem><para>controls if new files are created with the
510 case that the client passes, or if they are forced to be the
511 "default" case. Default <emphasis>yes</emphasis>.
512 </para></listitem>
513 </varlistentry>
515 <varlistentry>
516 <term>short preserve case = yes/no</term>
517 <listitem><para>controls if new files which conform to 8.3 syntax,
518 that is all in upper case and of suitable length, are created
519 upper case, or if they are forced to be the "default"
520 case. This option can be use with "preserve case = yes"
521 to permit long filenames to retain their case, while short names
522 are lowercased. Default <emphasis>yes</emphasis>.</para></listitem>
523 </varlistentry>
524 </variablelist>
526 <para>By default, Samba 2.2 has the same semantics as a Windows
527 NT server, in that it is case insensitive but case preserving.</para>
529 </refsect1>
531 <refsect1>
532 <title id="VALIDATIONSECT">NOTE ABOUT USERNAME/PASSWORD VALIDATION</title>
534 <para>There are a number of ways in which a user can connect
535 to a service. The server uses the following steps in determining
536 if it will allow a connection to a specified service. If all the
537 steps fail, then the connection request is rejected. However, if one of the
538 steps succeeds, then the following steps are not checked.</para>
540 <para>If the service is marked "guest only = yes" then
541 steps 1 to 5 are skipped.</para>
543 <orderedlist numeration="Arabic">
544 <listitem><para>If the client has passed a username/password
545 pair and that username/password pair is validated by the UNIX
546 system's password programs then the connection is made as that
547 username. Note that this includes the
548 \\server\service%<replaceable>username</replaceable> method of passing
549 a username.</para></listitem>
551 <listitem><para>If the client has previously registered a username
552 with the system and now supplies a correct password for that
553 username then the connection is allowed.</para></listitem>
555 <listitem><para>The client's NetBIOS name and any previously
556 used user names are checked against the supplied password, if
557 they match then the connection is allowed as the corresponding
558 user.</para></listitem>
560 <listitem><para>If the client has previously validated a
561 username/password pair with the server and the client has passed
562 the validation token then that username is used. </para></listitem>
564 <listitem><para>If a "user = " field is given in the
565 <filename>smb.conf</filename> file for the service and the client
566 has supplied a password, and that password matches (according to
567 the UNIX system's password checking) with one of the usernames
568 from the "user=" field then the connection is made as
569 the username in the "user=" line. If one
570 of the username in the "user=" list begins with a
571 '@' then that name expands to a list of names in
572 the group of the same name.</para></listitem>
574 <listitem><para>If the service is a guest service then a
575 connection is made as the username given in the "guest
576 account =" for the service, irrespective of the
577 supplied password.</para></listitem>
578 </orderedlist>
580 </refsect1>
582 <refsect1>
583 <title>COMPLETE LIST OF GLOBAL PARAMETERS</title>
585 <para>Here is a list of all global parameters. See the section of
586 each parameter for details. Note that some are synonyms.</para>
588 <itemizedlist>
589 <listitem><para><link linkend="ADDPRINTERCOMMAND"><parameter>add printer command</parameter></link></para></listitem>
590 <listitem><para><link linkend="ADDSHARECOMMAND"><parameter>add share command</parameter></link></para></listitem>
591 <listitem><para><link linkend="ADDUSERSCRIPT"><parameter>add user script</parameter></link></para></listitem>
592 <listitem><para><link linkend="ALLOWTRUSTEDDOMAINS"><parameter>allow trusted domains</parameter></link></para></listitem>
593 <listitem><para><link linkend="ANNOUNCEAS"><parameter>announce as</parameter></link></para></listitem>
594 <listitem><para><link linkend="ANNOUNCEVERSION"><parameter>announce version</parameter></link></para></listitem>
595 <listitem><para><link linkend="AUTOSERVICES"><parameter>auto services</parameter></link></para></listitem>
596 <listitem><para><link linkend="BINDINTERFACESONLY"><parameter>bind interfaces only</parameter></link></para></listitem>
597 <listitem><para><link linkend="BROWSELIST"><parameter>browse list</parameter></link></para></listitem>
598 <listitem><para><link linkend="CHANGENOTIFYTIMEOUT"><parameter>change notify timeout</parameter></link></para></listitem>
599 <listitem><para><link linkend="CHANGESHARECOMMAND"><parameter>change share command</parameter></link></para></listitem>
600 <listitem><para><link linkend="CHARACTERSET"><parameter>character set</parameter></link></para></listitem>
601 <listitem><para><link linkend="CLIENTCODEPAGE"><parameter>client code page</parameter></link></para></listitem>
602 <listitem><para><link linkend="CODEPAGEDIRECTORY"><parameter>code page directory</parameter></link></para></listitem>
603 <listitem><para><link linkend="CODINGSYSTEM"><parameter>coding system</parameter></link></para></listitem>
604 <listitem><para><link linkend="CONFIGFILE"><parameter>config file</parameter></link></para></listitem>
605 <listitem><para><link linkend="DEADTIME"><parameter>deadtime</parameter></link></para></listitem>
606 <listitem><para><link linkend="DEBUGHIRESTIMESTAMP"><parameter>debug hires timestamp</parameter></link></para></listitem>
607 <listitem><para><link linkend="DEBUGPID"><parameter>debug pid</parameter></link></para></listitem>
608 <listitem><para><link linkend="DEBUGTIMESTAMP"><parameter>debug timestamp</parameter></link></para></listitem>
609 <listitem><para><link linkend="DEBUGUID"><parameter>debug uid</parameter></link></para></listitem>
610 <listitem><para><link linkend="DEBUGLEVEL"><parameter>debuglevel</parameter></link></para></listitem>
611 <listitem><para><link linkend="DEFAULT"><parameter>default</parameter></link></para></listitem>
612 <listitem><para><link linkend="DEFAULTSERVICE"><parameter>default service</parameter></link></para></listitem>
613 <listitem><para><link linkend="DELETEPRINTERCOMMAND"><parameter>delete printer command</parameter></link></para></listitem>
614 <listitem><para><link linkend="DELETESHARECOMMAND"><parameter>delete share command</parameter></link></para></listitem>
615 <listitem><para><link linkend="DELETEUSERSCRIPT"><parameter>delete user script</parameter></link></para></listitem>
616 <listitem><para><link linkend="DFREECOMMAND"><parameter>dfree command</parameter></link></para></listitem>
617 <listitem><para><link linkend="DNSPROXY"><parameter>dns proxy</parameter></link></para></listitem>
618 <listitem><para><link linkend="DOMAINADMINGROUP"><parameter>domain admin group</parameter></link></para></listitem>
619 <listitem><para><link linkend="DOMAINGUESTGROUP"><parameter>domain guest group</parameter></link></para></listitem>
620 <listitem><para><link linkend="DOMAINLOGONS"><parameter>domain logons</parameter></link></para></listitem>
621 <listitem><para><link linkend="DOMAINMASTER"><parameter>domain master</parameter></link></para></listitem>
622 <listitem><para><link linkend="ENCRYPTPASSWORDS"><parameter>encrypt passwords</parameter></link></para></listitem>
623 <listitem><para><link linkend="ENHANCEDBROWSING"><parameter>enhanced browsing</parameter></link></para></listitem>
624 <listitem><para><link linkend="ENUMPORTSCOMMAND"><parameter>enumports command</parameter></link></para></listitem>
625 <listitem><para><link linkend="GETWDCACHE"><parameter>getwd cache</parameter></link></para></listitem>
626 <listitem><para><link linkend="HIDELOCALUSERS"><parameter>hide local users</parameter></link></para></listitem>
627 <listitem><para><link linkend="HIDEUNREADABLE"><parameter>hide unreadable</parameter></link></para></listitem>
628 <listitem><para><link linkend="HOMEDIRMAP"><parameter>homedir map</parameter></link></para></listitem>
629 <listitem><para><link linkend="HOSTMSDFS"><parameter>host msdfs</parameter></link></para></listitem>
630 <listitem><para><link linkend="HOSTSEQUIV"><parameter>hosts equiv</parameter></link></para></listitem>
631 <listitem><para><link linkend="INTERFACES"><parameter>interfaces</parameter></link></para></listitem>
632 <listitem><para><link linkend="KEEPALIVE"><parameter>keepalive</parameter></link></para></listitem>
633 <listitem><para><link linkend="KERNELOPLOCKS"><parameter>kernel oplocks</parameter></link></para></listitem>
634 <listitem><para><link linkend="LANMANAUTH"><parameter>lanman auth</parameter></link></para></listitem>
635 <listitem><para><link linkend="LARGEREADWRITE"><parameter>large readwrite</parameter></link></para></listitem>
636 <listitem><para><link linkend="LMANNOUNCE"><parameter>lm announce</parameter></link></para></listitem>
637 <listitem><para><link linkend="LMINTERVAL"><parameter>lm interval</parameter></link></para></listitem>
638 <listitem><para><link linkend="LOADPRINTERS"><parameter>load printers</parameter></link></para></listitem>
639 <listitem><para><link linkend="LOCALMASTER"><parameter>local master</parameter></link></para></listitem>
640 <listitem><para><link linkend="LOCKDIR"><parameter>lock dir</parameter></link></para></listitem>
641 <listitem><para><link linkend="LOCKDIRECTORY"><parameter>lock directory</parameter></link></para></listitem>
642 <listitem><para><link linkend="LOGFILE"><parameter>log file</parameter></link></para></listitem>
643 <listitem><para><link linkend="LOGLEVEL"><parameter>log level</parameter></link></para></listitem>
644 <listitem><para><link linkend="LOGONDRIVE"><parameter>logon drive</parameter></link></para></listitem>
645 <listitem><para><link linkend="LOGONHOME"><parameter>logon home</parameter></link></para></listitem>
646 <listitem><para><link linkend="LOGONPATH"><parameter>logon path</parameter></link></para></listitem>
647 <listitem><para><link linkend="LOGONSCRIPT"><parameter>logon script</parameter></link></para></listitem>
648 <listitem><para><link linkend="LPQCACHETIME"><parameter>lpq cache time</parameter></link></para></listitem>
649 <listitem><para><link linkend="MACHINEPASSWORDTIMEOUT"><parameter>machine password timeout</parameter></link></para></listitem>
650 <listitem><para><link linkend="MANGLEDSTACK"><parameter>mangled stack</parameter></link></para></listitem>
651 <listitem><para><link linkend="MAPTOGUEST"><parameter>map to guest</parameter></link></para></listitem>
652 <listitem><para><link linkend="MAXDISKSIZE"><parameter>max disk size</parameter></link></para></listitem>
653 <listitem><para><link linkend="MAXLOGSIZE"><parameter>max log size</parameter></link></para></listitem>
654 <listitem><para><link linkend="MAXMUX"><parameter>max mux</parameter></link></para></listitem>
655 <listitem><para><link linkend="MAXOPENFILES"><parameter>max open files</parameter></link></para></listitem>
656 <listitem><para><link linkend="MAXPROTOCOL"><parameter>max protocol</parameter></link></para></listitem>
657 <listitem><para><link linkend="MAXSMBDPROCESSES"><parameter>max smbd processes</parameter></link></para></listitem>
658 <listitem><para><link linkend="MAXTTL"><parameter>max ttl</parameter></link></para></listitem>
659 <listitem><para><link linkend="MAXWINSTTL"><parameter>max wins ttl</parameter></link></para></listitem>
660 <listitem><para><link linkend="MAXXMIT"><parameter>max xmit</parameter></link></para></listitem>
661 <listitem><para><link linkend="MESSAGECOMMAND"><parameter>message command</parameter></link></para></listitem>
662 <listitem><para><link linkend="MINPASSWDLENGTH"><parameter>min passwd length</parameter></link></para></listitem>
663 <listitem><para><link linkend="MINPASSWORDLENGTH"><parameter>min password length</parameter></link></para></listitem>
664 <listitem><para><link linkend="MINPROTOCOL"><parameter>min protocol</parameter></link></para></listitem>
665 <listitem><para><link linkend="MINWINSTTL"><parameter>min wins ttl</parameter></link></para></listitem>
666 <listitem><para><link linkend="NAMERESOLVEORDER"><parameter>name resolve order</parameter></link></para></listitem>
667 <listitem><para><link linkend="NETBIOSALIASES"><parameter>netbios aliases</parameter></link></para></listitem>
668 <listitem><para><link linkend="NETBIOSNAME"><parameter>netbios name</parameter></link></para></listitem>
669 <listitem><para><link linkend="NETBIOSSCOPE"><parameter>netbios scope</parameter></link></para></listitem>
670 <listitem><para><link linkend="NISHOMEDIR"><parameter>nis homedir</parameter></link></para></listitem>
671 <listitem><para><link linkend="NTACLSUPPORT"><parameter>nt acl support</parameter></link></para></listitem>
672 <listitem><para><link linkend="NTPIPESUPPORT"><parameter>nt pipe support</parameter></link></para></listitem>
673 <listitem><para><link linkend="NTSMBSUPPORT"><parameter>nt smb support</parameter></link></para></listitem>
674 <listitem><para><link linkend="NULLPASSWORDS"><parameter>null passwords</parameter></link></para></listitem>
675 <listitem><para><link linkend="OBEYPAMRESTRICTIONS"><parameter>obey pam restrictions</parameter></link></para></listitem>
676 <listitem><para><link linkend="OPLOCKBREAKWAITTIME"><parameter>oplock break wait time</parameter></link></para></listitem>
677 <listitem><para><link linkend="OSLEVEL"><parameter>os level</parameter></link></para></listitem>
678 <listitem><para><link linkend="OS2DRIVERMAP"><parameter>os2 driver map</parameter></link></para></listitem>
679 <listitem><para><link linkend="PAMPASSWORDCHANGE"><parameter>pam password change</parameter></link></para></listitem>
680 <listitem><para><link linkend="PANICACTION"><parameter>panic action</parameter></link></para></listitem>
681 <listitem><para><link linkend="PASSWDCHAT"><parameter>passwd chat</parameter></link></para></listitem>
682 <listitem><para><link linkend="PASSWDCHATDEBUG"><parameter>passwd chat debug</parameter></link></para></listitem>
683 <listitem><para><link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter></link></para></listitem>
684 <listitem><para><link linkend="PASSWORDLEVEL"><parameter>password level</parameter></link></para></listitem>
685 <listitem><para><link linkend="PASSWORDSERVER"><parameter>password server</parameter></link></para></listitem>
686 <listitem><para><link linkend="PREFEREDMASTER"><parameter>prefered master</parameter></link></para></listitem>
687 <listitem><para><link linkend="PREFERREDMASTER"><parameter>preferred master</parameter></link></para></listitem>
688 <listitem><para><link linkend="PRELOAD"><parameter>preload</parameter></link></para></listitem>
689 <listitem><para><link linkend="PRINTCAP"><parameter>printcap</parameter></link></para></listitem>
690 <listitem><para><link linkend="PRINTCAPNAME"><parameter>printcap name</parameter></link></para></listitem>
691 <listitem><para><link linkend="PRINTERDRIVERFILE"><parameter>printer driver file</parameter></link></para></listitem>
692 <listitem><para><link linkend="PROTOCOL"><parameter>protocol</parameter></link></para></listitem>
693 <listitem><para><link linkend="READBMPX"><parameter>read bmpx</parameter></link></para></listitem>
694 <listitem><para><link linkend="READRAW"><parameter>read raw</parameter></link></para></listitem>
695 <listitem><para><link linkend="READSIZE"><parameter>read size</parameter></link></para></listitem>
696 <listitem><para><link linkend="REMOTEANNOUNCE"><parameter>remote announce</parameter></link></para></listitem>
697 <listitem><para><link linkend="REMOTEBROWSESYNC"><parameter>remote browse sync</parameter></link></para></listitem>
698 <listitem><para><link linkend="RESTRICTANONYMOUS"><parameter>restrict anonymous</parameter></link></para></listitem>
699 <listitem><para><link linkend="ROOT"><parameter>root</parameter></link></para></listitem>
700 <listitem><para><link linkend="ROOTDIR"><parameter>root dir</parameter></link></para></listitem>
701 <listitem><para><link linkend="ROOTDIRECTORY"><parameter>root directory</parameter></link></para></listitem>
702 <listitem><para><link linkend="SECURITY"><parameter>security</parameter></link></para></listitem>
703 <listitem><para><link linkend="SERVERSTRING"><parameter>server string</parameter></link></para></listitem>
704 <listitem><para><link linkend="SHOWADDPRINTERWIZARD"><parameter>show add printer wizard</parameter></link></para></listitem>
705 <listitem><para><link linkend="SMBPASSWDFILE"><parameter>smb passwd file</parameter></link></para></listitem>
706 <listitem><para><link linkend="SOCKETADDRESS"><parameter>socket address</parameter></link></para></listitem>
707 <listitem><para><link linkend="SOCKETOPTIONS"><parameter>socket options</parameter></link></para></listitem>
708 <listitem><para><link linkend="SOURCEENVIRONMENT"><parameter>source environment</parameter></link></para></listitem>
709 <listitem><para><link linkend="SSL"><parameter>ssl</parameter></link></para></listitem>
710 <listitem><para><link linkend="SSLCACERTDIR"><parameter>ssl CA certDir</parameter></link></para></listitem>
711 <listitem><para><link linkend="SSLCACERTFILE"><parameter>ssl CA certFile</parameter></link></para></listitem>
712 <listitem><para><link linkend="SSLCIPHERS"><parameter>ssl ciphers</parameter></link></para></listitem>
713 <listitem><para><link linkend="SSLCLIENTCERT"><parameter>ssl client cert</parameter></link></para></listitem>
714 <listitem><para><link linkend="SSLCLIENTKEY"><parameter>ssl client key</parameter></link></para></listitem>
715 <listitem><para><link linkend="SSLCOMPATIBILITY"><parameter>ssl compatibility</parameter></link></para></listitem>
716 <listitem><para><link linkend="SSLHOSTS"><parameter>ssl hosts</parameter></link></para></listitem>
717 <listitem><para><link linkend="SSLHOSTSRESIGN"><parameter>ssl hosts resign</parameter></link></para></listitem>
718 <listitem><para><link linkend="SSLREQUIRECLIENTCERT"><parameter>ssl require clientcert</parameter></link></para></listitem>
719 <listitem><para><link linkend="SSLREQUIRESERVERCERT"><parameter>ssl require servercert</parameter></link></para></listitem>
720 <listitem><para><link linkend="SSLSERVERCERT"><parameter>ssl server cert</parameter></link></para></listitem>
721 <listitem><para><link linkend="SSLSERVERKEY"><parameter>ssl server key</parameter></link></para></listitem>
722 <listitem><para><link linkend="SSLVERSION"><parameter>ssl version</parameter></link></para></listitem>
723 <listitem><para><link linkend="STATCACHE"><parameter>stat cache</parameter></link></para></listitem>
724 <listitem><para><link linkend="STATCACHESIZE"><parameter>stat cache size</parameter></link></para></listitem>
725 <listitem><para><link linkend="STRIPDOT"><parameter>strip dot</parameter></link></para></listitem>
726 <listitem><para><link linkend="SYSLOG"><parameter>syslog</parameter></link></para></listitem>
727 <listitem><para><link linkend="SYSLOGONLY"><parameter>syslog only</parameter></link></para></listitem>
728 <listitem><para><link linkend="TEMPLATEHOMEDIR"><parameter>template homedir</parameter></link></para></listitem>
729 <listitem><para><link linkend="TEMPLATESHELL"><parameter>template shell</parameter></link></para></listitem>
730 <listitem><para><link linkend="TIMEOFFSET"><parameter>time offset</parameter></link></para></listitem>
731 <listitem><para><link linkend="TIMESERVER"><parameter>time server</parameter></link></para></listitem>
732 <listitem><para><link linkend="TIMESTAMPLOGS"><parameter>timestamp logs</parameter></link></para></listitem>
733 <listitem><para><link linkend="TOTALPRINTJOBS"><parameter>total print jobs</parameter></link></para></listitem>
734 <listitem><para><link linkend="UNIXPASSWORDSYNC"><parameter>unix password sync</parameter></link></para></listitem>
735 <listitem><para><link linkend="UPDATEENCRYPTED"><parameter>update encrypted</parameter></link></para></listitem>
736 <listitem><para><link linkend="USERHOSTS"><parameter>use rhosts</parameter></link></para></listitem>
737 <listitem><para><link linkend="USERNAMELEVEL"><parameter>username level</parameter></link></para></listitem>
738 <listitem><para><link linkend="USERNAMEMAP"><parameter>username map</parameter></link></para></listitem>
739 <listitem><para><link linkend="UTMP"><parameter>utmp</parameter></link></para></listitem>
740 <listitem><para><link linkend="UTMPDIRECTORY"><parameter>utmp directory</parameter></link></para></listitem>
741 <listitem><para><link linkend="VALIDCHARS"><parameter>valid chars</parameter></link></para></listitem>
742 <listitem><para><link linkend="WINBINDCACHETIME"><parameter>winbind cache time</parameter></link></para></listitem>
743 <listitem><para><link linkend="WINBINDGID"><parameter>winbind gid</parameter></link></para></listitem>
744 <listitem><para><link linkend="WINBINDSEPARATOR"><parameter>winbind separator</parameter></link></para></listitem>
745 <listitem><para><link linkend="WINBINDUID"><parameter>winbind uid</parameter></link></para></listitem>
746 <listitem><para><link linkend="WINSHOOK"><parameter>wins hook</parameter></link></para></listitem>
747 <listitem><para><link linkend="WINSPROXY"><parameter>wins proxy</parameter></link></para></listitem>
748 <listitem><para><link linkend="WINSSERVER"><parameter>wins server</parameter></link></para></listitem>
749 <listitem><para><link linkend="WINSSUPPORT"><parameter>wins support</parameter></link></para></listitem>
750 <listitem><para><link linkend="WORKGROUP"><parameter>workgroup</parameter></link></para></listitem>
751 <listitem><para><link linkend="WRITERAW"><parameter>write raw</parameter></link></para></listitem>
752 </itemizedlist>
754 </refsect1>
756 <refsect1>
757 <title>COMPLETE LIST OF SERVICE PARAMETERS</title>
759 <para>Here is a list of all service parameters. See the section on
760 each parameter for details. Note that some are synonyms.</para>
762 <itemizedlist>
763 <listitem><para><link linkend="ADMINUSERS"><parameter>admin users</parameter></link></para></listitem>
764 <listitem><para><link linkend="ALLOWHOSTS"><parameter>allow hosts</parameter></link></para></listitem>
765 <listitem><para><link linkend="AVAILABLE"><parameter>available</parameter></link></para></listitem>
766 <listitem><para><link linkend="BLOCKINGLOCKS"><parameter>blocking locks</parameter></link></para></listitem>
767 <listitem><para><link linkend="BROWSABLE"><parameter>browsable</parameter></link></para></listitem>
768 <listitem><para><link linkend="BROWSEABLE"><parameter>browseable</parameter></link></para></listitem>
769 <listitem><para><link linkend="CASESENSITIVE"><parameter>case sensitive</parameter></link></para></listitem>
770 <listitem><para><link linkend="CASESIGNAMES"><parameter>casesignames</parameter></link></para></listitem>
771 <listitem><para><link linkend="COMMENT"><parameter>comment</parameter></link></para></listitem>
772 <listitem><para><link linkend="COPY"><parameter>copy</parameter></link></para></listitem>
773 <listitem><para><link linkend="CREATEMASK"><parameter>create mask</parameter></link></para></listitem>
774 <listitem><para><link linkend="CREATEMODE"><parameter>create mode</parameter></link></para></listitem>
775 <listitem><para><link linkend="DEFAULTCASE"><parameter>default case</parameter></link></para></listitem>
776 <listitem><para><link linkend="DELETEREADONLY"><parameter>delete readonly</parameter></link></para></listitem>
777 <listitem><para><link linkend="DELETEVETOFILES"><parameter>delete veto files</parameter></link></para></listitem>
778 <listitem><para><link linkend="DENYHOSTS"><parameter>deny hosts</parameter></link></para></listitem>
779 <listitem><para><link linkend="DIRECTORY"><parameter>directory</parameter></link></para></listitem>
780 <listitem><para><link linkend="DIRECTORYMASK"><parameter>directory mask</parameter></link></para></listitem>
781 <listitem><para><link linkend="DIRECTORYMODE"><parameter>directory mode</parameter></link></para></listitem>
782 <listitem><para><link linkend="DIRECTORYSECURITYMASK"><parameter>directory security mask</parameter></link></para></listitem>
783 <listitem><para><link linkend="DONTDESCEND"><parameter>dont descend</parameter></link></para></listitem>
784 <listitem><para><link linkend="DOSFILEMODE"><parameter>dos filemode</parameter></link></para></listitem>
785 <listitem><para><link linkend="DOSFILETIMERESOLUTION"><parameter>dos filetime resolution</parameter></link></para></listitem>
786 <listitem><para><link linkend="DOSFILETIMES"><parameter>dos filetimes</parameter></link></para></listitem>
787 <listitem><para><link linkend="EXEC"><parameter>exec</parameter></link></para></listitem>
788 <listitem><para><link linkend="FAKEDIRECTORYCREATETIMES"><parameter>fake directory create times</parameter></link></para></listitem>
789 <listitem><para><link linkend="FAKEOPLOCKS"><parameter>fake oplocks</parameter></link></para></listitem>
790 <listitem><para><link linkend="FOLLOWSYMLINKS"><parameter>follow symlinks</parameter></link></para></listitem>
791 <listitem><para><link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link></para></listitem>
792 <listitem><para><link linkend="FORCEDIRECTORYMODE"><parameter>force directory mode</parameter></link></para></listitem>
793 <listitem><para><link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>force directory security mode</parameter></link></para></listitem>
794 <listitem><para><link linkend="FORCEGROUP"><parameter>force group</parameter></link></para></listitem>
795 <listitem><para><link linkend="FORCESECURITYMODE"><parameter>force security mode</parameter></link></para></listitem>
796 <listitem><para><link linkend="FORCEUSER"><parameter>force user</parameter></link></para></listitem>
797 <listitem><para><link linkend="FSTYPE"><parameter>fstype</parameter></link></para></listitem>
798 <listitem><para><link linkend="GROUP"><parameter>group</parameter></link></para></listitem>
799 <listitem><para><link linkend="GUESTACCOUNT"><parameter>guest account</parameter></link></para></listitem>
800 <listitem><para><link linkend="GUESTOK"><parameter>guest ok</parameter></link></para></listitem>
801 <listitem><para><link linkend="GUESTONLY"><parameter>guest only</parameter></link></para></listitem>
802 <listitem><para><link linkend="HIDEDOTFILES"><parameter>hide dot files</parameter></link></para></listitem>
803 <listitem><para><link linkend="HIDEFILES"><parameter>hide files</parameter></link></para></listitem>
804 <listitem><para><link linkend="HOSTSALLOW"><parameter>hosts allow</parameter></link></para></listitem>
805 <listitem><para><link linkend="HOSTSDENY"><parameter>hosts deny</parameter></link></para></listitem>
806 <listitem><para><link linkend="INCLUDE"><parameter>include</parameter></link></para></listitem>
807 <listitem><para><link linkend="INHERITPERMISSIONS"><parameter>inherit permissions</parameter></link></para></listitem>
808 <listitem><para><link linkend="INVALIDUSERS"><parameter>invalid users</parameter></link></para></listitem>
809 <listitem><para><link linkend="LEVEL2OPLOCKS"><parameter>level2 oplocks</parameter></link></para></listitem>
810 <listitem><para><link linkend="LOCKING"><parameter>locking</parameter></link></para></listitem>
811 <listitem><para><link linkend="LPPAUSECOMMAND"><parameter>lppause command</parameter></link></para></listitem>
812 <listitem><para><link linkend="LPQCOMMAND"><parameter>lpq command</parameter></link></para></listitem>
813 <listitem><para><link linkend="LPRESUMECOMMAND"><parameter>lpresume command</parameter></link></para></listitem>
814 <listitem><para><link linkend="LPRMCOMMAND"><parameter>lprm command</parameter></link></para></listitem>
815 <listitem><para><link linkend="MAGICOUTPUT"><parameter>magic output</parameter></link></para></listitem>
816 <listitem><para><link linkend="MAGICSCRIPT"><parameter>magic script</parameter></link></para></listitem>
817 <listitem><para><link linkend="MANGLECASE"><parameter>mangle case</parameter></link></para></listitem>
818 <listitem><para><link linkend="MANGLEDMAP"><parameter>mangled map</parameter></link></para></listitem>
819 <listitem><para><link linkend="MANGLEDNAMES"><parameter>mangled names</parameter></link></para></listitem>
820 <listitem><para><link linkend="MANGLINGCHAR"><parameter>mangling char</parameter></link></para></listitem>
821 <listitem><para><link linkend="MAPARCHIVE"><parameter>map archive</parameter></link></para></listitem>
822 <listitem><para><link linkend="MAPHIDDEN"><parameter>map hidden</parameter></link></para></listitem>
823 <listitem><para><link linkend="MAPSYSTEM"><parameter>map system</parameter></link></para></listitem>
824 <listitem><para><link linkend="MAXCONNECTIONS"><parameter>max connections</parameter></link></para></listitem>
825 <listitem><para><link linkend="MAXPRINTJOBS"><parameter>max print jobs</parameter></link></para></listitem>
826 <listitem><para><link linkend="MINPRINTSPACE"><parameter>min print space</parameter></link></para></listitem>
827 <listitem><para><link linkend="MSDFSROOT"><parameter>msdfs root</parameter></link></para></listitem>
828 <listitem><para><link linkend="ONLYGUEST"><parameter>only guest</parameter></link></para></listitem>
829 <listitem><para><link linkend="ONLYUSER"><parameter>only user</parameter></link></para></listitem>
830 <listitem><para><link linkend="OPLOCKCONTENTIONLIMIT"><parameter>oplock contention limit</parameter></link></para></listitem>
831 <listitem><para><link linkend="OPLOCKS"><parameter>oplocks</parameter></link></para></listitem>
832 <listitem><para><link linkend="PATH"><parameter>path</parameter></link></para></listitem>
833 <listitem><para><link linkend="POSIXLOCKING"><parameter>posix locking</parameter></link></para></listitem>
834 <listitem><para><link linkend="POSTEXEC"><parameter>postexec</parameter></link></para></listitem>
835 <listitem><para><link linkend="POSTSCRIPT"><parameter>postscript</parameter></link></para></listitem>
836 <listitem><para><link linkend="PREEXEC"><parameter>preexec</parameter></link></para></listitem>
837 <listitem><para><link linkend="PREEXECCLOSE"><parameter>preexec close</parameter></link></para></listitem>
838 <listitem><para><link linkend="PRESERVECASE"><parameter>preserve case</parameter></link></para></listitem>
839 <listitem><para><link linkend="PRINTCOMMAND"><parameter>print command</parameter></link></para></listitem>
840 <listitem><para><link linkend="PRINTOK"><parameter>print ok</parameter></link></para></listitem>
841 <listitem><para><link linkend="PRINTABLE"><parameter>printable</parameter></link></para></listitem>
842 <listitem><para><link linkend="PRINTER"><parameter>printer</parameter></link></para></listitem>
843 <listitem><para><link linkend="PRINTERADMIN"><parameter>printer admin</parameter></link></para></listitem>
844 <listitem><para><link linkend="PRINTERDRIVER"><parameter>printer driver</parameter></link></para></listitem>
845 <listitem><para><link linkend="PRINTERDRIVERLOCATION"><parameter>printer driver location</parameter></link></para></listitem>
846 <listitem><para><link linkend="PRINTERNAME"><parameter>printer name</parameter></link></para></listitem>
847 <listitem><para><link linkend="PRINTING"><parameter>printing</parameter></link></para></listitem>
848 <listitem><para><link linkend="PUBLIC"><parameter>public</parameter></link></para></listitem>
849 <listitem><para><link linkend="QUEUEPAUSECOMMAND"><parameter>queuepause command</parameter></link></para></listitem>
850 <listitem><para><link linkend="QUEUERESUMECOMMAND"><parameter>queueresume command</parameter></link></para></listitem>
851 <listitem><para><link linkend="READLIST"><parameter>read list</parameter></link></para></listitem>
852 <listitem><para><link linkend="READONLY"><parameter>read only</parameter></link></para></listitem>
853 <listitem><para><link linkend="ROOTPOSTEXEC"><parameter>root postexec</parameter></link></para></listitem>
854 <listitem><para><link linkend="ROOTPREEXEC"><parameter>root preexec</parameter></link></para></listitem>
855 <listitem><para><link linkend="ROOTPREEXECCLOSE"><parameter>root preexec close</parameter></link></para></listitem>
856 <listitem><para><link linkend="SECURITYMASK"><parameter>security mask</parameter></link></para></listitem>
857 <listitem><para><link linkend="SETDIRECTORY"><parameter>set directory</parameter></link></para></listitem>
858 <listitem><para><link linkend="SHAREMODES"><parameter>share modes</parameter></link></para></listitem>
859 <listitem><para><link linkend="SHORTPRESERVECASE"><parameter>short preserve case</parameter></link></para></listitem>
860 <listitem><para><link linkend="STATUS"><parameter>status</parameter></link></para></listitem>
861 <listitem><para><link linkend="STRICTLOCKING"><parameter>strict locking</parameter></link></para></listitem>
862 <listitem><para><link linkend="STRICTSYNC"><parameter>strict sync</parameter></link></para></listitem>
863 <listitem><para><link linkend="SYNCALWAYS"><parameter>sync always</parameter></link></para></listitem>
864 <listitem><para><link linkend="USER"><parameter>user</parameter></link></para></listitem>
865 <listitem><para><link linkend="USERNAME"><parameter>username</parameter></link></para></listitem>
866 <listitem><para><link linkend="USERS"><parameter>users</parameter></link></para></listitem>
867 <listitem><para><link linkend="VALIDUSERS"><parameter>valid users</parameter></link></para></listitem>
868 <listitem><para><link linkend="VETOFILES"><parameter>veto files</parameter></link></para></listitem>
869 <listitem><para><link linkend="VETOOPLOCKFILES"><parameter>veto oplock files</parameter></link></para></listitem>
870 <listitem><para><link linkend="VFSOBJECT"><parameter>vfs object</parameter></link></para></listitem>
871 <listitem><para><link linkend="VFSOPTIONS"><parameter>vfs options</parameter></link></para></listitem>
872 <listitem><para><link linkend="VOLUME"><parameter>volume</parameter></link></para></listitem>
873 <listitem><para><link linkend="WIDELINKS"><parameter>wide links</parameter></link></para></listitem>
874 <listitem><para><link linkend="WRITABLE"><parameter>writable</parameter></link></para></listitem>
875 <listitem><para><link linkend="WRITECACHESIZE"><parameter>write cache size</parameter></link></para></listitem>
876 <listitem><para><link linkend="WRITELIST"><parameter>write list</parameter></link></para></listitem>
877 <listitem><para><link linkend="WRITEOK"><parameter>write ok</parameter></link></para></listitem>
878 <listitem><para><link linkend="WRITEABLE"><parameter>writeable</parameter></link></para></listitem>
879 </itemizedlist>
881 </refsect1>
883 <refsect1>
884 <title>EXPLANATION OF EACH PARAMETER</title>
886 <variablelist>
889 <varlistentry>
890 <term><anchor id="ADDPRINTERCOMMAND">add printer command (G)</term>
891 <listitem><para>With the introduction of MS-RPC based printing
892 support for Windows NT/2000 clients in Samba 2.2, The MS Add
893 Printer Wizard (APW) icon is now also available in the
894 "Printers..." folder displayed a share listing. The APW
895 allows for printers to be add remotely to a Samba or Windows
896 NT/2000 print server.</para>
898 <para>For a Samba host this means that the printer must be
899 physically added to the underlying printing system. The <parameter>add
900 printer command</parameter> defines a script to be run which
901 will perform the necessary operations for adding the printer
902 to the print system and to add the appropriate service definition
903 to the <filename>smb.conf</filename> file in order that it can be
904 shared by <ulink url="smbd.8.html"><command>smbd(8)</command>
905 </ulink>.</para>
907 <para>The <parameter>add printer command</parameter> is
908 automatically invoked with the following parameter (in
909 order:</para>
911 <itemizedlist>
912 <listitem><para><parameter>printer name</parameter></para></listitem>
913 <listitem><para><parameter>share name</parameter></para></listitem>
914 <listitem><para><parameter>port name</parameter></para></listitem>
915 <listitem><para><parameter>driver name</parameter></para></listitem>
916 <listitem><para><parameter>location</parameter></para></listitem>
917 <listitem><para><parameter>Windows 9x driver location</parameter>
918 </para></listitem>
919 </itemizedlist>
921 <para>All parameters are filled in from the PRINTER_INFO_2 structure sent
922 by the Windows NT/2000 client with one exception. The "Windows 9x
923 driver location" parameter is included for backwards compatibility
924 only. The remaining fields in the structure are generated from answers
925 to the APW questions.</para>
927 <para>Once the <parameter>add printer command</parameter> has
928 been executed, <command>smbd</command> will reparse the <filename>
929 smb.conf</filename> to determine if the share defined by the APW
930 exists. If the sharename is still invalid, then <command>smbd
931 </command> will return an ACCESS_DENIED error to the client.</para>
933 <para>See also <link linkend="DELETEPRINTERCOMMAND"><parameter>
934 delete printer command</parameter></link>, <link
935 linkend="printing"><parameter>printing</parameter></link>,
936 <link linkend="SHOWADDPRINTERWIZARD"><parameter>show add
937 printer wizard</parameter></link></para>
939 <para>Default: <emphasis>none</emphasis></para>
940 <para>Example: <command>addprinter command = /usr/bin/addprinter
941 </command></para>
942 </listitem>
943 </varlistentry>
947 <varlistentry>
948 <term><anchor id="ADDSHARECOMMAND">add share command (G)</term>
949 <listitem><para>Samba 2.2.0 introduced the ability to dynamically
950 add and delete shares via the Windows NT 4.0 Server Manager. The
951 <parameter>add share command</parameter> is used to define an
952 external program or script which will add a new service definition
953 to <filename>smb.conf</filename>. In order to successfully
954 execute the <parameter>add share command</parameter>, <command>smbd</command>
955 requires that the administrator be connected using a root account (i.e.
956 uid == 0).
957 </para>
959 <para>
960 When executed, <command>smbd</command> will automatically invoke the
961 <parameter>add share command</parameter> with four parameters.
962 </para>
964 <itemizedlist>
965 <listitem><para><parameter>configFile</parameter> - the location
966 of the global <filename>smb.conf</filename> file.
967 </para></listitem>
969 <listitem><para><parameter>shareName</parameter> - the name of the new
970 share.
971 </para></listitem>
973 <listitem><para><parameter>pathName</parameter> - path to an **existing**
974 directory on disk.
975 </para></listitem>
977 <listitem><para><parameter>comment</parameter> - comment string to associate
978 with the new share.
979 </para></listitem>
980 </itemizedlist>
982 <para>
983 This parameter is only used for add file shares. To add printer shares,
984 see the <link linkend="ADDPRINTERCOMMAND"><parameter>add printer
985 command</parameter></link>.
986 </para>
988 <para>
989 See also <link linkend="CHANGESHARECOMMAND"><parameter>change share
990 command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter>delete share
991 command</parameter></link>.
992 </para>
994 <para>Default: <emphasis>none</emphasis></para>
995 <para>Example: <command>add share command = /usr/local/bin/addshare</command></para>
996 </listitem>
997 </varlistentry>
1001 <varlistentry>
1002 <term><anchor id="ADDUSERSCRIPT">add user script (G)</term>
1003 <listitem><para>This is the full pathname to a script that will
1004 be run <emphasis>AS ROOT</emphasis> by <ulink url="smbd.8.html">smbd(8)
1005 </ulink> under special circumstances described below.</para>
1007 <para>Normally, a Samba server requires that UNIX users are
1008 created for all users accessing files on this server. For sites
1009 that use Windows NT account databases as their primary user database
1010 creating these users and keeping the user list in sync with the
1011 Windows NT PDC is an onerous task. This option allows <ulink
1012 url="smbd.8.html">smbd</ulink> to create the required UNIX users
1013 <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.</para>
1015 <para>In order to use this option, <ulink url="smbd.8.html">smbd</ulink>
1016 must be set to <parameter>security=server</parameter> or <parameter>
1017 security=domain</parameter> and <parameter>add user script</parameter>
1018 must be set to a full pathname for a script that will create a UNIX
1019 user given one argument of <parameter>%u</parameter>, which expands into
1020 the UNIX user name to create.</para>
1022 <para>When the Windows user attempts to access the Samba server,
1023 at login (session setup in the SMB protocol) time, <ulink url="smbd.8.html">
1024 smbd</ulink> contacts the <parameter>password server</parameter> and
1025 attempts to authenticate the given user with the given password. If the
1026 authentication succeeds then <command>smbd</command>
1027 attempts to find a UNIX user in the UNIX password database to map the
1028 Windows user into. If this lookup fails, and <parameter>add user script
1029 </parameter> is set then <command>smbd</command> will
1030 call the specified script <emphasis>AS ROOT</emphasis>, expanding
1031 any <parameter>%u</parameter> argument to be the user name to create.</para>
1033 <para>If this script successfully creates the user then <command>smbd
1034 </command> will continue on as though the UNIX user
1035 already existed. In this way, UNIX users are dynamically created to
1036 match existing Windows NT accounts.</para>
1038 <para>See also <link linkend="SECURITY"><parameter>
1039 security</parameter></link>, <link linkend="PASSWORDSERVER">
1040 <parameter>password server</parameter></link>,
1041 <link linkend="DELETEUSERSCRIPT"><parameter>delete user
1042 script</parameter></link>.</para>
1044 <para>Default: <command>add user script = &lt;empty string&gt;
1045 </command></para>
1047 <para>Example: <command>add user script = /usr/local/samba/bin/add_user
1048 %u</command></para>
1049 </listitem>
1050 </varlistentry>
1054 <varlistentry>
1055 <term><anchor id="ADMINUSERS">admin users (S)</term>
1056 <listitem><para>This is a list of users who will be granted
1057 administrative privileges on the share. This means that they
1058 will do all file operations as the super-user (root).</para>
1060 <para>You should use this option very carefully, as any user in
1061 this list will be able to do anything they like on the share,
1062 irrespective of file permissions.</para>
1064 <para>Default: <emphasis>no admin users</emphasis></para>
1066 <para>Example: <command>admin users = jason</command></para>
1067 </listitem>
1068 </varlistentry>
1072 <varlistentry>
1073 <term><anchor id="ALLOWHOSTS">allow hosts (S)</term>
1074 <listitem><para>Synonym for <link linkend="HOSTSALLOW">
1075 <parameter>hosts allow</parameter></link>.</para></listitem>
1076 </varlistentry>
1080 <varlistentry>
1081 <term><anchor id="ALLOWTRUSTEDDOMAINS">allow trusted domains (G)</term>
1082 <listitem><para>This option only takes effect when the <link
1083 linkend="SECURITY"><parameter>security</parameter></link> option is set to
1084 <constant>server</constant> or <constant>domain</constant>.
1085 If it is set to no, then attempts to connect to a resource from
1086 a domain or workgroup other than the one which <ulink url="smbd.8.html">smbd</ulink> is running
1087 in will fail, even if that domain is trusted by the remote server
1088 doing the authentication.</para>
1090 <para>This is useful if you only want your Samba server to
1091 serve resources to users in the domain it is a member of. As
1092 an example, suppose that there are two domains DOMA and DOMB. DOMB
1093 is trusted by DOMA, which contains the Samba server. Under normal
1094 circumstances, a user with an account in DOMB can then access the
1095 resources of a UNIX account with the same account name on the
1096 Samba server even if they do not have an account in DOMA. This
1097 can make implementing a security boundary difficult.</para>
1099 <para>Default: <command>allow trusted domains = yes</command></para>
1101 </listitem>
1102 </varlistentry>
1106 <varlistentry>
1107 <term><anchor id="ANNOUNCEAS">announce as (G)</term>
1108 <listitem><para>This specifies what type of server
1109 <ulink url="nmbd.8.html"><command>nmbd</command></ulink>
1110 will announce itself as, to a network neighborhood browse
1111 list. By default this is set to Windows NT. The valid options
1112 are : "NT Server" (which can also be written as "NT"),
1113 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
1114 Windows NT Workstation, Windows 95 and Windows for Workgroups
1115 respectively. Do not change this parameter unless you have a
1116 specific need to stop Samba appearing as an NT server as this
1117 may prevent Samba servers from participating as browser servers
1118 correctly.</para>
1120 <para>Default: <command>announce as = NT Server</command></para>
1122 <para>Example: <command>announce as = Win95</command></para>
1123 </listitem>
1124 </varlistentry>
1128 <varlistentry>
1129 <term><anchor id="ANNOUNCEVERSION">announce version (G)</term>
1130 <listitem><para>This specifies the major and minor version numbers
1131 that nmbd will use when announcing itself as a server. The default
1132 is 4.2. Do not change this parameter unless you have a specific
1133 need to set a Samba server to be a downlevel server.</para>
1135 <para>Default: <command>announce version = 4.5</command></para>
1137 <para>Example: <command>announce version = 2.0</command></para>
1138 </listitem>
1139 </varlistentry>
1143 <varlistentry>
1144 <term><anchor id="AUTOSERVICES">auto services (G)</term>
1145 <listitem><para>This is a synonym for the <link linkend="PRELOAD">
1146 <parameter>preload</parameter></link>.</para>
1147 </listitem>
1148 </varlistentry>
1152 <varlistentry>
1153 <term><anchor id="AVAILABLE">available (S)</term>
1154 <listitem><para>This parameter lets you "turn off" a service. If
1155 <parameter>available = no</parameter>, then <emphasis>ALL</emphasis>
1156 attempts to connect to the service will fail. Such failures are
1157 logged.</para>
1159 <para>Default: <command>available = yes</command></para>
1161 </listitem>
1162 </varlistentry>
1166 <varlistentry>
1167 <term><anchor id="BINDINTERFACESONLY">bind interfaces only (G)</term>
1168 <listitem><para>This global parameter allows the Samba admin
1169 to limit what interfaces on a machine will serve SMB requests. If
1170 affects file service <ulink url="smbd.8.html">smbd(8)</ulink> and
1171 name service <ulink url="nmbd.8.html">nmbd(8)</ulink> in slightly
1172 different ways.</para>
1174 <para>For name service it causes <command>nmbd</command> to bind
1175 to ports 137 and 138 on the interfaces listed in the <link
1176 linkend="INTERFACES">interfaces</link> parameter. <command>nmbd
1177 </command> also binds to the "all addresses" interface (0.0.0.0)
1178 on ports 137 and 138 for the purposes of reading broadcast messages.
1179 If this option is not set then <command>nmbd</command> will service
1180 name requests on all of these sockets. If <parameter>bind interfaces
1181 only</parameter> is set then <command>nmbd</command> will check the
1182 source address of any packets coming in on the broadcast sockets
1183 and discard any that don't match the broadcast addresses of the
1184 interfaces in the <parameter>interfaces</parameter> parameter list.
1185 As unicast packets are received on the other sockets it allows
1186 <command>nmbd</command> to refuse to serve names to machines that
1187 send packets that arrive through any interfaces not listed in the
1188 <parameter>interfaces</parameter> list. IP Source address spoofing
1189 does defeat this simple check, however so it must not be used
1190 seriously as a security feature for <command>nmbd</command>.</para>
1192 <para>For file service it causes <ulink url="smbd.8.html">smbd(8)</ulink>
1193 to bind only to the interface list given in the <link linkend="INTERFACES">
1194 interfaces</link> parameter. This restricts the networks that
1195 <command>smbd</command> will serve to packets coming in those
1196 interfaces. Note that you should not use this parameter for machines
1197 that are serving PPP or other intermittent or non-broadcast network
1198 interfaces as it will not cope with non-permanent interfaces.</para>
1200 <para>If <parameter>bind interfaces only</parameter> is set then
1201 unless the network address <emphasis>127.0.0.1</emphasis> is added
1202 to the <parameter>interfaces</parameter> parameter list <ulink
1203 url="smbpasswd.8.html"><command>smbpasswd(8)</command></ulink>
1204 and <ulink url="swat.8.html"><command>swat(8)</command></ulink> may
1205 not work as expected due to the reasons covered below.</para>
1207 <para>To change a users SMB password, the <command>smbpasswd</command>
1208 by default connects to the <emphasis>localhost - 127.0.0.1</emphasis>
1209 address as an SMB client to issue the password change request. If
1210 <parameter>bind interfaces only</parameter> is set then unless the
1211 network address <emphasis>127.0.0.1</emphasis> is added to the
1212 <parameter>interfaces</parameter> parameter list then <command>
1213 smbpasswd</command> will fail to connect in it's default mode.
1214 <command>smbpasswd</command> can be forced to use the primary IP interface
1215 of the local host by using its <ulink url="smbpasswd.8.html#minusr">
1216 <parameter>-r <replaceable>remote machine</replaceable></parameter>
1217 </ulink> parameter, with <replaceable>remote machine</replaceable> set
1218 to the IP name of the primary interface of the local host.</para>
1220 <para>The <command>swat</command> status page tries to connect with
1221 <command>smbd</command> and <command>nmbd</command> at the address
1222 <emphasis>127.0.0.1</emphasis> to determine if they are running.
1223 Not adding <emphasis>127.0.0.1</emphasis> will cause <command>
1224 smbd</command> and <command>nmbd</command> to always show
1225 "not running" even if they really are. This can prevent <command>
1226 swat</command> from starting/stopping/restarting <command>smbd</command>
1227 and <command>nmbd</command>.</para>
1229 <para>Default: <command>bind interfaces only = no</command></para>
1231 </listitem>
1232 </varlistentry>
1236 <varlistentry>
1237 <term><anchor id="BLOCKINGLOCKS">blocking locks (S)</term>
1238 <listitem><para>This parameter controls the behavior of <ulink
1239 url="smbd.8.html">smbd(8)</ulink> when given a request by a client
1240 to obtain a byte range lock on a region of an open file, and the
1241 request has a time limit associated with it.</para>
1243 <para>If this parameter is set and the lock range requested
1244 cannot be immediately satisfied, Samba 2.2 will internally
1245 queue the lock request, and periodically attempt to obtain
1246 the lock until the timeout period expires.</para>
1248 <para>If this parameter is set to <constant>false</constant>, then
1249 Samba 2.2 will behave as previous versions of Samba would and
1250 will fail the lock request immediately if the lock range
1251 cannot be obtained.</para>
1253 <para>Default: <command>blocking locks = yes</command></para>
1255 </listitem>
1256 </varlistentry>
1260 <varlistentry>
1261 <term><anchor id="BROWSABLE">browsable (S)</term>
1262 <listitem><para>See the <link linkend="BROWSEABLE"><parameter>
1263 browseable</parameter></link>.</para></listitem>
1264 </varlistentry>
1268 <varlistentry>
1269 <term><anchor id="BROWSELIST">browse list (G)</term>
1270 <listitem><para>This controls whether <ulink url="smbd.8.html">
1271 <command>smbd(8)</command></ulink> will serve a browse list to
1272 a client doing a <command>NetServerEnum</command> call. Normally
1273 set to <constant>true</constant>. You should never need to change
1274 this.</para>
1276 <para>Default: <command>browse list = yes</command></para></listitem>
1277 </varlistentry>
1281 <varlistentry>
1282 <term><anchor id="BROWSEABLE">browseable (S)</term>
1283 <listitem><para>This controls whether this share is seen in
1284 the list of available shares in a net view and in the browse list.</para>
1286 <para>Default: <command>browseable = yes</command></para>
1287 </listitem>
1288 </varlistentry>
1292 <varlistentry>
1293 <term><anchor id="CASESENSITIVE">case sensitive (S)</term>
1294 <listitem><para>See the discussion in the section <link
1295 linkend="NAMEMANGLINGSECT">NAME MANGLING</link>.</para>
1297 <para>Default: <command>case sensitive = no</command></para>
1298 </listitem>
1299 </varlistentry>
1303 <varlistentry>
1304 <term><anchor id="CASESIGNAMES">casesignames (S)</term>
1305 <listitem><para>Synonym for <link linkend="CASESENSITIVE">case
1306 sensitive</link>.</para></listitem>
1307 </varlistentry>
1311 <varlistentry>
1312 <term><anchor id="CHANGENOTIFYTIMEOUT">change notify timeout (G)</term>
1313 <listitem><para>This SMB allows a client to tell a server to
1314 "watch" a particular directory for any changes and only reply to
1315 the SMB request when a change has occurred. Such constant scanning of
1316 a directory is expensive under UNIX, hence an <ulink url="smbd.8.html">
1317 <command>smbd(8)</command></ulink> daemon only performs such a scan
1318 on each requested directory once every <parameter>change notify
1319 timeout</parameter> seconds.</para>
1321 <para>Default: <command>change notify timeout = 60</command></para>
1322 <para>Example: <command>change notify timeout = 300</command></para>
1324 <para>Would change the scan time to every 5 minutes.</para></listitem>
1325 </varlistentry>
1329 <varlistentry>
1330 <term><anchor id="CHANGESHARECOMMAND">change share command (G)</term>
1331 <listitem><para>Samba 2.2.0 introduced the ability to dynamically
1332 add and delete shares via the Windows NT 4.0 Server Manager. The
1333 <parameter>change share command</parameter> is used to define an
1334 external program or script which will modify an existing service definition
1335 in <filename>smb.conf</filename>. In order to successfully
1336 execute the <parameter>change share command</parameter>, <command>smbd</command>
1337 requires that the administrator be connected using a root account (i.e.
1338 uid == 0).
1339 </para>
1341 <para>
1342 When executed, <command>smbd</command> will automatically invoke the
1343 <parameter>change share command</parameter> with four parameters.
1344 </para>
1346 <itemizedlist>
1347 <listitem><para><parameter>configFile</parameter> - the location
1348 of the global <filename>smb.conf</filename> file.
1349 </para></listitem>
1351 <listitem><para><parameter>shareName</parameter> - the name of the new
1352 share.
1353 </para></listitem>
1355 <listitem><para><parameter>pathName</parameter> - path to an **existing**
1356 directory on disk.
1357 </para></listitem>
1359 <listitem><para><parameter>comment</parameter> - comment string to associate
1360 with the new share.
1361 </para></listitem>
1362 </itemizedlist>
1364 <para>
1365 This parameter is only used modify existing file shares definitions. To modify
1366 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
1367 </para>
1369 <para>
1370 See also <link linkend="ADDSHARECOMMAND"><parameter>add share
1371 command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter>delete
1372 share command</parameter></link>.
1373 </para>
1375 <para>Default: <emphasis>none</emphasis></para>
1376 <para>Example: <command>change share command = /usr/local/bin/addshare</command></para>
1377 </listitem>
1378 </varlistentry>
1382 <varlistentry>
1383 <term><anchor id="CHARACTERSET">character set (G)</term>
1384 <listitem><para>This allows <ulink url="smbd.8.html">smbd</ulink> to map incoming filenames
1385 from a DOS Code page (see the <link linkend="CLIENTCODEPAGE">client
1386 code page</link> parameter) to several built in UNIX character sets.
1387 The built in code page translations are:</para>
1389 <itemizedlist>
1390 <listitem><para><constant>ISO8859-1</constant> : Western European
1391 UNIX character set. The parameter <parameter>client code page</parameter>
1392 <emphasis>MUST</emphasis> be set to code page 850 if the
1393 <parameter>character set</parameter> parameter is set to
1394 <constant>ISO8859-1</constant> in order for the conversion to the
1395 UNIX character set to be done correctly.</para></listitem>
1397 <listitem><para><constant>ISO8859-2</constant> : Eastern European
1398 UNIX character set. The parameter <parameter>client code page
1399 </parameter> <emphasis>MUST</emphasis> be set to code page 852 if
1400 the <parameter> character set</parameter> parameter is set
1401 to <constant>ISO8859-2</constant> in order for the conversion
1402 to the UNIX character set to be done correctly. </para></listitem>
1404 <listitem><para><constant>ISO8859-5</constant> : Russian Cyrillic
1405 UNIX character set. The parameter <parameter>client code page
1406 </parameter> <emphasis>MUST</emphasis> be set to code page
1407 866 if the <parameter>character set </parameter> parameter is
1408 set to <constant>ISO8859-5</constant> in order for the conversion
1409 to the UNIX character set to be done correctly. </para></listitem>
1411 <listitem><para><constant>ISO8859-7</constant> : Greek UNIX
1412 character set. The parameter <parameter>client code page
1413 </parameter> <emphasis>MUST</emphasis> be set to code page
1414 737 if the <parameter>character set</parameter> parameter is
1415 set to <constant>ISO8859-7</constant> in order for the conversion
1416 to the UNIX character set to be done correctly.</para></listitem>
1418 <listitem><para><constant>KOI8-R</constant> : Alternate mapping
1419 for Russian Cyrillic UNIX character set. The parameter
1420 <parameter>client code page</parameter> <emphasis>MUST</emphasis>
1421 be set to code page 866 if the <parameter>character set</parameter>
1422 parameter is set to <constant>KOI8-R</constant> in order for the
1423 conversion to the UNIX character set to be done correctly.</para>
1424 </listitem>
1425 </itemizedlist>
1427 <para><emphasis>BUG</emphasis>. These MSDOS code page to UNIX character
1428 set mappings should be dynamic, like the loading of MS DOS code pages,
1429 not static.</para>
1431 <para>Normally this parameter is not set, meaning no filename
1432 translation is done.</para>
1434 <para>Default: <command>character set = &lt;empty string&gt;</command></para>
1435 <para>Example: <command>character set = ISO8859-1</command></para></listitem>
1436 </varlistentry>
1440 <varlistentry>
1441 <term><anchor id="CLIENTCODEPAGE">client code page (G)</term>
1442 <listitem><para>This parameter specifies the DOS code page
1443 that the clients accessing Samba are using. To determine what code
1444 page a Windows or DOS client is using, open a DOS command prompt
1445 and type the command <command>chcp</command>. This will output
1446 the code page. The default for USA MS-DOS, Windows 95, and
1447 Windows NT releases is code page 437. The default for western
1448 European releases of the above operating systems is code page 850.</para>
1450 <para>This parameter tells <ulink url="smbd.8.html">smbd(8)</ulink>
1451 which of the <filename>codepage.<replaceable>XXX</replaceable>
1452 </filename> files to dynamically load on startup. These files,
1453 described more fully in the manual page <ulink url="make_smbcodepage.1.html">
1454 <command>make_smbcodepage(1)</command></ulink>, tell <command>
1455 smbd</command> how to map lower to upper case characters to provide
1456 the case insensitivity of filenames that Windows clients expect.</para>
1458 <para>Samba currently ships with the following code page files :</para>
1460 <itemizedlist>
1461 <listitem><para>Code Page 437 - MS-DOS Latin US</para></listitem>
1462 <listitem><para>Code Page 737 - Windows '95 Greek</para></listitem>
1463 <listitem><para>Code Page 850 - MS-DOS Latin 1</para></listitem>
1464 <listitem><para>Code Page 852 - MS-DOS Latin 2</para></listitem>
1465 <listitem><para>Code Page 861 - MS-DOS Icelandic</para></listitem>
1466 <listitem><para>Code Page 866 - MS-DOS Cyrillic</para></listitem>
1467 <listitem><para>Code Page 932 - MS-DOS Japanese SJIS</para></listitem>
1468 <listitem><para>Code Page 936 - MS-DOS Simplified Chinese</para></listitem>
1469 <listitem><para>Code Page 949 - MS-DOS Korean Hangul</para></listitem>
1470 <listitem><para>Code Page 950 - MS-DOS Traditional Chinese</para></listitem>
1471 </itemizedlist>
1473 <para>Thus this parameter may have any of the values 437, 737, 850, 852,
1474 861, 932, 936, 949, or 950. If you don't find the codepage you need,
1475 read the comments in one of the other codepage files and the
1476 <command>make_smbcodepage(1)</command> man page and write one. Please
1477 remember to donate it back to the Samba user community.</para>
1479 <para>This parameter co-operates with the <parameter>valid
1480 chars</parameter> parameter in determining what characters are
1481 valid in filenames and how capitalization is done. If you set both
1482 this parameter and the <parameter>valid chars</parameter> parameter
1483 the <parameter>client code page</parameter> parameter
1484 <emphasis>MUST</emphasis> be set before the <parameter>valid
1485 chars</parameter> parameter in the <filename>smb.conf</filename>
1486 file. The <parameter>valid chars</parameter> string will then
1487 augment the character settings in the <parameter>client code page</parameter>
1488 parameter.</para>
1490 <para>If not set, <parameter>client code page</parameter> defaults
1491 to 850.</para>
1493 <para>See also : <link linkend="VALIDCHARS"><parameter>valid
1494 chars</parameter></link>, <link linkend="CODEPAGEDIRECTORY">
1495 <parameter>code page directory</parameter></link></para>
1497 <para>Default: <command>client code page = 850</command></para>
1498 <para>Example: <command>client code page = 936</command></para>
1499 </listitem>
1500 </varlistentry>
1505 <varlistentry>
1506 <term><anchor id="CODEPAGEDIRECTORY">code page directory (G)</term>
1507 <listitem><para>Define the location of the various client code page
1508 files.</para>
1510 <para>See also <link linkend="CLIENTCODEPAGE"><parameter>client
1511 code page</parameter></link></para>
1513 <para>Default: <command>code page directory = ${prefix}/lib/codepages
1514 </command></para>
1515 <para>Example: <command>code page directory = /usr/share/samba/codepages
1516 </command></para>
1517 </listitem>
1518 </varlistentry>
1524 <varlistentry>
1525 <term><anchor id="CODINGSYSTEM">coding system (G)</term>
1526 <listitem><para>This parameter is used to determine how incoming
1527 Shift-JIS Japanese characters are mapped from the incoming <link
1528 linkend="CLIENTCODEPAGE"><parameter>client code page</parameter>
1529 </link> used by the client, into file names in the UNIX filesystem.
1530 Only useful if <parameter>client code page</parameter> is set to
1531 932 (Japanese Shift-JIS). The options are :</para>
1533 <itemizedlist>
1534 <listitem><para><constant>SJIS</constant> - Shift-JIS. Does no
1535 conversion of the incoming filename.</para></listitem>
1537 <listitem><para><constant>JIS8, J8BB, J8BH, J8@B,
1538 J8@J, J8@H </constant> - Convert from incoming Shift-JIS to eight
1539 bit JIS code with different shift-in, shift out codes.</para></listitem>
1541 <listitem><para><constant>JIS7, J7BB, J7BH, J7@B, J7@J,
1542 J7@H </constant> - Convert from incoming Shift-JIS to seven bit
1543 JIS code with different shift-in, shift out codes.</para></listitem>
1545 <listitem><para><constant>JUNET, JUBB, JUBH, JU@B, JU@J, JU@H </constant>
1546 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
1547 shift out codes.</para></listitem>
1549 <listitem><para><constant>EUC</constant> - Convert an incoming
1550 Shift-JIS character to EUC code.</para></listitem>
1552 <listitem><para><constant>HEX</constant> - Convert an incoming
1553 Shift-JIS character to a 3 byte hex representation, i.e.
1554 <constant>:AB</constant>.</para></listitem>
1556 <listitem><para><constant>CAP</constant> - Convert an incoming
1557 Shift-JIS character to the 3 byte hex representation used by
1558 the Columbia AppleTalk Program (CAP), i.e. <constant>:AB</constant>.
1559 This is used for compatibility between Samba and CAP.</para></listitem>
1560 </itemizedlist>
1562 <para>Default: <command>coding system = &lt;empty value&gt;</command>
1563 </para>
1564 </listitem>
1565 </varlistentry>
1569 <varlistentry>
1570 <term><anchor id="COMMENT">comment (S)</term>
1571 <listitem><para>This is a text field that is seen next to a share
1572 when a client does a queries the server, either via the network
1573 neighborhood or via <command>net view</command> to list what shares
1574 are available.</para>
1576 <para>If you want to set the string that is displayed next to the
1577 machine name then see the <link linkend="SERVERSTRING"><parameter>
1578 server string</parameter></link> parameter.</para>
1580 <para>Default: <emphasis>No comment string</emphasis></para>
1581 <para>Example: <command>comment = Fred's Files</command></para></listitem>
1582 </varlistentry>
1586 <varlistentry>
1587 <term><anchor id="CONFIGFILE">config file (G)</term>
1588 <listitem><para>This allows you to override the config file
1589 to use, instead of the default (usually <filename>smb.conf</filename>).
1590 There is a chicken and egg problem here as this option is set
1591 in the config file!</para>
1593 <para>For this reason, if the name of the config file has changed
1594 when the parameters are loaded then it will reload them from
1595 the new config file.</para>
1597 <para>This option takes the usual substitutions, which can
1598 be very useful.</para>
1600 <para>If the config file doesn't exist then it won't be loaded
1601 (allowing you to special case the config files of just a few
1602 clients).</para>
1604 <para>Example: <command>config file = /usr/local/samba/lib/smb.conf.%m
1605 </command></para></listitem>
1606 </varlistentry>
1610 <varlistentry>
1611 <term><anchor id="COPY">copy (S)</term>
1612 <listitem><para>This parameter allows you to "clone" service
1613 entries. The specified service is simply duplicated under the
1614 current service's name. Any parameters specified in the current
1615 section will override those in the section being copied.</para>
1617 <para>This feature lets you set up a 'template' service and
1618 create similar services easily. Note that the service being
1619 copied must occur earlier in the configuration file than the
1620 service doing the copying.</para>
1622 <para>Default: <emphasis>no value</emphasis></para>
1623 <para>Example: <command>copy = otherservice</command></para></listitem>
1624 </varlistentry>
1628 <varlistentry>
1629 <term><anchor id="CREATEMASK">create mask (S)</term>
1630 <listitem><para>A synonym for this parameter is
1631 <link linkend="CREATEMODE"><parameter>create mode</parameter>
1632 </link>.</para>
1634 <para>When a file is created, the necessary permissions are
1635 calculated according to the mapping from DOS modes to UNIX
1636 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
1637 with this parameter. This parameter may be thought of as a bit-wise
1638 MASK for the UNIX modes of a file. Any bit <emphasis>not</emphasis>
1639 set here will be removed from the modes set on a file when it is
1640 created.</para>
1642 <para>The default value of this parameter removes the
1643 'group' and 'other' write and execute bits from the UNIX modes.</para>
1645 <para>Following this Samba will bit-wise 'OR' the UNIX mode created
1646 from this parameter with the value of the <link
1647 linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>
1648 parameter which is set to 000 by default.</para>
1650 <para>This parameter does not affect directory modes. See the
1651 parameter <link linkend="DIRECTORYMODE"><parameter>directory mode
1652 </parameter></link> for details.</para>
1654 <para>See also the <link linkend="FORCECREATEMODE"><parameter>force
1655 create mode</parameter></link> parameter for forcing particular mode
1656 bits to be set on created files. See also the <link linkend="DIRECTORYMODE">
1657 <parameter>directory mode"</parameter></link> parameter for masking
1658 mode bits on created directories. See also the <link linkend="INHERITPERMISSIONS">
1659 <parameter>inherit permissions</parameter></link> parameter.</para>
1661 <para>Note that this parameter does not apply to permissions
1662 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
1663 a mask on access control lists also, they need to set the <link
1664 linkend="SECURITYMASK"><parameter>security mask</parameter></link>.</para>
1666 <para>Default: <command>create mask = 0744</command></para>
1667 <para>Example: <command>create mask = 0775</command></para></listitem>
1668 </varlistentry>
1672 <varlistentry>
1673 <term><anchor id="CREATEMODE">create mode (S)</term>
1674 <listitem><para>This is a synonym for <link linkend="CREATEMASK"><parameter>
1675 create mask</parameter></link>.</para></listitem>
1676 </varlistentry>
1680 <varlistentry>
1681 <term><anchor id="DEADTIME">deadtime (G)</term>
1682 <listitem><para>The value of the parameter (a decimal integer)
1683 represents the number of minutes of inactivity before a connection
1684 is considered dead, and it is disconnected. The deadtime only takes
1685 effect if the number of open files is zero.</para>
1687 <para>This is useful to stop a server's resources being
1688 exhausted by a large number of inactive connections.</para>
1690 <para>Most clients have an auto-reconnect feature when a
1691 connection is broken so in most cases this parameter should be
1692 transparent to users.</para>
1694 <para>Using this parameter with a timeout of a few minutes
1695 is recommended for most systems.</para>
1697 <para>A deadtime of zero indicates that no auto-disconnection
1698 should be performed.</para>
1700 <para>Default: <command>deadtime = 0</command></para>
1701 <para>Example: <command>deadtime = 15</command></para></listitem>
1702 </varlistentry>
1706 <varlistentry>
1707 <term><anchor id="DEBUGHIRESTIMESTAMP">debug hires timestamp (G)</term>
1708 <listitem><para>Sometimes the timestamps in the log messages
1709 are needed with a resolution of higher that seconds, this
1710 boolean parameter adds microsecond resolution to the timestamp
1711 message header when turned on.</para>
1713 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1714 debug timestamp</parameter></link> must be on for this to have an
1715 effect.</para>
1717 <para>Default: <command>debug hires timestamp = no</command></para>
1718 </listitem>
1719 </varlistentry>
1723 <varlistentry>
1724 <term><anchor id="DEBUGPID">debug pid (G)</term>
1725 <listitem><para>When using only one log file for more then one
1726 forked <ulink url="smbd.8.html">smbd</ulink>-process there may be hard to follow which process
1727 outputs which message. This boolean parameter is adds the process-id
1728 to the timestamp message headers in the logfile when turned on.</para>
1730 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1731 debug timestamp</parameter></link> must be on for this to have an
1732 effect.</para>
1734 <para>Default: <command>debug pid = no</command></para></listitem>
1735 </varlistentry>
1738 <varlistentry>
1739 <term><anchor id="DEBUGTIMESTAMP">debug timestamp (G)</term>
1740 <listitem><para>Samba 2.2 debug log messages are timestamped
1741 by default. If you are running at a high <link linkend="DEBUGLEVEL">
1742 <parameter>debug level</parameter></link> these timestamps
1743 can be distracting. This boolean parameter allows timestamping
1744 to be turned off.</para>
1746 <para>Default: <command>debug timestamp = yes</command></para></listitem>
1747 </varlistentry>
1751 <varlistentry>
1752 <term><anchor id="DEBUGUID">debug uid (G)</term>
1753 <listitem><para>Samba is sometimes run as root and sometime
1754 run as the connected user, this boolean parameter inserts the
1755 current euid, egid, uid and gid to the timestamp message headers
1756 in the log file if turned on.</para>
1758 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1759 debug timestamp</parameter></link> must be on for this to have an
1760 effect.</para>
1762 <para>Default: <command>debug uid = no</command></para></listitem>
1763 </varlistentry>
1767 <varlistentry>
1768 <term><anchor id="DEBUGLEVEL">debuglevel (G)</term>
1769 <listitem><para>Synonym for <link linkend="LOGLEVEL"><parameter>
1770 log level</parameter></link>.</para>
1771 </listitem>
1772 </varlistentry>
1776 <varlistentry>
1777 <term><anchor id="DEFAULT">default (G)</term>
1778 <listitem><para>A synonym for <link linkend="DEFAULTSERVICE"><parameter>
1779 default service</parameter></link>.</para></listitem>
1780 </varlistentry>
1784 <varlistentry>
1785 <term><anchor id="DEFAULTCASE">default case (S)</term>
1786 <listitem><para>See the section on <link linkend="NAMEMANGLINGSECT">
1787 NAME MANGLING</link>. Also note the <link linkend="SHORTPRESERVECASE">
1788 <parameter>short preserve case"</parameter></link> parameter.</para>
1790 <para>Default: <command>default case = lower</command></para>
1791 </listitem>
1792 </varlistentry>
1796 <varlistentry>
1797 <term><anchor id="DEFAULTSERVICE">default service (G)</term>
1798 <listitem><para>This parameter specifies the name of a service
1799 which will be connected to if the service actually requested cannot
1800 be found. Note that the square brackets are <emphasis>NOT</emphasis>
1801 given in the parameter value (see example below).</para>
1803 <para>There is no default value for this parameter. If this
1804 parameter is not given, attempting to connect to a nonexistent
1805 service results in an error.</para>
1807 <para>Typically the default service would be a <link linkend="GUESTOK">
1808 <parameter>guest ok</parameter></link>, <link linkend="READONLY">
1809 <parameter>read-only</parameter></link> service.</para>
1811 <para>Also note that the apparent service name will be changed
1812 to equal that of the requested service, this is very useful as it
1813 allows you to use macros like <parameter>%S</parameter> to make
1814 a wildcard service.</para>
1816 <para>Note also that any "_" characters in the name of the service
1817 used in the default service will get mapped to a "/". This allows for
1818 interesting things.</para>
1821 <para>Example:</para>
1823 <para><programlisting>
1824 [global]
1825 default service = pub
1827 [pub]
1828 path = /%S
1829 </programlisting></para>
1830 </listitem>
1831 </varlistentry>
1835 <varlistentry>
1836 <term><anchor id="DELETEPRINTERCOMMAND">delete printer command (G)</term>
1837 <listitem><para>With the introduction of MS-RPC based printer
1838 support for Windows NT/2000 clients in Samba 2.2, it is now
1839 possible to delete printer at run time by issuing the
1840 DeletePrinter() RPC call.</para>
1842 <para>For a Samba host this means that the printer must be
1843 physically deleted from underlying printing system. The <parameter>
1844 deleteprinter command</parameter> defines a script to be run which
1845 will perform the necessary operations for removing the printer
1846 from the print system and from <filename>smb.conf</filename>.
1847 </para>
1849 <para>The <parameter>delete printer command</parameter> is
1850 automatically called with only one parameter: <parameter>
1851 "printer name"</parameter>.</para>
1854 <para>Once the <parameter>delete printer command</parameter> has
1855 been executed, <command>smbd</command> will reparse the <filename>
1856 smb.conf</filename> to associated printer no longer exists.
1857 If the sharename is still valid, then <command>smbd
1858 </command> will return an ACCESS_DENIED error to the client.</para>
1860 <para>See also <link linkend="ADDPRINTERCOMMAND"><parameter>
1861 add printer command</parameter></link>, <link
1862 linkend="printing"><parameter>printing</parameter></link>,
1863 <link linkend="SHOWADDPRINTERWIZARD"><parameter>show add
1864 printer wizard</parameter></link></para>
1866 <para>Default: <emphasis>none</emphasis></para>
1867 <para>Example: <command>deleteprinter command = /usr/bin/removeprinter
1868 </command></para>
1869 </listitem>
1870 </varlistentry>
1877 <varlistentry>
1878 <term><anchor id="DELETEREADONLY">delete readonly (S)</term>
1879 <listitem><para>This parameter allows readonly files to be deleted.
1880 This is not normal DOS semantics, but is allowed by UNIX.</para>
1882 <para>This option may be useful for running applications such
1883 as rcs, where UNIX file ownership prevents changing file
1884 permissions, and DOS semantics prevent deletion of a read only file.</para>
1886 <para>Default: <command>delete readonly = no</command></para></listitem>
1887 </varlistentry>
1891 <varlistentry>
1892 <term><anchor id="DELETESHARECOMMAND">delete share command (G)</term>
1893 <listitem><para>Samba 2.2.0 introduced the ability to dynamically
1894 add and delete shares via the Windows NT 4.0 Server Manager. The
1895 <parameter>delete share command</parameter> is used to define an
1896 external program or script which will remove an existing service
1897 definition from <filename>smb.conf</filename>. In order to successfully
1898 execute the <parameter>delete share command</parameter>, <command>smbd</command>
1899 requires that the administrator be connected using a root account (i.e.
1900 uid == 0).
1901 </para>
1903 <para>
1904 When executed, <command>smbd</command> will automatically invoke the
1905 <parameter>delete share command</parameter> with two parameters.
1906 </para>
1908 <itemizedlist>
1909 <listitem><para><parameter>configFile</parameter> - the location
1910 of the global <filename>smb.conf</filename> file.
1911 </para></listitem>
1913 <listitem><para><parameter>shareName</parameter> - the name of
1914 the existing service.
1915 </para></listitem>
1916 </itemizedlist>
1918 <para>
1919 This parameter is only used to remove file shares. To delete printer shares,
1920 see the <link linkend="DELETEPRINTERCOMMAND"><parameter>delete printer
1921 command</parameter></link>.
1922 </para>
1924 <para>
1925 See also <link linkend="ADDSHARECOMMAND"><parameter>delete share
1926 command</parameter></link>, <link linkend="CHANGESHARECOMMAND"><parameter>change
1927 share</parameter></link>.
1928 </para>
1930 <para>Default: <emphasis>none</emphasis></para>
1931 <para>Example: <command>delete share command = /usr/local/bin/delshare</command></para>
1933 </listitem>
1934 </varlistentry>
1939 <varlistentry>
1940 <term><anchor id="DELETEUSERSCRIPT">delete user script (G)</term>
1941 <listitem><para>This is the full pathname to a script that will
1942 be run <emphasis>AS ROOT</emphasis> by <ulink url="smbd.8.html">
1943 <command>smbd(8)</command></ulink> under special circumstances
1944 described below.</para>
1946 <para>Normally, a Samba server requires that UNIX users are
1947 created for all users accessing files on this server. For sites
1948 that use Windows NT account databases as their primary user database
1949 creating these users and keeping the user list in sync with the
1950 Windows NT PDC is an onerous task. This option allows <command>
1951 smbd</command> to delete the required UNIX users <emphasis>ON
1952 DEMAND</emphasis> when a user accesses the Samba server and the
1953 Windows NT user no longer exists.</para>
1955 <para>In order to use this option, <command>smbd</command> must be
1956 set to <parameter>security=domain</parameter> and <parameter>delete
1957 user script</parameter> must be set to a full pathname for a script
1958 that will delete a UNIX user given one argument of <parameter>%u
1959 </parameter>, which expands into the UNIX user name to delete.
1960 <emphasis>NOTE</emphasis> that this is different to the <link
1961 linkend="ADDUSERSCRIPT"><parameter>add user script</parameter></link>
1962 which will work with the <parameter>security=server</parameter> option
1963 as well as <parameter>security=domain</parameter>. The reason for this
1964 is only when Samba is a domain member does it get the information
1965 on an attempted user logon that a user no longer exists. In the
1966 <parameter>security=server</parameter> mode a missing user
1967 is treated the same as an invalid password logon attempt. Deleting
1968 the user in this circumstance would not be a good idea.</para>
1970 <para>When the Windows user attempts to access the Samba server,
1971 at <emphasis>login</emphasis> (session setup in the SMB protocol)
1972 time, <command>smbd</command> contacts the <link linkend="PASSWORDSERVER">
1973 <parameter>password server</parameter></link> and attempts to authenticate
1974 the given user with the given password. If the authentication fails
1975 with the specific Domain error code meaning that the user no longer
1976 exists then <command>smbd</command> attempts to find a UNIX user in
1977 the UNIX password database that matches the Windows user account. If
1978 this lookup succeeds, and <parameter>delete user script</parameter> is
1979 set then <command>smbd</command> will all the specified script
1980 <emphasis>AS ROOT</emphasis>, expanding any <parameter>%u</parameter>
1981 argument to be the user name to delete.</para>
1983 <para>This script should delete the given UNIX username. In this way,
1984 UNIX users are dynamically deleted to match existing Windows NT
1985 accounts.</para>
1987 <para>See also <link linkend="SECURITYEQUALSDOMAIN">security=domain</link>,
1988 <link linkend="PASSWORDSERVER"><parameter>password server</parameter>
1989 </link>, <link linkend="ADDUSERSCRIPT"><parameter>add user script</parameter>
1990 </link>.</para>
1992 <para>Default: <command>delete user script = &lt;empty string&gt;
1993 </command></para>
1994 <para>Example: <command>delete user script = /usr/local/samba/bin/del_user
1995 %u</command></para></listitem>
1996 </varlistentry>
2002 <varlistentry>
2003 <term><anchor id="DELETEVETOFILES">delete veto files (S)</term>
2004 <listitem><para>This option is used when Samba is attempting to
2005 delete a directory that contains one or more vetoed directories
2006 (see the <link linkend="VETOFILES"><parameter>veto files</parameter></link>
2007 option). If this option is set to <constant>false</constant> (the default) then if a vetoed
2008 directory contains any non-vetoed files or directories then the
2009 directory delete will fail. This is usually what you want.</para>
2011 <para>If this option is set to <constant>true</constant>, then Samba
2012 will attempt to recursively delete any files and directories within
2013 the vetoed directory. This can be useful for integration with file
2014 serving systems such as NetAtalk which create meta-files within
2015 directories you might normally veto DOS/Windows users from seeing
2016 (e.g. <filename>.AppleDouble</filename>)</para>
2018 <para>Setting <command>delete veto files = yes</command> allows these
2019 directories to be transparently deleted when the parent directory
2020 is deleted (so long as the user has permissions to do so).</para>
2022 <para>See also the <link linkend="VETOFILES"><parameter>veto
2023 files</parameter></link> parameter.</para>
2025 <para>Default: <command>delete veto files = no</command></para></listitem>
2026 </varlistentry>
2031 <varlistentry>
2032 <term><anchor id="DENYHOSTS">deny hosts (S)</term>
2033 <listitem><para>Synonym for <link linkend="HOSTSDENY"><parameter>hosts
2034 deny</parameter></link>.</para></listitem>
2035 </varlistentry>
2040 <varlistentry>
2041 <term><anchor id="DFREECOMMAND">dfree command (G)</term>
2042 <listitem><para>The <parameter>dfree command</parameter> setting should
2043 only be used on systems where a problem occurs with the internal
2044 disk space calculations. This has been known to happen with Ultrix,
2045 but may occur with other operating systems. The symptom that was
2046 seen was an error of "Abort Retry Ignore" at the end of each
2047 directory listing.</para>
2049 <para>This setting allows the replacement of the internal routines to
2050 calculate the total disk space and amount available with an external
2051 routine. The example below gives a possible script that might fulfill
2052 this function.</para>
2054 <para>The external program will be passed a single parameter indicating
2055 a directory in the filesystem being queried. This will typically consist
2056 of the string <filename>./</filename>. The script should return two
2057 integers in ASCII. The first should be the total disk space in blocks,
2058 and the second should be the number of available blocks. An optional
2059 third return value can give the block size in bytes. The default
2060 blocksize is 1024 bytes.</para>
2062 <para>Note: Your script should <emphasis>NOT</emphasis> be setuid or
2063 setgid and should be owned by (and writeable only by) root!</para>
2065 <para>Default: <emphasis>By default internal routines for
2066 determining the disk capacity and remaining space will be used.
2067 </emphasis></para>
2069 <para>Example: <command>dfree command = /usr/local/samba/bin/dfree
2070 </command></para>
2072 <para>Where the script dfree (which must be made executable) could be:</para>
2074 <para><programlisting>
2075 #!/bin/sh
2076 df $1 | tail -1 | awk '{print $2" "$4}'
2077 </programlisting></para>
2079 <para>or perhaps (on Sys V based systems):</para>
2081 <para><programlisting>
2082 #!/bin/sh
2083 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2084 </programlisting></para>
2086 <para>Note that you may have to replace the command names
2087 with full path names on some systems.</para>
2088 </listitem>
2089 </varlistentry>
2094 <varlistentry>
2095 <term><anchor id="DIRECTORY">directory (S)</term>
2096 <listitem><para>Synonym for <link linkend="PATH"><parameter>path
2097 </parameter></link>.</para></listitem>
2098 </varlistentry>
2102 <varlistentry>
2103 <term><anchor id="DIRECTORYMASK">directory mask (S)</term>
2104 <listitem><para>This parameter is the octal modes which are
2105 used when converting DOS modes to UNIX modes when creating UNIX
2106 directories.</para>
2108 <para>When a directory is created, the necessary permissions are
2109 calculated according to the mapping from DOS modes to UNIX permissions,
2110 and the resulting UNIX mode is then bit-wise 'AND'ed with this
2111 parameter. This parameter may be thought of as a bit-wise MASK for
2112 the UNIX modes of a directory. Any bit <emphasis>not</emphasis> set
2113 here will be removed from the modes set on a directory when it is
2114 created.</para>
2116 <para>The default value of this parameter removes the 'group'
2117 and 'other' write bits from the UNIX mode, allowing only the
2118 user who owns the directory to modify it.</para>
2120 <para>Following this Samba will bit-wise 'OR' the UNIX mode
2121 created from this parameter with the value of the <link
2122 linkend="FORCEDIRECTORYMODE"><parameter>force directory mode
2123 </parameter></link> parameter. This parameter is set to 000 by
2124 default (i.e. no extra mode bits are added).</para>
2126 <para>Note that this parameter does not apply to permissions
2127 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2128 a mask on access control lists also, they need to set the <link
2129 linkend="DIRECTORYSECURITYMASK"><parameter>directory security mask</parameter></link>.</para>
2131 <para>See the <link linkend="FORCEDIRECTORYMODE"><parameter>force
2132 directory mode</parameter></link> parameter to cause particular mode
2133 bits to always be set on created directories.</para>
2135 <para>See also the <link linkend="CREATEMODE"><parameter>create mode
2136 </parameter></link> parameter for masking mode bits on created files,
2137 and the <link linkend="DIRECTORYSECURITYMASK"><parameter>directory
2138 security mask</parameter></link> parameter.</para>
2140 <para>Also refer to the <link linkend="INHERITPERMISSIONS"><parameter>
2141 inherit permissions</parameter></link> parameter.</para>
2143 <para>Default: <command>directory mask = 0755</command></para>
2144 <para>Example: <command>directory mask = 0775</command></para>
2145 </listitem>
2146 </varlistentry>
2150 <varlistentry>
2151 <term><anchor id="DIRECTORYMODE">directory mode (S)</term>
2152 <listitem><para>Synonym for <link linkend="DIRECTORYMASK"><parameter>
2153 directory mask</parameter></link></para></listitem>
2154 </varlistentry>
2158 <varlistentry>
2159 <term><anchor id="DIRECTORYSECURITYMASK">directory security mask (S)</term>
2160 <listitem><para>This parameter controls what UNIX permission bits
2161 can be modified when a Windows NT client is manipulating the UNIX
2162 permission on a directory using the native NT security dialog
2163 box.</para>
2165 <para>This parameter is applied as a mask (AND'ed with) to
2166 the changed permission bits, thus preventing any bits not in
2167 this mask from being modified. Essentially, zero bits in this
2168 mask may be treated as a set of bits the user is not allowed
2169 to change.</para>
2171 <para>If not set explicitly this parameter is set to 0777
2172 meaning a user is allowed to modify all the user/group/world
2173 permissions on a directory.</para>
2175 <para><emphasis>Note</emphasis> that users who can access the
2176 Samba server through other means can easily bypass this restriction,
2177 so it is primarily useful for standalone "appliance" systems.
2178 Administrators of most normal systems will probably want to leave
2179 it as the default of <constant>0777</constant>.</para>
2181 <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>
2182 force directory security mode</parameter></link>, <link
2183 linkend="SECURITYMASK"><parameter>security mask</parameter></link>,
2184 <link linkend="FORCESECURITYMODE"><parameter>force security mode
2185 </parameter></link> parameters.</para>
2187 <para>Default: <command>directory security mask = 0777</command></para>
2188 <para>Example: <command>directory security mask = 0700</command></para>
2189 </listitem>
2190 </varlistentry>
2194 <varlistentry>
2195 <term><anchor id="DNSPROXY">dns proxy (G)</term>
2196 <listitem><para>Specifies that <ulink url="nmbd.8.html">nmbd(8)</ulink>
2197 when acting as a WINS server and finding that a NetBIOS name has not
2198 been registered, should treat the NetBIOS name word-for-word as a DNS
2199 name and do a lookup with the DNS server for that name on behalf of
2200 the name-querying client.</para>
2202 <para>Note that the maximum length for a NetBIOS name is 15
2203 characters, so the DNS name (or DNS alias) can likewise only be
2204 15 characters, maximum.</para>
2206 <para><command>nmbd</command> spawns a second copy of itself to do the
2207 DNS name lookup requests, as doing a name lookup is a blocking
2208 action.</para>
2210 <para>See also the parameter <link linkend="WINSSUPPORT"><parameter>
2211 wins support</parameter></link>.</para>
2213 <para>Default: <command>dns proxy = yes</command></para></listitem>
2214 </varlistentry>
2218 <varlistentry>
2219 <term><anchor id="DOMAINADMINGROUP">domain admin group (G)</term>
2220 <listitem><para>This parameter is intended as a temporary solution
2221 to enable users to be a member of the "Domain Admins" group when
2222 a Samba host is acting as a PDC. A complete solution will be provided
2223 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2224 Please note that this parameter has a somewhat confusing name. It
2225 accepts a list of usernames and of group names in standard
2226 <filename>smb.conf</filename> notation.
2227 </para>
2229 <para>See also <link linkend="DOMAINGUESTGROUP"><parameter>domain
2230 guest group</parameter></link>, <link linkend="DOMAINLOGONS"><parameter>domain
2231 logons</parameter></link>
2232 </para>
2234 <para>Default: <emphasis>no domain administrators</emphasis></para>
2235 <para>Example: <command>domain admin group = root @wheel</command></para>
2236 </listitem>
2237 </varlistentry>
2242 <varlistentry>
2243 <term><anchor id="DOMAINGUESTGROUP">domain guest group (G)</term>
2244 <listitem><para>This parameter is intended as a temporary solution
2245 to enable users to be a member of the "Domain Guests" group when
2246 a Samba host is acting as a PDC. A complete solution will be provided
2247 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2248 Please note that this parameter has a somewhat confusing name. It
2249 accepts a list of usernames and of group names in standard
2250 <filename>smb.conf</filename> notation.
2251 </para>
2253 <para>See also <link linkend="DOMAINADMINGROUP"><parameter>domain
2254 admin group</parameter></link>, <link linkend="DOMAINLOGONS"><parameter>domain
2255 logons</parameter></link>
2256 </para>
2258 <para>Default: <emphasis>no domain guests</emphasis></para>
2259 <para>Example: <command>domain guest group = nobody @guest</command></para>
2260 </listitem>
2261 </varlistentry>
2264 <varlistentry>
2265 <term><anchor id="DOMAINLOGONS">domain logons (G)</term>
2266 <listitem><para>If set to <constant>true</constant>, the Samba server will serve
2267 Windows 95/98 Domain logons for the <link linkend="WORKGROUP">
2268 <parameter>workgroup</parameter></link> it is in. Samba 2.2 also
2269 has limited capability to act as a domain controller for Windows
2270 NT 4 Domains. For more details on setting up this feature see
2271 the file DOMAINS.txt in the Samba documentation directory <filename>docs/
2272 </filename> shipped with the source code.</para>
2274 <para>Default: <command>domain logons = no</command></para></listitem>
2275 </varlistentry>
2279 <varlistentry>
2280 <term><anchor id="DOMAINMASTER">domain master (G)</term>
2281 <listitem><para>Tell <ulink url="nmbd.8.html"><command>
2282 nmbd(8)</command></ulink> to enable WAN-wide browse list
2283 collation. Setting this option causes <command>nmbd</command> to
2284 claim a special domain specific NetBIOS name that identifies
2285 it as a domain master browser for its given <link linkend="WORKGROUP">
2286 <parameter>workgroup</parameter></link>. Local master browsers
2287 in the same <parameter>workgroup</parameter> on broadcast-isolated
2288 subnets will give this <command>nmbd</command> their local browse lists,
2289 and then ask <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
2290 for a complete copy of the browse list for the whole wide area
2291 network. Browser clients will then contact their local master browser,
2292 and will receive the domain-wide browse list, instead of just the list
2293 for their broadcast-isolated subnet.</para>
2295 <para>Note that Windows NT Primary Domain Controllers expect to be
2296 able to claim this <parameter>workgroup</parameter> specific special
2297 NetBIOS name that identifies them as domain master browsers for
2298 that <parameter>workgroup</parameter> by default (i.e. there is no
2299 way to prevent a Windows NT PDC from attempting to do this). This
2300 means that if this parameter is set and <command>nmbd</command> claims
2301 the special name for a <parameter>workgroup</parameter> before a Windows
2302 NT PDC is able to do so then cross subnet browsing will behave
2303 strangely and may fail.</para>
2305 <para>If <link linkend="DOMAINLOGONS"><command>domain logons = yes</command>
2306 </link>, then the default behavior is to enable the <parameter>domain
2307 master</parameter> parameter. If <parameter>domain logons</parameter> is
2308 not enabled (the default setting), then neither will <parameter>domain
2309 master</parameter> be enabled by default.</para>
2311 <para>Default: <command>domain master = auto</command></para></listitem>
2312 </varlistentry>
2317 <varlistentry>
2318 <term><anchor id="DONTDESCEND">dont descend (S)</term>
2319 <listitem><para>There are certain directories on some systems
2320 (e.g., the <filename>/proc</filename> tree under Linux) that are either not
2321 of interest to clients or are infinitely deep (recursive). This
2322 parameter allows you to specify a comma-delimited list of directories
2323 that the server should always show as empty.</para>
2325 <para>Note that Samba can be very fussy about the exact format
2326 of the "dont descend" entries. For example you may need <filename>
2327 ./proc</filename> instead of just <filename>/proc</filename>.
2328 Experimentation is the best policy :-) </para>
2330 <para>Default: <emphasis>none (i.e., all directories are OK
2331 to descend)</emphasis></para>
2332 <para>Example: <command>dont descend = /proc,/dev</command></para>
2333 </listitem>
2334 </varlistentry>
2338 <varlistentry>
2339 <term><anchor id="DOSFILEMODE">dos filemode (S)</term>
2340 <listitem><para> The default behavior in Samba is to provide
2341 UNIX-like behavior where only the owner of a file/directory is
2342 able to change the permissions on it. However, this behavior
2343 is often confusing to DOS/Windows users. Enabling this parameter
2344 allows a user who has write access to the file (by whatever
2345 means) to modify the permissions on it. Note that a user
2346 belonging to the group owning the file will not be allowed to
2347 change permissions if the group is only granted read access.
2348 Ownership of the file/directory is not changed, only the permissions
2349 are modified.</para>
2351 <para>Default: <command>dos filemode = no</command></para>
2352 </listitem>
2353 </varlistentry>
2357 <varlistentry>
2358 <term><anchor id="DOSFILETIMERESOLUTION">dos filetime resolution (S)</term>
2359 <listitem><para>Under the DOS and Windows FAT filesystem, the finest
2360 granularity on time resolution is two seconds. Setting this parameter
2361 for a share causes Samba to round the reported time down to the
2362 nearest two second boundary when a query call that requires one second
2363 resolution is made to <ulink url="smbd.8.html"><command>smbd(8)</command>
2364 </ulink>.</para>
2366 <para>This option is mainly used as a compatibility option for Visual
2367 C++ when used against Samba shares. If oplocks are enabled on a
2368 share, Visual C++ uses two different time reading calls to check if a
2369 file has changed since it was last read. One of these calls uses a
2370 one-second granularity, the other uses a two second granularity. As
2371 the two second call rounds any odd second down, then if the file has a
2372 timestamp of an odd number of seconds then the two timestamps will not
2373 match and Visual C++ will keep reporting the file has changed. Setting
2374 this option causes the two timestamps to match, and Visual C++ is
2375 happy.</para>
2377 <para>Default: <command>dos filetime resolution = no</command></para>
2378 </listitem>
2379 </varlistentry>
2383 <varlistentry>
2384 <term><anchor id="DOSFILETIMES">dos filetimes (S)</term>
2385 <listitem><para>Under DOS and Windows, if a user can write to a
2386 file they can change the timestamp on it. Under POSIX semantics,
2387 only the owner of the file or root may change the timestamp. By
2388 default, Samba runs with POSIX semantics and refuses to change the
2389 timestamp on a file if the user <command>smbd</command> is acting
2390 on behalf of is not the file owner. Setting this option to <constant>
2391 true</constant> allows DOS semantics and <ulink url="smbd.8.html">smbd</ulink> will change the file
2392 timestamp as DOS requires.</para>
2394 <para>Default: <command>dos filetimes = no</command></para></listitem>
2395 </varlistentry>
2399 <varlistentry>
2400 <term><anchor id="ENCRYPTPASSWORDS">encrypt passwords (G)</term>
2401 <listitem><para>This boolean controls whether encrypted passwords
2402 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
2403 above and also Windows 98 will by default expect encrypted passwords
2404 unless a registry entry is changed. To use encrypted passwords in
2405 Samba see the file ENCRYPTION.txt in the Samba documentation
2406 directory <filename>docs/</filename> shipped with the source code.</para>
2408 <para>In order for encrypted passwords to work correctly
2409 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink> must either
2410 have access to a local <ulink url="smbpasswd.5.html"><filename>smbpasswd(5)
2411 </filename></ulink> file (see the <ulink url="smbpasswd.8.html"><command>
2412 smbpasswd(8)</command></ulink> program for information on how to set up
2413 and maintain this file), or set the <link
2414 linkend="SECURITY">security=[server|domain]</link> parameter which
2415 causes <command>smbd</command> to authenticate against another
2416 server.</para>
2418 <para>Default: <command>encrypt passwords = no</command></para></listitem>
2419 </varlistentry>
2422 <varlistentry>
2423 <term><anchor id="ENHANCEDBROWSING">enhanced browsing (G)</term>
2424 <listitem><para>This option enables a couple of enhancements to
2425 cross-subnet browse propagation that have been added in Samba
2426 but which are not standard in Microsoft implementations.
2427 </para>
2429 <para>The first enhancement to browse propagation consists of a regular
2430 wildcard query to a Samba WINS server for all Domain Master Browsers,
2431 followed by a browse synchronization with each of the returned
2432 DMBs. The second enhancement consists of a regular randomised browse
2433 synchronization with all currently known DMBs.</para>
2435 <para>You may wish to disable this option if you have a problem with empty
2436 workgroups not disappearing from browse lists. Due to the restrictions
2437 of the browse protocols these enhancements can cause a empty workgroup
2438 to stay around forever which can be annoying.</para>
2440 <para>In general you should leave this option enabled as it makes
2441 cross-subnet browse propagation much more reliable.</para>
2443 <para>Default: <command>enhanced browsing = yes</command></para>
2444 </listitem>
2445 </varlistentry>
2448 <varlistentry>
2449 <term><anchor id="ENUMPORTSCOMMAND">enumports command (G)</term>
2450 <listitem><para>The concept of a "port" is fairly foreign
2451 to UNIX hosts. Under Windows NT/2000 print servers, a port
2452 is associated with a port monitor and generally takes the form of
2453 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
2454 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
2455 port defined--<constant>"Samba Printer Port"</constant>. Under
2456 Windows NT/2000, all printers must have a valid port name.
2457 If you wish to have a list of ports displayed (<command>smbd
2458 </command> does not use a port name for anything) other than
2459 the default <constant>"Samba Printer Port"</constant>, you
2460 can define <parameter>enumports command</parameter> to point to
2461 a program which should generate a list of ports, one per line,
2462 to standard output. This listing will then be used in response
2463 to the level 1 and 2 EnumPorts() RPC.</para>
2465 <para>Default: <emphasis>no enumports command</emphasis></para>
2466 <para>Example: <command>enumports command = /usr/bin/listports
2467 </command></para>
2468 </listitem>
2469 </varlistentry>
2471 <varlistentry>
2472 <term><anchor id="EXEC">exec (S)</term>
2473 <listitem><para>This is a synonym for <link linkend="PREEXEC">
2474 <parameter>preexec</parameter></link>.</para></listitem>
2475 </varlistentry>
2479 <varlistentry>
2480 <term><anchor id="FAKEDIRECTORYCREATETIMES">fake directory create times (S)</term>
2481 <listitem><para>NTFS and Windows VFAT file systems keep a create
2482 time for all files and directories. This is not the same as the
2483 ctime - status change time - that Unix keeps, so Samba by default
2484 reports the earliest of the various times Unix does keep. Setting
2485 this parameter for a share causes Samba to always report midnight
2486 1-1-1980 as the create time for directories.</para>
2488 <para>This option is mainly used as a compatibility option for
2489 Visual C++ when used against Samba shares. Visual C++ generated
2490 makefiles have the object directory as a dependency for each object
2491 file, and a make rule to create the directory. Also, when NMAKE
2492 compares timestamps it uses the creation time when examining a
2493 directory. Thus the object directory will be created if it does not
2494 exist, but once it does exist it will always have an earlier
2495 timestamp than the object files it contains.</para>
2497 <para>However, Unix time semantics mean that the create time
2498 reported by Samba will be updated whenever a file is created or
2499 or deleted in the directory. NMAKE finds all object files in
2500 the object directory. The timestamp of the last one built is then
2501 compared to the timestamp of the object directory. If the
2502 directory's timestamp if newer, then all object files
2503 will be rebuilt. Enabling this option
2504 ensures directories always predate their contents and an NMAKE build
2505 will proceed as expected.</para>
2507 <para>Default: <command>fake directory create times = no</command></para>
2508 </listitem>
2509 </varlistentry>
2513 <varlistentry>
2514 <term><anchor id="FAKEOPLOCKS">fake oplocks (S)</term>
2515 <listitem><para>Oplocks are the way that SMB clients get permission
2516 from a server to locally cache file operations. If a server grants
2517 an oplock (opportunistic lock) then the client is free to assume
2518 that it is the only one accessing the file and it will aggressively
2519 cache file data. With some oplock types the client may even cache
2520 file open/close operations. This can give enormous performance benefits.
2521 </para>
2523 <para>When you set <command>fake oplocks = yes</command>, <ulink
2524 url="smbd.8.html"><command>smbd(8)</command></ulink> will
2525 always grant oplock requests no matter how many clients are using
2526 the file.</para>
2528 <para>It is generally much better to use the real <link
2529 linkend="OPLOCKS"><parameter>oplocks</parameter></link> support rather
2530 than this parameter.</para>
2532 <para>If you enable this option on all read-only shares or
2533 shares that you know will only be accessed from one client at a
2534 time such as physically read-only media like CDROMs, you will see
2535 a big performance improvement on many operations. If you enable
2536 this option on shares where multiple clients may be accessing the
2537 files read-write at the same time you can get data corruption. Use
2538 this option carefully!</para>
2540 <para>Default: <command>fake oplocks = no</command></para></listitem>
2541 </varlistentry>
2545 <varlistentry>
2546 <term><anchor id="FOLLOWSYMLINKS">follow symlinks (S)</term>
2547 <listitem><para>This parameter allows the Samba administrator
2548 to stop <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
2549 from following symbolic links in a particular share. Setting this
2550 parameter to <constant>no</constant> prevents any file or directory
2551 that is a symbolic link from being followed (the user will get an
2552 error). This option is very useful to stop users from adding a
2553 symbolic link to <filename>/etc/passwd</filename> in their home
2554 directory for instance. However it will slow filename lookups
2555 down slightly.</para>
2557 <para>This option is enabled (i.e. <command>smbd</command> will
2558 follow symbolic links) by default.</para>
2560 <para>Default: <command>follow symlinks = yes</command></para></listitem>
2561 </varlistentry>
2565 <varlistentry>
2566 <term><anchor id="FORCECREATEMODE">force create mode (S)</term>
2567 <listitem><para>This parameter specifies a set of UNIX mode bit
2568 permissions that will <emphasis>always</emphasis> be set on a
2569 file created by Samba. This is done by bitwise 'OR'ing these bits onto
2570 the mode bits of a file that is being created or having its
2571 permissions changed. The default for this parameter is (in octal)
2572 000. The modes in this parameter are bitwise 'OR'ed onto the file
2573 mode after the mask set in the <parameter>create mask</parameter>
2574 parameter is applied.</para>
2576 <para>Note that by default this parameter does not apply to permissions
2577 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2578 this mask on access control lists also, they need to set the <link
2579 linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with
2580 mask</parameter></link> to <constant>true</constant>.</para>
2582 <para>See also the parameter <link linkend="CREATEMASK"><parameter>create
2583 mask</parameter></link> for details on masking mode bits on files.</para>
2585 <para>See also the <link linkend="INHERITPERMISSIONS"><parameter>inherit
2586 permissions</parameter></link> parameter.</para>
2588 <para>Default: <command>force create mode = 000</command></para>
2589 <para>Example: <command>force create mode = 0755</command></para>
2591 <para>would force all created files to have read and execute
2592 permissions set for 'group' and 'other' as well as the
2593 read/write/execute bits set for the 'user'.</para>
2594 </listitem>
2595 </varlistentry>
2599 <varlistentry>
2600 <term><anchor id="FORCEDIRECTORYMODE">force directory mode (S)</term>
2601 <listitem><para>This parameter specifies a set of UNIX mode bit
2602 permissions that will <emphasis>always</emphasis> be set on a directory
2603 created by Samba. This is done by bitwise 'OR'ing these bits onto the
2604 mode bits of a directory that is being created. The default for this
2605 parameter is (in octal) 0000 which will not add any extra permission
2606 bits to a created directory. This operation is done after the mode
2607 mask in the parameter <parameter>directory mask</parameter> is
2608 applied.</para>
2610 <para>Note that by default this parameter does not apply to permissions
2611 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2612 this mask on access control lists also, they need to set the <link
2613 linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with
2614 mask</parameter></link> to <constant>true</constant>.</para>
2616 <para>See also the parameter <link linkend="DIRECTORYMASK"><parameter>
2617 directory mask</parameter></link> for details on masking mode bits
2618 on created directories.</para>
2620 <para>See also the <link linkend="INHERITPERMISSIONS"><parameter>
2621 inherit permissions</parameter></link> parameter.</para>
2623 <para>Default: <command>force directory mode = 000</command></para>
2624 <para>Example: <command>force directory mode = 0755</command></para>
2626 <para>would force all created directories to have read and execute
2627 permissions set for 'group' and 'other' as well as the
2628 read/write/execute bits set for the 'user'.</para>
2629 </listitem>
2630 </varlistentry>
2634 <varlistentry>
2635 <term><anchor id="FORCEDIRECTORYSECURITYMODE">force directory
2636 security mode (S)</term>
2637 <listitem><para>This parameter controls what UNIX permission bits
2638 can be modified when a Windows NT client is manipulating the UNIX
2639 permission on a directory using the native NT security dialog box.</para>
2641 <para>This parameter is applied as a mask (OR'ed with) to the
2642 changed permission bits, thus forcing any bits in this mask that
2643 the user may have modified to be on. Essentially, one bits in this
2644 mask may be treated as a set of bits that, when modifying security
2645 on a directory, the user has always set to be 'on'.</para>
2647 <para>If not set explicitly this parameter is 000, which
2648 allows a user to modify all the user/group/world permissions on a
2649 directory without restrictions.</para>
2651 <para><emphasis>Note</emphasis> that users who can access the
2652 Samba server through other means can easily bypass this restriction,
2653 so it is primarily useful for standalone "appliance" systems.
2654 Administrators of most normal systems will probably want to leave
2655 it set as 0000.</para>
2657 <para>See also the <link linkend="DIRECTORYSECURITYMASK"><parameter>
2658 directory security mask</parameter></link>, <link linkend="SECURITYMASK">
2659 <parameter>security mask</parameter></link>,
2660 <link linkend="FORCESECURITYMODE"><parameter>force security mode
2661 </parameter></link> parameters.</para>
2663 <para>Default: <command>force directory security mode = 0</command></para>
2664 <para>Example: <command>force directory security mode = 700</command></para>
2665 </listitem>
2666 </varlistentry>
2671 <varlistentry>
2672 <term><anchor id="FORCEGROUP">force group (S)</term>
2673 <listitem><para>This specifies a UNIX group name that will be
2674 assigned as the default primary group for all users connecting
2675 to this service. This is useful for sharing files by ensuring
2676 that all access to files on service will use the named group for
2677 their permissions checking. Thus, by assigning permissions for this
2678 group to the files and directories within this service the Samba
2679 administrator can restrict or allow sharing of these files.</para>
2681 <para>In Samba 2.0.5 and above this parameter has extended
2682 functionality in the following way. If the group name listed here
2683 has a '+' character prepended to it then the current user accessing
2684 the share only has the primary group default assigned to this group
2685 if they are already assigned as a member of that group. This allows
2686 an administrator to decide that only users who are already in a
2687 particular group will create files with group ownership set to that
2688 group. This gives a finer granularity of ownership assignment. For
2689 example, the setting <filename>force group = +sys</filename> means
2690 that only users who are already in group sys will have their default
2691 primary group assigned to sys when accessing this Samba share. All
2692 other users will retain their ordinary primary group.</para>
2694 <para>If the <link linkend="FORCEUSER"><parameter>force user
2695 </parameter></link> parameter is also set the group specified in
2696 <parameter>force group</parameter> will override the primary group
2697 set in <parameter>force user</parameter>.</para>
2699 <para>See also <link linkend="FORCEUSER"><parameter>force
2700 user</parameter></link>.</para>
2702 <para>Default: <emphasis>no forced group</emphasis></para>
2703 <para>Example: <command>force group = agroup</command></para>
2704 </listitem>
2705 </varlistentry>
2709 <varlistentry>
2710 <term><anchor id="FORCESECURITYMODE">force security mode (S)</term>
2711 <listitem><para>This parameter controls what UNIX permission
2712 bits can be modified when a Windows NT client is manipulating
2713 the UNIX permission on a file using the native NT security dialog
2714 box.</para>
2716 <para>This parameter is applied as a mask (OR'ed with) to the
2717 changed permission bits, thus forcing any bits in this mask that
2718 the user may have modified to be on. Essentially, one bits in this
2719 mask may be treated as a set of bits that, when modifying security
2720 on a file, the user has always set to be 'on'.</para>
2722 <para>If not set explicitly this parameter is set to 0,
2723 and allows a user to modify all the user/group/world permissions on a file,
2724 with no restrictions.</para>
2726 <para><emphasis>Note</emphasis> that users who can access
2727 the Samba server through other means can easily bypass this restriction,
2728 so it is primarily useful for standalone "appliance" systems.
2729 Administrators of most normal systems will probably want to leave
2730 this set to 0000.</para>
2732 <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>
2733 force directory security mode</parameter></link>,
2734 <link linkend="DIRECTORYSECURITYMASK"><parameter>directory security
2735 mask</parameter></link>, <link linkend="SECURITYMASK"><parameter>
2736 security mask</parameter></link> parameters.</para>
2738 <para>Default: <command>force security mode = 0</command></para>
2739 <para>Example: <command>force security mode = 700</command></para>
2740 </listitem>
2741 </varlistentry>
2745 <varlistentry>
2746 <term><anchor id="FORCEUSER">force user (S)</term>
2747 <listitem><para>This specifies a UNIX user name that will be
2748 assigned as the default user for all users connecting to this service.
2749 This is useful for sharing files. You should also use it carefully
2750 as using it incorrectly can cause security problems.</para>
2752 <para>This user name only gets used once a connection is established.
2753 Thus clients still need to connect as a valid user and supply a
2754 valid password. Once connected, all file operations will be performed
2755 as the "forced user", no matter what username the client connected
2756 as. This can be very useful.</para>
2758 <para>In Samba 2.0.5 and above this parameter also causes the
2759 primary group of the forced user to be used as the primary group
2760 for all file activity. Prior to 2.0.5 the primary group was left
2761 as the primary group of the connecting user (this was a bug).</para>
2763 <para>See also <link linkend="FORCEGROUP"><parameter>force group
2764 </parameter></link></para>
2766 <para>Default: <emphasis>no forced user</emphasis></para>
2767 <para>Example: <command>force user = auser</command></para>
2768 </listitem>
2769 </varlistentry>
2773 <varlistentry>
2774 <term><anchor id="FSTYPE">fstype (S)</term>
2775 <listitem><para>This parameter allows the administrator to
2776 configure the string that specifies the type of filesystem a share
2777 is using that is reported by <ulink url="smbd.8.html"><command>smbd(8)
2778 </command></ulink> when a client queries the filesystem type
2779 for a share. The default type is <constant>NTFS</constant> for
2780 compatibility with Windows NT but this can be changed to other
2781 strings such as <constant>Samba</constant> or <constant>FAT
2782 </constant> if required.</para>
2784 <para>Default: <command>fstype = NTFS</command></para>
2785 <para>Example: <command>fstype = Samba</command></para></listitem>
2786 </varlistentry>
2790 <varlistentry>
2791 <term><anchor id="GETWDCACHE">getwd cache (G)</term>
2792 <listitem><para>This is a tuning option. When this is enabled a
2793 caching algorithm will be used to reduce the time taken for getwd()
2794 calls. This can have a significant impact on performance, especially
2795 when the <link linkend="WIDELINKS"><parameter>wide links</parameter>
2796 </link>parameter is set to <constant>false</constant>.</para>
2798 <para>Default: <command>getwd cache = yes</command></para>
2799 </listitem>
2800 </varlistentry>
2804 <varlistentry>
2805 <term><anchor id="GROUP">group (S)</term>
2806 <listitem><para>Synonym for <link linkend="FORCEGROUP"><parameter>force
2807 group</parameter></link>.</para></listitem>
2808 </varlistentry>
2812 <varlistentry>
2813 <term><anchor id="GUESTACCOUNT">guest account (S)</term>
2814 <listitem><para>This is a username which will be used for access
2815 to services which are specified as <link linkend="GUESTOK"><parameter>
2816 guest ok</parameter></link> (see below). Whatever privileges this
2817 user has will be available to any client connecting to the guest service.
2818 Typically this user will exist in the password file, but will not
2819 have a valid login. The user account "ftp" is often a good choice
2820 for this parameter. If a username is specified in a given service,
2821 the specified username overrides this one.</para>
2823 <para>One some systems the default guest account "nobody" may not
2824 be able to print. Use another account in this case. You should test
2825 this by trying to log in as your guest user (perhaps by using the
2826 <command>su -</command> command) and trying to print using the
2827 system print command such as <command>lpr(1)</command> or <command>
2828 lp(1)</command>.</para>
2830 <para>Default: <emphasis>specified at compile time, usually
2831 "nobody"</emphasis></para>
2833 <para>Example: <command>guest account = ftp</command></para></listitem>
2834 </varlistentry>
2838 <varlistentry>
2839 <term><anchor id="GUESTOK">guest ok (S)</term>
2840 <listitem><para>If this parameter is <constant>yes</constant> for
2841 a service, then no password is required to connect to the service.
2842 Privileges will be those of the <link linkend="GUESTACCOUNT"><parameter>
2843 guest account</parameter></link>.</para>
2845 <para>See the section below on <link linkend="SECURITY"><parameter>
2846 security</parameter></link> for more information about this option.
2847 </para>
2849 <para>Default: <command>guest ok = no</command></para></listitem>
2850 </varlistentry>
2854 <varlistentry>
2855 <term><anchor id="GUESTONLY">guest only (S)</term>
2856 <listitem><para>If this parameter is <constant>yes</constant> for
2857 a service, then only guest connections to the service are permitted.
2858 This parameter will have no effect if <link linkend="GUESTOK">
2859 <parameter>guest ok</parameter></link> is not set for the service.</para>
2861 <para>See the section below on <link linkend="SECURITY"><parameter>
2862 security</parameter></link> for more information about this option.
2863 </para>
2865 <para>Default: <command>guest only = no</command></para></listitem>
2866 </varlistentry>
2870 <varlistentry>
2871 <term><anchor id="HIDEDOTFILES">hide dot files (S)</term>
2872 <listitem><para>This is a boolean parameter that controls whether
2873 files starting with a dot appear as hidden files.</para>
2875 <para>Default: <command>hide dot files = yes</command></para></listitem>
2876 </varlistentry>
2880 <varlistentry>
2881 <term><anchor id="HIDEFILES">hide files(S)</term>
2882 <listitem><para>This is a list of files or directories that are not
2883 visible but are accessible. The DOS 'hidden' attribute is applied
2884 to any files or directories that match.</para>
2886 <para>Each entry in the list must be separated by a '/',
2887 which allows spaces to be included in the entry. '*'
2888 and '?' can be used to specify multiple files or directories
2889 as in DOS wildcards.</para>
2891 <para>Each entry must be a Unix path, not a DOS path and must
2892 not include the Unix directory separator '/'.</para>
2894 <para>Note that the case sensitivity option is applicable
2895 in hiding files.</para>
2897 <para>Setting this parameter will affect the performance of Samba,
2898 as it will be forced to check all files and directories for a match
2899 as they are scanned.</para>
2901 <para>See also <link linkend="HIDEDOTFILES"><parameter>hide
2902 dot files</parameter></link>, <link linkend="VETOFILES"><parameter>
2903 veto files</parameter></link> and <link linkend="CASESENSITIVE">
2904 <parameter>case sensitive</parameter></link>.</para>
2906 <para>Default: <emphasis>no file are hidden</emphasis></para>
2907 <para>Example: <command>hide files =
2908 /.*/DesktopFolderDB/TrashFor%m/resource.frk/</command></para>
2910 <para>The above example is based on files that the Macintosh
2911 SMB client (DAVE) available from <ulink url="http://www.thursby.com">
2912 Thursby</ulink> creates for internal use, and also still hides
2913 all files beginning with a dot.</para></listitem>
2914 </varlistentry>
2918 <varlistentry>
2919 <term><anchor id="HIDELOCALUSERS">hide local users(G)</term>
2920 <listitem><para>This parameter toggles the hiding of local UNIX
2921 users (root, wheel, floppy, etc) from remote clients.</para>
2923 <para>Default: <command>hide local users = no</command></para></listitem>
2924 </varlistentry>
2928 <varlistentry>
2929 <term><anchor id="HIDEUNREADABLE">hide unreadable(G)</term>
2930 <listitem><para>This parameter prevents clients from seeing the
2931 existance of files that cannot be read. Defaults to off.</para>
2933 <para>Default: <command>hide unreadable = no</command></para></listitem>
2934 </varlistentry>
2938 <varlistentry>
2939 <term><anchor id="HOMEDIRMAP">homedir map (G)</term>
2940 <listitem><para>If<link linkend="NISHOMEDIR"><parameter>nis homedir
2941 </parameter></link> is <constant>true</constant>, and <ulink
2942 url="smbd.8.html"><command>smbd(8)</command></ulink> is also acting
2943 as a Win95/98 <parameter>logon server</parameter> then this parameter
2944 specifies the NIS (or YP) map from which the server for the user's
2945 home directory should be extracted. At present, only the Sun
2946 auto.home map format is understood. The form of the map is:</para>
2948 <para><command>username server:/some/file/system</command></para>
2950 <para>and the program will extract the servername from before
2951 the first ':'. There should probably be a better parsing system
2952 that copes with different map formats and also Amd (another
2953 automounter) maps.</para>
2955 <para><emphasis>NOTE :</emphasis>A working NIS client is required on
2956 the system for this option to work.</para>
2958 <para>See also <link linkend="NISHOMEDIR"><parameter>nis homedir</parameter>
2959 </link>, <link linkend="DOMAINLOGONS"><parameter>domain logons</parameter>
2960 </link>.</para>
2962 <para>Default: <command>homedir map = &lt;empty string&gt;</command></para>
2963 <para>Example: <command>homedir map = amd.homedir</command></para>
2964 </listitem>
2965 </varlistentry>
2971 <varlistentry>
2972 <term><anchor id="HOSTMSDFS">host msdfs (G)</term>
2973 <listitem><para>This boolean parameter is only available
2974 if Samba has been configured and compiled with the <command>
2975 --with-msdfs</command> option. If set to <constant>yes</constant>,
2976 Samba will act as a Dfs server, and allow Dfs-aware clients
2977 to browse Dfs trees hosted on the server.</para>
2979 <para>See also the <link linkend="MSDFSROOT"><parameter>
2980 msdfs root</parameter></link> share level parameter. For
2981 more information on setting up a Dfs tree on Samba,
2982 refer to <ulink url="msdfs_setup.html">msdfs_setup.html</ulink>.
2983 </para>
2985 <para>Default: <command>host msdfs = no</command></para>
2986 </listitem>
2987 </varlistentry>
2990 <varlistentry>
2991 <term><anchor id="HOSTSALLOW">hosts allow (S)</term>
2992 <listitem><para>A synonym for this parameter is <parameter>allow
2993 hosts</parameter>.</para>
2995 <para>This parameter is a comma, space, or tab delimited
2996 set of hosts which are permitted to access a service.</para>
2998 <para>If specified in the [global] section then it will
2999 apply to all services, regardless of whether the individual
3000 service has a different setting.</para>
3002 <para>You can specify the hosts by name or IP number. For
3003 example, you could restrict access to only the hosts on a
3004 Class C subnet with something like <command>allow hosts = 150.203.5.
3005 </command>. The full syntax of the list is described in the man
3006 page <filename>hosts_access(5)</filename>. Note that this man
3007 page may not be present on your system, so a brief description will
3008 be given here also.</para>
3010 <para>Note that the localhost address 127.0.0.1 will always
3011 be allowed access unless specifically denied by a <link
3012 linkend="HOSTSDENY"><parameter>hosts deny</parameter></link> option.</para>
3014 <para>You can also specify hosts by network/netmask pairs and
3015 by netgroup names if your system supports netgroups. The
3016 <emphasis>EXCEPT</emphasis> keyword can also be used to limit a
3017 wildcard list. The following examples may provide some help:</para>
3019 <para>Example 1: allow all IPs in 150.203.*.*; except one</para>
3021 <para><command>hosts allow = 150.203. EXCEPT 150.203.6.66</command></para>
3023 <para>Example 2: allow hosts that match the given network/netmask</para>
3025 <para><command>hosts allow = 150.203.15.0/255.255.255.0</command></para>
3027 <para>Example 3: allow a couple of hosts</para>
3029 <para><command>hosts allow = lapland, arvidsjaur</command></para>
3031 <para>Example 4: allow only hosts in NIS netgroup "foonet", but
3032 deny access from one particular host</para>
3034 <para><command>hosts allow = @foonet</command></para>
3036 <para><command>hosts deny = pirate</command></para>
3038 <para>Note that access still requires suitable user-level passwords.</para>
3040 <para>See <ulink url="testparm.1.html"><command>testparm(1)</command>
3041 </ulink> for a way of testing your host access to see if it does
3042 what you expect.</para>
3044 <para>Default: <emphasis>none (i.e., all hosts permitted access)
3045 </emphasis></para>
3047 <para>Example: <command>allow hosts = 150.203.5. myhost.mynet.edu.au
3048 </command></para>
3049 </listitem>
3050 </varlistentry>
3054 <varlistentry>
3055 <term><anchor id="HOSTSDENY">hosts deny (S)</term>
3056 <listitem><para>The opposite of <parameter>hosts allow</parameter>
3057 - hosts listed here are <emphasis>NOT</emphasis> permitted access to
3058 services unless the specific services have their own lists to override
3059 this one. Where the lists conflict, the <parameter>allow</parameter>
3060 list takes precedence.</para>
3062 <para>Default: <emphasis>none (i.e., no hosts specifically excluded)
3063 </emphasis></para>
3065 <para>Example: <command>hosts deny = 150.203.4. badhost.mynet.edu.au
3066 </command></para></listitem>
3067 </varlistentry>
3071 <varlistentry>
3072 <term><anchor id="HOSTSEQUIV">hosts equiv (G)</term>
3073 <listitem><para>If this global parameter is a non-null string,
3074 it specifies the name of a file to read for the names of hosts
3075 and users who will be allowed access without specifying a password.
3076 </para>
3078 <para>This is not be confused with <link linkend="HOSTSALLOW">
3079 <parameter>hosts allow</parameter></link> which is about hosts
3080 access to services and is more useful for guest services. <parameter>
3081 hosts equiv</parameter> may be useful for NT clients which will
3082 not supply passwords to Samba.</para>
3084 <para><emphasis>NOTE :</emphasis> The use of <parameter>hosts equiv
3085 </parameter> can be a major security hole. This is because you are
3086 trusting the PC to supply the correct username. It is very easy to
3087 get a PC to supply a false username. I recommend that the
3088 <parameter>hosts equiv</parameter> option be only used if you really
3089 know what you are doing, or perhaps on a home network where you trust
3090 your spouse and kids. And only if you <emphasis>really</emphasis> trust
3091 them :-).</para>
3093 <para>Default: <emphasis>no host equivalences</emphasis></para>
3094 <para>Example: <command>hosts equiv = /etc/hosts.equiv</command></para>
3095 </listitem>
3096 </varlistentry>
3100 <varlistentry>
3101 <term><anchor id="INCLUDE">include (G)</term>
3102 <listitem><para>This allows you to include one config file
3103 inside another. The file is included literally, as though typed
3104 in place.</para>
3106 <para>It takes the standard substitutions, except <parameter>%u
3107 </parameter>, <parameter>%P</parameter> and <parameter>%S</parameter>.
3108 </para>
3110 <para>Default: <emphasis>no file included</emphasis></para>
3111 <para>Example: <command>include = /usr/local/samba/lib/admin_smb.conf
3112 </command></para></listitem>
3113 </varlistentry>
3117 <varlistentry>
3118 <term><anchor id="INHERITPERMISSIONS">inherit permissions (S)</term>
3119 <listitem><para>The permissions on new files and directories
3120 are normally governed by <link linkend="CREATEMASK"><parameter>
3121 create mask</parameter></link>, <link linkend="DIRECTORYMASK">
3122 <parameter>directory mask</parameter></link>, <link
3123 linkend="FORCECREATEMODE"><parameter>force create mode</parameter>
3124 </link> and <link linkend="FORCEDIRECTORYMODE"><parameter>force
3125 directory mode</parameter></link> but the boolean inherit
3126 permissions parameter overrides this.</para>
3128 <para>New directories inherit the mode of the parent directory,
3129 including bits such as setgid.</para>
3131 <para>New files inherit their read/write bits from the parent
3132 directory. Their execute bits continue to be determined by
3133 <link linkend="MAPARCHIVE"><parameter>map archive</parameter>
3134 </link>, <link linkend="MAPHIDDEN"><parameter>map hidden</parameter>
3135 </link> and <link linkend="MAPSYSTEM"><parameter>map system</parameter>
3136 </link> as usual.</para>
3138 <para>Note that the setuid bit is <emphasis>never</emphasis> set via
3139 inheritance (the code explicitly prohibits this).</para>
3141 <para>This can be particularly useful on large systems with
3142 many users, perhaps several thousand, to allow a single [homes]
3143 share to be used flexibly by each user.</para>
3145 <para>See also <link linkend="CREATEMASK"><parameter>create mask
3146 </parameter></link>, <link linkend="DIRECTORYMASK"><parameter>
3147 directory mask</parameter></link>, <link linkend="FORCECREATEMODE">
3148 <parameter>force create mode</parameter></link> and <link
3149 linkend="FORCEDIRECTORYMODE"><parameter>force directory mode</parameter>
3150 </link>.</para>
3152 <para>Default: <command>inherit permissions = no</command></para>
3153 </listitem>
3154 </varlistentry>
3158 <varlistentry>
3159 <term><anchor id="INTERFACES">interfaces (G)</term>
3160 <listitem><para>This option allows you to override the default
3161 network interfaces list that Samba will use for browsing, name
3162 registration and other NBT traffic. By default Samba will query
3163 the kernel for the list of all active interfaces and use any
3164 interfaces except 127.0.0.1 that are broadcast capable.</para>
3166 <para>The option takes a list of interface strings. Each string
3167 can be in any of the following forms:</para>
3169 <itemizedlist>
3170 <listitem><para>a network interface name (such as eth0).
3171 This may include shell-like wildcards so eth* will match
3172 any interface starting with the substring "eth"</para></listitem>
3174 <listitem><para>an IP address. In this case the netmask is
3175 determined from the list of interfaces obtained from the
3176 kernel</para></listitem>
3178 <listitem><para>an IP/mask pair. </para></listitem>
3180 <listitem><para>a broadcast/mask pair.</para></listitem>
3181 </itemizedlist>
3183 <para>The "mask" parameters can either be a bit length (such
3184 as 24 for a C class network) or a full netmask in dotted
3185 decimal form.</para>
3187 <para>The "IP" parameters above can either be a full dotted
3188 decimal IP address or a hostname which will be looked up via
3189 the OS's normal hostname resolution mechanisms.</para>
3191 <para>For example, the following line:</para>
3193 <para><command>interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
3194 </command></para>
3196 <para>would configure three network interfaces corresponding
3197 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
3198 The netmasks of the latter two interfaces would be set to 255.255.255.0.</para>
3200 <para>See also <link linkend="BINDINTERFACESONLY"><parameter>bind
3201 interfaces only</parameter></link>.</para>
3203 <para>Default: <emphasis>all active interfaces except 127.0.0.1
3204 that are broadcast capable</emphasis></para>
3205 </listitem>
3206 </varlistentry>
3210 <varlistentry>
3211 <term><anchor id="INVALIDUSERS">invalid users (S)</term>
3212 <listitem><para>This is a list of users that should not be allowed
3213 to login to this service. This is really a <emphasis>paranoid</emphasis>
3214 check to absolutely ensure an improper setting does not breach
3215 your security.</para>
3217 <para>A name starting with a '@' is interpreted as an NIS
3218 netgroup first (if your system supports NIS), and then as a UNIX
3219 group if the name was not found in the NIS netgroup database.</para>
3221 <para>A name starting with '+' is interpreted only
3222 by looking in the UNIX group database. A name starting with
3223 '&' is interpreted only by looking in the NIS netgroup database
3224 (this requires NIS to be working on your system). The characters
3225 '+' and '&' may be used at the start of the name in either order
3226 so the value <parameter>+&amp;group</parameter> means check the
3227 UNIX group database, followed by the NIS netgroup database, and
3228 the value <parameter>&+group"</parameter> means check the NIS
3229 netgroup database, followed by the UNIX group database (the
3230 same as the '@' prefix).</para>
3232 <para>The current servicename is substituted for <parameter>%S</parameter>.
3233 This is useful in the [homes] section.</para>
3235 <para>See also <link linkend="VALIDUSERS"><parameter>valid users
3236 </parameter></link>.</para>
3238 <para>Default: <emphasis>no invalid users</emphasis></para>
3239 <para>Example: <command>invalid users = root fred admin @wheel
3240 </command></para>
3241 </listitem>
3242 </varlistentry>
3246 <varlistentry>
3247 <term><anchor id="KEEPALIVE">keepalive (G)</term>
3248 <listitem><para>The value of the parameter (an integer) represents
3249 the number of seconds between <parameter>keepalive</parameter>
3250 packets. If this parameter is zero, no keepalive packets will be
3251 sent. Keepalive packets, if sent, allow the server to tell whether
3252 a client is still present and responding.</para>
3254 <para>Keepalives should, in general, not be needed if the socket
3255 being used has the SO_KEEPALIVE attribute set on it (see <link
3256 linkend="SOCKETOPTIONS"><parameter>socket options</parameter></link>).
3257 Basically you should only use this option if you strike difficulties.</para>
3259 <para>Default: <command>keepalive = 300</command></para>
3260 <para>Example: <command>keepalive = 600</command></para>
3261 </listitem>
3262 </varlistentry>
3266 <varlistentry>
3267 <term><anchor id="KERNELOPLOCKS">kernel oplocks (G)</term>
3268 <listitem><para>For UNIXes that support kernel based <link
3269 linkend="OPLOCKS"><parameter>oplocks</parameter></link>
3270 (currently only IRIX and the Linux 2.4 kernel), this parameter
3271 allows the use of them to be turned on or off.</para>
3273 <para>Kernel oplocks support allows Samba <parameter>oplocks
3274 </parameter> to be broken whenever a local UNIX process or NFS operation
3275 accesses a file that <ulink url="smbd.8.html"><command>smbd(8)</command>
3276 </ulink> has oplocked. This allows complete data consistency between
3277 SMB/CIFS, NFS and local file access (and is a <emphasis>very</emphasis>
3278 cool feature :-).</para>
3280 <para>This parameter defaults to <constant>on</constant> on systems
3281 that have the support, and <constant>off</constant> on systems that
3282 don't. You should never need to touch this parameter.</para>
3284 <para>See also the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
3285 </link> and <link linkend="LEVEL2OPLOCKS"><parameter>level2 oplocks
3286 </parameter></link> parameters.</para>
3288 <para>Default: <command>kernel oplocks = yes</command></para>
3289 </listitem>
3290 </varlistentry>
3295 <varlistentry>
3296 <term><anchor id="LANMANAUTH">lanman auth (G)</term>
3297 <listitem><para>This parameter determines whether or not <ulink url="smbd.8.html">smbd</ulink> will
3298 attempt to authenticate users using the LANMAN password hash.
3299 If disabled, only clients which support NT password hashes (e.g. Windows
3300 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
3301 network client) will be able to connect to the Samba host.</para>
3303 <para>Default : <command>lanman auth = yes</command></para>
3304 </listitem>
3305 </varlistentry>
3311 <varlistentry>
3312 <term><anchor id="LARGEREADWRITE">large readwrite(G)</term>
3313 <listitem><para>This parameter determines whether or not <ulink url="smbd.8.html">smbd</ulink>
3314 supports the new 64k streaming read and write varient SMB requests introduced
3315 with Windows 2000. Note that due to Windows 2000 client redirector bugs
3316 this requires Samba to be running on a 64-bit capable operating system such
3317 as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with
3318 Windows 2000 clients. Defaults to off. Not as tested as some other Samba
3319 code paths.
3320 </para>
3322 <para>Default : <command>large readwrite = no</command></para>
3323 </listitem>
3324 </varlistentry>
3330 <varlistentry>
3331 <term><anchor id="LEVEL2OPLOCKS">level2 oplocks (S)</term>
3332 <listitem><para>This parameter controls whether Samba supports
3333 level2 (read-only) oplocks on a share.</para>
3335 <para>Level2, or read-only oplocks allow Windows NT clients
3336 that have an oplock on a file to downgrade from a read-write oplock
3337 to a read-only oplock once a second client opens the file (instead
3338 of releasing all oplocks on a second open, as in traditional,
3339 exclusive oplocks). This allows all openers of the file that
3340 support level2 oplocks to cache the file for read-ahead only (ie.
3341 they may not cache writes or lock requests) and increases performance
3342 for many accesses of files that are not commonly written (such as
3343 application .EXE files).</para>
3345 <para>Once one of the clients which have a read-only oplock
3346 writes to the file all clients are notified (no reply is needed
3347 or waited for) and told to break their oplocks to "none" and
3348 delete any read-ahead caches.</para>
3350 <para>It is recommended that this parameter be turned on
3351 to speed access to shared executables.</para>
3353 <para>For more discussions on level2 oplocks see the CIFS spec.</para>
3355 <para>Currently, if <link linkend="KERNELOPLOCKS"><parameter>kernel
3356 oplocks</parameter></link> are supported then level2 oplocks are
3357 not granted (even if this parameter is set to <constant>yes</constant>).
3358 Note also, the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
3359 </link> parameter must be set to <constant>true</constant> on this share in order for
3360 this parameter to have any effect.</para>
3362 <para>See also the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
3363 </link> and <link linkend="OPLOCKS"><parameter>kernel oplocks</parameter>
3364 </link> parameters.</para>
3366 <para>Default: <command>level2 oplocks = yes</command></para>
3367 </listitem>
3368 </varlistentry>
3374 <varlistentry>
3375 <term><anchor id="LMANNOUNCE">lm announce (G)</term>
3376 <listitem><para>This parameter determines if <ulink url="nmbd.8.html">
3377 <command>nmbd(8)</command></ulink> will produce Lanman announce
3378 broadcasts that are needed by OS/2 clients in order for them to see
3379 the Samba server in their browse list. This parameter can have three
3380 values, <constant>true</constant>, <constant>false</constant>, or
3381 <constant>auto</constant>. The default is <constant>auto</constant>.
3382 If set to <constant>false</constant> Samba will never produce these
3383 broadcasts. If set to <constant>true</constant> Samba will produce
3384 Lanman announce broadcasts at a frequency set by the parameter
3385 <parameter>lm interval</parameter>. If set to <constant>auto</constant>
3386 Samba will not send Lanman announce broadcasts by default but will
3387 listen for them. If it hears such a broadcast on the wire it will
3388 then start sending them at a frequency set by the parameter
3389 <parameter>lm interval</parameter>.</para>
3391 <para>See also <link linkend="LMINTERVAL"><parameter>lm interval
3392 </parameter></link>.</para>
3394 <para>Default: <command>lm announce = auto</command></para>
3395 <para>Example: <command>lm announce = yes</command></para>
3396 </listitem>
3397 </varlistentry>
3401 <varlistentry>
3402 <term><anchor id="LMINTERVAL">lm interval (G)</term>
3403 <listitem><para>If Samba is set to produce Lanman announce
3404 broadcasts needed by OS/2 clients (see the <link linkend="LMANNOUNCE">
3405 <parameter>lm announce</parameter></link> parameter) then this
3406 parameter defines the frequency in seconds with which they will be
3407 made. If this is set to zero then no Lanman announcements will be
3408 made despite the setting of the <parameter>lm announce</parameter>
3409 parameter.</para>
3411 <para>See also <link linkend="LMANNOUNCE"><parameter>lm
3412 announce</parameter></link>.</para>
3414 <para>Default: <command>lm interval = 60</command></para>
3415 <para>Example: <command>lm interval = 120</command></para>
3416 </listitem>
3417 </varlistentry>
3421 <varlistentry>
3422 <term><anchor id="LOADPRINTERS">load printers (G)</term>
3423 <listitem><para>A boolean variable that controls whether all
3424 printers in the printcap will be loaded for browsing by default.
3425 See the <link linkend="PRINTERSSECT">printers</link> section for
3426 more details.</para>
3428 <para>Default: <command>load printers = yes</command></para></listitem>
3429 </varlistentry>
3434 <varlistentry>
3435 <term><anchor id="LOCALMASTER">local master (G)</term>
3436 <listitem><para>This option allows <ulink url="nmbd.8.html"><command>
3437 nmbd(8)</command></ulink> to try and become a local master browser
3438 on a subnet. If set to <constant>false</constant> then <command>
3439 nmbd</command> will not attempt to become a local master browser
3440 on a subnet and will also lose in all browsing elections. By
3441 default this value is set to <constant>true</constant>. Setting this value to <constant>true</constant> doesn't
3442 mean that Samba will <emphasis>become</emphasis> the local master
3443 browser on a subnet, just that <command>nmbd</command> will <emphasis>
3444 participate</emphasis> in elections for local master browser.</para>
3446 <para>Setting this value to <constant>false</constant> will cause <command>nmbd</command>
3447 <emphasis>never</emphasis> to become a local master browser.</para>
3449 <para>Default: <command>local master = yes</command></para>
3450 </listitem>
3451 </varlistentry>
3455 <varlistentry>
3456 <term><anchor id="LOCKDIR">lock dir (G)</term>
3457 <listitem><para>Synonym for <link linkend="LOCKDIRECTORY"><parameter>
3458 lock directory</parameter></link>.</para></listitem>
3459 </varlistentry>
3463 <varlistentry>
3464 <term><anchor id="LOCKDIRECTORY">lock directory (G)</term>
3465 <listitem><para>This option specifies the directory where lock
3466 files will be placed. The lock files are used to implement the
3467 <link linkend="MAXCONNECTIONS"><parameter>max connections</parameter>
3468 </link> option.</para>
3470 <para>Default: <command>lock directory = ${prefix}/var/locks</command></para>
3471 <para>Example: <command>lock directory = /var/run/samba/locks</command>
3472 </para></listitem>
3473 </varlistentry>
3477 <varlistentry>
3478 <term><anchor id="LOCKING">locking (S)</term>
3479 <listitem><para>This controls whether or not locking will be
3480 performed by the server in response to lock requests from the
3481 client.</para>
3483 <para>If <command>locking = no</command>, all lock and unlock
3484 requests will appear to succeed and all lock queries will report
3485 that the file in question is available for locking.</para>
3487 <para>If <command>locking = yes</command>, real locking will be performed
3488 by the server.</para>
3490 <para>This option <emphasis>may</emphasis> be useful for read-only
3491 filesystems which <emphasis>may</emphasis> not need locking (such as
3492 CDROM drives), although setting this parameter of <constant>no</constant>
3493 is not really recommended even in this case.</para>
3495 <para>Be careful about disabling locking either globally or in a
3496 specific service, as lack of locking may result in data corruption.
3497 You should never need to set this parameter.</para>
3499 <para>Default: <command>locking = yes</command></para>
3500 </listitem>
3501 </varlistentry>
3505 <varlistentry>
3506 <term><anchor id="LOGFILE">log file (G)</term>
3507 <listitem><para>This option allows you to override the name
3508 of the Samba log file (also known as the debug file).</para>
3510 <para>This option takes the standard substitutions, allowing
3511 you to have separate log files for each user or machine.</para>
3513 <para>Example: <command>log file = /usr/local/samba/var/log.%m
3514 </command></para></listitem>
3515 </varlistentry>
3519 <varlistentry>
3520 <term><anchor id="LOGLEVEL">log level (G)</term>
3521 <listitem><para>The value of the parameter (an integer) allows
3522 the debug level (logging level) to be specified in the
3523 <filename>smb.conf</filename> file. This is to give greater
3524 flexibility in the configuration of the system.</para>
3526 <para>The default will be the log level specified on
3527 the command line or level zero if none was specified.</para>
3529 <para>Example: <command>log level = 3</command></para></listitem>
3530 </varlistentry>
3534 <varlistentry>
3535 <term><anchor id="LOGONDRIVE">logon drive (G)</term>
3536 <listitem><para>This parameter specifies the local path to
3537 which the home directory will be connected (see <link
3538 linkend="LOGONHOME"><parameter>logon home</parameter></link>)
3539 and is only used by NT Workstations. </para>
3541 <para>Note that this option is only useful if Samba is set up as a
3542 logon server.</para>
3544 <para>Default: <command>logon drive = z:</command></para>
3545 <para>Example: <command>logon drive = h:</command></para>
3546 </listitem>
3547 </varlistentry>
3551 <varlistentry>
3552 <term><anchor id="LOGONHOME">logon home (G)</term>
3553 <listitem><para>This parameter specifies the home directory
3554 location when a Win95/98 or NT Workstation logs into a Samba PDC.
3555 It allows you to do </para>
3557 <para><prompt>C:\> </prompt><userinput>NET USE H: /HOME</userinput>
3558 </para>
3560 <para>from a command prompt, for example.</para>
3562 <para>This option takes the standard substitutions, allowing
3563 you to have separate logon scripts for each user or machine.</para>
3565 <para>This parameter can be used with Win9X workstations to ensure
3566 that roaming profiles are stored in a subdirectory of the user's
3567 home directory. This is done in the following way:</para>
3569 <para><command>logon home = \\%N\%U\profile</command></para>
3571 <para>This tells Samba to return the above string, with
3572 substitutions made when a client requests the info, generally
3573 in a NetUserGetInfo request. Win9X clients truncate the info to
3574 \\server\share when a user does <command>net use /home"</command>
3575 but use the whole string when dealing with profiles.</para>
3577 <para>Note that in prior versions of Samba, the <link linkend="LOGONPATH">
3578 <parameter>logon path</parameter></link> was returned rather than
3579 <parameter>logon home</parameter>. This broke <command>net use
3580 /home</command> but allowed profiles outside the home directory.
3581 The current implementation is correct, and can be used for
3582 profiles if you use the above trick.</para>
3584 <para>This option is only useful if Samba is set up as a logon
3585 server.</para>
3587 <para>Default: <command>logon home = "\\%N\%U"</command></para>
3588 <para>Example: <command>logon home = "\\remote_smb_server\%U"</command>
3589 </para></listitem>
3590 </varlistentry>
3593 <varlistentry>
3594 <term><anchor id="LOGONPATH">logon path (G)</term>
3595 <listitem><para>This parameter specifies the home directory
3596 where roaming profiles (NTuser.dat etc files for Windows NT) are
3597 stored. Contrary to previous versions of these manual pages, it has
3598 nothing to do with Win 9X roaming profiles. To find out how to
3599 handle roaming profiles for Win 9X system, see the <link linkend="LOGONHOME">
3600 <parameter>logon home</parameter></link> parameter.</para>
3602 <para>This option takes the standard substitutions, allowing you
3603 to have separate logon scripts for each user or machine. It also
3604 specifies the directory from which the "Application Data",
3605 (<filename>desktop</filename>, <filename>start menu</filename>,
3606 <filename>network neighborhood</filename>, <filename>programs</filename>
3607 and other folders, and their contents, are loaded and displayed on
3608 your Windows NT client.</para>
3610 <para>The share and the path must be readable by the user for
3611 the preferences and directories to be loaded onto the Windows NT
3612 client. The share must be writeable when the user logs in for the first
3613 time, in order that the Windows NT client can create the NTuser.dat
3614 and other directories.</para>
3616 <para>Thereafter, the directories and any of the contents can,
3617 if required, be made read-only. It is not advisable that the
3618 NTuser.dat file be made read-only - rename it to NTuser.man to
3619 achieve the desired effect (a <emphasis>MAN</emphasis>datory
3620 profile). </para>
3622 <para>Windows clients can sometimes maintain a connection to
3623 the [homes] share, even though there is no user logged in.
3624 Therefore, it is vital that the logon path does not include a
3625 reference to the homes share (i.e. setting this parameter to
3626 \%N\%U\profile_path will cause problems).</para>
3628 <para>This option takes the standard substitutions, allowing
3629 you to have separate logon scripts for each user or machine.</para>
3631 <para>Note that this option is only useful if Samba is set up
3632 as a logon server.</para>
3634 <para>Default: <command>logon path = \\%N\%U\profile</command></para>
3635 <para>Example: <command>logon path = \\PROFILESERVER\PROFILE\%U</command></para>
3636 </listitem>
3637 </varlistentry>
3641 <varlistentry>
3642 <term><anchor id="LOGONSCRIPT">logon script (G)</term>
3643 <listitem><para>This parameter specifies the batch file (.bat) or
3644 NT command file (.cmd) to be downloaded and run on a machine when
3645 a user successfully logs in. The file must contain the DOS
3646 style CR/LF line endings. Using a DOS-style editor to create the
3647 file is recommended.</para>
3649 <para>The script must be a relative path to the [netlogon]
3650 service. If the [netlogon] service specifies a <link linkend="PATH">
3651 <parameter>path</parameter></link> of <filename>/usr/local/samba/netlogon
3652 </filename>, and <command>logon script = STARTUP.BAT</command>, then
3653 the file that will be downloaded is:</para>
3655 <para><filename>/usr/local/samba/netlogon/STARTUP.BAT</filename></para>
3657 <para>The contents of the batch file are entirely your choice. A
3658 suggested command would be to add <command>NET TIME \\SERVER /SET
3659 /YES</command>, to force every machine to synchronize clocks with
3660 the same time server. Another use would be to add <command>NET USE
3661 U: \\SERVER\UTILS</command> for commonly used utilities, or <command>
3662 NET USE Q: \\SERVER\ISO9001_QA</command> for example.</para>
3664 <para>Note that it is particularly important not to allow write
3665 access to the [netlogon] share, or to grant users write permission
3666 on the batch files in a secure environment, as this would allow
3667 the batch files to be arbitrarily modified and security to be
3668 breached.</para>
3670 <para>This option takes the standard substitutions, allowing you
3671 to have separate logon scripts for each user or machine.</para>
3673 <para>This option is only useful if Samba is set up as a logon
3674 server.</para>
3676 <para>Default: <emphasis>no logon script defined</emphasis></para>
3677 <para>Example: <command>logon script = scripts\%U.bat</command></para>
3678 </listitem>
3679 </varlistentry>
3683 <varlistentry>
3684 <term><anchor id="LPPAUSECOMMAND">lppause command (S)</term>
3685 <listitem><para>This parameter specifies the command to be
3686 executed on the server host in order to stop printing or spooling
3687 a specific print job.</para>
3689 <para>This command should be a program or script which takes
3690 a printer name and job number to pause the print job. One way
3691 of implementing this is by using job priorities, where jobs
3692 having a too low priority won't be sent to the printer.</para>
3694 <para>If a <parameter>%p</parameter> is given then the printer name
3695 is put in its place. A <parameter>%j</parameter> is replaced with
3696 the job number (an integer). On HPUX (see <parameter>printing=hpux
3697 </parameter>), if the <parameter>-p%p</parameter> option is added
3698 to the lpq command, the job will show up with the correct status, i.e.
3699 if the job priority is lower than the set fence priority it will
3700 have the PAUSED status, whereas if the priority is equal or higher it
3701 will have the SPOOLED or PRINTING status.</para>
3703 <para>Note that it is good practice to include the absolute path
3704 in the lppause command as the PATH may not be available to the server.</para>
3706 <para>See also the <link linkend="PRINTING"><parameter>printing
3707 </parameter></link> parameter.</para>
3709 <para>Default: Currently no default value is given to
3710 this string, unless the value of the <parameter>printing</parameter>
3711 parameter is <constant>SYSV</constant>, in which case the default is :</para>
3713 <para><command>lp -i %p-%j -H hold</command></para>
3715 <para>or if the value of the <parameter>printing</parameter> parameter
3716 is <constant>SOFTQ</constant>, then the default is:</para>
3718 <para><command>qstat -s -j%j -h</command></para>
3720 <para>Example for HPUX: <command>lppause command = /usr/bin/lpalt
3721 %p-%j -p0</command></para>
3722 </listitem>
3723 </varlistentry>
3727 <varlistentry>
3728 <term><anchor id="LPQCACHETIME">lpq cache time (G)</term>
3729 <listitem><para>This controls how long lpq info will be cached
3730 for to prevent the <command>lpq</command> command being called too
3731 often. A separate cache is kept for each variation of the <command>
3732 lpq</command> command used by the system, so if you use different
3733 <command>lpq</command> commands for different users then they won't
3734 share cache information.</para>
3736 <para>The cache files are stored in <filename>/tmp/lpq.xxxx</filename>
3737 where xxxx is a hash of the <command>lpq</command> command in use.</para>
3739 <para>The default is 10 seconds, meaning that the cached results
3740 of a previous identical <command>lpq</command> command will be used
3741 if the cached data is less than 10 seconds old. A large value may
3742 be advisable if your <command>lpq</command> command is very slow.</para>
3744 <para>A value of 0 will disable caching completely.</para>
3746 <para>See also the <link linkend="PRINTING"><parameter>printing
3747 </parameter></link> parameter.</para>
3749 <para>Default: <command>lpq cache time = 10</command></para>
3750 <para>Example: <command>lpq cache time = 30</command></para>
3751 </listitem>
3752 </varlistentry>
3756 <varlistentry>
3757 <term><anchor id="LPQCOMMAND">lpq command (S)</term>
3758 <listitem><para>This parameter specifies the command to be
3759 executed on the server host in order to obtain <command>lpq
3760 </command>-style printer status information.</para>
3762 <para>This command should be a program or script which
3763 takes a printer name as its only parameter and outputs printer
3764 status information.</para>
3766 <para>Currently eight styles of printer status information
3767 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
3768 This covers most UNIX systems. You control which type is expected
3769 using the <parameter>printing =</parameter> option.</para>
3771 <para>Some clients (notably Windows for Workgroups) may not
3772 correctly send the connection number for the printer they are
3773 requesting status information about. To get around this, the
3774 server reports on the first printer service connected to by the
3775 client. This only happens if the connection number sent is invalid.</para>
3777 <para>If a <parameter>%p</parameter> is given then the printer name
3778 is put in its place. Otherwise it is placed at the end of the
3779 command.</para>
3781 <para>Note that it is good practice to include the absolute path
3782 in the <parameter>lpq command</parameter> as the <envar>$PATH
3783 </envar> may not be available to the server.</para>
3785 <para>See also the <link linkend="PRINTING"><parameter>printing
3786 </parameter></link> parameter.</para>
3788 <para>Default: <emphasis>depends on the setting of <parameter>
3789 printing</parameter></emphasis></para>
3791 <para>Example: <command>lpq command = /usr/bin/lpq -P%p</command></para>
3792 </listitem>
3793 </varlistentry>
3797 <varlistentry>
3798 <term><anchor id="LPRESUMECOMMAND">lpresume command (S)</term>
3799 <listitem><para>This parameter specifies the command to be
3800 executed on the server host in order to restart or continue
3801 printing or spooling a specific print job.</para>
3803 <para>This command should be a program or script which takes
3804 a printer name and job number to resume the print job. See
3805 also the <link linkend="LPPAUSECOMMAND"><parameter>lppause command
3806 </parameter></link> parameter.</para>
3808 <para>If a <parameter>%p</parameter> is given then the printer name
3809 is put in its place. A <parameter>%j</parameter> is replaced with
3810 the job number (an integer).</para>
3812 <para>Note that it is good practice to include the absolute path
3813 in the <parameter>lpresume command</parameter> as the PATH may not
3814 be available to the server.</para>
3816 <para>See also the <link linkend="PRINTING"><parameter>printing
3817 </parameter></link> parameter.</para>
3819 <para>Default: Currently no default value is given
3820 to this string, unless the value of the <parameter>printing</parameter>
3821 parameter is <constant>SYSV</constant>, in which case the default is :</para>
3823 <para><command>lp -i %p-%j -H resume</command></para>
3825 <para>or if the value of the <parameter>printing</parameter> parameter
3826 is <constant>SOFTQ</constant>, then the default is:</para>
3828 <para><command>qstat -s -j%j -r</command></para>
3830 <para>Example for HPUX: <command>lpresume command = /usr/bin/lpalt
3831 %p-%j -p2</command></para>
3832 </listitem>
3833 </varlistentry>
3837 <varlistentry>
3838 <term><anchor id="LPRMCOMMAND">lprm command (S)</term>
3839 <listitem><para>This parameter specifies the command to be
3840 executed on the server host in order to delete a print job.</para>
3842 <para>This command should be a program or script which takes
3843 a printer name and job number, and deletes the print job.</para>
3845 <para>If a <parameter>%p</parameter> is given then the printer name
3846 is put in its place. A <parameter>%j</parameter> is replaced with
3847 the job number (an integer).</para>
3849 <para>Note that it is good practice to include the absolute
3850 path in the <parameter>lprm command</parameter> as the PATH may not be
3851 available to the server.</para>
3853 <para>See also the <link linkend="PRINTING"><parameter>printing
3854 </parameter></link> parameter.</para>
3856 <para>Default: <emphasis>depends on the setting of <parameter>printing
3857 </parameter></emphasis></para>
3859 <para>Example 1: <command>lprm command = /usr/bin/lprm -P%p %j
3860 </command></para>
3861 <para>Example 2: <command>lprm command = /usr/bin/cancel %p-%j
3862 </command></para></listitem>
3863 </varlistentry>
3867 <varlistentry>
3868 <term><anchor id="MACHINEPASSWORDTIMEOUT">machine password timeout (G)</term>
3869 <listitem><para>If a Samba server is a member of a Windows
3870 NT Domain (see the <link linkend="SECURITYEQUALSDOMAIN">security=domain</link>)
3871 parameter) then periodically a running <ulink url="smbd.8.html">
3872 smbd(8)</ulink> process will try and change the MACHINE ACCOUNT
3873 PASSWORD stored in the TDB called <filename>private/secrets.tdb
3874 </filename>. This parameter specifies how often this password
3875 will be changed, in seconds. The default is one week (expressed in
3876 seconds), the same as a Windows NT Domain member server.</para>
3878 <para>See also <ulink url="smbpasswd.8.html"><command>smbpasswd(8)
3879 </command></ulink>, and the <link linkend="SECURITYEQUALSDOMAIN">
3880 security=domain</link>) parameter.</para>
3882 <para>Default: <command>machine password timeout = 604800</command></para>
3883 </listitem>
3884 </varlistentry>
3887 <varlistentry>
3888 <term><anchor id="MAGICOUTPUT">magic output (S)</term>
3889 <listitem><para>This parameter specifies the name of a file
3890 which will contain output created by a magic script (see the
3891 <link linkend="MAGICSCRIPT"><parameter>magic script</parameter></link>
3892 parameter below).</para>
3894 <para>Warning: If two clients use the same <parameter>magic script
3895 </parameter> in the same directory the output file content
3896 is undefined.</para>
3898 <para>Default: <command>magic output = &lt;magic script name&gt;.out
3899 </command></para>
3901 <para>Example: <command>magic output = myfile.txt</command></para>
3902 </listitem>
3903 </varlistentry>
3907 <varlistentry>
3908 <term><anchor id="MAGICSCRIPT">magic script (S)</term>
3909 <listitem><para>This parameter specifies the name of a file which,
3910 if opened, will be executed by the server when the file is closed.
3911 This allows a UNIX script to be sent to the Samba host and
3912 executed on behalf of the connected user.</para>
3914 <para>Scripts executed in this way will be deleted upon
3915 completion assuming that the user has the appropriate level
3916 of privilege and the file permissions allow the deletion.</para>
3918 <para>If the script generates output, output will be sent to
3919 the file specified by the <link linkend="MAGICOUTPUT"><parameter>
3920 magic output</parameter></link> parameter (see above).</para>
3922 <para>Note that some shells are unable to interpret scripts
3923 containing CR/LF instead of CR as
3924 the end-of-line marker. Magic scripts must be executable
3925 <emphasis>as is</emphasis> on the host, which for some hosts and
3926 some shells will require filtering at the DOS end.</para>
3928 <para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and
3929 should <emphasis>NOT</emphasis> be relied upon.</para>
3931 <para>Default: <emphasis>None. Magic scripts disabled.</emphasis></para>
3932 <para>Example: <command>magic script = user.csh</command></para>
3933 </listitem>
3934 </varlistentry>
3938 <varlistentry>
3939 <term><anchor id="MANGLECASE">mangle case (S)</term>
3940 <listitem><para>See the section on <link linkend="NAMEMANGLINGSECT">
3941 NAME MANGLING</link></para>
3943 <para>Default: <command>mangle case = no</command></para>
3944 </listitem>
3945 </varlistentry>
3948 <varlistentry>
3949 <term><anchor id="MANGLEDMAP">mangled map (S)</term>
3950 <listitem><para>This is for those who want to directly map UNIX
3951 file names which cannot be represented on Windows/DOS. The mangling
3952 of names is not always what is needed. In particular you may have
3953 documents with file extensions that differ between DOS and UNIX.
3954 For example, under UNIX it is common to use <filename>.html</filename>
3955 for HTML files, whereas under Windows/DOS <filename>.htm</filename>
3956 is more commonly used.</para>
3958 <para>So to map <filename>html</filename> to <filename>htm</filename>
3959 you would use:</para>
3961 <para><command>mangled map = (*.html *.htm)</command></para>
3963 <para>One very useful case is to remove the annoying <filename>;1
3964 </filename> off the ends of filenames on some CDROMs (only visible
3965 under some UNIXes). To do this use a map of (*;1 *;).</para>
3967 <para>Default: <emphasis>no mangled map</emphasis></para>
3968 <para>Example: <command>mangled map = (*;1 *;)</command></para>
3969 </listitem>
3970 </varlistentry>
3973 <varlistentry>
3974 <term><anchor id="MANGLEDNAMES">mangled names (S)</term>
3975 <listitem><para>This controls whether non-DOS names under UNIX
3976 should be mapped to DOS-compatible names ("mangled") and made visible,
3977 or whether non-DOS names should simply be ignored.</para>
3979 <para>See the section on <link linkend="NAMEMANGLINGSECT">
3980 NAME MANGLING</link> for details on how to control the mangling process.</para>
3982 <para>If mangling is used then the mangling algorithm is as follows:</para>
3984 <itemizedlist>
3985 <listitem><para>The first (up to) five alphanumeric characters
3986 before the rightmost dot of the filename are preserved, forced
3987 to upper case, and appear as the first (up to) five characters
3988 of the mangled name.</para></listitem>
3990 <listitem><para>A tilde "~" is appended to the first part of the mangled
3991 name, followed by a two-character unique sequence, based on the
3992 original root name (i.e., the original filename minus its final
3993 extension). The final extension is included in the hash calculation
3994 only if it contains any upper case characters or is longer than three
3995 characters.</para>
3997 <para>Note that the character to use may be specified using
3998 the <link linkend="MANGLINGCHAR"><parameter>mangling char</parameter>
3999 </link> option, if you don't like '~'.</para></listitem>
4001 <listitem><para>The first three alphanumeric characters of the final
4002 extension are preserved, forced to upper case and appear as the
4003 extension of the mangled name. The final extension is defined as that
4004 part of the original filename after the rightmost dot. If there are no
4005 dots in the filename, the mangled name will have no extension (except
4006 in the case of "hidden files" - see below).</para></listitem>
4008 <listitem><para>Files whose UNIX name begins with a dot will be
4009 presented as DOS hidden files. The mangled name will be created as
4010 for other filenames, but with the leading dot removed and "___" as
4011 its extension regardless of actual original extension (that's three
4012 underscores).</para></listitem>
4013 </itemizedlist>
4015 <para>The two-digit hash value consists of upper case
4016 alphanumeric characters.</para>
4018 <para>This algorithm can cause name collisions only if files
4019 in a directory share the same first five alphanumeric characters.
4020 The probability of such a clash is 1/1300.</para>
4022 <para>The name mangling (if enabled) allows a file to be
4023 copied between UNIX directories from Windows/DOS while retaining
4024 the long UNIX filename. UNIX files can be renamed to a new extension
4025 from Windows/DOS and will retain the same basename. Mangled names
4026 do not change between sessions.</para>
4028 <para>Default: <command>mangled names = yes</command></para>
4029 </listitem>
4030 </varlistentry>
4034 <varlistentry>
4035 <term><anchor id="MANGLEDSTACK">mangled stack (G)</term>
4036 <listitem><para>This parameter controls the number of mangled names
4037 that should be cached in the Samba server <ulink url="smbd.8.html">
4038 smbd(8)</ulink>.</para>
4040 <para>This stack is a list of recently mangled base names
4041 (extensions are only maintained if they are longer than 3 characters
4042 or contains upper case characters).</para>
4044 <para>The larger this value, the more likely it is that mangled
4045 names can be successfully converted to correct long UNIX names.
4046 However, large stack sizes will slow most directory accesses. Smaller
4047 stacks save memory in the server (each stack element costs 256 bytes).
4048 </para>
4050 <para>It is not possible to absolutely guarantee correct long
4051 filenames, so be prepared for some surprises!</para>
4053 <para>Default: <command>mangled stack = 50</command></para>
4054 <para>Example: <command>mangled stack = 100</command></para>
4055 </listitem>
4056 </varlistentry>
4061 <varlistentry>
4062 <term><anchor id="MANGLINGCHAR">mangling char (S)</term>
4063 <listitem><para>This controls what character is used as
4064 the <emphasis>magic</emphasis> character in <link
4065 linkend="NAMEMANGLINGSECT">name mangling</link>. The default is a '~'
4066 but this may interfere with some software. Use this option to set
4067 it to whatever you prefer.</para>
4069 <para>Default: <command>mangling char = ~</command></para>
4070 <para>Example: <command>mangling char = ^</command></para>
4071 </listitem>
4072 </varlistentry>
4078 <varlistentry>
4079 <term><anchor id="MAPARCHIVE">map archive (S)</term>
4080 <listitem><para>This controls whether the DOS archive attribute
4081 should be mapped to the UNIX owner execute bit. The DOS archive bit
4082 is set when a file has been modified since its last backup. One
4083 motivation for this option it to keep Samba/your PC from making
4084 any file it touches from becoming executable under UNIX. This can
4085 be quite annoying for shared source code, documents, etc...</para>
4087 <para>Note that this requires the <parameter>create mask</parameter>
4088 parameter to be set such that owner execute bit is not masked out
4089 (i.e. it must include 100). See the parameter <link linkend="CREATEMASK">
4090 <parameter>create mask</parameter></link> for details.</para>
4092 <para>Default: <command>map archive = yes</command></para>
4093 </listitem>
4094 </varlistentry>
4098 <varlistentry>
4099 <term><anchor id="MAPHIDDEN">map hidden (S)</term>
4100 <listitem><para>This controls whether DOS style hidden files
4101 should be mapped to the UNIX world execute bit.</para>
4103 <para>Note that this requires the <parameter>create mask</parameter>
4104 to be set such that the world execute bit is not masked out (i.e.
4105 it must include 001). See the parameter <link linkend="CREATEMASK">
4106 <parameter>create mask</parameter></link> for details.</para>
4108 <para>Default: <command>map hidden = no</command></para>
4109 </listitem>
4110 </varlistentry>
4113 <varlistentry>
4114 <term><anchor id="MAPSYSTEM">map system (S)</term>
4115 <listitem><para>This controls whether DOS style system files
4116 should be mapped to the UNIX group execute bit.</para>
4118 <para>Note that this requires the <parameter>create mask</parameter>
4119 to be set such that the group execute bit is not masked out (i.e.
4120 it must include 010). See the parameter <link linkend="CREATEMASK">
4121 <parameter>create mask</parameter></link> for details.</para>
4123 <para>Default: <command>map system = no</command></para>
4124 </listitem>
4125 </varlistentry>
4128 <varlistentry>
4129 <term><anchor id="MAPTOGUEST">map to guest (G)</term>
4130 <listitem><para>This parameter is only useful in <link linkend="SECURITY">
4131 security</link> modes other than <parameter>security=share</parameter>
4132 - i.e. <constant>user</constant>, <constant>server</constant>,
4133 and <constant>domain</constant>.</para>
4135 <para>This parameter can take three different values, which tell
4136 <ulink url="smbd.8.html">smbd(8)</ulink> what to do with user
4137 login requests that don't match a valid UNIX user in some way.</para>
4139 <para>The three settings are :</para>
4141 <itemizedlist>
4142 <listitem><para><constant>Never</constant> - Means user login
4143 requests with an invalid password are rejected. This is the
4144 default.</para></listitem>
4146 <listitem><para><constant>Bad User</constant> - Means user
4147 logins with an invalid password are rejected, unless the username
4148 does not exist, in which case it is treated as a guest login and
4149 mapped into the <link linkend="GUESTACCOUNT"><parameter>
4150 guest account</parameter></link>.</para></listitem>
4152 <listitem><para><constant>Bad Password</constant> - Means user logins
4153 with an invalid password are treated as a guest login and mapped
4154 into the <link linkend="GUESTACCOUNT">guest account</link>. Note that
4155 this can cause problems as it means that any user incorrectly typing
4156 their password will be silently logged on as "guest" - and
4157 will not know the reason they cannot access files they think
4158 they should - there will have been no message given to them
4159 that they got their password wrong. Helpdesk services will
4160 <emphasis>hate</emphasis> you if you set the <parameter>map to
4161 guest</parameter> parameter this way :-).</para></listitem>
4162 </itemizedlist>
4164 <para>Note that this parameter is needed to set up "Guest"
4165 share services when using <parameter>security</parameter> modes other than
4166 share. This is because in these modes the name of the resource being
4167 requested is <emphasis>not</emphasis> sent to the server until after
4168 the server has successfully authenticated the client so the server
4169 cannot make authentication decisions at the correct time (connection
4170 to the share) for "Guest" shares.</para>
4172 <para>For people familiar with the older Samba releases, this
4173 parameter maps to the old compile-time setting of the <constant>
4174 GUEST_SESSSETUP</constant> value in local.h.</para>
4176 <para>Default: <command>map to guest = Never</command></para>
4177 <para>Example: <command>map to guest = Bad User</command></para>
4178 </listitem>
4179 </varlistentry>
4183 <varlistentry>
4184 <term><anchor id="MAXCONNECTIONS">max connections (S)</term>
4185 <listitem><para>This option allows the number of simultaneous
4186 connections to a service to be limited. If <parameter>max connections
4187 </parameter> is greater than 0 then connections will be refused if
4188 this number of connections to the service are already open. A value
4189 of zero mean an unlimited number of connections may be made.</para>
4191 <para>Record lock files are used to implement this feature. The
4192 lock files will be stored in the directory specified by the <link
4193 linkend="LOCKDIRECTORY"><parameter>lock directory</parameter></link>
4194 option.</para>
4196 <para>Default: <command>max connections = 0</command></para>
4197 <para>Example: <command>max connections = 10</command></para>
4198 </listitem>
4199 </varlistentry>
4203 <varlistentry>
4204 <term><anchor id="MAXDISKSIZE">max disk size (G)</term>
4205 <listitem><para>This option allows you to put an upper limit
4206 on the apparent size of disks. If you set this option to 100
4207 then all shares will appear to be not larger than 100 MB in
4208 size.</para>
4210 <para>Note that this option does not limit the amount of
4211 data you can put on the disk. In the above case you could still
4212 store much more than 100 MB on the disk, but if a client ever asks
4213 for the amount of free disk space or the total disk size then the
4214 result will be bounded by the amount specified in <parameter>max
4215 disk size</parameter>.</para>
4217 <para>This option is primarily useful to work around bugs
4218 in some pieces of software that can't handle very large disks,
4219 particularly disks over 1GB in size.</para>
4221 <para>A <parameter>max disk size</parameter> of 0 means no limit.</para>
4223 <para>Default: <command>max disk size = 0</command></para>
4224 <para>Example: <command>max disk size = 1000</command></para>
4225 </listitem>
4226 </varlistentry>
4230 <varlistentry>
4231 <term><anchor id="MAXLOGSIZE">max log size (G)</term>
4232 <listitem><para>This option (an integer in kilobytes) specifies
4233 the max size the log file should grow to. Samba periodically checks
4234 the size and if it is exceeded it will rename the file, adding
4235 a <filename>.old</filename> extension.</para>
4237 <para>A size of 0 means no limit.</para>
4239 <para>Default: <command>max log size = 5000</command></para>
4240 <para>Example: <command>max log size = 1000</command></para>
4241 </listitem>
4242 </varlistentry>
4246 <varlistentry>
4247 <term><anchor id="MAXMUX">max mux (G)</term>
4248 <listitem><para>This option controls the maximum number of
4249 outstanding simultaneous SMB operations that Samba tells the client
4250 it will allow. You should never need to set this parameter.</para>
4252 <para>Default: <command>max mux = 50</command></para>
4253 </listitem>
4254 </varlistentry>
4258 <varlistentry>
4259 <term><anchor id="MAXOPENFILES">max open files (G)</term>
4260 <listitem><para>This parameter limits the maximum number of
4261 open files that one <ulink url="smbd.8.html">smbd(8)</ulink> file
4262 serving process may have open for a client at any one time. The
4263 default for this parameter is set very high (10,000) as Samba uses
4264 only one bit per unopened file.</para>
4266 <para>The limit of the number of open files is usually set
4267 by the UNIX per-process file descriptor limit rather than
4268 this parameter so you should never need to touch this parameter.</para>
4270 <para>Default: <command>max open files = 10000</command></para>
4271 </listitem>
4272 </varlistentry>
4276 <varlistentry>
4277 <term><anchor id="MAXPRINTJOBS">max print jobs (S)</term>
4278 <listitem><para>This parameter limits the maximum number of
4279 jobs allowable in a Samba printer queue at any given moment.
4280 If this number is exceeded, <ulink url="smbd.8.html"><command>
4281 smbd(8)</command></ulink> will remote "Out of Space" to the client.
4282 See all <link linkend="TOTALPRINTJOBS"><parameter>total
4283 print jobs</parameter></link>.
4284 </para>
4286 <para>Default: <command>max print jobs = 1000</command></para>
4287 <para>Example: <command>max print jobs = 5000</command></para>
4288 </listitem>
4289 </varlistentry>
4292 <varlistentry>
4293 <term><anchor id="MAXPROTOCOL">max protocol (G)</term>
4294 <listitem><para>The value of the parameter (a string) is the highest
4295 protocol level that will be supported by the server.</para>
4297 <para>Possible values are :</para>
4298 <itemizedlist>
4299 <listitem><para><constant>CORE</constant>: Earliest version. No
4300 concept of user names.</para></listitem>
4302 <listitem><para><constant>COREPLUS</constant>: Slight improvements on
4303 CORE for efficiency.</para></listitem>
4305 <listitem><para><constant>LANMAN1</constant>: First <emphasis>
4306 modern</emphasis> version of the protocol. Long filename
4307 support.</para></listitem>
4309 <listitem><para><constant>LANMAN2</constant>: Updates to Lanman1 protocol.
4310 </para></listitem>
4312 <listitem><para><constant>NT1</constant>: Current up to date version of
4313 the protocol. Used by Windows NT. Known as CIFS.</para></listitem>
4314 </itemizedlist>
4316 <para>Normally this option should not be set as the automatic
4317 negotiation phase in the SMB protocol takes care of choosing
4318 the appropriate protocol.</para>
4320 <para>See also <link linkend="MINPROTOCOL"><parameter>min
4321 protocol</parameter></link></para>
4323 <para>Default: <command>max protocol = NT1</command></para>
4324 <para>Example: <command>max protocol = LANMAN1</command></para>
4325 </listitem>
4326 </varlistentry>
4330 <varlistentry>
4331 <term><anchor id="MAXSMBDPROCESSES">max smbd processes (G)</term>
4332 <listitem><para>This parameter limits the maximum number of
4333 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
4334 processes concurrently running on a system and is intended
4335 as a stopgap to prevent degrading service to clients in the event
4336 that the server has insufficient resources to handle more than this
4337 number of connections. Remember that under normal operating
4338 conditions, each user will have an <ulink url="smbd.8.html">smbd</ulink> associated with him or her
4339 to handle connections to all shares from a given host.
4340 </para>
4342 <para>Default: <command>max smbd processes = 0</command> ## no limit</para>
4343 <para>Example: <command>max smbd processes = 1000</command></para>
4344 </listitem>
4345 </varlistentry>
4350 <varlistentry>
4351 <term><anchor id="MAXTTL">max ttl (G)</term>
4352 <listitem><para>This option tells <ulink url="nmbd.8.html">nmbd(8)</ulink>
4353 what the default 'time to live' of NetBIOS names should be (in seconds)
4354 when <command>nmbd</command> is requesting a name using either a
4355 broadcast packet or from a WINS server. You should never need to
4356 change this parameter. The default is 3 days.</para>
4358 <para>Default: <command>max ttl = 259200</command></para>
4359 </listitem>
4360 </varlistentry>
4364 <varlistentry>
4365 <term><anchor id="MAXWINSTTL">max wins ttl (G)</term>
4366 <listitem><para>This option tells <ulink url="nmbd.8.html">nmbd(8)
4367 </ulink> when acting as a WINS server (<link linkend="WINSSUPPORT">
4368 <parameter>wins support=yes</parameter></link>) what the maximum
4369 'time to live' of NetBIOS names that <command>nmbd</command>
4370 will grant will be (in seconds). You should never need to change this
4371 parameter. The default is 6 days (518400 seconds).</para>
4373 <para>See also the <link linkend="MINWINSTTL"><parameter>min
4374 wins ttl"</parameter></link> parameter.</para>
4376 <para>Default: <command>max wins ttl = 518400</command></para>
4377 </listitem>
4378 </varlistentry>
4382 <varlistentry>
4383 <term><anchor id="MAXXMIT">max xmit (G)</term>
4384 <listitem><para>This option controls the maximum packet size
4385 that will be negotiated by Samba. The default is 65535, which
4386 is the maximum. In some cases you may find you get better performance
4387 with a smaller value. A value below 2048 is likely to cause problems.
4388 </para>
4390 <para>Default: <command>max xmit = 65535</command></para>
4391 <para>Example: <command>max xmit = 8192</command></para>
4392 </listitem>
4393 </varlistentry>
4397 <varlistentry>
4398 <term><anchor id="MESSAGECOMMAND">message command (G)</term>
4399 <listitem><para>This specifies what command to run when the
4400 server receives a WinPopup style message.</para>
4402 <para>This would normally be a command that would
4403 deliver the message somehow. How this is to be done is
4404 up to your imagination.</para>
4406 <para>An example is:</para>
4408 <para><command>message command = csh -c 'xedit %s;rm %s' &</command>
4409 </para>
4411 <para>This delivers the message using <command>xedit</command>, then
4412 removes it afterwards. <emphasis>NOTE THAT IT IS VERY IMPORTANT
4413 THAT THIS COMMAND RETURN IMMEDIATELY</emphasis>. That's why I
4414 have the '&' on the end. If it doesn't return immediately then
4415 your PCs may freeze when sending messages (they should recover
4416 after 30 seconds, hopefully).</para>
4418 <para>All messages are delivered as the global guest user.
4419 The command takes the standard substitutions, although <parameter>
4420 %u</parameter> won't work (<parameter>%U</parameter> may be better
4421 in this case).</para>
4423 <para>Apart from the standard substitutions, some additional
4424 ones apply. In particular:</para>
4426 <itemizedlist>
4427 <listitem><para><parameter>%s</parameter> = the filename containing
4428 the message.</para></listitem>
4430 <listitem><para><parameter>%t</parameter> = the destination that
4431 the message was sent to (probably the server name).</para></listitem>
4433 <listitem><para><parameter>%f</parameter> = who the message
4434 is from.</para></listitem>
4435 </itemizedlist>
4437 <para>You could make this command send mail, or whatever else
4438 takes your fancy. Please let us know of any really interesting
4439 ideas you have.</para>
4442 <para>Here's a way of sending the messages as mail to root:</para>
4444 <para><command>message command = /bin/mail -s 'message from %f on
4445 %m' root &lt; %s; rm %s</command></para>
4447 <para>If you don't have a message command then the message
4448 won't be delivered and Samba will tell the sender there was
4449 an error. Unfortunately WfWg totally ignores the error code
4450 and carries on regardless, saying that the message was delivered.
4451 </para>
4453 <para>If you want to silently delete it then try:</para>
4455 <para><command>message command = rm %s</command></para>
4457 <para>Default: <emphasis>no message command</emphasis></para>
4458 <para>Example: <command>message command = csh -c 'xedit %s;
4459 rm %s' &</command></para>
4460 </listitem>
4461 </varlistentry>
4466 <varlistentry>
4467 <term><anchor id="MINPASSWDLENGTH">min passwd length (G)</term>
4468 <listitem><para>Synonym for <link linkend="MINPASSWORDLENGTH">
4469 <parameter>min password length</parameter></link>.</para>
4470 </listitem>
4471 </varlistentry>
4475 <varlistentry>
4476 <term><anchor id="MINPASSWORDLENGTH">min password length (G)</term>
4477 <listitem><para>This option sets the minimum length in characters
4478 of a plaintext password that <command>smbd</command> will accept when performing
4479 UNIX password changing.</para>
4481 <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix
4482 password sync</parameter></link>, <link linkend="PASSWDPROGRAM">
4483 <parameter>passwd program</parameter></link> and <link
4484 linkend="PASSWDCHATDEBUG"><parameter>passwd chat debug</parameter>
4485 </link>.</para>
4487 <para>Default: <command>min password length = 5</command></para>
4488 </listitem>
4489 </varlistentry>
4493 <varlistentry>
4494 <term><anchor id="MINPRINTSPACE">min print space (S)</term>
4495 <listitem><para>This sets the minimum amount of free disk
4496 space that must be available before a user will be able to spool
4497 a print job. It is specified in kilobytes. The default is 0, which
4498 means a user can always spool a print job.</para>
4500 <para>See also the <link linkend="PRINTING"><parameter>printing
4501 </parameter></link> parameter.</para>
4503 <para>Default: <command>min print space = 0</command></para>
4504 <para>Example: <command>min print space = 2000</command></para>
4505 </listitem>
4506 </varlistentry>
4511 <varlistentry>
4512 <term><anchor id="MINPROTOCOL">min protocol (G)</term>
4513 <listitem><para>The value of the parameter (a string) is the
4514 lowest SMB protocol dialect than Samba will support. Please refer
4515 to the <link linkend="MAXPROTOCOL"><parameter>max protocol</parameter></link>
4516 parameter for a list of valid protocol names and a brief description
4517 of each. You may also wish to refer to the C source code in
4518 <filename>source/smbd/negprot.c</filename> for a listing of known protocol
4519 dialects supported by clients.</para>
4521 <para>If you are viewing this parameter as a security measure, you should
4522 also refer to the <link linkend="LANMANAUTH"><parameter>lanman
4523 auth</parameter></link> parameter. Otherwise, you should never need
4524 to change this parameter.</para>
4526 <para>Default : <command>min protocol = CORE</command></para>
4527 <para>Example : <command>min protocol = NT1</command> # disable DOS
4528 clients</para>
4529 </listitem>
4530 </varlistentry>
4535 <varlistentry>
4536 <term><anchor id="MINWINSTTL">min wins ttl (G)</term>
4537 <listitem><para>This option tells <ulink url="nmbd.8.html">nmbd(8)</ulink>
4538 when acting as a WINS server (<link linkend="WINSSUPPORT"><parameter>
4539 wins support = yes</parameter></link>) what the minimum 'time to live'
4540 of NetBIOS names that <command>nmbd</command> will grant will be (in
4541 seconds). You should never need to change this parameter. The default
4542 is 6 hours (21600 seconds).</para>
4544 <para>Default: <command>min wins ttl = 21600</command></para>
4545 </listitem>
4546 </varlistentry>
4551 <varlistentry>
4552 <term><anchor id="MSDFSROOT">msdfs root (S)</term>
4553 <listitem><para>This boolean parameter is only available if
4554 Samba is configured and compiled with the <command>
4555 --with-msdfs</command> option. If set to <constant>yes></constant>,
4556 Samba treats the share as a Dfs root and allows clients to browse
4557 the distributed file system tree rooted at the share directory.
4558 Dfs links are specified in the share directory by symbolic
4559 links of the form <filename>msdfs:serverA\shareA,serverB\shareB
4560 </filename> and so on. For more information on setting up a Dfs tree
4561 on Samba, refer to <ulink url="msdfs_setup.html">msdfs_setup.html
4562 </ulink>.</para>
4564 <para>See also <link linkend="HOSTMSDFS"><parameter>host msdfs
4565 </parameter></link></para>
4567 <para>Default: <command>msdfs root = no</command></para>
4568 </listitem>
4569 </varlistentry>
4572 <varlistentry>
4573 <term><anchor id="NAMERESOLVEORDER">name resolve order (G)</term>
4574 <listitem><para>This option is used by the programs in the Samba
4575 suite to determine what naming services to use and in what order
4576 to resolve host names to IP addresses. The option takes a space
4577 separated string of name resolution options.</para>
4579 <para>The options are :"lmhosts", "host", "wins" and "bcast". They
4580 cause names to be resolved as follows :</para>
4582 <itemizedlist>
4583 <listitem><para><constant>lmhosts</constant> : Lookup an IP
4584 address in the Samba lmhosts file. If the line in lmhosts has
4585 no name type attached to the NetBIOS name (see the <ulink
4586 url="lmhosts.5.html">lmhosts(5)</ulink> for details) then
4587 any name type matches for lookup.</para></listitem>
4589 <listitem><para><constant>host</constant> : Do a standard host
4590 name to IP address resolution, using the system <filename>/etc/hosts
4591 </filename>, NIS, or DNS lookups. This method of name resolution
4592 is operating system depended for instance on IRIX or Solaris this
4593 may be controlled by the <filename>/etc/nsswitch.conf</filename>
4594 file). Note that this method is only used if the NetBIOS name
4595 type being queried is the 0x20 (server) name type, otherwise
4596 it is ignored.</para></listitem>
4598 <listitem><para><constant>wins</constant> : Query a name with
4599 the IP address listed in the <link linkend="WINSSERVER"><parameter>
4600 wins server</parameter></link> parameter. If no WINS server has
4601 been specified this method will be ignored.</para></listitem>
4603 <listitem><para><constant>bcast</constant> : Do a broadcast on
4604 each of the known local interfaces listed in the <link
4605 linkend="INTERFACES"><parameter>interfaces</parameter></link>
4606 parameter. This is the least reliable of the name resolution
4607 methods as it depends on the target host being on a locally
4608 connected subnet.</para></listitem>
4609 </itemizedlist>
4611 <para>Default: <command>name resolve order = lmhosts host wins bcast
4612 </command></para>
4613 <para>Example: <command>name resolve order = lmhosts bcast host
4614 </command></para>
4616 <para>This will cause the local lmhosts file to be examined
4617 first, followed by a broadcast attempt, followed by a normal
4618 system hostname lookup.</para>
4619 </listitem>
4620 </varlistentry>
4625 <varlistentry>
4626 <term><anchor id="NETBIOSALIASES">netbios aliases (G)</term>
4627 <listitem><para>This is a list of NetBIOS names that <ulink
4628 url="nmbd.8.html">nmbd(8)</ulink> will advertise as additional
4629 names by which the Samba server is known. This allows one machine
4630 to appear in browse lists under multiple names. If a machine is
4631 acting as a browse server or logon server none
4632 of these names will be advertised as either browse server or logon
4633 servers, only the primary name of the machine will be advertised
4634 with these capabilities.</para>
4636 <para>See also <link linkend="NETBIOSNAME"><parameter>netbios
4637 name</parameter></link>.</para>
4639 <para>Default: <emphasis>empty string (no additional names)</emphasis></para>
4640 <para>Example: <command>netbios aliases = TEST TEST1 TEST2</command></para>
4641 </listitem>
4642 </varlistentry>
4646 <varlistentry>
4647 <term><anchor id="NETBIOSNAME">netbios name (G)</term>
4648 <listitem><para>This sets the NetBIOS name by which a Samba
4649 server is known. By default it is the same as the first component
4650 of the host's DNS name. If a machine is a browse server or
4651 logon server this name (or the first component
4652 of the hosts DNS name) will be the name that these services are
4653 advertised under.</para>
4655 <para>See also <link linkend="NETBIOSALIASES"><parameter>netbios
4656 aliases</parameter></link>.</para>
4658 <para>Default: <emphasis>machine DNS name</emphasis></para>
4659 <para>Example: <command>netbios name = MYNAME</command></para>
4660 </listitem>
4661 </varlistentry>
4665 <varlistentry>
4666 <term><anchor id="NETBIOSSCOPE">netbios scope (G)</term>
4667 <listitem><para>This sets the NetBIOS scope that Samba will
4668 operate under. This should not be set unless every machine
4669 on your LAN also sets this value.</para>
4670 </listitem>
4671 </varlistentry>
4674 <varlistentry>
4675 <term><anchor id="NISHOMEDIR">nis homedir (G)</term>
4676 <listitem><para>Get the home share server from a NIS map. For
4677 UNIX systems that use an automounter, the user's home directory
4678 will often be mounted on a workstation on demand from a remote
4679 server. </para>
4681 <para>When the Samba logon server is not the actual home directory
4682 server, but is mounting the home directories via NFS then two
4683 network hops would be required to access the users home directory
4684 if the logon server told the client to use itself as the SMB server
4685 for home directories (one over SMB and one over NFS). This can
4686 be very slow.</para>
4688 <para>This option allows Samba to return the home share as
4689 being on a different server to the logon server and as
4690 long as a Samba daemon is running on the home directory server,
4691 it will be mounted on the Samba client directly from the directory
4692 server. When Samba is returning the home share to the client, it
4693 will consult the NIS map specified in <link linkend="HOMEDIRMAP">
4694 <parameter>homedir map</parameter></link> and return the server
4695 listed there.</para>
4697 <para>Note that for this option to work there must be a working
4698 NIS system and the Samba server with this option must also
4699 be a logon server.</para>
4701 <para>Default: <command>nis homedir = no</command></para>
4702 </listitem>
4703 </varlistentry>
4707 <varlistentry>
4708 <term><anchor id="NTACLSUPPORT">nt acl support (G)</term>
4709 <listitem><para>This boolean parameter controls whether
4710 <ulink url="smbd.8.html">smbd(8)</ulink> will attempt to map
4711 UNIX permissions into Windows NT access control lists.</para>
4713 <para>Default: <command>nt acl support = yes</command></para>
4714 </listitem>
4715 </varlistentry>
4719 <varlistentry>
4720 <term><anchor id="NTPIPESUPPORT">nt pipe support (G)</term>
4721 <listitem><para>This boolean parameter controls whether
4722 <ulink url="smbd.8.html">smbd(8)</ulink> will allow Windows NT
4723 clients to connect to the NT SMB specific <constant>IPC$</constant>
4724 pipes. This is a developer debugging option and can be left
4725 alone.</para>
4727 <para>Default: <command>nt pipe support = yes</command></para>
4728 </listitem>
4729 </varlistentry>
4733 <varlistentry>
4734 <term><anchor id="NTSMBSUPPORT">nt smb support (G)</term>
4735 <listitem><para>This boolean parameter controls whether <ulink
4736 url="smbd.8.html">smbd(8)</ulink> will negotiate NT specific SMB
4737 support with Windows NT clients. Although this is a developer
4738 debugging option and should be left alone, benchmarking has discovered
4739 that Windows NT clients give faster performance with this option
4740 set to <constant>no</constant>. This is still being investigated.
4741 If this option is set to <constant>no</constant> then Samba offers
4742 exactly the same SMB calls that versions prior to Samba 2.0 offered.
4743 This information may be of use if any users are having problems
4744 with NT SMB support.</para>
4746 <para>You should not need to ever disable this parameter.</para>
4748 <para>Default: <command>nt smb support = yes</command></para>
4749 </listitem>
4750 </varlistentry>
4754 <varlistentry>
4755 <term><anchor id="NULLPASSWORDS">null passwords (G)</term>
4756 <listitem><para>Allow or disallow client access to accounts
4757 that have null passwords. </para>
4759 <para>See also <ulink url="smbpasswd.5.html">smbpasswd (5)</ulink>.</para>
4761 <para>Default: <command>null passwords = no</command></para>
4762 </listitem>
4763 </varlistentry>
4768 <varlistentry>
4769 <term><anchor id="OBEYPAMRESTRICTIONS">obey pam restrictions (G)</term>
4770 <listitem><para>When Samba 2.2 is configured to enable PAM support
4771 (i.e. --with-pam), this parameter will control whether or not Samba
4772 should obey PAM's account and session management directives. The
4773 default behavior is to use PAM for clear text authentication only
4774 and to ignore any account or session management. Note that Samba
4775 always ignores PAM for authentication in the case of <link
4776 linkend="ENCRYPTPASSWORDS"><parameter>encrypt passwords = yes</parameter>
4777 </link>. The reason is that PAM modules cannot support the challenge/response
4778 authentication mechanism needed in the presence of SMB password encryption.
4779 </para>
4781 <para>Default: <command>obey pam restrictions = no</command></para>
4782 </listitem>
4783 </varlistentry>
4789 <varlistentry>
4790 <term><anchor id="ONLYUSER">only user (S)</term>
4791 <listitem><para>This is a boolean option that controls whether
4792 connections with usernames not in the <parameter>user</parameter>
4793 list will be allowed. By default this option is disabled so that a
4794 client can supply a username to be used by the server. Enabling
4795 this parameter will force the server to only user the login
4796 names from the <parameter>user</parameter> list and is only really
4797 useful in <link linkend="SECURITYEQUALSSHARE">shave level</link>
4798 security.</para>
4800 <para>Note that this also means Samba won't try to deduce
4801 usernames from the service name. This can be annoying for
4802 the [homes] section. To get around this you could use <command>user =
4803 %S</command> which means your <parameter>user</parameter> list
4804 will be just the service name, which for home directories is the
4805 name of the user.</para>
4807 <para>See also the <link linkend="USER"><parameter>user</parameter>
4808 </link> parameter.</para>
4810 <para>Default: <command>only user = no</command></para>
4811 </listitem>
4812 </varlistentry>
4817 <varlistentry>
4818 <term><anchor id="ONLYGUEST">only guest (S)</term>
4819 <listitem><para>A synonym for <link linkend="GUESTONLY"><parameter>
4820 guest only</parameter></link>.</para>
4821 </listitem>
4822 </varlistentry>
4826 <varlistentry>
4827 <term><anchor id="OPLOCKBREAKWAITTIME">oplock break wait time (G)</term>
4828 <listitem><para>This is a tuning parameter added due to bugs in
4829 both Windows 9x and WinNT. If Samba responds to a client too
4830 quickly when that client issues an SMB that can cause an oplock
4831 break request, then the network client can fail and not respond
4832 to the break request. This tuning parameter (which is set in milliseconds)
4833 is the amount of time Samba will wait before sending an oplock break
4834 request to such (broken) clients.</para>
4836 <para><emphasis>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4837 AND UNDERSTOOD THE SAMBA OPLOCK CODE</emphasis>.</para>
4839 <para>Default: <command>oplock break wait time = 0</command></para>
4840 </listitem>
4841 </varlistentry>
4844 <varlistentry>
4845 <term><anchor id="OPLOCKCONTENTIONLIMIT">oplock contention limit (S)</term>
4846 <listitem><para>This is a <emphasis>very</emphasis> advanced
4847 <ulink url="smbd.8.html">smbd(8)</ulink> tuning option to
4848 improve the efficiency of the granting of oplocks under multiple
4849 client contention for the same file.</para>
4851 <para>In brief it specifies a number, which causes <ulink url="smbd.8.html">smbd</ulink> not to
4852 grant an oplock even when requested if the approximate number of
4853 clients contending for an oplock on the same file goes over this
4854 limit. This causes <command>smbd</command> to behave in a similar
4855 way to Windows NT.</para>
4857 <para><emphasis>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4858 AND UNDERSTOOD THE SAMBA OPLOCK CODE</emphasis>.</para>
4860 <para>Default: <command>oplock contention limit = 2</command></para>
4861 </listitem>
4862 </varlistentry>
4868 <varlistentry>
4869 <term><anchor id="OPLOCKS">oplocks (S)</term>
4870 <listitem><para>This boolean option tells <command>smbd</command> whether to
4871 issue oplocks (opportunistic locks) to file open requests on this
4872 share. The oplock code can dramatically (approx. 30% or more) improve
4873 the speed of access to files on Samba servers. It allows the clients
4874 to aggressively cache files locally and you may want to disable this
4875 option for unreliable network environments (it is turned on by
4876 default in Windows NT Servers). For more information see the file
4877 <filename>Speed.txt</filename> in the Samba <filename>docs/</filename>
4878 directory.</para>
4880 <para>Oplocks may be selectively turned off on certain files with a
4881 share. See the <link linkend="VETOOPLOCKFILES"><parameter>
4882 veto oplock files</parameter></link> parameter. On some systems
4883 oplocks are recognized by the underlying operating system. This
4884 allows data synchronization between all access to oplocked files,
4885 whether it be via Samba or NFS or a local UNIX process. See the
4886 <parameter>kernel oplocks</parameter> parameter for details.</para>
4888 <para>See also the <link linkend="KERNELOPLOCKS"><parameter>kernel
4889 oplocks</parameter></link> and <link linkend="LEVEL2OPLOCKS"><parameter>
4890 level2 oplocks</parameter></link> parameters.</para>
4892 <para>Default: <command>oplocks = yes</command></para>
4893 </listitem>
4894 </varlistentry>
4898 <varlistentry>
4899 <term><anchor id="OSLEVEL">os level (G)</term>
4900 <listitem><para>This integer value controls what level Samba
4901 advertises itself as for browse elections. The value of this
4902 parameter determines whether <ulink url="nmbd.8.html">nmbd(8)</ulink>
4903 has a chance of becoming a local master browser for the <parameter>
4904 WORKGROUP</parameter> in the local broadcast area.</para>
4906 <para><emphasis>Note :</emphasis>By default, Samba will win
4907 a local master browsing election over all Microsoft operating
4908 systems except a Windows NT 4.0/2000 Domain Controller. This
4909 means that a misconfigured Samba host can effectively isolate
4910 a subnet for browsing purposes. See <filename>BROWSING.txt
4911 </filename> in the Samba <filename>docs/</filename> directory
4912 for details.</para>
4914 <para>Default: <command>os level = 20</command></para>
4915 <para>Example: <command>os level = 65 </command></para>
4916 </listitem>
4917 </varlistentry>
4921 <varlistentry>
4922 <term><anchor id="OS2DRIVERMAP">os2 driver map (G)</term>
4923 <listitem><para>The parameter is used to define the absolute
4924 path to a file containing a mapping of Windows NT printer driver
4925 names to OS/2 printer driver names. The format is:</para>
4927 <para>&lt;nt driver name&gt; = &lt;os2 driver
4928 name&gt;.&lt;device name&gt;</para>
4930 <para>For example, a valid entry using the HP LaserJet 5
4931 printer driver would appear as <command>HP LaserJet 5L = LASERJET.HP
4932 LaserJet 5L</command>.</para>
4934 <para>The need for the file is due to the printer driver namespace
4935 problem described in the <ulink url="printer_driver2.html">Samba
4936 Printing HOWTO</ulink>. For more details on OS/2 clients, please
4937 refer to the <ulink url="OS2-Client-HOWTO.html">OS2-Client-HOWTO
4938 </ulink> containing in the Samba documentation.</para>
4940 <para>Default: <command>os2 driver map = &lt;empty string&gt;
4941 </command></para>
4942 </listitem>
4943 </varlistentry>
4946 <varlistentry>
4947 <term><anchor id="PAMPASSWORDCHANGE">pam password change (G)</term>
4948 <listitem><para>With the addition of better PAM support in Samba 2.2,
4949 this parameter, it is possible to use PAM's password change control
4950 flag for Samba. If enabled, then PAM will be used for password
4951 changes when requested by an SMB client insted of the program listed in
4952 <link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter></link>.
4953 It should be possible to enable this without changing your
4954 <link linkend="PASSWDCHAT"><parameter>passwd chat</parameter></link>
4955 paramater for most setups.
4956 </para>
4958 <para>Default: <command>pam password change = no</command></para>
4960 </listitem>
4961 </varlistentry>
4964 <varlistentry>
4965 <term><anchor id="PANICACTION">panic action (G)</term>
4966 <listitem><para>This is a Samba developer option that allows a
4967 system command to be called when either <ulink url="smbd.8.html">
4968 smbd(8)</ulink> or <ulink url="nmbd.8.html">nmbd(8)</ulink>
4969 crashes. This is usually used to draw attention to the fact that
4970 a problem occurred.</para>
4972 <para>Default: <command>panic action = &lt;empty string&gt;</command></para>
4973 <para>Example: <command>panic action = "/bin/sleep 90000"</command></para>
4974 </listitem>
4975 </varlistentry>
4978 <varlistentry>
4979 <term><anchor id="PASSWDCHAT">passwd chat (G)</term>
4980 <listitem><para>This string controls the <emphasis>"chat"</emphasis>
4981 conversation that takes places between <ulink
4982 url="smbd.8.html">smbd</ulink> and the local password changing
4983 program to change the user's password. The string describes a
4984 sequence of response-receive pairs that <ulink url="smbd.8.html">
4985 smbd(8)</ulink> uses to determine what to send to the
4986 <link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter>
4987 </link> and what to expect back. If the expected output is not
4988 received then the password is not changed.</para>
4990 <para>This chat sequence is often quite site specific, depending
4991 on what local methods are used for password control (such as NIS
4992 etc).</para>
4994 <para>The string can contain the macros <parameter>%o</parameter>
4995 and <parameter>%n</parameter> which are substituted for the old
4996 and new passwords respectively. It can also contain the standard
4997 macros <constant>\n</constant>, <constant>\r</constant>, <constant>
4998 \t</constant> and <constant>%s</constant> to give line-feed,
4999 carriage-return, tab and space.</para>
5001 <para>The string can also contain a '*' which matches
5002 any sequence of characters.</para>
5004 <para>Double quotes can be used to collect strings with spaces
5005 in them into a single string.</para>
5007 <para>If the send string in any part of the chat sequence
5008 is a full stop ".", then no string is sent. Similarly,
5009 if the expect string is a full stop then no string is expected.</para>
5011 <para>Note that if the <link linkend="UNIXPASSWORDSYNC"><parameter>unix
5012 password sync</parameter></link> parameter is set to <constant>true</constant>, then this
5013 sequence is called <emphasis>AS ROOT</emphasis> when the SMB password
5014 in the smbpasswd file is being changed, without access to the old
5015 password cleartext. In this case the old password cleartext is set
5016 to "" (the empty string).</para>
5018 <para>Also, if the <link linkend="PAMPASSWORDCHANGE"><parameter>pam
5019 password change</parameter></link> parameter is set to true, the chat pairs
5020 may be matched in any order, and sucess is determined by the PAM result,
5021 not any particular output. The \n macro is ignored for PAM conversions.
5022 </para>
5024 <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix password
5025 sync</parameter></link>, <link linkend="PASSWDPROGRAM"><parameter>
5026 passwd program</parameter></link> ,<link linkend="PASSWDCHATDEBUG">
5027 <parameter>passwd chat debug</parameter></link> and <link linkend="PAMPASSWORDCHANGE">
5028 <parameter>pam password change</parameter></link>.</para>
5030 <para>Default: <command>passwd chat = *new*password* %n\n
5031 *new*password* %n\n *changed*</command></para>
5032 <para>Example: <command>passwd chat = "*Enter OLD password*" %o\n
5033 "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password
5034 changed*"</command></para>
5035 </listitem>
5036 </varlistentry>
5040 <varlistentry>
5041 <term><anchor id="PASSWDCHATDEBUG">passwd chat debug (G)</term>
5042 <listitem><para>This boolean specifies if the passwd chat script
5043 parameter is run in <emphasis>debug</emphasis> mode. In this mode the
5044 strings passed to and received from the passwd chat are printed
5045 in the <ulink url="smbd.8.html">smbd(8)</ulink> log with a
5046 <link linkend="DEBUGLEVEL"><parameter>debug level</parameter></link>
5047 of 100. This is a dangerous option as it will allow plaintext passwords
5048 to be seen in the <command>smbd</command> log. It is available to help
5049 Samba admins debug their <parameter>passwd chat</parameter> scripts
5050 when calling the <parameter>passwd program</parameter> and should
5051 be turned off after this has been done. This option has no effect if the
5052 <link linkend="PAMPASSWORDCHANGE"><parameter>pam password change</parameter></link>
5053 paramter is set. This parameter is off by default.</para>
5056 <para>See also <link linkend="PASSWDCHAT"><parameter>passwd chat</parameter>
5057 </link>, <link linkend="PAMPASSWORDCHANGE"><parameter>pam password change</parameter>
5058 </link>, <link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter>
5059 </link>.</para>
5061 <para>Default: <command>passwd chat debug = no</command></para>
5062 </listitem>
5063 </varlistentry>
5067 <varlistentry>
5068 <term><anchor id="PASSWDPROGRAM">passwd program (G)</term>
5069 <listitem><para>The name of a program that can be used to set
5070 UNIX user passwords. Any occurrences of <parameter>%u</parameter>
5071 will be replaced with the user name. The user name is checked for
5072 existence before calling the password changing program.</para>
5074 <para>Also note that many passwd programs insist in <emphasis>reasonable
5075 </emphasis> passwords, such as a minimum length, or the inclusion
5076 of mixed case chars and digits. This can pose a problem as some clients
5077 (such as Windows for Workgroups) uppercase the password before sending
5078 it.</para>
5080 <para><emphasis>Note</emphasis> that if the <parameter>unix
5081 password sync</parameter> parameter is set to <constant>true
5082 </constant> then this program is called <emphasis>AS ROOT</emphasis>
5083 before the SMB password in the <ulink url="smbpasswd.5.html">smbpasswd(5)
5084 </ulink> file is changed. If this UNIX password change fails, then
5085 <command>smbd</command> will fail to change the SMB password also
5086 (this is by design).</para>
5088 <para>If the <parameter>unix password sync</parameter> parameter
5089 is set this parameter <emphasis>MUST USE ABSOLUTE PATHS</emphasis>
5090 for <emphasis>ALL</emphasis> programs called, and must be examined
5091 for security implications. Note that by default <parameter>unix
5092 password sync</parameter> is set to <constant>false</constant>.</para>
5094 <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix
5095 password sync</parameter></link>.</para>
5097 <para>Default: <command>passwd program = /bin/passwd</command></para>
5098 <para>Example: <command>passwd program = /sbin/npasswd %u</command>
5099 </para>
5100 </listitem>
5101 </varlistentry>
5105 <varlistentry>
5106 <term><anchor id="PASSWORDLEVEL">password level (G)</term>
5107 <listitem><para>Some client/server combinations have difficulty
5108 with mixed-case passwords. One offending client is Windows for
5109 Workgroups, which for some reason forces passwords to upper
5110 case when using the LANMAN1 protocol, but leaves them alone when
5111 using COREPLUS! Another problem child is the Windows 95/98
5112 family of operating systems. These clients upper case clear
5113 text passwords even when NT LM 0.12 selected by the protocol
5114 negotiation request/response.</para>
5116 <para>This parameter defines the maximum number of characters
5117 that may be upper case in passwords.</para>
5119 <para>For example, say the password given was "FRED". If <parameter>
5120 password level</parameter> is set to 1, the following combinations
5121 would be tried if "FRED" failed:</para>
5123 <para>"Fred", "fred", "fRed", "frEd","freD"</para>
5125 <para>If <parameter>password level</parameter> was set to 2,
5126 the following combinations would also be tried: </para>
5128 <para>"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..</para>
5130 <para>And so on.</para>
5132 <para>The higher value this parameter is set to the more likely
5133 it is that a mixed case password will be matched against a single
5134 case password. However, you should be aware that use of this
5135 parameter reduces security and increases the time taken to
5136 process a new connection.</para>
5138 <para>A value of zero will cause only two attempts to be
5139 made - the password as is and the password in all-lower case.</para>
5141 <para>Default: <command>password level = 0</command></para>
5142 <para>Example: <command>password level = 4</command</para>
5143 </listitem>
5144 </varlistentry>
5148 <varlistentry>
5149 <term><anchor id="PASSWORDSERVER">password server (G)</term>
5150 <listitem><para>By specifying the name of another SMB server (such
5151 as a WinNT box) with this option, and using <command>security = domain
5152 </command> or <command>security = server</command> you can get Samba
5153 to do all its username/password validation via a remote server.</para>
5155 <para>This option sets the name of the password server to use.
5156 It must be a NetBIOS name, so if the machine's NetBIOS name is
5157 different from its Internet name then you may have to add its NetBIOS
5158 name to the lmhosts file which is stored in the same directory
5159 as the <filename>smb.conf</filename> file.</para>
5161 <para>The name of the password server is looked up using the
5162 parameter <link linkend="NAMERESOLVEORDER"><parameter>name
5163 resolve order</parameter></link> and so may resolved
5164 by any method and order described in that parameter.</para>
5166 <para>The password server much be a machine capable of using
5167 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
5168 user level security mode.</para>
5170 <para><emphasis>NOTE:</emphasis> Using a password server
5171 means your UNIX box (running Samba) is only as secure as your
5172 password server. <emphasis>DO NOT CHOOSE A PASSWORD SERVER THAT
5173 YOU DON'T COMPLETELY TRUST</emphasis>.</para>
5175 <para>Never point a Samba server at itself for password
5176 serving. This will cause a loop and could lock up your Samba
5177 server!</para>
5179 <para>The name of the password server takes the standard
5180 substitutions, but probably the only useful one is <parameter>%m
5181 </parameter>, which means the Samba server will use the incoming
5182 client as the password server. If you use this then you better
5183 trust your clients, and you had better restrict them with hosts allow!</para>
5185 <para>If the <parameter>security</parameter> parameter is set to
5186 <constant>domain</constant>, then the list of machines in this
5187 option must be a list of Primary or Backup Domain controllers for the
5188 Domain or the character '*', as the Samba server is effectively
5189 in that domain, and will use cryptographically authenticated RPC calls
5190 to authenticate the user logging on. The advantage of using <command>
5191 security = domain</command> is that if you list several hosts in the
5192 <parameter>password server</parameter> option then <command>smbd
5193 </command> will try each in turn till it finds one that responds. This
5194 is useful in case your primary server goes down.</para>
5196 <para>If the <parameter>password server</parameter> option is set
5197 to the character '*', then Samba will attempt to auto-locate the
5198 Primary or Backup Domain controllers to authenticate against by
5199 doing a query for the name <constant>WORKGROUP&lt;1C&gt;</constant>
5200 and then contacting each server returned in the list of IP
5201 addresses from the name resolution source. </para>
5203 <para>If the <parameter>security</parameter> parameter is
5204 set to <constant>server</constant>, then there are different
5205 restrictions that <command>security = domain</command> doesn't
5206 suffer from:</para>
5208 <itemizedlist>
5209 <listitem><para>You may list several password servers in
5210 the <parameter>password server</parameter> parameter, however if an
5211 <command>smbd</command> makes a connection to a password server,
5212 and then the password server fails, no more users will be able
5213 to be authenticated from this <command>smbd</command>. This is a
5214 restriction of the SMB/CIFS protocol when in <command>security=server
5215 </command> mode and cannot be fixed in Samba.</para></listitem>
5217 <listitem><para>If you are using a Windows NT server as your
5218 password server then you will have to ensure that your users
5219 are able to login from the Samba server, as when in <command>
5220 security=server</command> mode the network logon will appear to
5221 come from there rather than from the user's workstation.</para></listitem>
5222 </itemizedlist>
5224 <para>See also the <link linkend="SECURITY"><parameter>security
5225 </parameter></link> parameter.</para>
5227 <para>Default: <command>password server = &lt;empty string&gt;</command>
5228 </para>
5229 <para>Example: <command>password server = NT-PDC, NT-BDC1, NT-BDC2
5230 </command></para>
5231 <para>Example: <command>password server = *</command></para>
5232 </listitem>
5233 </varlistentry>
5237 <varlistentry>
5238 <term><anchor id="PATH">path (S)</term>
5239 <listitem><para>This parameter specifies a directory to which
5240 the user of the service is to be given access. In the case of
5241 printable services, this is where print data will spool prior to
5242 being submitted to the host for printing.</para>
5244 <para>For a printable service offering guest access, the service
5245 should be readonly and the path should be world-writeable and
5246 have the sticky bit set. This is not mandatory of course, but
5247 you probably won't get the results you expect if you do
5248 otherwise.</para>
5250 <para>Any occurrences of <parameter>%u</parameter> in the path
5251 will be replaced with the UNIX username that the client is using
5252 on this connection. Any occurrences of <parameter>%m</parameter>
5253 will be replaced by the NetBIOS name of the machine they are
5254 connecting from. These replacements are very useful for setting
5255 up pseudo home directories for users.</para>
5257 <para>Note that this path will be based on <link linkend="ROOTDIR">
5258 <parameter>root dir</parameter></link> if one was specified.</para>
5260 <para>Default: <emphasis>none</emphasis></para>
5261 <para>Example: <command>path = /home/fred</command></para>
5262 </listitem>
5263 </varlistentry>
5268 <varlistentry>
5269 <term><anchor id="POSIXLOCKING">posix locking (S)</term>
5270 <listitem><para>The <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
5271 daemon maintains an database of file locks obtained by SMB clients.
5272 The default behavior is to map this internal database to POSIX
5273 locks. This means that file locks obtained by SMB clients are
5274 consistent with those seen by POSIX compliant applications accessing
5275 the files via a non-SMB method (e.g. NFS or local file access).
5276 You should never need to disable this parameter.</para>
5278 <para>Default: <command>posix locking = yes</command></para>
5279 </listitem>
5280 </varlistentry>
5285 <varlistentry>
5286 <term><anchor id="POSTEXEC">postexec (S)</term>
5287 <listitem><para>This option specifies a command to be run
5288 whenever the service is disconnected. It takes the usual
5289 substitutions. The command may be run as the root on some
5290 systems.</para>
5292 <para>An interesting example may be to unmount server
5293 resources:</para>
5295 <para><command>postexec = /etc/umount /cdrom</command></para>
5297 <para>See also <link linkend="PREEXEC"><parameter>preexec</parameter>
5298 </link>.</para>
5300 <para>Default: <emphasis>none (no command executed)</emphasis>
5301 </para>
5303 <para>Example: <command>postexec = echo \"%u disconnected from %S
5304 from %m (%I)\" &gt;&gt; /tmp/log</command></para>
5305 </listitem>
5306 </varlistentry>
5310 <varlistentry>
5311 <term><anchor id="POSTSCRIPT">postscript (S)</term>
5312 <listitem><para>This parameter forces a printer to interpret
5313 the print files as PostScript. This is done by adding a <constant>%!
5314 </constant> to the start of print output.</para>
5316 <para>This is most useful when you have lots of PCs that persist
5317 in putting a control-D at the start of print jobs, which then
5318 confuses your printer.</para>
5320 <para>Default: <command>postscript = no</command></para>
5321 </listitem>
5322 </varlistentry>
5326 <varlistentry>
5327 <term><anchor id="PREEXEC">preexec (S)</term>
5328 <listitem><para>This option specifies a command to be run whenever
5329 the service is connected to. It takes the usual substitutions.</para>
5331 <para>An interesting example is to send the users a welcome
5332 message every time they log in. Maybe a message of the day? Here
5333 is an example:</para>
5335 <para><command>preexec = csh -c 'echo \"Welcome to %S!\" |
5336 /usr/local/samba/bin/smbclient -M %m -I %I' & </command></para>
5338 <para>Of course, this could get annoying after a while :-)</para>
5340 <para>See also <link linkend="PREEXECCLOSE"><parameter>preexec close
5341 </parameter</link> and <link linkend="POSTEXEC"><parameter>postexec
5342 </parameter></link>.</para>
5344 <para>Default: <emphasis>none (no command executed)</emphasis></para>
5345 <para>Example: <command>preexec = echo \"%u connected to %S from %m
5346 (%I)\" &gt;&gt; /tmp/log</command></para>
5347 </listitem>
5348 </varlistentry>
5352 <varlistentry>
5353 <term><anchor id="PREEXECCLOSE">preexec close (S)</term>
5354 <listitem><para>This boolean option controls whether a non-zero
5355 return code from <link linkend="PREEXEC"><parameter>preexec
5356 </parameter></link> should close the service being connected to.</para>
5358 <para>Default: <command>preexec close = no</command></para>
5359 </listitem>
5360 </varlistentry>
5363 <varlistentry>
5364 <term><anchor id="PREFERREDMASTER">preferred master (G)</term>
5365 <listitem><para>This boolean parameter controls if <ulink
5366 url="nmbd.8.html">nmbd(8)</ulink> is a preferred master browser
5367 for its workgroup.</para>
5369 <para>If this is set to <constant>true</constant>, on startup, <command>nmbd</command>
5370 will force an election, and it will have a slight advantage in
5371 winning the election. It is recommended that this parameter is
5372 used in conjunction with <command><link linkend="DOMAINMASTER"><parameter>
5373 domain master</parameter></link> = yes</command>, so that <command>
5374 nmbd</command> can guarantee becoming a domain master.</para>
5376 <para>Use this option with caution, because if there are several
5377 hosts (whether Samba servers, Windows 95 or NT) that are preferred
5378 master browsers on the same subnet, they will each periodically
5379 and continuously attempt to become the local master browser.
5380 This will result in unnecessary broadcast traffic and reduced browsing
5381 capabilities.</para>
5383 <para>See also <link linkend="OSLEVEL"><parameter>os level</parameter>
5384 </link>.</para>
5386 <para>Default: <command>preferred master = auto</command></para>
5387 </listitem>
5388 </varlistentry>
5392 <varlistentry>
5393 <term><anchor id="PREFEREDMASTER">prefered master (G)</term>
5394 <listitem><para>Synonym for <link linkend="PREFERREDMASTER"><parameter>
5395 preferred master</parameter></link> for people who cannot spell :-).</para>
5396 </listitem>
5397 </varlistentry>
5401 <varlistentry>
5402 <term><anchor id="PRELOAD">preload</term>
5403 <listitem><para>This is a list of services that you want to be
5404 automatically added to the browse lists. This is most useful
5405 for homes and printers services that would otherwise not be
5406 visible.</para>
5408 <para>Note that if you just want all printers in your
5409 printcap file loaded then the <link linkend="LOADPRINTERS">
5410 <parameter>load printers</parameter></link> option is easier.</para>
5412 <para>Default: <emphasis>no preloaded services</emphasis></para>
5414 <para>Example: <command>preload = fred lp colorlp</command></para>
5415 </listitem>
5416 </varlistentry>
5419 <varlistentry>
5420 <term><anchor id="PRESERVECASE">preserve case (S)</term>
5421 <listitem><para> This controls if new filenames are created
5422 with the case that the client passes, or if they are forced to
5423 be the <link linkend="DEFAULTCASE"><parameter>default case
5424 </parameter></link>.</para>
5426 <para>Default: <command>preserve case = yes</command></para>
5428 <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME
5429 MANGLING</link> for a fuller discussion.</para>
5430 </listitem>
5431 </varlistentry>
5435 <varlistentry>
5436 <term><anchor id="PRINTCOMMAND">print command (S)</term>
5437 <listitem><para>After a print job has finished spooling to
5438 a service, this command will be used via a <command>system()</command>
5439 call to process the spool file. Typically the command specified will
5440 submit the spool file to the host's printing subsystem, but there
5441 is no requirement that this be the case. The server will not remove
5442 the spool file, so whatever command you specify should remove the
5443 spool file when it has been processed, otherwise you will need to
5444 manually remove old spool files.</para>
5446 <para>The print command is simply a text string. It will be used
5447 verbatim, with two exceptions: All occurrences of <parameter>%s
5448 </parameter> and <parameter>%f</parameter> will be replaced by the
5449 appropriate spool file name, and all occurrences of <parameter>%p
5450 </parameter> will be replaced by the appropriate printer name. The
5451 spool file name is generated automatically by the server, the printer
5452 name is discussed below.</para>
5454 <para>The print command <emphasis>MUST</emphasis> contain at least
5455 one occurrence of <parameter>%s</parameter> or <parameter>%f
5456 </parameter> - the <parameter>%p</parameter> is optional. At the time
5457 a job is submitted, if no printer name is supplied the <parameter>%p
5458 </parameter> will be silently removed from the printer command.</para>
5460 <para>If specified in the [global] section, the print command given
5461 will be used for any printable service that does not have its own
5462 print command specified.</para>
5464 <para>If there is neither a specified print command for a
5465 printable service nor a global print command, spool files will
5466 be created but not processed and (most importantly) not removed.</para>
5468 <para>Note that printing may fail on some UNIXes from the
5469 <constant>nobody</constant> account. If this happens then create
5470 an alternative guest account that can print and set the <link
5471 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>
5472 in the [global] section.</para>
5474 <para>You can form quite complex print commands by realizing
5475 that they are just passed to a shell. For example the following
5476 will log a print job, print the file, then remove it. Note that
5477 ';' is the usual separator for command in shell scripts.</para>
5479 <para><command>print command = echo Printing %s &gt;&gt;
5480 /tmp/print.log; lpr -P %p %s; rm %s</command></para>
5482 <para>You may have to vary this command considerably depending
5483 on how you normally print files on your system. The default for
5484 the parameter varies depending on the setting of the <link linkend="PRINTING">
5485 <parameter>printing</parameter></link> parameter.</para>
5487 <para>Default: For <command>printing= BSD, AIX, QNX, LPRNG
5488 or PLP :</command></para>
5489 <para><command>print command = lpr -r -P%p %s</command></para>
5491 <para>For <command>printing= SYS or HPUX :</command></para>
5492 <para><command>print command = lp -c -d%p %s; rm %s</command></para>
5494 <para>For <command>printing=SOFTQ :</command></para>
5495 <para><command>print command = lp -d%p -s %s; rm %s</command></para>
5497 <para>Example: <command>print command = /usr/local/samba/bin/myprintscript
5498 %p %s</command></para>
5499 </listitem>
5500 </varlistentry>
5504 <varlistentry>
5505 <term><anchor id="PRINTOK">print ok (S)</term>
5506 <listitem><para>Synonym for <link linkend="PRINTABLE">
5507 <parameter>printable</parameter></link>.</para>
5508 </listitem>
5509 </varlistentry>
5514 <varlistentry>
5515 <term><anchor id="PRINTABLE">printable (S)</term>
5516 <listitem><para>If this parameter is <constant>yes</constant>, then
5517 clients may open, write to and submit spool files on the directory
5518 specified for the service. </para>
5520 <para>Note that a printable service will ALWAYS allow writing
5521 to the service path (user privileges permitting) via the spooling
5522 of print data. The <link linkend="WRITEABLE"><parameter>writeable
5523 </parameter></link> parameter controls only non-printing access to
5524 the resource.</para>
5526 <para>Default: <command>printable = no</command></para>
5527 </listitem>
5528 </varlistentry>
5532 <varlistentry>
5533 <term><anchor id="PRINTCAP">printcap (G)</term>
5534 <listitem><para>Synonym for <link linkend="PRINTCAPNAME"><parameter>
5535 printcap name</parameter></link>.</para>
5536 </listitem>
5537 </varlistentry>
5542 <varlistentry>
5543 <term><anchor id="PRINTCAPNAME">printcap name (G)</term>
5544 <listitem><para>This parameter may be used to override the
5545 compiled-in default printcap name used by the server (usually <filename>
5546 /etc/printcap</filename>). See the discussion of the <link
5547 linkend="PRINTERSSECT">[printers]</link> section above for reasons
5548 why you might want to do this.</para>
5550 <para>On System V systems that use <command>lpstat</command> to
5551 list available printers you can use <command>printcap name = lpstat
5552 </command> to automatically obtain lists of available printers. This
5553 is the default for systems that define SYSV at configure time in
5554 Samba (this includes most System V based systems). If <parameter>
5555 printcap name</parameter> is set to <command>lpstat</command> on
5556 these systems then Samba will launch <command>lpstat -v</command> and
5557 attempt to parse the output to obtain a printer list.</para>
5559 <para>A minimal printcap file would look something like this:</para>
5561 <para><programlisting>
5562 print1|My Printer 1
5563 print2|My Printer 2
5564 print3|My Printer 3
5565 print4|My Printer 4
5566 print5|My Printer 5
5567 </programlisting></para>
5569 <para>where the '|' separates aliases of a printer. The fact
5570 that the second alias has a space in it gives a hint to Samba
5571 that it's a comment.</para>
5573 <para><emphasis>NOTE</emphasis>: Under AIX the default printcap
5574 name is <filename>/etc/qconfig</filename>. Samba will assume the
5575 file is in AIX <filename>qconfig</filename> format if the string
5576 <filename>qconfig</filename> appears in the printcap filename.</para>
5578 <para>Default: <command>printcap name = /etc/printcap</command></para>
5579 <para>Example: <command>printcap name = /etc/myprintcap</command></para>
5580 </listitem>
5581 </varlistentry>
5587 <varlistentry>
5588 <term><anchor id="PRINTERADMIN">printer admin (S)</term>
5589 <listitem><para>This is a list of users that can do anything to
5590 printers via the remote administration interfaces offered by MS-RPC
5591 (usually using a NT workstation). Note that the root user always
5592 has admin rights.</para>
5594 <para>Default: <command>printer admin = &lt;empty string&gt;</command>
5595 </para>
5596 <para>Example: <command>printer admin = admin, @staff</command></para>
5597 </listitem>
5598 </varlistentry>
5604 <varlistentry>
5605 <term><anchor id="PRINTERDRIVER">printer driver (S)</term>
5606 <listitem><para><emphasis>Note :</emphasis>This is a deprecated
5607 parameter and will be removed in the next major release
5608 following version 2.2. Please see the instructions in
5609 the <ulink url="printer_driver2.html">Samba 2.2. Printing
5610 HOWTO</ulink> for more information
5611 on the new method of loading printer drivers onto a Samba server.
5612 </para>
5614 <para>This option allows you to control the string
5615 that clients receive when they ask the server for the printer driver
5616 associated with a printer. If you are using Windows95 or Windows NT
5617 then you can use this to automate the setup of printers on your
5618 system.</para>
5620 <para>You need to set this parameter to the exact string (case
5621 sensitive) that describes the appropriate printer driver for your
5622 system. If you don't know the exact string to use then you should
5623 first try with no <link linkend="PRINTERDRIVER"><parameter>
5624 printer driver</parameter></link> option set and the client will
5625 give you a list of printer drivers. The appropriate strings are
5626 shown in a scroll box after you have chosen the printer manufacturer.</para>
5628 <para>See also <link linkend="PRINTERDRIVERFILE"><parameter>printer
5629 driver file</parameter></link>.</para>
5631 <para>Example: <command>printer driver = HP LaserJet 4L</command></para>
5632 </listitem>
5633 </varlistentry>
5637 <varlistentry>
5638 <term><anchor id="PRINTERDRIVERFILE">printer driver file (G)</term>
5639 <listitem><para><emphasis>Note :</emphasis>This is a deprecated
5640 parameter and will be removed in the next major release
5641 following version 2.2. Please see the instructions in
5642 the <ulink url="printer_driver2.html">Samba 2.2. Printing
5643 HOWTO</ulink> for more information
5644 on the new method of loading printer drivers onto a Samba server.
5645 </para>
5647 <para>This parameter tells Samba where the printer driver
5648 definition file, used when serving drivers to Windows 95 clients, is
5649 to be found. If this is not set, the default is :</para>
5651 <para><filename><replaceable>SAMBA_INSTALL_DIRECTORY</replaceable>
5652 /lib/printers.def</filename></para>
5654 <para>This file is created from Windows 95 <filename>msprint.inf
5655 </filename> files found on the Windows 95 client system. For more
5656 details on setting up serving of printer drivers to Windows 95
5657 clients, see the outdated documentation file in the <filename>docs/</filename>
5658 directory, <filename>PRINTER_DRIVER.txt</filename>.</para>
5660 <para>See also <link linkend="PRINTERDRIVERLOCATION"><parameter>
5661 printer driver location</parameter></link>.</para>
5663 <para>Default: <emphasis>None (set in compile).</emphasis></para>
5665 <para>Example: <command>printer driver file =
5666 /usr/local/samba/printers/drivers.def</command></para>
5667 </listitem>
5668 </varlistentry>
5673 <varlistentry>
5674 <term><anchor id="PRINTERDRIVERLOCATION">printer driver location (S)</term>
5675 <listitem><para><emphasis>Note :</emphasis>This is a deprecated
5676 parameter and will be removed in the next major release
5677 following version 2.2. Please see the instructions in
5678 the <ulink url="printer_driver2.html">Samba 2.2. Printing
5679 HOWTO</ulink> for more information
5680 on the new method of loading printer drivers onto a Samba server.
5681 </para>
5683 <para>This parameter tells clients of a particular printer
5684 share where to find the printer driver files for the automatic
5685 installation of drivers for Windows 95 machines. If Samba is set up
5686 to serve printer drivers to Windows 95 machines, this should be set to</para>
5688 <para><command>\\MACHINE\PRINTER$</command></para>
5690 <para>Where MACHINE is the NetBIOS name of your Samba server,
5691 and PRINTER$ is a share you set up for serving printer driver
5692 files. For more details on setting this up see the outdated documentation
5693 file in the <filename>docs/</filename> directory, <filename>
5694 PRINTER_DRIVER.txt</filename>.</para>
5696 <para>See also <link linkend="PRINTERDRIVERFILE"><parameter>
5697 printer driver file</parameter></link>.</para>
5699 <para>Default: <command>none</command></para>
5700 <para>Example: <command>printer driver location = \\MACHINE\PRINTER$
5701 </command></para>
5702 </listitem>
5703 </varlistentry>
5707 <varlistentry>
5708 <term><anchor id="PRINTERNAME">printer name (S)</term>
5709 <listitem><para>This parameter specifies the name of the printer
5710 to which print jobs spooled through a printable service will be sent.</para>
5712 <para>If specified in the [global] section, the printer
5713 name given will be used for any printable service that does
5714 not have its own printer name specified.</para>
5716 <para>Default: <emphasis>none (but may be <constant>lp</constant>
5717 on many systems)</emphasis></para>
5719 <para>Example: <command>printer name = laserwriter</command></para>
5720 </listitem>
5721 </varlistentry>
5724 <varlistentry>
5725 <term><anchor id="PRINTER">printer (S)</term>
5726 <listitem><para>Synonym for <link linkend="PRINTERNAME"><parameter>
5727 printer name</parameter></link>.</para>
5728 </listitem>
5729 </varlistentry>
5733 <varlistentry>
5734 <term><anchor id="PRINTING">printing (S)</term>
5735 <listitem><para>This parameters controls how printer status
5736 information is interpreted on your system. It also affects the
5737 default values for the <parameter>print command</parameter>,
5738 <parameter>lpq command</parameter>, <parameter>lppause command
5739 </parameter>, <parameter>lpresume command</parameter>, and
5740 <parameter>lprm command</parameter> if specified in the
5741 [global] section.</para>
5743 <para>Currently eight printing styles are supported. They are
5744 <constant>BSD</constant>, <constant>AIX</constant>,
5745 <constant>LPRNG</constant>, <constant>PLP</constant>,
5746 <constant>SYSV</constant>, <constant>HPUX</constant>,
5747 <constant>QNX</constant>, <constant>SOFTQ</constant>,
5748 and <constant>CUPS</constant>.</para>
5750 <para>To see what the defaults are for the other print
5751 commands when using the various options use the <ulink
5752 url="testparm.1.html">testparm(1)</ulink> program.</para>
5754 <para>This option can be set on a per printer basis</para>
5756 <para>See also the discussion in the <link linkend="PRINTERSSECT">
5757 [printers]</link> section.</para>
5758 </listitem>
5759 </varlistentry>
5764 <varlistentry>
5765 <term><anchor id="PROTOCOL">protocol (G)</term>
5766 <listitem><para>Synonym for <link linkend="MAXPROTOCOL">
5767 <parameter>max protocol</parameter></link>.</para></listitem>
5768 </varlistentry>
5773 <varlistentry>
5774 <term><anchor id="PUBLIC">public (S)</term>
5775 <listitem><para>Synonym for <link linkend="GUESTOK"><parameter>guest
5776 ok</parameter></link>.</para>
5777 </listitem>
5778 </varlistentry>
5782 <varlistentry>
5783 <term><anchor id="QUEUEPAUSECOMMAND">queuepause command (S)</term>
5784 <listitem><para>This parameter specifies the command to be
5785 executed on the server host in order to pause the printer queue.</para>
5787 <para>This command should be a program or script which takes
5788 a printer name as its only parameter and stops the printer queue,
5789 such that no longer jobs are submitted to the printer.</para>
5791 <para>This command is not supported by Windows for Workgroups,
5792 but can be issued from the Printers window under Windows 95
5793 and NT.</para>
5795 <para>If a <parameter>%p</parameter> is given then the printer name
5796 is put in its place. Otherwise it is placed at the end of the command.
5797 </para>
5799 <para>Note that it is good practice to include the absolute
5800 path in the command as the PATH may not be available to the
5801 server.</para>
5803 <para>Default: <emphasis>depends on the setting of <parameter>printing
5804 </parameter></emphasis></para>
5805 <para>Example: <command>queuepause command = disable %p</command></para>
5806 </listitem>
5807 </varlistentry>
5811 <varlistentry>
5812 <term><anchor id="QUEUERESUMECOMMAND">queueresume command (S)</term>
5813 <listitem><para>This parameter specifies the command to be
5814 executed on the server host in order to resume the printer queue. It
5815 is the command to undo the behavior that is caused by the
5816 previous parameter (<link linkend="QUEUEPAUSECOMMAND"><parameter>
5817 queuepause command</parameter></link>).</para>
5819 <para>This command should be a program or script which takes
5820 a printer name as its only parameter and resumes the printer queue,
5821 such that queued jobs are resubmitted to the printer.</para>
5823 <para>This command is not supported by Windows for Workgroups,
5824 but can be issued from the Printers window under Windows 95
5825 and NT.</para>
5827 <para>If a <parameter>%p</parameter> is given then the printer name
5828 is put in its place. Otherwise it is placed at the end of the
5829 command.</para>
5831 <para>Note that it is good practice to include the absolute
5832 path in the command as the PATH may not be available to the
5833 server.</para>
5835 <para>Default: <emphasis>depends on the setting of <link
5836 linkend="PRINTING"><parameter>printing</parameter></link></emphasis>
5837 </para>
5839 <para>Example: <command>queuepause command = enable %p
5840 </command></para>
5841 </listitem>
5842 </varlistentry>
5846 <varlistentry>
5847 <term><anchor id="READBMPX">read bmpx (G)</term>
5848 <listitem><para>This boolean parameter controls whether <ulink
5849 url="smbd.8.html">smbd(8)</ulink> will support the "Read
5850 Block Multiplex" SMB. This is now rarely used and defaults to
5851 <constant>no</constant>. You should never need to set this
5852 parameter.</para>
5854 <para>Default: <command>read bmpx = no</command></para>
5855 </listitem>
5856 </varlistentry>
5861 <varlistentry>
5862 <term><anchor id="READLIST">read list (S)</term>
5863 <listitem><para>This is a list of users that are given read-only
5864 access to a service. If the connecting user is in this list then
5865 they will not be given write access, no matter what the <link
5866 linkend="WRITEABLE"><parameter>writeable</parameter></link>
5867 option is set to. The list can include group names using the
5868 syntax described in the <link linkend="INVALIDUSERS"><parameter>
5869 invalid users</parameter></link> parameter.</para>
5871 <para>See also the <link linkend="WRITELIST"><parameter>
5872 write list</parameter></link> parameter and the <link
5873 linkend="INVALIDUSERS"><parameter>invalid users</parameter>
5874 </link> parameter.</para>
5876 <para>Default: <command>read list = &lt;empty string&gt;</command></para>
5877 <para>Example: <command>read list = mary, @students</command></para>
5878 </listitem>
5879 </varlistentry>
5883 <varlistentry>
5884 <term><anchor id="READONLY">read only (S)</term>
5885 <listitem><para>Note that this is an inverted synonym for <link
5886 linkend="WRITEABLE"><parameter>writeable</parameter></link>.</para>
5887 </listitem>
5888 </varlistentry>
5892 <varlistentry>
5893 <term><anchor id="READRAW">read raw (G)</term>
5894 <listitem><para>This parameter controls whether or not the server
5895 will support the raw read SMB requests when transferring data
5896 to clients.</para>
5898 <para>If enabled, raw reads allow reads of 65535 bytes in
5899 one packet. This typically provides a major performance benefit.
5900 </para>
5902 <para>However, some clients either negotiate the allowable
5903 block size incorrectly or are incapable of supporting larger block
5904 sizes, and for these clients you may need to disable raw reads.</para>
5906 <para>In general this parameter should be viewed as a system tuning
5907 tool and left severely alone. See also <link linkend="WRITERAW">
5908 <parameter>write raw</parameter></link>.</para>
5910 <para>Default: <command>read raw = yes</command></para>
5911 </listitem>
5912 </varlistentry>
5915 <varlistentry>
5916 <term><anchor id="READSIZE">read size (G)</term>
5917 <listitem><para>The option <parameter>read size</parameter>
5918 affects the overlap of disk reads/writes with network reads/writes.
5919 If the amount of data being transferred in several of the SMB
5920 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
5921 than this value then the server begins writing the data before it
5922 has received the whole packet from the network, or in the case of
5923 SMBreadbraw, it begins writing to the network before all the data
5924 has been read from disk.</para>
5926 <para>This overlapping works best when the speeds of disk and
5927 network access are similar, having very little effect when the
5928 speed of one is much greater than the other.</para>
5930 <para>The default value is 16384, but very little experimentation
5931 has been done yet to determine the optimal value, and it is likely
5932 that the best value will vary greatly between systems anyway.
5933 A value over 65536 is pointless and will cause you to allocate
5934 memory unnecessarily.</para>
5936 <para>Default: <command>read size = 16384</command></para>
5937 <para>Example: <command>read size = 8192</command></para>
5938 </listitem>
5939 </varlistentry>
5943 <varlistentry>
5944 <term><anchor id="REMOTEANNOUNCE">remote announce (G)</term>
5945 <listitem><para>This option allows you to setup <ulink
5946 url="nmbd.8.html">nmbd(8)</ulink> to periodically announce itself
5947 to arbitrary IP addresses with an arbitrary workgroup name.</para>
5949 <para>This is useful if you want your Samba server to appear
5950 in a remote workgroup for which the normal browse propagation
5951 rules don't work. The remote workgroup can be anywhere that you
5952 can send IP packets to.</para>
5954 <para>For example:</para>
5956 <para><command>remote announce = 192.168.2.255/SERVERS
5957 192.168.4.255/STAFF</command></para>
5959 <para>the above line would cause <command>nmbd</command> to announce itself
5960 to the two given IP addresses using the given workgroup names.
5961 If you leave out the workgroup name then the one given in
5962 the <link linkend="WORKGROUP"><parameter>workgroup</parameter></link>
5963 parameter is used instead.</para>
5965 <para>The IP addresses you choose would normally be the broadcast
5966 addresses of the remote networks, but can also be the IP addresses
5967 of known browse masters if your network config is that stable.</para>
5969 <para>See the documentation file <filename>BROWSING.txt</filename>
5970 in the <filename>docs/</filename> directory.</para>
5972 <para>Default: <command>remote announce = &lt;empty string&gt;
5973 </command></para>
5974 </listitem>
5975 </varlistentry>
5979 <varlistentry>
5980 <term><anchor id="REMOTEBROWSESYNC">remote browse sync (G)</term>
5981 <listitem><para>This option allows you to setup <ulink
5982 url="nmbd.8.html">nmbd(8)</ulink> to periodically request
5983 synchronization of browse lists with the master browser of a Samba
5984 server that is on a remote segment. This option will allow you to
5985 gain browse lists for multiple workgroups across routed networks. This
5986 is done in a manner that does not work with any non-Samba servers.</para>
5988 <para>This is useful if you want your Samba server and all local
5989 clients to appear in a remote workgroup for which the normal browse
5990 propagation rules don't work. The remote workgroup can be anywhere
5991 that you can send IP packets to.</para>
5993 <para>For example:</para>
5995 <para><command>remote browse sync = 192.168.2.255 192.168.4.255
5996 </command></para>
5998 <para>the above line would cause <command>nmbd</command> to request
5999 the master browser on the specified subnets or addresses to
6000 synchronize their browse lists with the local server.</para>
6002 <para>The IP addresses you choose would normally be the broadcast
6003 addresses of the remote networks, but can also be the IP addresses
6004 of known browse masters if your network config is that stable. If
6005 a machine IP address is given Samba makes NO attempt to validate
6006 that the remote machine is available, is listening, nor that it
6007 is in fact the browse master on its segment.</para>
6009 <para>Default: <command>remote browse sync = &lt;empty string&gt;
6010 </command></para>
6011 </listitem>
6012 </varlistentry>
6016 <varlistentry>
6017 <term><anchor id="RESTRICTACLWITHMASK">restrict acl with mask (S)</term>
6018 <listitem><para>This is a boolean parameter. If set to <constant>false</constant> (default), then
6019 creation of files with access control lists (ACLS) and modification of ACLs
6020 using the Windows NT/2000 ACL editor will be applied directly to the file
6021 or directory.</para>
6023 <para>If set to <constant>true</constant>, then all requests to set an ACL on a file will have the
6024 parameters <link linkend="CREATEMASK"><parameter>create mask</parameter></link>,
6025 <link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>
6026 applied before setting the ACL, and all requests to set an ACL on a directory will
6027 have the parameters <link linkend="DIRECTORYMASK"><parameter>directory
6028 mask</parameter></link>, <link linkend="FORCEDIRECTORYMODE"><parameter>force
6029 directory mode</parameter></link> applied before setting the ACL.
6030 </para>
6032 <para>See also <link linkend="CREATEMASK"><parameter>create mask</parameter></link>,
6033 <link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>,
6034 <link linkend="DIRECTORYMASK"><parameter>directory mask</parameter></link>,
6035 <link linkend="FORCEDIRECTORYMODE"><parameter>force directory mode</parameter></link>
6036 </para>
6038 <para>Default: <command>restrict acl with mask = no</command></para>
6039 </listitem>
6040 </varlistentry>
6045 <varlistentry>
6046 <term><anchor id="RESTRICTANONYMOUS">restrict anonymous (G)</term>
6047 <listitem><para>This is a boolean parameter. If it is <constant>true</constant>, then
6048 anonymous access to the server will be restricted, namely in the
6049 case where the server is expecting the client to send a username,
6050 but it doesn't. Setting it to <constant>true</constant> will force these anonymous
6051 connections to be denied, and the client will be required to always
6052 supply a username and password when connecting. Use of this parameter
6053 is only recommended for homogeneous NT client environments.</para>
6055 <para>This parameter makes the use of macro expansions that rely
6056 on the username (%U, %G, etc) consistent. NT 4.0
6057 likes to use anonymous connections when refreshing the share list,
6058 and this is a way to work around that.</para>
6060 <para>When restrict anonymous is <constant>true</constant>, all anonymous connections
6061 are denied no matter what they are for. This can effect the ability
6062 of a machine to access the Samba Primary Domain Controller to revalidate
6063 its machine account after someone else has logged on the client
6064 interactively. The NT client will display a message saying that
6065 the machine's account in the domain doesn't exist or the password is
6066 bad. The best way to deal with this is to reboot NT client machines
6067 between interactive logons, using "Shutdown and Restart", rather
6068 than "Close all programs and logon as a different user".</para>
6070 <para>Default: <command>restrict anonymous = no</command></para>
6071 </listitem>
6072 </varlistentry>
6076 <varlistentry>
6077 <term><anchor id="ROOT">root (G)</term>
6078 <listitem><para>Synonym for <link linkend="ROOTDIRECTORY">
6079 <parameter>root directory"</parameter></link>.</para>
6080 </listitem>
6081 </varlistentry>
6085 <varlistentry>
6086 <term><anchor id="ROOTDIR">root dir (G)</term>
6087 <listitem><para>Synonym for <link linkend="ROOTDIRECTORY">
6088 <parameter>root directory"</parameter></link>.</para>
6089 </listitem>
6090 </varlistentry>
6093 <varlistentry>
6094 <term><anchor id="ROOTDIRECTORY">root directory (G)</term>
6095 <listitem><para>The server will <command>chroot()</command> (i.e.
6096 Change its root directory) to this directory on startup. This is
6097 not strictly necessary for secure operation. Even without it the
6098 server will deny access to files not in one of the service entries.
6099 It may also check for, and deny access to, soft links to other
6100 parts of the filesystem, or attempts to use ".." in file names
6101 to access other directories (depending on the setting of the <link
6102 linkend="WIDELINKS"><parameter>wide links</parameter></link>
6103 parameter).</para>
6105 <para>Adding a <parameter>root directory</parameter> entry other
6106 than "/" adds an extra level of security, but at a price. It
6107 absolutely ensures that no access is given to files not in the
6108 sub-tree specified in the <parameter>root directory</parameter>
6109 option, <emphasis>including</emphasis> some files needed for
6110 complete operation of the server. To maintain full operability
6111 of the server you will need to mirror some system files
6112 into the <parameter>root directory</parameter> tree. In particular
6113 you will need to mirror <filename>/etc/passwd</filename> (or a
6114 subset of it), and any binaries or configuration files needed for
6115 printing (if required). The set of files that must be mirrored is
6116 operating system dependent.</para>
6118 <para>Default: <command>root directory = /</command></para>
6119 <para>Example: <command>root directory = /homes/smb</command></para>
6120 </listitem>
6121 </varlistentry>
6125 <varlistentry>
6126 <term><anchor id="ROOTPOSTEXEC">root postexec (S)</term>
6127 <listitem><para>This is the same as the <parameter>postexec</parameter>
6128 parameter except that the command is run as root. This
6129 is useful for unmounting filesystems
6130 (such as CDROMs) after a connection is closed.</para>
6132 <para>See also <link linkend="POSTEXEC"><parameter>
6133 postexec</parameter></link>.</para>
6135 <para>Default: <command>root postexec = &lt;empty string&gt;
6136 </command></para>
6137 </listitem>
6138 </varlistentry>
6140 <varlistentry>
6141 <term><anchor id="ROOTPREEXEC">root preexec (S)</term>
6142 <listitem><para>This is the same as the <parameter>preexec</parameter>
6143 parameter except that the command is run as root. This
6144 is useful for mounting filesystems (such as CDROMs) when a
6145 connection is opened.</para>
6147 <para>See also <link linkend="PREEXEC"><parameter>
6148 preexec</parameter></link> and <link linkend="PREEXECCLOSE">
6149 <parameter>preexec close</parameter></link>.</para>
6151 <para>Default: <command>root preexec = &lt;empty string&gt;
6152 </command></para>
6153 </listitem>
6154 </varlistentry>
6158 <varlistentry>
6159 <term><anchor id="ROOTPREEXECCLOSE">root preexec close (S)</term>
6160 <listitem><para>This is the same as the <parameter>preexec close
6161 </parameter> parameter except that the command is run as root.</para>
6163 <para>See also <link linkend="PREEXEC"><parameter>
6164 preexec</parameter></link> and <link linkend="PREEXECCLOSE">
6165 <parameter>preexec close</parameter></link>.</para>
6167 <para>Default: <command>root preexec close = no</command></para>
6168 </listitem>
6169 </varlistentry>
6172 <varlistentry>
6173 <term><anchor id="SECURITY">security (G)</term>
6174 <listitem><para>This option affects how clients respond to
6175 Samba and is one of the most important settings in the <filename>
6176 smb.conf</filename> file.</para>
6178 <para>The option sets the "security mode bit" in replies to
6179 protocol negotiations with <ulink url="smbd.8.html">smbd(8)
6180 </ulink> to turn share level security on or off. Clients decide
6181 based on this bit whether (and how) to transfer user and password
6182 information to the server.</para>
6185 <para>The default is <command>security = user</command>, as this is
6186 the most common setting needed when talking to Windows 98 and
6187 Windows NT.</para>
6189 <para>The alternatives are <command>security = share</command>,
6190 <command>security = server</command> or <command>security=domain
6191 </command>.</para>
6193 <para>In versions of Samba prior to 2..0, the default was
6194 <command>security = share</command> mainly because that was
6195 the only option at one stage.</para>
6197 <para>There is a bug in WfWg that has relevance to this
6198 setting. When in user or server level security a WfWg client
6199 will totally ignore the password you type in the "connect
6200 drive" dialog box. This makes it very difficult (if not impossible)
6201 to connect to a Samba service as anyone except the user that
6202 you are logged into WfWg as.</para>
6204 <para>If your PCs use usernames that are the same as their
6205 usernames on the UNIX machine then you will want to use
6206 <command>security = user</command>. If you mostly use usernames
6207 that don't exist on the UNIX box then use <command>security =
6208 share</command>.</para>
6210 <para>You should also use <command>security = share</command> if you
6211 want to mainly setup shares without a password (guest shares). This
6212 is commonly used for a shared printer server. It is more difficult
6213 to setup guest shares with <command>security = user</command>, see
6214 the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6215 </link>parameter for details.</para>
6217 <para>It is possible to use <command>smbd</command> in a <emphasis>
6218 hybrid mode</emphasis> where it is offers both user and share
6219 level security under different <link linkend="NETBIOSALIASES">
6220 <parameter>NetBIOS aliases</parameter></link>. </para>
6222 <para>The different settings will now be explained.</para>
6225 <para><anchor id="SECURITYEQUALSSHARE"><emphasis>SECURITY = SHARE
6226 </emphasis></para>
6228 <para>When clients connect to a share level security server they
6229 need not log onto the server with a valid username and password before
6230 attempting to connect to a shared resource (although modern clients
6231 such as Windows 95/98 and Windows NT will send a logon request with
6232 a username but no password when talking to a <command>security = share
6233 </command> server). Instead, the clients send authentication information
6234 (passwords) on a per-share basis, at the time they attempt to connect
6235 to that share.</para>
6237 <para>Note that <command>smbd</command> <emphasis>ALWAYS</emphasis>
6238 uses a valid UNIX user to act on behalf of the client, even in
6239 <command>security = share</command> level security.</para>
6241 <para>As clients are not required to send a username to the server
6242 in share level security, <command>smbd</command> uses several
6243 techniques to determine the correct UNIX user to use on behalf
6244 of the client.</para>
6246 <para>A list of possible UNIX usernames to match with the given
6247 client password is constructed using the following methods :</para>
6249 <itemizedlist>
6250 <listitem><para>If the <link linkend="GUESTONLY"><parameter>guest
6251 only</parameter></link> parameter is set, then all the other
6252 stages are missed and only the <link linkend="GUESTACCOUNT">
6253 <parameter>guest account</parameter></link> username is checked.
6254 </para></listitem>
6256 <listitem><para>Is a username is sent with the share connection
6257 request, then this username (after mapping - see <link
6258 linkend="USERNAMEMAP"><parameter>username map</parameter></link>),
6259 is added as a potential username.</para></listitem>
6261 <listitem><para>If the client did a previous <emphasis>logon
6262 </emphasis> request (the SessionSetup SMB call) then the
6263 username sent in this SMB will be added as a potential username.
6264 </para></listitem>
6266 <listitem><para>The name of the service the client requested is
6267 added as a potential username.</para></listitem>
6269 <listitem><para>The NetBIOS name of the client is added to
6270 the list as a potential username.</para></listitem>
6272 <listitem><para>Any users on the <link linkend="USER"><parameter>
6273 user</parameter></link> list are added as potential usernames.
6274 </para></listitem>
6275 </itemizedlist>
6277 <para>If the <parameter>guest only</parameter> parameter is
6278 not set, then this list is then tried with the supplied password.
6279 The first user for whom the password matches will be used as the
6280 UNIX user.</para>
6282 <para>If the <parameter>guest only</parameter> parameter is
6283 set, or no username can be determined then if the share is marked
6284 as available to the <parameter>guest account</parameter>, then this
6285 guest user will be used, otherwise access is denied.</para>
6287 <para>Note that it can be <emphasis>very</emphasis> confusing
6288 in share-level security as to which UNIX username will eventually
6289 be used in granting access.</para>
6291 <para>See also the section <link linkend="VALIDATIONSECT">
6292 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6294 <para><anchor id="SECURITYEQUALSUSER"><emphasis>SECURITY = USER
6295 </emphasis></para>
6297 <para>This is the default security setting in Samba 2.2.
6298 With user-level security a client must first "log=on" with a
6299 valid username and password (which can be mapped using the <link
6300 linkend="USERNAMEMAP"><parameter>username map</parameter></link>
6301 parameter). Encrypted passwords (see the <link linkend="ENCRYPTPASSWORDS">
6302 <parameter>encrypted passwords</parameter></link> parameter) can also
6303 be used in this security mode. Parameters such as <link linkend="USER">
6304 <parameter>user</parameter></link> and <link linkend="GUESTONLY">
6305 <parameter>guest only</parameter></link> if set are then applied and
6306 may change the UNIX user to use on this connection, but only after
6307 the user has been successfully authenticated.</para>
6309 <para><emphasis>Note</emphasis> that the name of the resource being
6310 requested is <emphasis>not</emphasis> sent to the server until after
6311 the server has successfully authenticated the client. This is why
6312 guest shares don't work in user level security without allowing
6313 the server to automatically map unknown users into the <link
6314 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>.
6315 See the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6316 </link> parameter for details on doing this.</para>
6318 <para>See also the section <link linkend="VALIDATIONSECT">
6319 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6321 <para><anchor id="SECURITYEQUALSSERVER"><emphasis>SECURITY = SERVER
6322 </emphasis></para>
6324 <para>In this mode Samba will try to validate the username/password
6325 by passing it to another SMB server, such as an NT box. If this
6326 fails it will revert to <command>security = user</command>, but note
6327 that if encrypted passwords have been negotiated then Samba cannot
6328 revert back to checking the UNIX password file, it must have a valid
6329 <filename>smbpasswd</filename> file to check users against. See the
6330 documentation file in the <filename>docs/</filename> directory
6331 <filename>ENCRYPTION.txt</filename> for details on how to set this
6332 up.</para>
6334 <para><emphasis>Note</emphasis> that from the client's point of
6335 view <command>security = server</command> is the same as <command>
6336 security = user</command>. It only affects how the server deals
6337 with the authentication, it does not in any way affect what the
6338 client sees.</para>
6340 <para><emphasis>Note</emphasis> that the name of the resource being
6341 requested is <emphasis>not</emphasis> sent to the server until after
6342 the server has successfully authenticated the client. This is why
6343 guest shares don't work in user level security without allowing
6344 the server to automatically map unknown users into the <link
6345 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>.
6346 See the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6347 </link> parameter for details on doing this.</para>
6349 <para>See also the section <link linkend="VALIDATIONSECT">
6350 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6352 <para>See also the <link linkend="PASSWORDSERVER"><parameter>password
6353 server</parameter></link> parameter and the <link
6354 linkend="ENCRYPTPASSWORDS"><parameter>encrypted passwords</parameter>
6355 </link> parameter.</para>
6357 <para><anchor id="SECURITYEQUALSDOMAIN"><emphasis>SECURITY = DOMAIN
6358 </emphasis></para>
6360 <para>This mode will only work correctly if <ulink
6361 url="smbpasswd.8.html">smbpasswd(8)</ulink> has been used to add this
6362 machine into a Windows NT Domain. It expects the <link
6363 linkend="ENCRYPTPASSWORDS"><parameter>encrypted passwords</parameter>
6364 </link> parameter to be set to <constant>true</constant>. In this
6365 mode Samba will try to validate the username/password by passing
6366 it to a Windows NT Primary or Backup Domain Controller, in exactly
6367 the same way that a Windows NT Server would do.</para>
6369 <para><emphasis>Note</emphasis> that a valid UNIX user must still
6370 exist as well as the account on the Domain Controller to allow
6371 Samba to have a valid UNIX account to map file access to.</para>
6373 <para><emphasis>Note</emphasis> that from the client's point
6374 of view <command>security = domain</command> is the same as <command>security = user
6375 </command>. It only affects how the server deals with the authentication,
6376 it does not in any way affect what the client sees.</para>
6378 <para><emphasis>Note</emphasis> that the name of the resource being
6379 requested is <emphasis>not</emphasis> sent to the server until after
6380 the server has successfully authenticated the client. This is why
6381 guest shares don't work in user level security without allowing
6382 the server to automatically map unknown users into the <link
6383 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>.
6384 See the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6385 </link> parameter for details on doing this.</para>
6387 <para><emphasis>BUG:</emphasis> There is currently a bug in the
6388 implementation of <command>security = domain</command> with respect
6389 to multi-byte character set usernames. The communication with a
6390 Domain Controller must be done in UNICODE and Samba currently
6391 does not widen multi-byte user names to UNICODE correctly, thus
6392 a multi-byte username will not be recognized correctly at the
6393 Domain Controller. This issue will be addressed in a future release.</para>
6395 <para>See also the section <link linkend="VALIDATIONSECT">
6396 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6398 <para>See also the <link linkend="PASSWORDSERVER"><parameter>password
6399 server</parameter></link> parameter and the <link
6400 linkend="ENCRYPTPASSWORDS"><parameter>encrypted passwords</parameter>
6401 </link> parameter.</para>
6403 <para>Default: <command>security = USER</command></para>
6404 <para>Example: <command>security = DOMAIN</command></para>
6405 </listitem>
6406 </varlistentry>
6410 <varlistentry>
6411 <term><anchor id="SECURITYMASK">security mask (S)</term>
6412 <listitem><para>This parameter controls what UNIX permission
6413 bits can be modified when a Windows NT client is manipulating
6414 the UNIX permission on a file using the native NT security
6415 dialog box.</para>
6417 <para>This parameter is applied as a mask (AND'ed with) to
6418 the changed permission bits, thus preventing any bits not in
6419 this mask from being modified. Essentially, zero bits in this
6420 mask may be treated as a set of bits the user is not allowed
6421 to change.</para>
6423 <para>If not set explicitly this parameter is 0777, allowing
6424 a user to modify all the user/group/world permissions on a file.
6425 </para>
6427 <para><emphasis>Note</emphasis> that users who can access the
6428 Samba server through other means can easily bypass this
6429 restriction, so it is primarily useful for standalone
6430 "appliance" systems. Administrators of most normal systems will
6431 probably want to leave it set to <constant>0777</constant>.</para>
6433 <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE">
6434 <parameter>force directory security mode</parameter></link>,
6435 <link linkend="DIRECTORYSECURITYMASK"><parameter>directory
6436 security mask</parameter></link>, <link linkend="FORCESECURITYMODE">
6437 <parameter>force security mode</parameter></link> parameters.</para>
6439 <para>Default: <command>security mask = 0777</command></para>
6440 <para>Example: <command>security mask = 0770</command></para>
6441 </listitem>
6442 </varlistentry>
6445 <varlistentry>
6446 <term><anchor id="SERVERSTRING">server string (G)</term>
6447 <listitem><para>This controls what string will show up in the
6448 printer comment box in print manager and next to the IPC connection
6449 in <command>net view</command>. It can be any string that you wish
6450 to show to your users.</para>
6452 <para>It also sets what will appear in browse lists next
6453 to the machine name.</para>
6455 <para>A <parameter>%v</parameter> will be replaced with the Samba
6456 version number.</para>
6458 <para>A <parameter>%h</parameter> will be replaced with the
6459 hostname.</para>
6461 <para>Default: <command>server string = Samba %v</command></para>
6463 <para>Example: <command>server string = University of GNUs Samba
6464 Server</command></para>
6465 </listitem>
6466 </varlistentry>
6470 <varlistentry>
6471 <term><anchor id="SETDIRECTORY">set directory (S)</term>
6472 <listitem><para>If <command>set directory = no</command>, then
6473 users of the service may not use the setdir command to change
6474 directory.</para>
6476 <para>The <command>setdir</command> command is only implemented
6477 in the Digital Pathworks client. See the Pathworks documentation
6478 for details.</para>
6480 <para>Default: <command>set directory = no</command></para>
6481 </listitem>
6482 </varlistentry>
6487 <varlistentry>
6488 <term><anchor id="SHAREMODES">share modes (S)</term>
6489 <listitem><para>This enables or disables the honoring of
6490 the <parameter>share modes</parameter> during a file open. These
6491 modes are used by clients to gain exclusive read or write access
6492 to a file.</para>
6494 <para>These open modes are not directly supported by UNIX, so
6495 they are simulated using shared memory, or lock files if your
6496 UNIX doesn't support shared memory (almost all do).</para>
6498 <para>The share modes that are enabled by this option are
6499 <constant>DENY_DOS</constant>, <constant>DENY_ALL</constant>,
6500 <constant>DENY_READ</constant>, <constant>DENY_WRITE</constant>,
6501 <constant>DENY_NONE</constant> and <constant>DENY_FCB</constant>.
6502 </para>
6504 <para>This option gives full share compatibility and enabled
6505 by default.</para>
6507 <para>You should <emphasis>NEVER</emphasis> turn this parameter
6508 off as many Windows applications will break if you do so.</para>
6510 <para>Default: <command>share modes = yes</command></para>
6511 </listitem>
6512 </varlistentry>
6516 <varlistentry>
6517 <term><anchor id="SHORTPRESERVECASE">short preserve case (S)</term>
6518 <listitem><para>This boolean parameter controls if new files
6519 which conform to 8.3 syntax, that is all in upper case and of
6520 suitable length, are created upper case, or if they are forced
6521 to be the <link linkend="DEFAULTCASE"><parameter>default case
6522 </parameter></link>. This option can be use with <link
6523 linkend="PRESERVECASE"><command>preserve case = yes</command>
6524 </link> to permit long filenames to retain their case, while short
6525 names are lowered. </para>
6527 <para>See the section on <link linkend="NAMEMANGLINGSECT">
6528 NAME MANGLING</link>.</para>
6530 <para>Default: <command>short preserve case = yes</command></para>
6531 </listitem>
6532 </varlistentry>
6536 <varlistentry>
6537 <term><anchor id="SHOWADDPRINTERWIZARD">show add printer wizard (G)</term>
6538 <listitem><para>With the introduction of MS-RPC based printing support
6539 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
6540 appear on Samba hosts in the share listing. Normally this folder will
6541 contain an icon for the MS Add Printer Wizard (APW). However, it is
6542 possible to disable this feature regardless of the level of privilege
6543 of the connected user.</para>
6545 <para>Under normal circumstances, the Windows NT/2000 client will
6546 open a handle on the printer server with OpenPrinterEx() asking for
6547 Administrator privileges. If the user does not have administrative
6548 access on the print server (i.e is not root or a member of the
6549 <parameter>printer admin</parameter> group), the OpenPrinterEx()
6550 call fails and the client makes another open call with a request for
6551 a lower privilege level. This should succeed, however the APW
6552 icon will not be displayed.</para>
6554 <para>Disabling the <parameter>show add printer wizard</parameter>
6555 parameter will always cause the OpenPrinterEx() on the server
6556 to fail. Thus the APW icon will never be displayed. <emphasis>
6557 Note :</emphasis>This does not prevent the same user from having
6558 administrative privilege on an individual printer.</para>
6560 <para>See also <link linkend="ADDPRINTERCOMMAND"><parameter>addprinter
6561 command</parameter></link>, <link linkend="DELETEPRINTERCOMMAND">
6562 <parameter>deleteprinter command</parameter></link>, <link
6563 linkend="PRINTERADMIN"><parameter>printer admin</parameter></link></para>
6565 <para>Default :<command>show add printer wizard = yes</command></para>
6566 </listitem>
6567 </varlistentry>
6572 <varlistentry>
6573 <term><anchor id="SMBPASSWDFILE">smb passwd file (G)</term>
6574 <listitem><para>This option sets the path to the encrypted
6575 smbpasswd file. By default the path to the smbpasswd file
6576 is compiled into Samba.</para>
6578 <para>Default: <command>smb passwd file = ${prefix}/private/smbpasswd
6579 </command></para>
6581 <para>Example: <command>smb passwd file = /etc/samba/smbpasswd
6582 </command></para>
6583 </listitem>
6584 </varlistentry>
6589 <varlistentry>
6590 <term><anchor id="SOCKETADDRESS">socket address (G)</term>
6591 <listitem><para>This option allows you to control what
6592 address Samba will listen for connections on. This is used to
6593 support multiple virtual interfaces on the one server, each
6594 with a different configuration.</para>
6596 <para>By default Samba will accept connections on any
6597 address.</para>
6599 <para>Example: <command>socket address = 192.168.2.20</command>
6600 </para>
6601 </listitem>
6602 </varlistentry>
6606 <varlistentry>
6607 <term><anchor id="SOCKETOPTIONS">socket options (G)</term>
6608 <listitem><para>This option allows you to set socket options
6609 to be used when talking with the client.</para>
6611 <para>Socket options are controls on the networking layer
6612 of the operating systems which allow the connection to be
6613 tuned.</para>
6615 <para>This option will typically be used to tune your Samba
6616 server for optimal performance for your local network. There is
6617 no way that Samba can know what the optimal parameters are for
6618 your net, so you must experiment and choose them yourself. We
6619 strongly suggest you read the appropriate documentation for your
6620 operating system first (perhaps <command>man setsockopt</command>
6621 will help).</para>
6623 <para>You may find that on some systems Samba will say
6624 "Unknown socket option" when you supply an option. This means you
6625 either incorrectly typed it or you need to add an include file
6626 to includes.h for your OS. If the latter is the case please
6627 send the patch to <ulink url="mailto:samba@samba.org">
6628 samba@samba.org</ulink>.</para>
6630 <para>Any of the supported socket options may be combined
6631 in any way you like, as long as your OS allows it.</para>
6633 <para>This is the list of socket options currently settable
6634 using this option:</para>
6636 <itemizedlist>
6637 <listitem><para>SO_KEEPALIVE</para></listitem>
6638 <listitem><para>SO_REUSEADDR</para></listitem>
6639 <listitem><para>SO_BROADCAST</para></listitem>
6640 <listitem><para>TCP_NODELAY</para></listitem>
6641 <listitem><para>IPTOS_LOWDELAY</para></listitem>
6642 <listitem><para>IPTOS_THROUGHPUT</para></listitem>
6643 <listitem><para>SO_SNDBUF *</para></listitem>
6644 <listitem><para>SO_RCVBUF *</para></listitem>
6645 <listitem><para>SO_SNDLOWAT *</para></listitem>
6646 <listitem><para>SO_RCVLOWAT *</para></listitem>
6647 </itemizedlist>
6649 <para>Those marked with a <emphasis>'*'</emphasis> take an integer
6650 argument. The others can optionally take a 1 or 0 argument to enable
6651 or disable the option, by default they will be enabled if you
6652 don't specify 1 or 0.</para>
6654 <para>To specify an argument use the syntax SOME_OPTION=VALUE
6655 for example <command>SO_SNDBUF=8192</command>. Note that you must
6656 not have any spaces before or after the = sign.</para>
6658 <para>If you are on a local network then a sensible option
6659 might be</para>
6660 <para><command>socket options = IPTOS_LOWDELAY</command></para>
6662 <para>If you have a local network then you could try:</para>
6663 <para><command>socket options = IPTOS_LOWDELAY TCP_NODELAY</command></para>
6665 <para>If you are on a wide area network then perhaps try
6666 setting IPTOS_THROUGHPUT. </para>
6668 <para>Note that several of the options may cause your Samba
6669 server to fail completely. Use these options with caution!</para>
6671 <para>Default: <command>socket options = TCP_NODELAY</command></para>
6672 <para>Example: <command>socket options = IPTOS_LOWDELAY</command></para>
6673 </listitem>
6674 </varlistentry>
6679 <varlistentry>
6680 <term><anchor id="SOURCEENVIRONMENT">source environment (G)</term>
6681 <listitem><para>This parameter causes Samba to set environment
6682 variables as per the content of the file named.</para>
6684 <para>If the value of this parameter starts with a "|" character
6685 then Samba will treat that value as a pipe command to open and
6686 will set the environment variables from the output of the pipe.</para>
6688 <para>The contents of the file or the output of the pipe should
6689 be formatted as the output of the standard Unix <command>env(1)
6690 </command> command. This is of the form :</para>
6691 <para>Example environment entry:</para>
6692 <para><command>SAMBA_NETBIOS_NAME=myhostname</command></para>
6694 <para>Default: <emphasis>No default value</emphasis></para>
6695 <para>Examples: <command>source environment = |/etc/smb.conf.sh
6696 </command></para>
6698 <para>Example: <command>source environment =
6699 /usr/local/smb_env_vars</command></para>
6700 </listitem>
6701 </varlistentry>
6705 <varlistentry>
6706 <term><anchor id="SSL">ssl (G)</term>
6707 <listitem><para>This variable is part of SSL-enabled Samba. This
6708 is only available if the SSL libraries have been compiled on your
6709 system and the configure option <command>--with-ssl</command> was
6710 given at configure time.</para>
6712 <para><emphasis>Note</emphasis> that for export control reasons
6713 this code is <emphasis>NOT</emphasis> enabled by default in any
6714 current binary version of Samba.</para>
6716 <para>This variable enables or disables the entire SSL mode. If
6717 it is set to <constant>no</constant>, the SSL-enabled Samba behaves
6718 exactly like the non-SSL Samba. If set to <constant>yes</constant>,
6719 it depends on the variables <link linkend="SSLHOSTS"><parameter>
6720 ssl hosts</parameter></link> and <link linkend="SSLHOSTSRESIGN">
6721 <parameter>ssl hosts resign</parameter></link> whether an SSL
6722 connection will be required.</para>
6724 <para>Default: <command>ssl=no</command></para>
6725 </listitem>
6726 </varlistentry>
6730 <varlistentry>
6731 <term><anchor id="SSLCACERTDIR">ssl CA certDir (G)</term>
6732 <listitem><para>This variable is part of SSL-enabled Samba. This
6733 is only available if the SSL libraries have been compiled on your
6734 system and the configure option <command>--with-ssl</command> was
6735 given at configure time.</para>
6737 <para><emphasis>Note</emphasis> that for export control reasons
6738 this code is <emphasis>NOT</emphasis> enabled by default in any
6739 current binary version of Samba.</para>
6741 <para>This variable defines where to look up the Certification
6742 Authorities. The given directory should contain one file for
6743 each CA that Samba will trust. The file name must be the hash
6744 value over the "Distinguished Name" of the CA. How this directory
6745 is set up is explained later in this document. All files within the
6746 directory that don't fit into this naming scheme are ignored. You
6747 don't need this variable if you don't verify client certificates.</para>
6749 <para>Default: <command>ssl CA certDir = /usr/local/ssl/certs
6750 </command></para>
6751 </listitem>
6752 </varlistentry>
6756 <varlistentry>
6757 <term><anchor id="SSLCACERTFILE">ssl CA certFile (G)</term>
6758 <listitem><para>This variable is part of SSL-enabled Samba. This
6759 is only available if the SSL libraries have been compiled on your
6760 system and the configure option <command>--with-ssl</command> was
6761 given at configure time.</para>
6763 <para><emphasis>Note</emphasis> that for export control reasons
6764 this code is <emphasis>NOT</emphasis> enabled by default in any
6765 current binary version of Samba.</para>
6767 <para>This variable is a second way to define the trusted CAs.
6768 The certificates of the trusted CAs are collected in one big
6769 file and this variable points to the file. You will probably
6770 only use one of the two ways to define your CAs. The first choice is
6771 preferable if you have many CAs or want to be flexible, the second
6772 is preferable if you only have one CA and want to keep things
6773 simple (you won't need to create the hashed file names). You
6774 don't need this variable if you don't verify client certificates.</para>
6776 <para>Default: <command>ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
6777 </command></para>
6778 </listitem>
6779 </varlistentry>
6783 <varlistentry>
6784 <term><anchor id="SSLCIPHERS">ssl ciphers (G)</term>
6785 <listitem><para>This variable is part of SSL-enabled Samba. This
6786 is only available if the SSL libraries have been compiled on your
6787 system and the configure option <command>--with-ssl</command> was
6788 given at configure time.</para>
6790 <para><emphasis>Note</emphasis> that for export control reasons
6791 this code is <emphasis>NOT</emphasis> enabled by default in any
6792 current binary version of Samba.</para>
6794 <para>This variable defines the ciphers that should be offered
6795 during SSL negotiation. You should not set this variable unless
6796 you know what you are doing.</para>
6797 </listitem>
6798 </varlistentry>
6801 <varlistentry>
6802 <term><anchor id="SSLCLIENTCERT">ssl client cert (G)</term>
6803 <listitem><para>This variable is part of SSL-enabled Samba. This
6804 is only available if the SSL libraries have been compiled on your
6805 system and the configure option <command>--with-ssl</command> was
6806 given at configure time.</para>
6808 <para><emphasis>Note</emphasis> that for export control reasons
6809 this code is <emphasis>NOT</emphasis> enabled by default in any
6810 current binary version of Samba.</para>
6812 <para>The certificate in this file is used by <ulink url="smbclient.1.html">
6813 <command>smbclient(1)</command></ulink> if it exists. It's needed
6814 if the server requires a client certificate.</para>
6816 <para>Default: <command>ssl client cert = /usr/local/ssl/certs/smbclient.pem
6817 </command></para>
6818 </listitem>
6819 </varlistentry>
6823 <varlistentry>
6824 <term><anchor id="SSLCLIENTKEY">ssl client key (G)</term>
6825 <listitem><para>This variable is part of SSL-enabled Samba. This
6826 is only available if the SSL libraries have been compiled on your
6827 system and the configure option <command>--with-ssl</command> was
6828 given at configure time.</para>
6830 <para><emphasis>Note</emphasis> that for export control reasons
6831 this code is <emphasis>NOT</emphasis> enabled by default in any
6832 current binary version of Samba.</para>
6834 <para>This is the private key for <ulink url="smbclient.1.html">
6835 <command>smbclient(1)</command></ulink>. It's only needed if the
6836 client should have a certificate. </para>
6838 <para>Default: <command>ssl client key = /usr/local/ssl/private/smbclient.pem
6839 </command></para>
6840 </listitem>
6841 </varlistentry>
6845 <varlistentry>
6846 <term><anchor id="SSLCOMPATIBILITY">ssl compatibility (G)</term>
6847 <listitem><para>This variable is part of SSL-enabled Samba. This
6848 is only available if the SSL libraries have been compiled on your
6849 system and the configure option <command>--with-ssl</command> was
6850 given at configure time.</para>
6852 <para><emphasis>Note</emphasis> that for export control reasons
6853 this code is <emphasis>NOT</emphasis> enabled by default in any
6854 current binary version of Samba.</para>
6856 <para>This variable defines whether SSLeay should be configured
6857 for bug compatibility with other SSL implementations. This is
6858 probably not desirable because currently no clients with SSL
6859 implementations other than SSLeay exist.</para>
6861 <para>Default: <command>ssl compatibility = no</command></para>
6862 </listitem>
6863 </varlistentry>
6866 <varlistentry>
6867 <term><anchor id="SSLHOSTS">ssl hosts (G)</term>
6868 <listitem><para>See <link linkend="SSLHOSTSRESIGN"><parameter>
6869 ssl hosts resign</parameter></link>.</para>
6870 </listitem>
6871 </varlistentry>
6874 <varlistentry>
6875 <term><anchor id="SSLHOSTSRESIGN">ssl hosts resign (G)</term>
6876 <listitem><para>This variable is part of SSL-enabled Samba. This
6877 is only available if the SSL libraries have been compiled on your
6878 system and the configure option <command>--with-ssl</command> was
6879 given at configure time.</para>
6881 <para><emphasis>Note</emphasis> that for export control reasons
6882 this code is <emphasis>NOT</emphasis> enabled by default in any
6883 current binary version of Samba.</para>
6885 <para>These two variables define whether Samba will go
6886 into SSL mode or not. If none of them is defined, Samba will
6887 allow only SSL connections. If the <link linkend="SSLHOSTS">
6888 <parameter>ssl hosts</parameter></link> variable lists
6889 hosts (by IP-address, IP-address range, net group or name),
6890 only these hosts will be forced into SSL mode. If the <parameter>
6891 ssl hosts resign</parameter> variable lists hosts, only these
6892 hosts will <emphasis>NOT</emphasis> be forced into SSL mode. The syntax for these two
6893 variables is the same as for the <link linkend="HOSTSALLOW"><parameter>
6894 hosts allow</parameter></link> and <link linkend="HOSTSDENY">
6895 <parameter>hosts deny</parameter></link> pair of variables, only
6896 that the subject of the decision is different: It's not the access
6897 right but whether SSL is used or not. </para>
6899 <para>The example below requires SSL connections from all hosts
6900 outside the local net (which is 192.168.*.*).</para>
6902 <para>Default: <command>ssl hosts = &lt;empty string&gt;</command></para>
6903 <para><command>ssl hosts resign = &lt;empty string&gt;</command></para>
6905 <para>Example: <command>ssl hosts resign = 192.168.</command></para>
6906 </listitem>
6907 </varlistentry>
6911 <varlistentry>
6912 <term><anchor id="SSLREQUIRECLIENTCERT">ssl require clientcert (G)</term>
6913 <listitem><para>This variable is part of SSL-enabled Samba. This
6914 is only available if the SSL libraries have been compiled on your
6915 system and the configure option <command>--with-ssl</command> was
6916 given at configure time.</para>
6918 <para><emphasis>Note</emphasis> that for export control reasons
6919 this code is <emphasis>NOT</emphasis> enabled by default in any
6920 current binary version of Samba.</para>
6922 <para>If this variable is set to <constant>yes</constant>, the
6923 server will not tolerate connections from clients that don't
6924 have a valid certificate. The directory/file given in <link
6925 linkend="SSLCACERTDIR"><parameter>ssl CA certDir</parameter>
6926 </link> and <link linkend="SSLCACERTFILE"><parameter>ssl CA certFile
6927 </parameter></link> will be used to look up the CAs that issued
6928 the client's certificate. If the certificate can't be verified
6929 positively, the connection will be terminated. If this variable
6930 is set to <constant>no</constant>, clients don't need certificates.
6931 Contrary to web applications you really <emphasis>should</emphasis>
6932 require client certificates. In the web environment the client's
6933 data is sensitive (credit card numbers) and the server must prove
6934 to be trustworthy. In a file server environment the server's data
6935 will be sensitive and the clients must prove to be trustworthy.</para>
6937 <para>Default: <command>ssl require clientcert = no</command></para>
6938 </listitem>
6939 </varlistentry>
6943 <varlistentry>
6944 <term><anchor id="SSLREQUIRESERVERCERT">ssl require servercert (G)</term>
6945 <listitem><para>This variable is part of SSL-enabled Samba. This
6946 is only available if the SSL libraries have been compiled on your
6947 system and the configure option <command>--with-ssl</command> was
6948 given at configure time.</para>
6950 <para><emphasis>Note</emphasis> that for export control reasons
6951 this code is <emphasis>NOT</emphasis> enabled by default in any
6952 current binary version of Samba.</para>
6954 <para>If this variable is set to <constant>yes</constant>, the
6955 <ulink url="smbclient.1.html"><command>smbclient(1)</command>
6956 </ulink> will request a certificate from the server. Same as
6957 <link linkend="SSLREQUIRECLIENTCERT"><parameter>ssl require
6958 clientcert</parameter></link> for the server.</para>
6960 <para>Default: <command>ssl require servercert = no</command>
6961 </para>
6962 </listitem>
6963 </varlistentry>
6965 <varlistentry>
6966 <term><anchor id="SSLSERVERCERT">ssl server cert (G)</term>
6967 <listitem><para>This variable is part of SSL-enabled Samba. This
6968 is only available if the SSL libraries have been compiled on your
6969 system and the configure option <command>--with-ssl</command> was
6970 given at configure time.</para>
6972 <para><emphasis>Note</emphasis> that for export control reasons
6973 this code is <emphasis>NOT</emphasis> enabled by default in any
6974 current binary version of Samba.</para>
6976 <para>This is the file containing the server's certificate.
6977 The server <emphasis>must</emphasis> have a certificate. The
6978 file may also contain the server's private key. See later for
6979 how certificates and private keys are created.</para>
6981 <para>Default: <command>ssl server cert = &lt;empty string&gt;
6982 </command></para>
6983 </listitem>
6984 </varlistentry>
6987 <varlistentry>
6988 <term><anchor id="SSLSERVERKEY">ssl server key (G)</term>
6989 <listitem><para>This variable is part of SSL-enabled Samba. This
6990 is only available if the SSL libraries have been compiled on your
6991 system and the configure option <command>--with-ssl</command> was
6992 given at configure time.</para>
6994 <para><emphasis>Note</emphasis> that for export control reasons
6995 this code is <emphasis>NOT</emphasis> enabled by default in any
6996 current binary version of Samba.</para>
6998 <para>This file contains the private key of the server. If
6999 this variable is not defined, the key is looked up in the
7000 certificate file (it may be appended to the certificate).
7001 The server <emphasis>must</emphasis> have a private key
7002 and the certificate <emphasis>must</emphasis>
7003 match this private key.</para>
7005 <para>Default: <command>ssl server key = &lt;empty string&gt;
7006 </command></para>
7007 </listitem>
7008 </varlistentry>
7011 <varlistentry>
7012 <term><anchor id="SSLVERSION">ssl version (G)</term>
7013 <listitem><para>This variable is part of SSL-enabled Samba. This
7014 is only available if the SSL libraries have been compiled on your
7015 system and the configure option <command>--with-ssl</command> was
7016 given at configure time.</para>
7018 <para><emphasis>Note</emphasis> that for export control reasons
7019 this code is <emphasis>NOT</emphasis> enabled by default in any
7020 current binary version of Samba.</para>
7022 <para>This enumeration variable defines the versions of the
7023 SSL protocol that will be used. <constant>ssl2or3</constant> allows
7024 dynamic negotiation of SSL v2 or v3, <constant>ssl2</constant> results
7025 in SSL v2, <constant>ssl3</constant> results in SSL v3 and
7026 <constant>tls1</constant> results in TLS v1. TLS (Transport Layer
7027 Security) is the new standard for SSL.</para>
7029 <para>Default: <command>ssl version = "ssl2or3"</command></para>
7030 </listitem>
7031 </varlistentry>
7035 <varlistentry>
7036 <term><anchor id="STATCACHE">stat cache (G)</term>
7037 <listitem><para>This parameter determines if <ulink
7038 url="smbd.8.html">smbd(8)</ulink> will use a cache in order to
7039 speed up case insensitive name mappings. You should never need
7040 to change this parameter.</para>
7042 <para>Default: <command>stat cache = yes</command></para>
7043 </listitem>
7044 </varlistentry>
7046 <varlistentry>
7047 <term><anchor id="STATCACHESIZE">stat cache size (G)</term>
7048 <listitem><para>This parameter determines the number of
7049 entries in the <parameter>stat cache</parameter>. You should
7050 never need to change this parameter.</para>
7052 <para>Default: <command>stat cache size = 50</command></para>
7053 </listitem>
7054 </varlistentry>
7058 <varlistentry>
7059 <term><anchor id="STATUS">status (G)</term>
7060 <listitem><para>This enables or disables logging of connections
7061 to a status file that <ulink url="smbstatus.1.html">smbstatus(1)</ulink>
7062 can read.</para>
7064 <para>With this disabled <command>smbstatus</command> won't be able
7065 to tell you what connections are active. You should never need to
7066 change this parameter.</para>
7068 <para>Default: <command>status = yes</command></para>
7069 </listitem>
7070 </varlistentry>
7074 <varlistentry>
7075 <term><anchor id="STRICTLOCKING">strict locking (S)</term>
7076 <listitem><para>This is a boolean that controls the handling of
7077 file locking in the server. When this is set to <constant>yes</constant>
7078 the server will check every read and write access for file locks, and
7079 deny access if locks exist. This can be slow on some systems.</para>
7081 <para>When strict locking is <constant>no</constant> the server does file
7082 lock checks only when the client explicitly asks for them.</para>
7084 <para>Well-behaved clients always ask for lock checks when it
7085 is important, so in the vast majority of cases <command>strict
7086 locking = no</command> is preferable.</para>
7088 <para>Default: <command>strict locking = no</command></para>
7089 </listitem>
7090 </varlistentry>
7094 <varlistentry>
7095 <term><anchor id="STRICTSYNC">strict sync (S)</term>
7096 <listitem><para>Many Windows applications (including the Windows
7097 98 explorer shell) seem to confuse flushing buffer contents to
7098 disk with doing a sync to disk. Under UNIX, a sync call forces
7099 the process to be suspended until the kernel has ensured that
7100 all outstanding data in kernel disk buffers has been safely stored
7101 onto stable storage. This is very slow and should only be done
7102 rarely. Setting this parameter to <constant>no</constant> (the
7103 default) means that <ulink url="smbd.8.html">smbd</ulink> ignores the Windows applications requests for
7104 a sync call. There is only a possibility of losing data if the
7105 operating system itself that Samba is running on crashes, so there is
7106 little danger in this default setting. In addition, this fixes many
7107 performance problems that people have reported with the new Windows98
7108 explorer shell file copies.</para>
7110 <para>See also the <link linkend="SYNCALWAYS"><parameter>sync
7111 always></parameter></link> parameter.</para>
7113 <para>Default: <command>strict sync = no</command></para>
7114 </listitem>
7115 </varlistentry>
7118 <varlistentry>
7119 <term><anchor id="STRIPDOT">strip dot (G)</term>
7120 <listitem><para>This is a boolean that controls whether to
7121 strip trailing dots off UNIX filenames. This helps with some
7122 CDROMs that have filenames ending in a single dot.</para>
7124 <para>Default: <command>strip dot = no</command></para>
7125 </listitem>
7126 </varlistentry>
7130 <varlistentry>
7131 <term><anchor id="SYNCALWAYS">sync always (S)</term>
7132 <listitem><para>This is a boolean parameter that controls
7133 whether writes will always be written to stable storage before
7134 the write call returns. If this is <constant>false</constant> then the server will be
7135 guided by the client's request in each write call (clients can
7136 set a bit indicating that a particular write should be synchronous).
7137 If this is <constant>true</constant> then every write will be followed by a <command>fsync()
7138 </command> call to ensure the data is written to disk. Note that
7139 the <parameter>strict sync</parameter> parameter must be set to
7140 <constant>yes</constant> in order for this parameter to have
7141 any affect.</para>
7143 <para>See also the <link linkend="STRICTSYNC"><parameter>strict
7144 sync</parameter></link> parameter.</para>
7146 <para>Default: <command>sync always = no</command></para>
7147 </listitem>
7148 </varlistentry>
7152 <varlistentry>
7153 <term><anchor id="SYSLOG">syslog (G)</term>
7154 <listitem><para>This parameter maps how Samba debug messages
7155 are logged onto the system syslog logging levels. Samba debug
7156 level zero maps onto syslog <constant>LOG_ERR</constant>, debug
7157 level one maps onto <constant>LOG_WARNING</constant>, debug level
7158 two maps onto <constant>LOG_NOTICE</constant>, debug level three
7159 maps onto LOG_INFO. All higher levels are mapped to <constant>
7160 LOG_DEBUG</constant>.</para>
7162 <para>This parameter sets the threshold for sending messages
7163 to syslog. Only messages with debug level less than this value
7164 will be sent to syslog.</para>
7166 <para>Default: <command>syslog = 1</command></para>
7167 </listitem>
7168 </varlistentry>
7172 <varlistentry>
7173 <term><anchor id="SYSLOGONLY">syslog only (G)</term>
7174 <listitem><para>If this parameter is set then Samba debug
7175 messages are logged into the system syslog only, and not to
7176 the debug log files.</para>
7178 <para>Default: <command>syslog only = no</command></para>
7179 </listitem>
7180 </varlistentry>
7184 <varlistentry>
7185 <term><anchor id="TEMPLATEHOMEDIR">template homedir (G)</term>
7186 <listitem><para><emphasis>NOTE:</emphasis> this parameter is
7187 only available in Samba 3.0.</para>
7189 <para>When filling out the user information for a Windows NT
7190 user, the <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon
7191 uses this parameter to fill in the home directory for that user.
7192 If the string <parameter>%D</parameter> is present it is substituted
7193 with the user's Windows NT domain name. If the string <parameter>%U
7194 </parameter> is present it is substituted with the user's Windows
7195 NT user name.</para>
7197 <para>Default: <command>template homedir = /home/%D/%U</command></para>
7198 </listitem>
7199 </varlistentry>
7203 <varlistentry>
7204 <term><anchor id="TEMPLATESHELL">template shell (G)</term>
7205 <listitem><para><emphasis>NOTE:</emphasis> this parameter is
7206 only available in Samba 3.0.</para>
7208 <para>When filling out the user information for a Windows NT
7209 user, the <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon
7210 uses this parameter to fill in the login shell for that user.</para>
7212 <para>Default: <command>template shell = /bin/false</command></para>
7213 </listitem>
7214 </varlistentry>
7218 <varlistentry>
7219 <term><anchor id="TIMEOFFSET">time offset (G)</term>
7220 <listitem><para>This parameter is a setting in minutes to add
7221 to the normal GMT to local time conversion. This is useful if
7222 you are serving a lot of PCs that have incorrect daylight
7223 saving time handling.</para>
7225 <para>Default: <command>time offset = 0</command></para>
7226 <para>Example: <command>time offset = 60</command></para>
7227 </listitem>
7228 </varlistentry>
7232 <varlistentry>
7233 <term><anchor id="TIMESERVER">time server (G)</term>
7234 <listitem><para>This parameter determines if <ulink url="nmbd.8.html">
7235 nmbd(8)</ulink> advertises itself as a time server to Windows
7236 clients.</para>
7238 <para>Default: <command>time server = no</command></para>
7239 </listitem>
7240 </varlistentry>
7243 <varlistentry>
7244 <term><anchor id="TIMESTAMPLOGS">timestamp logs (G)</term>
7245 <listitem><para>Synonym for <link linkend="DEBUGTIMESTAMP"><parameter>
7246 debug timestamp</parameter></link>.</para>
7247 </listitem>
7248 </varlistentry>
7254 <varlistentry>
7255 <term><anchor id="TOTALPRINTJOBS">total print jobs (G)</term>
7256 <listitem><para>This parameter accepts an integer value which defines
7257 a limit on the maximum number of print jobs that will be accepted
7258 system wide at any given time. If a print job is submitted
7259 by a client which will exceed this number, then <ulink url="smbd.8.html">smbd</ulink> will return an
7260 error indicating that no space is available on the server. The
7261 default value of 0 means that no such limit exists. This parameter
7262 can be used to prevent a server from exceeding its capacity and is
7263 designed as a printing throttle. See also
7264 <link linkend="MAXPRINTJOBS"><parameter>max print jobs</parameter</link>.
7265 </para>
7267 <para>Default: <command>total print jobs = 0</command></para>
7268 <para>Example: <command>total print jobs = 5000</command></para>
7269 </listitem>
7270 </varlistentry>
7275 <varlistentry>
7276 <term><anchor id="UNIXPASSWORDSYNC">unix password sync (G)</term>
7277 <listitem><para>This boolean parameter controls whether Samba
7278 attempts to synchronize the UNIX password with the SMB password
7279 when the encrypted SMB password in the smbpasswd file is changed.
7280 If this is set to <constant>true</constant> the program specified in the <parameter>passwd
7281 program</parameter>parameter is called <emphasis>AS ROOT</emphasis> -
7282 to allow the new UNIX password to be set without access to the
7283 old UNIX password (as the SMB password change code has no
7284 access to the old password cleartext, only the new).</para>
7286 <para>See also <link linkend="PASSWDPROGRAM"><parameter>passwd
7287 program</parameter></link>, <link linkend="PASSWDCHAT"><parameter>
7288 passwd chat</parameter></link>.</para>
7290 <para>Default: <command>unix password sync = no</command></para>
7291 </listitem>
7292 </varlistentry>
7296 <varlistentry>
7297 <term><anchor id="UPDATEENCRYPTED">update encrypted (G)</term>
7298 <listitem><para>This boolean parameter allows a user logging
7299 on with a plaintext password to have their encrypted (hashed)
7300 password in the smbpasswd file to be updated automatically as
7301 they log on. This option allows a site to migrate from plaintext
7302 password authentication (users authenticate with plaintext
7303 password over the wire, and are checked against a UNIX account
7304 database) to encrypted password authentication (the SMB
7305 challenge/response authentication mechanism) without forcing
7306 all users to re-enter their passwords via smbpasswd at the time the
7307 change is made. This is a convenience option to allow the change over
7308 to encrypted passwords to be made over a longer period. Once all users
7309 have encrypted representations of their passwords in the smbpasswd
7310 file this parameter should be set to <constant>no</constant>.</para>
7312 <para>In order for this parameter to work correctly the <link
7313 linkend="ENCRYPTPASSWORDS"><parameter>encrypt passwords</parameter>
7314 </link> parameter must be set to <constant>no</constant> when
7315 this parameter is set to <constant>yes</constant>.</para>
7317 <para>Note that even when this parameter is set a user
7318 authenticating to <command>smbd</command> must still enter a valid
7319 password in order to connect correctly, and to update their hashed
7320 (smbpasswd) passwords.</para>
7322 <para>Default: <command>update encrypted = no</command></para>
7323 </listitem>
7324 </varlistentry>
7328 <varlistentry>
7329 <term><anchor id="USERHOSTS">use rhosts (G)</term>
7330 <listitem><para>If this global parameter is <constant>true</constant>, it specifies
7331 that the UNIX user's <filename>.rhosts</filename> file in their home directory
7332 will be read to find the names of hosts and users who will be allowed
7333 access without specifying a password.</para>
7335 <para><emphasis>NOTE:</emphasis> The use of <parameter>use rhosts
7336 </parameter> can be a major security hole. This is because you are
7337 trusting the PC to supply the correct username. It is very easy to
7338 get a PC to supply a false username. I recommend that the <parameter>
7339 use rhosts</parameter> option be only used if you really know what
7340 you are doing.</para>
7342 <para>Default: <command>use rhosts = no</command></para>
7343 </listitem>
7344 </varlistentry>
7348 <varlistentry>
7349 <term><anchor id="USER">user (S)</term>
7350 <listitem><para>Synonym for <link linkend="USERNAME"><parameter>
7351 username</parameter></link>.</para>
7352 </listitem>
7353 </varlistentry>
7357 <varlistentry>
7358 <term><anchor id="USERS">users (S)</term>
7359 <listitem><para>Synonym for <link linkend="USERNAME"><parameter>
7360 username</parameter></link>.</para>
7361 </listitem>
7362 </varlistentry>
7365 <varlistentry>
7366 <term><anchor id="USERNAME">username (S)</term>
7367 <listitem><para>Multiple users may be specified in a comma-delimited
7368 list, in which case the supplied password will be tested against
7369 each username in turn (left to right).</para>
7371 <para>The <parameter>username</parameter> line is needed only when
7372 the PC is unable to supply its own username. This is the case
7373 for the COREPLUS protocol or where your users have different WfWg
7374 usernames to UNIX usernames. In both these cases you may also be
7375 better using the \\server\share%user syntax instead.</para>
7377 <para>The <parameter>username</parameter> line is not a great
7378 solution in many cases as it means Samba will try to validate
7379 the supplied password against each of the usernames in the
7380 <parameter>username</parameter> line in turn. This is slow and
7381 a bad idea for lots of users in case of duplicate passwords.
7382 You may get timeouts or security breaches using this parameter
7383 unwisely.</para>
7385 <para>Samba relies on the underlying UNIX security. This
7386 parameter does not restrict who can login, it just offers hints
7387 to the Samba server as to what usernames might correspond to the
7388 supplied password. Users can login as whoever they please and
7389 they will be able to do no more damage than if they started a
7390 telnet session. The daemon runs as the user that they log in as,
7391 so they cannot do anything that user cannot do.</para>
7393 <para>To restrict a service to a particular set of users you
7394 can use the <link linkend="VALIDUSERS"><parameter>valid users
7395 </parameter></link> parameter.</para>
7397 <para>If any of the usernames begin with a '@' then the name
7398 will be looked up first in the NIS netgroups list (if Samba
7399 is compiled with netgroup support), followed by a lookup in
7400 the UNIX groups database and will expand to a list of all users
7401 in the group of that name.</para>
7403 <para>If any of the usernames begin with a '+' then the name
7404 will be looked up only in the UNIX groups database and will
7405 expand to a list of all users in the group of that name.</para>
7407 <para>If any of the usernames begin with a '&'then the name
7408 will be looked up only in the NIS netgroups database (if Samba
7409 is compiled with netgroup support) and will expand to a list
7410 of all users in the netgroup group of that name.</para>
7412 <para>Note that searching though a groups database can take
7413 quite some time, and some clients may time out during the
7414 search.</para>
7416 <para>See the section <link linkend="VALIDATIONSECT">NOTE ABOUT
7417 USERNAME/PASSWORD VALIDATION</link> for more information on how
7418 this parameter determines access to the services.</para>
7420 <para>Default: <command>The guest account if a guest service,
7421 else &lt;empty string&gt;.</command></para>
7423 <para>Examples:<command>username = fred, mary, jack, jane,
7424 @users, @pcgroup</command></para>
7425 </listitem>
7426 </varlistentry>
7430 <varlistentry>
7431 <term><anchor id="USERNAMELEVEL">username level (G)</term>
7432 <listitem><para>This option helps Samba to try and 'guess' at
7433 the real UNIX username, as many DOS clients send an all-uppercase
7434 username. By default Samba tries all lowercase, followed by the
7435 username with the first letter capitalized, and fails if the
7436 username is not found on the UNIX machine.</para>
7438 <para>If this parameter is set to non-zero the behavior changes.
7439 This parameter is a number that specifies the number of uppercase
7440 combinations to try while trying to determine the UNIX user name. The
7441 higher the number the more combinations will be tried, but the slower
7442 the discovery of usernames will be. Use this parameter when you have
7443 strange usernames on your UNIX machine, such as <constant>AstrangeUser
7444 </constant>.</para>
7446 <para>Default: <command>username level = 0</command></para>
7447 <para>Example: <command>username level = 5</command></para>
7448 </listitem>
7449 </varlistentry>
7453 <varlistentry>
7454 <term><anchor id="USERNAMEMAP">username map (G)</term>
7455 <listitem><para>This option allows you to specify a file containing
7456 a mapping of usernames from the clients to the server. This can be
7457 used for several purposes. The most common is to map usernames
7458 that users use on DOS or Windows machines to those that the UNIX
7459 box uses. The other is to map multiple users to a single username
7460 so that they can more easily share files.</para>
7462 <para>The map file is parsed line by line. Each line should
7463 contain a single UNIX username on the left then a '=' followed
7464 by a list of usernames on the right. The list of usernames on the
7465 right may contain names of the form @group in which case they
7466 will match any UNIX username in that group. The special client
7467 name '*' is a wildcard and matches any name. Each line of the
7468 map file may be up to 1023 characters long.</para>
7470 <para>The file is processed on each line by taking the
7471 supplied username and comparing it with each username on the right
7472 hand side of the '=' signs. If the supplied name matches any of
7473 the names on the right hand side then it is replaced with the name
7474 on the left. Processing then continues with the next line.</para>
7476 <para>If any line begins with a '#' or a ';' then it is
7477 ignored</para>
7479 <para>If any line begins with an '!' then the processing
7480 will stop after that line if a mapping was done by the line.
7481 Otherwise mapping continues with every line being processed.
7482 Using '!' is most useful when you have a wildcard mapping line
7483 later in the file.</para>
7485 <para>For example to map from the name <constant>admin</constant>
7486 or <constant>administrator</constant> to the UNIX name <constant>
7487 root</constant> you would use:</para>
7489 <para><command>root = admin administrator</command></para>
7491 <para>Or to map anyone in the UNIX group <constant>system</constant>
7492 to the UNIX name <constant>sys</constant> you would use:</para>
7494 <para><command>sys = @system</command></para>
7496 <para>You can have as many mappings as you like in a username
7497 map file.</para>
7500 <para>If your system supports the NIS NETGROUP option then
7501 the netgroup database is checked before the <filename>/etc/group
7502 </filename> database for matching groups.</para>
7504 <para>You can map Windows usernames that have spaces in them
7505 by using double quotes around the name. For example:</para>
7507 <para><command>tridge = "Andrew Tridgell"</command></para>
7509 <para>would map the windows username "Andrew Tridgell" to the
7510 unix username "tridge".</para>
7512 <para>The following example would map mary and fred to the
7513 unix user sys, and map the rest to guest. Note the use of the
7514 '!' to tell Samba to stop processing if it gets a match on
7515 that line.</para>
7517 <para><programlisting>
7518 !sys = mary fred
7519 guest = *
7520 </programlisting></para>
7522 <para>Note that the remapping is applied to all occurrences
7523 of usernames. Thus if you connect to \\server\fred and <constant>
7524 fred</constant> is remapped to <constant>mary</constant> then you
7525 will actually be connecting to \\server\mary and will need to
7526 supply a password suitable for <constant>mary</constant> not
7527 <constant>fred</constant>. The only exception to this is the
7528 username passed to the <link linkend="PASSWORDSERVER"><parameter>
7529 password server</parameter></link> (if you have one). The password
7530 server will receive whatever username the client supplies without
7531 modification.</para>
7533 <para>Also note that no reverse mapping is done. The main effect
7534 this has is with printing. Users who have been mapped may have
7535 trouble deleting print jobs as PrintManager under WfWg will think
7536 they don't own the print job.</para>
7538 <para>Default: <emphasis>no username map</emphasis></para>
7539 <para>Example: <command>username map = /usr/local/samba/lib/users.map
7540 </command></para>
7541 </listitem>
7542 </varlistentry>
7546 <varlistentry>
7547 <term><anchor id="UTMP">utmp (G)</term>
7548 <listitem><para>This boolean parameter is only available if
7549 Samba has been configured and compiled with the option <command>
7550 --with-utmp</command>. If set to <constant>true</constant> then Samba will attempt
7551 to add utmp or utmpx records (depending on the UNIX system) whenever a
7552 connection is made to a Samba server. Sites may use this to record the
7553 user connecting to a Samba share.</para>
7555 <para>See also the <link linkend="UTMPDIRECTORY"><parameter>
7556 utmp directory</parameter></link> parameter.</para>
7558 <para>Default: <command>utmp = no</command></para>
7559 </listitem>
7560 </varlistentry>
7564 <varlistentry>
7565 <term><anchor id="UTMPDIRECTORY">utmp directory(G)</term>
7566 <listitem><para>This parameter is only available if Samba has
7567 been configured and compiled with the option <command>
7568 --with-utmp</command>. It specifies a directory pathname that is
7569 used to store the utmp or utmpx files (depending on the UNIX system) that
7570 record user connections to a Samba server. See also the <link linkend="UTMP">
7571 <parameter>utmp</parameter></link> parameter. By default this is
7572 not set, meaning the system will use whatever utmp file the
7573 native system is set to use (usually
7574 <filename>/var/run/utmp</filename> on Linux).</para>
7576 <para>Default: <emphasis>no utmp directory</emphasis></para>
7577 </listitem>
7578 </varlistentry>
7582 <varlistentry>
7583 <term><anchor id="VALIDCHARS">valid chars (G)</term>
7584 <listitem><para>The option allows you to specify additional
7585 characters that should be considered valid by the server in
7586 filenames. This is particularly useful for national character
7587 sets, such as adding u-umlaut or a-ring.</para>
7589 <para>The option takes a list of characters in either integer
7590 or character form with spaces between them. If you give two
7591 characters with a colon between them then it will be taken as
7592 an lowercase:uppercase pair.</para>
7594 <para>If you have an editor capable of entering the characters
7595 into the config file then it is probably easiest to use this
7596 method. Otherwise you can specify the characters in octal,
7597 decimal or hexadecimal form using the usual C notation.</para>
7599 <para>For example to add the single character 'Z' to the charset
7600 (which is a pointless thing to do as it's already there) you could
7601 do one of the following</para>
7603 <para><programlisting>
7604 valid chars = Z
7605 valid chars = z:Z
7606 valid chars = 0132:0172
7607 </programlisting></para>
7609 <para>The last two examples above actually add two characters,
7610 and alter the uppercase and lowercase mappings appropriately.</para>
7612 <para>Note that you <emphasis>MUST</emphasis> specify this parameter
7613 after the <parameter>client code page</parameter> parameter if you
7614 have both set. If <parameter>client code page</parameter> is set after
7615 the <parameter>valid chars</parameter> parameter the <parameter>valid
7616 chars</parameter> settings will be overwritten.</para>
7618 <para>See also the <link linkend="CLIENTCODEPAGE"><parameter>client
7619 code page</parameter></link> parameter.</para>
7621 <para>Default: <emphasis>Samba defaults to using a reasonable set
7622 of valid characters for English systems</emphasis></para>
7624 <para>Example: <command>valid chars = 0345:0305 0366:0326 0344:0304
7625 </command></para>
7627 <para>The above example allows filenames to have the Swedish
7628 characters in them.</para>
7630 <para><emphasis>NOTE:</emphasis> It is actually quite difficult to
7631 correctly produce a <parameter>valid chars</parameter> line for
7632 a particular system. To automate the process <ulink
7633 url="mailto:tino@augsburg.net">tino@augsburg.net</ulink> has written
7634 a package called <command>validchars</command> which will automatically
7635 produce a complete <parameter>valid chars</parameter> line for
7636 a given client system. Look in the <filename>examples/validchars/
7637 </filename> subdirectory of your Samba source code distribution
7638 for this package.</para>
7639 </listitem>
7640 </varlistentry>
7644 <varlistentry>
7645 <term><anchor id="VALIDUSERS">valid users (S)</term>
7646 <listitem><para>This is a list of users that should be allowed
7647 to login to this service. Names starting with '@', '+' and '&'
7648 are interpreted using the same rules as described in the
7649 <parameter>invalid users</parameter> parameter.</para>
7651 <para>If this is empty (the default) then any user can login.
7652 If a username is in both this list and the <parameter>invalid
7653 users</parameter> list then access is denied for that user.</para>
7655 <para>The current servicename is substituted for <parameter>%S
7656 </parameter>. This is useful in the [homes] section.</para>
7658 <para>See also <link linkend="INVALIDUSERS"><parameter>invalid users
7659 </parameter></link></para>
7661 <para>Default: <emphasis>No valid users list (anyone can login)
7662 </emphasis></para>
7664 <para>Example: <command>valid users = greg, @pcusers</command></para>
7665 </listitem>
7666 </varlistentry>
7671 <varlistentry>
7672 <term><anchor id="VETOFILES">veto files(S)</term>
7673 <listitem><para>This is a list of files and directories that
7674 are neither visible nor accessible. Each entry in the list must
7675 be separated by a '/', which allows spaces to be included
7676 in the entry. '*' and '?' can be used to specify multiple files
7677 or directories as in DOS wildcards.</para>
7679 <para>Each entry must be a unix path, not a DOS path and
7680 must <emphasis>not</emphasis> include the unix directory
7681 separator '/'.</para>
7683 <para>Note that the <parameter>case sensitive</parameter> option
7684 is applicable in vetoing files.</para>
7686 <para>One feature of the veto files parameter that it is important
7687 to be aware of, is that if a directory contains nothing but files
7688 that match the veto files parameter (which means that Windows/DOS
7689 clients cannot ever see them) is deleted, the veto files within
7690 that directory <emphasis>are automatically deleted</emphasis> along
7691 with it, if the user has UNIX permissions to do so.</para>
7693 <para>Setting this parameter will affect the performance
7694 of Samba, as it will be forced to check all files and directories
7695 for a match as they are scanned.</para>
7697 <para>See also <link linkend="HIDEFILES"><parameter>hide files
7698 </parameter></link> and <link linkend="CASESENSITIVE"><parameter>
7699 case sensitive</parameter></link>.</para>
7701 <para>Default: <emphasis>No files or directories are vetoed.
7702 </emphasis></para>
7704 <para>Examples:<programlisting>
7705 ; Veto any files containing the word Security,
7706 ; any ending in .tmp, and any directory containing the
7707 ; word root.
7708 veto files = /*Security*/*.tmp/*root*/
7710 ; Veto the Apple specific files that a NetAtalk server
7711 ; creates.
7712 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
7713 </programlisting></para>
7714 </listitem>
7715 </varlistentry>
7718 <varlistentry>
7719 <term><anchor id="VETOOPLOCKFILES">veto oplock files (S)</term>
7720 <listitem><para>This parameter is only valid when the <link
7721 linkend="OPLOCKS"><parameter>oplocks</parameter></link>
7722 parameter is turned on for a share. It allows the Samba administrator
7723 to selectively turn off the granting of oplocks on selected files that
7724 match a wildcarded list, similar to the wildcarded list used in the
7725 <link linkend="VETOFILES"><parameter>veto files</parameter></link>
7726 parameter.</para>
7728 <para>Default: <emphasis>No files are vetoed for oplock
7729 grants</emphasis></para>
7731 <para>You might want to do this on files that you know will
7732 be heavily contended for by clients. A good example of this
7733 is in the NetBench SMB benchmark program, which causes heavy
7734 client contention for files ending in <filename>.SEM</filename>.
7735 To cause Samba not to grant oplocks on these files you would use
7736 the line (either in the [global] section or in the section for
7737 the particular NetBench share :</para>
7739 <para>Example: <command>veto oplock files = /*;.SEM/
7740 </command></para>
7741 </listitem>
7742 </varlistentry>
7746 <varlistentry>
7747 <term><anchor id="VFSOBJECT">vfs object (S)</term>
7748 <listitem><para>This parameter specifies a shared object file that
7749 is used for Samba VFS I/O operations. By default, normal
7750 disk I/O operations are used but these can be overloaded
7751 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
7752 must be enabled at compile time with --with-vfs.</para>
7754 <para>Default : <emphasis>no value</emphasis></para>
7755 </listitem>
7756 </varlistentry>
7761 <varlistentry>
7762 <term><anchor id="VFSOPTIONS">vfs options (S)</term>
7763 <listitem><para>This parameter allows parameters to be passed
7764 to the vfs layer at initialization time. The Samba VFS layer
7765 is new to Samba 2.2 and must be enabled at compile time
7766 with --with-vfs. See also <link linkend="VFSOBJECT"><parameter>
7767 vfs object</parameter></link>.</para>
7769 <para>Default : <emphasis>no value</emphasis></para>
7770 </listitem>
7771 </varlistentry>
7775 <varlistentry>
7776 <term><anchor id="VOLUME">volume (S)</term>
7777 <listitem><para> This allows you to override the volume label
7778 returned for a share. Useful for CDROMs with installation programs
7779 that insist on a particular volume label.</para>
7781 <para>Default: <emphasis>the name of the share</emphasis></para>
7782 </listitem>
7783 </varlistentry>
7787 <varlistentry>
7788 <term><anchor id="WIDELINKS">wide links (S)</term>
7789 <listitem><para>This parameter controls whether or not links
7790 in the UNIX file system may be followed by the server. Links
7791 that point to areas within the directory tree exported by the
7792 server are always allowed; this parameter controls access only
7793 to areas that are outside the directory tree being exported.</para>
7795 <para>Note that setting this parameter can have a negative
7796 effect on your server performance due to the extra system calls
7797 that Samba has to do in order to perform the link checks.</para>
7799 <para>Default: <command>wide links = yes</command></para>
7800 </listitem>
7801 </varlistentry>
7806 <varlistentry>
7807 <term><anchor id="WINBINDCACHETIME">winbind cache time</term>
7808 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7809 available in Samba 3.0.</para>
7811 <para>This parameter specifies the number of seconds the
7812 <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon will cache
7813 user and group information before querying a Windows NT server
7814 again.</para>
7816 <para>Default: <command>winbind cache type = 15</command></para>
7817 </listitem>
7818 </varlistentry>
7823 <varlistentry>
7824 <term><anchor id="WINBINDGID">winbind gid</term>
7825 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7826 available in Samba 3.0.</para>
7828 <para>The winbind gid parameter specifies the range of group
7829 ids that are allocated by the <ulink url="winbindd.8.html">
7830 winbindd(8)</ulink> daemon. This range of group ids should have no
7831 existing local or NIS groups within it as strange conflicts can
7832 occur otherwise.</para>
7834 <para>Default: <command>winbind gid = &lt;empty string&gt;
7835 </command></para>
7837 <para>Example: <command>winbind gid = 10000-20000</command></para>
7838 </listitem>
7839 </varlistentry>
7842 <varlistentry>
7843 <term><anchor id="WINBINDSEPARATOR">winbind separator</term>
7844 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7845 available in Samba 3.0.</para>
7847 <para>This parameter allows an admin to define the character
7848 used when listing a username of the form of <replaceable>DOMAIN
7849 </replaceable>\<replaceable>user</replaceable>. This parameter
7850 is only applicable when using the <filename>pam_winbind.so</filename>
7851 and <filename>nss_winbind.so</filename> modules for UNIX services.
7852 </para>
7854 <para>Example: <command>winbind separator = \</command></para>
7855 <para>Example: <command>winbind separator = +</command></para>
7856 </listitem>
7857 </varlistentry>
7862 <varlistentry>
7863 <term><anchor id="WINBINDUID">winbind uid</term>
7864 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7865 available in Samba 3.0.</para>
7867 <para>The winbind gid parameter specifies the range of group
7868 ids that are allocated by the <ulink url="winbindd.8.html">
7869 winbindd(8)</ulink> daemon. This range of ids should have no
7870 existing local or NIS users within it as strange conflicts can
7871 occur otherwise.</para>
7873 <para>Default: <command>winbind uid = &lt;empty string&gt;
7874 </command></para>
7876 <para>Example: <command>winbind uid = 10000-20000</command></para>
7877 </listitem>
7878 </varlistentry>
7884 <varlistentry>
7885 <term><anchor id="WINSHOOK">wins hook (G)</term>
7886 <listitem><para>When Samba is running as a WINS server this
7887 allows you to call an external program for all changes to the
7888 WINS database. The primary use for this option is to allow the
7889 dynamic update of external name resolution databases such as
7890 dynamic DNS.</para>
7892 <para>The wins hook parameter specifies the name of a script
7893 or executable that will be called as follows:</para>
7895 <para><command>wins_hook operation name nametype ttl IP_list
7896 </command></para>
7898 <itemizedlist>
7899 <listitem><para>The first argument is the operation and is one
7900 of "add", "delete", or "refresh". In most cases the operation can
7901 be ignored as the rest of the parameters provide sufficient
7902 information. Note that "refresh" may sometimes be called when the
7903 name has not previously been added, in that case it should be treated
7904 as an add.</para></listitem>
7906 <listitem><para>The second argument is the NetBIOS name. If the
7907 name is not a legal name then the wins hook is not called.
7908 Legal names contain only letters, digits, hyphens, underscores
7909 and periods.</para></listitem>
7911 <listitem><para>The third argument is the NetBIOS name
7912 type as a 2 digit hexadecimal number. </para></listitem>
7914 <listitem><para>The fourth argument is the TTL (time to live)
7915 for the name in seconds.</para></listitem>
7917 <listitem><para>The fifth and subsequent arguments are the IP
7918 addresses currently registered for that name. If this list is
7919 empty then the name should be deleted.</para></listitem>
7920 </itemizedlist>
7922 <para>An example script that calls the BIND dynamic DNS update
7923 program <command>nsupdate</command> is provided in the examples
7924 directory of the Samba source code. </para>
7925 </listitem>
7926 </varlistentry>
7932 <varlistentry>
7933 <term><anchor id="WINSPROXY">wins proxy (G)</term>
7934 <listitem><para>This is a boolean that controls if <ulink
7935 url="nmbd.8.html">nmbd(8)</ulink> will respond to broadcast name
7936 queries on behalf of other hosts. You may need to set this
7937 to <constant>yes</constant> for some older clients.</para>
7939 <para>Default: <command>wins proxy = no</command></para>
7940 </listitem>
7941 </varlistentry>
7946 <varlistentry>
7947 <term><anchor id="WINSSERVER">wins server (G)</term>
7948 <listitem><para>This specifies the IP address (or DNS name: IP
7949 address for preference) of the WINS server that <ulink url="nmbd.8.html">
7950 nmbd(8)</ulink> should register with. If you have a WINS server on
7951 your network then you should set this to the WINS server's IP.</para>
7953 <para>You should point this at your WINS server if you have a
7954 multi-subnetted network.</para>
7956 <para><emphasis>NOTE</emphasis>. You need to set up Samba to point
7957 to a WINS server if you have multiple subnets and wish cross-subnet
7958 browsing to work correctly.</para>
7960 <para>See the documentation file <filename>BROWSING.txt</filename>
7961 in the docs/ directory of your Samba source distribution.</para>
7963 <para>Default: <emphasis>not enabled</emphasis></para>
7964 <para>Example: <command>wins server = 192.9.200.1</command></para>
7965 </listitem>
7966 </varlistentry>
7970 <varlistentry>
7971 <term><anchor id="WINSSUPPORT">wins support (G)</term>
7972 <listitem><para>This boolean controls if the <ulink url="nmbd.8.html">
7973 nmbd(8)</ulink> process in Samba will act as a WINS server. You should
7974 not set this to <constant>true</constant> unless you have a multi-subnetted network and
7975 you wish a particular <command>nmbd</command> to be your WINS server.
7976 Note that you should <emphasis>NEVER</emphasis> set this to <constant>true</constant>
7977 on more than one machine in your network.</para>
7979 <para>Default: <command>wins support = no</command></para>
7980 </listitem>
7981 </varlistentry>
7985 <varlistentry>
7986 <term><anchor id="WORKGROUP">workgroup (G)</term>
7987 <listitem><para>This controls what workgroup your server will
7988 appear to be in when queried by clients. Note that this parameter
7989 also controls the Domain name used with the <link
7990 linkend="SECURITYEQUALSDOMAIN"><command>security=domain</command></link>
7991 setting.</para>
7993 <para>Default: <emphasis>set at compile time to WORKGROUP</emphasis></para>
7994 <para>Example: <command>workgroup = MYGROUP</command></para>
7995 </listitem>
7996 </varlistentry>
8001 <varlistentry>
8002 <term><anchor id="WRITABLE">writable (S)</term>
8003 <listitem><para>Synonym for <link linkend="WRITEABLE"><parameter>
8004 writeable</parameter></link> for people who can't spell :-).</para>
8005 </listitem>
8006 </varlistentry>
8010 <varlistentry>
8011 <term><anchor id="WRITECACHESIZE">write cache size (S)</term>
8012 <listitem><para>If this integer parameter is set to non-zero value,
8013 Samba will create an in-memory cache for each oplocked file
8014 (it does <emphasis>not</emphasis> do this for
8015 non-oplocked files). All writes that the client does not request
8016 to be flushed directly to disk will be stored in this cache if possible.
8017 The cache is flushed onto disk when a write comes in whose offset
8018 would not fit into the cache or when the file is closed by the client.
8019 Reads for the file are also served from this cache if the data is stored
8020 within it.</para>
8022 <para>This cache allows Samba to batch client writes into a more
8023 efficient write size for RAID disks (i.e. writes may be tuned to
8024 be the RAID stripe size) and can improve performance on systems
8025 where the disk subsystem is a bottleneck but there is free
8026 memory for userspace programs.</para>
8028 <para>The integer parameter specifies the size of this cache
8029 (per oplocked file) in bytes.</para>
8031 <para>Default: <command>write cache size = 0</command></para>
8032 <para>Example: <command>write cache size = 262144</command></para>
8034 <para>for a 256k cache size per file.</para>
8035 </listitem>
8036 </varlistentry>
8042 <varlistentry>
8043 <term><anchor id="WRITELIST">write list (S)</term>
8044 <listitem><para>This is a list of users that are given read-write
8045 access to a service. If the connecting user is in this list then
8046 they will be given write access, no matter what the <link
8047 linkend="WRITEABLE"><parameter>writeable</parameter></link>
8048 option is set to. The list can include group names using the
8049 @group syntax.</para>
8051 <para>Note that if a user is in both the read list and the
8052 write list then they will be given write access.</para>
8054 <para>See also the <link linkend="READLIST"><parameter>read list
8055 </parameter></link> option.</para>
8057 <para>Default: <command>write list = &lt;empty string&gt;
8058 </command></para>
8060 <para>Example: <command>write list = admin, root, @staff
8061 </command></para>
8062 </listitem>
8063 </varlistentry>
8069 <varlistentry>
8070 <term><anchor id="WRITEOK">write ok (S)</term>
8071 <listitem><para>Synonym for <link linkend="WRITEABLE"><parameter>
8072 writeable</parameter></link>.</para>
8073 </listitem>
8074 </varlistentry>
8078 <varlistentry>
8079 <term><anchor id="WRITERAW">write raw (G)</term>
8080 <listitem><para>This parameter controls whether or not the server
8081 will support raw write SMB's when transferring data from clients.
8082 You should never need to change this parameter.</para>
8084 <para>Default: <command>write raw = yes</command></para>
8085 </listitem>
8086 </varlistentry>
8090 <varlistentry>
8091 <term><anchor id="WRITEABLE">writeable (S)</term>
8092 <listitem><para>An inverted synonym is <link linkend="READONLY">
8093 <parameter>read only</parameter></link>.</para>
8095 <para>If this parameter is <constant>no</constant>, then users
8096 of a service may not create or modify files in the service's
8097 directory.</para>
8099 <para>Note that a printable service (<command>printable = yes</command>)
8100 will <emphasis>ALWAYS</emphasis> allow writing to the directory
8101 (user privileges permitting), but only via spooling operations.</para>
8103 <para>Default: <command>writeable = no</command></para>
8104 </listitem>
8105 </varlistentry>
8108 </variablelist>
8110 </refsect1>
8112 <refsect1>
8113 <title>WARNINGS</title>
8115 <para>Although the configuration file permits service names
8116 to contain spaces, your client software may not. Spaces will
8117 be ignored in comparisons anyway, so it shouldn't be a
8118 problem - but be aware of the possibility.</para>
8120 <para>On a similar note, many clients - especially DOS clients -
8121 limit service names to eight characters. <ulink url="smbd.8.html">smbd(8)
8122 </ulink> has no such limitation, but attempts to connect from such
8123 clients will fail if they truncate the service names. For this reason
8124 you should probably keep your service names down to eight characters
8125 in length.</para>
8127 <para>Use of the [homes] and [printers] special sections make life
8128 for an administrator easy, but the various combinations of default
8129 attributes can be tricky. Take extreme care when designing these
8130 sections. In particular, ensure that the permissions on spool
8131 directories are correct.</para>
8132 </refsect1>
8134 <refsect1>
8135 <title>VERSION</title>
8137 <para>This man page is correct for version 2.2 of
8138 the Samba suite.</para>
8139 </refsect1>
8141 <refsect1>
8142 <title>SEE ALSO</title>
8143 <para><ulink url="samba.7.html">samba(7)</ulink>,
8144 <ulink url="smbpasswd.8.html"><command>smbpasswd(8)</command></ulink>,
8145 <ulink url="swat.8.html"><command>swat(8)</command></ulink>,
8146 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>,
8147 <ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>,
8148 <ulink url="smbclient.1.html"><command>smbclient(1)</command></ulink>,
8149 <ulink url="nmblookup.1.html"><command>nmblookup(1)</command></ulink>,
8150 <ulink url="testparm.1.html"><command>testparm(1)</command></ulink>,
8151 <ulink url="testprns.1.html"><command>testprns(1)</command></ulink>
8152 </para>
8153 </refsect1>
8155 <refsect1>
8156 <title>AUTHOR</title>
8158 <para>The original Samba software and related utilities
8159 were created by Andrew Tridgell. Samba is now developed
8160 by the Samba Team as an Open Source project similar
8161 to the way the Linux kernel is developed.</para>
8163 <para>The original Samba man pages were written by Karl Auer.
8164 The man page sources were converted to YODL format (another
8165 excellent piece of Open Source software, available at
8166 <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
8167 ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
8168 release by Jeremy Allison. The conversion to DocBook for
8169 Samba 2.2 was done by Gerald Carter</para>
8170 </refsect1>
8172 </refentry>