syncing up with SAMBA_2_2
[Samba/gbeck.git] / docs / docbook / manpages / smb.conf.5.sgml
blob70b4cc1c8ee6a5aa9ca2f35e149669b2f4257f92
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 lowered. 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="HOMEDIRMAP"><parameter>homedir map</parameter></link></para></listitem>
628 <listitem><para><link linkend="HOSTMSDFS"><parameter>host msdfs</parameter></link></para></listitem>
629 <listitem><para><link linkend="HOSTSEQUIV"><parameter>hosts equiv</parameter></link></para></listitem>
630 <listitem><para><link linkend="INTERFACES"><parameter>interfaces</parameter></link></para></listitem>
631 <listitem><para><link linkend="KEEPALIVE"><parameter>keepalive</parameter></link></para></listitem>
632 <listitem><para><link linkend="KERNELOPLOCKS"><parameter>kernel oplocks</parameter></link></para></listitem>
633 <listitem><para><link linkend="LANMANAUTH"><parameter>lanman auth</parameter></link></para></listitem>
634 <listitem><para><link linkend="LMANNOUNCE"><parameter>lm announce</parameter></link></para></listitem>
635 <listitem><para><link linkend="LMINTERVAL"><parameter>lm interval</parameter></link></para></listitem>
636 <listitem><para><link linkend="LOADPRINTERS"><parameter>load printers</parameter></link></para></listitem>
637 <listitem><para><link linkend="LOCALMASTER"><parameter>local master</parameter></link></para></listitem>
638 <listitem><para><link linkend="LOCKDIR"><parameter>lock dir</parameter></link></para></listitem>
639 <listitem><para><link linkend="LOCKDIRECTORY"><parameter>lock directory</parameter></link></para></listitem>
640 <listitem><para><link linkend="LOGFILE"><parameter>log file</parameter></link></para></listitem>
641 <listitem><para><link linkend="LOGLEVEL"><parameter>log level</parameter></link></para></listitem>
642 <listitem><para><link linkend="LOGONDRIVE"><parameter>logon drive</parameter></link></para></listitem>
643 <listitem><para><link linkend="LOGONHOME"><parameter>logon home</parameter></link></para></listitem>
644 <listitem><para><link linkend="LOGONPATH"><parameter>logon path</parameter></link></para></listitem>
645 <listitem><para><link linkend="LOGONSCRIPT"><parameter>logon script</parameter></link></para></listitem>
646 <listitem><para><link linkend="LPQCACHETIME"><parameter>lpq cache time</parameter></link></para></listitem>
647 <listitem><para><link linkend="MACHINEPASSWORDTIMEOUT"><parameter>machine password timeout</parameter></link></para></listitem>
648 <listitem><para><link linkend="MANGLEDSTACK"><parameter>mangled stack</parameter></link></para></listitem>
649 <listitem><para><link linkend="MAPTOGUEST"><parameter>map to guest</parameter></link></para></listitem>
650 <listitem><para><link linkend="MAXDISKSIZE"><parameter>max disk size</parameter></link></para></listitem>
651 <listitem><para><link linkend="MAXLOGSIZE"><parameter>max log size</parameter></link></para></listitem>
652 <listitem><para><link linkend="MAXMUX"><parameter>max mux</parameter></link></para></listitem>
653 <listitem><para><link linkend="MAXOPENFILES"><parameter>max open files</parameter></link></para></listitem>
654 <listitem><para><link linkend="MAXPROTOCOL"><parameter>max protocol</parameter></link></para></listitem>
655 <listitem><para><link linkend="MAXSMBDPROCESSES"><parameter>max smbd processes</parameter></link></para></listitem>
656 <listitem><para><link linkend="MAXTTL"><parameter>max ttl</parameter></link></para></listitem>
657 <listitem><para><link linkend="MAXWINSTTL"><parameter>max wins ttl</parameter></link></para></listitem>
658 <listitem><para><link linkend="MAXXMIT"><parameter>max xmit</parameter></link></para></listitem>
659 <listitem><para><link linkend="MESSAGECOMMAND"><parameter>message command</parameter></link></para></listitem>
660 <listitem><para><link linkend="MINPASSWDLENGTH"><parameter>min passwd length</parameter></link></para></listitem>
661 <listitem><para><link linkend="MINPASSWORDLENGTH"><parameter>min password length</parameter></link></para></listitem>
662 <listitem><para><link linkend="MINPROTOCOL"><parameter>min protocol</parameter></link></para></listitem>
663 <listitem><para><link linkend="MINWINSTTL"><parameter>min wins ttl</parameter></link></para></listitem>
664 <listitem><para><link linkend="NAMERESOLVEORDER"><parameter>name resolve order</parameter></link></para></listitem>
665 <listitem><para><link linkend="NETBIOSALIASES"><parameter>netbios aliases</parameter></link></para></listitem>
666 <listitem><para><link linkend="NETBIOSNAME"><parameter>netbios name</parameter></link></para></listitem>
667 <listitem><para><link linkend="NETBIOSSCOPE"><parameter>netbios scope</parameter></link></para></listitem>
668 <listitem><para><link linkend="NISHOMEDIR"><parameter>nis homedir</parameter></link></para></listitem>
669 <listitem><para><link linkend="NTACLSUPPORT"><parameter>nt acl support</parameter></link></para></listitem>
670 <listitem><para><link linkend="NTPIPESUPPORT"><parameter>nt pipe support</parameter></link></para></listitem>
671 <listitem><para><link linkend="NTSMBSUPPORT"><parameter>nt smb support</parameter></link></para></listitem>
672 <listitem><para><link linkend="NULLPASSWORDS"><parameter>null passwords</parameter></link></para></listitem>
673 <listitem><para><link linkend="OBEYPAMRESTRICTIONS"><parameter>obey pam restrictions</parameter></link></para></listitem>
674 <listitem><para><link linkend="OPLOCKBREAKWAITTIME"><parameter>oplock break wait time</parameter></link></para></listitem>
675 <listitem><para><link linkend="OSLEVEL"><parameter>os level</parameter></link></para></listitem>
676 <listitem><para><link linkend="OS2DRIVERMAP"><parameter>os2 driver map</parameter></link></para></listitem>
677 <listitem><para><link linkend="PAMPASSWORDCHANGE"><parameter>pam password change</parameter></link></para></listitem>
678 <listitem><para><link linkend="PANICACTION"><parameter>panic action</parameter></link></para></listitem>
679 <listitem><para><link linkend="PASSWDCHAT"><parameter>passwd chat</parameter></link></para></listitem>
680 <listitem><para><link linkend="PASSWDCHATDEBUG"><parameter>passwd chat debug</parameter></link></para></listitem>
681 <listitem><para><link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter></link></para></listitem>
682 <listitem><para><link linkend="PASSWORDLEVEL"><parameter>password level</parameter></link></para></listitem>
683 <listitem><para><link linkend="PASSWORDSERVER"><parameter>password server</parameter></link></para></listitem>
684 <listitem><para><link linkend="PREFEREDMASTER"><parameter>prefered master</parameter></link></para></listitem>
685 <listitem><para><link linkend="PREFERREDMASTER"><parameter>preferred master</parameter></link></para></listitem>
686 <listitem><para><link linkend="PRELOAD"><parameter>preload</parameter></link></para></listitem>
687 <listitem><para><link linkend="PRINTCAP"><parameter>printcap</parameter></link></para></listitem>
688 <listitem><para><link linkend="PRINTCAPNAME"><parameter>printcap name</parameter></link></para></listitem>
689 <listitem><para><link linkend="PRINTERDRIVERFILE"><parameter>printer driver file</parameter></link></para></listitem>
690 <listitem><para><link linkend="PROTOCOL"><parameter>protocol</parameter></link></para></listitem>
691 <listitem><para><link linkend="READBMPX"><parameter>read bmpx</parameter></link></para></listitem>
692 <listitem><para><link linkend="READRAW"><parameter>read raw</parameter></link></para></listitem>
693 <listitem><para><link linkend="READSIZE"><parameter>read size</parameter></link></para></listitem>
694 <listitem><para><link linkend="REMOTEANNOUNCE"><parameter>remote announce</parameter></link></para></listitem>
695 <listitem><para><link linkend="REMOTEBROWSESYNC"><parameter>remote browse sync</parameter></link></para></listitem>
696 <listitem><para><link linkend="RESTRICTANONYMOUS"><parameter>restrict anonymous</parameter></link></para></listitem>
697 <listitem><para><link linkend="ROOT"><parameter>root</parameter></link></para></listitem>
698 <listitem><para><link linkend="ROOTDIR"><parameter>root dir</parameter></link></para></listitem>
699 <listitem><para><link linkend="ROOTDIRECTORY"><parameter>root directory</parameter></link></para></listitem>
700 <listitem><para><link linkend="SECURITY"><parameter>security</parameter></link></para></listitem>
701 <listitem><para><link linkend="SERVERSTRING"><parameter>server string</parameter></link></para></listitem>
702 <listitem><para><link linkend="SHOWADDPRINTERWIZARD"><parameter>show add printer wizard</parameter></link></para></listitem>
703 <listitem><para><link linkend="SMBPASSWDFILE"><parameter>smb passwd file</parameter></link></para></listitem>
704 <listitem><para><link linkend="SOCKETADDRESS"><parameter>socket address</parameter></link></para></listitem>
705 <listitem><para><link linkend="SOCKETOPTIONS"><parameter>socket options</parameter></link></para></listitem>
706 <listitem><para><link linkend="SOURCEENVIRONMENT"><parameter>source environment</parameter></link></para></listitem>
707 <listitem><para><link linkend="SSL"><parameter>ssl</parameter></link></para></listitem>
708 <listitem><para><link linkend="SSLCACERTDIR"><parameter>ssl CA certDir</parameter></link></para></listitem>
709 <listitem><para><link linkend="SSLCACERTFILE"><parameter>ssl CA certFile</parameter></link></para></listitem>
710 <listitem><para><link linkend="SSLCIPHERS"><parameter>ssl ciphers</parameter></link></para></listitem>
711 <listitem><para><link linkend="SSLCLIENTCERT"><parameter>ssl client cert</parameter></link></para></listitem>
712 <listitem><para><link linkend="SSLCLIENTKEY"><parameter>ssl client key</parameter></link></para></listitem>
713 <listitem><para><link linkend="SSLCOMPATIBILITY"><parameter>ssl compatibility</parameter></link></para></listitem>
714 <listitem><para><link linkend="SSLHOSTS"><parameter>ssl hosts</parameter></link></para></listitem>
715 <listitem><para><link linkend="SSLHOSTSRESIGN"><parameter>ssl hosts resign</parameter></link></para></listitem>
716 <listitem><para><link linkend="SSLREQUIRECLIENTCERT"><parameter>ssl require clientcert</parameter></link></para></listitem>
717 <listitem><para><link linkend="SSLREQUIRESERVERCERT"><parameter>ssl require servercert</parameter></link></para></listitem>
718 <listitem><para><link linkend="SSLSERVERCERT"><parameter>ssl server cert</parameter></link></para></listitem>
719 <listitem><para><link linkend="SSLSERVERKEY"><parameter>ssl server key</parameter></link></para></listitem>
720 <listitem><para><link linkend="SSLVERSION"><parameter>ssl version</parameter></link></para></listitem>
721 <listitem><para><link linkend="STATCACHE"><parameter>stat cache</parameter></link></para></listitem>
722 <listitem><para><link linkend="STATCACHESIZE"><parameter>stat cache size</parameter></link></para></listitem>
723 <listitem><para><link linkend="STRIPDOT"><parameter>strip dot</parameter></link></para></listitem>
724 <listitem><para><link linkend="SYSLOG"><parameter>syslog</parameter></link></para></listitem>
725 <listitem><para><link linkend="SYSLOGONLY"><parameter>syslog only</parameter></link></para></listitem>
726 <listitem><para><link linkend="TEMPLATEHOMEDIR"><parameter>template homedir</parameter></link></para></listitem>
727 <listitem><para><link linkend="TEMPLATESHELL"><parameter>template shell</parameter></link></para></listitem>
728 <listitem><para><link linkend="TIMEOFFSET"><parameter>time offset</parameter></link></para></listitem>
729 <listitem><para><link linkend="TIMESERVER"><parameter>time server</parameter></link></para></listitem>
730 <listitem><para><link linkend="TIMESTAMPLOGS"><parameter>timestamp logs</parameter></link></para></listitem>
731 <listitem><para><link linkend="TOTALPRINTJOBS"><parameter>total print jobs</parameter></link></para></listitem>
732 <listitem><para><link linkend="UNIXPASSWORDSYNC"><parameter>unix password sync</parameter></link></para></listitem>
733 <listitem><para><link linkend="UPDATEENCRYPTED"><parameter>update encrypted</parameter></link></para></listitem>
734 <listitem><para><link linkend="USERHOSTS"><parameter>use rhosts</parameter></link></para></listitem>
735 <listitem><para><link linkend="USERNAMELEVEL"><parameter>username level</parameter></link></para></listitem>
736 <listitem><para><link linkend="USERNAMEMAP"><parameter>username map</parameter></link></para></listitem>
737 <listitem><para><link linkend="UTMPDIRECTORY"><parameter>utmp directory</parameter></link></para></listitem>
738 <listitem><para><link linkend="VALIDCHARS"><parameter>valid chars</parameter></link></para></listitem>
739 <listitem><para><link linkend="WINBINDCACHETIME"><parameter>winbind cache time</parameter></link></para></listitem>
740 <listitem><para><link linkend="WINBINDGID"><parameter>winbind gid</parameter></link></para></listitem>
741 <listitem><para><link linkend="WINBINDSEPARATOR"><parameter>winbind separator</parameter></link></para></listitem>
742 <listitem><para><link linkend="WINBINDUID"><parameter>winbind uid</parameter></link></para></listitem>
743 <listitem><para><link linkend="WINSHOOK"><parameter>wins hook</parameter></link></para></listitem>
744 <listitem><para><link linkend="WINSPROXY"><parameter>wins proxy</parameter></link></para></listitem>
745 <listitem><para><link linkend="WINSSERVER"><parameter>wins server</parameter></link></para></listitem>
746 <listitem><para><link linkend="WINSSUPPORT"><parameter>wins support</parameter></link></para></listitem>
747 <listitem><para><link linkend="WORKGROUP"><parameter>workgroup</parameter></link></para></listitem>
748 <listitem><para><link linkend="WRITERAW"><parameter>write raw</parameter></link></para></listitem>
749 </itemizedlist>
751 </refsect1>
753 <refsect1>
754 <title>COMPLETE LIST OF SERVICE PARAMETERS</title>
756 <para>Here is a list of all service parameters. See the section on
757 each parameter for details. Note that some are synonyms.</para>
759 <itemizedlist>
760 <listitem><para><link linkend="ADMINUSERS"><parameter>admin users</parameter></link></para></listitem>
761 <listitem><para><link linkend="ALLOWHOSTS"><parameter>allow hosts</parameter></link></para></listitem>
762 <listitem><para><link linkend="AVAILABLE"><parameter>available</parameter></link></para></listitem>
763 <listitem><para><link linkend="BLOCKINGLOCKS"><parameter>blocking locks</parameter></link></para></listitem>
764 <listitem><para><link linkend="BROWSABLE"><parameter>browsable</parameter></link></para></listitem>
765 <listitem><para><link linkend="BROWSEABLE"><parameter>browseable</parameter></link></para></listitem>
766 <listitem><para><link linkend="CASESENSITIVE"><parameter>case sensitive</parameter></link></para></listitem>
767 <listitem><para><link linkend="CASESIGNAMES"><parameter>casesignames</parameter></link></para></listitem>
768 <listitem><para><link linkend="COMMENT"><parameter>comment</parameter></link></para></listitem>
769 <listitem><para><link linkend="COPY"><parameter>copy</parameter></link></para></listitem>
770 <listitem><para><link linkend="CREATEMASK"><parameter>create mask</parameter></link></para></listitem>
771 <listitem><para><link linkend="CREATEMODE"><parameter>create mode</parameter></link></para></listitem>
772 <listitem><para><link linkend="DEFAULTCASE"><parameter>default case</parameter></link></para></listitem>
773 <listitem><para><link linkend="DELETEREADONLY"><parameter>delete readonly</parameter></link></para></listitem>
774 <listitem><para><link linkend="DELETEVETOFILES"><parameter>delete veto files</parameter></link></para></listitem>
775 <listitem><para><link linkend="DENYHOSTS"><parameter>deny hosts</parameter></link></para></listitem>
776 <listitem><para><link linkend="DIRECTORY"><parameter>directory</parameter></link></para></listitem>
777 <listitem><para><link linkend="DIRECTORYMASK"><parameter>directory mask</parameter></link></para></listitem>
778 <listitem><para><link linkend="DIRECTORYMODE"><parameter>directory mode</parameter></link></para></listitem>
779 <listitem><para><link linkend="DIRECTORYSECURITYMASK"><parameter>directory security mask</parameter></link></para></listitem>
780 <listitem><para><link linkend="DONTDESCEND"><parameter>dont descend</parameter></link></para></listitem>
781 <listitem><para><link linkend="DOSFILEMODE"><parameter>dos filemode</parameter></link></para></listitem>
782 <listitem><para><link linkend="DOSFILETIMERESOLUTION"><parameter>dos filetime resolution</parameter></link></para></listitem>
783 <listitem><para><link linkend="DOSFILETIMES"><parameter>dos filetimes</parameter></link></para></listitem>
784 <listitem><para><link linkend="EXEC"><parameter>exec</parameter></link></para></listitem>
785 <listitem><para><link linkend="FAKEDIRECTORYCREATETIMES"><parameter>fake directory create times</parameter></link></para></listitem>
786 <listitem><para><link linkend="FAKEOPLOCKS"><parameter>fake oplocks</parameter></link></para></listitem>
787 <listitem><para><link linkend="FOLLOWSYMLINKS"><parameter>follow symlinks</parameter></link></para></listitem>
788 <listitem><para><link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link></para></listitem>
789 <listitem><para><link linkend="FORCEDIRECTORYMODE"><parameter>force directory mode</parameter></link></para></listitem>
790 <listitem><para><link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>force directory security mode</parameter></link></para></listitem>
791 <listitem><para><link linkend="FORCEGROUP"><parameter>force group</parameter></link></para></listitem>
792 <listitem><para><link linkend="FORCESECURITYMODE"><parameter>force security mode</parameter></link></para></listitem>
793 <listitem><para><link linkend="FORCEUSER"><parameter>force user</parameter></link></para></listitem>
794 <listitem><para><link linkend="FSTYPE"><parameter>fstype</parameter></link></para></listitem>
795 <listitem><para><link linkend="GROUP"><parameter>group</parameter></link></para></listitem>
796 <listitem><para><link linkend="GUESTACCOUNT"><parameter>guest account</parameter></link></para></listitem>
797 <listitem><para><link linkend="GUESTOK"><parameter>guest ok</parameter></link></para></listitem>
798 <listitem><para><link linkend="GUESTONLY"><parameter>guest only</parameter></link></para></listitem>
799 <listitem><para><link linkend="HIDEDOTFILES"><parameter>hide dot files</parameter></link></para></listitem>
800 <listitem><para><link linkend="HIDEFILES"><parameter>hide files</parameter></link></para></listitem>
801 <listitem><para><link linkend="HOSTSALLOW"><parameter>hosts allow</parameter></link></para></listitem>
802 <listitem><para><link linkend="HOSTSDENY"><parameter>hosts deny</parameter></link></para></listitem>
803 <listitem><para><link linkend="INCLUDE"><parameter>include</parameter></link></para></listitem>
804 <listitem><para><link linkend="INHERITPERMISSIONS"><parameter>inherit permissions</parameter></link></para></listitem>
805 <listitem><para><link linkend="INVALIDUSERS"><parameter>invalid users</parameter></link></para></listitem>
806 <listitem><para><link linkend="LEVEL2OPLOCKS"><parameter>level2 oplocks</parameter></link></para></listitem>
807 <listitem><para><link linkend="LOCKING"><parameter>locking</parameter></link></para></listitem>
808 <listitem><para><link linkend="LPPAUSECOMMAND"><parameter>lppause command</parameter></link></para></listitem>
809 <listitem><para><link linkend="LPQCOMMAND"><parameter>lpq command</parameter></link></para></listitem>
810 <listitem><para><link linkend="LPRESUMECOMMAND"><parameter>lpresume command</parameter></link></para></listitem>
811 <listitem><para><link linkend="LPRMCOMMAND"><parameter>lprm command</parameter></link></para></listitem>
812 <listitem><para><link linkend="MAGICOUTPUT"><parameter>magic output</parameter></link></para></listitem>
813 <listitem><para><link linkend="MAGICSCRIPT"><parameter>magic script</parameter></link></para></listitem>
814 <listitem><para><link linkend="MANGLECASE"><parameter>mangle case</parameter></link></para></listitem>
815 <listitem><para><link linkend="MANGLEDMAP"><parameter>mangled map</parameter></link></para></listitem>
816 <listitem><para><link linkend="MANGLEDNAMES"><parameter>mangled names</parameter></link></para></listitem>
817 <listitem><para><link linkend="MANGLINGCHAR"><parameter>mangling char</parameter></link></para></listitem>
818 <listitem><para><link linkend="MAPARCHIVE"><parameter>map archive</parameter></link></para></listitem>
819 <listitem><para><link linkend="MAPHIDDEN"><parameter>map hidden</parameter></link></para></listitem>
820 <listitem><para><link linkend="MAPSYSTEM"><parameter>map system</parameter></link></para></listitem>
821 <listitem><para><link linkend="MAXCONNECTIONS"><parameter>max connections</parameter></link></para></listitem>
822 <listitem><para><link linkend="MAXPRINTJOBS"><parameter>max print jobs</parameter></link></para></listitem>
823 <listitem><para><link linkend="MINPRINTSPACE"><parameter>min print space</parameter></link></para></listitem>
824 <listitem><para><link linkend="MSDFSROOT"><parameter>msdfs root</parameter></link></para></listitem>
825 <listitem><para><link linkend="ONLYGUEST"><parameter>only guest</parameter></link></para></listitem>
826 <listitem><para><link linkend="ONLYUSER"><parameter>only user</parameter></link></para></listitem>
827 <listitem><para><link linkend="OPLOCKCONTENTIONLIMIT"><parameter>oplock contention limit</parameter></link></para></listitem>
828 <listitem><para><link linkend="OPLOCKS"><parameter>oplocks</parameter></link></para></listitem>
829 <listitem><para><link linkend="PATH"><parameter>path</parameter></link></para></listitem>
830 <listitem><para><link linkend="POSIXLOCKING"><parameter>posix locking</parameter></link></para></listitem>
831 <listitem><para><link linkend="POSTEXEC"><parameter>postexec</parameter></link></para></listitem>
832 <listitem><para><link linkend="POSTSCRIPT"><parameter>postscript</parameter></link></para></listitem>
833 <listitem><para><link linkend="PREEXEC"><parameter>preexec</parameter></link></para></listitem>
834 <listitem><para><link linkend="PREEXECCLOSE"><parameter>preexec close</parameter></link></para></listitem>
835 <listitem><para><link linkend="PRESERVECASE"><parameter>preserve case</parameter></link></para></listitem>
836 <listitem><para><link linkend="PRINTCOMMAND"><parameter>print command</parameter></link></para></listitem>
837 <listitem><para><link linkend="PRINTOK"><parameter>print ok</parameter></link></para></listitem>
838 <listitem><para><link linkend="PRINTABLE"><parameter>printable</parameter></link></para></listitem>
839 <listitem><para><link linkend="PRINTER"><parameter>printer</parameter></link></para></listitem>
840 <listitem><para><link linkend="PRINTERADMIN"><parameter>printer admin</parameter></link></para></listitem>
841 <listitem><para><link linkend="PRINTERDRIVER"><parameter>printer driver</parameter></link></para></listitem>
842 <listitem><para><link linkend="PRINTERDRIVERLOCATION"><parameter>printer driver location</parameter></link></para></listitem>
843 <listitem><para><link linkend="PRINTERNAME"><parameter>printer name</parameter></link></para></listitem>
844 <listitem><para><link linkend="PRINTING"><parameter>printing</parameter></link></para></listitem>
845 <listitem><para><link linkend="PUBLIC"><parameter>public</parameter></link></para></listitem>
846 <listitem><para><link linkend="QUEUEPAUSECOMMAND"><parameter>queuepause command</parameter></link></para></listitem>
847 <listitem><para><link linkend="QUEUERESUMECOMMAND"><parameter>queueresume command</parameter></link></para></listitem>
848 <listitem><para><link linkend="READLIST"><parameter>read list</parameter></link></para></listitem>
849 <listitem><para><link linkend="READONLY"><parameter>read only</parameter></link></para></listitem>
850 <listitem><para><link linkend="ROOTPOSTEXEC"><parameter>root postexec</parameter></link></para></listitem>
851 <listitem><para><link linkend="ROOTPREEXEC"><parameter>root preexec</parameter></link></para></listitem>
852 <listitem><para><link linkend="ROOTPREEXECCLOSE"><parameter>root preexec close</parameter></link></para></listitem>
853 <listitem><para><link linkend="SECURITYMASK"><parameter>security mask</parameter></link></para></listitem>
854 <listitem><para><link linkend="SETDIRECTORY"><parameter>set directory</parameter></link></para></listitem>
855 <listitem><para><link linkend="SHAREMODES"><parameter>share modes</parameter></link></para></listitem>
856 <listitem><para><link linkend="SHORTPRESERVECASE"><parameter>short preserve case</parameter></link></para></listitem>
857 <listitem><para><link linkend="STATUS"><parameter>status</parameter></link></para></listitem>
858 <listitem><para><link linkend="STRICTLOCKING"><parameter>strict locking</parameter></link></para></listitem>
859 <listitem><para><link linkend="STRICTSYNC"><parameter>strict sync</parameter></link></para></listitem>
860 <listitem><para><link linkend="SYNCALWAYS"><parameter>sync always</parameter></link></para></listitem>
861 <listitem><para><link linkend="USER"><parameter>user</parameter></link></para></listitem>
862 <listitem><para><link linkend="USERNAME"><parameter>username</parameter></link></para></listitem>
863 <listitem><para><link linkend="USERS"><parameter>users</parameter></link></para></listitem>
864 <listitem><para><link linkend="UTMP"><parameter>utmp</parameter></link></para></listitem>
865 <listitem><para><link linkend="VALIDUSERS"><parameter>valid users</parameter></link></para></listitem>
866 <listitem><para><link linkend="VETOFILES"><parameter>veto files</parameter></link></para></listitem>
867 <listitem><para><link linkend="VETOOPLOCKFILES"><parameter>veto oplock files</parameter></link></para></listitem>
868 <listitem><para><link linkend="VFSOBJECT"><parameter>vfs object</parameter></link></para></listitem>
869 <listitem><para><link linkend="VFSOPTIONS"><parameter>vfs options</parameter></link></para></listitem>
870 <listitem><para><link linkend="VOLUME"><parameter>volume</parameter></link></para></listitem>
871 <listitem><para><link linkend="WIDELINKS"><parameter>wide links</parameter></link></para></listitem>
872 <listitem><para><link linkend="WRITABLE"><parameter>writable</parameter></link></para></listitem>
873 <listitem><para><link linkend="WRITECACHESIZE"><parameter>write cache size</parameter></link></para></listitem>
874 <listitem><para><link linkend="WRITELIST"><parameter>write list</parameter></link></para></listitem>
875 <listitem><para><link linkend="WRITEOK"><parameter>write ok</parameter></link></para></listitem>
876 <listitem><para><link linkend="WRITEABLE"><parameter>writeable</parameter></link></para></listitem>
877 </itemizedlist>
879 </refsect1>
881 <refsect1>
882 <title>EXPLANATION OF EACH PARAMETER</title>
884 <variablelist>
887 <varlistentry>
888 <term><anchor id="ADDPRINTERCOMMAND">add printer command (G)</term>
889 <listitem><para>With the introduction of MS-RPC based printing
890 support for Windows NT/2000 clients in Samba 2.2, The MS Add
891 Printer Wizard (APW) icon is now also available in the
892 "Printers..." folder displayed a share listing. The APW
893 allows for printers to be add remotely to a Samba or Windows
894 NT/2000 print server.</para>
896 <para>For a Samba host this means that the printer must be
897 physically added to underlying printing system. The <parameter>add
898 printer command</parameter> defines a script to be run which
899 will perform the necessary operations for adding the printer
900 to the print system and to add the appropriate service definition
901 to the <filename>smb.conf</filename> file in order that it can be
902 shared by <ulink url="smbd.8.html"><command>smbd(8)</command>
903 </ulink>.</para>
905 <para>The <parameter>add printer command</parameter> is
906 automatically invoked with the following parameter (in
907 order:</para>
909 <itemizedlist>
910 <listitem><para><parameter>printer name</parameter></para></listitem>
911 <listitem><para><parameter>share name</parameter></para></listitem>
912 <listitem><para><parameter>port name</parameter></para></listitem>
913 <listitem><para><parameter>driver name</parameter></para></listitem>
914 <listitem><para><parameter>location</parameter></para></listitem>
915 <listitem><para><parameter>Windows 9x driver location</parameter>
916 </para></listitem>
917 </itemizedlist>
919 <para>All parameters are filled in from the PRINTER_INFO_2 structure sent
920 by the Windows NT/2000 client with one exception. The "Windows 9x
921 driver location" parameter is included for backwards compatibility
922 only. The remaining fields in the structure are generated from answers
923 to the APW questions.</para>
925 <para>Once the <parameter>add printer command</parameter> has
926 been executed, <command>smbd</command> will reparse the <filename>
927 smb.conf</filename> to determine if the share defined by the APW
928 exists. If the sharename is still invalid, then <command>smbd
929 </command> will return an ACCESS_DENIED error to the client.</para>
931 <para>See also <link linkend="DELETEPRINTERCOMMAND"><parameter>
932 delete printer command</parameter></link>, <link
933 linkend="printing"><parameter>printing</parameter></link>,
934 <link linkend="SHOWADDPRINTERWIZARD"><parameter>show add
935 printer wizard</parameter></link></para>
937 <para>Default: <emphasis>none</emphasis></para>
938 <para>Example: <command>addprinter command = /usr/bin/addprinter
939 </command></para>
940 </listitem>
941 </varlistentry>
945 <varlistentry>
946 <term><anchor id="ADDSHARECOMMAND">add share command (G)</term>
947 <listitem><para>Samba 2.2.0 introduced the ability to dynamically
948 add and delete shares via the Windows NT 4.0 Server Manager. The
949 <parameter>add share command</parameter> is used to define an
950 external program or script which will add a new service definition
951 to <filename>smb.conf</filename>. In order to successfully
952 execute the <parameter>add share command</parameter>, <command>smbd</command>
953 requires that the administrator be connected using a root account (i.e.
954 uid == 0).
955 </para>
957 <para>
958 When executed, <command>smbd</command> will automatically invoke the
959 <parameter>add share command</parameter> with four parameters.
960 </para>
962 <itemizedlist>
963 <listitem><para><parameter>configFile</parameter> - the location
964 of the global <filename>smb.conf</filename> file.
965 </para></listitem>
967 <listitem><para><parameter>shareName</parameter> - the name of the new
968 share.
969 </para></listitem>
971 <listitem><para><parameter>pathName</parameter> - path to an **existing**
972 directory on disk.
973 </para></listitem>
975 <listitem><para><parameter>comment</parameter> - comment string to associate
976 with the new share.
977 </para></listitem>
978 </itemizedlist>
980 <para>
981 This parameter is only used for add file shares. To add printer shares,
982 see the <link linkend="ADDPRINTERCOMMAND"><parameter>add printer
983 command</parameter></link>.
984 </para>
986 <para>
987 See also <link linkend="CHANGESHARECOMMAND"><parameter>change share
988 command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter>delete share
989 command</parameter></link>.
990 </para>
992 <para>Default: <emphasis>none</emphasis></para>
993 <para>Example: <command>add share command = /usr/local/bin/addshare</command></para>
994 </listitem>
995 </varlistentry>
999 <varlistentry>
1000 <term><anchor id="ADDUSERSCRIPT">add user script (G)</term>
1001 <listitem><para>This is the full pathname to a script that will
1002 be run <emphasis>AS ROOT</emphasis> by <ulink url="smbd.8.html">smbd(8)
1003 </ulink> under special circumstances described below.</para>
1005 <para>Normally, a Samba server requires that UNIX users are
1006 created for all users accessing files on this server. For sites
1007 that use Windows NT account databases as their primary user database
1008 creating these users and keeping the user list in sync with the
1009 Windows NT PDC is an onerous task. This option allows <ulink
1010 url="smbd.8.html">smbd</ulink> to create the required UNIX users
1011 <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.</para>
1013 <para>In order to use this option, <ulink url="smbd.8.html">smbd</ulink>
1014 must be set to <parameter>security=server</parameter> or <parameter>
1015 security=domain</parameter> and <parameter>add user script</parameter>
1016 must be set to a full pathname for a script that will create a UNIX
1017 user given one argument of <parameter>%u</parameter>, which expands into
1018 the UNIX user name to create.</para>
1020 <para>When the Windows user attempts to access the Samba server,
1021 at login (session setup in the SMB protocol) time, <ulink url="smbd.8.html">
1022 smbd</ulink> contacts the <parameter>password server</parameter> and
1023 attempts to authenticate the given user with the given password. If the
1024 authentication succeeds then <command>smbd</command>
1025 attempts to find a UNIX user in the UNIX password database to map the
1026 Windows user into. If this lookup fails, and <parameter>add user script
1027 </parameter> is set then <command>smbd</command> will
1028 call the specified script <emphasis>AS ROOT</emphasis>, expanding
1029 any <parameter>%u</parameter> argument to be the user name to create.</para>
1031 <para>If this script successfully creates the user then <command>smbd
1032 </command> will continue on as though the UNIX user
1033 already existed. In this way, UNIX users are dynamically created to
1034 match existing Windows NT accounts.</para>
1036 <para>See also <link linkend="SECURITY"><parameter>
1037 security</parameter></link>, <link linkend="PASSWORDSERVER">
1038 <parameter>password server</parameter></link>,
1039 <link linkend="DELETEUSERSCRIPT"><parameter>delete user
1040 script</parameter></link>.</para>
1042 <para>Default: <command>add user script = &lt;empty string&gt;
1043 </command></para>
1045 <para>Example: <command>add user script = /usr/local/samba/bin/add_user
1046 %u</command></para>
1047 </listitem>
1048 </varlistentry>
1052 <varlistentry>
1053 <term><anchor id="ADMINUSERS">admin users (S)</term>
1054 <listitem><para>This is a list of users who will be granted
1055 administrative privileges on the share. This means that they
1056 will do all file operations as the super-user (root).</para>
1058 <para>You should use this option very carefully, as any user in
1059 this list will be able to do anything they like on the share,
1060 irrespective of file permissions.</para>
1062 <para>Default: <emphasis>no admin users</emphasis></para>
1064 <para>Example: <command>admin users = jason</command></para>
1065 </listitem>
1066 </varlistentry>
1070 <varlistentry>
1071 <term><anchor id="ALLOWHOSTS">allow hosts (S)</term>
1072 <listitem><para>Synonym for <link linkend="HOSTSALLOW">
1073 <parameter>hosts allow</parameter></link>.</para></listitem>
1074 </varlistentry>
1078 <varlistentry>
1079 <term><anchor id="ALLOWTRUSTEDDOMAINS">allow trusted domains (G)</term>
1080 <listitem><para>This option only takes effect when the <link
1081 linkend="SECURITY"><parameter>security</parameter></link> option is set to
1082 <constant>server</constant> or <constant>domain</constant>.
1083 If it is set to no, then attempts to connect to a resource from
1084 a domain or workgroup other than the one which smbd is running
1085 in will fail, even if that domain is trusted by the remote server
1086 doing the authentication.</para>
1088 <para>This is useful if you only want your Samba server to
1089 serve resources to users in the domain it is a member of. As
1090 an example, suppose that there are two domains DOMA and DOMB. DOMB
1091 is trusted by DOMA, which contains the Samba server. Under normal
1092 circumstances, a user with an account in DOMB can then access the
1093 resources of a UNIX account with the same account name on the
1094 Samba server even if they do not have an account in DOMA. This
1095 can make implementing a security boundary difficult.</para>
1097 <para>Default: <command>allow trusted domains = yes</command></para>
1099 </listitem>
1100 </varlistentry>
1104 <varlistentry>
1105 <term><anchor id="ANNOUNCEAS">announce as (G)</term>
1106 <listitem><para>This specifies what type of server
1107 <ulink url="nmbd.8.html"><command>nmbd</command></ulink>
1108 will announce itself as, to a network neighborhood browse
1109 list. By default this is set to Windows NT. The valid options
1110 are : "NT Server" (which can also be written as "NT"),
1111 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
1112 Windows NT Workstation, Windows 95 and Windows for Workgroups
1113 respectively. Do not change this parameter unless you have a
1114 specific need to stop Samba appearing as an NT server as this
1115 may prevent Samba servers from participating as browser servers
1116 correctly.</para>
1118 <para>Default: <command>announce as = NT Server</command></para>
1120 <para>Example: <command>announce as = Win95</command></para>
1121 </listitem>
1122 </varlistentry>
1126 <varlistentry>
1127 <term><anchor id="ANNOUNCEVERSION">annouce version (G)</term>
1128 <listitem><para>This specifies the major and minor version numbers
1129 that nmbd will use when announcing itself as a server. The default
1130 is 4.2. Do not change this parameter unless you have a specific
1131 need to set a Samba server to be a downlevel server.</para>
1133 <para>Default: <command>announce version = 4.2</command></para>
1135 <para>Example: <command>announce version = 2.0</command></para>
1136 </listitem>
1137 </varlistentry>
1141 <varlistentry>
1142 <term><anchor id="AUTOSERVICES">auto services (G)</term>
1143 <listitem><para>This is a synonym for the <link linkend="PRELOAD">
1144 <parameter>preload</parameter></link>.</para>
1145 </listitem>
1146 </varlistentry>
1150 <varlistentry>
1151 <term><anchor id="AVAILABLE">available (S)</term>
1152 <listitem><para>This parameter lets you "turn off" a service. If
1153 <parameter>available = no</parameter>, then <emphasis>ALL</emphasis>
1154 attempts to connect to the service will fail. Such failures are
1155 logged.</para>
1157 <para>Default: <command>available = yes</command></para>
1159 </listitem>
1160 </varlistentry>
1164 <varlistentry>
1165 <term><anchor id="BINDINTERFACESONLY">bind interfaces only (G)</term>
1166 <listitem><para>This global parameter allows the Samba admin
1167 to limit what interfaces on a machine will serve smb requests. If
1168 affects file service <ulink url="smbd.8.html">smbd(8)</ulink> and
1169 name service <ulink url="nmbd.8.html">nmbd(8)</ulink> in slightly
1170 different ways.</para>
1172 <para>For name service it causes <command>nmbd</command> to bind
1173 to ports 137 and 138 on the interfaces listed in the <link
1174 linkend="INTERFACES">interfaces</link> parameter. <command>nmbd
1175 </command> also binds to the "all addresses" interface (0.0.0.0)
1176 on ports 137 and 138 for the purposes of reading broadcast messages.
1177 If this option is not set then <command>nmbd</command> will service
1178 name requests on all of these sockets. If <parameter>bind interfaces
1179 only</parameter> is set then <command>nmbd</command> will check the
1180 source address of any packets coming in on the broadcast sockets
1181 and discard any that don't match the broadcast addresses of the
1182 interfaces in the <parameter>interfaces</parameter> parameter list.
1183 As unicast packets are received on the other sockets it allows
1184 <command>nmbd</command> to refuse to serve names to machines that
1185 send packets that arrive through any interfaces not listed in the
1186 <parameter>interfaces</parameter> list. IP Source address spoofing
1187 does defeat this simple check, however so it must not be used
1188 seriously as a security feature for <command>nmbd</command>.</para>
1190 <para>For file service it causes <ulink url="smbd.8.html">smbd(8)</ulink>
1191 to bind only to the interface list given in the <link linkend="INTERFACES">
1192 interfaces</link> parameter. This restricts the networks that
1193 <command>smbd</command> will serve to packets coming in those
1194 interfaces. Note that you should not use this parameter for machines
1195 that are serving PPP or other intermittent or non-broadcast network
1196 interfaces as it will not cope with non-permanent interfaces.</para>
1198 <para>If <parameter>bind interfaces only</parameter> is set then
1199 unless the network address <emphasis>127.0.0.1</emphasis> is added
1200 to the <parameter>interfaces</parameter> parameter list <ulink
1201 url="smbpasswd.8.html"><command>smbpasswd(8)</command></ulink>
1202 and <ulink url="swat.8.html"><command>swat(8)</command></ulink> may
1203 not work as expected due to the reasons covered below.</para>
1205 <para>To change a users SMB password, the <command>smbpasswd</command>
1206 by default connects to the <emphasis>localhost - 127.0.0.1</emphasis>
1207 address as an SMB client to issue the password change request. If
1208 <parameter>bind interfaces only</parameter> is set then unless the
1209 network address <emphasis>127.0.0.1</emphasis> is added to the
1210 <parameter>interfaces</parameter> parameter list then <command>
1211 smbpasswd</command> will fail to connect in it's default mode.
1212 <command>smbpasswd</command> can be forced to use the primary IP interface
1213 of the local host by using its <ulink url="smbpasswd.8.html#minusr">
1214 <parameter>-r <replaceable>remote machine</replaceable></parameter>
1215 </ulink> parameter, with <replaceable>remote machine</replaceable> set
1216 to the IP name of the primary interface of the local host.</para>
1218 <para>The <command>swat</command> status page tries to connect with
1219 <command>smbd</command> and <command>nmbd</command> at the address
1220 <emphasis>127.0.0.1</emphasis> to determine if they are running.
1221 Not adding <emphasis>127.0.0.1</emphasis> will cause <command>
1222 smbd</command> and <command>nmbd</command> to always show
1223 "not running" even if they really are. This can prevent <command>
1224 swat</command> from starting/stopping/restarting <command>smbd</command>
1225 and <command>nmbd</command>.</para>
1227 <para>Default: <command>bind interfaces only = no</command></para>
1229 </listitem>
1230 </varlistentry>
1234 <varlistentry>
1235 <term><anchor id="BLOCKINGLOCKS">blocking locks (S)</term>
1236 <listitem><para>This parameter controls the behavior of <ulink
1237 url="smbd.8.html">smbd(8)</ulink> when given a request by a client
1238 to obtain a byte range lock on a region of an open file, and the
1239 request has a time limit associated with it.</para>
1241 <para>If this parameter is set and the lock range requested
1242 cannot be immediately satisfied, Samba 2.2 will internally
1243 queue the lock request, and periodically attempt to obtain
1244 the lock until the timeout period expires.</para>
1246 <para>If this parameter is set to <constant>False</constant>, then
1247 Samba 2.2 will behave as previous versions of Samba would and
1248 will fail the lock request immediately if the lock range
1249 cannot be obtained.</para>
1251 <para>Default: <command>blocking locks = yes</command></para>
1253 </listitem>
1254 </varlistentry>
1258 <varlistentry>
1259 <term><anchor id="BROWSABLE">browsable (S)</term>
1260 <listitem><para>See the <link linkend="BROWSEABLE"><parameter>
1261 browseable</parameter></link>.</para></listitem>
1262 </varlistentry>
1266 <varlistentry>
1267 <term><anchor id="BROWSELIST">browse list (G)</term>
1268 <listitem><para>This controls whether <ulink url="smbd.8.html">
1269 <command>smbd(8)</command></ulink> will serve a browse list to
1270 a client doing a <command>NetServerEnum</command> call. Normally
1271 set to <constant>true</constant>. You should never need to change
1272 this.</para>
1274 <para>Default: <command>browse list = yes</command></para></listitem>
1275 </varlistentry>
1279 <varlistentry>
1280 <term><anchor id="BROWSEABLE">browseable (S)</term>
1281 <listitem><para>This controls whether this share is seen in
1282 the list of available shares in a net view and in the browse list.</para>
1284 <para>Default: <command>browseable = yes</command></para>
1285 </listitem>
1286 </varlistentry>
1290 <varlistentry>
1291 <term><anchor id="CASESENSITIVE">case sensitive (S)</term>
1292 <listitem><para>See the discussion in the section <link
1293 linkend="NAMEMANGLINGSECT">NAME MANGLING</link>.</para>
1295 <para>Default: <command>case sensitive = no</command></para>
1296 </listitem>
1297 </varlistentry>
1301 <varlistentry>
1302 <term><anchor id="CASESIGNAMES">casesignames (S)</term>
1303 <listitem><para>Synonym for <link linkend="CASESENSITIVE">case
1304 sensitive</link>.</para></listitem>
1305 </varlistentry>
1309 <varlistentry>
1310 <term><anchor id="CHANGENOTIFYTIMEOUT">change notify timeout (G)</term>
1311 <listitem><para>This SMB allows a client to tell a server to
1312 "watch" a particular directory for any changes and only reply to
1313 the SMB request when a change has occurred. Such constant scanning of
1314 a directory is expensive under UNIX, hence an <ulink url="smbd.8.html">
1315 <command>smbd(8)</command></ulink> daemon only performs such a scan
1316 on each requested directory once every <parameter>change notify
1317 timeout</parameter> seconds.</para>
1319 <para>Default: <command>change notify timeout = 60</command></para>
1320 <para>Example: <command>change notify timeout = 300</command></para>
1322 <para>Would change the scan time to every 5 minutes.</para></listitem>
1323 </varlistentry>
1327 <varlistentry>
1328 <term><anchor id="CHANGESHARECOMMAND">change share command (G)</term>
1329 <listitem><para>Samba 2.2.0 introduced the ability to dynamically
1330 add and delete shares via the Windows NT 4.0 Server Manager. The
1331 <parameter>change share command</parameter> is used to define an
1332 external program or script which will modify an existing service definition
1333 in <filename>smb.conf</filename>. In order to successfully
1334 execute the <parameter>change share command</parameter>, <command>smbd</command>
1335 requires that the administrator be connected using a root account (i.e.
1336 uid == 0).
1337 </para>
1339 <para>
1340 When executed, <command>smbd</command> will automatically invoke the
1341 <parameter>change share command</parameter> with four parameters.
1342 </para>
1344 <itemizedlist>
1345 <listitem><para><parameter>configFile</parameter> - the location
1346 of the global <filename>smb.conf</filename> file.
1347 </para></listitem>
1349 <listitem><para><parameter>shareName</parameter> - the name of the new
1350 share.
1351 </para></listitem>
1353 <listitem><para><parameter>pathName</parameter> - path to an **existing**
1354 directory on disk.
1355 </para></listitem>
1357 <listitem><para><parameter>comment</parameter> - comment string to associate
1358 with the new share.
1359 </para></listitem>
1360 </itemizedlist>
1362 <para>
1363 This parameter is only used modify existing file shares definitions. To modify
1364 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
1365 </para>
1367 <para>
1368 See also <link linkend="ADDSHARECOMMAND"><parameter>add share
1369 command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter>delete
1370 share command</parameter></link>.
1371 </para>
1373 <para>Default: <emphasis>none</emphasis></para>
1374 <para>Example: <command>change share command = /usr/local/bin/addshare</command></para>
1375 </listitem>
1376 </varlistentry>
1380 <varlistentry>
1381 <term><anchor id="CHARACTERSET">character set (G)</term>
1382 <listitem><para>This allows a smbd to map incoming filenames
1383 from a DOS Code page (see the <link linkend="CLIENTCODEPAGE">client
1384 code page</link> parameter) to several built in UNIX character sets.
1385 The built in code page translations are:</para>
1387 <itemizedlist>
1388 <listitem><para><constant>ISO8859-1</constant> : Western European
1389 UNIX character set. The parameter <parameter>client code page</parameter>
1390 <emphasis>MUST</emphasis> be set to code page 850 if the
1391 <parameter>character set</parameter> parameter is set to
1392 <constant>ISO8859-1</constant> in order for the conversion to the
1393 UNIX character set to be done correctly.</para></listitem>
1395 <listitem><para><constant>ISO8859-2</constant> : Eastern European
1396 UNIX character set. The parameter <parameter>client code page
1397 </parameter> <emphasis>MUST</emphasis> be set to code page 852 if
1398 the <parameter> character set</parameter> parameter is set
1399 to <constant>ISO8859-2</constant> in order for the conversion
1400 to the UNIX character set to be done correctly. </para></listitem>
1402 <listitem><para><constant>ISO8859-5</constant> : Russian Cyrillic
1403 UNIX character set. The parameter <parameter>client code page
1404 </parameter> <emphasis>MUST</emphasis> be set to code page
1405 866 if the <parameter>character set </parameter> parameter is
1406 set to <constant>ISO8859-5</constant> in order for the conversion
1407 to the UNIX character set to be done correctly. </para></listitem>
1409 <listitem><para><constant>ISO8859-7</constant> : Greek UNIX
1410 character set. The parameter <parameter>client code page
1411 </parameter> <emphasis>MUST</emphasis> be set to code page
1412 737 if the <parameter>character set</parameter> parameter is
1413 set to <constant>ISO8859-7</constant> in order for the conversion
1414 to the UNIX character set to be done correctly.</para></listitem>
1416 <listitem><para><constant>KOI8-R</constant> : Alternate mapping
1417 for Russian Cyrillic UNIX character set. The parameter
1418 <parameter>client code page</parameter> <emphasis>MUST</emphasis>
1419 be set to code page 866 if the <parameter>character set</parameter>
1420 parameter is set to <constant>KOI8-R</constant> in order for the
1421 conversion to the UNIX character set to be done correctly.</para>
1422 </listitem>
1423 </itemizedlist>
1425 <para><emphasis>BUG</emphasis>. These MSDOS code page to UNIX character
1426 set mappings should be dynamic, like the loading of MS DOS code pages,
1427 not static.</para>
1429 <para>Normally this parameter is not set, meaning no filename
1430 translation is done.</para>
1432 <para>Default: <command>character set = &lt;empty string&gt;</command></para>
1433 <para>Example: <command>character set = ISO8859-1</command></para></listitem>
1434 </varlistentry>
1438 <varlistentry>
1439 <term><anchor id="CLIENTCODEPAGE">client code page (G)</term>
1440 <listitem><para>This parameter specifies the DOS code page
1441 that the clients accessing Samba are using. To determine what code
1442 page a Windows or DOS client is using, open a DOS command prompt
1443 and type the command <command>chcp</command>. This will output
1444 the code page. The default for USA MS-DOS, Windows 95, and
1445 Windows NT releases is code page 437. The default for western
1446 European releases of the above operating systems is code page 850.</para>
1448 <para>This parameter tells <ulink url="smbd.8.html">smbd(8)</ulink>
1449 which of the <filename>codepage.<replaceable>XXX</replaceable>
1450 </filename> files to dynamically load on startup. These files,
1451 described more fully in the manual page <ulink url="make_smbcodepage.1.html">
1452 <command>make_smbcodepage(1)</command></ulink>, tell <command>
1453 smbd</command> how to map lower to upper case characters to provide
1454 the case insensitivity of filenames that Windows clients expect.</para>
1456 <para>Samba currently ships with the following code page files :</para>
1458 <itemizedlist>
1459 <listitem><para>Code Page 437 - MS-DOS Latin US</para></listitem>
1460 <listitem><para>Code Page 737 - Windows '95 Greek</para></listitem>
1461 <listitem><para>Code Page 850 - MS-DOS Latin 1</para></listitem>
1462 <listitem><para>Code Page 852 - MS-DOS Latin 2</para></listitem>
1463 <listitem><para>Code Page 861 - MS-DOS Icelandic</para></listitem>
1464 <listitem><para>Code Page 866 - MS-DOS Cyrillic</para></listitem>
1465 <listitem><para>Code Page 932 - MS-DOS Japanese SJIS</para></listitem>
1466 <listitem><para>Code Page 936 - MS-DOS Simplified Chinese</para></listitem>
1467 <listitem><para>Code Page 949 - MS-DOS Korean Hangul</para></listitem>
1468 <listitem><para>Code Page 950 - MS-DOS Traditional Chinese</para></listitem>
1469 </itemizedlist>
1471 <para>Thus this parameter may have any of the values 437, 737, 850, 852,
1472 861, 932, 936, 949, or 950. If you don't find the codepage you need,
1473 read the comments in one of the other codepage files and the
1474 <command>make_smbcodepage(1)</command> man page and write one. Please
1475 remember to donate it back to the Samba user community.</para>
1477 <para>This parameter co-operates with the <parameter>valid
1478 chars</parameter> parameter in determining what characters are
1479 valid in filenames and how capitalization is done. If you set both
1480 this parameter and the <parameter>valid chars</parameter> parameter
1481 the <parameter>client code page</parameter> parameter
1482 <emphasis>MUST</emphasis> be set before the <parameter>valid
1483 chars</parameter> parameter in the <filename>smb.conf</filename>
1484 file. The <parameter>valid chars</parameter> string will then
1485 augment the character settings in the <parameter>client code page</parameter>
1486 parameter.</para>
1488 <para>If not set, <parameter>client code page</parameter> defaults
1489 to 850.</para>
1491 <para>See also : <link linkend="VALIDCHARS"><parameter>valid
1492 chars</parameter></link>, <link linkend="CODEPAGEDIRECTORY">
1493 <parameter>code page directory</parameter></link></para>
1495 <para>Default: <command>client code page = 850</command></para>
1496 <para>Example: <command>client code page = 936</command></para>
1497 </listitem>
1498 </varlistentry>
1503 <varlistentry>
1504 <term><anchor id="CODEPAGEDIRECTORY">code page directory (G)</term>
1505 <listitem><para>Define the location of the various client code page
1506 files.</para>
1508 <para>See also <link linkend="CLIENTCODEPAGE"><parameter>client
1509 code page</parameter></link></para>
1511 <para>Default: <command>code page directory = ${prefix}/lib/codepages
1512 </command></para>
1513 <para>Example: <command>code page directory = /usr/share/samba/codepages
1514 </command></para>
1515 </listitem>
1516 </varlistentry>
1522 <varlistentry>
1523 <term><anchor id="CODINGSYSTEM">codingsystem (G)</term>
1524 <listitem><para>This parameter is used to determine how incoming
1525 Shift-JIS Japanese characters are mapped from the incoming <link
1526 linkend="CLIENTCODEPAGE"><parameter>client code page</parameter>
1527 </link> used by the client, into file names in the UNIX filesystem.
1528 Only useful if <parameter>client code page</parameter> is set to
1529 932 (Japanese Shift-JIS). The options are :</para>
1531 <itemizedlist>
1532 <listitem><para><constant>SJIS</constant> - Shift-JIS. Does no
1533 conversion of the incoming filename.</para></listitem>
1535 <listitem><para><constant>JIS8, J8BB, J8BH, J8@B,
1536 J8@J, J8@H </constant> - Convert from incoming Shift-JIS to eight
1537 bit JIS code with different shift-in, shift out codes.</para></listitem>
1539 <listitem><para><constant>JIS7, J7BB, J7BH, J7@B, J7@J,
1540 J7@H </constant> - Convert from incoming Shift-JIS to seven bit
1541 JIS code with different shift-in, shift out codes.</para></listitem>
1543 <listitem><para><constant>JUNET, JUBB, JUBH, JU@B, JU@J, JU@H </constant>
1544 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
1545 shift out codes.</para></listitem>
1547 <listitem><para><constant>EUC</constant> - Convert an incoming
1548 Shift-JIS character to EUC code.</para></listitem>
1550 <listitem><para><constant>HEX</constant> - Convert an incoming
1551 Shift-JIS character to a 3 byte hex representation, i.e.
1552 <constant>:AB</constant>.</para></listitem>
1554 <listitem><para><constant>CAP</constant> - Convert an incoming
1555 Shift-JIS character to the 3 byte hex representation used by
1556 the Columbia AppleTalk Program (CAP), i.e. <constant>:AB</constant>.
1557 This is used for compatibility between Samba and CAP.</para></listitem>
1558 </itemizedlist>
1560 <para>Default: <command>coding system = &lt;empty value&gt;</command>
1561 </para>
1562 </listitem>
1563 </varlistentry>
1567 <varlistentry>
1568 <term><anchor id="COMMENT">comment (S)</term>
1569 <listitem><para>This is a text field that is seen next to a share
1570 when a client does a queries the server, either via the network
1571 neighborhood or via <command>net view</command> to list what shares
1572 are available.</para>
1574 <para>If you want to set the string that is displayed next to the
1575 machine name then see the <link linkend="SERVERSTRING"><parameter>
1576 server string</parameter></link> parameter.</para>
1578 <para>Default: <emphasis>No comment string</emphasis></para>
1579 <para>Example: <command>comment = Fred's Files</command></para></listitem>
1580 </varlistentry>
1584 <varlistentry>
1585 <term><anchor id="CONFIGFILE">config file (G)</term>
1586 <listitem><para>This allows you to override the config file
1587 to use, instead of the default (usually <filename>smb.conf</filename>).
1588 There is a chicken and egg problem here as this option is set
1589 in the config file!</para>
1591 <para>For this reason, if the name of the config file has changed
1592 when the parameters are loaded then it will reload them from
1593 the new config file.</para>
1595 <para>This option takes the usual substitutions, which can
1596 be very useful.</para>
1598 <para>If the config file doesn't exist then it won't be loaded
1599 (allowing you to special case the config files of just a few
1600 clients).</para>
1602 <para>Example: <command>config file = /usr/local/samba/lib/smb.conf.%m
1603 </command></para></listitem>
1604 </varlistentry>
1608 <varlistentry>
1609 <term><anchor id="COPY">copy (S)</term>
1610 <listitem><para>This parameter allows you to "clone" service
1611 entries. The specified service is simply duplicated under the
1612 current service's name. Any parameters specified in the current
1613 section will override those in the section being copied.</para>
1615 <para>This feature lets you set up a 'template' service and
1616 create similar services easily. Note that the service being
1617 copied must occur earlier in the configuration file than the
1618 service doing the copying.</para>
1620 <para>Default: <emphasis>no value</emphasis></para>
1621 <para>Example: <command>copy = otherservice</command></para></listitem>
1622 </varlistentry>
1626 <varlistentry>
1627 <term><anchor id="CREATEMASK">create mask (S)</term>
1628 <listitem><para>A synonym for this parameter is
1629 <link linkend="CREATEMODE"><parameter>create mode</parameter>
1630 </link>.</para>
1632 <para>When a file is created, the necessary permissions are
1633 calculated according to the mapping from DOS modes to UNIX
1634 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
1635 with this parameter. This parameter may be thought of as a bit-wise
1636 MASK for the UNIX modes of a file. Any bit <emphasis>not</emphasis>
1637 set here will be removed from the modes set on a file when it is
1638 created.</para>
1640 <para>The default value of this parameter removes the
1641 'group' and 'other' write and execute bits from the UNIX modes.</para>
1643 <para>Following this Samba will bit-wise 'OR' the UNIX mode created
1644 from this parameter with the value of the <link
1645 linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>
1646 parameter which is set to 000 by default.</para>
1648 <para>This parameter does not affect directory modes. See the
1649 parameter <link linkend="DIRECTORYMODE"><parameter>directory mode
1650 </parameter></link> for details.</para>
1652 <para>See also the <link linkend="FORCECREATEMODE"><parameter>force
1653 create mode</parameter></link> parameter for forcing particular mode
1654 bits to be set on created files. See also the <link linkend="DIRECTORYMODE">
1655 <parameter>directory mode"</parameter></link> parameter for masking
1656 mode bits on created directories. See also the <link linkend="INHERITPERMISSIONS">
1657 <parameter>inherit permissions</parameter></link> parameter.</para>
1659 <para>Note that this parameter does not apply to permissions
1660 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
1661 a mask on access control lists also, they need to set the <link
1662 linkend="SECURITYMASK"><parameter>security mask</parameter></link>.</para>
1664 <para>Default: <command>create mask = 0744</command></para>
1665 <para>Example: <command>create mask = 0775</command></para></listitem>
1666 </varlistentry>
1670 <varlistentry>
1671 <term><anchor id="CREATEMODE">create mode (S)</term>
1672 <listitem><para>This is a synonym for <link linkend="CREATEMASK"><parameter>
1673 create mask</parameter></link>.</para></listitem>
1674 </varlistentry>
1678 <varlistentry>
1679 <term><anchor id="DEADTIME">deadtime (G)</term>
1680 <listitem><para>The value of the parameter (a decimal integer)
1681 represents the number of minutes of inactivity before a connection
1682 is considered dead, and it is disconnected. The deadtime only takes
1683 effect if the number of open files is zero.</para>
1685 <para>This is useful to stop a server's resources being
1686 exhausted by a large number of inactive connections.</para>
1688 <para>Most clients have an auto-reconnect feature when a
1689 connection is broken so in most cases this parameter should be
1690 transparent to users.</para>
1692 <para>Using this parameter with a timeout of a few minutes
1693 is recommended for most systems.</para>
1695 <para>A deadtime of zero indicates that no auto-disconnection
1696 should be performed.</para>
1698 <para>Default: <command>deadtime = 0</command></para>
1699 <para>Example: <command>deadtime = 15</command></para></listitem>
1700 </varlistentry>
1704 <varlistentry>
1705 <term><anchor id="DEBUGHIRESTIMESTAMP">debug hires timestamp (G)</term>
1706 <listitem><para>Sometimes the timestamps in the log messages
1707 are needed with a resolution of higher that seconds, this
1708 boolean parameter adds microsecond resolution to the timestamp
1709 message header when turned on.</para>
1711 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1712 debug timestamp</parameter></link> must be on for this to have an
1713 effect.</para>
1715 <para>Default: <command>debug hires timestamp = no</command></para>
1716 </listitem>
1717 </varlistentry>
1721 <varlistentry>
1722 <term><anchor id="DEBUGPID">debug pid (G)</term>
1723 <listitem><para>When using only one log file for more then one
1724 forked smbd-process there may be hard to follow which process
1725 outputs which message. This boolean parameter is adds the process-id
1726 to the timestamp message headers in the logfile when turned on.</para>
1728 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1729 debug timestamp</parameter></link> must be on for this to have an
1730 effect.</para>
1732 <para>Default: <command>debug pid = no</command></para></listitem>
1733 </varlistentry>
1736 <varlistentry>
1737 <term><anchor id="DEBUGTIMESTAMP">debug timestamp (G)</term>
1738 <listitem><para>Samba 2.2 debug log messages are timestamped
1739 by default. If you are running at a high <link linkend="DEBUGLEVEL">
1740 <parameter>debug level</parameter></link> these timestamps
1741 can be distracting. This boolean parameter allows timestamping
1742 to be turned off.</para>
1744 <para>Default: <command>debug timestamp = yes</command></para></listitem>
1745 </varlistentry>
1749 <varlistentry>
1750 <term><anchor id="DEBUGUID">debug uid (G)</term>
1751 <listitem><para>Samba is sometimes run as root and sometime
1752 run as the connected user, this boolean parameter inserts the
1753 current euid, egid, uid and gid to the timestamp message headers
1754 in the log file if turned on.</para>
1756 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1757 debug timestamp</parameter></link> must be on for this to have an
1758 effect.</para>
1760 <para>Default: <command>debug uid = no</command></para></listitem>
1761 </varlistentry>
1765 <varlistentry>
1766 <term><anchor id="DEBUGLEVEL">debuglevel (G)</term>
1767 <listitem><para>Synonym for <link linkend="LOGLEVEL"><parameter>
1768 log level</parameter></link>.</para>
1769 </listitem>
1770 </varlistentry>
1774 <varlistentry>
1775 <term><anchor id="DEFAULT">default (G)</term>
1776 <listitem><para>A synonym for <link linkend="DEFAULTSERVICE"><parameter>
1777 default service</parameter></link>.</para></listitem>
1778 </varlistentry>
1782 <varlistentry>
1783 <term><anchor id="DEFAULTCASE">default case (S)</term>
1784 <listitem><para>See the section on <link linkend="NAMEMANGLINGSECT">
1785 NAME MANGLING</link>. Also note the <link linkend="SHORTPRESERVECASE">
1786 <parameter>short preserve case"</parameter></link> parameter.</para>
1788 <para>Default: <command>default case = lower</command></para>
1789 </listitem>
1790 </varlistentry>
1794 <varlistentry>
1795 <term><anchor id="DEFAULTSERVICE">default service (G)</term>
1796 <listitem><para>This parameter specifies the name of a service
1797 which will be connected to if the service actually requested cannot
1798 be found. Note that the square brackets are <emphasis>NOT</emphasis>
1799 given in the parameter value (see example below).</para>
1801 <para>There is no default value for this parameter. If this
1802 parameter is not given, attempting to connect to a nonexistent
1803 service results in an error.</para>
1805 <para>Typically the default service would be a <link linkend="GUESTOK">
1806 <parameter>guest ok</parameter></link>, <link linkend="READONLY">
1807 <parameter>read-only</parameter></link> service.</para>
1809 <para>Also note that the apparent service name will be changed
1810 to equal that of the requested service, this is very useful as it
1811 allows you to use macros like <parameter>%S</parameter> to make
1812 a wildcard service.</para>
1814 <para>Note also that any "_" characters in the name of the service
1815 used in the default service will get mapped to a "/". This allows for
1816 interesting things.</para>
1819 <para>Example:</para>
1821 <para><programlisting>
1822 [global]
1823 default service = pub
1825 [pub]
1826 path = /%S
1827 </programlisting></para>
1828 </listitem>
1829 </varlistentry>
1833 <varlistentry>
1834 <term><anchor id="DELETEPRINTERCOMMAND">delete printer command (G)</term>
1835 <listitem><para>With the introduction of MS-RPC based printer
1836 support for Windows NT/2000 clients in Samba 2.2, it is now
1837 possible to delete printer at run time by issuing the
1838 DeletePrinter() RPC call.</para>
1840 <para>For a Samba host this means that the printer must be
1841 physically deleted from underlying printing system. The <parameter>
1842 deleteprinter command</parameter> defines a script to be run which
1843 will perform the necessary operations for removing the printer
1844 from the print system and from <filename>smb.conf</filename>.
1845 </para>
1847 <para>The <parameter>delete printer command</parameter> is
1848 automatically called with only one parameter: <parameter>
1849 "printer name"</parameter>.</para>
1852 <para>Once the <parameter>delete printer command</parameter> has
1853 been executed, <command>smbd</command> will reparse the <filename>
1854 smb.conf</filename> to associated printer no longer exists.
1855 If the sharename is still valid, then <command>smbd
1856 </command> will return an ACCESS_DENIED error to the client.</para>
1858 <para>See also <link linkend="ADDPRINTERCOMMAND"><parameter>
1859 add printer command</parameter></link>, <link
1860 linkend="printing"><parameter>printing</parameter></link>,
1861 <link linkend="SHOWADDPRINTERWIZARD"><parameter>show add
1862 printer wizard</parameter></link></para>
1864 <para>Default: <emphasis>none</emphasis></para>
1865 <para>Example: <command>deleteprinter command = /usr/bin/removeprinter
1866 </command></para>
1867 </listitem>
1868 </varlistentry>
1875 <varlistentry>
1876 <term><anchor id="DELETEREADONLY">delete readonly (S)</term>
1877 <listitem><para>This parameter allows readonly files to be deleted.
1878 This is not normal DOS semantics, but is allowed by UNIX.</para>
1880 <para>This option may be useful for running applications such
1881 as rcs, where UNIX file ownership prevents changing file
1882 permissions, and DOS semantics prevent deletion of a read only file.</para>
1884 <para>Default: <command>delete readonly = no</command></para></listitem>
1885 </varlistentry>
1889 <varlistentry>
1890 <term><anchor id="DELETESHARECOMMAND">delete share command (G)</term>
1891 <listitem><para>Samba 2.2.0 introduced the ability to dynamically
1892 add and delete shares via the Windows NT 4.0 Server Manager. The
1893 <parameter>delete share command</parameter> is used to define an
1894 external program or script which will remove an existing service
1895 definition from <filename>smb.conf</filename>. In order to successfully
1896 execute the <parameter>delete share command</parameter>, <command>smbd</command>
1897 requires that the administrator be connected using a root account (i.e.
1898 uid == 0).
1899 </para>
1901 <para>
1902 When executed, <command>smbd</command> will automatically invoke the
1903 <parameter>delete share command</parameter> with two parameters.
1904 </para>
1906 <itemizedlist>
1907 <listitem><para><parameter>configFile</parameter> - the location
1908 of the global <filename>smb.conf</filename> file.
1909 </para></listitem>
1911 <listitem><para><parameter>shareName</parameter> - the name of
1912 the existing service.
1913 </para></listitem>
1914 </itemizedlist>
1916 <para>
1917 This parameter is only used to remove file shares. To delete printer shares,
1918 see the <link linkend="DELETEPRINTERCOMMAND"><parameter>delete printer
1919 command</parameter></link>.
1920 </para>
1922 <para>
1923 See also <link linkend="ADDSHARECOMMAND"><parameter>delete share
1924 command</parameter></link>, <link linkend="CHANGESHARECOMMAND"><parameter>change
1925 share</parameter></link>.
1926 </para>
1928 <para>Default: <emphasis>none</emphasis></para>
1929 <para>Example: <command>delete share command = /usr/local/bin/delshare</command></para>
1931 </listitem>
1932 </varlistentry>
1937 <varlistentry>
1938 <term><anchor id="DELETEUSERSCRIPT">delete user script (G)</term>
1939 <listitem><para>This is the full pathname to a script that will
1940 be run <emphasis>AS ROOT</emphasis> by <ulink url="smbd.8.html">
1941 <command>smbd(8)</command></ulink> under special circumstances
1942 described below.</para>
1944 <para>Normally, a Samba server requires that UNIX users are
1945 created for all users accessing files on this server. For sites
1946 that use Windows NT account databases as their primary user database
1947 creating these users and keeping the user list in sync with the
1948 Windows NT PDC is an onerous task. This option allows <command>
1949 smbd</command> to delete the required UNIX users <emphasis>ON
1950 DEMAND</emphasis> when a user accesses the Samba server and the
1951 Windows NT user no longer exists.</para>
1953 <para>In order to use this option, <command>smbd</command> must be
1954 set to <parameter>security=domain</parameter> and <parameter>delete
1955 user script</parameter> must be set to a full pathname for a script
1956 that will delete a UNIX user given one argument of <parameter>%u
1957 </parameter>, which expands into the UNIX user name to delete.
1958 <emphasis>NOTE</emphasis> that this is different to the <link
1959 linkend="ADDUSERSCRIPT"><parameter>add user script</parameter></link>
1960 which will work with the <parameter>security=server</parameter> option
1961 as well as <parameter>security=domain</parameter>. The reason for this
1962 is only when Samba is a domain member does it get the information
1963 on an attempted user logon that a user no longer exists. In the
1964 <parameter>security=server</parameter> mode a missing user
1965 is treated the same as an invalid password logon attempt. Deleting
1966 the user in this circumstance would not be a good idea.</para>
1968 <para>When the Windows user attempts to access the Samba server,
1969 at <emphasis>login</emphasis> (session setup in the SMB protocol)
1970 time, <command>smbd</command> contacts the <link linkend="PASSWORDSERVER">
1971 <parameter>password server</parameter></link> and attempts to authenticate
1972 the given user with the given password. If the authentication fails
1973 with the specific Domain error code meaning that the user no longer
1974 exists then <command>smbd</command> attempts to find a UNIX user in
1975 the UNIX password database that matches the Windows user account. If
1976 this lookup succeeds, and <parameter>delete user script</parameter> is
1977 set then <command>smbd</command> will all the specified script
1978 <emphasis>AS ROOT</emphasis>, expanding any <parameter>%u</parameter>
1979 argument to be the user name to delete.</para>
1981 <para>This script should delete the given UNIX username. In this way,
1982 UNIX users are dynamically deleted to match existing Windows NT
1983 accounts.</para>
1985 <para>See also <link linkend="SECURITYEQUALSDOMAIN">security=domain</link>,
1986 <link linkend="PASSWORDSERVER"><parameter>password server</parameter>
1987 </link>, <link linkend="ADDUSERSCRIPT"><parameter>add user script</parameter>
1988 </link>.</para>
1990 <para>Default: <command>delete user script = &lt;empty string&gt;
1991 </command></para>
1992 <para>Example: <command>delete user script = /usr/local/samba/bin/del_user
1993 %u</command></para></listitem>
1994 </varlistentry>
2000 <varlistentry>
2001 <term><anchor id="DELETEVETOFILES">delete veto files (S)</term>
2002 <listitem><para>This option is used when Samba is attempting to
2003 delete a directory that contains one or more vetoed directories
2004 (see the <link linkend="VETOFILES"><parameter>veto files</parameter></link>
2005 option). If this option is set to False (the default) then if a vetoed
2006 directory contains any non-vetoed files or directories then the
2007 directory delete will fail. This is usually what you want.</para>
2009 <para>If this option is set to <constant>True</constant>, then Samba
2010 will attempt to recursively delete any files and directories within
2011 the vetoed directory. This can be useful for integration with file
2012 serving systems such as NetAtalk which create meta-files within
2013 directories you might normally veto DOS/Windows users from seeing
2014 (e.g. <filename>.AppleDouble</filename>)</para>
2016 <para>Setting <command>delete veto files = yes</command> allows these
2017 directories to be transparently deleted when the parent directory
2018 is deleted (so long as the user has permissions to do so).</para>
2020 <para>See also the <link linkend="VETOFILES"><parameter>veto
2021 files</parameter></link> parameter.</para>
2023 <para>Default: <command>delete veto files = no</command></para></listitem>
2024 </varlistentry>
2029 <varlistentry>
2030 <term><anchor id="DENYHOSTS">deny hosts (S)</term>
2031 <listitem><para>Synonym for <link linkend="HOSTSDENY"><parameter>hosts
2032 deny</parameter></link>.</para></listitem>
2033 </varlistentry>
2038 <varlistentry>
2039 <term><anchor id="DFREECOMMAND">dfree command (G)</term>
2040 <listitem><para>The <parameter>dfree command</parameter> setting should
2041 only be used on systems where a problem occurs with the internal
2042 disk space calculations. This has been known to happen with Ultrix,
2043 but may occur with other operating systems. The symptom that was
2044 seen was an error of "Abort Retry Ignore" at the end of each
2045 directory listing.</para>
2047 <para>This setting allows the replacement of the internal routines to
2048 calculate the total disk space and amount available with an external
2049 routine. The example below gives a possible script that might fulfill
2050 this function.</para>
2052 <para>The external program will be passed a single parameter indicating
2053 a directory in the filesystem being queried. This will typically consist
2054 of the string <filename>./</filename>. The script should return two
2055 integers in ASCII. The first should be the total disk space in blocks,
2056 and the second should be the number of available blocks. An optional
2057 third return value can give the block size in bytes. The default
2058 blocksize is 1024 bytes.</para>
2060 <para>Note: Your script should <emphasis>NOT</emphasis> be setuid or
2061 setgid and should be owned by (and writeable only by) root!</para>
2063 <para>Default: <emphasis>By default internal routines for
2064 determining the disk capacity and remaining space will be used.
2065 </emphasis></para>
2067 <para>Example: <command>dfree command = /usr/local/samba/bin/dfree
2068 </command></para>
2070 <para>Where the script dfree (which must be made executable) could be:</para>
2072 <para><programlisting>
2073 #!/bin/sh
2074 df $1 | tail -1 | awk '{print $2" "$4}'
2075 </programlisting></para>
2077 <para>or perhaps (on Sys V based systems):</para>
2079 <para><programlisting>
2080 #!/bin/sh
2081 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2082 </programlisting></para>
2084 <para>Note that you may have to replace the command names
2085 with full path names on some systems.</para>
2086 </listitem>
2087 </varlistentry>
2092 <varlistentry>
2093 <term><anchor id="DIRECTORY">directory (S)</term>
2094 <listitem><para>Synonym for <link linkend="PATH"><parameter>path
2095 </parameter></link>.</para></listitem>
2096 </varlistentry>
2100 <varlistentry>
2101 <term><anchor id="DIRECTORYMASK">directory mask (S)</term>
2102 <listitem><para>This parameter is the octal modes which are
2103 used when converting DOS modes to UNIX modes when creating UNIX
2104 directories.</para>
2106 <para>When a directory is created, the necessary permissions are
2107 calculated according to the mapping from DOS modes to UNIX permissions,
2108 and the resulting UNIX mode is then bit-wise 'AND'ed with this
2109 parameter. This parameter may be thought of as a bit-wise MASK for
2110 the UNIX modes of a directory. Any bit <emphasis>not</emphasis> set
2111 here will be removed from the modes set on a directory when it is
2112 created.</para>
2114 <para>The default value of this parameter removes the 'group'
2115 and 'other' write bits from the UNIX mode, allowing only the
2116 user who owns the directory to modify it.</para>
2118 <para>Following this Samba will bit-wise 'OR' the UNIX mode
2119 created from this parameter with the value of the <link
2120 linkend="FORCEDIRECTORYMODE"><parameter>force directory mode
2121 </parameter></link> parameter. This parameter is set to 000 by
2122 default (i.e. no extra mode bits are added).</para>
2124 <para>Note that this parameter does not apply to permissions
2125 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2126 a mask on access control lists also, they need to set the <link
2127 linkend="DIRECTORYSECURITYMASK"><parameter>directory security mask</parameter></link>.</para>
2129 <para>See the <link linkend="FORCEDIRECTORYMODE"><parameter>force
2130 directory mode</parameter></link> parameter to cause particular mode
2131 bits to always be set on created directories.</para>
2133 <para>See also the <link linkend="CREATEMODE"><parameter>create mode
2134 </parameter></link> parameter for masking mode bits on created files,
2135 and the <link linkend="DIRECTORYSECURITYMASK"><parameter>directory
2136 security mask</parameter></link> parameter.</para>
2138 <para>Also refer to the <link linkend="INHERITPERMISSIONS"><parameter>
2139 inherit permissions</parameter></link> parameter.</para>
2141 <para>Default: <command>directory mask = 0755</command></para>
2142 <para>Example: <command>directory mask = 0775</command></para>
2143 </listitem>
2144 </varlistentry>
2148 <varlistentry>
2149 <term><anchor id="DIRECTORYMODE">directory mode (S)</term>
2150 <listitem><para>Synonym for <link linkend="DIRECTORYMASK"><parameter>
2151 directory mask</parameter></link></para></listitem>
2152 </varlistentry>
2156 <varlistentry>
2157 <term><anchor id="DIRECTORYSECURITYMASK">directory security mask (S)</term>
2158 <listitem><para>This parameter controls what UNIX permission bits
2159 can be modified when a Windows NT client is manipulating the UNIX
2160 permission on a directory using the native NT security dialog
2161 box.</para>
2163 <para>This parameter is applied as a mask (AND'ed with) to
2164 the changed permission bits, thus preventing any bits not in
2165 this mask from being modified. Essentially, zero bits in this
2166 mask may be treated as a set of bits the user is not allowed
2167 to change.</para>
2169 <para>If not set explicitly this parameter is set to 0777
2170 meaning a user is allowed to modify all the user/group/world
2171 permissions on a directory.</para>
2173 <para><emphasis>Note</emphasis> that users who can access the
2174 Samba server through other means can easily bypass this restriction,
2175 so it is primarily useful for standalone "appliance" systems.
2176 Administrators of most normal systems will probably want to leave
2177 it as the default of 0777.</para>
2179 <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>
2180 force directory security mode</parameter></link>, <link
2181 linkend="SECURITYMASK"><parameter>security mask</parameter></link>,
2182 <link linkend="FORCESECURITYMODE"><parameter>force security mode
2183 </parameter></link> parameters.</para>
2185 <para>Default: <command>directory security mask = 0777</command></para>
2186 <para>Example: <command>directory security mask = 0700</command></para>
2187 </listitem>
2188 </varlistentry>
2192 <varlistentry>
2193 <term><anchor id="DNSPROXY">dns proxy (G)</term>
2194 <listitem><para>Specifies that <ulink url="nmbd.8.html">nmbd(8)</ulink>
2195 when acting as a WINS server and finding that a NetBIOS name has not
2196 been registered, should treat the NetBIOS name word-for-word as a DNS
2197 name and do a lookup with the DNS server for that name on behalf of
2198 the name-querying client.</para>
2200 <para>Note that the maximum length for a NetBIOS name is 15
2201 characters, so the DNS name (or DNS alias) can likewise only be
2202 15 characters, maximum.</para>
2204 <para><command>nmbd</command> spawns a second copy of itself to do the
2205 DNS name lookup requests, as doing a name lookup is a blocking
2206 action.</para>
2208 <para>See also the parameter <link linkend="WINSSUPPORT"><parameter>
2209 wins support</parameter></link>.</para>
2211 <para>Default: <command>dns proxy = yes</command></para></listitem>
2212 </varlistentry>
2216 <varlistentry>
2217 <term><anchor id="DOMAINADMINGROUP">domain admin group (G)</term>
2218 <listitem><para>This parameter is intended as a temporary solution
2219 to enable users to be a member of the "Domain Admins" group when
2220 a Samba host is acting as a PDC. A complete solution will be provided
2221 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2222 Please note that this parameter has a somewhat confusing name. It
2223 accepts a list of usernames and of group names in standard
2224 <filename>smb.conf</filename> notation.
2225 </para>
2227 <para>See also <link linkend="DOMAINGUESTGROUP"><parameter>domain
2228 guest group</parameter></link>, <link linkend="DOMAINLOGONS"><parameter>domain
2229 logons</parameter></link>
2230 </para>
2232 <para>Default: <emphasis>no domain administrators</emphasis></para>
2233 <para>Example: <command>domain admin group = root @wheel</command></para>
2234 </listitem>
2235 </varlistentry>
2240 <varlistentry>
2241 <term><anchor id="DOMAINGUESTGROUP">domain guest group (G)</term>
2242 <listitem><para>This parameter is intended as a temporary solution
2243 to enable users to be a member of the "Domain Guests" group when
2244 a Samba host is acting as a PDC. A complete solution will be provided
2245 by a system for mapping Windows NT/2000 groups onto UNIX groups.
2246 Please note that this parameter has a somewhat confusing name. It
2247 accepts a list of usernames and of group names in standard
2248 <filename>smb.conf</filename> notation.
2249 </para>
2251 <para>See also <link linkend="DOMAINADMINGROUP"><parameter>domain
2252 admin group</parameter></link>, <link linkend="DOMAINLOGONS"><parameter>domain
2253 logons</parameter></link>
2254 </para>
2256 <para>Default: <emphasis>no domain guests</emphasis></para>
2257 <para>Example: <command>domain guest group = nobody @guest</command></para>
2258 </listitem>
2259 </varlistentry>
2262 <varlistentry>
2263 <term><anchor id="DOMAINLOGONS">domain logons (G)</term>
2264 <listitem><para>If set to true, the Samba server will serve
2265 Windows 95/98 Domain logons for the <link linkend="WORKGROUP">
2266 <parameter>workgroup</parameter></link> it is in. Samba 2.2 also
2267 has limited capability to act as a domain controller for Windows
2268 NT 4 Domains. For more details on setting up this feature see
2269 the file DOMAINS.txt in the Samba documentation directory <filename>docs/
2270 </filename> shipped with the source code.</para>
2272 <para>Default: <command>domain logons = no</command></para></listitem>
2273 </varlistentry>
2277 <varlistentry>
2278 <term><anchor id="DOMAINMASTER">domain master (G)</term>
2279 <listitem><para>Tell <ulink url="nmbd.8.html"><command>
2280 nmbd(8)</command></ulink> to enable WAN-wide browse list
2281 collation. Setting this option causes <command>nmbd</command> to
2282 claim a special domain specific NetBIOS name that identifies
2283 it as a domain master browser for its given <link linkend="WORKGROUP">
2284 <parameter>workgroup</parameter></link>. Local master browsers
2285 in the same <parameter>workgroup</parameter> on broadcast-isolated
2286 subnets will give this <command>nmbd</command> their local browse lists,
2287 and then ask <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
2288 for a complete copy of the browse list for the whole wide area
2289 network. Browser clients will then contact their local master browser,
2290 and will receive the domain-wide browse list, instead of just the list
2291 for their broadcast-isolated subnet.</para>
2293 <para>Note that Windows NT Primary Domain Controllers expect to be
2294 able to claim this <parameter>workgroup</parameter> specific special
2295 NetBIOS name that identifies them as domain master browsers for
2296 that <parameter>workgroup</parameter> by default (i.e. there is no
2297 way to prevent a Windows NT PDC from attempting to do this). This
2298 means that if this parameter is set and <command>nmbd</command> claims
2299 the special name for a <parameter>workgroup</parameter> before a Windows
2300 NT PDC is able to do so then cross subnet browsing will behave
2301 strangely and may fail.</para>
2303 <para>If <link linkend="DOMAINLOGONS"><command>domain logons = yes</command>
2304 </link>, then the default behavior is to enable the <parameter>domain
2305 master</parameter> parameter. If <parameter>domain logons</parameter> is
2306 not enabled (the default setting), then neither will <parameter>domain
2307 master</parameter> be enabled by default.</para>
2309 <para>Default: <command>domain master = auto</command></para></listitem>
2310 </varlistentry>
2315 <varlistentry>
2316 <term><anchor id="DONTDESCEND">dont descend (S)</term>
2317 <listitem><para>There are certain directories on some systems
2318 (e.g., the <filename>/proc</filename> tree under Linux) that are either not
2319 of interest to clients or are infinitely deep (recursive). This
2320 parameter allows you to specify a comma-delimited list of directories
2321 that the server should always show as empty.</para>
2323 <para>Note that Samba can be very fussy about the exact format
2324 of the "dont descend" entries. For example you may need <filename>
2325 ./proc</filename> instead of just <filename>/proc</filename>.
2326 Experimentation is the best policy :-) </para>
2328 <para>Default: <emphasis>none (i.e., all directories are OK
2329 to descend)</emphasis></para>
2330 <para>Example: <command>dont descend = /proc,/dev</command></para>
2331 </listitem>
2332 </varlistentry>
2336 <varlistentry>
2337 <term><anchor id="DOSFILEMODE">dos filemode (S)</term>
2338 <listitem><para> The default behavior in Samba is to provide
2339 UNIX-like behavor where only the owner of a file/directory is
2340 able to change the permissions on it. However, this behavior
2341 is often confusing to DOS/Windows users. Enabling this parameter
2342 allows a user who has write access to the file (by whatever
2343 means) to modify the permissions on it. Note that a user
2344 belonging to the group owning the file will not be allowed to
2345 change permissions if the group is only granted read access.
2346 Ownership of the file/directory is not changed, only the permissions
2347 are modified.</para>
2349 <para>Default: <command>dos filemode = no</command></para>
2350 </listitem>
2351 </varlistentry>
2355 <varlistentry>
2356 <term><anchor id="DOSFILETIMERESOLUTION">dos filetime resolution (S)</term>
2357 <listitem><para>Under the DOS and Windows FAT filesystem, the finest
2358 granularity on time resolution is two seconds. Setting this parameter
2359 for a share causes Samba to round the reported time down to the
2360 nearest two second boundary when a query call that requires one second
2361 resolution is made to <ulink url="smbd.8.html"><command>smbd(8)</command>
2362 </ulink>.</para>
2364 <para>This option is mainly used as a compatibility option for Visual
2365 C++ when used against Samba shares. If oplocks are enabled on a
2366 share, Visual C++ uses two different time reading calls to check if a
2367 file has changed since it was last read. One of these calls uses a
2368 one-second granularity, the other uses a two second granularity. As
2369 the two second call rounds any odd second down, then if the file has a
2370 timestamp of an odd number of seconds then the two timestamps will not
2371 match and Visual C++ will keep reporting the file has changed. Setting
2372 this option causes the two timestamps to match, and Visual C++ is
2373 happy.</para>
2375 <para>Default: <command>dos filetime resolution = no</command></para>
2376 </listitem>
2377 </varlistentry>
2381 <varlistentry>
2382 <term><anchor id="DOSFILETIMES">dos filetimes (S)</term>
2383 <listitem><para>Under DOS and Windows, if a user can write to a
2384 file they can change the timestamp on it. Under POSIX semantics,
2385 only the owner of the file or root may change the timestamp. By
2386 default, Samba runs with POSIX semantics and refuses to change the
2387 timestamp on a file if the user <command>smbd</command> is acting
2388 on behalf of is not the file owner. Setting this option to <constant>
2389 True</constant> allows DOS semantics and smbd will change the file
2390 timestamp as DOS requires.</para>
2392 <para>Default: <command>dos filetimes = no</command></para></listitem>
2393 </varlistentry>
2397 <varlistentry>
2398 <term><anchor id="ENCRYPTPASSWORDS">encrypt passwords (G)</term>
2399 <listitem><para>This boolean controls whether encrypted passwords
2400 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
2401 above and also Windows 98 will by default expect encrypted passwords
2402 unless a registry entry is changed. To use encrypted passwords in
2403 Samba see the file ENCRYPTION.txt in the Samba documentation
2404 directory <filename>docs/</filename> shipped with the source code.</para>
2406 <para>In order for encrypted passwords to work correctly
2407 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink> must either
2408 have access to a local <ulink url="smbpasswd.5.html"><filename>smbpasswd(5)
2409 </filename></ulink> file (see the <ulink url="smbpasswd.8.html"><command>
2410 smbpasswd(8)</command></ulink> program for information on how to set up
2411 and maintain this file), or set the <link
2412 linkend="SECURITY">security=[serve|domain]</link> parameter which
2413 causes <command>smbd</command> to authenticate against another
2414 server.</para>
2416 <para>Default: <command>encrypt passwords = no</command></para></listitem>
2417 </varlistentry>
2420 <varlistentry>
2421 <term><anchor id="ENHANCEDBROWSING">enhanced browsing (G)</term>
2422 <listitem><para>This option enables a couple of enhancements to
2423 cross-subnet browse propogation that have been added in Samba
2424 but which are not standard in Microsoft implementations.
2425 <emphasis>These enhancements are currently only available in
2426 the HEAD Samba CVS tree (not Samba 2.2.x).</emphasis></para>
2428 <para>The first enhancement to browse propogation consists of a regular
2429 wildcard query to a Samba WINS server for all Domain Master Browsers,
2430 followed by a browse synchronisation with each of the returned
2431 DMBs. The second enhancement consists of a regular randomised browse
2432 synchronisation with all currently known DMBs.</para>
2434 <para>You may wish to disable this option if you have a problem with empty
2435 workgroups not disappearing from browse lists. Due to the restrictions
2436 of the browse protocols these enhancements can cause a empty workgroup
2437 to stay around forever which can be annoying.</para>
2439 <para>In general you should leave this option enabled as it makes
2440 cross-subnet browse propogation much more reliable.</para>
2442 <para>Default: <command>enhanced browsing = yes</command></para>
2443 </listitem>
2444 </varlistentry>
2447 <varlistentry>
2448 <term><anchor id="ENUMPORTSCOMMAND">enumports command (G)</term>
2449 <listitem><para>The concept of a "port" is fairly foreign
2450 to UNIX hosts. Under Windows NT/2000 print servers, a port
2451 is associated with a port monitor and generally takes the form of
2452 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
2453 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
2454 port defined--<constant>"Samba Printer Port"</constant>. Under
2455 Windows NT/2000, all printers must have a valid port name.
2456 If you wish to have a list of ports displayed (<command>smbd
2457 </command> does not use a port name for anything) other than
2458 the default <constant>"Samba Printer Port"</constant>, you
2459 can define <parameter>enumports command</parameter> to point to
2460 a program which should generate a list of ports, one per line,
2461 to standard output. This listing will then be used in response
2462 to the level 1 and 2 EnumPorts() RPC.</para>
2464 <para>Default: <emphasis>no enumports command</emphasis></para>
2465 <para>Example: <command>enumports command = /usr/bin/listports
2466 </command></para>
2467 </listitem>
2468 </varlistentry>
2470 <varlistentry>
2471 <term><anchor id="EXEC">exec (S)</term>
2472 <listitem><para>This is a synonym for <link linkend="PREEXEC">
2473 <parameter>preexec</parameter></link>.</para></listitem>
2474 </varlistentry>
2478 <varlistentry>
2479 <term><anchor id="FAKEDIRECTORYCREATETIMES">fake directory create times (S)</term>
2480 <listitem><para>NTFS and Windows VFAT file systems keep a create
2481 time for all files and directories. This is not the same as the
2482 ctime - status change time - that Unix keeps, so Samba by default
2483 reports the earliest of the various times Unix does keep. Setting
2484 this parameter for a share causes Samba to always report midnight
2485 1-1-1980 as the create time for directories.</para>
2487 <para>This option is mainly used as a compatibility option for
2488 Visual C++ when used against Samba shares. Visual C++ generated
2489 makefiles have the object directory as a dependency for each object
2490 file, and a make rule to create the directory. Also, when NMAKE
2491 compares timestamps it uses the creation time when examining a
2492 directory. Thus the object directory will be created if it does not
2493 exist, but once it does exist it will always have an earlier
2494 timestamp than the object files it contains.</para>
2496 <para>However, Unix time semantics mean that the create time
2497 reported by Samba will be updated whenever a file is created or
2498 or deleted in the directory. NMAKE finds all object files in
2499 the object directory. The timestamp of the last one built is then
2500 compared to the timestamp of the object dircetory. If the
2501 directory's timestamp if newer, then all object files
2502 will be rebuilt. Enabling this option
2503 ensures directories always predate their contents and an NMAKE build
2504 will proceed as expected.</para>
2506 <para>Default: <command>fake directory create times = no</command></para>
2507 </listitem>
2508 </varlistentry>
2512 <varlistentry>
2513 <term><anchor id="FAKEOPLOCKS">fake oplocks (S)</term>
2514 <listitem><para>Oplocks are the way that SMB clients get permission
2515 from a server to locally cache file operations. If a server grants
2516 an oplock (opportunistic lock) then the client is free to assume
2517 that it is the only one accessing the file and it will aggressively
2518 cache file data. With some oplock types the client may even cache
2519 file open/close operations. This can give enormous performance benefits.
2520 </para>
2522 <para>When you set <command>fake oplocks = yes</command>, <ulink
2523 url="smbd.8.html"><command>smbd(8)</command></ulink> will
2524 always grant oplock requests no matter how many clients are using
2525 the file.</para>
2527 <para>It is generally much better to use the real <link
2528 linkend="OPLOCKS"><parameter>oplocks</parameter></link> support rather
2529 than this parameter.</para>
2531 <para>If you enable this option on all read-only shares or
2532 shares that you know will only be accessed from one client at a
2533 time such as physically read-only media like CDROMs, you will see
2534 a big performance improvement on many operations. If you enable
2535 this option on shares where multiple clients may be accessing the
2536 files read-write at the same time you can get data corruption. Use
2537 this option carefully!</para>
2539 <para>Default: <command>fake oplocks = no</command></para></listitem>
2540 </varlistentry>
2544 <varlistentry>
2545 <term><anchor id="FOLLOWSYMLINKS">follow symlinks (S)</term>
2546 <listitem><para>This parameter allows the Samba administrator
2547 to stop <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
2548 from following symbolic links in a particular share. Setting this
2549 parameter to <constant>no</constant> prevents any file or directory
2550 that is a symbolic link from being followed (the user will get an
2551 error). This option is very useful to stop users from adding a
2552 symbolic link to <filename>/etc/passwd</filename> in their home
2553 directory for instance. However it will slow filename lookups
2554 down slightly.</para>
2556 <para>This option is enabled (i.e. <command>smbd</command> will
2557 follow symbolic links) by default.</para>
2559 <para>Default: <command>follow symlinks = yes</command></para></listitem>
2560 </varlistentry>
2564 <varlistentry>
2565 <term><anchor id="FORCECREATEMODE">force create mode (S)</term>
2566 <listitem><para>This parameter specifies a set of UNIX mode bit
2567 permissions that will <emphasis>always</emphasis> be set on a
2568 file created by Samba. This is done by bitwise 'OR'ing these bits onto
2569 the mode bits of a file that is being created or having its
2570 permissions changed. The default for this parameter is (in octal)
2571 000. The modes in this parameter are bitwise 'OR'ed onto the file
2572 mode after the mask set in the <parameter>create mask</parameter>
2573 parameter is applied.</para>
2575 <para>Note that by default this parameter does not apply to permissions
2576 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2577 this mask on access control lists also, they need to set the <link
2578 linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with
2579 mask</parameter></link> to true.</para>
2581 <para>See also the parameter <link linkend="CREATEMASK"><parameter>create
2582 mask</parameter></link> for details on masking mode bits on files.</para>
2584 <para>See also the <link linkend="INHERITPERMISSIONS"><parameter>inherit
2585 permissions</parameter></link> parameter.</para>
2587 <para>Default: <command>force create mode = 000</command></para>
2588 <para>Example: <command>force create mode = 0755</command></para>
2590 <para>would force all created files to have read and execute
2591 permissions set for 'group' and 'other' as well as the
2592 read/write/execute bits set for the 'user'.</para>
2593 </listitem>
2594 </varlistentry>
2598 <varlistentry>
2599 <term><anchor id="FORCEDIRECTORYMODE">force directory mode (S)</term>
2600 <listitem><para>This parameter specifies a set of UNIX mode bit
2601 permissions that will <emphasis>always</emphasis> be set on a directory
2602 created by Samba. This is done by bitwise 'OR'ing these bits onto the
2603 mode bits of a directory that is being created. The default for this
2604 parameter is (in octal) 0000 which will not add any extra permission
2605 bits to a created directory. This operation is done after the mode
2606 mask in the parameter <parameter>directory mask</parameter> is
2607 applied.</para>
2609 <para>Note that by default this parameter does not apply to permissions
2610 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2611 this mask on access control lists also, they need to set the <link
2612 linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with
2613 mask</parameter></link> to true.</para>
2615 <para>See also the parameter <link linkend="DIRECTORYMASK"><parameter>
2616 directory mask</parameter></link> for details on masking mode bits
2617 on created directories.</para>
2619 <para>See also the <link linkend="INHERITPERMISSIONS"><parameter>
2620 inherit permissions</parameter></link> parameter.</para>
2622 <para>Default: <command>force directory mode = 000</command></para>
2623 <para>Example: <command>force directory mode = 0755</command></para>
2625 <para>would force all created directories to have read and execute
2626 permissions set for 'group' and 'other' as well as the
2627 read/write/execute bits set for the 'user'.</para>
2628 </listitem>
2629 </varlistentry>
2633 <varlistentry>
2634 <term><anchor id="FORCEDIRECTORYSECURITYMODE">force directory
2635 security mode (S)</term>
2636 <listitem><para>This parameter controls what UNIX permission bits
2637 can be modified when a Windows NT client is manipulating the UNIX
2638 permission on a directory using the native NT security dialog box.</para>
2640 <para>This parameter is applied as a mask (OR'ed with) to the
2641 changed permission bits, thus forcing any bits in this mask that
2642 the user may have modified to be on. Essentially, one bits in this
2643 mask may be treated as a set of bits that, when modifying security
2644 on a directory, the user has always set to be 'on'.</para>
2646 <para>If not set explicitly this parameter is 000, which
2647 allows a user to modify all the user/group/world permissions on a
2648 directory without restrictions.</para>
2650 <para><emphasis>Note</emphasis> that users who can access the
2651 Samba server through other means can easily bypass this restriction,
2652 so it is primarily useful for standalone "appliance" systems.
2653 Administrators of most normal systems will probably want to leave
2654 it set as 0000.</para>
2656 <para>See also the <link linkend="DIRECTORYSECURITYMASK"><parameter>
2657 directory security mask</parameter></link>, <link linkend="SECURITYMASK">
2658 <parameter>security mask</parameter></link>,
2659 <link linkend="FORCESECURITYMODE"><parameter>force security mode
2660 </parameter></link> parameters.</para>
2662 <para>Default: <command>force directory security mode = 0</command></para>
2663 <para>Example: <command>force directory security mode = 700</command></para>
2664 </listitem>
2665 </varlistentry>
2670 <varlistentry>
2671 <term><anchor id="FORCEGROUP">force group (S)</term>
2672 <listitem><para>This specifies a UNIX group name that will be
2673 assigned as the default primary group for all users connecting
2674 to this service. This is useful for sharing files by ensuring
2675 that all access to files on service will use the named group for
2676 their permissions checking. Thus, by assigning permissions for this
2677 group to the files and directories within this service the Samba
2678 administrator can restrict or allow sharing of these files.</para>
2680 <para>In Samba 2.0.5 and above this parameter has extended
2681 functionality in the following way. If the group name listed here
2682 has a '+' character prepended to it then the current user accessing
2683 the share only has the primary group default assigned to this group
2684 if they are already assigned as a member of that group. This allows
2685 an administrator to decide that only users who are already in a
2686 particular group will create files with group ownership set to that
2687 group. This gives a finer granularity of ownership assignment. For
2688 example, the setting <filename>force group = +sys</filename> means
2689 that only users who are already in group sys will have their default
2690 primary group assigned to sys when accessing this Samba share. All
2691 other users will retain their ordinary primary group.</para>
2693 <para>If the <link linkend="FORCEUSER"><parameter>force user
2694 </parameter></link> parameter is also set the group specified in
2695 <parameter>force group</parameter> will override the primary group
2696 set in <parameter>force user</parameter>.</para>
2698 <para>See also <link linkend="FORCEUSER"><parameter>force
2699 user</parameter></link>.</para>
2701 <para>Default: <emphasis>no forced group</emphasis></para>
2702 <para>Example: <command>force group = agroup</command></para>
2703 </listitem>
2704 </varlistentry>
2708 <varlistentry>
2709 <term><anchor id="FORCESECURITYMODE">force security mode (S)</term>
2710 <listitem><para>This parameter controls what UNIX permission
2711 bits can be modified when a Windows NT client is manipulating
2712 the UNIX permission on a file using the native NT security dialog
2713 box.</para>
2715 <para>This parameter is applied as a mask (OR'ed with) to the
2716 changed permission bits, thus forcing any bits in this mask that
2717 the user may have modified to be on. Essentially, one bits in this
2718 mask may be treated as a set of bits that, when modifying security
2719 on a file, the user has always set to be 'on'.</para>
2721 <para>If not set explicitly this parameter is set to 0,
2722 and allows a user to modify all the user/group/world permissions on a file,
2723 with no restrictions.</para>
2725 <para><emphasis>Note</emphasis> that users who can access
2726 the Samba server through other means can easily bypass this restriction,
2727 so it is primarily useful for standalone "appliance" systems.
2728 Administrators of most normal systems will probably want to leave
2729 this set to 0000.</para>
2731 <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>
2732 force directory security mode</parameter></link>,
2733 <link linkend="DIRECTORYSECURITYMASK"><parameter>directory security
2734 mask</parameter></link>, <link linkend="SECURITYMASK"><parameter>
2735 security mask</parameter></link> parameters.</para>
2737 <para>Default: <command>force security mode = 0</command></para>
2738 <para>Example: <command>force security mode = 700</command></para>
2739 </listitem>
2740 </varlistentry>
2744 <varlistentry>
2745 <term><anchor id="FORCEUSER">force user (S)</term>
2746 <listitem><para>This specifies a UNIX user name that will be
2747 assigned as the default user for all users connecting to this service.
2748 This is useful for sharing files. You should also use it carefully
2749 as using it incorrectly can cause security problems.</para>
2751 <para>This user name only gets used once a connection is established.
2752 Thus clients still need to connect as a valid user and supply a
2753 valid password. Once connected, all file operations will be performed
2754 as the "forced user", no matter what username the client connected
2755 as. This can be very useful.</para>
2757 <para>In Samba 2.0.5 and above this parameter also causes the
2758 primary group of the forced user to be used as the primary group
2759 for all file activity. Prior to 2.0.5 the primary group was left
2760 as the primary group of the connecting user (this was a bug).</para>
2762 <para>See also <link linkend="FORCEGROUP"><parameter>force group
2763 </parameter></link></para>
2765 <para>Default: <emphasis>no forced user</emphasis></para>
2766 <para>Example: <command>force user = auser</command></para>
2767 </listitem>
2768 </varlistentry>
2772 <varlistentry>
2773 <term><anchor id="FSTYPE">fstype (S)</term>
2774 <listitem><para>This parameter allows the administrator to
2775 configure the string that specifies the type of filesystem a share
2776 is using that is reported by <ulink url="smbd.8.html"><command>smbd(8)
2777 </command></ulink> when a client queries the filesystem type
2778 for a share. The default type is <constant>NTFS</constant> for
2779 compatibility with Windows NT but this can be changed to other
2780 strings such as <constant>Samba</constant> or <constant>FAT
2781 </constant> if required.</para>
2783 <para>Default: <command>fstype = NTFS</command></para>
2784 <para>Example: <command>fstype = Samba</command></para></listitem>
2785 </varlistentry>
2789 <varlistentry>
2790 <term><anchor id="GETWDCACHE">getwd cache (G)</term>
2791 <listitem><para>This is a tuning option. When this is enabled a
2792 caching algorithm will be used to reduce the time taken for getwd()
2793 calls. This can have a significant impact on performance, especially
2794 when the <link linkend="WIDELINKS"><parameter>wide links</parameter>
2795 </link>parameter is set to <constant>False</constant>.</para>
2797 <para>Default: <command>getwd cache = yes</command></para>
2798 </listitem>
2799 </varlistentry>
2803 <varlistentry>
2804 <term><anchor id="GROUP">group (S)</term>
2805 <listitem><para>Synonym for <link linkend="FORCEGROUP"><parameter>force
2806 group</parameter></link>.</para></listitem>
2807 </varlistentry>
2811 <varlistentry>
2812 <term><anchor id="GUESTACCOUNT">guest account (S)</term>
2813 <listitem><para>This is a username which will be used for access
2814 to services which are specified as <link linkend="GUESTOK"><parameter>
2815 guest ok</parameter></link> (see below). Whatever privileges this
2816 user has will be available to any client connecting to the guest service.
2817 Typically this user will exist in the password file, but will not
2818 have a valid login. The user account "ftp" is often a good choice
2819 for this parameter. If a username is specified in a given service,
2820 the specified username overrides this one.</para>
2822 <para>One some systems the default guest account "nobody" may not
2823 be able to print. Use another account in this case. You should test
2824 this by trying to log in as your guest user (perhaps by using the
2825 <command>su -</command> command) and trying to print using the
2826 system print command such as <command>lpr(1)</command> or <command>
2827 lp(1)</command>.</para>
2829 <para>Default: <emphasis>specified at compile time, usually
2830 "nobody"</emphasis></para>
2832 <para>Example: <command>guest account = ftp</command></para></listitem>
2833 </varlistentry>
2837 <varlistentry>
2838 <term><anchor id="GUESTOK">guest ok (S)</term>
2839 <listitem><para>If this parameter is <constant>yes</constant> for
2840 a service, then no password is required to connect to the service.
2841 Privileges will be those of the <link linkend="GUESTACCOUNT"><parameter>
2842 guest account</parameter></link>.</para>
2844 <para>See the section below on <link linkend="SECURITY"><parameter>
2845 security</parameter></link> for more information about this option.
2846 </para>
2848 <para>Default: <command>guest ok = no</command></para></listitem>
2849 </varlistentry>
2853 <varlistentry>
2854 <term><anchor id="GUESTONLY">guest only (S)</term>
2855 <listitem><para>If this parameter is <constant>yes</constant> for
2856 a service, then only guest connections to the service are permitted.
2857 This parameter will have no effect if <link linkend="GUESTOK">
2858 <parameter>guest ok</parameter></link> is not set for the service.</para>
2860 <para>See the section below on <link linkend="SECURITY"><parameter>
2861 security</parameter></link> for more information about this option.
2862 </para>
2864 <para>Default: <command>guest only = no</command></para></listitem>
2865 </varlistentry>
2869 <varlistentry>
2870 <term><anchor id="HIDEDOTFILES">hide dot files (S)</term>
2871 <listitem><para>This is a boolean parameter that controls whether
2872 files starting with a dot appear as hidden files.</para>
2874 <para>Default: <command>hide dot files = yes</command></para></listitem>
2875 </varlistentry>
2879 <varlistentry>
2880 <term><anchor id="HIDEFILES">hide files(S)</term>
2881 <listitem><para>This is a list of files or directories that are not
2882 visible but are accessible. The DOS 'hidden' attribute is applied
2883 to any files or directories that match.</para>
2885 <para>Each entry in the list must be separated by a '/',
2886 which allows spaces to be included in the entry. '*'
2887 and '?' can be used to specify multiple files or directories
2888 as in DOS wildcards.</para>
2890 <para>Each entry must be a Unix path, not a DOS path and must
2891 not include the Unix directory separator '/'.</para>
2893 <para>Note that the case sensitivity option is applicable
2894 in hiding files.</para>
2896 <para>Setting this parameter will affect the performance of Samba,
2897 as it will be forced to check all files and directories for a match
2898 as they are scanned.</para>
2900 <para>See also <link linkend="HIDEDOTFILES"><parameter>hide
2901 dot files</parameter></link>, <link linkend="VETOFILES"><parameter>
2902 veto files</parameter></link> and <link linkend="CASESENSITIVE">
2903 <parameter>case sensitive</parameter></link>.</para>
2905 <para>Default: <emphasis>no file are hidden</emphasis></para>
2906 <para>Example: <command>hide files =
2907 /.*/DesktopFolderDB/TrashFor%m/resource.frk/</command></para>
2909 <para>The above example is based on files that the Macintosh
2910 SMB client (DAVE) available from <ulink url="http://www.thursby.com">
2911 Thursby</ulink> creates for internal use, and also still hides
2912 all files beginning with a dot.</para></listitem>
2913 </varlistentry>
2917 <varlistentry>
2918 <term><anchor id="HIDELOCALUSERS">hide local users(G)</term>
2919 <listitem><para>This parameter toggles the hiding of local UNIX
2920 users (root, wheel, floppy, etc) from remote clients.</para>
2922 <para>Default: <command>hide local users = no</command></para></listitem>
2923 </varlistentry>
2927 <varlistentry>
2928 <term><anchor id="HOMEDIRMAP">homedir map (G)</term>
2929 <listitem><para>If<link linkend="NISHOMEDIR"><parameter>nis homedir
2930 </parameter></link> is <constant>True</constant>, and <ulink
2931 url="smbd.8.html"><command>smbd(8)</command></ulink> is also acting
2932 as a Win95/98 <parameter>logon server</parameter> then this parameter
2933 specifies the NIS (or YP) map from which the server for the user's
2934 home directory should be extracted. At present, only the Sun
2935 auto.home map format is understood. The form of the map is:</para>
2937 <para><command>username server:/some/file/system</command></para>
2939 <para>and the program will extract the servername from before
2940 the first ':'. There should probably be a better parsing system
2941 that copes with different map formats and also Amd (another
2942 automounter) maps.</para>
2944 <para><emphasis>NOTE :</emphasis>A working NIS client is required on
2945 the system for this option to work.</para>
2947 <para>See also <link linkend="NISHOMEDIR"><parameter>nis homedir</parameter>
2948 </link>, <link linkend="DOMAINLOGONS"><parameter>domain logons</parameter>
2949 </link>.</para>
2951 <para>Default: <command>homedir map = &lt;empty string&gt;</command></para>
2952 <para>Example: <command>homedir map = amd.homedir</command></para>
2953 </listitem>
2954 </varlistentry>
2960 <varlistentry>
2961 <term><anchor id="HOSTMSDFS">host msdfs (G)</term>
2962 <listitem><para>This boolean parameter is only available
2963 if Samba has been configured and compiled with the <command>
2964 --with-msdfs</command> option. If set to <constant>yes</constant>,
2965 Samba will act as a Dfs server, and allow Dfs-aware clients
2966 to browse Dfs trees hosted on the server.</para>
2968 <para>See also the <link linkend="MSDFSROOT"><parameter>
2969 msdfs root</parameter></link> share level parameter. For
2970 more information on setting up a Dfs tree on Samba,
2971 refer to <ulink url="msdfs_setup.html">msdfs_setup.html</ulink>.
2972 </para>
2974 <para>Default: <command>host msdfs = no</command></para>
2975 </listitem>
2976 </varlistentry>
2979 <varlistentry>
2980 <term><anchor id="HOSTSALLOW">hosts allow (S)</term>
2981 <listitem><para>A synonym for this parameter is <parameter>allow
2982 hosts</parameter>.</para>
2984 <para>This parameter is a comma, space, or tab delimited
2985 set of hosts which are permitted to access a service.</para>
2987 <para>If specified in the [global] section then it will
2988 apply to all services, regardless of whether the individual
2989 service has a different setting.</para>
2991 <para>You can specify the hosts by name or IP number. For
2992 example, you could restrict access to only the hosts on a
2993 Class C subnet with something like <command>allow hosts = 150.203.5.
2994 </command>. The full syntax of the list is described in the man
2995 page <filename>hosts_access(5)</filename>. Note that this man
2996 page may not be present on your system, so a brief description will
2997 be given here also.</para>
2999 <para>Note that the localhost address 127.0.0.1 will always
3000 be allowed access unless specifically denied by a <link
3001 linkend="HOSTSDENY"><parameter>hosts deny</parameter></link> option.</para>
3003 <para>You can also specify hosts by network/netmask pairs and
3004 by netgroup names if your system supports netgroups. The
3005 <emphasis>EXCEPT</emphasis> keyword can also be used to limit a
3006 wildcard list. The following examples may provide some help:</para>
3008 <para>Example 1: allow all IPs in 150.203.*.*; except one</para>
3010 <para><command>hosts allow = 150.203. EXCEPT 150.203.6.66</command></para>
3012 <para>Example 2: allow hosts that match the given network/netmask</para>
3014 <para><command>hosts allow = 150.203.15.0/255.255.255.0</command></para>
3016 <para>Example 3: allow a couple of hosts</para>
3018 <para><command>hosts allow = lapland, arvidsjaur</command></para>
3020 <para>Example 4: allow only hosts in NIS netgroup "foonet", but
3021 deny access from one particular host</para>
3023 <para><command>hosts allow = @foonet</command></para>
3025 <para><command>hosts deny = pirate</command></para>
3027 <para>Note that access still requires suitable user-level passwords.</para>
3029 <para>See <ulink url="testparm.1.html"><command>testparm(1)</command>
3030 </ulink> for a way of testing your host access to see if it does
3031 what you expect.</para>
3033 <para>Default: <emphasis>none (i.e., all hosts permitted access)
3034 </emphasis></para>
3036 <para>Example: <command>allow hosts = 150.203.5. myhost.mynet.edu.au
3037 </command></para>
3038 </listitem>
3039 </varlistentry>
3043 <varlistentry>
3044 <term><anchor id="HOSTSDENY">hosts deny (S)</term>
3045 <listitem><para>The opposite of <parameter>hosts allow</parameter>
3046 - hosts listed here are <emphasis>NOT</emphasis> permitted access to
3047 services unless the specific services have their own lists to override
3048 this one. Where the lists conflict, the <parameter>allow</parameter>
3049 list takes precedence.</para>
3051 <para>Default: <emphasis>none (i.e., no hosts specifically excluded)
3052 </emphasis></para>
3054 <para>Example: <command>hosts deny = 150.203.4. badhost.mynet.edu.au
3055 </command></para></listitem>
3056 </varlistentry>
3060 <varlistentry>
3061 <term><anchor id="HOSTSEQUIV">hosts equiv (G)</term>
3062 <listitem><para>If this global parameter is a non-null string,
3063 it specifies the name of a file to read for the names of hosts
3064 and users who will be allowed access without specifying a password.
3065 </para>
3067 <para>This is not be confused with <link linkend="HOSTSALLOW">
3068 <parameter>hosts allow</parameter></link> which is about hosts
3069 access to services and is more useful for guest services. <parameter>
3070 hosts equiv</parameter> may be useful for NT clients which will
3071 not supply passwords to samba.</para>
3073 <para><emphasis>NOTE :</emphasis> The use of <parameter>hosts equiv
3074 </parameter> can be a major security hole. This is because you are
3075 trusting the PC to supply the correct username. It is very easy to
3076 get a PC to supply a false username. I recommend that the
3077 <parameter>hosts equiv</parameter> option be only used if you really
3078 know what you are doing, or perhaps on a home network where you trust
3079 your spouse and kids. And only if you <emphasis>really</emphasis> trust
3080 them :-).</para>
3082 <para>Default: <emphasis>no host equivalences</emphasis></para>
3083 <para>Example: <command>hosts equiv = /etc/hosts.equiv</command></para>
3084 </listitem>
3085 </varlistentry>
3089 <varlistentry>
3090 <term><anchor id="INCLUDE">include (G)</term>
3091 <listitem><para>This allows you to include one config file
3092 inside another. The file is included literally, as though typed
3093 in place.</para>
3095 <para>It takes the standard substitutions, except <parameter>%u
3096 </parameter>, <parameter>%P</parameter> and <parameter>%S</parameter>.
3097 </para>
3099 <para>Default: <emphasis>no file included</emphasis></para>
3100 <para>Example: <command>include = /usr/local/samba/lib/admin_smb.conf
3101 </command></para></listitem>
3102 </varlistentry>
3106 <varlistentry>
3107 <term><anchor id="INHERITPERMISSIONS">inherit permissions (S)</term>
3108 <listitem><para>The permissions on new files and directories
3109 are normally governed by <link linkend="CREATEMASK"><parameter>
3110 create mask</parameter></link>, <link linkend="DIRECTORYMASK">
3111 <parameter>directory mask</parameter></link>, <link
3112 linkend="FORCECREATEMODE"><parameter>force create mode</parameter>
3113 </link> and <link linkend="FORCEDIRECTORYMODE"><parameter>force
3114 directory mode</parameter></link> but the boolean inherit
3115 permissions parameter overrides this.</para>
3117 <para>New directories inherit the mode of the parent directory,
3118 including bits such as setgid.</para>
3120 <para>New files inherit their read/write bits from the parent
3121 directory. Their execute bits continue to be determined by
3122 <link linkend="MAPARCHIVE"><parameter>map archive</parameter>
3123 </link>, <link linkend="MAPHIDDEN"><parameter>map hidden</parameter>
3124 </link> and <link linkend="MAPSYSTEM"><parameter>map system</parameter>
3125 </link> as usual.</para>
3127 <para>Note that the setuid bit is <emphasis>never</emphasis> set via
3128 inheritance (the code explicitly prohibits this).</para>
3130 <para>This can be particularly useful on large systems with
3131 many users, perhaps several thousand,to allow a single [homes]
3132 share to be used flexibly by each user.</para>
3134 <para>See also <link linkend="CREATEMASK"><parameter>create mask
3135 </parameter></link>, <link linkend="DIRECTORYMASK"><parameter>
3136 directory mask</parameter></link>, <link linkend="FORCECREATEMODE">
3137 <parameter>force create mode</parameter></link> and <link
3138 linkend="FORCEDIRECTORYMODE"><parameter>force directory mode</parameter>
3139 </link>.</para>
3141 <para>Default: <command>inherit permissions = no</command></para>
3142 </listitem>
3143 </varlistentry>
3147 <varlistentry>
3148 <term><anchor id="INTERFACES">interfaces (G)</term>
3149 <listitem><para>This option allows you to override the default
3150 network interfaces list that Samba will use for browsing, name
3151 registration and other NBT traffic. By default Samba will query
3152 the kernel for the list of all active interfaces and use any
3153 interfaces except 127.0.0.1 that are broadcast capable.</para>
3155 <para>The option takes a list of interface strings. Each string
3156 can be in any of the following forms:</para>
3158 <itemizedlist>
3159 <listitem><para>a network interface name (such as eth0).
3160 This may include shell-like wildcards so eth* will match
3161 any interface starting with the substring "eth"</para></listitem>
3163 <listitem><para>an IP address. In this case the netmask is
3164 determined from the list of interfaces obtained from the
3165 kernel</para></listitem>
3167 <listitem><para>an IP/mask pair. </para></listitem>
3169 <listitem><para>a broadcast/mask pair.</para></listitem>
3170 </itemizedlist>
3172 <para>The "mask" parameters can either be a bit length (such
3173 as 24 for a C class network) or a full netmask in dotted
3174 decimal form.</para>
3176 <para>The "IP" parameters above can either be a full dotted
3177 decimal IP address or a hostname which will be looked up via
3178 the OS's normal hostname resolution mechanisms.</para>
3180 <para>For example, the following line:</para>
3182 <para><command>interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
3183 </command></para>
3185 <para>would configure three network interfaces corresponding
3186 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
3187 The netmasks of the latter two interfaces would be set to 255.255.255.0.</para>
3189 <para>See also <link linkend="BINDINTERFACESONLY"><parameter>bind
3190 interfaces only</parameter></link>.</para>
3192 <para>Default: <emphasis>all active interfaces except 127.0.0.1
3193 that are broadcast capable</emphasis></para>
3194 </listitem>
3195 </varlistentry>
3199 <varlistentry>
3200 <term><anchor id="INVALIDUSERS">invalid users (S)</term>
3201 <listitem><para>This is a list of users that should not be allowed
3202 to login to this service. This is really a <emphasis>paranoid</emphasis>
3203 check to absolutely ensure an improper setting does not breach
3204 your security.</para>
3206 <para>A name starting with a '@' is interpreted as an NIS
3207 netgroup first (if your system supports NIS), and then as a UNIX
3208 group if the name was not found in the NIS netgroup database.</para>
3210 <para>A name starting with '+' is interpreted only
3211 by looking in the UNIX group database. A name starting with
3212 '&' is interpreted only by looking in the NIS netgroup database
3213 (this requires NIS to be working on your system). The characters
3214 '+' and '&' may be used at the start of the name in either order
3215 so the value <parameter>+&amp;group</parameter> means check the
3216 UNIX group database, followed by the NIS netgroup database, and
3217 the value <parameter>&+group"</parameter> means check the NIS
3218 netgroup database, followed by the UNIX group database (the
3219 same as the '@' prefix).</para>
3221 <para>The current servicename is substituted for <parameter>%S</parameter>.
3222 This is useful in the [homes] section.</para>
3224 <para>See also <link linkend="VALIDUSERS"><parameter>valid users
3225 </parameter></link>.</para>
3227 <para>Default: <emphasis>no invalid users</emphasis></para>
3228 <para>Example: <command>invalid users = root fred admin @wheel
3229 </command></para>
3230 </listitem>
3231 </varlistentry>
3235 <varlistentry>
3236 <term><anchor id="KEEPALIVE">keepalive (G)</term>
3237 <listitem><para>The value of the parameter (an integer) represents
3238 the number of seconds between <parameter>keepalive</parameter>
3239 packets. If this parameter is zero, no keepalive packets will be
3240 sent. Keepalive packets, if sent, allow the server to tell whether
3241 a client is still present and responding.</para>
3243 <para>Keepalives should, in general, not be needed if the socket
3244 being used has the SO_KEEPALIVE attribute set on it (see <link
3245 linkend="SOCKETOPTIONS"><parameter>socket options</parameter></link>).
3246 Basically you should only use this option if you strike difficulties.</para>
3248 <para>Default: <command>keepalive = 300</command></para>
3249 <para>Example: <command>keepalive = 600</command></para>
3250 </listitem>
3251 </varlistentry>
3255 <varlistentry>
3256 <term><anchor id="KERNELOPLOCKS">kernel oplocks (G)</term>
3257 <listitem><para>For UNIXes that support kernel based <link
3258 linkend="OPLOCKS"><parameter>oplocks</parameter></link>
3259 (currently only IRIX and the Linux 2.4 kernel), this parameter
3260 allows the use of them to be turned on or off.</para>
3262 <para>Kernel oplocks support allows Samba <parameter>oplocks
3263 </parameter> to be broken whenever a local UNIX process or NFS operation
3264 accesses a file that <ulink url="smbd.8.html"><command>smbd(8)</command>
3265 </ulink> has oplocked. This allows complete data consistency between
3266 SMB/CIFS, NFS and local file access (and is a <emphasis>very</emphasis>
3267 cool feature :-).</para>
3269 <para>This parameter defaults to <constant>on</constant> on systems
3270 that have the support, and <constant>off</constant> on systems that
3271 don't. You should never need to touch this parameter.</para>
3273 <para>See also the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
3274 </link> and <link linkend="LEVEL2OPLOCKS"><parameter>level2 oplocks
3275 </parameter></link> parameters.</para>
3277 <para>Default: <command>kernel oplocks = yes</command></para>
3278 </listitem>
3279 </varlistentry>
3284 <varlistentry>
3285 <term><anchor id="LANMANAUTH">lanman auth (G)</term>
3286 <listitem><para>This parameter determines whether or not smbd will
3287 attempt to authentication users using the LANMAN password hash.
3288 If disabled, only clients which support NT password hashes (e.g. Windows
3289 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
3290 network client) will be able to connect to the Samba host.</para>
3292 <para>Default : <command>lanman auth = yes</command></para>
3293 </listitem>
3294 </varlistentry>
3299 <varlistentry>
3300 <term><anchor id="LEVEL2OPLOCKS">level2 oplocks (S)</term>
3301 <listitem><para>This parameter controls whether Samba supports
3302 level2 (read-only) oplocks on a share.</para>
3304 <para>Level2, or read-only oplocks allow Windows NT clients
3305 that have an oplock on a file to downgrade from a read-write oplock
3306 to a read-only oplock once a second client opens the file (instead
3307 of releasing all oplocks on a second open, as in traditional,
3308 exclusive oplocks). This allows all openers of the file that
3309 support level2 oplocks to cache the file for read-ahead only (ie.
3310 they may not cache writes or lock requests) and increases performance
3311 for many accesses of files that are not commonly written (such as
3312 application .EXE files).</para>
3314 <para>Once one of the clients which have a read-only oplock
3315 writes to the file all clients are notified (no reply is needed
3316 or waited for) and told to break their oplocks to "none" and
3317 delete any read-ahead caches.</para>
3319 <para>It is recommended that this parameter be turned on
3320 to speed access to shared executables.</para>
3322 <para>For more discussions on level2 oplocks see the CIFS spec.</para>
3324 <para>Currently, if <link linkend="KERNELOPLOCKS"><parameter>kernel
3325 oplocks</parameter></link> are supported then level2 oplocks are
3326 not granted (even if this parameter is set to <constant>yes</constant>).
3327 Note also, the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
3328 </link> parameter must be set to "true" on this share in order for
3329 this parameter to have any effect.</para>
3331 <para>See also the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
3332 </link> and <link linkend="OPLOCKS"><parameter>kernel oplocks</parameter>
3333 </link> parameters.</para>
3335 <para>Default: <command>level2 oplocks = yes</command></para>
3336 </listitem>
3337 </varlistentry>
3343 <varlistentry>
3344 <term><anchor id="LMANNOUNCE">lm announce (G)</term>
3345 <listitem><para>This parameter determines if <ulink url="nmbd.8.html">
3346 <command>nmbd(8)</command></ulink> will produce Lanman announce
3347 broadcasts that are needed by OS/2 clients in order for them to see
3348 the Samba server in their browse list. This parameter can have three
3349 values, <constant>true</constant>, <constant>false</constant>, or
3350 <constant>auto</constant>. The default is <constant>auto</constant>.
3351 If set to <constant>false</constant> Samba will never produce these
3352 broadcasts. If set to <constant>true</constant> Samba will produce
3353 Lanman announce broadcasts at a frequency set by the parameter
3354 <parameter>lm interval</parameter>. If set to <constant>auto</constant>
3355 Samba will not send Lanman announce broadcasts by default but will
3356 listen for them. If it hears such a broadcast on the wire it will
3357 then start sending them at a frequency set by the parameter
3358 <parameter>lm interval</parameter>.</para>
3360 <para>See also <link linkend="LMINTERVAL"><parameter>lm interval
3361 </parameter></link>.</para>
3363 <para>Default: <command>lm announce = auto</command></para>
3364 <para>Example: <command>lm announce = yes</command></para>
3365 </listitem>
3366 </varlistentry>
3370 <varlistentry>
3371 <term><anchor id="LMINTERVAL">lm interval (G)</term>
3372 <listitem><para>If Samba is set to produce Lanman announce
3373 broadcasts needed by OS/2 clients (see the <link linkend="LMANNOUNCE">
3374 <parameter>lm announce</parameter></link> parameter) then this
3375 parameter defines the frequency in seconds with which they will be
3376 made. If this is set to zero then no Lanman announcements will be
3377 made despite the setting of the <parameter>lm announce</parameter>
3378 parameter.</para>
3380 <para>See also <link linkend="LMANNOUNCE"><parameter>lm
3381 announce</parameter></link>.</para>
3383 <para>Default: <command>lm interval = 60</command></para>
3384 <para>Example: <command>lm interval = 120</command></para>
3385 </listitem>
3386 </varlistentry>
3390 <varlistentry>
3391 <term><anchor id="LOADPRINTERS">load printers (G)</term>
3392 <listitem><para>A boolean variable that controls whether all
3393 printers in the printcap will be loaded for browsing by default.
3394 See the <link linkend="PRINTERSSECT">printers</link> section for
3395 more details.</para>
3397 <para>Default: <command>load printers = yes</command></para></listitem>
3398 </varlistentry>
3403 <varlistentry>
3404 <term><anchor id="LOCALMASTER">local master (G)</term>
3405 <listitem><para>This option allows <ulink url="nmbd.8.html"><command>
3406 nmbd(8)</command></ulink> to try and become a local master browser
3407 on a subnet. If set to <constant>False</constant> then <command>
3408 nmbd</command> will not attempt to become a local master browser
3409 on a subnet and will also lose in all browsing elections. By
3410 default this value is set to true. Setting this value to true doesn't
3411 mean that Samba will <emphasis>become</emphasis> the local master
3412 browser on a subnet, just that <command>nmbd</command> will <emphasis>
3413 participate</emphasis> in elections for local master browser.</para>
3415 <para>Setting this value to False will cause <command>nmbd</command>
3416 <emphasis>never</emphasis> to become a local master browser.</para>
3418 <para>Default: <command>local master = yes</command></para>
3419 </listitem>
3420 </varlistentry>
3424 <varlistentry>
3425 <term><anchor id="LOCKDIR">lock dir (G)</term>
3426 <listitem><para>Synonym for <link linkend="LOCKDIRECTORY"><parameter>
3427 lock directory</parameter></link>.</para></listitem>
3428 </varlistentry>
3432 <varlistentry>
3433 <term><anchor id="LOCKDIRECTORY">lock directory (G)</term>
3434 <listitem><para>This option specifies the directory where lock
3435 files will be placed. The lock files are used to implement the
3436 <link linkend="MAXCONNECTIONS"><parameter>max connections</parameter>
3437 </link> option.</para>
3439 <para>Default: <command>lock directory = ${prefix}/var/locks</command></para>
3440 <para>Example: <command>lock directory = /var/run/samba/locks</command>
3441 </para></listitem>
3442 </varlistentry>
3446 <varlistentry>
3447 <term><anchor id="LOCKING">locking (S)</term>
3448 <listitem><para>This controls whether or not locking will be
3449 performed by the server in response to lock requests from the
3450 client.</para>
3452 <para>If <command>locking = no</command>, all lock and unlock
3453 requests will appear to succeed and all lock queries will report
3454 that the file in question is available for locking.</para>
3456 <para>If <command>locking = yes</command>, real locking will be performed
3457 by the server.</para>
3459 <para>This option <emphasis>may</emphasis> be useful for read-only
3460 filesystems which <emphasis>may</emphasis> not need locking (such as
3461 cdrom drives), although setting this parameter of <constant>no</constant>
3462 is not really recommended even in this case.</para>
3464 <para>Be careful about disabling locking either globally or in a
3465 specific service, as lack of locking may result in data corruption.
3466 You should never need to set this parameter.</para>
3468 <para>Default: <command>locking = yes</command></para>
3469 </listitem>
3470 </varlistentry>
3474 <varlistentry>
3475 <term><anchor id="LOGFILE">log file (G)</term>
3476 <listitem><para>This option allows you to override the name
3477 of the Samba log file (also known as the debug file).</para>
3479 <para>This option takes the standard substitutions, allowing
3480 you to have separate log files for each user or machine.</para>
3482 <para>Example: <command>log file = /usr/local/samba/var/log.%m
3483 </command></para></listitem>
3484 </varlistentry>
3488 <varlistentry>
3489 <term><anchor id="LOGLEVEL">log level (G)</term>
3490 <listitem><para>The value of the parameter (an integer) allows
3491 the debug level (logging level) to be specified in the
3492 <filename>smb.conf</filename> file. This is to give greater
3493 flexibility in the configuration of the system.</para>
3495 <para>The default will be the log level specified on
3496 the command line or level zero if none was specified.</para>
3498 <para>Example: <command>log level = 3</command></para></listitem>
3499 </varlistentry>
3503 <varlistentry>
3504 <term><anchor id="LOGONDRIVE">logon drive (G)</term>
3505 <listitem><para>This parameter specifies the local path to
3506 which the home directory will be connected (see <link
3507 linkend="LOGONHOME"><parameter>logon home</parameter></link>)
3508 and is only used by NT Workstations. </para>
3510 <para>Note that this option is only useful if Samba is set up as a
3511 logon server.</para>
3513 <para>Default: <command>logon drive = z:</command></para>
3514 <para>Example: <command>logon drive = h:</command></para>
3515 </listitem>
3516 </varlistentry>
3520 <varlistentry>
3521 <term><anchor id="LOGONHOME">logon home (G)</term>
3522 <listitem><para>This parameter specifies the home directory
3523 location when a Win95/98 or NT Workstation logs into a Samba PDC.
3524 It allows you to do </para>
3526 <para><prompt>C:\> </prompt><userinput>NET USE H: /HOME</userinput>
3527 </para>
3529 <para>from a command prompt, for example.</para>
3531 <para>This option takes the standard substitutions, allowing
3532 you to have separate logon scripts for each user or machine.</para>
3534 <para>This parameter can be used with Win9X workstations to ensure
3535 that roaming profiles are stored in a subdirectory of the user's
3536 home directory. This is done in the following way:</para>
3538 <para><command>logon home = \\%N\%U\profile</command></para>
3540 <para>This tells Samba to return the above string, with
3541 substitutions made when a client requests the info, generally
3542 in a NetUserGetInfo request. Win9X clients truncate the info to
3543 \\server\share when a user does <command>net use /home"</command>
3544 but use the whole string when dealing with profiles.</para>
3546 <para>Note that in prior versions of Samba, the <link linkend="LOGONPATH">
3547 <parameter>logon path</parameter></link> was returned rather than
3548 <parameter>logon home</parameter>. This broke <command>net use
3549 /home</command> but allowed profiles outside the home directory.
3550 The current implementation is correct, and can be used for
3551 profiles if you use the above trick.</para>
3553 <para>This option is only useful if Samba is set up as a logon
3554 server.</para>
3556 <para>Default: <command>logon home = "\\%N\%U"</command></para>
3557 <para>Example: <command>logon home = "\\remote_smb_server\%U"</command>
3558 </para></listitem>
3559 </varlistentry>
3562 <varlistentry>
3563 <term><anchor id="LOGONPATH">logon path (G)</term>
3564 <listitem><para>This parameter specifies the home directory
3565 where roaming profiles (NTuser.dat etc files for Windows NT) are
3566 stored. Contrary to previous versions of these manual pages, it has
3567 nothing to do with Win 9X roaming profiles. To find out how to
3568 handle roaming profiles for Win 9X system, see the <link linkend="LOGONHOME">
3569 <parameter>logon home</parameter></link> parameter.</para>
3571 <para>This option takes the standard substitutions, allowing you
3572 to have separate logon scripts for each user or machine. It also
3573 specifies the directory from which the "Application Data",
3574 (<filename>desktop</filename>, <filename>start menu</filename>,
3575 <filename>network neighborhood</filename>, <filename>programs</filename>
3576 and other folders, and their contents, are loaded and displayed on
3577 your Windows NT client.</para>
3579 <para>The share and the path must be readable by the user for
3580 the preferences and directories to be loaded onto the Windows NT
3581 client. The share must be writeable when the logs in for the first
3582 time, in order that the Windows NT client can create the NTuser.dat
3583 and other directories.</para>
3585 <para>Thereafter, the directories and any of the contents can,
3586 if required, be made read-only. It is not advisable that the
3587 NTuser.dat file be made read-only - rename it to NTuser.man to
3588 achieve the desired effect (a <emphasis>MAN</emphasis>datory
3589 profile). </para>
3591 <para>Windows clients can sometimes maintain a connection to
3592 the [homes] share, even though there is no user logged in.
3593 Therefore, it is vital that the logon path does not include a
3594 reference to the homes share (i.e. setting this parameter to
3595 \%N\%U\profile_path will cause problems).</para>
3597 <para>This option takes the standard substitutions, allowing
3598 you to have separate logon scripts for each user or machine.</para>
3600 <para>Note that this option is only useful if Samba is set up
3601 as a logon server.</para>
3603 <para>Default: <command>logon path = \\%N\%U\profile</command></para>
3604 <para>Example: <command>logon path = \\PROFILESERVER\PROFILE\%U</command></para>
3605 </listitem>
3606 </varlistentry>
3610 <varlistentry>
3611 <term><anchor id="LOGONSCRIPT">logon script (G)</term>
3612 <listitem><para>This parameter specifies the batch file (.bat) or
3613 NT command file (.cmd) to be downloaded and run on a machine when
3614 a user successfully logs in. The file must contain the DOS
3615 style cr/lf line endings. Using a DOS-style editor to create the
3616 file is recommended.</para>
3618 <para>The script must be a relative path to the [netlogon]
3619 service. If the [netlogon] service specifies a <link linkend="PATH">
3620 <parameter>path</parameter></link> of <filename>/usr/local/samba/netlogon
3621 </filename>, and <command>logon script = STARTUP.BAT</command>, then
3622 the file that will be downloaded is:</para>
3624 <para><filename>/usr/local/samba/netlogon/STARTUP.BAT</filename></para>
3626 <para>The contents of the batch file is entirely your choice. A
3627 suggested command would be to add <command>NET TIME \\SERVER /SET
3628 /YES</command>, to force every machine to synchronize clocks with
3629 the same time server. Another use would be to add <command>NET USE
3630 U: \\SERVER\UTILS</command> for commonly used utilities, or <command>
3631 NET USE Q: \\SERVER\ISO9001_QA</command> for example.</para>
3633 <para>Note that it is particularly important not to allow write
3634 access to the [netlogon] share, or to grant users write permission
3635 on the batch files in a secure environment, as this would allow
3636 the batch files to be arbitrarily modified and security to be
3637 breached.</para>
3639 <para>This option takes the standard substitutions, allowing you
3640 to have separate logon scripts for each user or machine.</para>
3642 <para>This option is only useful if Samba is set up as a logon
3643 server.</para>
3645 <para>Default: <emphasis>no logon script defined</emphasis></para>
3646 <para>Example: <command>logon script = scripts\%U.bat</command></para>
3647 </listitem>
3648 </varlistentry>
3652 <varlistentry>
3653 <term><anchor id="LPPAUSECOMMAND">lppause command (S)</term>
3654 <listitem><para>This parameter specifies the command to be
3655 executed on the server host in order to stop printing or spooling
3656 a specific print job.</para>
3658 <para>This command should be a program or script which takes
3659 a printer name and job number to pause the print job. One way
3660 of implementing this is by using job priorities, where jobs
3661 having a too low priority won't be sent to the printer.</para>
3663 <para>If a <parameter>%p</parameter> is given then the printername
3664 is put in its place. A <parameter>%j</parameter> is replaced with
3665 the job number (an integer). On HPUX (see <parameter>printing=hpux
3666 </parameter>), if the <parameter>-p%p</parameter> option is added
3667 to the lpq command, the job will show up with the correct status, i.e.
3668 if the job priority is lower than the set fence priority it will
3669 have the PAUSED status, whereas if the priority is equal or higher it
3670 will have the SPOOLED or PRINTING status.</para>
3672 <para>Note that it is good practice to include the absolute path
3673 in the lppause command as the PATH may not be available to the server.</para>
3675 <para>See also the <link linkend="PRINTING"><parameter>printing
3676 </parameter></link> parameter.</para>
3678 <para>Default: Currently no default value is given to
3679 this string, unless the value of the <parameter>printing</parameter>
3680 parameter is <constant>SYSV</constant>, in which case the default is :</para>
3682 <para><command>lp -i %p-%j -H hold</command></para>
3684 <para>or if the value of the <parameter>printing</parameter> parameter
3685 is <constant>SOFTQ</constant>, then the default is:</para>
3687 <para><command>qstat -s -j%j -h</command></para>
3689 <para>Example for HPUX: <command>lppause command = /usr/bin/lpalt
3690 %p-%j -p0</command></para>
3691 </listitem>
3692 </varlistentry>
3696 <varlistentry>
3697 <term><anchor id="LPQCACHETIME">lpq cache time (G)</term>
3698 <listitem><para>This controls how long lpq info will be cached
3699 for to prevent the <command>lpq</command> command being called too
3700 often. A separate cache is kept for each variation of the <command>
3701 lpq</command> command used by the system, so if you use different
3702 <command>lpq</command> commands for different users then they won't
3703 share cache information.</para>
3705 <para>The cache files are stored in <filename>/tmp/lpq.xxxx</filename>
3706 where xxxx is a hash of the <command>lpq</command> command in use.</para>
3708 <para>The default is 10 seconds, meaning that the cached results
3709 of a previous identical <command>lpq</command> command will be used
3710 if the cached data is less than 10 seconds old. A large value may
3711 be advisable if your <command>lpq</command> command is very slow.</para>
3713 <para>A value of 0 will disable caching completely.</para>
3715 <para>See also the <link linkend="PRINTING"><parameter>printing
3716 </parameter></link> parameter.</para>
3718 <para>Default: <command>lpq cache time = 10</command></para>
3719 <para>Example: <command>lpq cache time = 30</command></para>
3720 </listitem>
3721 </varlistentry>
3725 <varlistentry>
3726 <term><anchor id="LPQCOMMAND">lpq command (S)</term>
3727 <listitem><para>This parameter specifies the command to be
3728 executed on the server host in order to obtain <command>lpq
3729 </command>-style printer status information.</para>
3731 <para>This command should be a program or script which
3732 takes a printer name as its only parameter and outputs printer
3733 status information.</para>
3735 <para>Currently eight styles of printer status information
3736 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
3737 This covers most UNIX systems. You control which type is expected
3738 using the <parameter>printing =</parameter> option.</para>
3740 <para>Some clients (notably Windows for Workgroups) may not
3741 correctly send the connection number for the printer they are
3742 requesting status information about. To get around this, the
3743 server reports on the first printer service connected to by the
3744 client. This only happens if the connection number sent is invalid.</para>
3746 <para>If a <parameter>%p</parameter> is given then the printername
3747 is put in its place. Otherwise it is placed at the end of the
3748 command.</para>
3750 <para>Note that it is good practice to include the absolute path
3751 in the <parameter>lpq command</parameter> as the <envar>$PATH
3752 </envar> may not be available to the server.</para>
3754 <para>See also the <link linkend="PRINTING"><parameter>printing
3755 </parameter></link> parameter.</para>
3757 <para>Default: <emphasis>depends on the setting of <parameter>
3758 printing</parameter></emphasis></para>
3760 <para>Example: <command>lpq command = /usr/bin/lpq -P%p</command></para>
3761 </listitem>
3762 </varlistentry>
3766 <varlistentry>
3767 <term><anchor id="LPRESUMECOMMAND">lpresume command (S)</term>
3768 <listitem><para>This parameter specifies the command to be
3769 executed on the server host in order to restart or continue
3770 printing or spooling a specific print job.</para>
3772 <para>This command should be a program or script which takes
3773 a printer name and job number to resume the print job. See
3774 also the <link linkend="LPPAUSECOMMAND"><parameter>lppause command
3775 </parameter></link> parameter.</para>
3777 <para>If a <parameter>%p</parameter> is given then the printername
3778 is put in its place. A <parameter>%j</parameter> is replaced with
3779 the job number (an integer).</para>
3781 <para>Note that it is good practice to include the absolute path
3782 in the <parameter>lpresume command</parameter> as the PATH may not
3783 be available to the server.</para>
3785 <para>See also the <link linkend="PRINTING"><parameter>printing
3786 </parameter></link> parameter.</para>
3788 <para>Default: Currently no default value is given
3789 to this string, unless the value of the <parameter>printing</parameter>
3790 parameter is <constant>SYSV</constant>, in which case the default is :</para>
3792 <para><command>lp -i %p-%j -H resume</command></para>
3794 <para>or if the value of the <parameter>printing</parameter> parameter
3795 is <constant>SOFTQ</constant>, then the default is:</para>
3797 <para><command>qstat -s -j%j -r</command></para>
3799 <para>Example for HPUX: <command>lpresume command = /usr/bin/lpalt
3800 %p-%j -p2</command></para>
3801 </listitem>
3802 </varlistentry>
3806 <varlistentry>
3807 <term><anchor id="LPRMCOMMAND">lprm command (S)</term>
3808 <listitem><para>This parameter specifies the command to be
3809 executed on the server host in order to delete a print job.</para>
3811 <para>This command should be a program or script which takes
3812 a printer name and job number, and deletes the print job.</para>
3814 <para>If a <parameter>%p</parameter> is given then the printername
3815 is put in its place. A <parameter>%j</parameter> is replaced with
3816 the job number (an integer).</para>
3818 <para>Note that it is good practice to include the absolute
3819 path in the <parameter>lprm command</parameter> as the PATH may not be
3820 available to the server.</para>
3822 <para>See also the <link linkend="PRINTING"><parameter>printing
3823 </parameter></link> parameter.</para>
3825 <para>Default: <emphasis>depends on the setting of <parameter>printing
3826 </parameter></emphasis></para>
3828 <para>Example 1: <command>lprm command = /usr/bin/lprm -P%p %j
3829 </command></para>
3830 <para>Example 2: <command>lprm command = /usr/bin/cancel %p-%j
3831 </command></para></listitem>
3832 </varlistentry>
3836 <varlistentry>
3837 <term><anchor id="MACHINEPASSWORDTIMEOUT">machine password timeout (G)</term>
3838 <listitem><para>If a Samba server is a member of an Windows
3839 NT Domain (see the <link linkend="SECURITYEQUALSDOMAIN">security=domain</link>)
3840 parameter) then periodically a running <ulink url="smbd.8.html">
3841 smbd(8)</ulink> process will try and change the MACHINE ACCOUNT
3842 PASSWORD stored in the TDB called <filename>private/secrets.tdb
3843 </filename>. This parameter specifies how often this password
3844 will be changed, in seconds. The default is one week (expressed in
3845 seconds), the same as a Windows NT Domain member server.</para>
3847 <para>See also <ulink url="smbpasswd.8.html"><command>smbpasswd(8)
3848 </command></ulink>, and the <link linkend="SECURITYEQUALSDOMAIN">
3849 security=domain</link>) parameter.</para>
3851 <para>Default: <command>machine password timeout = 604800</command></para>
3852 </listitem>
3853 </varlistentry>
3856 <varlistentry>
3857 <term><anchor id="MAGICOUTPUT">magic output (S)</term>
3858 <listitem><para>This parameter specifies the name of a file
3859 which will contain output created by a magic script (see the
3860 <link linkend="MAGICSCRIPT"><parameter>magic script</parameter></link>
3861 parameter below).</para>
3863 <para>Warning: If two clients use the same <parameter>magic script
3864 </parameter> in the same directory the output file content
3865 is undefined.</para>
3867 <para>Default: <command>magic output = &lt;magic script name&gt;.out
3868 </command></para>
3870 <para>Example: <command>magic output = myfile.txt</command></para>
3871 </listitem>
3872 </varlistentry>
3876 <varlistentry>
3877 <term><anchor id="MAGICSCRIPT">magic script (S)</term>
3878 <listitem><para>This parameter specifies the name of a file which,
3879 if opened, will be executed by the server when the file is closed.
3880 This allows a UNIX script to be sent to the Samba host and
3881 executed on behalf of the connected user.</para>
3883 <para>Scripts executed in this way will be deleted upon
3884 completion assuming that the user has the appripriate level
3885 of priviledge and the ile permissions allow the deletion.</para>
3887 <para>If the script generates output, output will be sent to
3888 the file specified by the <link linkend="MAGICOUTPUT"><parameter>
3889 magic output</parameter></link> parameter (see above).</para>
3891 <para>Note that some shells are unable to interpret scripts
3892 containing CR/LF instead of CR as
3893 the end-of-line marker. Magic scripts must be executable
3894 <emphasis>as is</emphasis> on the host, which for some hosts and
3895 some shells will require filtering at the DOS end.</para>
3897 <para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and
3898 should <emphasis>NOT</emphasis> be relied upon.</para>
3900 <para>Default: <emphasis>None. Magic scripts disabled.</emphasis></para>
3901 <para>Example: <command>magic script = user.csh</command></para>
3902 </listitem>
3903 </varlistentry>
3907 <varlistentry>
3908 <term><anchor id="MANGLECASE">mangle case (S)</term>
3909 <listitem><para>See the section on <link linkend="NAMEMANGLINGSECT">
3910 NAME MANGLING</link></para>
3912 <para>Default: <command>mangle case = no</command></para>
3913 </listitem>
3914 </varlistentry>
3917 <varlistentry>
3918 <term><anchor id="MANGLEDMAP">mangled map (S)</term>
3919 <listitem><para>This is for those who want to directly map UNIX
3920 file names which can not be represented on Windows/DOS. The mangling
3921 of names is not always what is needed. In particular you may have
3922 documents with file extensions that differ between DOS and UNIX.
3923 For example, under UNIX it is common to use <filename>.html</filename>
3924 for HTML files, whereas under Windows/DOS <filename>.htm</filename>
3925 is more commonly used.</para>
3927 <para>So to map <filename>html</filename> to <filename>htm</filename>
3928 you would use:</para>
3930 <para><command>mangled map = (*.html *.htm)</command></para>
3932 <para>One very useful case is to remove the annoying <filename>;1
3933 </filename> off the ends of filenames on some CDROMS (only visible
3934 under some UNIXes). To do this use a map of (*;1 *;).</para>
3936 <para>Default: <emphasis>no mangled map</emphasis></para>
3937 <para>Example: <command>mangled map = (*;1 *;)</command></para>
3938 </listitem>
3939 </varlistentry>
3942 <varlistentry>
3943 <term><anchor id="MANGLEDNAMES">mangled names (S)</term>
3944 <listitem><para>This controls whether non-DOS names under UNIX
3945 should be mapped to DOS-compatible names ("mangled") and made visible,
3946 or whether non-DOS names should simply be ignored.</para>
3948 <para>See the section on <link linkend="NAMEMANGLINGSECT">
3949 NAME MANGLING</link> for details on how to control the mangling process.</para>
3951 <para>If mangling is used then the mangling algorithm is as follows:</para>
3953 <itemizedlist>
3954 <listitem><para>The first (up to) five alphanumeric characters
3955 before the rightmost dot of the filename are preserved, forced
3956 to upper case, and appear as the first (up to) five characters
3957 of the mangled name.</para></listitem>
3959 <listitem><para>A tilde "~" is appended to the first part of the mangled
3960 name, followed by a two-character unique sequence, based on the
3961 original root name (i.e., the original filename minus its final
3962 extension). The final extension is included in the hash calculation
3963 only if it contains any upper case characters or is longer than three
3964 characters.</para>
3966 <para>Note that the character to use may be specified using
3967 the <link linkend="MANGLINGCHAR"><parameter>mangling char</parameter>
3968 </link> option, if you don't like '~'.</para></listitem>
3970 <listitem><para>The first three alphanumeric characters of the final
3971 extension are preserved, forced to upper case and appear as the
3972 extension of the mangled name. The final extension is defined as that
3973 part of the original filename after the rightmost dot. If there are no
3974 dots in the filename, the mangled name will have no extension (except
3975 in the case of "hidden files" - see below).</para></listitem>
3977 <listitem><para>Files whose UNIX name begins with a dot will be
3978 presented as DOS hidden files. The mangled name will be created as
3979 for other filenames, but with the leading dot removed and "___" as
3980 its extension regardless of actual original extension (that's three
3981 underscores).</para></listitem>
3982 </itemizedlist>
3984 <para>The two-digit hash value consists of upper case
3985 alphanumeric characters.</para>
3987 <para>This algorithm can cause name collisions only if files
3988 in a directory share the same first five alphanumeric characters.
3989 The probability of such a clash is 1/1300.</para>
3991 <para>The name mangling (if enabled) allows a file to be
3992 copied between UNIX directories from Windows/DOS while retaining
3993 the long UNIX filename. UNIX files can be renamed to a new extension
3994 from Windows/DOS and will retain the same basename. Mangled names
3995 do not change between sessions.</para>
3997 <para>Default: <command>mangled names = yes</command></para>
3998 </listitem>
3999 </varlistentry>
4003 <varlistentry>
4004 <term><anchor id="MANGLEDSTACK">mangled stack (G)</term>
4005 <listitem><para>This parameter controls the number of mangled names
4006 that should be cached in the Samba server <ulink url="smbd.8.html">
4007 smbd(8)</ulink>.</para>
4009 <para>This stack is a list of recently mangled base names
4010 (extensions are only maintained if they are longer than 3 characters
4011 or contains upper case characters).</para>
4013 <para>The larger this value, the more likely it is that mangled
4014 names can be successfully converted to correct long UNIX names.
4015 However, large stack sizes will slow most directory access. Smaller
4016 stacks save memory in the server (each stack element costs 256 bytes).
4017 </para>
4019 <para>It is not possible to absolutely guarantee correct long
4020 file names, so be prepared for some surprises!</para>
4022 <para>Default: <command>mangled stack = 50</command></para>
4023 <para>Example: <command>mangled stack = 100</command></para>
4024 </listitem>
4025 </varlistentry>
4030 <varlistentry>
4031 <term><anchor id="MANGLINGCHAR">mangling char (S)</term>
4032 <listitem><para>This controls what character is used as
4033 the <emphasis>magic</emphasis> character in <link
4034 linkend="NAMEMANGLINGSECT">name mangling</link>. The default is a '~'
4035 but this may interfere with some software. Use this option to set
4036 it to whatever you prefer.</para>
4038 <para>Default: <command>mangling char = ~</command></para>
4039 <para>Example: <command>mangling char = ^</command></para>
4040 </listitem>
4041 </varlistentry>
4047 <varlistentry>
4048 <term><anchor id="MAPARCHIVE">map archive (S)</term>
4049 <listitem><para>This controls whether the DOS archive attribute
4050 should be mapped to the UNIX owner execute bit. The DOS archive bit
4051 is set when a file has been modified since its last backup. One
4052 motivation for this option it to keep Samba/your PC from making
4053 any file it touches from becoming executable under UNIX. This can
4054 be quite annoying for shared source code, documents, etc...</para>
4056 <para>Note that this requires the <parameter>create mask</parameter>
4057 parameter to be set such that owner execute bit is not masked out
4058 (i.e. it must include 100). See the parameter <link linkend="CREATEMASK">
4059 <parameter>create mask</parameter></link> for details.</para>
4061 <para>Default: <command>map archive = yes</command></para>
4062 </listitem>
4063 </varlistentry>
4067 <varlistentry>
4068 <term><anchor id="MAPHIDDEN">map hidden (S)</term>
4069 <listitem><para>This controls whether DOS style hidden files
4070 should be mapped to the UNIX world execute bit.</para>
4072 <para>Note that this requires the <parameter>create mask</parameter>
4073 to be set such that the world execute bit is not masked out (i.e.
4074 it must include 001). See the parameter <link linkend="CREATEMASK">
4075 <parameter>create mask</parameter></link> for details.</para>
4077 <para>Default: <command>map hidden = no</command></para>
4078 </listitem>
4079 </varlistentry>
4082 <varlistentry>
4083 <term><anchor id="MAPSYSTEM">map system (S)</term>
4084 <listitem><para>This controls whether DOS style system files
4085 should be mapped to the UNIX group execute bit.</para>
4087 <para>Note that this requires the <parameter>create mask</parameter>
4088 to be set such that the group execute bit is not masked out (i.e.
4089 it must include 010). See the parameter <link linkend="CREATEMASK">
4090 <parameter>create mask</parameter></link> for details.</para>
4092 <para>Default: <command>map system = no</command></para>
4093 </listitem>
4094 </varlistentry>
4097 <varlistentry>
4098 <term><anchor id="MAPTOGUEST">map to guest (G)</term>
4099 <listitem><para>This parameter is only useful in <link linkend="SECURITY">
4100 security</link> modes other than <parameter>security=share</parameter>
4101 - i.e. <constant>user</constant>, <constant>server</constant>,
4102 and <constant>domain</constant>.</para>
4104 <para>This parameter can take three different values, which tell
4105 <ulink url="smbd.8.html">smbd(8)</ulink> what to do with user
4106 login requests that don't match a valid UNIX user in some way.</para>
4108 <para>The three settings are :</para>
4110 <itemizedlist>
4111 <listitem><para><constant>Never</constant> - Means user login
4112 requests with an invalid password are rejected. This is the
4113 default.</para></listitem>
4115 <listitem><para><constant>Bad User</constant> - Means user
4116 logins with an invalid password are rejected, unless the username
4117 does not exist, in which case it is treated as a guest login and
4118 mapped into the <link linkend="GUESTACCOUNT"><parameter>
4119 guest account</parameter></link>.</para></listitem>
4121 <listitem><para><constant>Bad Password</constant> - Means user logins
4122 with an invalid password are treated as a guest login and mapped
4123 into the <link linkend="GUESTACCOUNT">guest account</link>. Note that
4124 this can cause problems as it means that any user incorrectly typing
4125 their password will be silently logged on as "guest" - and
4126 will not know the reason they cannot access files they think
4127 they should - there will have been no message given to them
4128 that they got their password wrong. Helpdesk services will
4129 <emphasis>hate</emphasis> you if you set the <parameter>map to
4130 guest</parameter> parameter this way :-).</para></listitem>
4131 </itemizedlist>
4133 <para>Note that this parameter is needed to set up "Guest"
4134 share services when using <parameter>security</parameter> modes other than
4135 share. This is because in these modes the name of the resource being
4136 requested is <emphasis>not</emphasis> sent to the server until after
4137 the server has successfully authenticated the client so the server
4138 cannot make authentication decisions at the correct time (connection
4139 to the share) for "Guest" shares.</para>
4141 <para>For people familiar with the older Samba releases, this
4142 parameter maps to the old compile-time setting of the <constant>
4143 GUEST_SESSSETUP</constant> value in local.h.</para>
4145 <para>Default: <command>map to guest = Never</command></para>
4146 <para>Example: <command>map to guest = Bad User</command></para>
4147 </listitem>
4148 </varlistentry>
4152 <varlistentry>
4153 <term><anchor id="MAXCONNECTIONS">max connections (S)</term>
4154 <listitem><para>This option allows the number of simultaneous
4155 connections to a service to be limited. If <parameter>max connections
4156 </parameter> is greater than 0 then connections will be refused if
4157 this number of connections to the service are already open. A value
4158 of zero mean an unlimited number of connections may be made.</para>
4160 <para>Record lock files are used to implement this feature. The
4161 lock files will be stored in the directory specified by the <link
4162 linkend="LOCKDIRECTORY"><parameter>lock directory</parameter></link>
4163 option.</para>
4165 <para>Default: <command>max connections = 0</command></para>
4166 <para>Example: <command>max connections = 10</command></para>
4167 </listitem>
4168 </varlistentry>
4172 <varlistentry>
4173 <term><anchor id="MAXDISKSIZE">max disk size (G)</term>
4174 <listitem><para>This option allows you to put an upper limit
4175 on the apparent size of disks. If you set this option to 100
4176 then all shares will appear to be not larger than 100 MB in
4177 size.</para>
4179 <para>Note that this option does not limit the amount of
4180 data you can put on the disk. In the above case you could still
4181 store much more than 100 MB on the disk, but if a client ever asks
4182 for the amount of free disk space or the total disk size then the
4183 result will be bounded by the amount specified in <parameter>max
4184 disk size</parameter>.</para>
4186 <para>This option is primarily useful to work around bugs
4187 in some pieces of software that can't handle very large disks,
4188 particularly disks over 1GB in size.</para>
4190 <para>A <parameter>max disk size</parameter> of 0 means no limit.</para>
4192 <para>Default: <command>max disk size = 0</command></para>
4193 <para>Example: <command>max disk size = 1000</command></para>
4194 </listitem>
4195 </varlistentry>
4199 <varlistentry>
4200 <term><anchor id="MAXLOGSIZE">max log size (G)</term>
4201 <listitem><para>This option (an integer in kilobytes) specifies
4202 the max size the log file should grow to. Samba periodically checks
4203 the size and if it is exceeded it will rename the file, adding
4204 a <filename>.old</filename> extension.</para>
4206 <para>A size of 0 means no limit.</para>
4208 <para>Default: <command>max log size = 5000</command></para>
4209 <para>Example: <command>max log size = 1000</command></para>
4210 </listitem>
4211 </varlistentry>
4215 <varlistentry>
4216 <term><anchor id="MAXMUX">max mux (G)</term>
4217 <listitem><para>This option controls the maximum number of
4218 outstanding simultaneous SMB operations that samba tells the client
4219 it will allow. You should never need to set this parameter.</para>
4221 <para>Default: <command>max mux = 50</command></para>
4222 </listitem>
4223 </varlistentry>
4227 <varlistentry>
4228 <term><anchor id="MAXOPENFILES">max open files (G)</term>
4229 <listitem><para>This parameter limits the maximum number of
4230 open files that one <ulink url="smbd.8.html">smbd(8)</ulink> file
4231 serving process may have open for a client at any one time. The
4232 default for this parameter is set very high (10,000) as Samba uses
4233 only one bit per unopened file.</para>
4235 <para>The limit of the number of open files is usually set
4236 by the UNIX per-process file descriptor limit rather than
4237 this parameter so you should never need to touch this parameter.</para>
4239 <para>Default: <command>max open files = 10000</command></para>
4240 </listitem>
4241 </varlistentry>
4245 <varlistentry>
4246 <term><anchor id="MAXPRINTJOBS">max print jobs (S)</term>
4247 <listitem><para>This parameter limits the maximum number of
4248 jobs allowable in a Samba printer queue at any given moment.
4249 If this number is exceeded, <ulink url="smbd.8.html"><command>
4250 smbd(8)</command></ulink> will remote "Out of Space" to the client.
4251 See all <link linkend="TOTALPRINTJOBS"><parameter>total
4252 print jobs</parameter></link>.
4253 </para>
4255 <para>Default: <command>max print jobs = 1000</command></para>
4256 <para>Example: <command>max print jobs = 5000</command></para>
4257 </listitem>
4258 </varlistentry>
4261 <varlistentry>
4262 <term><anchor id="MAXPROTOCOL">max protocol (G)</term>
4263 <listitem><para>The value of the parameter (a string) is the highest
4264 protocol level that will be supported by the server.</para>
4266 <para>Possible values are :</para>
4267 <itemizedlist>
4268 <listitem><para><constant>CORE</constant>: Earliest version. No
4269 concept of user names.</para></listitem>
4271 <listitem><para><constant>COREPLUS</constant>: Slight improvements on
4272 CORE for efficiency.</para></listitem>
4274 <listitem><para><constant>LANMAN1</constant>: First <emphasis>
4275 modern</emphasis> version of the protocol. Long filename
4276 support.</para></listitem>
4278 <listitem><para><constant>LANMAN2</constant>: Updates to Lanman1 protocol.
4279 </para></listitem>
4281 <listitem><para><constant>NT1</constant>: Current up to date version of
4282 the protocol. Used by Windows NT. Known as CIFS.</para></listitem>
4283 </itemizedlist>
4285 <para>Normally this option should not be set as the automatic
4286 negotiation phase in the SMB protocol takes care of choosing
4287 the appropriate protocol.</para>
4289 <para>See also <link linkend="MINPROTOCOL"><parameter>min
4290 protocol</parameter></link></para>
4292 <para>Default: <command>max protocol = NT1</command></para>
4293 <para>Example: <command>max protocol = LANMAN1</command></para>
4294 </listitem>
4295 </varlistentry>
4299 <varlistentry>
4300 <term><anchor id="MAXSMBDPROCESSES">max smbd processes (G)</term>
4301 <listitem><para>This parameter limits the maximum number of
4302 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
4303 processes concurrently running on a system and is intended
4304 as a stop gap to prevent degrading service to clients in the event
4305 that the server has insufficient resources to handle more than this
4306 number of connections. Remember that under normal operating
4307 conditions, each user will have an smbd associated with him or her
4308 to handle connections to all shares from a given host.
4309 </para>
4311 <para>Default: <command>max smbd processes = 0</command> ## no limit</para>
4312 <para>Example: <command>max smbd processes = 1000</command></para>
4313 </listitem>
4314 </varlistentry>
4319 <varlistentry>
4320 <term><anchor id="MAXTTL">max ttl (G)</term>
4321 <listitem><para>This option tells <ulink url="nmbd.8.html">nmbd(8)</ulink>
4322 what the default 'time to live' of NetBIOS names should be (in seconds)
4323 when <command>nmbd</command> is requesting a name using either a
4324 broadcast packet or from a WINS server. You should never need to
4325 change this parameter. The default is 3 days.</para>
4327 <para>Default: <command>max ttl = 259200</command></para>
4328 </listitem>
4329 </varlistentry>
4333 <varlistentry>
4334 <term><anchor id="MAXWINSTTL">max wins ttl (G)</term>
4335 <listitem><para>This option tells <ulink url="nmbd.8.html">nmbd(8)
4336 </ulink> when acting as a WINS server (<link linkend="WINSSUPPORT">
4337 <parameter>wins support=yes</parameter></link>) what the maximum
4338 'time to live' of NetBIOS names that <command>nmbd</command>
4339 will grant will be (in seconds). You should never need to change this
4340 parameter. The default is 6 days (518400 seconds).</para>
4342 <para>See also the <link linkend="MINWINSTTL"><parameter>min
4343 wins ttl"</parameter></link> parameter.</para>
4345 <para>Default: <command>max wins ttl = 518400</command></para>
4346 </listitem>
4347 </varlistentry>
4351 <varlistentry>
4352 <term><anchor id="MAXXMIT">max xmit (G)</term>
4353 <listitem><para>This option controls the maximum packet size
4354 that will be negotiated by Samba. The default is 65535, which
4355 is the maximum. In some cases you may find you get better performance
4356 with a smaller value. A value below 2048 is likely to cause problems.
4357 </para>
4359 <para>Default: <command>max xmit = 65535</command></para>
4360 <para>Example: <command>max xmit = 8192</command></para>
4361 </listitem>
4362 </varlistentry>
4366 <varlistentry>
4367 <term><anchor id="MESSAGECOMMAND">message command (G)</term>
4368 <listitem><para>This specifies what command to run when the
4369 server receives a WinPopup style message.</para>
4371 <para>This would normally be a command that would
4372 deliver the message somehow. How this is to be done is
4373 up to your imagination.</para>
4375 <para>An example is:</para>
4377 <para><command>message command = csh -c 'xedit %s;rm %s' &</command>
4378 </para>
4380 <para>This delivers the message using <command>xedit</command>, then
4381 removes it afterwards. <emphasis>NOTE THAT IT IS VERY IMPORTANT
4382 THAT THIS COMMAND RETURN IMMEDIATELY</emphasis>. That's why I
4383 have the '&' on the end. If it doesn't return immediately then
4384 your PCs may freeze when sending messages (they should recover
4385 after 30secs, hopefully).</para>
4387 <para>All messages are delivered as the global guest user.
4388 The command takes the standard substitutions, although <parameter>
4389 %u</parameter> won't work (<parameter>%U</parameter> may be better
4390 in this case).</para>
4392 <para>Apart from the standard substitutions, some additional
4393 ones apply. In particular:</para>
4395 <itemizedlist>
4396 <listitem><para><parameter>%s</parameter> = the filename containing
4397 the message.</para></listitem>
4399 <listitem><para><parameter>%t</parameter> = the destination that
4400 the message was sent to (probably the server name).</para></listitem>
4402 <listitem><para><parameter>%f</parameter> = who the message
4403 is from.</para></listitem>
4404 </itemizedlist>
4406 <para>You could make this command send mail, or whatever else
4407 takes your fancy. Please let us know of any really interesting
4408 ideas you have.</para>
4411 <para>Here's a way of sending the messages as mail to root:</para>
4413 <para><command>message command = /bin/mail -s 'message from %f on
4414 %m' root &lt; %s; rm %s</command></para>
4416 <para>If you don't have a message command then the message
4417 won't be delivered and Samba will tell the sender there was
4418 an error. Unfortunately WfWg totally ignores the error code
4419 and carries on regardless, saying that the message was delivered.
4420 </para>
4422 <para>If you want to silently delete it then try:</para>
4424 <para><command>message command = rm %s</command></para>
4426 <para>Default: <emphasis>no message command</emphasis></para>
4427 <para>Example: <command>message command = csh -c 'xedit %s;
4428 rm %s' &</command></para>
4429 </listitem>
4430 </varlistentry>
4435 <varlistentry>
4436 <term><anchor id="MINPASSWDLENGTH">min passwd length (G)</term>
4437 <listitem><para>Synonym for <link linkend="MINPASSWORDLENGTH">
4438 <parameter>min password length</parameter></link>.</para>
4439 </listitem>
4440 </varlistentry>
4444 <varlistentry>
4445 <term><anchor id="MINPASSWORDLENGTH">min password length (G)</term>
4446 <listitem><para>This option sets the minimum length in characters
4447 of a plaintext password that <command>smbd</command> will accept when performing
4448 UNIX password changing.</para>
4450 <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix
4451 password sync</parameter></link>, <link linkend="PASSWDPROGRAM">
4452 <parameter>passwd program</parameter></link> and <link
4453 linkend="PASSWDCHATDEBUG"><parameter>passwd chat debug</parameter>
4454 </link>.</para>
4456 <para>Default: <command>min password length = 5</command></para>
4457 </listitem>
4458 </varlistentry>
4462 <varlistentry>
4463 <term><anchor id="MINPRINTSPACE">min print space (S)</term>
4464 <listitem><para>This sets the minimum amount of free disk
4465 space that must be available before a user will be able to spool
4466 a print job. It is specified in kilobytes. The default is 0, which
4467 means a user can always spool a print job.</para>
4469 <para>See also the <link linkend="PRINTING"><parameter>printing
4470 </parameter></link> parameter.</para>
4472 <para>Default: <command>min print space = 0</command></para>
4473 <para>Example: <command>min print space = 2000</command></para>
4474 </listitem>
4475 </varlistentry>
4480 <varlistentry>
4481 <term><anchor id="MINPROTOCOL">min protocol (G)</term>
4482 <listitem><para>The value of the parameter (a string) is the
4483 lowest SMB protocol dialect than Samba will support. Please refer
4484 to the <link linkend="MAXPROTOCOL"><parameter>max protocol</parameter></link>
4485 parameter for a list of valid protocol names and a brief description
4486 of each. You may also wish to refer to the C source code in
4487 <filename>source/smbd/negprot.c</filename> for a listing of known protocol
4488 dialects supported by clients.</para>
4490 <para>If you are viewing this parameter as a security measure, you should
4491 also refer to the <link linkend="LANMANAUTH"><parameter>lanman
4492 auth</parameter></link> parameter. Otherwise, you should never need
4493 to change this parameter.</para>
4495 <para>Default : <command>min protocol = CORE</command></para>
4496 <para>Example : <command>min protocol = NT1</command> # disable DOS
4497 clients</para>
4498 </listitem>
4499 </varlistentry>
4504 <varlistentry>
4505 <term><anchor id="MINWINSTTL">min wins ttl (G)</term>
4506 <listitem><para>This option tells <ulink url="nmbd.8.html">nmbd(8)</ulink>
4507 when acting as a WINS server (<link linkend="WINSSUPPORT"><parameter>
4508 wins support = yes</parameter></link>) what the minimum 'time to live'
4509 of NetBIOS names that <command>nmbd</command> will grant will be (in
4510 seconds). You should never need to change this parameter. The default
4511 is 6 hours (21600 seconds).</para>
4513 <para>Default: <command>min wins ttl = 21600</command></para>
4514 </listitem>
4515 </varlistentry>
4520 <varlistentry>
4521 <term><anchor id="MSDFSROOT">msdfs root (S)</term>
4522 <listitem><para>This boolean parameter is only available if
4523 Samba is configured and compiled with the <command>
4524 --with-msdfs</command> option. If set to <constant>yes></constant>,
4525 Samba treats the share as a Dfs root and allows clients to browse
4526 the distributed file system tree rooted at the share directory.
4527 Dfs links are specified in the share directory by symbolic
4528 links of the form <filename>msdfs:serverA\shareA,serverB\shareB
4529 </filename> and so on. For more information on setting up a Dfs tree
4530 on Samba, refer to <ulink url="msdfs_setup.html">msdfs_setup.html
4531 </ulink>.</para>
4533 <para>See also <link linkend="HOSTMSDFS"><parameter>host msdfs
4534 </parameter></link></para>
4536 <para>Default: <command>msdfs root = no</command></para>
4537 </listitem>
4538 </varlistentry>
4541 <varlistentry>
4542 <term><anchor id="NAMERESOLVEORDER">name resolve order (G)</term>
4543 <listitem><para>This option is used by the programs in the Samba
4544 suite to determine what naming services to use and in what order
4545 to resolve host names to IP addresses. The option takes a space
4546 separated string of name resolution options.</para>
4548 <para>The options are :"lmhosts", "host", "wins" and "bcast". They
4549 cause names to be resolved as follows :</para>
4551 <itemizedlist>
4552 <listitem><para><constant>lmhosts</constant> : Lookup an IP
4553 address in the Samba lmhosts file. If the line in lmhosts has
4554 no name type attached to the NetBIOS name (see the <ulink
4555 url="lmhosts.5.html">lmhosts(5)</ulink> for details) then
4556 any name type matches for lookup.</para></listitem>
4558 <listitem><para><constant>host</constant> : Do a standard host
4559 name to IP address resolution, using the system <filename>/etc/hosts
4560 </filename>, NIS, or DNS lookups. This method of name resolution
4561 is operating system depended for instance on IRIX or Solaris this
4562 may be controlled by the <filename>/etc/nsswitch.conf</filename>
4563 file). Note that this method is only used if the NetBIOS name
4564 type being queried is the 0x20 (server) name type, otherwise
4565 it is ignored.</para></listitem>
4567 <listitem><para><constant>wins</constant> : Query a name with
4568 the IP address listed in the <link linkend="WINSSERVER"><parameter>
4569 wins server</parameter></link> parameter. If no WINS server has
4570 been specified this method will be ignored.</para></listitem>
4572 <listitem><para><constant>bcast</constant> : Do a broadcast on
4573 each of the known local interfaces listed in the <link
4574 linkend="INTERFACES"><parameter>interfaces</parameter></link>
4575 parameter. This is the least reliable of the name resolution
4576 methods as it depends on the target host being on a locally
4577 connected subnet.</para></listitem>
4578 </itemizedlist>
4580 <para>Default: <command>name resolve order = lmhosts host wins bcast
4581 </command></para>
4582 <para>Example: <command>name resolve order = lmhosts bcast host
4583 </command></para>
4585 <para>This will cause the local lmhosts file to be examined
4586 first, followed by a broadcast attempt, followed by a normal
4587 system hostname lookup.</para>
4588 </listitem>
4589 </varlistentry>
4594 <varlistentry>
4595 <term><anchor id="NETBIOSALIASES">netbios aliases (G)</term>
4596 <listitem><para>This is a list of NetBIOS names that <ulink
4597 url="nmbd.8.html">nmbd(8)</ulink> will advertise as additional
4598 names by which the Samba server is known. This allows one machine
4599 to appear in browse lists under multiple names. If a machine is
4600 acting as a browse server or logon server none
4601 of these names will be advertised as either browse server or logon
4602 servers, only the primary name of the machine will be advertised
4603 with these capabilities.</para>
4605 <para>See also <link linkend="NETBIOSNAME"><parameter>netbios
4606 name</parameter></link>.</para>
4608 <para>Default: <emphasis>empty string (no additional names)</emphasis></para>
4609 <para>Example: <command>netbios aliases = TEST TEST1 TEST2</command></para>
4610 </listitem>
4611 </varlistentry>
4615 <varlistentry>
4616 <term><anchor id="NETBIOSNAME">netbios name (G)</term>
4617 <listitem><para>This sets the NetBIOS name by which a Samba
4618 server is known. By default it is the same as the first component
4619 of the host's DNS name. If a machine is a browse server or
4620 logon server this name (or the first component
4621 of the hosts DNS name) will be the name that these services are
4622 advertised under.</para>
4624 <para>See also <link linkend="NETBIOSALIASES"><parameter>netbios
4625 aliases</parameter></link>.</para>
4627 <para>Default: <emphasis>machine DNS name</emphasis></para>
4628 <para>Example: <command>netbios name = MYNAME</command></para>
4629 </listitem>
4630 </varlistentry>
4634 <varlistentry>
4635 <term><anchor id="NETBIOSSCOPE">netbios scope (G)</term>
4636 <listitem><para>This sets the NetBIOS scope that Samba will
4637 operate under. This should not be set unless every machine
4638 on your LAN also sets this value.</para>
4639 </listitem>
4640 </varlistentry>
4643 <varlistentry>
4644 <term><anchor id="NISHOMEDIR">nis homedir (G)</term>
4645 <listitem><para>Get the home share server from a NIS map. For
4646 UNIX systems that use an automounter, the user's home directory
4647 will often be mounted on a workstation on demand from a remote
4648 server. </para>
4650 <para>When the Samba logon server is not the actual home directory
4651 server, but is mounting the home directories via NFS then two
4652 network hops would be required to access the users home directory
4653 if the logon server told the client to use itself as the SMB server
4654 for home directories (one over SMB and one over NFS). This can
4655 be very slow.</para>
4657 <para>This option allows Samba to return the home share as
4658 being on a different server to the logon server and as
4659 long as a Samba daemon is running on the home directory server,
4660 it will be mounted on the Samba client directly from the directory
4661 server. When Samba is returning the home share to the client, it
4662 will consult the NIS map specified in <link linkend="HOMEDIRMAP">
4663 <parameter>homedir map</parameter></link> and return the server
4664 listed there.</para>
4666 <para>Note that for this option to work there must be a working
4667 NIS system and the Samba server with this option must also
4668 be a logon server.</para>
4670 <para>Default: <command>nis homedir = no</command></para>
4671 </listitem>
4672 </varlistentry>
4676 <varlistentry>
4677 <term><anchor id="NTACLSUPPORT">nt acl support (G)</term>
4678 <listitem><para>This boolean parameter controls whether
4679 <ulink url="smbd.8.html">smbd(8)</ulink> will attempt to map
4680 UNIX permissions into Windows NT access control lists.</para>
4682 <para>Default: <command>nt acl support = yes</command></para>
4683 </listitem>
4684 </varlistentry>
4688 <varlistentry>
4689 <term><anchor id="NTPIPESUPPORT">nt pipe support (G)</term>
4690 <listitem><para>This boolean parameter controls whether
4691 <ulink url="smbd.8.html">smbd(8)</ulink> will allow Windows NT
4692 clients to connect to the NT SMB specific <constant>IPC$</constant>
4693 pipes. This is a developer debugging option and can be left
4694 alone.</para>
4696 <para>Default: <command>nt pipe support = yes</command></para>
4697 </listitem>
4698 </varlistentry>
4702 <varlistentry>
4703 <term><anchor id="NTSMBSUPPORT">nt smb support (G)</term>
4704 <listitem><para>This boolean parameter controls whether <ulink
4705 url="smbd.8.html">smbd(8)</ulink> will negotiate NT specific SMB
4706 support with Windows NT clients. Although this is a developer
4707 debugging option and should be left alone, benchmarking has discovered
4708 that Windows NT clients give faster performance with this option
4709 set to <constant>no</constant>. This is still being investigated.
4710 If this option is set to <constant>no</constant> then Samba offers
4711 exactly the same SMB calls that versions prior to Samba 2.0 offered.
4712 This information may be of use if any users are having problems
4713 with NT SMB support.</para>
4715 <para>You should not need to ever disable this parameter.</para>
4717 <para>Default: <command>nt smb support = yes</command></para>
4718 </listitem>
4719 </varlistentry>
4723 <varlistentry>
4724 <term><anchor id="NULLPASSWORDS">null passwords (G)</term>
4725 <listitem><para>Allow or disallow client access to accounts
4726 that have null passwords. </para>
4728 <para>See also <ulink url="smbpasswd.5.html">smbpasswd (5)</ulink>.</para>
4730 <para>Default: <command>null passwords = no</command></para>
4731 </listitem>
4732 </varlistentry>
4737 <varlistentry>
4738 <term><anchor id="OBEYPAMRESTRICTIONS">obey pam restrictions (G)</term>
4739 <listitem><para>When Samba 2.2 is configure to enable PAM support
4740 (i.e. --with-pam), this parameter will control whether or not Samba
4741 should obey PAM's account and session management directives. The
4742 default behavior is to use PAM for clear text authentication only
4743 and to ignore any account or session management. Note that Samba
4744 always ignores PAM for authentication in the case of <link
4745 linkend="ENCRYPTPASSWORDS"><parameter>encrypt passwords = yes</parameter>
4746 </link>. The reason is that PAM modules cannot support the challenge/response
4747 authentication mechanism needed in the presence of SMB password encryption.
4748 </para>
4750 <para>Default: <command>obey pam restrictions = no</command></para>
4751 </listitem>
4752 </varlistentry>
4758 <varlistentry>
4759 <term><anchor id="ONLYUSER">only user (S)</term>
4760 <listitem><para>This is a boolean option that controls whether
4761 connections with usernames not in the <parameter>user</parameter>
4762 list will be allowed. By default this option is disabled so that a
4763 client can supply a username to be used by the server. Enabling
4764 this parameter will force the server to only user the login
4765 names from the <parameter>user</parameter> list and is only really
4766 useful in <link linkend="SECURITYEQUALSSHARE">shave level</link>
4767 security.</para>
4769 <para>Note that this also means Samba won't try to deduce
4770 usernames from the service name. This can be annoying for
4771 the [homes] section. To get around this you could use <command>user =
4772 %S</command> which means your <parameter>user</parameter> list
4773 will be just the service name, which for home directories is the
4774 name of the user.</para>
4776 <para>See also the <link linkend="USER"><parameter>user</parameter>
4777 </link> parameter.</para>
4779 <para>Default: <command>only user = no</command></para>
4780 </listitem>
4781 </varlistentry>
4786 <varlistentry>
4787 <term><anchor id="ONLYGUEST">only guest (S)</term>
4788 <listitem><para>A synonym for <link linkend="GUESTONLY"><parameter>
4789 guest only</parameter></link>.</para>
4790 </listitem>
4791 </varlistentry>
4795 <varlistentry>
4796 <term><anchor id="OPLOCKBREAKWAITTIME">oplock break wait time (G)</term>
4797 <listitem><para>This is a tuning parameter added due to bugs in
4798 both Windows 9x and WinNT. If Samba responds to a client too
4799 quickly when that client issues an SMB that can cause an oplock
4800 break request, then the network client can fail and not respond
4801 to the break request. This tuning parameter (which is set in milliseconds)
4802 is the amount of time Samba will wait before sending an oplock break
4803 request to such (broken) clients.</para>
4805 <para><emphasis>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4806 AND UNDERSTOOD THE SAMBA OPLOCK CODE</emphasis>.</para>
4808 <para>Default: <command>oplock break wait time = 0</command></para>
4809 </listitem>
4810 </varlistentry>
4813 <varlistentry>
4814 <term><anchor id="OPLOCKCONTENTIONLIMIT">oplock contention limit (S)</term>
4815 <listitem><para>This is a <emphasis>very</emphasis> advanced
4816 <ulink url="smbd.8.html">smbd(8)</ulink> tuning option to
4817 improve the efficiency of the granting of oplocks under multiple
4818 client contention for the same file.</para>
4820 <para>In brief it specifies a number, which causes smbd not to
4821 grant an oplock even when requested if the approximate number of
4822 clients contending for an oplock on the same file goes over this
4823 limit. This causes <command>smbd</command> to behave in a similar
4824 way to Windows NT.</para>
4826 <para><emphasis>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4827 AND UNDERSTOOD THE SAMBA OPLOCK CODE</emphasis>.</para>
4829 <para>Default: <command>oplock contention limit = 2</command></para>
4830 </listitem>
4831 </varlistentry>
4837 <varlistentry>
4838 <term><anchor id="OPLOCKS">oplocks (S)</term>
4839 <listitem><para>This boolean option tells smbd whether to
4840 issue oplocks (opportunistic locks) to file open requests on this
4841 share. The oplock code can dramatically (approx. 30% or more) improve
4842 the speed of access to files on Samba servers. It allows the clients
4843 to aggressively cache files locally and you may want to disable this
4844 option for unreliable network environments (it is turned on by
4845 default in Windows NT Servers). For more information see the file
4846 <filename>Speed.txt</filename> in the Samba <filename>docs/</filename>
4847 directory.</para>
4849 <para>Oplocks may be selectively turned off on certain files with a
4850 share. See the <link linkend="VETOOPLOCKFILES"><parameter>
4851 veto oplock files</parameter></link> parameter. On some systems
4852 oplocks are recognized by the underlying operating system. This
4853 allows data synchronization between all access to oplocked files,
4854 whether it be via Samba or NFS or a local UNIX process. See the
4855 <parameter>kernel oplocks</parameter> parameter for details.</para>
4857 <para>See also the <link linkend="KERNELOPLOCKS"><parameter>kernel
4858 oplocks</parameter></link> and <link linkend="LEVEL2OPLOCKS"><parameter>
4859 level2 oplocks</parameter></link> parameters.</para>
4861 <para>Default: <command>oplocks = yes</command></para>
4862 </listitem>
4863 </varlistentry>
4867 <varlistentry>
4868 <term><anchor id="OSLEVEL">os level (G)</term>
4869 <listitem><para>This integer value controls what level Samba
4870 advertises itself as for browse elections. The value of this
4871 parameter determines whether <ulink url="nmbd.8.html">nmbd(8)</ulink>
4872 has a chance of becoming a local master browser for the <parameter>
4873 WORKGROUP</parameter> in the local broadcast area.</para>
4875 <para><emphasis>Note :</emphasis>By default, Samba will win
4876 a local master browsing election over all Microsoft operating
4877 systems except a Windows NT 4.0/2000 Domain Controller. This
4878 means that a misconfigured Samba host can effectively isolate
4879 a subnet for browsing purposes. See <filename>BROWSING.txt
4880 </filename> in the Samba <filename>docs/</filename> directory
4881 for details.</para>
4883 <para>Default: <command>os level = 20</command></para>
4884 <para>Example: <command>os level = 65 </command></para>
4885 </listitem>
4886 </varlistentry>
4890 <varlistentry>
4891 <term><anchor id="OS2DRIVERMAP">os2 driver map (G)</term>
4892 <listitem><para>The parameter is used to define the absolute
4893 path to a file containing a mapping of Windows NT printer driver
4894 names to OS/2 printer driver names. The format is:</para>
4896 <para>&lt;nt driver name&gt; = &lt;os2 driver
4897 name&gt;.&lt;device name&gt;</para>
4899 <para>For example, a valid entry using the HP LaserJet 5
4900 printer driver woudl appear as <command>HP LaserJet 5L = LASERJET.HP
4901 LaserJet 5L</command>.</para>
4903 <para>The need for the file is due to the printer driver namespace
4904 problem described in the <ulink url="printer_driver2.html">Samba
4905 Printing HOWTO</ulink>. For more details on OS/2 clients, please
4906 refer to the <ulink url="OS2-Client-HOWTO.html">OS2-Client-HOWTO
4907 </ulink> containing in the Samba documentation.</para>
4909 <para>Default: <command>os2 driver map = &lt;empty string&gt;
4910 </command></para>
4911 </listitem>
4912 </varlistentry>
4915 <varlistentry>
4916 <term><anchor id="PAMPASSWORDCHANGE">pam password change (G)</term>
4917 <listitem><para>With the addition of better PAM support in Samba 2.2,
4918 this parameter, it is possible to use PAM's password change control
4919 flag for Samba. If enabled, then PAM will be used for password
4920 changes when requested by an SMB client, and the <link
4921 linkend="PASSWDCHAT"><parameter>passwd chat</parameter></link> must be
4922 be changed to work with the pam prompts.
4923 </para>
4925 <para>Default: <command>pam password change = no</command></para>
4927 </listitem>
4928 </varlistentry>
4931 <varlistentry>
4932 <term><anchor id="PANICACTION">panic action (G)</term>
4933 <listitem><para>This is a Samba developer option that allows a
4934 system command to be called when either <ulink url="smbd.8.html">
4935 smbd(8)</ulink> or <ulink url="nmbd.8.html">nmbd(8)</ulink>
4936 crashes. This is usually used to draw attention to the fact that
4937 a problem occurred.</para>
4939 <para>Default: <command>panic action = &lt;empty string&gt;</command></para>
4940 <para>Example: <command>panic action = "/bin/sleep 90000"</command></para>
4941 </listitem>
4942 </varlistentry>
4945 <varlistentry>
4946 <term><anchor id="PASSWDCHAT">passwd chat (G)</term>
4947 <listitem><para>This string controls the <emphasis>"chat"</emphasis>
4948 conversation that takes places between <ulink
4949 url="smbd.8.html">smbd</ulink> and the local password changing
4950 program to change the users password. The string describes a
4951 sequence of response-receive pairs that <ulink url="smbd.8.html">
4952 smbd(8)</ulink> uses to determine what to send to the
4953 <link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter>
4954 </link> and what to expect back. If the expected output is not
4955 received then the password is not changed.</para>
4957 <para>This chat sequence is often quite site specific, depending
4958 on what local methods are used for password control (such as NIS
4959 etc).</para>
4961 <para>The string can contain the macros <parameter>%o</parameter>
4962 and <parameter>%n</parameter> which are substituted for the old
4963 and new passwords respectively. It can also contain the standard
4964 macros <constant>\n</constant>, <constant>\r</constant>, <constant>
4965 \t</constant> and <constant>%s</constant> to give line-feed,
4966 carriage-return, tab and space.</para>
4968 <para>The string can also contain a '*' which matches
4969 any sequence of characters.</para>
4971 <para>Double quotes can be used to collect strings with spaces
4972 in them into a single string.</para>
4974 <para>If the send string in any part of the chat sequence
4975 is a fullstop ".", then no string is sent. Similarly,
4976 if the expect string is a fullstop then no string is expected.</para>
4978 <para>Note that if the <link linkend="UNIXPASSWORDSYNC"><parameter>unix
4979 password sync</parameter></link> parameter is set to true, then this
4980 sequence is called <emphasis>AS ROOT</emphasis> when the SMB password
4981 in the smbpasswd file is being changed, without access to the old
4982 password cleartext. In this case the old password cleartext is set
4983 to "" (the empty string).</para>
4985 <para>Also, if the <link linkend="PAMPASSWORDCHANGE"><parameter>pam
4986 password change</parameter></link> parameter is set to true, then the
4987 chat sequence should consist of three elements. The first element should
4988 match the pam prompt for the old password, the second element should match
4989 the pam prompt for the first request for the new password, and the final
4990 element should match the pam prompt for the second request for the new password.
4991 These matches are done case insentively. Under most conditions this change
4992 is done as root so the prompt for the old password will never be matched.
4993 </para>
4995 <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix password
4996 sync</parameter></link>, <link linkend="PASSWDPROGRAM"><parameter>
4997 passwd program</parameter></link> ,<link linkend="PASSWDCHATDEBUG">
4998 <parameter>passwd chat debug</parameter></link> and <link linkend="PAMPASSWORDCHANGE">
4999 <parameter>pam password change</parameter></link>.</para>
5001 <para>Default: <command>passwd chat = *new*password* %n\n
5002 *new*password* %n\n *changed*</command></para>
5003 <para>Example: <command>passwd chat = "*Enter OLD password*" %o\n
5004 "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password
5005 changed*"</command></para>
5006 </listitem>
5007 </varlistentry>
5011 <varlistentry>
5012 <term><anchor id="PASSWDCHATDEBUG">passwd chat debug (G)</term>
5013 <listitem><para>This boolean specifies if the passwd chat script
5014 parameter is run in <emphasis>debug</emphasis> mode. In this mode the
5015 strings passed to and received from the passwd chat are printed
5016 in the <ulink url="smbd.8.html">smbd(8)</ulink> log with a
5017 <link linkend="DEBUGLEVEL"><parameter>debug level</parameter></link>
5018 of 100. This is a dangerous option as it will allow plaintext passwords
5019 to be seen in the <command>smbd</command> log. It is available to help
5020 Samba admins debug their <parameter>passwd chat</parameter> scripts
5021 when calling the <parameter>passwd program</parameter> and should
5022 be turned off after this has been done. This parameter is off by
5023 default.</para>
5025 <para>See also <<link linkend="PASSWDCHAT"><parameter>passwd chat</parameter>
5026 </link>, <link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter>
5027 </link>.</para>
5029 <para>Default: <command>passwd chat debug = no</command></para>
5030 </listitem>
5031 </varlistentry>
5035 <varlistentry>
5036 <term><anchor id="PASSWDPROGRAM">passwd program (G)</term>
5037 <listitem><para>The name of a program that can be used to set
5038 UNIX user passwords. Any occurrences of <parameter>%u</parameter>
5039 will be replaced with the user name. The user name is checked for
5040 existence before calling the password changing program.</para>
5042 <para>Also note that many passwd programs insist in <emphasis>reasonable
5043 </emphasis> passwords, such as a minimum length, or the inclusion
5044 of mixed case chars and digits. This can pose a problem as some clients
5045 (such as Windows for Workgroups) uppercase the password before sending
5046 it.</para>
5048 <para><emphasis>Note</emphasis> that if the <parameter>unix
5049 password sync</parameter> parameter is set to <constant>True
5050 </constant> then this program is called <emphasis>AS ROOT</emphasis>
5051 before the SMB password in the <ulink url="smbpasswd.5.html">smbpasswd(5)
5052 </ulink> file is changed. If this UNIX password change fails, then
5053 <command>smbd</command> will fail to change the SMB password also
5054 (this is by design).</para>
5056 <para>If the <parameter>unix password sync</parameter> parameter
5057 is set this parameter <emphasis>MUST USE ABSOLUTE PATHS</emphasis>
5058 for <emphasis>ALL</emphasis> programs called, and must be examined
5059 for security implications. Note that by default <parameter>unix
5060 password sync</parameter> is set to <constant>False</constant>.</para>
5062 <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix
5063 password sync</parameter></link>.</para>
5065 <para>Default: <command>passwd program = /bin/passwd</command></para>
5066 <para>Example: <command>passwd program = /sbin/npasswd %u</command>
5067 </para>
5068 </listitem>
5069 </varlistentry>
5073 <varlistentry>
5074 <term><anchor id="PASSWORDLEVEL">password level (G)</term>
5075 <listitem><para>Some client/server combinations have difficulty
5076 with mixed-case passwords. One offending client is Windows for
5077 Workgroups, which for some reason forces passwords to upper
5078 case when using the LANMAN1 protocol, but leaves them alone when
5079 using COREPLUS! Another problem child is the Windows 95/98
5080 family of operating systems. These clients upper case clear
5081 text passwords even when NT LM 0.12 selected by the protocol
5082 negotiation request/response.</para>
5084 <para>This parameter defines the maximum number of characters
5085 that may be upper case in passwords.</para>
5087 <para>For example, say the password given was "FRED". If <parameter>
5088 password level</parameter> is set to 1, the following combinations
5089 would be tried if "FRED" failed:</para>
5091 <para>"Fred", "fred", "fRed", "frEd","freD"</para>
5093 <para>If <parameter>password level</parameter> was set to 2,
5094 the following combinations would also be tried: </para>
5096 <para>"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..</para>
5098 <para>And so on.</para>
5100 <para>The higher value this parameter is set to the more likely
5101 it is that a mixed case password will be matched against a single
5102 case password. However, you should be aware that use of this
5103 parameter reduces security and increases the time taken to
5104 process a new connection.</para>
5106 <para>A value of zero will cause only two attempts to be
5107 made - the password as is and the password in all-lower case.</para>
5109 <para>Default: <command>password level = 0</command></para>
5110 <para>Example: <command>password level = 4</command</para>
5111 </listitem>
5112 </varlistentry>
5116 <varlistentry>
5117 <term><anchor id="PASSWORDSERVER">password server (G)</term>
5118 <listitem><para>By specifying the name of another SMB server (such
5119 as a WinNT box) with this option, and using <command>security = domain
5120 </command> or <command>security = server</command> you can get Samba
5121 to do all its username/password validation via a remote server.</para>
5123 <para>This option sets the name of the password server to use.
5124 It must be a NetBIOS name, so if the machine's NetBIOS name is
5125 different from its Internet name then you may have to add its NetBIOS
5126 name to the lmhosts file which is stored in the same directory
5127 as the <filename>smb.conf</filename> file.</para>
5129 <para>The name of the password server is looked up using the
5130 parameter <link linkend="NAMERESOLVEORDER"><parameter>name
5131 resolve order</parameter></link> and so may resolved
5132 by any method and order described in that parameter.</para>
5134 <para>The password server much be a machine capable of using
5135 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
5136 user level security mode.</para>
5138 <para><emphasis>NOTE:</emphasis> Using a password server
5139 means your UNIX box (running Samba) is only as secure as your
5140 password server. <emphasis>DO NOT CHOOSE A PASSWORD SERVER THAT
5141 YOU DON'T COMPLETELY TRUST</emphasis>.</para>
5143 <para>Never point a Samba server at itself for password
5144 serving. This will cause a loop and could lock up your Samba
5145 server!</para>
5147 <para>The name of the password server takes the standard
5148 substitutions, but probably the only useful one is <parameter>%m
5149 </parameter>, which means the Samba server will use the incoming
5150 client as the password server. If you use this then you better
5151 trust your clients, and you had better restrict them with hosts allow!</para>
5153 <para>If the <parameter>security</parameter> parameter is set to
5154 <constant>domain</constant>, then the list of machines in this
5155 option must be a list of Primary or Backup Domain controllers for the
5156 Domain or the character '*', as the Samba server is effectively
5157 in that domain, and will use cryptographically authenticated RPC calls
5158 to authenticate the user logging on. The advantage of using <command>
5159 security = domain</command> is that if you list several hosts in the
5160 <parameter>password server</parameter> option then <command>smbd
5161 </command> will try each in turn till it finds one that responds. This
5162 is useful in case your primary server goes down.</para>
5164 <para>If the <parameter>password server</parameter> option is set
5165 to the character '*', then Samba will attempt to auto-locate the
5166 Primary or Backup Domain controllers to authenticate against by
5167 doing a query for the name <constant>WORKGROUP&lt;1C&gt;</constant>
5168 and then contacting each server returned in the list of IP
5169 addresses from the name resolution source. </para>
5171 <para>If the <parameter>security</parameter> parameter is
5172 set to <constant>server</constant>, then there are different
5173 restrictions that <command>security = domain</command> doesn't
5174 suffer from:</para>
5176 <itemizedlist>
5177 <listitem><para>You may list several password servers in
5178 the <parameter>password server</parameter> parameter, however if an
5179 <command>smbd</command> makes a connection to a password server,
5180 and then the password server fails, no more users will be able
5181 to be authenticated from this <command>smbd</command>. This is a
5182 restriction of the SMB/CIFS protocol when in <command>security=server
5183 </command> mode and cannot be fixed in Samba.</para></listitem>
5185 <listitem><para>If you are using a Windows NT server as your
5186 password server then you will have to ensure that your users
5187 are able to login from the Samba server, as when in <command>
5188 security=server</command> mode the network logon will appear to
5189 come from there rather than from the users workstation.</para></listitem>
5190 </itemizedlist>
5192 <para>See also the <link linkend="SECURITY"><parameter>security
5193 </parameter></link> parameter.</para>
5195 <para>Default: <command>password server = &lt;empty string&gt;</command>
5196 </para>
5197 <para>Example: <command>password server = NT-PDC, NT-BDC1, NT-BDC2
5198 </command></para>
5199 <para>Example: <command>password server = *</command></para>
5200 </listitem>
5201 </varlistentry>
5205 <varlistentry>
5206 <term><anchor id="PATH">path (S)</term>
5207 <listitem><para>This parameter specifies a directory to which
5208 the user of the service is to be given access. In the case of
5209 printable services, this is where print data will spool prior to
5210 being submitted to the host for printing.</para>
5212 <para>For a printable service offering guest access, the service
5213 should be readonly and the path should be world-writeable and
5214 have the sticky bit set. This is not mandatory of course, but
5215 you probably won't get the results you expect if you do
5216 otherwise.</para>
5218 <para>Any occurrences of <parameter>%u</parameter> in the path
5219 will be replaced with the UNIX username that the client is using
5220 on this connection. Any occurrences of <parameter>%m</parameter>
5221 will be replaced by the NetBIOS name of the machine they are
5222 connecting from. These replacements are very useful for setting
5223 up pseudo home directories for users.</para>
5225 <para>Note that this path will be based on <link linkend="ROOTDIR">
5226 <parameter>root dir</parameter></link> if one was specified.</para>
5228 <para>Default: <emphasis>none</emphasis></para>
5229 <para>Example: <command>path = /home/fred</command></para>
5230 </listitem>
5231 </varlistentry>
5236 <varlistentry>
5237 <term><anchor id="POSIXLOCKING">posix locking (S)</term>
5238 <listitem><para>The <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
5239 daemon maintains an database of file locks obtained by SMB clients.
5240 The default behavior is to map this internal database to POSIX
5241 locks. This means that file locks obtained by SMB clients are
5242 consistent with those seen by POSIX compliant applications accessing
5243 the files via a non-SMB method (e.g. NFS or local file access).
5244 You should never need to disable this parameter.</para>
5246 <para>Default: <command>posix locking = yes</command></para>
5247 </listitem>
5248 </varlistentry>
5253 <varlistentry>
5254 <term><anchor id="POSTEXEC">postexec (S)</term>
5255 <listitem><para>This option specifies a command to be run
5256 whenever the service is disconnected. It takes the usual
5257 substitutions. The command may be run as the root on some
5258 systems.</para>
5260 <para>An interesting example may be do unmount server
5261 resources:</para>
5263 <para><command>postexec = /etc/umount /cdrom</command></para>
5265 <para>See also <link linkend="PREEXEC"><parameter>preexec</parameter>
5266 </link>.</para>
5268 <para>Default: <emphasis>none (no command executed)</emphasis>
5269 </para>
5271 <para>Example: <command>postexec = echo \"%u disconnected from %S
5272 from %m (%I)\" &gt;&gt; /tmp/log</command></para>
5273 </listitem>
5274 </varlistentry>
5278 <varlistentry>
5279 <term><anchor id="POSTSCRIPT">postscript (S)</term>
5280 <listitem><para>This parameter forces a printer to interpret
5281 the print files as postscript. This is done by adding a <constant>%!
5282 </constant> to the start of print output.</para>
5284 <para>This is most useful when you have lots of PCs that persist
5285 in putting a control-D at the start of print jobs, which then
5286 confuses your printer.</para>
5288 <para>Default: <command>postscript = no</command></para>
5289 </listitem>
5290 </varlistentry>
5294 <varlistentry>
5295 <term><anchor id="PREEXEC">preexec (S)</term>
5296 <listitem><para>This option specifies a command to be run whenever
5297 the service is connected to. It takes the usual substitutions.</para>
5299 <para>An interesting example is to send the users a welcome
5300 message every time they log in. Maybe a message of the day? Here
5301 is an example:</para>
5303 <para><command>preexec = csh -c 'echo \"Welcome to %S!\" |
5304 /usr/local/samba/bin/smbclient -M %m -I %I' & </command></para>
5306 <para>Of course, this could get annoying after a while :-)</para>
5308 <para>See also <link linkend="PREEXECCLOSE"><parameter>preexec close
5309 </parameter</link> and <link linkend="POSTEXEC"><parameter>postexec
5310 </parameter></link>.</para>
5312 <para>Default: <emphasis>none (no command executed)</emphasis></para>
5313 <para>Example: <command>preexec = echo \"%u connected to %S from %m
5314 (%I)\" &gt;&gt; /tmp/log</command></para>
5315 </listitem>
5316 </varlistentry>
5320 <varlistentry>
5321 <term><anchor id="PREEXECCLOSE">preexec close (S)</term>
5322 <listitem><para>This boolean option controls whether a non-zero
5323 return code from <link linkend="PREEXEC"><parameter>preexec
5324 </parameter></link> should close the service being connected to.</para>
5326 <para>Default: <command>preexec close = no</command></para>
5327 </listitem>
5328 </varlistentry>
5331 <varlistentry>
5332 <term><anchor id="PREFERREDMASTER">preferred master (G)</term>
5333 <listitem><para>This boolean parameter controls if <ulink
5334 url="nmbd.8.html">nmbd(8)</ulink> is a preferred master browser
5335 for its workgroup.</para>
5337 <para>If this is set to true, on startup, <command>nmbd</command>
5338 will force an election, and it will have a slight advantage in
5339 winning the election. It is recommended that this parameter is
5340 used in conjunction with <command><link linkend="DOMAINMASTER"><parameter>
5341 domain master</parameter></link> = yes</command>, so that <command>
5342 nmbd</command> can guarantee becoming a domain master.</para>
5344 <para>Use this option with caution, because if there are several
5345 hosts (whether Samba servers, Windows 95 or NT) that are preferred
5346 master browsers on the same subnet, they will each periodically
5347 and continuously attempt to become the local master browser.
5348 This will result in unnecessary broadcast traffic and reduced browsing
5349 capabilities.</para>
5351 <para>See also <link linkend="OSLEVEL"><parameter>os level</parameter>
5352 </link>.</para>
5354 <para>Default: <command>preferred master = auto</command></para>
5355 </listitem>
5356 </varlistentry>
5360 <varlistentry>
5361 <term><anchor id="PREFEREDMASTER">prefered master (G)</term>
5362 <listitem><para>Synonym for <link linkend="PREFERREDMASTER"><parameter>
5363 preferred master</parameter></link> for people who cannot spell :-).</para>
5364 </listitem>
5365 </varlistentry>
5369 <varlistentry>
5370 <term><anchor id="PRELOAD">preload</term>
5371 <listitem><para>This is a list of services that you want to be
5372 automatically added to the browse lists. This is most useful
5373 for homes and printers services that would otherwise not be
5374 visible.</para>
5376 <para>Note that if you just want all printers in your
5377 printcap file loaded then the <link linkend="LOADPRINTERS">
5378 <parameter>load printers</parameter></link> option is easier.</para>
5380 <para>Default: <emphasis>no preloaded services</emphasis></para>
5382 <para>Example: <command>preload = fred lp colorlp</command></para>
5383 </listitem>
5384 </varlistentry>
5387 <varlistentry>
5388 <term><anchor id="PRESERVECASE">preserve case (S)</term>
5389 <listitem><para> This controls if new filenames are created
5390 with the case that the client passes, or if they are forced to
5391 be the <link linkend="DEFAULTCASE"><parameter>default case
5392 </parameter></link>.</para>
5394 <para>Default: <command>preserve case = yes</command></para>
5396 <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME
5397 MANGLING</link> for a fuller discussion.</para>
5398 </listitem>
5399 </varlistentry>
5403 <varlistentry>
5404 <term><anchor id="PRINTCOMMAND">print command (S)</term>
5405 <listitem><para>After a print job has finished spooling to
5406 a service, this command will be used via a <command>system()</command>
5407 call to process the spool file. Typically the command specified will
5408 submit the spool file to the host's printing subsystem, but there
5409 is no requirement that this be the case. The server will not remove
5410 the spool file, so whatever command you specify should remove the
5411 spool file when it has been processed, otherwise you will need to
5412 manually remove old spool files.</para>
5414 <para>The print command is simply a text string. It will be used
5415 verbatim, with two exceptions: All occurrences of <parameter>%s
5416 </parameter> and <parameter>%f</parameter> will be replaced by the
5417 appropriate spool file name, and all occurrences of <parameter>%p
5418 </parameter> will be replaced by the appropriate printer name. The
5419 spool file name is generated automatically by the server, the printer
5420 name is discussed below.</para>
5422 <para>The print command <emphasis>MUST</emphasis> contain at least
5423 one occurrence of <parameter>%s</parameter> or <parameter>%f
5424 </parameter> - the <parameter>%p</parameter> is optional. At the time
5425 a job is submitted, if no printer name is supplied the <parameter>%p
5426 </parameter> will be silently removed from the printer command.</para>
5428 <para>If specified in the [global] section, the print command given
5429 will be used for any printable service that does not have its own
5430 print command specified.</para>
5432 <para>If there is neither a specified print command for a
5433 printable service nor a global print command, spool files will
5434 be created but not processed and (most importantly) not removed.</para>
5436 <para>Note that printing may fail on some UNIXes from the
5437 <constant>nobody</constant> account. If this happens then create
5438 an alternative guest account that can print and set the <link
5439 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>
5440 in the [global] section.</para>
5442 <para>You can form quite complex print commands by realizing
5443 that they are just passed to a shell. For example the following
5444 will log a print job, print the file, then remove it. Note that
5445 ';' is the usual separator for command in shell scripts.</para>
5447 <para><command>print command = echo Printing %s &gt;&gt;
5448 /tmp/print.log; lpr -P %p %s; rm %s</command></para>
5450 <para>You may have to vary this command considerably depending
5451 on how you normally print files on your system. The default for
5452 the parameter varies depending on the setting of the <link linkend="PRINTING">
5453 <parameter>printing</parameter></link> parameter.</para>
5455 <para>Default: For <command>printing= BSD, AIX, QNX, LPRNG
5456 or PLP :</command></para>
5457 <para><command>print command = lpr -r -P%p %s</command></para>
5459 <para>For <command>printing= SYS or HPUX :</command></para>
5460 <para><command>print command = lp -c -d%p %s; rm %s</command></para>
5462 <para>For <command>printing=SOFTQ :</command></para>
5463 <para><command>print command = lp -d%p -s %s; rm %s</command></para>
5465 <para>Example: <command>print command = /usr/local/samba/bin/myprintscript
5466 %p %s</command></para>
5467 </listitem>
5468 </varlistentry>
5472 <varlistentry>
5473 <term><anchor id="PRINTOK">print ok (S)</term>
5474 <listitem><para>Synonym for <link linkend="PRINTABLE">
5475 <parameter>printable</parameter></link>.</para>
5476 </listitem>
5477 </varlistentry>
5482 <varlistentry>
5483 <term><anchor id="PRINTABLE">printable (S)</term>
5484 <listitem><para>If this parameter is <constant>yes</constant>, then
5485 clients may open, write to and submit spool files on the directory
5486 specified for the service. </para>
5488 <para>Note that a printable service will ALWAYS allow writing
5489 to the service path (user privileges permitting) via the spooling
5490 of print data. The <link linkend="WRITEABLE"><parameter>writeable
5491 </parameter></link> parameter controls only non-printing access to
5492 the resource.</para>
5494 <para>Default: <command>printable = no</command></para>
5495 </listitem>
5496 </varlistentry>
5500 <varlistentry>
5501 <term><anchor id="PRINTCAP">printcap (G)</term>
5502 <listitem><para>Synonym for <link linkend="PRINTCAPNAME"><parameter>
5503 printcap name</parameter></link>.</para>
5504 </listitem>
5505 </varlistentry>
5510 <varlistentry>
5511 <term><anchor id="PRINTCAPNAME">printcap name (G)</term>
5512 <listitem><para>This parameter may be used to override the
5513 compiled-in default printcap name used by the server (usually <filename>
5514 /etc/printcap</filename>). See the discussion of the <link
5515 linkend="PRINTERSSECT">[printers]</link> section above for reasons
5516 why you might want to do this.</para>
5518 <para>On System V systems that use <command>lpstat</command> to
5519 list available printers you can use <command>printcap name = lpstat
5520 </command> to automatically obtain lists of available printers. This
5521 is the default for systems that define SYSV at configure time in
5522 Samba (this includes most System V based systems). If <parameter>
5523 printcap name</parameter> is set to <command>lpstat</command> on
5524 these systems then Samba will launch <command>lpstat -v</command> and
5525 attempt to parse the output to obtain a printer list.</para>
5527 <para>A minimal printcap file would look something like this:</para>
5529 <para><programlisting>
5530 print1|My Printer 1
5531 print2|My Printer 2
5532 print3|My Printer 3
5533 print4|My Printer 4
5534 print5|My Printer 5
5535 </programlisting></para>
5537 <para>where the '|' separates aliases of a printer. The fact
5538 that the second alias has a space in it gives a hint to Samba
5539 that it's a comment.</para>
5541 <para><emphasis>NOTE</emphasis>: Under AIX the default printcap
5542 name is <filename>/etc/qconfig</filename>. Samba will assume the
5543 file is in AIX <filename>qconfig</filename> format if the string
5544 <filename>qconfig</filename> appears in the printcap filename.</para>
5546 <para>Default: <command>printcap name = /etc/printcap</command></para>
5547 <para>Example: <command>printcap name = /etc/myprintcap</command></para>
5548 </listitem>
5549 </varlistentry>
5555 <varlistentry>
5556 <term><anchor id="PRINTERADMIN">printer admin (S)</term>
5557 <listitem><para>This is a list of users that can do anything to
5558 printers via the remote administration interfaces offered by MS-RPC
5559 (usually using a NT workstation). Note that the root user always
5560 has admin rights.</para>
5562 <para>Default: <command>printer admin = &lt;empty string&gt;</command>
5563 </para>
5564 <para>Example: <command>printer admin = admin, @staff</command></para>
5565 </listitem>
5566 </varlistentry>
5572 <varlistentry>
5573 <term><anchor id="PRINTERDRIVER">printer driver (S)</term>
5574 <listitem><para><emphasis>Note :</emphasis>This is a depreciated
5575 parameter and will be removed in the next major release
5576 following version 2.2. Please see the instructions in
5577 <filename>PRINTER_DRIVER2.txt</filename> in the <filename>docs
5578 </filename> of the Samba distribution for more information
5579 on the new method of loading printer drivers onto a Samba server.
5580 </para>
5582 <para>This option allows you to control the string
5583 that clients receive when they ask the server for the printer driver
5584 associated with a printer. If you are using Windows95 or Windows NT
5585 then you can use this to automate the setup of printers on your
5586 system.</para>
5588 <para>You need to set this parameter to the exact string (case
5589 sensitive) that describes the appropriate printer driver for your
5590 system. If you don't know the exact string to use then you should
5591 first try with no <link linkend="PRINTERDRIVER"><parameter>
5592 printer driver</parameter></link> option set and the client will
5593 give you a list of printer drivers. The appropriate strings are
5594 shown in a scroll box after you have chosen the printer manufacturer.</para>
5596 <para>See also <link linkend="PRINTERDRIVERFILE"><parameter>printer
5597 driver file</parameter></link>.</para>
5599 <para>Example: <command>printer driver = HP LaserJet 4L</command></para>
5600 </listitem>
5601 </varlistentry>
5605 <varlistentry>
5606 <term><anchor id="PRINTERDRIVERFILE">printer driver file (G)</term>
5607 <listitem><para><emphasis>Note :</emphasis>This is a depreciated
5608 parameter and will be removed in the next major release
5609 following version 2.2. Please see the instructions in
5610 <filename>PRINTER_DRIVER2.txt</filename> in the <filename>docs
5611 </filename> of the Samba distribution for more information
5612 on the new method of loading printer drivers onto a Samba server.
5613 </para>
5615 <para>This parameter tells Samba where the printer driver
5616 definition file, used when serving drivers to Windows 95 clients, is
5617 to be found. If this is not set, the default is :</para>
5619 <para><filename><replaceable>SAMBA_INSTALL_DIRECTORY</replaceable>
5620 /lib/printers.def</filename></para>
5622 <para>This file is created from Windows 95 <filename>msprint.inf
5623 </filename> files found on the Windows 95 client system. For more
5624 details on setting up serving of printer drivers to Windows 95
5625 clients, see the documentation file in the <filename>docs/</filename>
5626 directory, <filename>PRINTER_DRIVER.txt</filename>.</para>
5628 <para>See also <link linkend="PRINTERDRIVERLOCATION"><parameter>
5629 printer driver location</parameter></link>.</para>
5631 <para>Default: <emphasis>None (set in compile).</emphasis></para>
5633 <para>Example: <command>printer driver file =
5634 /usr/local/samba/printers/drivers.def</command></para>
5635 </listitem>
5636 </varlistentry>
5641 <varlistentry>
5642 <term><anchor id="PRINTERDRIVERLOCATION">printer driver location (S)</term>
5643 <listitem><para><emphasis>Note :</emphasis>This is a depreciated
5644 parameter and will be removed in the next major release
5645 following version 2.2. Please see the instructions in
5646 <filename>PRINTER_DRIVER2.txt</filename> in the <filename>docs
5647 </filename> of the Samba distribution for more information
5648 on the new method of loading printer drivers onto a Samba server.
5649 </para>
5651 <para>This parameter tells clients of a particular printer
5652 share where to find the printer driver files for the automatic
5653 installation of drivers for Windows 95 machines. If Samba is set up
5654 to serve printer drivers to Windows 95 machines, this should be set to</para>
5656 <para><command>\\MACHINE\PRINTER$</command></para>
5658 <para>Where MACHINE is the NetBIOS name of your Samba server,
5659 and PRINTER$ is a share you set up for serving printer driver
5660 files. For more details on setting this up see the documentation
5661 file in the <filename>docs/</filename> directory, <filename>
5662 PRINTER_DRIVER.txt</filename>.</para>
5664 <para>See also <link linkend="PRINTERDRIVERFILE"><parameter>
5665 printer driver file</parameter></link>.</para>
5667 <para>Default: <command>none</command></para>
5668 <para>Example: <command>printer driver location = \\MACHINE\PRINTER$
5669 </command></para>
5670 </listitem>
5671 </varlistentry>
5675 <varlistentry>
5676 <term><anchor id="PRINTERNAME">printer name (S)</term>
5677 <listitem><para>This parameter specifies the name of the printer
5678 to which print jobs spooled through a printable service will be sent.</para>
5680 <para>If specified in the [global] section, the printer
5681 name given will be used for any printable service that does
5682 not have its own printer name specified.</para>
5684 <para>Default: <emphasis>none (but may be <constant>lp</constant>
5685 on many systems)</emphasis></para>
5687 <para>Example: <command>printer name = laserwriter</command></para>
5688 </listitem>
5689 </varlistentry>
5692 <varlistentry>
5693 <term><anchor id="PRINTER">printer (S)</term>
5694 <listitem><para>Synonym for <link linkend="PRINTERNAME"><parameter>
5695 printer name</parameter></link>.</para>
5696 </listitem>
5697 </varlistentry>
5701 <varlistentry>
5702 <term><anchor id="PRINTING">printing (S)</term>
5703 <listitem><para>This parameters controls how printer status
5704 information is interpreted on your system. It also affects the
5705 default values for the <parameter>print command</parameter>,
5706 <parameter>lpq command</parameter>, <parameter>lppause command
5707 </parameter>, <parameter>lpresume command</parameter>, and
5708 <parameter>lprm command</parameter> if specified in the
5709 [global]f> section.</para>
5711 <para>Currently eight printing styles are supported. They are
5712 <constant>BSD</constant>, <constant>AIX</constant>,
5713 <constant>LPRNG</constant>, <constant>PLP</constant>,
5714 <constant>SYSV</constant>, <constant>HPUX</constant>,
5715 <constant>QNX</constant>, <constant>SOFTQ</constant>,
5716 and <constant>CUPS</constant>.</para>
5718 <para>To see what the defaults are for the other print
5719 commands when using the various options use the <ulink
5720 url="testparm.1.html">testparm(1)</ulink> program.</para>
5722 <para>This option can be set on a per printer basis</para>
5724 <para>See also the discussion in the <link linkend="PRINTERSSECT">
5725 [printers]</link> section.</para>
5726 </listitem>
5727 </varlistentry>
5732 <varlistentry>
5733 <term><anchor id="PROTOCOL">protocol (G)</term>
5734 <listitem><para>Synonym for <link linkend="MAXPROTOCOL">
5735 <parameter>max protocol</parameter></link>.</para></listitem>
5736 </varlistentry>
5741 <varlistentry>
5742 <term><anchor id="PUBLIC">public (S)</term>
5743 <listitem><para>Synonym for <link linkend="GUESTOK"><parameter>guest
5744 ok</parameter></link>.</para>
5745 </listitem>
5746 </varlistentry>
5750 <varlistentry>
5751 <term><anchor id="QUEUEPAUSECOMMAND">queuepause command (S)</term>
5752 <listitem><para>This parameter specifies the command to be
5753 executed on the server host in order to pause the printerqueue.</para>
5755 <para>This command should be a program or script which takes
5756 a printer name as its only parameter and stops the printerqueue,
5757 such that no longer jobs are submitted to the printer.</para>
5759 <para>This command is not supported by Windows for Workgroups,
5760 but can be issued from the Printer's window under Windows 95
5761 and NT.</para>
5763 <para>If a <parameter>%p</parameter> is given then the printername
5764 is put in its place. Otherwise it is placed at the end of the command.
5765 </para>
5767 <para>Note that it is good practice to include the absolute
5768 path in the command as the PATH may not be available to the
5769 server.</para>
5771 <para>Default: <emphasis>depends on the setting of <parameter>printing
5772 </parameter></emphasis></para>
5773 <para>Example: <command>queuepause command = disable %p</command></para>
5774 </listitem>
5775 </varlistentry>
5779 <varlistentry>
5780 <term><anchor id="QUEUERESUMECOMMAND">queueresume command (S)</term>
5781 <listitem><para>This parameter specifies the command to be
5782 executed on the server host in order to resume the printerqueue. It
5783 is the command to undo the behavior that is caused by the
5784 previous parameter (<link linkend="QUEUEPAUSECOMMAND"><parameter>
5785 queuepause command</parameter></link>).</para>
5787 <para>This command should be a program or script which takes
5788 a printer name as its only parameter and resumes the printerqueue,
5789 such that queued jobs are resubmitted to the printer.</para>
5791 <para>This command is not supported by Windows for Workgroups,
5792 but can be issued from the Printer's window under Windows 95
5793 and NT.</para>
5795 <para>If a <parameter>%p</parameter> is given then the printername
5796 is put in its place. Otherwise it is placed at the end of the
5797 command.</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 <link
5804 linkend="PRINTING"><parameter>printing</parameter></link></emphasis>
5805 </para>
5807 <para>Example: <command>queuepause command = enable %p
5808 </command></para>
5809 </listitem>
5810 </varlistentry>
5814 <varlistentry>
5815 <term><anchor id="READBMPX">read bmpx (G)</term>
5816 <listitem><para>This boolean parameter controls whether <ulink
5817 url="smbd.8.html">smbd(8)</ulink> will support the "Read
5818 Block Multiplex" SMB. This is now rarely used and defaults to
5819 <constant>no</constant>. You should never need to set this
5820 parameter.</para>
5822 <para>Default: <command>read bmpx = no</command></para>
5823 </listitem>
5824 </varlistentry>
5829 <varlistentry>
5830 <term><anchor id="READLIST">read list (S)</term>
5831 <listitem><para>This is a list of users that are given read-only
5832 access to a service. If the connecting user is in this list then
5833 they will not be given write access, no matter what the <link
5834 linkend="WRITEABLE"><parameter>writeable</parameter></link>
5835 option is set to. The list can include group names using the
5836 syntax described in the <link linkend="INVALIDUSERS"><parameter>
5837 invalid users</parameter></link> parameter.</para>
5839 <para>See also the <link linkend="WRITELIST"><parameter>
5840 write list</parameter></link> parameter and the <link
5841 linkend="INVALIDUSERS"><parameter>invalid users</parameter>
5842 </link> parameter.</para>
5844 <para>Default: <command>read list = &lt;empty string&gt;</command></para>
5845 <para>Example: <command>read list = mary, @students</command></para>
5846 </listitem>
5847 </varlistentry>
5851 <varlistentry>
5852 <term><anchor id="READONLY">read only (S)</term>
5853 <listitem><para>Note that this is an inverted synonym for <link
5854 linkend="WRITEABLE"><parameter>writeable</parameter></link>.</para>
5855 </listitem>
5856 </varlistentry>
5860 <varlistentry>
5861 <term><anchor id="READRAW">read raw (G)</term>
5862 <listitem><para>This parameter controls whether or not the server
5863 will support the raw read SMB requests when transferring data
5864 to clients.</para>
5866 <para>If enabled, raw reads allow reads of 65535 bytes in
5867 one packet. This typically provides a major performance benefit.
5868 </para>
5870 <para>However, some clients either negotiate the allowable
5871 block size incorrectly or are incapable of supporting larger block
5872 sizes, and for these clients you may need to disable raw reads.</para>
5874 <para>In general this parameter should be viewed as a system tuning
5875 tool and left severely alone. See also <link linkend="WRITERAW">
5876 <parameter>write raw</parameter></link>.</para>
5878 <para>Default: <command>read raw = yes</command></para>
5879 </listitem>
5880 </varlistentry>
5883 <varlistentry>
5884 <term><anchor id="READSIZE">read size (G)</term>
5885 <listitem><para>The option <parameter>read size</parameter>
5886 affects the overlap of disk reads/writes with network reads/writes.
5887 If the amount of data being transferred in several of the SMB
5888 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
5889 than this value then the server begins writing the data before it
5890 has received the whole packet from the network, or in the case of
5891 SMBreadbraw, it begins writing to the network before all the data
5892 has been read from disk.</para>
5894 <para>This overlapping works best when the speeds of disk and
5895 network access are similar, having very little effect when the
5896 speed of one is much greater than the other.</para>
5898 <para>The default value is 16384, but very little experimentation
5899 has been done yet to determine the optimal value, and it is likely
5900 that the best value will vary greatly between systems anyway.
5901 A value over 65536 is pointless and will cause you to allocate
5902 memory unnecessarily.</para>
5904 <para>Default: <command>read size = 16384</command></para>
5905 <para>Example: <command>read size = 8192</command></para>
5906 </listitem>
5907 </varlistentry>
5911 <varlistentry>
5912 <term><anchor id="REMOTEANNOUNCE">remote announce (G)</term>
5913 <listitem><para>This option allows you to setup <ulink
5914 url="nmbd.8.html">nmbd(8)</ulink> to periodically announce itself
5915 to arbitrary IP addresses with an arbitrary workgroup name.</para>
5917 <para>This is useful if you want your Samba server to appear
5918 in a remote workgroup for which the normal browse propagation
5919 rules don't work. The remote workgroup can be anywhere that you
5920 can send IP packets to.</para>
5922 <para>For example:</para>
5924 <para><command>remote announce = 192.168.2.255/SERVERS
5925 192.168.4.255/STAFF</command></para>
5927 <para>the above line would cause nmbd to announce itself
5928 to the two given IP addresses using the given workgroup names.
5929 If you leave out the workgroup name then the one given in
5930 the <link linkend="WORKGROUP"><parameter>workgroup</parameter></link>
5931 parameter is used instead.</para>
5933 <para>The IP addresses you choose would normally be the broadcast
5934 addresses of the remote networks, but can also be the IP addresses
5935 of known browse masters if your network config is that stable.</para>
5937 <para>See the documentation file <filename>BROWSING.txt</filename>
5938 in the <filename>docs/</filename> directory.</para>
5940 <para>Default: <command>remote announce = &lt;empty string&gt;
5941 </command></para>
5942 </listitem>
5943 </varlistentry>
5947 <varlistentry>
5948 <term><anchor id="REMOTEBROWSESYNC">remote browse sync (G)</term>
5949 <listitem><para>This option allows you to setup <ulink
5950 url="nmbd.8.html">nmbd(8)</ulink> to periodically request
5951 synchronization of browse lists with the master browser of a samba
5952 server that is on a remote segment. This option will allow you to
5953 gain browse lists for multiple workgroups across routed networks. This
5954 is done in a manner that does not work with any non-samba servers.</para>
5956 <para>This is useful if you want your Samba server and all local
5957 clients to appear in a remote workgroup for which the normal browse
5958 propagation rules don't work. The remote workgroup can be anywhere
5959 that you can send IP packets to.</para>
5961 <para>For example:</para>
5963 <para><command>remote browse sync = 192.168.2.255 192.168.4.255
5964 </command></para>
5966 <para>the above line would cause <command>nmbd</command> to request
5967 the master browser on the specified subnets or addresses to
5968 synchronize their browse lists with the local server.</para>
5970 <para>The IP addresses you choose would normally be the broadcast
5971 addresses of the remote networks, but can also be the IP addresses
5972 of known browse masters if your network config is that stable. If
5973 a machine IP address is given Samba makes NO attempt to validate
5974 that the remote machine is available, is listening, nor that it
5975 is in fact the browse master on it's segment.</para>
5977 <para>Default: <command>remote browse sync = &lt;empty string&gt;
5978 </command></para>
5979 </listitem>
5980 </varlistentry>
5984 <varlistentry>
5985 <term><anchor id="RESTRICTACLWITHMASK">restrict acl with mask (S)</term>
5986 <listitem><para>This is a boolean parameter. If set to false (default), then
5987 Creation of files with access control lists (ACLS) and modification of ACLs
5988 using the Windows NT/2000 ACL editor will be applied directly to the file
5989 or directory.</para>
5991 <para>If set to True, then all requests to set an ACL on a file will have the
5992 parameters <link linkend="CREATEMASK"><parameter>create mask</parameter></link>,
5993 <link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>
5994 applied before setting the ACL, and all requests to set an ACL on a directory will
5995 have the parameters <link linkend="DIRECTORYMASK"><parameter>directory
5996 mask</parameter></link>, <link linkend="FORCEDIRECTORYMODE"><parameter>force
5997 directory mode</parameter></link> applied before setting the ACL.
5998 </para>
6000 <para>See also <link linkend="CREATEMASK"><parameter>create mask</parameter></link>,
6001 <link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>,
6002 <link linkend="DIRECTORYMASK"><parameter>directory mask</parameter></link>,
6003 <link linkend="FORCEDIRECTORYMODE"><parameter>force directory mode</parameter></link>
6004 </para>
6006 <para>Default: <command>restrict acl with mask = no</command></para>
6007 </listitem>
6008 </varlistentry>
6013 <varlistentry>
6014 <term><anchor id="RESTRICTANONYMOUS">restrict anonymous (G)</term>
6015 <listitem><para>This is a boolean parameter. If it is true, then
6016 anonymous access to the server will be restricted, namely in the
6017 case where the server is expecting the client to send a username,
6018 but it doesn't. Setting it to true will force these anonymous
6019 connections to be denied, and the client will be required to always
6020 supply a username and password when connecting. Use of this parameter
6021 is only recommended for homogeneous NT client environments.</para>
6023 <para>This parameter makes the use of macro expansions that rely
6024 on the username (%U, %G, etc) consistent. NT 4.0
6025 likes to use anonymous connections when refreshing the share list,
6026 and this is a way to work around that.</para>
6028 <para>When restrict anonymous is true, all anonymous connections
6029 are denied no matter what they are for. This can effect the ability
6030 of a machine to access the samba Primary Domain Controller to revalidate
6031 it's machine account after someone else has logged on the client
6032 interactively. The NT client will display a message saying that
6033 the machine's account in the domain doesn't exist or the password is
6034 bad. The best way to deal with this is to reboot NT client machines
6035 between interactive logons, using "Shutdown and Restart", rather
6036 than "Close all programs and logon as a different user".</para>
6038 <para>Default: <command>restrict anonymous = no</command></para>
6039 </listitem>
6040 </varlistentry>
6044 <varlistentry>
6045 <term><anchor id="ROOT">root (G)</term>
6046 <listitem><para>Synonym for <link linkend="ROOTDIRECTORY">
6047 <parameter>root directory"</parameter></link>.</para>
6048 </listitem>
6049 </varlistentry>
6053 <varlistentry>
6054 <term><anchor id="ROOTDIR">root dir (G)</term>
6055 <listitem><para>Synonym for <link linkend="ROOTDIRECTORY">
6056 <parameter>root directory"</parameter></link>.</para>
6057 </listitem>
6058 </varlistentry>
6061 <varlistentry>
6062 <term><anchor id="ROOTDIRECTORY">root directory (G)</term>
6063 <listitem><para>The server will <command>chroot()</command> (i.e.
6064 Change it's root directory) to this directory on startup. This is
6065 not strictly necessary for secure operation. Even without it the
6066 server will deny access to files not in one of the service entries.
6067 It may also check for, and deny access to, soft links to other
6068 parts of the filesystem, or attempts to use ".." in file names
6069 to access other directories (depending on the setting of the <link
6070 linkend="WIDELINKS"><parameter>wide links</parameter></link>
6071 parameter).</para>
6073 <para>Adding a <parameter>root directory</parameter> entry other
6074 than "/" adds an extra level of security, but at a price. It
6075 absolutely ensures that no access is given to files not in the
6076 sub-tree specified in the <parameter>root directory</parameter>
6077 option, <emphasis>including</emphasis> some files needed for
6078 complete operation of the server. To maintain full operability
6079 of the server you will need to mirror some system files
6080 into the <parameter>root directory</parameter> tree. In particular
6081 you will need to mirror <filename>/etc/passwd</filename> (or a
6082 subset of it), and any binaries or configuration files needed for
6083 printing (if required). The set of files that must be mirrored is
6084 operating system dependent.</para>
6086 <para>Default: <command>root directory = /</command></para>
6087 <para>Example: <command>root directory = /homes/smb</command></para>
6088 </listitem>
6089 </varlistentry>
6093 <varlistentry>
6094 <term><anchor id="ROOTPOSTEXEC">root postexec (S)</term>
6095 <listitem><para>This is the same as the <parameter>postexec</parameter>
6096 parameter except that the command is run as root. This
6097 is useful for unmounting filesystems
6098 (such as cdroms) after a connection is closed.</para>
6100 <para>See also <link linkend="POSTEXEC"><parameter>
6101 postexec</parameter></link>.</para>
6103 <para>Default: <command>root postexec = &lt;empty string&gt;
6104 </command></para>
6105 </listitem>
6106 </varlistentry>
6108 <varlistentry>
6109 <term><anchor id="ROOTPREEXEC">root preexec (S)</term>
6110 <listitem><para>This is the same as the <parameter>preexec</parameter>
6111 parameter except that the command is run as root. This
6112 is useful for mounting filesystems (such as cdroms) after a
6113 connection is closed.</para>
6115 <para>See also <link linkend="PREEXEC"><parameter>
6116 preexec</parameter></link> and <link linkend="PREEXECCLOSE">
6117 <parameter>preexec close</parameter></link>.</para>
6119 <para>Default: <command>root preexec = &lt;empty string&gt;
6120 </command></para>
6121 </listitem>
6122 </varlistentry>
6126 <varlistentry>
6127 <term><anchor id="ROOTPREEXECCLOSE">root preexec close (S)</term>
6128 <listitem><para>This is the same as the <parameter>preexec close
6129 </parameter> parameter except that the command is run as root.</para>
6131 <para>See also <link linkend="PREEXEC"><parameter>
6132 preexec</parameter></link> and <link linkend="PREEXECCLOSE">
6133 <parameter>preexec close</parameter></link>.</para>
6135 <para>Default: <command>root preexec close = no</command></para>
6136 </listitem>
6137 </varlistentry>
6140 <varlistentry>
6141 <term><anchor id="SECURITY">security (G)</term>
6142 <listitem><para>This option affects how clients respond to
6143 Samba and is one of the most important settings in the <filename>
6144 smb.conf</filename> file.</para>
6146 <para>The option sets the "security mode bit" in replies to
6147 protocol negotiations with <ulink url="smbd.8.html">smbd(8)
6148 </ulink> to turn share level security on or off. Clients decide
6149 based on this bit whether (and how) to transfer user and password
6150 information to the server.</para>
6153 <para>The default is <command>security = user</command>, as this is
6154 the most common setting needed when talking to Windows 98 and
6155 Windows NT.</para>
6157 <para>The alternatives are <command>security = share</command>,
6158 <command>security = server</command> or <command>security=domain
6159 </command>.</para>
6161 <para>In versions of Samba prior to 2..0, the default was
6162 <command>security = share</command> mainly because that was
6163 the only option at one stage.</para>
6165 <para>There is a bug in WfWg that has relevance to this
6166 setting. When in user or server level security a WfWg client
6167 will totally ignore the password you type in the "connect
6168 drive" dialog box. This makes it very difficult (if not impossible)
6169 to connect to a Samba service as anyone except the user that
6170 you are logged into WfWg as.</para>
6172 <para>If your PCs use usernames that are the same as their
6173 usernames on the UNIX machine then you will want to use
6174 <command>security = user</command>. If you mostly use usernames
6175 that don't exist on the UNIX box then use <command>security =
6176 share</command>.</para>
6178 <para>You should also use <command>security = share</command> if you
6179 want to mainly setup shares without a password (guest shares). This
6180 is commonly used for a shared printer server. It is more difficult
6181 to setup guest shares with <command>security = user</command>, see
6182 the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6183 </link>parameter for details.</para>
6185 <para>It is possible to use <command>smbd</command> in a <emphasis>
6186 hybrid mode</emphasis> where it is offers both user and share
6187 level security under different <link linkend="NETBIOSALIASES">
6188 <parameter>NetBIOS aliases</parameter></link>. </para>
6190 <para>The different settings will now be explained.</para>
6193 <para><anchor id="SECURITYEQUALSSHARE"><emphasis>SECURITY = SHARE
6194 </emphasis></para>
6196 <para>When clients connect to a share level security server then
6197 need not log onto the server with a valid username and password before
6198 attempting to connect to a shared resource (although modern clients
6199 such as Windows 95/98 and Windows NT will send a logon request with
6200 a username but no password when talking to a <command>security = share
6201 </command> server). Instead, the clients send authentication information
6202 (passwords) on a per-share basis, at the time they attempt to connect
6203 to that share.</para>
6205 <para>Note that <command>smbd</command> <emphasis>ALWAYS</emphasis>
6206 uses a valid UNIX user to act on behalf of the client, even in
6207 <command>security = share</command> level security.</para>
6209 <para>As clients are not required to send a username to the server
6210 in share level security, <command>smbd</command> uses several
6211 techniques to determine the correct UNIX user to use on behalf
6212 of the client.</para>
6214 <para>A list of possible UNIX usernames to match with the given
6215 client password is constructed using the following methods :</para>
6217 <itemizedlist>
6218 <listitem><para>If the <link linkend="GUESTONLY"><parameter>guest
6219 only</parameter></link> parameter is set, then all the other
6220 stages are missed and only the <link linkend="GUESTACCOUNT">
6221 <parameter>guest account</parameter></link> username is checked.
6222 </para></listitem>
6224 <listitem><para>Is a username is sent with the share connection
6225 request, then this username (after mapping - see <link
6226 linkend="USERNAMEMAP"><parameter>username map</parameter></link>),
6227 is added as a potential username.</para></listitem>
6229 <listitem><para>If the client did a previous <emphasis>logon
6230 </emphasis> request (the SessionSetup SMB call) then the
6231 username sent in this SMB will be added as a potential username.
6232 </para></listitem>
6234 <listitem><para>The name of the service the client requested is
6235 added as a potential username.</para></listitem>
6237 <listitem><para>The NetBIOS name of the client is added to
6238 the list as a potential username.</para></listitem>
6240 <listitem><para>Any users on the <link linkend="USER"><parameter>
6241 user</parameter></link> list are added as potential usernames.
6242 </para></listitem>
6243 </itemizedlist>
6245 <para>If the <parameter>guest only</parameter> parameter is
6246 not set, then this list is then tried with the supplied password.
6247 The first user for whom the password matches will be used as the
6248 UNIX user.</para>
6250 <para>If the <parameter>guest only</parameter> parameter is
6251 set, or no username can be determined then if the share is marked
6252 as available to the <parameter>guest account</parameter>, then this
6253 guest user will be used, otherwise access is denied.</para>
6255 <para>Note that it can be <emphasis>very</emphasis> confusing
6256 in share-level security as to which UNIX username will eventually
6257 be used in granting access.</para>
6259 <para>See also the section <link linkend="VALIDATIONSECT">
6260 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6262 <para><anchor id="SECURITYEQUALSUSER"><emphasis>SECURIYT = USER
6263 </emphasis></para>
6265 <para>This is the default security setting in Samba 2.2.
6266 With user-level security a client must first "log=on" with a
6267 valid username and password (which can be mapped using the <link
6268 linkend="USERNAMEMAP"><parameter>username map</parameter></link>
6269 parameter). Encrypted passwords (see the <link linkend="ENCRYPTPASSWORDS">
6270 <parameter>encrypted passwords</parameter></link> parameter) can also
6271 be used in this security mode. Parameters such as <link linkend="USER">
6272 <parameter>user</parameter></link> and <link linkend="GUESTONLY">
6273 <parameter>guest only</parameter></link> if set are then applied and
6274 may change the UNIX user to use on this connection, but only after
6275 the user has been successfully authenticated.</para>
6277 <para><emphasis>Note</emphasis> that the name of the resource being
6278 requested is <emphasis>not</emphasis> sent to the server until after
6279 the server has successfully authenticated the client. This is why
6280 guest shares don't work in user level security without allowing
6281 the server to automatically map unknown users into the <link
6282 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>.
6283 See the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6284 </link> parameter for details on doing this.</para>
6286 <para>See also the section <link linkend="VALIDATIONSECT">
6287 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6289 <para><anchor id="SECURITYEQUALSSERVER"><emphasis>SECURITY = SERVER
6290 </emphasis></para>
6292 <para>In this mode Samba will try to validate the username/password
6293 by passing it to another SMB server, such as an NT box. If this
6294 fails it will revert to <command>security = user</command>, but note
6295 that if encrypted passwords have been negotiated then Samba cannot
6296 revert back to checking the UNIX password file, it must have a valid
6297 <filename>smbpasswd</filename> file to check users against. See the
6298 documentation file in the <filename>docs/</filename> directory
6299 <filename>ENCRYPTION.txt</filename> for details on how to set this
6300 up.</para>
6302 <para><emphasis>Note</emphasis> that from the clients point of
6303 view <command>security = server</command> is the same as <command>
6304 security = user</command>. It only affects how the server deals
6305 with the authentication, it does not in any way affect what the
6306 client sees.</para>
6308 <para><emphasis>Note</emphasis> that the name of the resource being
6309 requested is <emphasis>not</emphasis> sent to the server until after
6310 the server has successfully authenticated the client. This is why
6311 guest shares don't work in user level security without allowing
6312 the server to automatically map unknown users into the <link
6313 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>.
6314 See the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6315 </link> parameter for details on doing this.</para>
6317 <para>See also the section <link linkend="VALIDATIONSECT">
6318 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6320 <para>See also the <link linkend="PASSWORDSERVER"><parameter>password
6321 server</parameter></link> parameter and the <link
6322 linkend="ENCRYPTPASSWORDS"><parameter>encrypted passwords</parameter>
6323 </link> parameter.</para>
6325 <para><anchor id="SECURITYEQUALSDOMAIN"><emphasis>SECURITY = DOMAIN
6326 </emphasis></para>
6328 <para>This mode will only work correctly if <ulink
6329 url="smbpasswd.8.html">smbpasswd(8)</ulink> has been used to add this
6330 machine into a Windows NT Domain. It expects the <link
6331 linkend="ENCRYPTPASSWORDS"><parameter>encrypted passwords</parameter>
6332 </link> parameter to be set to <constant>true</constant>. In this
6333 mode Samba will try to validate the username/password by passing
6334 it to a Windows NT Primary or Backup Domain Controller, in exactly
6335 the same way that a Windows NT Server would do.</para>
6337 <para><emphasis>Note</emphasis> that a valid UNIX user must still
6338 exist as well as the account on the Domain Controller to allow
6339 Samba to have a valid UNIX account to map file access to.</para>
6341 <para><emphasis>Note</emphasis> that from the clients point
6342 of view <command>security = domain</command> is the same as <command>security = user
6343 </command>. It only affects how the server deals with the authentication,
6344 it does not in any way affect what the client sees.</para>
6346 <para><emphasis>Note</emphasis> that the name of the resource being
6347 requested is <emphasis>not</emphasis> sent to the server until after
6348 the server has successfully authenticated the client. This is why
6349 guest shares don't work in user level security without allowing
6350 the server to automatically map unknown users into the <link
6351 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>.
6352 See the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6353 </link> parameter for details on doing this.</para>
6355 <para><emphasis>BUG:</emphasis> There is currently a bug in the
6356 implementation of <command>security = domain</command> with respect
6357 to multi-byte character set usernames. The communication with a
6358 Domain Controller must be done in UNICODE and Samba currently
6359 does not widen multi-byte user names to UNICODE correctly, thus
6360 a multi-byte username will not be recognized correctly at the
6361 Domain Controller. This issue will be addressed in a future release.</para>
6363 <para>See also the section <link linkend="VALIDATIONSECT">
6364 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6366 <para>See also the <link linkend="PASSWORDSERVER"><parameter>password
6367 server</parameter></link> parameter and the <link
6368 linkend="ENCRYPTPASSWORDS"><parameter>encrypted passwords</parameter>
6369 </link> parameter.</para>
6371 <para>Default: <command>security = USER</command></para>
6372 <para>Example: <command>security = DOMAIN</command></para>
6373 </listitem>
6374 </varlistentry>
6378 <varlistentry>
6379 <term><anchor id="SECURITYMASK">security mask (S)</term>
6380 <listitem><para>This parameter controls what UNIX permission
6381 bits can be modified when a Windows NT client is manipulating
6382 the UNIX permission on a file using the native NT security
6383 dialog box.</para>
6385 <para>This parameter is applied as a mask (AND'ed with) to
6386 the changed permission bits, thus preventing any bits not in
6387 this mask from being modified. Essentially, zero bits in this
6388 mask may be treated as a set of bits the user is not allowed
6389 to change.</para>
6391 <para>If not set explicitly this parameter is 0777, allowing
6392 a user to modify all the user/group/world permissions on a file.
6393 </para>
6395 <para><emphasis>Note</emphasis> that users who can access the
6396 Samba server through other means can easily bypass this
6397 restriction, so it is primarily useful for standalone
6398 "appliance" systems. Administrators of most normal systems will
6399 probably want to leave it set to 0777.</para>
6401 <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE">
6402 <parameter>force directory security mode</parameter></link>,
6403 <link linkend="DIRECTORYSECURITYMASK"><parameter>directory
6404 security mask</parameter></link>, <link linkend="FORCESECURITYMODE">
6405 <parameter>force security mode</parameter></link> parameters.</para>
6407 <para>Default: <command>security mask = 0777</command></para>
6408 <para>Example: <command>security mask = 0770</command></para>
6409 </listitem>
6410 </varlistentry>
6413 <varlistentry>
6414 <term><anchor id="SERVERSTRING">server string (G)</term>
6415 <listitem><para>This controls what string will show up in the
6416 printer comment box in print manager and next to the IPC connection
6417 in <command>net view"</command>. It can be any string that you wish
6418 to show to your users.</para>
6420 <para>It also sets what will appear in browse lists next
6421 to the machine name.</para>
6423 <para>A <parameter>%v</parameter> will be replaced with the Samba
6424 version number.</para>
6426 <para>A <parameter>%h</parameter> will be replaced with the
6427 hostname.</para>
6429 <para>Default: <command>server string = Samba %v</command></para>
6431 <para>Example: <command>server string = University of GNUs Samba
6432 Server</command></para>
6433 </listitem>
6434 </varlistentry>
6438 <varlistentry>
6439 <term><anchor id="SETDIRECTORY">set directory (S)</term>
6440 <listitem><para>If <command>set directory = no</command>, then
6441 users of the service may not use the setdir command to change
6442 directory.</para>
6444 <para>The <command>setdir</command> command is only implemented
6445 in the Digital Pathworks client. See the Pathworks documentation
6446 for details.</para>
6448 <para>Default: <command>set directory = no</command></para>
6449 </listitem>
6450 </varlistentry>
6455 <varlistentry>
6456 <term><anchor id="SHAREMODES">share modes (S)</term>
6457 <listitem><para>This enables or disables the honoring of
6458 the <parameter>share modes</parameter> during a file open. These
6459 modes are used by clients to gain exclusive read or write access
6460 to a file.</para>
6462 <para>These open modes are not directly supported by UNIX, so
6463 they are simulated using shared memory, or lock files if your
6464 UNIX doesn't support shared memory (almost all do).</para>
6466 <para>The share modes that are enabled by this option are
6467 <constant>DENY_DOS</constant>, <constant>DENY_ALL</constant>,
6468 <constant>DENY_READ</constant>, <constant>DENY_WRITE</constant>,
6469 <constant>DENY_NONE</constant> and <constant>DENY_FCB</constant>.
6470 </para>
6472 <para>This option gives full share compatibility and enabled
6473 by default.</para>
6475 <para>You should <emphasis>NEVER</emphasis> turn this parameter
6476 off as many Windows applications will break if you do so.</para>
6478 <para>Default: <command>share modes = yes</command></para>
6479 </listitem>
6480 </varlistentry>
6485 <varlistentry>
6486 <term><anchor id="SHORTPRESERVECASE">short preserve case (S)</term>
6487 <listitem><para>This boolean parameter controls if new files
6488 which conform to 8.3 syntax, that is all in upper case and of
6489 suitable length, are created upper case, or if they are forced
6490 to be the <link linkend="DEFAULTCASE"><parameter>default case
6491 </parameter></link>. This option can be use with <link
6492 linkend="PRESERVECASE"><command>preserve case = yes</command>
6493 </link> to permit long filenames to retain their case, while short
6494 names are lowered. </para>
6496 <para>See the section on <link linkend="NAMEMANGLINGSECT">
6497 NAME MANGLING</link>.</para>
6499 <para>Default: <command>short preserve case = yes</command></para>
6500 </listitem>
6501 </varlistentry>
6505 <varlistentry>
6506 <term><anchor id="SHOWADDPRINTERWIZARD">show add printer wizard (G)</term>
6507 <listitem><para>With the introduction of MS-RPC based printing support
6508 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
6509 appear on Samba hosts in the share listing. Normally this folder will
6510 contain an icon for the MS Add Printer Wizard (APW). However, it is
6511 possible to disable this feature regardless of the level of privilege
6512 of the connected user.</para>
6514 <para>Under normal circumstances, the Windows NT/2000 client will
6515 open a handle on the printer server with OpenPrinterEx() asking for
6516 Administrator privileges. If the user does not have administrative
6517 access on the print server (i.e is not root or a member of the
6518 <parameter>printer admin</parameter> group), the OpenPrinterEx()
6519 call fails and the clients another open call with a request for
6520 a lower privilege level. This should succeed, however the APW
6521 icon will not be displayed.</para>
6523 <para>Disabling the <parameter>show add printer wizard</parameter>
6524 parameter will always cause the OpenPrinterEx() on the server
6525 to fail. Thus the APW icon will never be displayed. <emphasis>
6526 Note :</emphasis>This does not prevent the same user from having
6527 administrative privilege on an individual printer.</para>
6529 <para>See also <link linkend="ADDPRINTERCOMMAND"><parameter>addprinter
6530 command</parameter></link>, <link linkend="DELETEPRINTERCOMMAND">
6531 <parameter>deleteprinter command</parameter></link>, <link
6532 linkend="PRINTERADMIN"><parameter>printer admin</parameter></link></para>
6534 <para>Default :<command>show add printer wizard = yes</command></para>
6535 </listitem>
6536 </varlistentry>
6541 <varlistentry>
6542 <term><anchor id="SMBPASSWDFILE">smb passwd file (G)</term>
6543 <listitem><para>This option sets the path to the encrypted
6544 smbpasswd file. By default the path to the smbpasswd file
6545 is compiled into Samba.</para>
6547 <para>Default: <command>smb passwd file = ${prefix}/private/smbpasswd
6548 </command></para>
6550 <para>Example: <command>smb passwd file = /etc/samba/smbpasswd
6551 </command></para>
6552 </listitem>
6553 </varlistentry>
6558 <varlistentry>
6559 <term><anchor id="SOCKETADDRESS">socket address (G)</term>
6560 <listitem><para>This option allows you to control what
6561 address Samba will listen for connections on. This is used to
6562 support multiple virtual interfaces on the one server, each
6563 with a different configuration.</para>
6565 <para>By default samba will accept connections on any
6566 address.</para>
6568 <para>Example: <command>socket address = 192.168.2.20</command>
6569 </para>
6570 </listitem>
6571 </varlistentry>
6575 <varlistentry>
6576 <term><anchor id="SOCKETOPTIONS">socket options (G)</term>
6577 <listitem><para>This option allows you to set socket options
6578 to be used when talking with the client.</para>
6580 <para>Socket options are controls on the networking layer
6581 of the operating systems which allow the connection to be
6582 tuned.</para>
6584 <para>This option will typically be used to tune your Samba
6585 server for optimal performance for your local network. There is
6586 no way that Samba can know what the optimal parameters are for
6587 your net, so you must experiment and choose them yourself. We
6588 strongly suggest you read the appropriate documentation for your
6589 operating system first (perhaps <command>man setsockopt</command>
6590 will help).</para>
6592 <para>You may find that on some systems Samba will say
6593 "Unknown socket option" when you supply an option. This means you
6594 either incorrectly typed it or you need to add an include file
6595 to includes.h for your OS. If the latter is the case please
6596 send the patch to <ulink url="mailto:samba@samba.org">
6597 samba@samba.org</ulink>.</para>
6599 <para>Any of the supported socket options may be combined
6600 in any way you like, as long as your OS allows it.</para>
6602 <para>This is the list of socket options currently settable
6603 using this option:</para>
6605 <itemizedlist>
6606 <listitem><para>SO_KEEPALIVE</para></listitem>
6607 <listitem><para>SO_REUSEADDR</para></listitem>
6608 <listitem><para>SO_BROADCAST</para></listitem>
6609 <listitem><para>TCP_NODELAY</para></listitem>
6610 <listitem><para>IPTOS_LOWDELAY</para></listitem>
6611 <listitem><para>IPTOS_THROUGHPUT</para></listitem>
6612 <listitem><para>SO_SNDBUF *</para></listitem>
6613 <listitem><para>SO_RCVBUF *</para></listitem>
6614 <listitem><para>SO_SNDLOWAT *</para></listitem>
6615 <listitem><para>SO_RCVLOWAT *</para></listitem>
6616 </itemizedlist>
6618 <para>Those marked with a <emphasis>'*'</emphasis> take an integer
6619 argument. The others can optionally take a 1 or 0 argument to enable
6620 or disable the option, by default they will be enabled if you
6621 don't specify 1 or 0.</para>
6623 <para>To specify an argument use the syntax SOME_OPTION=VALUE
6624 for example <command>SO_SNDBUF=8192</command>. Note that you must
6625 not have any spaces before or after the = sign.</para>
6627 <para>If you are on a local network then a sensible option
6628 might be</para>
6629 <para><command>socket options = IPTOS_LOWDELAY</command></para>
6631 <para>If you have a local network then you could try:</para>
6632 <para><command>socket options = IPTOS_LOWDELAY TCP_NODELAY</command></para>
6634 <para>If you are on a wide area network then perhaps try
6635 setting IPTOS_THROUGHPUT. </para>
6637 <para>Note that several of the options may cause your Samba
6638 server to fail completely. Use these options with caution!</para>
6640 <para>Default: <command>socket options = TCP_NODELAY</command></para>
6641 <para>Example: <command>socket options = IPTOS_LOWDELAY</command></para>
6642 </listitem>
6643 </varlistentry>
6648 <varlistentry>
6649 <term><anchor id="SOURCEENVIRONMENT">source environment (G)</term>
6650 <listitem><para>This parameter causes Samba to set environment
6651 variables as per the content of the file named.</para>
6653 <para>If the value of this parameter starts with a "|" character
6654 then Samba will treat that value as a pipe command to open and
6655 will set the environment variables from the output of the pipe.</para>
6657 <para>The contents of the file or the output of the pipe should
6658 be formatted as the output of the standard Unix <command>env(1)
6659 </command> command. This is of the form :</para>
6660 <para>Example environment entry:</para>
6661 <para><command>SAMBA_NETBIOS_NAME=myhostname</command></para>
6663 <para>Default: <emphasis>No default value</emphasis></para>
6664 <para>Examples: <command>source environment = |/etc/smb.conf.sh
6665 </command></para>
6667 <para>Example: <command>source environment =
6668 /usr/local/smb_env_vars</command></para>
6669 </listitem>
6670 </varlistentry>
6674 <varlistentry>
6675 <term><anchor id="SSL">ssl (G)</term>
6676 <listitem><para>This variable is part of SSL-enabled Samba. This
6677 is only available if the SSL libraries have been compiled on your
6678 system and the configure option <command>--with-ssl</command> was
6679 given at configure time.</para>
6681 <para><emphasis>Note</emphasis> that for export control reasons
6682 this code is <emphasis>NOT</emphasis> enabled by default in any
6683 current binary version of Samba.</para>
6685 <para>This variable enables or disables the entire SSL mode. If
6686 it is set to <constant>no</constant>, the SSL enabled samba behaves
6687 exactly like the non-SSL samba. If set to <constant>yes</constant>,
6688 it depends on the variables <link linkend="SSLHOSTS"><parameter>
6689 ssl hosts</parameter></link> and <link linkend="SSLHOSTSRESIGN">
6690 <parameter>ssl hosts resign</parameter></link> whether an SSL
6691 connection will be required.</para>
6693 <para>Default: <command>ssl=no</command></para>
6694 </listitem>
6695 </varlistentry>
6699 <varlistentry>
6700 <term><anchor id="SSLCACERTDIR">ssl CA certDir (G)</term>
6701 <listitem><para>This variable is part of SSL-enabled Samba. This
6702 is only available if the SSL libraries have been compiled on your
6703 system and the configure option <command>--with-ssl</command> was
6704 given at configure time.</para>
6706 <para><emphasis>Note</emphasis> that for export control reasons
6707 this code is <emphasis>NOT</emphasis> enabled by default in any
6708 current binary version of Samba.</para>
6710 <para>This variable defines where to look up the Certification
6711 Authorities. The given directory should contain one file for
6712 each CA that samba will trust. The file name must be the hash
6713 value over the "Distinguished Name" of the CA. How this directory
6714 is set up is explained later in this document. All files within the
6715 directory that don't fit into this naming scheme are ignored. You
6716 don't need this variable if you don't verify client certificates.</para>
6718 <para>Default: <command>ssl CA certDir = /usr/local/ssl/certs
6719 </command></para>
6720 </listitem>
6721 </varlistentry>
6725 <varlistentry>
6726 <term><anchor id="SSLCACERTFILE">ssl CA certFile (G)</term>
6727 <listitem><para>This variable is part of SSL-enabled Samba. This
6728 is only available if the SSL libraries have been compiled on your
6729 system and the configure option <command>--with-ssl</command> was
6730 given at configure time.</para>
6732 <para><emphasis>Note</emphasis> that for export control reasons
6733 this code is <emphasis>NOT</emphasis> enabled by default in any
6734 current binary version of Samba.</para>
6736 <para>This variable is a second way to define the trusted CAs.
6737 The certificates of the trusted CAs are collected in one big
6738 file and this variable points to the file. You will probably
6739 only use one of the two ways to define your CAs. The first choice is
6740 preferable if you have many CAs or want to be flexible, the second
6741 is preferable if you only have one CA and want to keep things
6742 simple (you won't need to create the hashed file names). You
6743 don't need this variable if you don't verify client certificates.</para>
6745 <para>Default: <command>ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
6746 </command></para>
6747 </listitem>
6748 </varlistentry>
6752 <varlistentry>
6753 <term><anchor id="SSLCIPHERS">ssl ciphers (G)</term>
6754 <listitem><para>This variable is part of SSL-enabled Samba. This
6755 is only available if the SSL libraries have been compiled on your
6756 system and the configure option <command>--with-ssl</command> was
6757 given at configure time.</para>
6759 <para><emphasis>Note</emphasis> that for export control reasons
6760 this code is <emphasis>NOT</emphasis> enabled by default in any
6761 current binary version of Samba.</para>
6763 <para>This variable defines the ciphers that should be offered
6764 during SSL negotiation. You should not set this variable unless
6765 you know what you are doing.</para>
6766 </listitem>
6767 </varlistentry>
6770 <varlistentry>
6771 <term><anchor id="SSLCLIENTCERT">ssl client cert (G)</term>
6772 <listitem><para>This variable is part of SSL-enabled Samba. This
6773 is only available if the SSL libraries have been compiled on your
6774 system and the configure option <command>--with-ssl</command> was
6775 given at configure time.</para>
6777 <para><emphasis>Note</emphasis> that for export control reasons
6778 this code is <emphasis>NOT</emphasis> enabled by default in any
6779 current binary version of Samba.</para>
6781 <para>The certificate in this file is used by <ulink url="smbclient.1.html">
6782 <command>smbclient(1)</command></ulink> if it exists. It's needed
6783 if the server requires a client certificate.</para>
6785 <para>Default: <command>ssl client cert = /usr/local/ssl/certs/smbclient.pem
6786 </command></para>
6787 </listitem>
6788 </varlistentry>
6792 <varlistentry>
6793 <term><anchor id="SSLCLIENTKEY">ssl client key (G)</term>
6794 <listitem><para>This variable is part of SSL-enabled Samba. This
6795 is only available if the SSL libraries have been compiled on your
6796 system and the configure option <command>--with-ssl</command> was
6797 given at configure time.</para>
6799 <para><emphasis>Note</emphasis> that for export control reasons
6800 this code is <emphasis>NOT</emphasis> enabled by default in any
6801 current binary version of Samba.</para>
6803 <para>This is the private key for <ulink url="smbclient.1.html">
6804 <command>smbclient(1)</command></ulink>. It's only needed if the
6805 client should have a certificate. </para>
6807 <para>Default: <command>ssl client key = /usr/local/ssl/private/smbclient.pem
6808 </command></para>
6809 </listitem>
6810 </varlistentry>
6814 <varlistentry>
6815 <term><anchor id="SSLCOMPATIBILITY">ssl compatibility (G)</term>
6816 <listitem><para>This variable is part of SSL-enabled Samba. This
6817 is only available if the SSL libraries have been compiled on your
6818 system and the configure option <command>--with-ssl</command> was
6819 given at configure time.</para>
6821 <para><emphasis>Note</emphasis> that for export control reasons
6822 this code is <emphasis>NOT</emphasis> enabled by default in any
6823 current binary version of Samba.</para>
6825 <para>This variable defines whether SSLeay should be configured
6826 for bug compatibility with other SSL implementations. This is
6827 probably not desirable because currently no clients with SSL
6828 implementations other than SSLeay exist.</para>
6830 <para>Default: <command>ssl compatibility = no</command></para>
6831 </listitem>
6832 </varlistentry>
6835 <varlistentry>
6836 <term><anchor id="SSLHOSTS">ssl hosts (G)</term>
6837 <listitem><para>See <link linkend="SSLHOSTSRESIGN"><parameter>
6838 ssl hosts resign</parameter></link>.</para>
6839 </listitem>
6840 </varlistentry>
6843 <varlistentry>
6844 <term><anchor id="SSLHOSTSRESIGN">ssl hosts resign (G)</term>
6845 <listitem><para>This variable is part of SSL-enabled Samba. This
6846 is only available if the SSL libraries have been compiled on your
6847 system and the configure option <command>--with-ssl</command> was
6848 given at configure time.</para>
6850 <para><emphasis>Note</emphasis> that for export control reasons
6851 this code is <emphasis>NOT</emphasis> enabled by default in any
6852 current binary version of Samba.</para>
6854 <para>These two variables define whether samba will go
6855 into SSL mode or not. If none of them is defined, samba will
6856 allow only SSL connections. If the <link linkend="SSLHOSTS">
6857 <parameter>ssl hosts</parameter></link> variable lists
6858 hosts (by IP-address, IP-address range, net group or name),
6859 only these hosts will be forced into SSL mode. If the <parameter>
6860 ssl hosts resign</parameter> variable lists hosts, only these
6861 hosts will NOT be forced into SSL mode. The syntax for these two
6862 variables is the same as for the <link linkend="HOSTSALLOW"><parameter>
6863 hosts allow</parameter></link> and <link linkend="HOSTSDENY">
6864 <parameter>hosts deny</parameter></link> pair of variables, only
6865 that the subject of the decision is different: It's not the access
6866 right but whether SSL is used or not. </para>
6868 <para>The example below requires SSL connections from all hosts
6869 outside the local net (which is 192.168.*.*).</para>
6871 <para>Default: <command>ssl hosts = &lt;empty string&gt;</command></para>
6872 <para><command>ssl hosts resign = &lt;empty string&gt;</command></para>
6874 <para>Example: <command>ssl hosts resign = 192.168.</command></para>
6875 </listitem>
6876 </varlistentry>
6880 <varlistentry>
6881 <term><anchor id="SSLREQUIRECLIENTCERT">ssl require clientcert (G)</term>
6882 <listitem><para>This variable is part of SSL-enabled Samba. This
6883 is only available if the SSL libraries have been compiled on your
6884 system and the configure option <command>--with-ssl</command> was
6885 given at configure time.</para>
6887 <para><emphasis>Note</emphasis> that for export control reasons
6888 this code is <emphasis>NOT</emphasis> enabled by default in any
6889 current binary version of Samba.</para>
6891 <para>If this variable is set to <constant>yes</constant>, the
6892 server will not tolerate connections from clients that don't
6893 have a valid certificate. The directory/file given in <link
6894 linkend="SSLCACERTDIR"><parameter>ssl CA certDir</parameter>
6895 </link> and <link linkend="SSLCACERTFILE"><parameter>ssl CA certFile
6896 </parameter></link> will be used to look up the CAs that issued
6897 the client's certificate. If the certificate can't be verified
6898 positively, the connection will be terminated. If this variable
6899 is set to <constant>no</constant>, clients don't need certificates.
6900 Contrary to web applications you really <emphasis>should</emphasis>
6901 require client certificates. In the web environment the client's
6902 data is sensitive (credit card numbers) and the server must prove
6903 to be trustworthy. In a file server environment the server's data
6904 will be sensitive and the clients must prove to be trustworthy.</para>
6906 <para>Default: <command>ssl require clientcert = no</command></para>
6907 </listitem>
6908 </varlistentry>
6912 <varlistentry>
6913 <term><anchor id="SSLREQUIRESERVERCERT">ssl require servercert (G)</term>
6914 <listitem><para>This variable is part of SSL-enabled Samba. This
6915 is only available if the SSL libraries have been compiled on your
6916 system and the configure option <command>--with-ssl</command> was
6917 given at configure time.</para>
6919 <para><emphasis>Note</emphasis> that for export control reasons
6920 this code is <emphasis>NOT</emphasis> enabled by default in any
6921 current binary version of Samba.</para>
6923 <para>If this variable is set to <constant>yes</constant>, the
6924 <ulink url="smbclient.1.html"><command>smbclient(1)</command>
6925 </ulink> will request a certificate from the server. Same as
6926 <link linkend="SSLREQUIRECLIENTCERT"><parameter>ssl require
6927 clientcert</parameter></link> for the server.</para>
6929 <para>Default: <command>ssl require servercert = no</command>
6930 </para>
6931 </listitem>
6932 </varlistentry>
6934 <varlistentry>
6935 <term><anchor id="SSLSERVERCERT">ssl server cert (G)</term>
6936 <listitem><para>This variable is part of SSL-enabled Samba. This
6937 is only available if the SSL libraries have been compiled on your
6938 system and the configure option <command>--with-ssl</command> was
6939 given at configure time.</para>
6941 <para><emphasis>Note</emphasis> that for export control reasons
6942 this code is <emphasis>NOT</emphasis> enabled by default in any
6943 current binary version of Samba.</para>
6945 <para>This is the file containing the server's certificate.
6946 The server <emphasis>must</emphasis> have a certificate. The
6947 file may also contain the server's private key. See later for
6948 how certificates and private keys are created.</para>
6950 <para>Default: <command>ssl server cert = &lt;empty string&gt;
6951 </command></para>
6952 </listitem>
6953 </varlistentry>
6956 <varlistentry>
6957 <term><anchor id="SSLSERVERKEY">ssl server key (G)</term>
6958 <listitem><para>This variable is part of SSL-enabled Samba. This
6959 is only available if the SSL libraries have been compiled on your
6960 system and the configure option <command>--with-ssl</command> was
6961 given at configure time.</para>
6963 <para><emphasis>Note</emphasis> that for export control reasons
6964 this code is <emphasis>NOT</emphasis> enabled by default in any
6965 current binary version of Samba.</para>
6967 <para>This file contains the private key of the server. If
6968 this variable is not defined, the key is looked up in the
6969 certificate file (it may be appended to the certificate).
6970 The server <emphasis>must</emphasis> have a private key
6971 and the certificate <emphasis>must</emphasis>
6972 match this private key.</para>
6974 <para>Default: <command>ssl server key = &lt;empty string&gt;
6975 </command></para>
6976 </listitem>
6977 </varlistentry>
6980 <varlistentry>
6981 <term><anchor id="SSLVERSION">ssl version (G)</term>
6982 <listitem><para>This variable is part of SSL-enabled Samba. This
6983 is only available if the SSL libraries have been compiled on your
6984 system and the configure option <command>--with-ssl</command> was
6985 given at configure time.</para>
6987 <para><emphasis>Note</emphasis> that for export control reasons
6988 this code is <emphasis>NOT</emphasis> enabled by default in any
6989 current binary version of Samba.</para>
6991 <para>This enumeration variable defines the versions of the
6992 SSL protocol that will be used. <constant>ssl2or3</constant> allows
6993 dynamic negotiation of SSL v2 or v3, <constant>ssl2</constant> results
6994 in SSL v2, <constant>ssl3</constant> results in SSL v3 and
6995 <constant>tls1</constant> results in TLS v1. TLS (Transport Layer
6996 Security) is the new standard for SSL.</para>
6998 <para>Default: <command>ssl version = "ssl2or3"</command></para>
6999 </listitem>
7000 </varlistentry>
7004 <varlistentry>
7005 <term><anchor id="STATCACHE">stat cache (G)</term>
7006 <listitem><para>This parameter determines if <ulink
7007 url="smbd.8.html">smbd(8)</ulink> will use a cache in order to
7008 speed up case insensitive name mappings. You should never need
7009 to change this parameter.</para>
7011 <para>Default: <command>stat cache = yes</command></para>
7012 </listitem>
7013 </varlistentry>
7015 <varlistentry>
7016 <term><anchor id="STATCACHESIZE">stat cache size (G)</term>
7017 <listitem><para>This parameter determines the number of
7018 entries in the <parameter>stat cache</parameter>. You should
7019 never need to change this parameter.</para>
7021 <para>Default: <command>stat cache size = 50</command></para>
7022 </listitem>
7023 </varlistentry>
7027 <varlistentry>
7028 <term><anchor id="STATUS">status (G)</term>
7029 <listitem><para>This enables or disables logging of connections
7030 to a status file that <ulink url="smbstatus.1.html">smbstatus(1)</ulink>
7031 can read.</para>
7033 <para>With this disabled <command>smbstatus</command> won't be able
7034 to tell you what connections are active. You should never need to
7035 change this parameter.</para>
7037 <para>Default: <command>status = yes</command></para>
7038 </listitem>
7039 </varlistentry>
7043 <varlistentry>
7044 <term><anchor id="STRICTLOCKING">strict locking (S)</term>
7045 <listitem><para>This is a boolean that controls the handling of
7046 file locking in the server. When this is set to <constant>yes</constant>
7047 the server will check every read and write access for file locks, and
7048 deny access if locks exist. This can be slow on some systems.</para>
7050 <para>When strict locking is <constant>no</constant> the server does file
7051 lock checks only when the client explicitly asks for them.</para>
7053 <para>Well behaved clients always ask for lock checks when it
7054 is important, so in the vast majority of cases <command>strict
7055 locking = no</command> is preferable.</para>
7057 <para>Default: <command>strict locking = no</command></para>
7058 </listitem>
7059 </varlistentry>
7063 <varlistentry>
7064 <term><anchor id="STRICTSYNC">strict sync (S)</term>
7065 <listitem><para>Many Windows applications (including the Windows
7066 98 explorer shell) seem to confuse flushing buffer contents to
7067 disk with doing a sync to disk. Under UNIX, a sync call forces
7068 the process to be suspended until the kernel has ensured that
7069 all outstanding data in kernel disk buffers has been safely stored
7070 onto stable storage. This is very slow and should only be done
7071 rarely. Setting this parameter to <constant>no</constant> (the
7072 default) means that smbd ignores the Windows applications requests for
7073 a sync call. There is only a possibility of losing data if the
7074 operating system itself that Samba is running on crashes, so there is
7075 little danger in this default setting. In addition, this fixes many
7076 performance problems that people have reported with the new Windows98
7077 explorer shell file copies.</para>
7079 <para>See also the <link linkend="SYNCALWAYS"><parameter>sync
7080 always></parameter></link> parameter.</para>
7082 <para>Default: <command>strict sync = no</command></para>
7083 </listitem>
7084 </varlistentry>
7087 <varlistentry>
7088 <term><anchor id="STRIPDOT">strip dot (G)</term>
7089 <listitem><para>This is a boolean that controls whether to
7090 strip trailing dots off UNIX filenames. This helps with some
7091 CDROMs that have filenames ending in a single dot.</para>
7093 <para>Default: <command>strip dot = no</command></para>
7094 </listitem>
7095 </varlistentry>
7099 <varlistentry>
7100 <term><anchor id="SYNCALWAYS">sync always (S)</term>
7101 <listitem><para>This is a boolean parameter that controls
7102 whether writes will always be written to stable storage before
7103 the write call returns. If this is false then the server will be
7104 guided by the client's request in each write call (clients can
7105 set a bit indicating that a particular write should be synchronous).
7106 If this is true then every write will be followed by a <command>fsync()
7107 </command> call to ensure the data is written to disk. Note that
7108 the <parameter>strict sync</parameter> parameter must be set to
7109 <constant>yes</constant> in order for this parameter to have
7110 any affect.</para>
7112 <para>See also the <link linkend="STRICTSYNC"><parameter>strict
7113 sync</parameter></link> parameter.</para>
7115 <para>Default: <command>sync always = no</command></para>
7116 </listitem>
7117 </varlistentry>
7121 <varlistentry>
7122 <term><anchor id="SYSLOG">syslog (G)</term>
7123 <listitem><para>This parameter maps how Samba debug messages
7124 are logged onto the system syslog logging levels. Samba debug
7125 level zero maps onto syslog <constant>LOG_ERR</constant>, debug
7126 level one maps onto <constant>LOG_WARNING</constant>, debug level
7127 two maps onto <constant>LOG_NOTICE</constant>, debug level three
7128 maps onto LOG_INFO. All higher levels are mapped to <constant>
7129 LOG_DEBUG</constant>.</para>
7131 <para>This parameter sets the threshold for sending messages
7132 to syslog. Only messages with debug level less than this value
7133 will be sent to syslog.</para>
7135 <para>Default: <command>syslog = 1</command></para>
7136 </listitem>
7137 </varlistentry>
7141 <varlistentry>
7142 <term><anchor id="SYSLOGONLY">syslog only (G)</term>
7143 <listitem><para>If this parameter is set then Samba debug
7144 messages are logged into the system syslog only, and not to
7145 the debug log files.</para>
7147 <para>Default: <command>syslog only = no</command></para>
7148 </listitem>
7149 </varlistentry>
7153 <varlistentry>
7154 <term><anchor id="TEMPLATEHOMEDIR">template homedir (G)</term>
7155 <listitem><para><emphasis>NOTE:</emphasis> this parameter is
7156 only available in Samba 3.0.</para>
7158 <para>When filling out the user information for a Windows NT
7159 user, the <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon
7160 uses this parameter to fill in the home directory for that user.
7161 If the string <parameter>%D</parameter> is present it is substituted
7162 with the user's Windows NT domain name. If the string <parameter>%U
7163 </parameter> is present it is substituted with the user's Windows
7164 NT user name.</para>
7166 <para>Default: <command>template homedir = /home/%D/%U</command></para>
7167 </listitem>
7168 </varlistentry>
7172 <varlistentry>
7173 <term><anchor id="TEMPLATESHELL">template shell (G)</term>
7174 <listitem><para><emphasis>NOTE:</emphasis> this parameter is
7175 only available in Samba 3.0.</para>
7177 <para>When filling out the user information for a Windows NT
7178 user, the <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon
7179 uses this parameter to fill in the login shell for that user.</para>
7181 <para>Default: <command>template shell = /bin/false</command></para>
7182 </listitem>
7183 </varlistentry>
7187 <varlistentry>
7188 <term><anchor id="TIMEOFFSET">time offset (G)</term>
7189 <listitem><para>This parameter is a setting in minutes to add
7190 to the normal GMT to local time conversion. This is useful if
7191 you are serving a lot of PCs that have incorrect daylight
7192 saving time handling.</para>
7194 <para>Default: <command>time offset = 0</command></para>
7195 <para>Example: <command>time offset = 60</command></para>
7196 </listitem>
7197 </varlistentry>
7201 <varlistentry>
7202 <term><anchor id="TIMESERVER">time server (G)</term>
7203 <listitem><para>This parameter determines if <ulink url="nmbd.8.html">
7204 nmbd(8)</ulink> advertises itself as a time server to Windows
7205 clients.</para>
7207 <para>Default: <command>time server = no</command></para>
7208 </listitem>
7209 </varlistentry>
7212 <varlistentry>
7213 <term><anchor id="TIMESTAMPLOGS">timestamp logs (G)</term>
7214 <listitem><para>Synonym for <link linkend="DEBUGTIMESTAMP"><parameter>
7215 debug timestamp</parameter></link>.</para>
7216 </listitem>
7217 </varlistentry>
7223 <varlistentry>
7224 <term><anchor id="TOTALPRINTJOBS">total print jobs (G)</term>
7225 <listitem><para>This parameter accepts an integer value which defines
7226 a limit on the maximum number of print jobs that will be accepted
7227 system wide at any given time. If a print job is submitted
7228 by a client which will exceed this number, then smbd will return an
7229 error indicating that no space is available on the server. The
7230 default value of 0 means that no such limit exists. This parameter
7231 can be used to prevent a server from exceeding its capacity and is
7232 designed as a printing throttle. See also
7233 <link linkend="MAXPRINTJOBS"><parameter>max print jobs</parameter</link>.
7234 </para>
7236 <para>Default: <command>total print jobs = 0</command></para>
7237 <para>Example: <command>total print jobs = 5000</command></para>
7238 </listitem>
7239 </varlistentry>
7244 <varlistentry>
7245 <term><anchor id="UNIXPASSWORDSYNC">unix password sync (G)</term>
7246 <listitem><para>This boolean parameter controls whether Samba
7247 attempts to synchronize the UNIX password with the SMB password
7248 when the encrypted SMB password in the smbpasswd file is changed.
7249 If this is set to true the program specified in the <parameter>passwd
7250 program</parameter>parameter is called <emphasis>AS ROOT</emphasis> -
7251 to allow the new UNIX password to be set without access to the
7252 old UNIX password (as the SMB password has change code has no
7253 access to the old password cleartext, only the new).</para>
7255 <para>See also <link linkend="PASSWDPROGRAM"><parameter>passwd
7256 program</parameter></link>, <link linkend="PASSWDCHAT"><parameter>
7257 passwd chat</parameter></link>.</para>
7259 <para>Default: <command>unix password sync = no</command></para>
7260 </listitem>
7261 </varlistentry>
7265 <varlistentry>
7266 <term><anchor id="UPDATEENCRYPTED">update encrypted (G)</term>
7267 <listitem><para>This boolean parameter allows a user logging
7268 on with a plaintext password to have their encrypted (hashed)
7269 password in the smbpasswd file to be updated automatically as
7270 they log on. This option allows a site to migrate from plaintext
7271 password authentication (users authenticate with plaintext
7272 password over the wire, and are checked against a UNIX account
7273 database) to encrypted password authentication (the SMB
7274 challenge/response authentication mechanism) without forcing
7275 all users to re-enter their passwords via smbpasswd at the time the
7276 change is made. This is a convenience option to allow the change over
7277 to encrypted passwords to be made over a longer period. Once all users
7278 have encrypted representations of their passwords in the smbpasswd
7279 file this parameter should be set to <constant>no</constant>.</para>
7281 <para>In order for this parameter to work correctly the <link
7282 linkend="ENCRYPTPASSWORDS"><parameter>encrypt passwords</parameter>
7283 </link> parameter must be set to <constant>no</constant> when
7284 this parameter is set to <constant>yes</constant>.</para>
7286 <para>Note that even when this parameter is set a user
7287 authenticating to <command>smbd</command> must still enter a valid
7288 password in order to connect correctly, and to update their hashed
7289 (smbpasswd) passwords.</para>
7291 <para>Default: <command>update encrypted = no</command></para>
7292 </listitem>
7293 </varlistentry>
7297 <varlistentry>
7298 <term><anchor id="USERHOSTS">use rhosts (G)</term>
7299 <listitem><para>If this global parameter is a true, it specifies
7300 that the UNIX users <filename>.rhosts</filename> file in their home directory
7301 will be read to find the names of hosts and users who will be allowed
7302 access without specifying a password.</para>
7304 <para><emphasis>NOTE:</emphasis> The use of <parameter>use rhosts
7305 </parameter> can be a major security hole. This is because you are
7306 trusting the PC to supply the correct username. It is very easy to
7307 get a PC to supply a false username. I recommend that the <parameter>
7308 use rhosts</parameter> option be only used if you really know what
7309 you are doing.</para>
7311 <para>Default: <command>use rhosts = no</command></para>
7312 </listitem>
7313 </varlistentry>
7317 <varlistentry>
7318 <term><anchor id="USER">user (S)</term>
7319 <listitem><para>Synonym for <link linkend="USERNAME"><parameter>
7320 username</parameter></link>.</para>
7321 </listitem>
7322 </varlistentry>
7326 <varlistentry>
7327 <term><anchor id="USERS">users (S)</term>
7328 <listitem><para>Synonym for <link linkend="USERNAME"><parameter>
7329 username</parameter></link>.</para>
7330 </listitem>
7331 </varlistentry>
7334 <varlistentry>
7335 <term><anchor id="USERNAME">username (S)</term>
7336 <listitem><para>Multiple users may be specified in a comma-delimited
7337 list, in which case the supplied password will be tested against
7338 each username in turn (left to right).</para>
7340 <para>The <parameter>username</parameter> line is needed only when
7341 the PC is unable to supply its own username. This is the case
7342 for the COREPLUS protocol or where your users have different WfWg
7343 usernames to UNIX usernames. In both these cases you may also be
7344 better using the \\server\share%user syntax instead.</para>
7346 <para>The <parameter>username</parameter> line is not a great
7347 solution in many cases as it means Samba will try to validate
7348 the supplied password against each of the usernames in the
7349 <parameter>username</parameter> line in turn. This is slow and
7350 a bad idea for lots of users in case of duplicate passwords.
7351 You may get timeouts or security breaches using this parameter
7352 unwisely.</para>
7354 <para>Samba relies on the underlying UNIX security. This
7355 parameter does not restrict who can login, it just offers hints
7356 to the Samba server as to what usernames might correspond to the
7357 supplied password. Users can login as whoever they please and
7358 they will be able to do no more damage than if they started a
7359 telnet session. The daemon runs as the user that they log in as,
7360 so they cannot do anything that user cannot do.</para>
7362 <para>To restrict a service to a particular set of users you
7363 can use the <link linkend="VALIDUSERS"><parameter>valid users
7364 </parameter></link> parameter.</para>
7366 <para>If any of the usernames begin with a '@' then the name
7367 will be looked up first in the yp netgroups list (if Samba
7368 is compiled with netgroup support), followed by a lookup in
7369 the UNIX groups database and will expand to a list of all users
7370 in the group of that name.</para>
7372 <para>If any of the usernames begin with a '+' then the name
7373 will be looked up only in the UNIX groups database and will
7374 expand to a list of all users in the group of that name.</para>
7376 <para>If any of the usernames begin with a '&'then the name
7377 will be looked up only in the yp netgroups database (if Samba
7378 is compiled with netgroup support) and will expand to a list
7379 of all users in the netgroup group of that name.</para>
7381 <para>Note that searching though a groups database can take
7382 quite some time, and some clients may time out during the
7383 search.</para>
7385 <para>See the section <link linkend="VALIDATIONSECT">NOTE ABOUT
7386 USERNAME/PASSWORD VALIDATION</link> for more information on how
7387 this parameter determines access to the services.</para>
7389 <para>Default: <command>The guest account if a guest service,
7390 else &lt;empty string&gt;.</command></para>
7392 <para>Examples:<command>username = fred, mary, jack, jane,
7393 @users, @pcgroup</command></para>
7394 </listitem>
7395 </varlistentry>
7399 <varlistentry>
7400 <term><anchor id="USERNAMELEVEL">username level (G)</term>
7401 <listitem><para>This option helps Samba to try and 'guess' at
7402 the real UNIX username, as many DOS clients send an all-uppercase
7403 username. By default Samba tries all lowercase, followed by the
7404 username with the first letter capitalized, and fails if the
7405 username is not found on the UNIX machine.</para>
7407 <para>If this parameter is set to non-zero the behavior changes.
7408 This parameter is a number that specifies the number of uppercase
7409 combinations to try while trying to determine the UNIX user name. The
7410 higher the number the more combinations will be tried, but the slower
7411 the discovery of usernames will be. Use this parameter when you have
7412 strange usernames on your UNIX machine, such as <constant>AstrangeUser
7413 </constant>.</para>
7415 <para>Default: <command>username level = 0</command></para>
7416 <para>Example: <command>username level = 5</command></para>
7417 </listitem>
7418 </varlistentry>
7422 <varlistentry>
7423 <term><anchor id="USERNAMEMAP">username map (G)</term>
7424 <listitem><para>This option allows you to specify a file containing
7425 a mapping of usernames from the clients to the server. This can be
7426 used for several purposes. The most common is to map usernames
7427 that users use on DOS or Windows machines to those that the UNIX
7428 box uses. The other is to map multiple users to a single username
7429 so that they can more easily share files.</para>
7431 <para>The map file is parsed line by line. Each line should
7432 contain a single UNIX username on the left then a '=' followed
7433 by a list of usernames on the right. The list of usernames on the
7434 right may contain names of the form @group in which case they
7435 will match any UNIX username in that group. The special client
7436 name '*' is a wildcard and matches any name. Each line of the
7437 map file may be up to 1023 characters long.</para>
7439 <para>The file is processed on each line by taking the
7440 supplied username and comparing it with each username on the right
7441 hand side of the '=' signs. If the supplied name matches any of
7442 the names on the right hand side then it is replaced with the name
7443 on the left. Processing then continues with the next line.</para>
7445 <para>If any line begins with a '#' or a ';' then it is
7446 ignored</para>
7448 <para>If any line begins with an '!' then the processing
7449 will stop after that line if a mapping was done by the line.
7450 Otherwise mapping continues with every line being processed.
7451 Using '!' is most useful when you have a wildcard mapping line
7452 later in the file.</para>
7454 <para>For example to map from the name <constant>admin</constant>
7455 or <constant>administrator</constant> to the UNIX name <constant>
7456 root</constant> you would use:</para>
7458 <para><command>root = admin administrator</command></para>
7460 <para>Or to map anyone in the UNIX group <constant>system</constant>
7461 to the UNIX name <constant>sys</constant> you would use:</para>
7463 <para><command>sys = @system</command></para>
7465 <para>You can have as many mappings as you like in a username
7466 map file.</para>
7469 <para>If your system supports the NIS NETGROUP option then
7470 the netgroup database is checked before the <filename>/etc/group
7471 </filename> database for matching groups.</para>
7473 <para>You can map Windows usernames that have spaces in them
7474 by using double quotes around the name. For example:</para>
7476 <para><command>tridge = "Andrew Tridgell"</command></para>
7478 <para>would map the windows username "Andrew Tridgell" to the
7479 unix username "tridge".</para>
7481 <para>The following example would map mary and fred to the
7482 unix user sys, and map the rest to guest. Note the use of the
7483 '!' to tell Samba to stop processing if it gets a match on
7484 that line.</para>
7486 <para><programlisting>
7487 !sys = mary fred
7488 guest = *
7489 </programlisting></para>
7491 <para>Note that the remapping is applied to all occurrences
7492 of usernames. Thus if you connect to \\server\fred and <constant>
7493 fred</constant> is remapped to <constant>mary</constant> then you
7494 will actually be connecting to \\server\mary and will need to
7495 supply a password suitable for <constant>mary</constant> not
7496 <constant>fred</constant>. The only exception to this is the
7497 username passed to the <link linkend="PASSWORDSERVER"><parameter>
7498 password server</parameter></link> (if you have one). The password
7499 server will receive whatever username the client supplies without
7500 modification.</para>
7502 <para>Also note that no reverse mapping is done. The main effect
7503 this has is with printing. Users who have been mapped may have
7504 trouble deleting print jobs as PrintManager under WfWg will think
7505 they don't own the print job.</para>
7507 <para>Default: <emphasis>no username map</emphasis></para>
7508 <para>Example: <command>username map = /usr/local/samba/lib/users.map
7509 </command></para>
7510 </listitem>
7511 </varlistentry>
7515 <varlistentry>
7516 <term><anchor id="UTMP">utmp (S)</term>
7517 <listitem><para>This boolean parameter is only available if
7518 Samba has been configured and compiled with the option <command>
7519 --with-utmp</command>. If set to True then Samba will attempt
7520 to add utmp or utmpx records (depending on the UNIX system) whenever a
7521 connection is made to a Samba server. Sites may use this to record the
7522 user connecting to a Samba share.</para>
7524 <para>See also the <link linkend="UTMPDIRECTORY"><parameter>
7525 utmp directory</parameter></link> parameter.</para>
7527 <para>Default: <command>utmp = no</command></para>
7528 </listitem>
7529 </varlistentry>
7533 <varlistentry>
7534 <term><anchor id="UTMPDIRECTORY">utmp directory(G)</term>
7535 <listitem><para>This parameter is only available if Samba has
7536 been configured and compiled with the option <command>
7537 --with-utmp</command>. It specifies a directory pathname that is
7538 used to store the utmp or utmpx files (depending on the UNIX system) that
7539 record user connections to a Samba server. See also the <link linkend="UTMP">
7540 <parameter>utmp</parameter></link> parameter. By default this is
7541 not set, meaning the system will use whatever utmp file the
7542 native system is set to use (usually
7543 <filename>/var/run/utmp</filename> on Linux).</para>
7545 <para>Default: <emphasis>no utmp directory</emphasis></para>
7546 </listitem>
7547 </varlistentry>
7551 <varlistentry>
7552 <term><anchor id="VALIDCHARS">valid chars (G)</term>
7553 <listitem><para>The option allows you to specify additional
7554 characters that should be considered valid by the server in
7555 filenames. This is particularly useful for national character
7556 sets, such as adding u-umlaut or a-ring.</para>
7558 <para>The option takes a list of characters in either integer
7559 or character form with spaces between them. If you give two
7560 characters with a colon between them then it will be taken as
7561 an lowercase:uppercase pair.</para>
7563 <para>If you have an editor capable of entering the characters
7564 into the config file then it is probably easiest to use this
7565 method. Otherwise you can specify the characters in octal,
7566 decimal or hexadecimal form using the usual C notation.</para>
7568 <para>For example to add the single character 'Z' to the charset
7569 (which is a pointless thing to do as it's already there) you could
7570 do one of the following</para>
7572 <para><programlisting>
7573 valid chars = Z
7574 valid chars = z:Z
7575 valid chars = 0132:0172
7576 </programlisting></para>
7578 <para>The last two examples above actually add two characters,
7579 and alter the uppercase and lowercase mappings appropriately.</para>
7581 <para>Note that you <emphasis>MUST</emphasis> specify this parameter
7582 after the <parameter>client code page</parameter> parameter if you
7583 have both set. If <parameter>client code page</parameter> is set after
7584 the <parameter>valid chars</parameter> parameter the <parameter>valid
7585 chars</parameter> settings will be overwritten.</para>
7587 <para>See also the <link linkend="CLIENTCODEPAGE"><parameter>client
7588 code page</parameter></link> parameter.</para>
7590 <para>Default: <emphasis>Samba defaults to using a reasonable set
7591 of valid characters for English systems</emphasis></para>
7593 <para>Example: <command>valid chars = 0345:0305 0366:0326 0344:0304
7594 </command></para>
7596 <para>The above example allows filenames to have the Swedish
7597 characters in them.</para>
7599 <para><emphasis>NOTE:</emphasis> It is actually quite difficult to
7600 correctly produce a <parameter>valid chars</parameter> line for
7601 a particular system. To automate the process <ulink
7602 url="mailto:tino@augsburg.net">tino@augsburg.net</ulink> has written
7603 a package called <command>validchars</command> which will automatically
7604 produce a complete <parameter>valid chars</parameter> line for
7605 a given client system. Look in the <filename>examples/validchars/
7606 </filename> subdirectory of your Samba source code distribution
7607 for this package.</para>
7608 </listitem>
7609 </varlistentry>
7613 <varlistentry>
7614 <term><anchor id="VALIDUSERS">valid users (S)</term>
7615 <listitem><para>This is a list of users that should be allowed
7616 to login to this service. Names starting with '@', '+' and '&'
7617 are interpreted using the same rules as described in the
7618 <parameter>invalid users</parameter> parameter.</para>
7620 <para>If this is empty (the default) then any user can login.
7621 If a username is in both this list and the <parameter>invalid
7622 users</parameter> list then access is denied for that user.</para>
7624 <para>The current servicename is substituted for <parameter>%S
7625 </parameter>. This is useful in the [homes] section.</para>
7627 <para>See also <link linkend="INVALIDUSERS"><parameter>invalid users
7628 </parameter></link></para>
7630 <para>Default: <emphasis>No valid users list (anyone can login)
7631 </emphasis></para>
7633 <para>Example: <command>valid users = greg, @pcusers</command></para>
7634 </listitem>
7635 </varlistentry>
7640 <varlistentry>
7641 <term><anchor id="VETOFILES">veto files(S)</term>
7642 <listitem><para>This is a list of files and directories that
7643 are neither visible nor accessible. Each entry in the list must
7644 be separated by a '/', which allows spaces to be included
7645 in the entry. '*' and '?' can be used to specify multiple files
7646 or directories as in DOS wildcards.</para>
7648 <para>Each entry must be a unix path, not a DOS path and
7649 must <emphasis>not</emphasis> include the unix directory
7650 separator '/'.</para>
7652 <para>Note that the <parameter>case sensitive</parameter> option
7653 is applicable in vetoing files.</para>
7655 <para>One feature of the veto files parameter that it is important
7656 to be aware of, is that if a directory contains nothing but files
7657 that match the veto files parameter (which means that Windows/DOS
7658 clients cannot ever see them) is deleted, the veto files within
7659 that directory <emphasis>are automatically deleted</emphasis> along
7660 with it, if the user has UNIX permissions to do so.</para>
7662 <para>Setting this parameter will affect the performance
7663 of Samba, as it will be forced to check all files and directories
7664 for a match as they are scanned.</para>
7666 <para>See also <link linkend="HIDEFILES"><parameter>hide files
7667 </parameter></link> and <link linkend="CASESENSITIVE"><parameter>
7668 case sensitive</parameter></link>.</para>
7670 <para>Default: <emphasis>No files or directories are vetoed.
7671 </emphasis></para>
7673 <para>Examples:<programlisting>
7674 ; Veto any files containing the word Security,
7675 ; any ending in .tmp, and any directory containing the
7676 ; word root.
7677 veto files = /*Security*/*.tmp/*root*/
7679 ; Veto the Apple specific files that a NetAtalk server
7680 ; creates.
7681 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
7682 </programlisting></para>
7683 </listitem>
7684 </varlistentry>
7687 <varlistentry>
7688 <term><anchor id="VETOOPLOCKFILES">veto oplock files (S)</term>
7689 <listitem><para>This parameter is only valid when the <link
7690 linkend="OPLOCKS"><parameter>oplocks</parameter></link>
7691 parameter is turned on for a share. It allows the Samba administrator
7692 to selectively turn off the granting of oplocks on selected files that
7693 match a wildcarded list, similar to the wildcarded list used in the
7694 <link linkend="VETOFILES"><parameter>veto files</parameter></link>
7695 parameter.</para>
7697 <para>Default: <emphasis>No files are vetoed for oplock
7698 grants</emphasis></para>
7700 <para>You might want to do this on files that you know will
7701 be heavily contended for by clients. A good example of this
7702 is in the NetBench SMB benchmark program, which causes heavy
7703 client contention for files ending in <filename>.SEM</filename>.
7704 To cause Samba not to grant oplocks on these files you would use
7705 the line (either in the [global] section or in the section for
7706 the particular NetBench share :</para>
7708 <para>Example: <command>veto oplock files = /*;.SEM/
7709 </command></para>
7710 </listitem>
7711 </varlistentry>
7715 <varlistentry>
7716 <term><anchor id="VFSOBJECT">vfs object (S)</term>
7717 <listitem><para>This parameter specifies a shared object file that
7718 is used for Samba VFS I/O operations. By default, normal
7719 disk I/O operations are used but these can be overloaded
7720 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
7721 must be enabled at compile time with --with-vfs.</para>
7723 <para>Default : <emphasis>no value</emphasis></para>
7724 </listitem>
7725 </varlistentry>
7730 <varlistentry>
7731 <term><anchor id="VFSOPTIONS">vfs options (S)</term>
7732 <listitem><para>This parameter allows parameters to be passed
7733 to the vfs layer at initialisation time. The Samba VFS layer
7734 is new to Samba 2.2 and must be enabled at compile time
7735 with --with-vfs. See also <link linkend="VFSOBJECT"><parameter>
7736 vfs object</parameter></link>.</para>
7738 <para>Default : <emphasis>no value</emphasis></para>
7739 </listitem>
7740 </varlistentry>
7744 <varlistentry>
7745 <term><anchor id="VOLUME">volume (S)</term>
7746 <listitem><para> This allows you to override the volume label
7747 returned for a share. Useful for CDROMs with installation programs
7748 that insist on a particular volume label.</para>
7750 <para>Default: <emphasis>the name of the share</emphasis></para>
7751 </listitem>
7752 </varlistentry>
7756 <varlistentry>
7757 <term><anchor id="WIDELINKS">wide links (S)</term>
7758 <listitem><para>This parameter controls whether or not links
7759 in the UNIX file system may be followed by the server. Links
7760 that point to areas within the directory tree exported by the
7761 server are always allowed; this parameter controls access only
7762 to areas that are outside the directory tree being exported.</para>
7764 <para>Note that setting this parameter can have a negative
7765 effect on your server performance due to the extra system calls
7766 that Samba has to do in order to perform the link checks.</para>
7768 <para>Default: <command>wide links = yes</command></para>
7769 </listitem>
7770 </varlistentry>
7775 <varlistentry>
7776 <term><anchor id="WINBINDCACHETIME">winbind cache time</term>
7777 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7778 available in Samba 3.0.</para>
7780 <para>This parameter specifies the number of seconds the
7781 <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon will cache
7782 user and group information before querying a Windows NT server
7783 again.</para>
7785 <para>Default: <command>winbind cache type = 15</command></para>
7786 </listitem>
7787 </varlistentry>
7792 <varlistentry>
7793 <term><anchor id="WINBINDGID">winbind gid</term>
7794 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7795 available in Samba 3.0.</para>
7797 <para>The winbind gid parameter specifies the range of group
7798 ids that are allocated by the <ulink url="winbindd.8.html">
7799 winbindd(8)</ulink> daemon. This range of group ids should have no
7800 existing local or nis groups within it as strange conflicts can
7801 occur otherwise.</para>
7803 <para>Default: <command>winbind gid = &lt;empty string&gt;
7804 </command></para>
7806 <para>Example: <command>winbind gid = 10000-20000</command></para>
7807 </listitem>
7808 </varlistentry>
7811 <varlistentry>
7812 <term><anchor id="WINBINDSEPARATOR">winbind separator</term>
7813 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7814 available in Samba 3.0.</para>
7816 <para>This parameter allows an admin to define the character
7817 used when listing a username of the form of <replaceable>DOMAIN
7818 </replaceable>\<replaceable>user</replaceable>. This parameter
7819 is only applicable when using the <filename>pam_winbind.so</filename>
7820 and <filename>nss_winbind.so</filename> modules for UNIX services.
7821 </para>
7823 <para>Example: <command>winbind separator = \</command></para>
7824 <para>Example: <command>winbind separator = +</command></para>
7825 </listitem>
7826 </varlistentry>
7831 <varlistentry>
7832 <term><anchor id="WINBINDUID">winbind uid</term>
7833 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7834 available in Samba 3.0.</para>
7836 <para>The winbind gid parameter specifies the range of group
7837 ids that are allocated by the <ulink url="winbindd.8.html">
7838 winbindd(8)</ulink> daemon. This range of ids should have no
7839 existing local or nis users within it as strange conflicts can
7840 occur otherwise.</para>
7842 <para>Default: <command>winbind uid = &lt;empty string&gt;
7843 </command></para>
7845 <para>Example: <command>winbind uid = 10000-20000</command></para>
7846 </listitem>
7847 </varlistentry>
7853 <varlistentry>
7854 <term><anchor id="WINSHOOK">wins hook (G)</term>
7855 <listitem><para>When Samba is running as a WINS server this
7856 allows you to call an external program for all changes to the
7857 WINS database. The primary use for this option is to allow the
7858 dynamic update of external name resolution databases such as
7859 dynamic DNS.</para>
7861 <para>The wins hook parameter specifies the name of a script
7862 or executable that will be called as follows:</para>
7864 <para><command>wins_hook operation name nametype ttl IP_list
7865 </command></para>
7867 <itemizedlist>
7868 <listitem><para>The first argument is the operation and is one
7869 of "add", "delete", or "refresh". In most cases the operation can
7870 be ignored as the rest of the parameters provide sufficient
7871 information. Note that "refresh" may sometimes be called when the
7872 name has not previously been added, in that case it should be treated
7873 as an add.</para></listitem>
7875 <listitem><para>The second argument is the netbios name. If the
7876 name is not a legal name then the wins hook is not called.
7877 Legal names contain only letters, digits, hyphens, underscores
7878 and periods.</para></listitem>
7880 <listitem><para>The third argument is the netbios name
7881 type as a 2 digit hexadecimal number. </para></listitem>
7883 <listitem><para>The fourth argument is the TTL (time to live)
7884 for the name in seconds.</para></listitem>
7886 <listitem><para>The fifth and subsequent arguments are the IP
7887 addresses currently registered for that name. If this list is
7888 empty then the name should be deleted.</para></listitem>
7889 </itemizedlist>
7891 <para>An example script that calls the BIND dynamic DNS update
7892 program <command>nsupdate</command> is provided in the examples
7893 directory of the Samba source code. </para>
7894 </listitem>
7895 </varlistentry>
7901 <varlistentry>
7902 <term><anchor id="WINSPROXY">wins proxy (G)</term>
7903 <listitem><para>This is a boolean that controls if <ulink
7904 url="nmbd.8.html">nmbd(8)</ulink> will respond to broadcast name
7905 queries on behalf of other hosts. You may need to set this
7906 to <constant>yes</constant> for some older clients.</para>
7908 <para>Default: <command>wins proxy = no</command></para>
7909 </listitem>
7910 </varlistentry>
7915 <varlistentry>
7916 <term><anchor id="WINSSERVER">wins server (G)</term>
7917 <listitem><para>This specifies the IP address (or DNS name: IP
7918 address for preference) of the WINS server that <ulink url="nmbd.8.html">
7919 nmbd(8)</ulink> should register with. If you have a WINS server on
7920 your network then you should set this to the WINS server's IP.</para>
7922 <para>You should point this at your WINS server if you have a
7923 multi-subnetted network.</para>
7925 <para><emphasis>NOTE</emphasis>. You need to set up Samba to point
7926 to a WINS server if you have multiple subnets and wish cross-subnet
7927 browsing to work correctly.</para>
7929 <para>See the documentation file <filename>BROWSING.txt</filename>
7930 in the docs/ directory of your Samba source distribution.</para>
7932 <para>Default: <emphasis>not enabled</emphasis></para>
7933 <para>Example: <command>wins server = 192.9.200.1</command></para>
7934 </listitem>
7935 </varlistentry>
7939 <varlistentry>
7940 <term><anchor id="WINSSUPPORT">wins support (G)</term>
7941 <listitem><para>This boolean controls if the <ulink url="nmbd.8.html">
7942 nmbd(8)</ulink> process in Samba will act as a WINS server. You should
7943 not set this to true unless you have a multi-subnetted network and
7944 you wish a particular <command>nmbd</command> to be your WINS server.
7945 Note that you should <emphasis>NEVER</emphasis> set this to true
7946 on more than one machine in your network.</para>
7948 <para>Default: <command>wins support = no</command></para>
7949 </listitem>
7950 </varlistentry>
7954 <varlistentry>
7955 <term><anchor id="WORKGROUP">workgroup (G)</term>
7956 <listitem><para>This controls what workgroup your server will
7957 appear to be in when queried by clients. Note that this parameter
7958 also controls the Domain name used with the <link
7959 linkend="SECURITYEQUALSDOMAIN"><command>security=domain</command></link>
7960 setting.</para>
7962 <para>Default: <emphasis>set at compile time to WORKGROUP</emphasis></para>
7963 <para>Example: <command>workgroup = MYGROUP</command></para>
7964 </listitem>
7965 </varlistentry>
7970 <varlistentry>
7971 <term><anchor id="WRITABLE">writable (S)</term>
7972 <listitem><para>Synonym for <link linkend="WRITEABLE"><parameter>
7973 writeable</parameter></link> for people who can't spell :-).</para>
7974 </listitem>
7975 </varlistentry>
7979 <varlistentry>
7980 <term><anchor id="WRITECACHESIZE">write cache size (S)</term>
7981 <listitem><para>If this integer parameter is set to non-zero value,
7982 Samba will create an in-memory cache for each oplocked file
7983 (it does <emphasis>not</emphasis> do this for
7984 non-oplocked files). All writes that the client does not request
7985 to be flushed directly to disk will be stored in this cache if possible.
7986 The cache is flushed onto disk when a write comes in whose offset
7987 would not fit into the cache or when the file is closed by the client.
7988 Reads for the file are also served from this cache if the data is stored
7989 within it.</para>
7991 <para>This cache allows Samba to batch client writes into a more
7992 efficient write size for RAID disks (ie. writes may be tuned to
7993 be the RAID stripe size) and can improve performance on systems
7994 where the disk subsystem is a bottleneck but there is free
7995 memory for userspace programs.</para>
7997 <para>The integer parameter specifies the size of this cache
7998 (per oplocked file) in bytes.</para>
8000 <para>Default: <command>write cache size = 0</command></para>
8001 <para>Example: <command>write cache size = 262144</command></para>
8003 <para>for a 256k cache size per file.</para>
8004 </listitem>
8005 </varlistentry>
8011 <varlistentry>
8012 <term><anchor id="WRITELIST">write list (S)</term>
8013 <listitem><para>This is a list of users that are given read-write
8014 access to a service. If the connecting user is in this list then
8015 they will be given write access, no matter what the <link
8016 linkend="WRITEABLE"><parameter>writeable</parameter></link>
8017 option is set to. The list can include group names using the
8018 @group syntax.</para>
8020 <para>Note that if a user is in both the read list and the
8021 write list then they will be given write access.</para>
8023 <para>See also the <link linkend="READLIST"><parameter>read list
8024 </parameter></link> option.</para>
8026 <para>Default: <command>write list = &lt;empty string&gt;
8027 </command></para>
8029 <para>Example: <command>write list = admin, root, @staff
8030 </command></para>
8031 </listitem>
8032 </varlistentry>
8038 <varlistentry>
8039 <term><anchor id="WRITEOK">write ok (S)</term>
8040 <listitem><para>Synonym for <link linkend="WRITEABLE"><parameter>
8041 writeable</parameter></link>.</para>
8042 </listitem>
8043 </varlistentry>
8047 <varlistentry>
8048 <term><anchor id="WRITERAW">write raw (G)</term>
8049 <listitem><para>This parameter controls whether or not the server
8050 will support raw writes SMB's when transferring data from clients.
8051 You should never need to change this parameter.</para>
8053 <para>Default: <command>write raw = yes</command></para>
8054 </listitem>
8055 </varlistentry>
8059 <varlistentry>
8060 <term><anchor id="WRITEABLE">writeable (S)</term>
8061 <listitem><para>An inverted synonym is <link linkend="READONLY">
8062 <parameter>read only</parameter></link>.</para>
8064 <para>If this parameter is <constant>no</constant>, then users
8065 of a service may not create or modify files in the service's
8066 directory.</para>
8068 <para>Note that a printable service (<command>printable = yes</command>)
8069 will <emphasis>ALWAYS</emphasis> allow writing to the directory
8070 (user privileges permitting), but only via spooling operations.</para>
8072 <para>Default: <command>writeable = no</command></para>
8073 </listitem>
8074 </varlistentry>
8077 </variablelist>
8079 </refsect1>
8081 <refsect1>
8082 <title>WARNINGS</title>
8084 <para>Although the configuration file permits service names
8085 to contain spaces, your client software may not. Spaces will
8086 be ignored in comparisons anyway, so it shouldn't be a
8087 problem - but be aware of the possibility.</para>
8089 <para>On a similar note, many clients - especially DOS clients -
8090 limit service names to eight characters. <ulink url="smbd.8.html">smbd(8)
8091 </ulink> has no such limitation, but attempts to connect from such
8092 clients will fail if they truncate the service names. For this reason
8093 you should probably keep your service names down to eight characters
8094 in length.</para>
8096 <para>Use of the [homes] and [printers] special sections make life
8097 for an administrator easy, but the various combinations of default
8098 attributes can be tricky. Take extreme care when designing these
8099 sections. In particular, ensure that the permissions on spool
8100 directories are correct.</para>
8101 </refsect1>
8103 <refsect1>
8104 <title>VERSION</title>
8106 <para>This man page is correct for version 2.2 of
8107 the Samba suite.</para>
8108 </refsect1>
8110 <refsect1>
8111 <title>SEE ALSO</title>
8112 <para><ulink url="samba.7.html">samba(7)</ulink>,
8113 <ulink url="smbpasswd.8.html"><command>smbpasswd(8)</command></ulink>,
8114 <ulink url="swat.8.html"><command>swat(8)</command></ulink>,
8115 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>,
8116 <ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>,
8117 <ulink url="smbclient.1.html"><command>smbclient(1)</command></ulink>,
8118 <ulink url="nmblookup.1.html"><command>nmblookup(1)</command></ulink>,
8119 <ulink url="testparm.1.html"><command>testparm(1)</command></ulink>,
8120 <ulink url="testprns.1.html"><command>testprns(1)</command></ulink>
8121 </para>
8122 </refsect1>
8124 <refsect1>
8125 <title>AUTHOR</title>
8127 <para>The original Samba software and related utilities
8128 were created by Andrew Tridgell. Samba is now developed
8129 by the Samba Team as an Open Source project similar
8130 to the way the Linux kernel is developed.</para>
8132 <para>The original Samba man pages were written by Karl Auer.
8133 The man page sources were converted to YODL format (another
8134 excellent piece of Open Source software, available at
8135 <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
8136 ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
8137 release by Jeremy Allison. The conversion to DocBook for
8138 Samba 2.2 was done by Gerald Carter</para>
8139 </refsect1>
8141 </refentry>