filled in 'change share command' parameter in smb.conf. Also regenerated
[Samba.git] / docs / docbook / manpages / smb.conf.5.sgml
blob46bf91e3f8232efe7a467b637fc05b3f6cf30f68
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="DOMAINADMINUSERS"><parameter>domain admin users</parameter></link></para></listitem>
620 <listitem><para><link linkend="DOMAINGROUPS"><parameter>domain groups</parameter></link></para></listitem>
621 <listitem><para><link linkend="DOMAINGUESTGROUP"><parameter>domain guest group</parameter></link></para></listitem>
622 <listitem><para><link linkend="DOMAINGUESTUSERS"><parameter>domain guest users</parameter></link></para></listitem>
623 <listitem><para><link linkend="DOMAINLOGONS"><parameter>domain logons</parameter></link></para></listitem>
624 <listitem><para><link linkend="DOMAINMASTER"><parameter>domain master</parameter></link></para></listitem>
625 <listitem><para><link linkend="ENCRYPTPASSWORDS"><parameter>encrypt passwords</parameter></link></para></listitem>
626 <listitem><para><link linkend="ENHANCEDBROWSING"><parameter>enhanced browsing</parameter></link></para></listitem>
627 <listitem><para><link linkend="ENUMPORTSCOMMAND"><parameter>enumports command</parameter></link></para></listitem>
628 <listitem><para><link linkend="GETWDCACHE"><parameter>getwd cache</parameter></link></para></listitem>
629 <listitem><para><link linkend="HIDELOCALUSERS"><parameter>hide local users</parameter></link></para></listitem>
630 <listitem><para><link linkend="HOMEDIRMAP"><parameter>homedir map</parameter></link></para></listitem>
631 <listitem><para><link linkend="HOSTMSDFS"><parameter>host msdfs</parameter></link></para></listitem>
632 <listitem><para><link linkend="HOSTSEQUIV"><parameter>hosts equiv</parameter></link></para></listitem>
633 <listitem><para><link linkend="INTERFACES"><parameter>interfaces</parameter></link></para></listitem>
634 <listitem><para><link linkend="KEEPALIVE"><parameter>keepalive</parameter></link></para></listitem>
635 <listitem><para><link linkend="KERNELOPLOCKS"><parameter>kernel oplocks</parameter></link></para></listitem>
636 <listitem><para><link linkend="LANMANAUTH"><parameter>lanman auth</parameter></link></para></listitem>
637 <listitem><para><link linkend="LMANNOUNCE"><parameter>lm announce</parameter></link></para></listitem>
638 <listitem><para><link linkend="LMINTERVAL"><parameter>lm interval</parameter></link></para></listitem>
639 <listitem><para><link linkend="LOADPRINTERS"><parameter>load printers</parameter></link></para></listitem>
640 <listitem><para><link linkend="LOCALMASTER"><parameter>local master</parameter></link></para></listitem>
641 <listitem><para><link linkend="LOCKDIR"><parameter>lock dir</parameter></link></para></listitem>
642 <listitem><para><link linkend="LOCKDIRECTORY"><parameter>lock directory</parameter></link></para></listitem>
643 <listitem><para><link linkend="LOGFILE"><parameter>log file</parameter></link></para></listitem>
644 <listitem><para><link linkend="LOGLEVEL"><parameter>log level</parameter></link></para></listitem>
645 <listitem><para><link linkend="LOGONDRIVE"><parameter>logon drive</parameter></link></para></listitem>
646 <listitem><para><link linkend="LOGONHOME"><parameter>logon home</parameter></link></para></listitem>
647 <listitem><para><link linkend="LOGONPATH"><parameter>logon path</parameter></link></para></listitem>
648 <listitem><para><link linkend="LOGONSCRIPT"><parameter>logon script</parameter></link></para></listitem>
649 <listitem><para><link linkend="LPQCACHETIME"><parameter>lpq cache time</parameter></link></para></listitem>
650 <listitem><para><link linkend="MACHINEPASSWORDTIMEOUT"><parameter>machine password timeout</parameter></link></para></listitem>
651 <listitem><para><link linkend="MANGLEDSTACK"><parameter>mangled stack</parameter></link></para></listitem>
652 <listitem><para><link linkend="MAPTOGUEST"><parameter>map to guest</parameter></link></para></listitem>
653 <listitem><para><link linkend="MAXDISKSIZE"><parameter>max disk size</parameter></link></para></listitem>
654 <listitem><para><link linkend="MAXLOGSIZE"><parameter>max log size</parameter></link></para></listitem>
655 <listitem><para><link linkend="MAXMUX"><parameter>max mux</parameter></link></para></listitem>
656 <listitem><para><link linkend="MAXOPENFILES"><parameter>max open files</parameter></link></para></listitem>
657 <listitem><para><link linkend="MAXPROTOCOL"><parameter>max protocol</parameter></link></para></listitem>
658 <listitem><para><link linkend="MAXSMBDPROCESSES"><parameter>max smbd processes</parameter></link></para></listitem>
659 <listitem><para><link linkend="MAXTTL"><parameter>max ttl</parameter></link></para></listitem>
660 <listitem><para><link linkend="MAXWINSTTL"><parameter>max wins ttl</parameter></link></para></listitem>
661 <listitem><para><link linkend="MAXXMIT"><parameter>max xmit</parameter></link></para></listitem>
662 <listitem><para><link linkend="MESSAGECOMMAND"><parameter>message command</parameter></link></para></listitem>
663 <listitem><para><link linkend="MINPASSWDLENGTH"><parameter>min passwd length</parameter></link></para></listitem>
664 <listitem><para><link linkend="MINPASSWORDLENGTH"><parameter>min password length</parameter></link></para></listitem>
665 <listitem><para><link linkend="MINPROTOCOL"><parameter>min protocol</parameter></link></para></listitem>
666 <listitem><para><link linkend="MINWINSTTL"><parameter>min wins ttl</parameter></link></para></listitem>
667 <listitem><para><link linkend="NAMERESOLVEORDER"><parameter>name resolve order</parameter></link></para></listitem>
668 <listitem><para><link linkend="NETBIOSALIASES"><parameter>netbios aliases</parameter></link></para></listitem>
669 <listitem><para><link linkend="NETBIOSNAME"><parameter>netbios name</parameter></link></para></listitem>
670 <listitem><para><link linkend="NETBIOSSCOPE"><parameter>netbios scope</parameter></link></para></listitem>
671 <listitem><para><link linkend="NISHOMEDIR"><parameter>nis homedir</parameter></link></para></listitem>
672 <listitem><para><link linkend="NTACLSUPPORT"><parameter>nt acl support</parameter></link></para></listitem>
673 <listitem><para><link linkend="NTPIPESUPPORT"><parameter>nt pipe support</parameter></link></para></listitem>
674 <listitem><para><link linkend="NTSMBSUPPORT"><parameter>nt smb support</parameter></link></para></listitem>
675 <listitem><para><link linkend="NULLPASSWORDS"><parameter>null passwords</parameter></link></para></listitem>
676 <listitem><para><link linkend="OBEYPAMRESTRICTIONS"><parameter>obey pam restrictions</parameter></link></para></listitem>
677 <listitem><para><link linkend="OPLOCKBREAKWAITTIME"><parameter>oplock break wait time</parameter></link></para></listitem>
678 <listitem><para><link linkend="OSLEVEL"><parameter>os level</parameter></link></para></listitem>
679 <listitem><para><link linkend="OS2DRIVERMAP"><parameter>os2 driver map</parameter></link></para></listitem>
680 <listitem><para><link linkend="PAMPASSWORDCHANGE"><parameter>pam password change</parameter></link></para></listitem>
681 <listitem><para><link linkend="PANICACTION"><parameter>panic action</parameter></link></para></listitem>
682 <listitem><para><link linkend="PASSWDCHAT"><parameter>passwd chat</parameter></link></para></listitem>
683 <listitem><para><link linkend="PASSWDCHATDEBUG"><parameter>passwd chat debug</parameter></link></para></listitem>
684 <listitem><para><link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter></link></para></listitem>
685 <listitem><para><link linkend="PASSWORDLEVEL"><parameter>password level</parameter></link></para></listitem>
686 <listitem><para><link linkend="PASSWORDSERVER"><parameter>password server</parameter></link></para></listitem>
687 <listitem><para><link linkend="PREFEREDMASTER"><parameter>prefered master</parameter></link></para></listitem>
688 <listitem><para><link linkend="PREFERREDMASTER"><parameter>preferred master</parameter></link></para></listitem>
689 <listitem><para><link linkend="PRELOAD"><parameter>preload</parameter></link></para></listitem>
690 <listitem><para><link linkend="PRINTCAP"><parameter>printcap</parameter></link></para></listitem>
691 <listitem><para><link linkend="PRINTCAPNAME"><parameter>printcap name</parameter></link></para></listitem>
692 <listitem><para><link linkend="PRINTERDRIVERFILE"><parameter>printer driver file</parameter></link></para></listitem>
693 <listitem><para><link linkend="PROTOCOL"><parameter>protocol</parameter></link></para></listitem>
694 <listitem><para><link linkend="READBMPX"><parameter>read bmpx</parameter></link></para></listitem>
695 <listitem><para><link linkend="READRAW"><parameter>read raw</parameter></link></para></listitem>
696 <listitem><para><link linkend="READSIZE"><parameter>read size</parameter></link></para></listitem>
697 <listitem><para><link linkend="REMOTEANNOUNCE"><parameter>remote announce</parameter></link></para></listitem>
698 <listitem><para><link linkend="REMOTEBROWSESYNC"><parameter>remote browse sync</parameter></link></para></listitem>
699 <listitem><para><link linkend="RESTRICTANONYMOUS"><parameter>restrict anonymous</parameter></link></para></listitem>
700 <listitem><para><link linkend="ROOT"><parameter>root</parameter></link></para></listitem>
701 <listitem><para><link linkend="ROOTDIR"><parameter>root dir</parameter></link></para></listitem>
702 <listitem><para><link linkend="ROOTDIRECTORY"><parameter>root directory</parameter></link></para></listitem>
703 <listitem><para><link linkend="SECURITY"><parameter>security</parameter></link></para></listitem>
704 <listitem><para><link linkend="SERVERSTRING"><parameter>server string</parameter></link></para></listitem>
705 <listitem><para><link linkend="SHOWADDPRINTERWIZARD"><parameter>show add printer wizard</parameter></link></para></listitem>
706 <listitem><para><link linkend="SMBPASSWDFILE"><parameter>smb passwd file</parameter></link></para></listitem>
707 <listitem><para><link linkend="SOCKETADDRESS"><parameter>socket address</parameter></link></para></listitem>
708 <listitem><para><link linkend="SOCKETOPTIONS"><parameter>socket options</parameter></link></para></listitem>
709 <listitem><para><link linkend="SOURCEENVIRONMENT"><parameter>source environment</parameter></link></para></listitem>
710 <listitem><para><link linkend="SSL"><parameter>ssl</parameter></link></para></listitem>
711 <listitem><para><link linkend="SSLCACERTDIR"><parameter>ssl CA certDir</parameter></link></para></listitem>
712 <listitem><para><link linkend="SSLCACERTFILE"><parameter>ssl CA certFile</parameter></link></para></listitem>
713 <listitem><para><link linkend="SSLCIPHERS"><parameter>ssl ciphers</parameter></link></para></listitem>
714 <listitem><para><link linkend="SSLCLIENTCERT"><parameter>ssl client cert</parameter></link></para></listitem>
715 <listitem><para><link linkend="SSLCLIENTKEY"><parameter>ssl client key</parameter></link></para></listitem>
716 <listitem><para><link linkend="SSLCOMPATIBILITY"><parameter>ssl compatibility</parameter></link></para></listitem>
717 <listitem><para><link linkend="SSLHOSTS"><parameter>ssl hosts</parameter></link></para></listitem>
718 <listitem><para><link linkend="SSLHOSTSRESIGN"><parameter>ssl hosts resign</parameter></link></para></listitem>
719 <listitem><para><link linkend="SSLREQUIRECLIENTCERT"><parameter>ssl require clientcert</parameter></link></para></listitem>
720 <listitem><para><link linkend="SSLREQUIRESERVERCERT"><parameter>ssl require servercert</parameter></link></para></listitem>
721 <listitem><para><link linkend="SSLSERVERCERT"><parameter>ssl server cert</parameter></link></para></listitem>
722 <listitem><para><link linkend="SSLSERVERKEY"><parameter>ssl server key</parameter></link></para></listitem>
723 <listitem><para><link linkend="SSLVERSION"><parameter>ssl version</parameter></link></para></listitem>
724 <listitem><para><link linkend="STATCACHE"><parameter>stat cache</parameter></link></para></listitem>
725 <listitem><para><link linkend="STATCACHESIZE"><parameter>stat cache size</parameter></link></para></listitem>
726 <listitem><para><link linkend="STRIPDOT"><parameter>strip dot</parameter></link></para></listitem>
727 <listitem><para><link linkend="SYSLOG"><parameter>syslog</parameter></link></para></listitem>
728 <listitem><para><link linkend="SYSLOGONLY"><parameter>syslog only</parameter></link></para></listitem>
729 <listitem><para><link linkend="TEMPLATEHOMEDIR"><parameter>template homedir</parameter></link></para></listitem>
730 <listitem><para><link linkend="TEMPLATESHELL"><parameter>template shell</parameter></link></para></listitem>
731 <listitem><para><link linkend="TIMEOFFSET"><parameter>time offset</parameter></link></para></listitem>
732 <listitem><para><link linkend="TIMESERVER"><parameter>time server</parameter></link></para></listitem>
733 <listitem><para><link linkend="TIMESTAMPLOGS"><parameter>timestamp logs</parameter></link></para></listitem>
734 <listitem><para><link linkend="TOTALPRINTJOBS"><parameter>total print jobs</parameter></link></para></listitem>
735 <listitem><para><link linkend="UNIXPASSWORDSYNC"><parameter>unix password sync</parameter></link></para></listitem>
736 <listitem><para><link linkend="UPDATEENCRYPTED"><parameter>update encrypted</parameter></link></para></listitem>
737 <listitem><para><link linkend="USERHOSTS"><parameter>use rhosts</parameter></link></para></listitem>
738 <listitem><para><link linkend="USERNAMELEVEL"><parameter>username level</parameter></link></para></listitem>
739 <listitem><para><link linkend="USERNAMEMAP"><parameter>username map</parameter></link></para></listitem>
740 <listitem><para><link linkend="UTMPDIRECTORY"><parameter>utmp directory</parameter></link></para></listitem>
741 <listitem><para><link linkend="VALIDCHARS"><parameter>valid chars</parameter></link></para></listitem>
742 <listitem><para><link linkend="WINBINDCACHETIME"><parameter>winbind cache time</parameter></link></para></listitem>
743 <listitem><para><link linkend="WINBINDGID"><parameter>winbind gid</parameter></link></para></listitem>
744 <listitem><para><link linkend="WINBINDSEPARATOR"><parameter>winbind separator</parameter></link></para></listitem>
745 <listitem><para><link linkend="WINBINDUID"><parameter>winbind uid</parameter></link></para></listitem>
746 <listitem><para><link linkend="WINSHOOK"><parameter>wins hook</parameter></link></para></listitem>
747 <listitem><para><link linkend="WINSPROXY"><parameter>wins proxy</parameter></link></para></listitem>
748 <listitem><para><link linkend="WINSSERVER"><parameter>wins server</parameter></link></para></listitem>
749 <listitem><para><link linkend="WINSSUPPORT"><parameter>wins support</parameter></link></para></listitem>
750 <listitem><para><link linkend="WORKGROUP"><parameter>workgroup</parameter></link></para></listitem>
751 <listitem><para><link linkend="WRITERAW"><parameter>write raw</parameter></link></para></listitem>
752 </itemizedlist>
754 </refsect1>
756 <refsect1>
757 <title>COMPLETE LIST OF SERVICE PARAMETERS</title>
759 <para>Here is a list of all service parameters. See the section on
760 each parameter for details. Note that some are synonyms.</para>
762 <itemizedlist>
763 <listitem><para><link linkend="ADMINUSERS"><parameter>admin users</parameter></link></para></listitem>
764 <listitem><para><link linkend="ALLOWHOSTS"><parameter>allow hosts</parameter></link></para></listitem>
765 <listitem><para><link linkend="AVAILABLE"><parameter>available</parameter></link></para></listitem>
766 <listitem><para><link linkend="BLOCKINGLOCKS"><parameter>blocking locks</parameter></link></para></listitem>
767 <listitem><para><link linkend="BROWSABLE"><parameter>browsable</parameter></link></para></listitem>
768 <listitem><para><link linkend="BROWSEABLE"><parameter>browseable</parameter></link></para></listitem>
769 <listitem><para><link linkend="CASESENSITIVE"><parameter>case sensitive</parameter></link></para></listitem>
770 <listitem><para><link linkend="CASESIGNAMES"><parameter>casesignames</parameter></link></para></listitem>
771 <listitem><para><link linkend="COMMENT"><parameter>comment</parameter></link></para></listitem>
772 <listitem><para><link linkend="COPY"><parameter>copy</parameter></link></para></listitem>
773 <listitem><para><link linkend="CREATEMASK"><parameter>create mask</parameter></link></para></listitem>
774 <listitem><para><link linkend="CREATEMODE"><parameter>create mode</parameter></link></para></listitem>
775 <listitem><para><link linkend="DEFAULTCASE"><parameter>default case</parameter></link></para></listitem>
776 <listitem><para><link linkend="DELETEREADONLY"><parameter>delete readonly</parameter></link></para></listitem>
777 <listitem><para><link linkend="DELETEVETOFILES"><parameter>delete veto files</parameter></link></para></listitem>
778 <listitem><para><link linkend="DENYHOSTS"><parameter>deny hosts</parameter></link></para></listitem>
779 <listitem><para><link linkend="DIRECTORY"><parameter>directory</parameter></link></para></listitem>
780 <listitem><para><link linkend="DIRECTORYMASK"><parameter>directory mask</parameter></link></para></listitem>
781 <listitem><para><link linkend="DIRECTORYMODE"><parameter>directory mode</parameter></link></para></listitem>
782 <listitem><para><link linkend="DIRECTORYSECURITYMASK"><parameter>directory security mask</parameter></link></para></listitem>
783 <listitem><para><link linkend="DONTDESCEND"><parameter>dont descend</parameter></link></para></listitem>
784 <listitem><para><link linkend="DOSFILEMODE"><parameter>dos filemode</parameter></link></para></listitem>
785 <listitem><para><link linkend="DOSFILETIMERESOLUTION"><parameter>dos filetime resolution</parameter></link></para></listitem>
786 <listitem><para><link linkend="DOSFILETIMES"><parameter>dos filetimes</parameter></link></para></listitem>
787 <listitem><para><link linkend="EXEC"><parameter>exec</parameter></link></para></listitem>
788 <listitem><para><link linkend="FAKEDIRECTORYCREATETIMES"><parameter>fake directory create times</parameter></link></para></listitem>
789 <listitem><para><link linkend="FAKEOPLOCKS"><parameter>fake oplocks</parameter></link></para></listitem>
790 <listitem><para><link linkend="FOLLOWSYMLINKS"><parameter>follow symlinks</parameter></link></para></listitem>
791 <listitem><para><link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link></para></listitem>
792 <listitem><para><link linkend="FORCEDIRECTORYMODE"><parameter>force directory mode</parameter></link></para></listitem>
793 <listitem><para><link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>force directory security mode</parameter></link></para></listitem>
794 <listitem><para><link linkend="FORCEGROUP"><parameter>force group</parameter></link></para></listitem>
795 <listitem><para><link linkend="FORCESECURITYMODE"><parameter>force security mode</parameter></link></para></listitem>
796 <listitem><para><link linkend="FORCEUSER"><parameter>force user</parameter></link></para></listitem>
797 <listitem><para><link linkend="FSTYPE"><parameter>fstype</parameter></link></para></listitem>
798 <listitem><para><link linkend="GROUP"><parameter>group</parameter></link></para></listitem>
799 <listitem><para><link linkend="GUESTACCOUNT"><parameter>guest account</parameter></link></para></listitem>
800 <listitem><para><link linkend="GUESTOK"><parameter>guest ok</parameter></link></para></listitem>
801 <listitem><para><link linkend="GUESTONLY"><parameter>guest only</parameter></link></para></listitem>
802 <listitem><para><link linkend="HIDEDOTFILES"><parameter>hide dot files</parameter></link></para></listitem>
803 <listitem><para><link linkend="HIDEFILES"><parameter>hide files</parameter></link></para></listitem>
804 <listitem><para><link linkend="HOSTSALLOW"><parameter>hosts allow</parameter></link></para></listitem>
805 <listitem><para><link linkend="HOSTSDENY"><parameter>hosts deny</parameter></link></para></listitem>
806 <listitem><para><link linkend="INCLUDE"><parameter>include</parameter></link></para></listitem>
807 <listitem><para><link linkend="INHERITPERMISSIONS"><parameter>inherit permissions</parameter></link></para></listitem>
808 <listitem><para><link linkend="INVALIDUSERS"><parameter>invalid users</parameter></link></para></listitem>
809 <listitem><para><link linkend="LEVEL2OPLOCKS"><parameter>level2 oplocks</parameter></link></para></listitem>
810 <listitem><para><link linkend="LOCKING"><parameter>locking</parameter></link></para></listitem>
811 <listitem><para><link linkend="LPPAUSECOMMAND"><parameter>lppause command</parameter></link></para></listitem>
812 <listitem><para><link linkend="LPQCOMMAND"><parameter>lpq command</parameter></link></para></listitem>
813 <listitem><para><link linkend="LPRESUMECOMMAND"><parameter>lpresume command</parameter></link></para></listitem>
814 <listitem><para><link linkend="LPRMCOMMAND"><parameter>lprm command</parameter></link></para></listitem>
815 <listitem><para><link linkend="MAGICOUTPUT"><parameter>magic output</parameter></link></para></listitem>
816 <listitem><para><link linkend="MAGICSCRIPT"><parameter>magic script</parameter></link></para></listitem>
817 <listitem><para><link linkend="MANGLECASE"><parameter>mangle case</parameter></link></para></listitem>
818 <listitem><para><link linkend="MANGLEDMAP"><parameter>mangled map</parameter></link></para></listitem>
819 <listitem><para><link linkend="MANGLEDNAMES"><parameter>mangled names</parameter></link></para></listitem>
820 <listitem><para><link linkend="MANGLINGCHAR"><parameter>mangling char</parameter></link></para></listitem>
821 <listitem><para><link linkend="MAPARCHIVE"><parameter>map archive</parameter></link></para></listitem>
822 <listitem><para><link linkend="MAPHIDDEN"><parameter>map hidden</parameter></link></para></listitem>
823 <listitem><para><link linkend="MAPSYSTEM"><parameter>map system</parameter></link></para></listitem>
824 <listitem><para><link linkend="MAXCONNECTIONS"><parameter>max connections</parameter></link></para></listitem>
825 <listitem><para><link linkend="MAXPRINTJOBS"><parameter>max print jobs</parameter></link></para></listitem>
826 <listitem><para><link linkend="MINPRINTSPACE"><parameter>min print space</parameter></link></para></listitem>
827 <listitem><para><link linkend="MSDFSROOT"><parameter>msdfs root</parameter></link></para></listitem>
828 <listitem><para><link linkend="ONLYGUEST"><parameter>only guest</parameter></link></para></listitem>
829 <listitem><para><link linkend="ONLYUSER"><parameter>only user</parameter></link></para></listitem>
830 <listitem><para><link linkend="OPLOCKCONTENTIONLIMIT"><parameter>oplock contention limit</parameter></link></para></listitem>
831 <listitem><para><link linkend="OPLOCKS"><parameter>oplocks</parameter></link></para></listitem>
832 <listitem><para><link linkend="PATH"><parameter>path</parameter></link></para></listitem>
833 <listitem><para><link linkend="POSIXLOCKING"><parameter>posix locking</parameter></link></para></listitem>
834 <listitem><para><link linkend="POSTEXEC"><parameter>postexec</parameter></link></para></listitem>
835 <listitem><para><link linkend="POSTSCRIPT"><parameter>postscript</parameter></link></para></listitem>
836 <listitem><para><link linkend="PREEXEC"><parameter>preexec</parameter></link></para></listitem>
837 <listitem><para><link linkend="PREEXECCLOSE"><parameter>preexec close</parameter></link></para></listitem>
838 <listitem><para><link linkend="PRESERVECASE"><parameter>preserve case</parameter></link></para></listitem>
839 <listitem><para><link linkend="PRINTCOMMAND"><parameter>print command</parameter></link></para></listitem>
840 <listitem><para><link linkend="PRINTOK"><parameter>print ok</parameter></link></para></listitem>
841 <listitem><para><link linkend="PRINTABLE"><parameter>printable</parameter></link></para></listitem>
842 <listitem><para><link linkend="PRINTER"><parameter>printer</parameter></link></para></listitem>
843 <listitem><para><link linkend="PRINTERADMIN"><parameter>printer admin</parameter></link></para></listitem>
844 <listitem><para><link linkend="PRINTERDRIVER"><parameter>printer driver</parameter></link></para></listitem>
845 <listitem><para><link linkend="PRINTERDRIVERLOCATION"><parameter>printer driver location</parameter></link></para></listitem>
846 <listitem><para><link linkend="PRINTERNAME"><parameter>printer name</parameter></link></para></listitem>
847 <listitem><para><link linkend="PRINTING"><parameter>printing</parameter></link></para></listitem>
848 <listitem><para><link linkend="PUBLIC"><parameter>public</parameter></link></para></listitem>
849 <listitem><para><link linkend="QUEUEPAUSECOMMAND"><parameter>queuepause command</parameter></link></para></listitem>
850 <listitem><para><link linkend="QUEUERESUMECOMMAND"><parameter>queueresume command</parameter></link></para></listitem>
851 <listitem><para><link linkend="READLIST"><parameter>read list</parameter></link></para></listitem>
852 <listitem><para><link linkend="READONLY"><parameter>read only</parameter></link></para></listitem>
853 <listitem><para><link linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with mask</parameter></link></para></listitem>
854 <listitem><para><link linkend="ROOTPOSTEXEC"><parameter>root postexec</parameter></link></para></listitem>
855 <listitem><para><link linkend="ROOTPREEXEC"><parameter>root preexec</parameter></link></para></listitem>
856 <listitem><para><link linkend="ROOTPREEXECCLOSE"><parameter>root preexec close</parameter></link></para></listitem>
857 <listitem><para><link linkend="SECURITYMASK"><parameter>security mask</parameter></link></para></listitem>
858 <listitem><para><link linkend="SETDIRECTORY"><parameter>set directory</parameter></link></para></listitem>
859 <listitem><para><link linkend="SHAREMODES"><parameter>share modes</parameter></link></para></listitem>
860 <listitem><para><link linkend="SHORTPRESERVECASE"><parameter>short preserve case</parameter></link></para></listitem>
861 <listitem><para><link linkend="STATUS"><parameter>status</parameter></link></para></listitem>
862 <listitem><para><link linkend="STRICTLOCKING"><parameter>strict locking</parameter></link></para></listitem>
863 <listitem><para><link linkend="STRICTSYNC"><parameter>strict sync</parameter></link></para></listitem>
864 <listitem><para><link linkend="SYNCALWAYS"><parameter>sync always</parameter></link></para></listitem>
865 <listitem><para><link linkend="USER"><parameter>user</parameter></link></para></listitem>
866 <listitem><para><link linkend="USERNAME"><parameter>username</parameter></link></para></listitem>
867 <listitem><para><link linkend="USERS"><parameter>users</parameter></link></para></listitem>
868 <listitem><para><link linkend="UTMP"><parameter>utmp</parameter></link></para></listitem>
869 <listitem><para><link linkend="VALIDUSERS"><parameter>valid users</parameter></link></para></listitem>
870 <listitem><para><link linkend="VETOFILES"><parameter>veto files</parameter></link></para></listitem>
871 <listitem><para><link linkend="VETOOPLOCKFILES"><parameter>veto oplock files</parameter></link></para></listitem>
872 <listitem><para><link linkend="VFSOBJECT"><parameter>vfs object</parameter></link></para></listitem>
873 <listitem><para><link linkend="VFSOPTIONS"><parameter>vfs options</parameter></link></para></listitem>
874 <listitem><para><link linkend="VOLUME"><parameter>volume</parameter></link></para></listitem>
875 <listitem><para><link linkend="WIDELINKS"><parameter>wide links</parameter></link></para></listitem>
876 <listitem><para><link linkend="WRITABLE"><parameter>writable</parameter></link></para></listitem>
877 <listitem><para><link linkend="WRITECACHESIZE"><parameter>write cache size</parameter></link></para></listitem>
878 <listitem><para><link linkend="WRITELIST"><parameter>write list</parameter></link></para></listitem>
879 <listitem><para><link linkend="WRITEOK"><parameter>write ok</parameter></link></para></listitem>
880 <listitem><para><link linkend="WRITEABLE"><parameter>writeable</parameter></link></para></listitem>
881 </itemizedlist>
883 </refsect1>
885 <refsect1>
886 <title>EXPLANATION OF EACH PARAMETER</title>
888 <variablelist>
891 <varlistentry>
892 <term><anchor id="ADDPRINTERCOMMAND">add printer command (G)</term>
893 <listitem><para>With the introduction of MS-RPC based printing
894 support for Windows NT/2000 clients in Samba 2.2, The MS Add
895 Printer Wizard (APW) icon is now also available in the
896 "Printers..." folder displayed a share listing. The APW
897 allows for printers to be add remotely to a Samba or Windows
898 NT/2000 print server.</para>
900 <para>For a Samba host this means that the printer must be
901 physically added to underlying printing system. The <parameter>add
902 printer command</parameter> defines a script to be run which
903 will perform the necessary operations for adding the printer
904 to the print system and to add the appropriate service definition
905 to the <filename>smb.conf</filename> file in order that it can be
906 shared by <ulink url="smbd.8.html"><command>smbd(8)</command>
907 </ulink>.</para>
909 <para>The <parameter>add printer command</parameter> is
910 automatically invoked with the following parameter (in
911 order:</para>
913 <itemizedlist>
914 <listitem><para><parameter>printer name</parameter></para></listitem>
915 <listitem><para><parameter>share name</parameter></para></listitem>
916 <listitem><para><parameter>port name</parameter></para></listitem>
917 <listitem><para><parameter>driver name</parameter></para></listitem>
918 <listitem><para><parameter>location</parameter></para></listitem>
919 <listitem><para><parameter>Windows 9x driver location</parameter>
920 </para></listitem>
921 </itemizedlist>
923 <para>All parameters are filled in from the PRINTER_INFO_2 structure sent
924 by the Windows NT/2000 client with one exception. The "Windows 9x
925 driver location" parameter is included for backwards compatibility
926 only. The remaining fields in the structure are generated from answers
927 to the APW questions.</para>
929 <para>Once the <parameter>add printer command</parameter> has
930 been executed, <command>smbd</command> will reparse the <filename>
931 smb.conf</filename> to determine if the share defined by the APW
932 exists. If the sharename is still invalid, then <command>smbd
933 </command> will return an ACCESS_DENIED error to the client.</para>
935 <para>See also <link linkend="DELETEPRINTERCOMMAND"><parameter>
936 delete printer command</parameter></link>, <link
937 linkend="printing"><parameter>printing</parameter></link>,
938 <link linkend="SHOWADDPRINTERWIZARD"><parameter>show add
939 printer wizard</parameter></link></para>
941 <para>Default: <emphasis>none</emphasis></para>
942 <para>Example: <command>addprinter command = /usr/bin/addprinter
943 </command></para>
944 </listitem>
945 </varlistentry>
949 <varlistentry>
950 <term><anchor id="ADDSHARECOMMAND">add share command (G)</term>
951 <listitem><para>Samba 2.2.0 introduced the ability to dynamically
952 add and delete shares via the Windows NT 4.0 Server Manager. The
953 <parameter>add share command</parameter> is used to define an
954 external program or script which will add a new service definition
955 to <filename>smb.conf</filename>. In order to successfully
956 execute the <parameter>add share command</parameter>, <command>smbd</command>
957 requires that the administrator be connected using a root account (i.e.
958 uid == 0).
959 </para>
961 <para>
962 When executed, <command>smbd</command> will automatically invoke the
963 <parameter>add share command</parameter> with four parameters.
964 </para>
966 <itemizedlist>
967 <listitem><para><parameter>configFile</parameter> - the location
968 of the global <filename>smb.conf</filename> file.
969 </para></listitem>
971 <listitem><para><parameter>shareName</parameter> - the name of the new
972 share.
973 </para></listitem>
975 <listitem><para><parameter>pathName</parameter> - path to an **existing**
976 directory on disk.
977 </para></listitem>
979 <listitem><para><parameter>comment</parameter> - comment string to associate
980 with the new share.
981 </para></listitem>
982 </itemizedlist>
984 <para>
985 This parameter is only used for add file shares. To add printer shares,
986 see the <link linkend="ADDPRINTERCOMMAND"><parameter>add printer
987 command</parameter></link>.
988 </para>
990 <para>
991 See also <link linkend="CHANGESHARECOMMAND"><parameter>change share
992 command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter>delete share
993 command</parameter></link>.
994 </para>
996 <para>Default: <emphasis>none</emphasis></para>
997 <para>Example: <command>add share command = /usr/local/bin/addshare</command></para>
998 </listitem>
999 </varlistentry>
1003 <varlistentry>
1004 <term><anchor id="ADDUSERSCRIPT">add user script (G)</term>
1005 <listitem><para>This is the full pathname to a script that will
1006 be run <emphasis>AS ROOT</emphasis> by <ulink url="smbd.8.html">smbd(8)
1007 </ulink> under special circumstances described below.</para>
1009 <para>Normally, a Samba server requires that UNIX users are
1010 created for all users accessing files on this server. For sites
1011 that use Windows NT account databases as their primary user database
1012 creating these users and keeping the user list in sync with the
1013 Windows NT PDC is an onerous task. This option allows <ulink
1014 url="smbd.8.html">smbd</ulink> to create the required UNIX users
1015 <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.</para>
1017 <para>In order to use this option, <ulink url="smbd.8.html">smbd</ulink>
1018 must be set to <parameter>security=server</parameter> or <parameter>
1019 security=domain</parameter> and <parameter>add user script</parameter>
1020 must be set to a full pathname for a script that will create a UNIX
1021 user given one argument of <parameter>%u</parameter>, which expands into
1022 the UNIX user name to create.</para>
1024 <para>When the Windows user attempts to access the Samba server,
1025 at login (session setup in the SMB protocol) time, <ulink url="smbd.8.html">
1026 smbd</ulink> contacts the <parameter>password server</parameter> and
1027 attempts to authenticate the given user with the given password. If the
1028 authentication succeeds then <command>smbd</command>
1029 attempts to find a UNIX user in the UNIX password database to map the
1030 Windows user into. If this lookup fails, and <parameter>add user script
1031 </parameter> is set then <command>smbd</command> will
1032 call the specified script <emphasis>AS ROOT</emphasis>, expanding
1033 any <parameter>%u</parameter> argument to be the user name to create.</para>
1035 <para>If this script successfully creates the user then <command>smbd
1036 </command> will continue on as though the UNIX user
1037 already existed. In this way, UNIX users are dynamically created to
1038 match existing Windows NT accounts.</para>
1040 <para>See also <link linkend="SECURITY"><parameter>
1041 security</parameter></link>, <link linkend="PASSWORDSERVER">
1042 <parameter>password server</parameter></link>,
1043 <link linkend="DELETEUSERSCRIPT"><parameter>delete user
1044 script</parameter></link>.</para>
1046 <para>Default: <command>add user script = &lt;empty string&gt;
1047 </command></para>
1049 <para>Example: <command>add user script = /usr/local/samba/bin/add_user
1050 %u</command></para>
1051 </listitem>
1052 </varlistentry>
1056 <varlistentry>
1057 <term><anchor id="ADMINUSERS">admin users (S)</term>
1058 <listitem><para>This is a list of users who will be granted
1059 administrative privileges on the share. This means that they
1060 will do all file operations as the super-user (root).</para>
1062 <para>You should use this option very carefully, as any user in
1063 this list will be able to do anything they like on the share,
1064 irrespective of file permissions.</para>
1066 <para>Default: <emphasis>no admin users</emphasis></para>
1068 <para>Example: <command>admin users = jason</command></para>
1069 </listitem>
1070 </varlistentry>
1074 <varlistentry>
1075 <term><anchor id="ALLOWHOSTS">allow hosts (S)</term>
1076 <listitem><para>Synonym for <link linkend="HOSTSALLOW">
1077 <parameter>hosts allow</parameter></link>.</para></listitem>
1078 </varlistentry>
1082 <varlistentry>
1083 <term><anchor id="ALLOWTRUSTEDDOMAINS">allow trusted domains (G)</term>
1084 <listitem><para>This option only takes effect when the <link
1085 linkend="SECURITY"><parameter>security</parameter></link> option is set to
1086 <constant>server</constant> or <constant>domain</constant>.
1087 If it is set to no, then attempts to connect to a resource from
1088 a domain or workgroup other than the one which smbd is running
1089 in will fail, even if that domain is trusted by the remote server
1090 doing the authentication.</para>
1092 <para>This is useful if you only want your Samba server to
1093 serve resources to users in the domain it is a member of. As
1094 an example, suppose that there are two domains DOMA and DOMB. DOMB
1095 is trusted by DOMA, which contains the Samba server. Under normal
1096 circumstances, a user with an account in DOMB can then access the
1097 resources of a UNIX account with the same account name on the
1098 Samba server even if they do not have an account in DOMA. This
1099 can make implementing a security boundary difficult.</para>
1101 <para>Default: <command>allow trusted domains = yes</command></para>
1103 </listitem>
1104 </varlistentry>
1108 <varlistentry>
1109 <term><anchor id="ANNOUNCEAS">announce as (G)</term>
1110 <listitem><para>This specifies what type of server
1111 <ulink url="nmbd.8.html"><command>nmbd</command></ulink>
1112 will announce itself as, to a network neighborhood browse
1113 list. By default this is set to Windows NT. The valid options
1114 are : "NT Server" (which can also be written as "NT"),
1115 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
1116 Windows NT Workstation, Windows 95 and Windows for Workgroups
1117 respectively. Do not change this parameter unless you have a
1118 specific need to stop Samba appearing as an NT server as this
1119 may prevent Samba servers from participating as browser servers
1120 correctly.</para>
1122 <para>Default: <command>announce as = NT Server</command></para>
1124 <para>Example: <command>announce as = Win95</command></para>
1125 </listitem>
1126 </varlistentry>
1130 <varlistentry>
1131 <term><anchor id="ANNOUNCEVERSION">annouce version (G)</term>
1132 <listitem><para>This specifies the major and minor version numbers
1133 that nmbd will use when announcing itself as a server. The default
1134 is 4.2. Do not change this parameter unless you have a specific
1135 need to set a Samba server to be a downlevel server.</para>
1137 <para>Default: <command>announce version = 4.2</command></para>
1139 <para>Example: <command>announce version = 2.0</command></para>
1140 </listitem>
1141 </varlistentry>
1145 <varlistentry>
1146 <term><anchor id="AUTOSERVICES">auto services (G)</term>
1147 <listitem><para>This is a synonym for the <link linkend="PRELOAD">
1148 <parameter>preload</parameter></link>.</para>
1149 </listitem>
1150 </varlistentry>
1154 <varlistentry>
1155 <term><anchor id="AVAILABLE">available (S)</term>
1156 <listitem><para>This parameter lets you "turn off" a service. If
1157 <parameter>available = no</parameter>, then <emphasis>ALL</emphasis>
1158 attempts to connect to the service will fail. Such failures are
1159 logged.</para>
1161 <para>Default: <command>available = yes</command></para>
1163 </listitem>
1164 </varlistentry>
1168 <varlistentry>
1169 <term><anchor id="BINDINTERFACESONLY">bind interfaces only (G)</term>
1170 <listitem><para>This global parameter allows the Samba admin
1171 to limit what interfaces on a machine will serve smb requests. If
1172 affects file service <ulink url="smbd.8.html">smbd(8)</ulink> and
1173 name service <ulink url="nmbd.8.html">nmbd(8)</ulink> in slightly
1174 different ways.</para>
1176 <para>For name service it causes <command>nmbd</command> to bind
1177 to ports 137 and 138 on the interfaces listed in the <link
1178 linkend="INTERFACES">interfaces</link> parameter. <command>nmbd
1179 </command> also binds to the "all addresses" interface (0.0.0.0)
1180 on ports 137 and 138 for the purposes of reading broadcast messages.
1181 If this option is not set then <command>nmbd</command> will service
1182 name requests on all of these sockets. If <parameter>bind interfaces
1183 only</parameter> is set then <command>nmbd</command> will check the
1184 source address of any packets coming in on the broadcast sockets
1185 and discard any that don't match the broadcast addresses of the
1186 interfaces in the <parameter>interfaces</parameter> parameter list.
1187 As unicast packets are received on the other sockets it allows
1188 <command>nmbd</command> to refuse to serve names to machines that
1189 send packets that arrive through any interfaces not listed in the
1190 <parameter>interfaces</parameter> list. IP Source address spoofing
1191 does defeat this simple check, however so it must not be used
1192 seriously as a security feature for <command>nmbd</command>.</para>
1194 <para>For file service it causes <ulink url="smbd.8.html">smbd(8)</ulink>
1195 to bind only to the interface list given in the <link linkend="INTERFACES">
1196 interfaces</link> parameter. This restricts the networks that
1197 <command>smbd</command> will serve to packets coming in those
1198 interfaces. Note that you should not use this parameter for machines
1199 that are serving PPP or other intermittent or non-broadcast network
1200 interfaces as it will not cope with non-permanent interfaces.</para>
1202 <para>If <parameter>bind interfaces only</parameter> is set then
1203 unless the network address <emphasis>127.0.0.1</emphasis> is added
1204 to the <parameter>interfaces</parameter> parameter list <ulink
1205 url="smbpasswd.8.html"><command>smbpasswd(8)</command></ulink>
1206 and <ulink url="swat.8.html"><command>swat(8)</command></ulink> may
1207 not work as expected due to the reasons covered below.</para>
1209 <para>To change a users SMB password, the <command>smbpasswd</command>
1210 by default connects to the <emphasis>localhost - 127.0.0.1</emphasis>
1211 address as an SMB client to issue the password change request. If
1212 <parameter>bind interfaces only</parameter> is set then unless the
1213 network address <emphasis>127.0.0.1</emphasis> is added to the
1214 <parameter>interfaces</parameter> parameter list then <command>
1215 smbpasswd</command> will fail to connect in it's default mode.
1216 <command>smbpasswd</command> can be forced to use the primary IP interface
1217 of the local host by using its <ulink url="smbpasswd.8.html#minusr">
1218 <parameter>-r <replaceable>remote machine</replaceable></parameter>
1219 </ulink> parameter, with <replaceable>remote machine</replaceable> set
1220 to the IP name of the primary interface of the local host.</para>
1222 <para>The <command>swat</command> status page tries to connect with
1223 <command>smbd</command> and <command>nmbd</command> at the address
1224 <emphasis>127.0.0.1</emphasis> to determine if they are running.
1225 Not adding <emphasis>127.0.0.1</emphasis> will cause <command>
1226 smbd</command> and <command>nmbd</command> to always show
1227 "not running" even if they really are. This can prevent <command>
1228 swat</command> from starting/stopping/restarting <command>smbd</command>
1229 and <command>nmbd</command>.</para>
1231 <para>Default: <command>bind interfaces only = no</command></para>
1233 </listitem>
1234 </varlistentry>
1238 <varlistentry>
1239 <term><anchor id="BLOCKINGLOCKS">blocking locks (S)</term>
1240 <listitem><para>This parameter controls the behavior of <ulink
1241 url="smbd.8.html">smbd(8)</ulink> when given a request by a client
1242 to obtain a byte range lock on a region of an open file, and the
1243 request has a time limit associated with it.</para>
1245 <para>If this parameter is set and the lock range requested
1246 cannot be immediately satisfied, Samba 2.2 will internally
1247 queue the lock request, and periodically attempt to obtain
1248 the lock until the timeout period expires.</para>
1250 <para>If this parameter is set to <constant>False</constant>, then
1251 Samba 2.2 will behave as previous versions of Samba would and
1252 will fail the lock request immediately if the lock range
1253 cannot be obtained.</para>
1255 <para>Default: <command>blocking locks = yes</command></para>
1257 </listitem>
1258 </varlistentry>
1262 <varlistentry>
1263 <term><anchor id="BROWSABLE">browsable (S)</term>
1264 <listitem><para>See the <link linkend="BROWSEABLE"><parameter>
1265 browseable</parameter></link>.</para></listitem>
1266 </varlistentry>
1270 <varlistentry>
1271 <term><anchor id="BROWSELIST">browse list (G)</term>
1272 <listitem><para>This controls whether <ulink url="smbd.8.html">
1273 <command>smbd(8)</command></ulink> will serve a browse list to
1274 a client doing a <command>NetServerEnum</command> call. Normally
1275 set to <constant>true</constant>. You should never need to change
1276 this.</para>
1278 <para>Default: <command>browse list = yes</command></para></listitem>
1279 </varlistentry>
1283 <varlistentry>
1284 <term><anchor id="BROWSEABLE">browseable (S)</term>
1285 <listitem><para>This controls whether this share is seen in
1286 the list of available shares in a net view and in the browse list.</para>
1288 <para>Default: <command>browseable = yes</command></para>
1289 </listitem>
1290 </varlistentry>
1294 <varlistentry>
1295 <term><anchor id="CASESENSITIVE">case sensitive (S)</term>
1296 <listitem><para>See the discussion in the section <link
1297 linkend="NAMEMANGLINGSECT">NAME MANGLING</link>.</para>
1299 <para>Default: <command>case sensitive = no</command></para>
1300 </listitem>
1301 </varlistentry>
1305 <varlistentry>
1306 <term><anchor id="CASESIGNAMES">casesignames (S)</term>
1307 <listitem><para>Synonym for <link linkend="CASESENSITIVE">case
1308 sensitive</link>.</para></listitem>
1309 </varlistentry>
1313 <varlistentry>
1314 <term><anchor id="CHANGENOTIFYTIMEOUT">change notify timeout (G)</term>
1315 <listitem><para>This SMB allows a client to tell a server to
1316 "watch" a particular directory for any changes and only reply to
1317 the SMB request when a change has occurred. Such constant scanning of
1318 a directory is expensive under UNIX, hence an <ulink url="smbd.8.html">
1319 <command>smbd(8)</command></ulink> daemon only performs such a scan
1320 on each requested directory once every <parameter>change notify
1321 timeout</parameter> seconds.</para>
1323 <para>Default: <command>change notify timeout = 60</command></para>
1324 <para>Example: <command>change notify timeout = 300</command></para>
1326 <para>Would change the scan time to every 5 minutes.</para></listitem>
1327 </varlistentry>
1331 <varlistentry>
1332 <term><anchor id="CHANGESHARECOMMAND">change share command (G)</term>
1333 <listitem><para>Samba 2.2.0 introduced the ability to dynamically
1334 add and delete shares via the Windows NT 4.0 Server Manager. The
1335 <parameter>change share command</parameter> is used to define an
1336 external program or script which will modify an existing service definition
1337 in <filename>smb.conf</filename>. In order to successfully
1338 execute the <parameter>change share command</parameter>, <command>smbd</command>
1339 requires that the administrator be connected using a root account (i.e.
1340 uid == 0).
1341 </para>
1343 <para>
1344 When executed, <command>smbd</command> will automatically invoke the
1345 <parameter>change share command</parameter> with four parameters.
1346 </para>
1348 <itemizedlist>
1349 <listitem><para><parameter>configFile</parameter> - the location
1350 of the global <filename>smb.conf</filename> file.
1351 </para></listitem>
1353 <listitem><para><parameter>shareName</parameter> - the name of the new
1354 share.
1355 </para></listitem>
1357 <listitem><para><parameter>pathName</parameter> - path to an **existing**
1358 directory on disk.
1359 </para></listitem>
1361 <listitem><para><parameter>comment</parameter> - comment string to associate
1362 with the new share.
1363 </para></listitem>
1364 </itemizedlist>
1366 <para>
1367 This parameter is only used modify existing file shares definitions. To modify
1368 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
1369 </para>
1371 <para>
1372 See also <link linkend="ADDSHARECOMMAND"><parameter>add share
1373 command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter>delete
1374 share command</parameter></link>.
1375 </para>
1377 <para>Default: <emphasis>none</emphasis></para>
1378 <para>Example: <command>change share command = /usr/local/bin/addshare</command></para>
1379 </listitem>
1380 </varlistentry>
1384 <varlistentry>
1385 <term><anchor id="CHARACTERSET">character set (G)</term>
1386 <listitem><para>This allows a smbd to map incoming filenames
1387 from a DOS Code page (see the <link linkend="CLIENTCODEPAGE">client
1388 code page</link> parameter) to several built in UNIX character sets.
1389 The built in code page translations are:</para>
1391 <itemizedlist>
1392 <listitem><para><constant>ISO8859-1</constant> : Western European
1393 UNIX character set. The parameter <parameter>client code page</parameter>
1394 <emphasis>MUST</emphasis> be set to code page 850 if the
1395 <parameter>character set</parameter> parameter is set to
1396 <constant>ISO8859-1</constant> in order for the conversion to the
1397 UNIX character set to be done correctly.</para></listitem>
1399 <listitem><para><constant>ISO8859-2</constant> : Eastern European
1400 UNIX character set. The parameter <parameter>client code page
1401 </parameter> <emphasis>MUST</emphasis> be set to code page 852 if
1402 the <parameter> character set</parameter> parameter is set
1403 to <constant>ISO8859-2</constant> in order for the conversion
1404 to the UNIX character set to be done correctly. </para></listitem>
1406 <listitem><para><constant>ISO8859-5</constant> : Russian Cyrillic
1407 UNIX character set. The parameter <parameter>client code page
1408 </parameter> <emphasis>MUST</emphasis> be set to code page
1409 866 if the <parameter>character set </parameter> parameter is
1410 set to <constant>ISO8859-5</constant> in order for the conversion
1411 to the UNIX character set to be done correctly. </para></listitem>
1413 <listitem><para><constant>ISO8859-7</constant> : Greek UNIX
1414 character set. The parameter <parameter>client code page
1415 </parameter> <emphasis>MUST</emphasis> be set to code page
1416 737 if the <parameter>character set</parameter> parameter is
1417 set to <constant>ISO8859-7</constant> in order for the conversion
1418 to the UNIX character set to be done correctly.</para></listitem>
1420 <listitem><para><constant>KOI8-R</constant> : Alternate mapping
1421 for Russian Cyrillic UNIX character set. The parameter
1422 <parameter>client code page</parameter> <emphasis>MUST</emphasis>
1423 be set to code page 866 if the <parameter>character set</parameter>
1424 parameter is set to <constant>KOI8-R</constant> in order for the
1425 conversion to the UNIX character set to be done correctly.</para>
1426 </listitem>
1427 </itemizedlist>
1429 <para><emphasis>BUG</emphasis>. These MSDOS code page to UNIX character
1430 set mappings should be dynamic, like the loading of MS DOS code pages,
1431 not static.</para>
1433 <para>Normally this parameter is not set, meaning no filename
1434 translation is done.</para>
1436 <para>Default: <command>character set = &lt;empty string&gt;</command></para>
1437 <para>Example: <command>character set = ISO8859-1</command></para></listitem>
1438 </varlistentry>
1442 <varlistentry>
1443 <term><anchor id="CLIENTCODEPAGE">client code page (G)</term>
1444 <listitem><para>This parameter specifies the DOS code page
1445 that the clients accessing Samba are using. To determine what code
1446 page a Windows or DOS client is using, open a DOS command prompt
1447 and type the command <command>chcp</command>. This will output
1448 the code page. The default for USA MS-DOS, Windows 95, and
1449 Windows NT releases is code page 437. The default for western
1450 European releases of the above operating systems is code page 850.</para>
1452 <para>This parameter tells <ulink url="smbd.8.html">smbd(8)</ulink>
1453 which of the <filename>codepage.<replaceable>XXX</replaceable>
1454 </filename> files to dynamically load on startup. These files,
1455 described more fully in the manual page <ulink url="make_smbcodepage.1.html">
1456 <command>make_smbcodepage(1)</command></ulink>, tell <command>
1457 smbd</command> how to map lower to upper case characters to provide
1458 the case insensitivity of filenames that Windows clients expect.</para>
1460 <para>Samba currently ships with the following code page files :</para>
1462 <itemizedlist>
1463 <listitem><para>Code Page 437 - MS-DOS Latin US</para></listitem>
1464 <listitem><para>Code Page 737 - Windows '95 Greek</para></listitem>
1465 <listitem><para>Code Page 850 - MS-DOS Latin 1</para></listitem>
1466 <listitem><para>Code Page 852 - MS-DOS Latin 2</para></listitem>
1467 <listitem><para>Code Page 861 - MS-DOS Icelandic</para></listitem>
1468 <listitem><para>Code Page 866 - MS-DOS Cyrillic</para></listitem>
1469 <listitem><para>Code Page 932 - MS-DOS Japanese SJIS</para></listitem>
1470 <listitem><para>Code Page 936 - MS-DOS Simplified Chinese</para></listitem>
1471 <listitem><para>Code Page 949 - MS-DOS Korean Hangul</para></listitem>
1472 <listitem><para>Code Page 950 - MS-DOS Traditional Chinese</para></listitem>
1473 </itemizedlist>
1475 <para>Thus this parameter may have any of the values 437, 737, 850, 852,
1476 861, 932, 936, 949, or 950. If you don't find the codepage you need,
1477 read the comments in one of the other codepage files and the
1478 <command>make_smbcodepage(1)</command> man page and write one. Please
1479 remember to donate it back to the Samba user community.</para>
1481 <para>This parameter co-operates with the <parameter>valid
1482 chars</parameter> parameter in determining what characters are
1483 valid in filenames and how capitalization is done. If you set both
1484 this parameter and the <parameter>valid chars</parameter> parameter
1485 the <parameter>client code page</parameter> parameter
1486 <emphasis>MUST</emphasis> be set before the <parameter>valid
1487 chars</parameter> parameter in the <filename>smb.conf</filename>
1488 file. The <parameter>valid chars</parameter> string will then
1489 augment the character settings in the <parameter>client code page</parameter>
1490 parameter.</para>
1492 <para>If not set, <parameter>client code page</parameter> defaults
1493 to 850.</para>
1495 <para>See also : <link linkend="VALIDCHARS"><parameter>valid
1496 chars</parameter></link>, <link linkend="CODEPAGEDIRECTORY">
1497 <parameter>code page directory</parameter></link></para>
1499 <para>Default: <command>client code page = 850</command></para>
1500 <para>Example: <command>client code page = 936</command></para>
1501 </listitem>
1502 </varlistentry>
1507 <varlistentry>
1508 <term><anchor id="CODEPAGEDIRECTORY">code page directory (G)</term>
1509 <listitem><para>Define the location of the various client code page
1510 files.</para>
1512 <para>See also <link linkend="CLIENTCODEPAGE"><parameter>client
1513 code page</parameter></link></para>
1515 <para>Default: <command>code page directory = ${prefix}/lib/codepages
1516 </command></para>
1517 <para>Example: <command>code page directory = /usr/share/samba/codepages
1518 </command></para>
1519 </listitem>
1520 </varlistentry>
1526 <varlistentry>
1527 <term><anchor id="CODINGSYSTEM">codingsystem (G)</term>
1528 <listitem><para>This parameter is used to determine how incoming
1529 Shift-JIS Japanese characters are mapped from the incoming <link
1530 linkend="CLIENTCODEPAGE"><parameter>client code page</parameter>
1531 </link> used by the client, into file names in the UNIX filesystem.
1532 Only useful if <parameter>client code page</parameter> is set to
1533 932 (Japanese Shift-JIS). The options are :</para>
1535 <itemizedlist>
1536 <listitem><para><constant>SJIS</constant> - Shift-JIS. Does no
1537 conversion of the incoming filename.</para></listitem>
1539 <listitem><para><constant>JIS8, J8BB, J8BH, J8@B,
1540 J8@J, J8@H </constant> - Convert from incoming Shift-JIS to eight
1541 bit JIS code with different shift-in, shift out codes.</para></listitem>
1543 <listitem><para><constant>JIS7, J7BB, J7BH, J7@B, J7@J,
1544 J7@H </constant> - Convert from incoming Shift-JIS to seven bit
1545 JIS code with different shift-in, shift out codes.</para></listitem>
1547 <listitem><para><constant>JUNET, JUBB, JUBH, JU@B, JU@J, JU@H </constant>
1548 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
1549 shift out codes.</para></listitem>
1551 <listitem><para><constant>EUC</constant> - Convert an incoming
1552 Shift-JIS character to EUC code.</para></listitem>
1554 <listitem><para><constant>HEX</constant> - Convert an incoming
1555 Shift-JIS character to a 3 byte hex representation, i.e.
1556 <constant>:AB</constant>.</para></listitem>
1558 <listitem><para><constant>CAP</constant> - Convert an incoming
1559 Shift-JIS character to the 3 byte hex representation used by
1560 the Columbia AppleTalk Program (CAP), i.e. <constant>:AB</constant>.
1561 This is used for compatibility between Samba and CAP.</para></listitem>
1562 </itemizedlist>
1564 <para>Default: <command>coding system = &lt;empty value&gt;</command>
1565 </para>
1566 </listitem>
1567 </varlistentry>
1571 <varlistentry>
1572 <term><anchor id="COMMENT">comment (S)</term>
1573 <listitem><para>This is a text field that is seen next to a share
1574 when a client does a queries the server, either via the network
1575 neighborhood or via <command>net view</command> to list what shares
1576 are available.</para>
1578 <para>If you want to set the string that is displayed next to the
1579 machine name then see the <link linkend="SERVERSTRING"><parameter>
1580 server string</parameter></link> parameter.</para>
1582 <para>Default: <emphasis>No comment string</emphasis></para>
1583 <para>Example: <command>comment = Fred's Files</command></para></listitem>
1584 </varlistentry>
1588 <varlistentry>
1589 <term><anchor id="CONFIGFILE">config file (G)</term>
1590 <listitem><para>This allows you to override the config file
1591 to use, instead of the default (usually <filename>smb.conf</filename>).
1592 There is a chicken and egg problem here as this option is set
1593 in the config file!</para>
1595 <para>For this reason, if the name of the config file has changed
1596 when the parameters are loaded then it will reload them from
1597 the new config file.</para>
1599 <para>This option takes the usual substitutions, which can
1600 be very useful.</para>
1602 <para>If the config file doesn't exist then it won't be loaded
1603 (allowing you to special case the config files of just a few
1604 clients).</para>
1606 <para>Example: <command>config file = /usr/local/samba/lib/smb.conf.%m
1607 </command></para></listitem>
1608 </varlistentry>
1612 <varlistentry>
1613 <term><anchor id="COPY">copy (S)</term>
1614 <listitem><para>This parameter allows you to "clone" service
1615 entries. The specified service is simply duplicated under the
1616 current service's name. Any parameters specified in the current
1617 section will override those in the section being copied.</para>
1619 <para>This feature lets you set up a 'template' service and
1620 create similar services easily. Note that the service being
1621 copied must occur earlier in the configuration file than the
1622 service doing the copying.</para>
1624 <para>Default: <emphasis>no value</emphasis></para>
1625 <para>Example: <command>copy = otherservice</command></para></listitem>
1626 </varlistentry>
1630 <varlistentry>
1631 <term><anchor id="CREATEMASK">create mask (S)</term>
1632 <listitem><para>A synonym for this parameter is
1633 <link linkend="CREATEMODE"><parameter>create mode</parameter>
1634 </link>.</para>
1636 <para>When a file is created, the necessary permissions are
1637 calculated according to the mapping from DOS modes to UNIX
1638 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
1639 with this parameter. This parameter may be thought of as a bit-wise
1640 MASK for the UNIX modes of a file. Any bit <emphasis>not</emphasis>
1641 set here will be removed from the modes set on a file when it is
1642 created.</para>
1644 <para>The default value of this parameter removes the
1645 'group' and 'other' write and execute bits from the UNIX modes.</para>
1647 <para>Following this Samba will bit-wise 'OR' the UNIX mode created
1648 from this parameter with the value of the <link
1649 linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>
1650 parameter which is set to 000 by default.</para>
1652 <para>This parameter does not affect directory modes. See the
1653 parameter <link linkend="DIRECTORYMODE"><parameter>directory mode
1654 </parameter></link> for details.</para>
1656 <para>See also the <link linkend="FORCECREATEMODE"><parameter>force
1657 create mode</parameter></link> parameter for forcing particular mode
1658 bits to be set on created files. See also the <link linkend="DIRECTORYMODE">
1659 <parameter>directory mode"</parameter></link> parameter for masking
1660 mode bits on created directories. See also the <link linkend="INHERITPERMISSIONS">
1661 <parameter>inherit permissions</parameter></link> parameter.</para>
1663 <para>Note that by default this parameter does not apply to permissions
1664 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
1665 this mask on access control lists also, they need to set the <link
1666 linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with
1667 mask</parameter></link> to true.</para>
1669 <para>Default: <command>create mask = 0744</command></para>
1670 <para>Example: <command>create mask = 0775</command></para></listitem>
1671 </varlistentry>
1675 <varlistentry>
1676 <term><anchor id="CREATEMODE">create mode (S)</term>
1677 <listitem><para>This is a synonym for <link linkend="CREATEMASK"><parameter>
1678 create mask</parameter></link>.</para></listitem>
1679 </varlistentry>
1683 <varlistentry>
1684 <term><anchor id="DEADTIME">deadtime (G)</term>
1685 <listitem><para>The value of the parameter (a decimal integer)
1686 represents the number of minutes of inactivity before a connection
1687 is considered dead, and it is disconnected. The deadtime only takes
1688 effect if the number of open files is zero.</para>
1690 <para>This is useful to stop a server's resources being
1691 exhausted by a large number of inactive connections.</para>
1693 <para>Most clients have an auto-reconnect feature when a
1694 connection is broken so in most cases this parameter should be
1695 transparent to users.</para>
1697 <para>Using this parameter with a timeout of a few minutes
1698 is recommended for most systems.</para>
1700 <para>A deadtime of zero indicates that no auto-disconnection
1701 should be performed.</para>
1703 <para>Default: <command>deadtime = 0</command></para>
1704 <para>Example: <command>deadtime = 15</command></para></listitem>
1705 </varlistentry>
1709 <varlistentry>
1710 <term><anchor id="DEBUGHIRESTIMESTAMP">debug hires timestamp (G)</term>
1711 <listitem><para>Sometimes the timestamps in the log messages
1712 are needed with a resolution of higher that seconds, this
1713 boolean parameter adds microsecond resolution to the timestamp
1714 message header when turned on.</para>
1716 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1717 debug timestamp</parameter></link> must be on for this to have an
1718 effect.</para>
1720 <para>Default: <command>debug hires timestamp = no</command></para>
1721 </listitem>
1722 </varlistentry>
1726 <varlistentry>
1727 <term><anchor id="DEBUGPID">debug pid (G)</term>
1728 <listitem><para>When using only one log file for more then one
1729 forked smbd-process there may be hard to follow which process
1730 outputs which message. This boolean parameter is adds the process-id
1731 to the timestamp message headers in the logfile when turned on.</para>
1733 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1734 debug timestamp</parameter></link> must be on for this to have an
1735 effect.</para>
1737 <para>Default: <command>debug pid = no</command></para></listitem>
1738 </varlistentry>
1741 <varlistentry>
1742 <term><anchor id="DEBUGTIMESTAMP">debug timestamp (G)</term>
1743 <listitem><para>Samba 2.2 debug log messages are timestamped
1744 by default. If you are running at a high <link linkend="DEBUGLEVEL">
1745 <parameter>debug level</parameter></link> these timestamps
1746 can be distracting. This boolean parameter allows timestamping
1747 to be turned off.</para>
1749 <para>Default: <command>debug timestamp = yes</command></para></listitem>
1750 </varlistentry>
1754 <varlistentry>
1755 <term><anchor id="DEBUGUID">debug uid (G)</term>
1756 <listitem><para>Samba is sometimes run as root and sometime
1757 run as the connected user, this boolean parameter inserts the
1758 current euid, egid, uid and gid to the timestamp message headers
1759 in the log file if turned on.</para>
1761 <para>Note that the parameter <link linkend="DEBUGTIMESTAMP"><parameter>
1762 debug timestamp</parameter></link> must be on for this to have an
1763 effect.</para>
1765 <para>Default: <command>debug uid = no</command></para></listitem>
1766 </varlistentry>
1770 <varlistentry>
1771 <term><anchor id="DEBUGLEVEL">debuglevel (G)</term>
1772 <listitem><para>The value of the parameter (an integer) allows
1773 the debug level (logging level) to be specified in the
1774 <filename>smb.conf</filename> file. This is to give greater
1775 flexibility in the configuration of the system.</para>
1777 <para>The default will be the debug level specified on
1778 the command line or level zero if none was specified.</para>
1780 <para>Example: <command>debug level = 3</command></para></listitem>
1781 </varlistentry>
1785 <varlistentry>
1786 <term><anchor id="DEFAULT">default (G)</term>
1787 <listitem><para>A synonym for <link linkend="DEFAULTSERVICE"><parameter>
1788 default service</parameter></link>.</para></listitem>
1789 </varlistentry>
1793 <varlistentry>
1794 <term><anchor id="DEFAULTCASE">default case (S)</term>
1795 <listitem><para>See the section on <link linkend="NAMEMANGLINGSECT">
1796 NAME MANGLING</link>. Also note the <link linkend="SHORTPRESERVECASE">
1797 <parameter>short preserve case"</parameter></link> parameter.</para>
1799 <para>Default: <command>default case = lower</command></para>
1800 </listitem>
1801 </varlistentry>
1805 <varlistentry>
1806 <term><anchor id="DEFAULTSERVICE">default service (G)</term>
1807 <listitem><para>This parameter specifies the name of a service
1808 which will be connected to if the service actually requested cannot
1809 be found. Note that the square brackets are <emphasis>NOT</emphasis>
1810 given in the parameter value (see example below).</para>
1812 <para>There is no default value for this parameter. If this
1813 parameter is not given, attempting to connect to a nonexistent
1814 service results in an error.</para>
1816 <para>Typically the default service would be a <link linkend="GUESTOK">
1817 <parameter>guest ok</parameter></link>, <link linkend="READONLY">
1818 <parameter>read-only</parameter></link> service.</para>
1820 <para>Also note that the apparent service name will be changed
1821 to equal that of the requested service, this is very useful as it
1822 allows you to use macros like <parameter>%S</parameter> to make
1823 a wildcard service.</para>
1825 <para>Note also that any "_" characters in the name of the service
1826 used in the default service will get mapped to a "/". This allows for
1827 interesting things.</para>
1830 <para>Example:</para>
1832 <para><programlisting>
1833 [global]
1834 default service = pub
1836 [pub]
1837 path = /%S
1838 </programlisting></para>
1839 </listitem>
1840 </varlistentry>
1844 <varlistentry>
1845 <term><anchor id="DELETEPRINTERCOMMAND">delete printer command (G)</term>
1846 <listitem><para>With the introduction of MS-RPC based printer
1847 support for Windows NT/2000 clients in Samba 2.2, it is now
1848 possible to delete printer at run time by issuing the
1849 DeletePrinter() RPC call.</para>
1851 <para>For a Samba host this means that the printer must be
1852 physically deleted from underlying printing system. The <parameter>
1853 deleteprinter command</parameter> defines a script to be run which
1854 will perform the necessary operations for removing the printer
1855 from the print system and from <filename>smb.conf</filename>.
1856 </para>
1858 <para>The <parameter>delete printer command</parameter> is
1859 automatically called with only one parameter: <parameter>
1860 "printer name"</parameter>.</para>
1863 <para>Once the <parameter>delete printer command</parameter> has
1864 been executed, <command>smbd</command> will reparse the <filename>
1865 smb.conf</filename> to associated printer no longer exists.
1866 If the sharename is still valid, then <command>smbd
1867 </command> will return an ACCESS_DENIED error to the client.</para>
1869 <para>See also <link linkend="ADDPRINTERCOMMAND"><parameter>
1870 add printer command</parameter></link>, <link
1871 linkend="printing"><parameter>printing</parameter></link>,
1872 <link linkend="SHOWADDPRINTERWIZARD"><parameter>show add
1873 printer wizard</parameter></link></para>
1875 <para>Default: <emphasis>none</emphasis></para>
1876 <para>Example: <command>deleteprinter command = /usr/bin/removeprinter
1877 </command></para>
1878 </listitem>
1879 </varlistentry>
1886 <varlistentry>
1887 <term><anchor id="DELETEREADONLY">delete readonly (S)</term>
1888 <listitem><para>This parameter allows readonly files to be deleted.
1889 This is not normal DOS semantics, but is allowed by UNIX.</para>
1891 <para>This option may be useful for running applications such
1892 as rcs, where UNIX file ownership prevents changing file
1893 permissions, and DOS semantics prevent deletion of a read only file.</para>
1895 <para>Default: <command>delete readonly = no</command></para></listitem>
1896 </varlistentry>
1900 <varlistentry>
1901 <term><anchor id="DELETESHARECOMMAND">delete share command (G)</term>
1902 <listitem><para>Samba 2.2.0 introduced the ability to dynamically
1903 add and delete shares via the Windows NT 4.0 Server Manager. The
1904 <parameter>delete share command</parameter> is used to define an
1905 external program or script which will remove an existing service
1906 definition from <filename>smb.conf</filename>. In order to successfully
1907 execute the <parameter>delete share command</parameter>, <command>smbd</command>
1908 requires that the administrator be connected using a root account (i.e.
1909 uid == 0).
1910 </para>
1912 <para>
1913 When executed, <command>smbd</command> will automatically invoke the
1914 <parameter>delete share command</parameter> with two parameters.
1915 </para>
1917 <itemizedlist>
1918 <listitem><para><parameter>configFile</parameter> - the location
1919 of the global <filename>smb.conf</filename> file.
1920 </para></listitem>
1922 <listitem><para><parameter>shareName</parameter> - the name of
1923 the existing service.
1924 </para></listitem>
1925 </itemizedlist>
1927 <para>
1928 This parameter is only used to remove file shares. To delete printer shares,
1929 see the <link linkend="DELETEPRINTERCOMMAND"><parameter>delete printer
1930 command</parameter></link>.
1931 </para>
1933 <para>
1934 See also <link linkend="ADDSHARECOMMAND"><parameter>delete share
1935 command</parameter></link>, <link linkend="CHANGESHARECOMMAND"><parameter>change
1936 share</parameter></link>.
1937 </para>
1939 <para>Default: <emphasis>none</emphasis></para>
1940 <para>Example: <command>delete share command = /usr/local/bin/delshare</command></para>
1942 </listitem>
1943 </varlistentry>
1948 <varlistentry>
1949 <term><anchor id="DELETEUSERSCRIPT">delete user script (G)</term>
1950 <listitem><para>This is the full pathname to a script that will
1951 be run <emphasis>AS ROOT</emphasis> by <ulink url="smbd.8.html">
1952 <command>smbd(8)</command></ulink> under special circumstances
1953 described below.</para>
1955 <para>Normally, a Samba server requires that UNIX users are
1956 created for all users accessing files on this server. For sites
1957 that use Windows NT account databases as their primary user database
1958 creating these users and keeping the user list in sync with the
1959 Windows NT PDC is an onerous task. This option allows <command>
1960 smbd</command> to delete the required UNIX users <emphasis>ON
1961 DEMAND</emphasis> when a user accesses the Samba server and the
1962 Windows NT user no longer exists.</para>
1964 <para>In order to use this option, <command>smbd</command> must be
1965 set to <parameter>security=domain</parameter> and <parameter>delete
1966 user script</parameter> must be set to a full pathname for a script
1967 that will delete a UNIX user given one argument of <parameter>%u
1968 </parameter>, which expands into the UNIX user name to delete.
1969 <emphasis>NOTE</emphasis> that this is different to the <link
1970 linkend="ADDUSERSCRIPT"><parameter>add user script</parameter></link>
1971 which will work with the <parameter>security=server</parameter> option
1972 as well as <parameter>security=domain</parameter>. The reason for this
1973 is only when Samba is a domain member does it get the information
1974 on an attempted user logon that a user no longer exists. In the
1975 <parameter>security=server</parameter> mode a missing user
1976 is treated the same as an invalid password logon attempt. Deleting
1977 the user in this circumstance would not be a good idea.</para>
1979 <para>When the Windows user attempts to access the Samba server,
1980 at <emphasis>login</emphasis> (session setup in the SMB protocol)
1981 time, <command>smbd</command> contacts the <link linkend="PASSWORDSERVER">
1982 <parameter>password server</parameter></link> and attempts to authenticate
1983 the given user with the given password. If the authentication fails
1984 with the specific Domain error code meaning that the user no longer
1985 exists then <command>smbd</command> attempts to find a UNIX user in
1986 the UNIX password database that matches the Windows user account. If
1987 this lookup succeeds, and <parameter>delete user script</parameter> is
1988 set then <command>smbd</command> will all the specified script
1989 <emphasis>AS ROOT</emphasis>, expanding any <parameter>%u</parameter>
1990 argument to be the user name to delete.</para>
1992 <para>This script should delete the given UNIX username. In this way,
1993 UNIX users are dynamically deleted to match existing Windows NT
1994 accounts.</para>
1996 <para>See also <link linkend="SECURITYEQUALSDOMAIN">security=domain</link>,
1997 <link linkend="PASSWORDSERVER"><parameter>password server</parameter>
1998 </link>, <link linkend="ADDUSERSCRIPT"><parameter>add user script</parameter>
1999 </link>.</para>
2001 <para>Default: <command>delete user script = &lt;empty string&gt;
2002 </command></para>
2003 <para>Example: <command>delete user script = /usr/local/samba/bin/del_user
2004 %u</command></para></listitem>
2005 </varlistentry>
2011 <varlistentry>
2012 <term><anchor id="DELETEVETOFILES">delete veto files (S)</term>
2013 <listitem><para>This option is used when Samba is attempting to
2014 delete a directory that contains one or more vetoed directories
2015 (see the <link linkend="VETOFILES"><parameter>veto files</parameter></link>
2016 option). If this option is set to False (the default) then if a vetoed
2017 directory contains any non-vetoed files or directories then the
2018 directory delete will fail. This is usually what you want.</para>
2020 <para>If this option is set to <constant>True</constant>, then Samba
2021 will attempt to recursively delete any files and directories within
2022 the vetoed directory. This can be useful for integration with file
2023 serving systems such as NetAtalk which create meta-files within
2024 directories you might normally veto DOS/Windows users from seeing
2025 (e.g. <filename>.AppleDouble</filename>)</para>
2027 <para>Setting <command>delete veto files = yes</command> allows these
2028 directories to be transparently deleted when the parent directory
2029 is deleted (so long as the user has permissions to do so).</para>
2031 <para>See also the <link linkend="VETOFILES"><parameter>veto
2032 files</parameter></link> parameter.</para>
2034 <para>Default: <command>delete veto files = no</command></para></listitem>
2035 </varlistentry>
2040 <varlistentry>
2041 <term><anchor id="DENYHOSTS">deny hosts (S)</term>
2042 <listitem><para>Synonym for <link linkend="HOSTSDENY"><parameter>hosts
2043 deny</parameter></link>.</para></listitem>
2044 </varlistentry>
2049 <varlistentry>
2050 <term><anchor id="DFREECOMMAND">dfree command (G)</term>
2051 <listitem><para>The <parameter>dfree command</parameter> setting should
2052 only be used on systems where a problem occurs with the internal
2053 disk space calculations. This has been known to happen with Ultrix,
2054 but may occur with other operating systems. The symptom that was
2055 seen was an error of "Abort Retry Ignore" at the end of each
2056 directory listing.</para>
2058 <para>This setting allows the replacement of the internal routines to
2059 calculate the total disk space and amount available with an external
2060 routine. The example below gives a possible script that might fulfill
2061 this function.</para>
2063 <para>The external program will be passed a single parameter indicating
2064 a directory in the filesystem being queried. This will typically consist
2065 of the string <filename>./</filename>. The script should return two
2066 integers in ASCII. The first should be the total disk space in blocks,
2067 and the second should be the number of available blocks. An optional
2068 third return value can give the block size in bytes. The default
2069 blocksize is 1024 bytes.</para>
2071 <para>Note: Your script should <emphasis>NOT</emphasis> be setuid or
2072 setgid and should be owned by (and writeable only by) root!</para>
2074 <para>Default: <emphasis>By default internal routines for
2075 determining the disk capacity and remaining space will be used.
2076 </emphasis></para>
2078 <para>Example: <command>dfree command = /usr/local/samba/bin/dfree
2079 </command></para>
2081 <para>Where the script dfree (which must be made executable) could be:</para>
2083 <para><programlisting>
2084 #!/bin/sh
2085 df $1 | tail -1 | awk '{print $2" "$4}'
2086 </programlisting></para>
2088 <para>or perhaps (on Sys V based systems):</para>
2090 <para><programlisting>
2091 #!/bin/sh
2092 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2093 </programlisting></para>
2095 <para>Note that you may have to replace the command names
2096 with full path names on some systems.</para>
2097 </listitem>
2098 </varlistentry>
2103 <varlistentry>
2104 <term><anchor id="DIRECTORY">directory (S)</term>
2105 <listitem><para>Synonym for <link linkend="PATH"><parameter>path
2106 </parameter></link>.</para></listitem>
2107 </varlistentry>
2111 <varlistentry>
2112 <term><anchor id="DIRECTORYMASK">directory mask (S)</term>
2113 <listitem><para>This parameter is the octal modes which are
2114 used when converting DOS modes to UNIX modes when creating UNIX
2115 directories.</para>
2117 <para>When a directory is created, the necessary permissions are
2118 calculated according to the mapping from DOS modes to UNIX permissions,
2119 and the resulting UNIX mode is then bit-wise 'AND'ed with this
2120 parameter. This parameter may be thought of as a bit-wise MASK for
2121 the UNIX modes of a directory. Any bit <emphasis>not</emphasis> set
2122 here will be removed from the modes set on a directory when it is
2123 created.</para>
2125 <para>The default value of this parameter removes the 'group'
2126 and 'other' write bits from the UNIX mode, allowing only the
2127 user who owns the directory to modify it.</para>
2129 <para>Following this Samba will bit-wise 'OR' the UNIX mode
2130 created from this parameter with the value of the <link
2131 linkend="FORCEDIRECTORYMODE"><parameter>force directory mode
2132 </parameter></link> parameter. This parameter is set to 000 by
2133 default (i.e. no extra mode bits are added).</para>
2135 <para>Note that by default this parameter does not apply to permissions
2136 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2137 this mask on access control lists also, they need to set the <link
2138 linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with
2139 mask</parameter></link> to true.</para>
2141 <para>See the <link linkend="FORCEDIRECTORYMODE"><parameter>force
2142 directory mode</parameter></link> parameter to cause particular mode
2143 bits to always be set on created directories.</para>
2145 <para>See also the <link linkend="CREATEMODE"><parameter>create mode
2146 </parameter></link> parameter for masking mode bits on created files,
2147 and the <link linkend="DIRECTORYSECURITYMASK"><parameter>directory
2148 security mask</parameter></link> parameter.</para>
2150 <para>Also refer to the <link linkend="INHERITPERMISSIONS"><parameter>
2151 inherit permissions</parameter></link> parameter.</para>
2153 <para>Default: <command>directory mask = 0755</command></para>
2154 <para>Example: <command>directory mask = 0775</command></para>
2155 </listitem>
2156 </varlistentry>
2160 <varlistentry>
2161 <term><anchor id="DIRECTORYMODE">directory mode (S)</term>
2162 <listitem><para>Synonym for <link linkend="DIRECTORYMASK"><parameter>
2163 directory mask</parameter></link></para></listitem>
2164 </varlistentry>
2168 <varlistentry>
2169 <term><anchor id="DIRECTORYSECURITYMASK">directory security mask (S)</term>
2170 <listitem><para>This parameter controls what UNIX permission bits
2171 can be modified when a Windows NT client is manipulating the UNIX
2172 permission on a directory using the native NT security dialog
2173 box.</para>
2175 <para>This parameter is applied as a mask (AND'ed with) to
2176 the changed permission bits, thus preventing any bits not in
2177 this mask from being modified. Essentially, zero bits in this
2178 mask may be treated as a set of bits the user is not allowed
2179 to change.</para>
2181 <para>If not set explicitly this parameter is set to the same
2182 value as the <link linkend="DIRECTORYMASK"><parameter>directory
2183 mask</parameter></link> parameter. To allow a user to
2184 modify all the user/group/world permissions on a directory, set
2185 this parameter to 0777.</para>
2187 <para><emphasis>Note</emphasis> that users who can access the
2188 Samba server through other means can easily bypass this restriction,
2189 so it is primarily useful for standalone "appliance" systems.
2190 Administrators of most normal systems will probably want to set
2191 it to 0777.</para>
2193 <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>
2194 force directory security mode</parameter></link>, <link
2195 linkend="SECURITYMASK"><parameter>security mask</parameter></link>,
2196 <link linkend="FORCESECURITYMODE"><parameter>force security mode
2197 </parameter></link> parameters.</para>
2199 <para>Default: <command>directory security mask = &lt;same as
2200 directory mask&gt;</command></para>
2201 <para>Example: <command>directory security mask = 0777</command></para>
2202 </listitem>
2203 </varlistentry>
2207 <varlistentry>
2208 <term><anchor id="DNSPROXY">dns proxy (G)</term>
2209 <listitem><para>Specifies that <ulink url="nmbd.8.html">nmbd(8)</ulink>
2210 when acting as a WINS server and finding that a NetBIOS name has not
2211 been registered, should treat the NetBIOS name word-for-word as a DNS
2212 name and do a lookup with the DNS server for that name on behalf of
2213 the name-querying client.</para>
2215 <para>Note that the maximum length for a NetBIOS name is 15
2216 characters, so the DNS name (or DNS alias) can likewise only be
2217 15 characters, maximum.</para>
2219 <para><command>nmbd</command> spawns a second copy of itself to do the
2220 DNS name lookup requests, as doing a name lookup is a blocking
2221 action.</para>
2223 <para>See also the parameter <link linkend="WINSSUPPORT"><parameter>
2224 wins support</parameter></link>.</para>
2226 <para>Default: <command>dns proxy = yes</command></para></listitem>
2227 </varlistentry>
2231 <varlistentry>
2232 <term><anchor id="DOMAINADMINGROUP">domain admin group (G)</term>
2233 <listitem><para>This is an <emphasis>EXPERIMENTAL</emphasis> parameter
2234 that is part of the unfinished Samba NT Domain Controller Code. It may
2235 be removed in a later release. To work with the latest code builds
2236 that may have more support for Samba NT Domain Controller functionality
2237 please subscribe to the mailing list <ulink
2238 url="mailto:samba-ntdom@samba.org">samba-ntdom</ulink> available by
2239 visiting the web page at <ulink url="http://lists.samba.org/">
2240 http://lists.samba.org/</ulink>.</para></listitem>
2241 </varlistentry>
2244 <varlistentry>
2245 <term><anchor id="DOMAINADMINUSERS">domain admin users (G)</term>
2246 <listitem><para>This is an <emphasis>EXPERIMENTAL</emphasis> parameter
2247 that is part of the unfinished Samba NT Domain Controller Code. It may
2248 be removed in a later release. To work with the latest code builds
2249 that may have more support for Samba NT Domain Controller functionality
2250 please subscribe to the mailing list <ulink
2251 url="mailto:samba-ntdom@samba.org">samba-ntdom</ulink> available by
2252 visiting the web page at <ulink url="http://lists.samba.org/">
2253 http://lists.samba.org/</ulink>.</para></listitem>
2254 </varlistentry>
2257 <varlistentry>
2258 <term><anchor id="DOMAINGROUPS">domain groups (G)</term>
2259 <listitem><para>This is an <emphasis>EXPERIMENTAL</emphasis> parameter
2260 that is part of the unfinished Samba NT Domain Controller Code. It may
2261 be removed in a later release. To work with the latest code builds
2262 that may have more support for Samba NT Domain Controller functionality
2263 please subscribe to the mailing list <ulink
2264 url="mailto:samba-ntdom@samba.org">samba-ntdom</ulink> available by
2265 visiting the web page at <ulink url="http://lists.samba.org/">
2266 http://lists.samba.org/</ulink>.</para></listitem>
2267 </varlistentry>
2271 <varlistentry>
2272 <term><anchor id="DOMAINGUESTGROUP">domain guest group (G)</term>
2273 <listitem><para>This is an <emphasis>EXPERIMENTAL</emphasis> parameter
2274 that is part of the unfinished Samba NT Domain Controller Code. It may
2275 be removed in a later release. To work with the latest code builds
2276 that may have more support for Samba NT Domain Controller functionality
2277 please subscribe to the mailing list <ulink
2278 url="mailto:samba-ntdom@samba.org">samba-ntdom</ulink> available by
2279 visiting the web page at <ulink url="http://lists.samba.org/">
2280 http://lists.samba.org/</ulink>.</para></listitem>
2281 </varlistentry>
2284 <varlistentry>
2285 <term><anchor id="DOMAINGUESTUSERS">domain guest users (G)</term>
2286 <listitem><para>This is an <emphasis>EXPERIMENTAL</emphasis> parameter
2287 that is part of the unfinished Samba NT Domain Controller Code. It may
2288 be removed in a later release. To work with the latest code builds
2289 that may have more support for Samba NT Domain Controller functionality
2290 please subscribe to the mailing list <ulink
2291 url="mailto:samba-ntdom@samba.org">samba-ntdom</ulink> available by
2292 visiting the web page at <ulink url="http://lists.samba.org/">
2293 http://lists.samba.org/</ulink>.</para></listitem>
2294 </varlistentry>
2297 <varlistentry>
2298 <term><anchor id="DOMAINLOGONS">domain logons (G)</term>
2299 <listitem><para>If set to true, the Samba server will serve
2300 Windows 95/98 Domain logons for the <link linkend="WORKGROUP">
2301 <parameter>workgroup</parameter></link> it is in. Samba 2.2 also
2302 has limited capability to act as a domain controller for Windows
2303 NT 4 Domains. For more details on setting up this feature see
2304 the file DOMAINS.txt in the Samba documentation directory <filename>docs/
2305 </filename> shipped with the source code.</para>
2307 <para>Default: <command>domain logons = no</command></para></listitem>
2308 </varlistentry>
2312 <varlistentry>
2313 <term><anchor id="DOMAINMASTER">domain master (G)</term>
2314 <listitem><para>Tell <ulink url="nmbd.8.html"><command>
2315 nmbd(8)</command></ulink> to enable WAN-wide browse list
2316 collation. Setting this option causes <command>nmbd</command> to
2317 claim a special domain specific NetBIOS name that identifies
2318 it as a domain master browser for its given <link linkend="WORKGROUP">
2319 <parameter>workgroup</parameter></link>. Local master browsers
2320 in the same <parameter>workgroup</parameter> on broadcast-isolated
2321 subnets will give this <command>nmbd</command> their local browse lists,
2322 and then ask <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
2323 for a complete copy of the browse list for the whole wide area
2324 network. Browser clients will then contact their local master browser,
2325 and will receive the domain-wide browse list, instead of just the list
2326 for their broadcast-isolated subnet.</para>
2328 <para>Note that Windows NT Primary Domain Controllers expect to be
2329 able to claim this <parameter>workgroup</parameter> specific special
2330 NetBIOS name that identifies them as domain master browsers for
2331 that <parameter>workgroup</parameter> by default (i.e. there is no
2332 way to prevent a Windows NT PDC from attempting to do this). This
2333 means that if this parameter is set and <command>nmbd</command> claims
2334 the special name for a <parameter>workgroup</parameter> before a Windows
2335 NT PDC is able to do so then cross subnet browsing will behave
2336 strangely and may fail.</para>
2338 <para>If <link linkend="DOMAINLOGONS"><command>domain logons = yes</command>
2339 </link>, then the default behavior is to enable the <parameter>domain
2340 master</parameter> parameter. If <parameter>domain logons</parameter> is
2341 not enabled (the default setting), then neither will <parameter>domain
2342 master</parameter> be enabled by default.</para>
2344 <para>Default: <command>domain master = auto</command></para></listitem>
2345 </varlistentry>
2350 <varlistentry>
2351 <term><anchor id="DONTDESCEND">dont descend (S)</term>
2352 <listitem><para>There are certain directories on some systems
2353 (e.g., the <filename>/proc</filename> tree under Linux) that are either not
2354 of interest to clients or are infinitely deep (recursive). This
2355 parameter allows you to specify a comma-delimited list of directories
2356 that the server should always show as empty.</para>
2358 <para>Note that Samba can be very fussy about the exact format
2359 of the "dont descend" entries. For example you may need <filename>
2360 ./proc</filename> instead of just <filename>/proc</filename>.
2361 Experimentation is the best policy :-) </para>
2363 <para>Default: <emphasis>none (i.e., all directories are OK
2364 to descend)</emphasis></para>
2365 <para>Example: <command>dont descend = /proc,/dev</command></para>
2366 </listitem>
2367 </varlistentry>
2371 <varlistentry>
2372 <term><anchor id="DOSFILEMODE">dos filemode (S)</term>
2373 <listitem><para> The default behavior in Samba is to provide
2374 UNIX-like behavor where only the owner of a file/directory is
2375 able to change the permissions on it. However, this behavior
2376 is often confusing to DOS/Windows users. Enabling this parameter
2377 allows a user who has write access to the file (by whatever
2378 means) to modify the permissions on it. Note that a user
2379 belonging to the group owning the file will not be allowed to
2380 change permissions if the group is only granted read access.
2381 Ownership of the file/directory is not changed, only the permissions
2382 are modified.</para>
2384 <para>Default: <command>dos filemode = no</command></para>
2385 </listitem>
2386 </varlistentry>
2390 <varlistentry>
2391 <term><anchor id="DOSFILETIMERESOLUTION">dos filetime resolution (S)</term>
2392 <listitem><para>Under the DOS and Windows FAT filesystem, the finest
2393 granularity on time resolution is two seconds. Setting this parameter
2394 for a share causes Samba to round the reported time down to the
2395 nearest two second boundary when a query call that requires one second
2396 resolution is made to <ulink url="smbd.8.html"><command>smbd(8)</command>
2397 </ulink>.</para>
2399 <para>This option is mainly used as a compatibility option for Visual
2400 C++ when used against Samba shares. If oplocks are enabled on a
2401 share, Visual C++ uses two different time reading calls to check if a
2402 file has changed since it was last read. One of these calls uses a
2403 one-second granularity, the other uses a two second granularity. As
2404 the two second call rounds any odd second down, then if the file has a
2405 timestamp of an odd number of seconds then the two timestamps will not
2406 match and Visual C++ will keep reporting the file has changed. Setting
2407 this option causes the two timestamps to match, and Visual C++ is
2408 happy.</para>
2410 <para>Default: <command>dos filetime resolution = no</command></para>
2411 </listitem>
2412 </varlistentry>
2416 <varlistentry>
2417 <term><anchor id="DOSFILETIMES">dos filetimes (S)</term>
2418 <listitem><para>Under DOS and Windows, if a user can write to a
2419 file they can change the timestamp on it. Under POSIX semantics,
2420 only the owner of the file or root may change the timestamp. By
2421 default, Samba runs with POSIX semantics and refuses to change the
2422 timestamp on a file if the user <command>smbd</command> is acting
2423 on behalf of is not the file owner. Setting this option to <constant>
2424 True</constant> allows DOS semantics and smbd will change the file
2425 timestamp as DOS requires.</para>
2427 <para>Default: <command>dos filetimes = no</command></para></listitem>
2428 </varlistentry>
2432 <varlistentry>
2433 <term><anchor id="ENCRYPTPASSWORDS">encrypt passwords (G)</term>
2434 <listitem><para>This boolean controls whether encrypted passwords
2435 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
2436 above and also Windows 98 will by default expect encrypted passwords
2437 unless a registry entry is changed. To use encrypted passwords in
2438 Samba see the file ENCRYPTION.txt in the Samba documentation
2439 directory <filename>docs/</filename> shipped with the source code.</para>
2441 <para>In order for encrypted passwords to work correctly
2442 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink> must either
2443 have access to a local <ulink url="smbpasswd.5.html"><filename>smbpasswd(5)
2444 </filename></ulink> file (see the <ulink url="smbpasswd.8.html"><command>
2445 smbpasswd(8)</command></ulink> program for information on how to set up
2446 and maintain this file), or set the <link
2447 linkend="SECURITY">security=[serve|domain]</link> parameter which
2448 causes <command>smbd</command> to authenticate against another
2449 server.</para>
2451 <para>Default: <command>encrypt passwords = no</command></para></listitem>
2452 </varlistentry>
2455 <varlistentry>
2456 <term><anchor id="ENHANCEDBROWSING">enhanced browsing (G)</term>
2457 <listitem><para>This option enables a couple of enhancements to
2458 cross-subnet browse propogation that have been added in Samba
2459 but which are not standard in Microsoft implementations.
2460 <emphasis>These enhancements are currently only available in
2461 the HEAD Samba CVS tree (not Samba 2.2.x).</emphasis></para>
2463 <para>The first enhancement to browse propogation consists of a regular
2464 wildcard query to a Samba WINS server for all Domain Master Browsers,
2465 followed by a browse synchronisation with each of the returned
2466 DMBs. The second enhancement consists of a regular randomised browse
2467 synchronisation with all currently known DMBs.</para>
2469 <para>You may wish to disable this option if you have a problem with empty
2470 workgroups not disappearing from browse lists. Due to the restrictions
2471 of the browse protocols these enhancements can cause a empty workgroup
2472 to stay around forever which can be annoying.</para>
2474 <para>In general you should leave this option enabled as it makes
2475 cross-subnet browse propogation much more reliable.</para>
2477 <para>Default: <command>enhanced browsing = yes</command></para>
2478 </listitem>
2479 </varlistentry>
2482 <varlistentry>
2483 <term><anchor id="ENUMPORTSCOMMAND">enumports command (G)</term>
2484 <listitem><para>The concept of a "port" is fairly foreign
2485 to UNIX hosts. Under Windows NT/2000 print servers, a port
2486 is associated with a port monitor and generally takes the form of
2487 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
2488 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
2489 port defined--<constant>"Samba Printer Port"</constant>. Under
2490 Windows NT/2000, all printers must have a valid port name.
2491 If you wish to have a list of ports displayed (<command>smbd
2492 </command> does not use a port name for anything) other than
2493 the default <constant>"Samba Printer Port"</constant>, you
2494 can define <parameter>enumports command</parameter> to point to
2495 a program which should generate a list of ports, one per line,
2496 to standard output. This listing will then be used in response
2497 to the level 1 and 2 EnumPorts() RPC.</para>
2499 <para>Default: <emphasis>no enumports command</emphasis></para>
2500 <para>Example: <command>enumports command = /usr/bin/listports
2501 </command></para>
2502 </listitem>
2503 </varlistentry>
2505 <varlistentry>
2506 <term><anchor id="EXEC">exec (S)</term>
2507 <listitem><para>This is a synonym for <link linkend="PREEXEC">
2508 <parameter>preexec</parameter></link>.</para></listitem>
2509 </varlistentry>
2513 <varlistentry>
2514 <term><anchor id="FAKEDIRECTORYCREATETIMES">fake directory create times (S)</term>
2515 <listitem><para>NTFS and Windows VFAT file systems keep a create
2516 time for all files and directories. This is not the same as the
2517 ctime - status change time - that Unix keeps, so Samba by default
2518 reports the earliest of the various times Unix does keep. Setting
2519 this parameter for a share causes Samba to always report midnight
2520 1-1-1980 as the create time for directories.</para>
2522 <para>This option is mainly used as a compatibility option for
2523 Visual C++ when used against Samba shares. Visual C++ generated
2524 makefiles have the object directory as a dependency for each object
2525 file, and a make rule to create the directory. Also, when NMAKE
2526 compares timestamps it uses the creation time when examining a
2527 directory. Thus the object directory will be created if it does not
2528 exist, but once it does exist it will always have an earlier
2529 timestamp than the object files it contains.</para>
2531 <para>However, Unix time semantics mean that the create time
2532 reported by Samba will be updated whenever a file is created or
2533 or deleted in the directory. NMAKE finds all object files in
2534 the object directory. The timestamp of the last one built is then
2535 compared to the timestamp of the object dircetory. If the
2536 directory's timestamp if newer, then all object files
2537 will be rebuilt. Enabling this option
2538 ensures directories always predate their contents and an NMAKE build
2539 will proceed as expected.</para>
2541 <para>Default: <command>fake directory create times = no</command></para>
2542 </listitem>
2543 </varlistentry>
2547 <varlistentry>
2548 <term><anchor id="FAKEOPLOCKS">fake oplocks (S)</term>
2549 <listitem><para>Oplocks are the way that SMB clients get permission
2550 from a server to locally cache file operations. If a server grants
2551 an oplock (opportunistic lock) then the client is free to assume
2552 that it is the only one accessing the file and it will aggressively
2553 cache file data. With some oplock types the client may even cache
2554 file open/close operations. This can give enormous performance benefits.
2555 </para>
2557 <para>When you set <command>fake oplocks = yes</command>, <ulink
2558 url="smbd.8.html"><command>smbd(8)</command></ulink> will
2559 always grant oplock requests no matter how many clients are using
2560 the file.</para>
2562 <para>It is generally much better to use the real <link
2563 linkend="OPLOCKS"><parameter>oplocks</parameter></link> support rather
2564 than this parameter.</para>
2566 <para>If you enable this option on all read-only shares or
2567 shares that you know will only be accessed from one client at a
2568 time such as physically read-only media like CDROMs, you will see
2569 a big performance improvement on many operations. If you enable
2570 this option on shares where multiple clients may be accessing the
2571 files read-write at the same time you can get data corruption. Use
2572 this option carefully!</para>
2574 <para>Default: <command>fake oplocks = no</command></para></listitem>
2575 </varlistentry>
2579 <varlistentry>
2580 <term><anchor id="FOLLOWSYMLINKS">follow symlinks (S)</term>
2581 <listitem><para>This parameter allows the Samba administrator
2582 to stop <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
2583 from following symbolic links in a particular share. Setting this
2584 parameter to <constant>no</constant> prevents any file or directory
2585 that is a symbolic link from being followed (the user will get an
2586 error). This option is very useful to stop users from adding a
2587 symbolic link to <filename>/etc/passwd</filename> in their home
2588 directory for instance. However it will slow filename lookups
2589 down slightly.</para>
2591 <para>This option is enabled (i.e. <command>smbd</command> will
2592 follow symbolic links) by default.</para>
2594 <para>Default: <command>follow symlinks = yes</command></para></listitem>
2595 </varlistentry>
2599 <varlistentry>
2600 <term><anchor id="FORCECREATEMODE">force create mode (S)</term>
2601 <listitem><para>This parameter specifies a set of UNIX mode bit
2602 permissions that will <emphasis>always</emphasis> be set on a
2603 file created by Samba. This is done by bitwise 'OR'ing these bits onto
2604 the mode bits of a file that is being created or having its
2605 permissions changed. The default for this parameter is (in octal)
2606 000. The modes in this parameter are bitwise 'OR'ed onto the file
2607 mode after the mask set in the <parameter>create mask</parameter>
2608 parameter is applied.</para>
2610 <para>Note that by default this parameter does not apply to permissions
2611 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2612 this mask on access control lists also, they need to set the <link
2613 linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with
2614 mask</parameter></link> to true.</para>
2616 <para>See also the parameter <link linkend="CREATEMASK"><parameter>create
2617 mask</parameter></link> for details on masking mode bits on files.</para>
2619 <para>See also the <link linkend="INHERITPERMISSIONS"><parameter>inherit
2620 permissions</parameter></link> parameter.</para>
2622 <para>Default: <command>force create mode = 000</command></para>
2623 <para>Example: <command>force create mode = 0755</command></para>
2625 <para>would force all created files 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="FORCEDIRECTORYMODE">force directory mode (S)</term>
2635 <listitem><para>This parameter specifies a set of UNIX mode bit
2636 permissions that will <emphasis>always</emphasis> be set on a directory
2637 created by Samba. This is done by bitwise 'OR'ing these bits onto the
2638 mode bits of a directory that is being created. The default for this
2639 parameter is (in octal) 0000 which will not add any extra permission
2640 bits to a created directory. This operation is done after the mode
2641 mask in the parameter <parameter>directory mask</parameter> is
2642 applied.</para>
2644 <para>Note that by default this parameter does not apply to permissions
2645 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
2646 this mask on access control lists also, they need to set the <link
2647 linkend="RESTRICTACLWITHMASK"><parameter>restrict acl with
2648 mask</parameter></link> to true.</para>
2650 <para>See also the parameter <link linkend="DIRECTORYMASK"><parameter>
2651 directory mask</parameter></link> for details on masking mode bits
2652 on created directories.</para>
2654 <para>See also the <link linkend="INHERITPERMISSIONS"><parameter>
2655 inherit permissions</parameter></link> parameter.</para>
2657 <para>Default: <command>force directory mode = 000</command></para>
2658 <para>Example: <command>force directory mode = 0755</command></para>
2660 <para>would force all created directories to have read and execute
2661 permissions set for 'group' and 'other' as well as the
2662 read/write/execute bits set for the 'user'.</para>
2663 </listitem>
2664 </varlistentry>
2668 <varlistentry>
2669 <term><anchor id="FORCEDIRECTORYSECURITYMODE">force directory
2670 security mode (S)</term>
2671 <listitem><para>This parameter controls what UNIX permission bits
2672 can be modified when a Windows NT client is manipulating the UNIX
2673 permission on a directory using the native NT security dialog box.</para>
2675 <para>This parameter is applied as a mask (OR'ed with) to the
2676 changed permission bits, thus forcing any bits in this mask that
2677 the user may have modified to be on. Essentially, one bits in this
2678 mask may be treated as a set of bits that, when modifying security
2679 on a directory, the user has always set to be 'on'.</para>
2681 <para>If not set explicitly this parameter is set to the same
2682 value as the <link linkend="FORCEDIRECTORYMODE"><parameter>force
2683 directory mode</parameter></link> parameter. To allow
2684 a user to modify all the user/group/world permissions on a
2685 directory without restrictions, set this parameter to 000.</para>
2687 <para><emphasis>Note</emphasis> that users who can access the
2688 Samba server through other means can easily bypass this restriction,
2689 so it is primarily useful for standalone "appliance" systems.
2690 Administrators of most normal systems will probably want to set
2691 it to 0000.</para>
2693 <para>See also the <link linkend="DIRECTORYSECURITYMASK"><parameter>
2694 directory security mask</parameter></link>, <link linkend="SECURITYMASK">
2695 <parameter>security mask</parameter></link>,
2696 <link linkend="FORCESECURITYMODE"><parameter>force security mode
2697 </parameter></link> parameters.</para>
2699 <para>Default: <command>force directory security mode = &lt;same as
2700 force directory mode&gt;</command></para>
2701 <para>Example: <command>force directory security mode = 0</command></para>
2702 </listitem>
2703 </varlistentry>
2708 <varlistentry>
2709 <term><anchor id="FORCEGROUP">force group (S)</term>
2710 <listitem><para>This specifies a UNIX group name that will be
2711 assigned as the default primary group for all users connecting
2712 to this service. This is useful for sharing files by ensuring
2713 that all access to files on service will use the named group for
2714 their permissions checking. Thus, by assigning permissions for this
2715 group to the files and directories within this service the Samba
2716 administrator can restrict or allow sharing of these files.</para>
2718 <para>In Samba 2.0.5 and above this parameter has extended
2719 functionality in the following way. If the group name listed here
2720 has a '+' character prepended to it then the current user accessing
2721 the share only has the primary group default assigned to this group
2722 if they are already assigned as a member of that group. This allows
2723 an administrator to decide that only users who are already in a
2724 particular group will create files with group ownership set to that
2725 group. This gives a finer granularity of ownership assignment. For
2726 example, the setting <filename>force group = +sys</filename> means
2727 that only users who are already in group sys will have their default
2728 primary group assigned to sys when accessing this Samba share. All
2729 other users will retain their ordinary primary group.</para>
2731 <para>If the <link linkend="FORCEUSER"><parameter>force user
2732 </parameter></link> parameter is also set the group specified in
2733 <parameter>force group</parameter> will override the primary group
2734 set in <parameter>force user</parameter>.</para>
2736 <para>See also <link linkend="FORCEUSER"><parameter>force
2737 user</parameter></link>.</para>
2739 <para>Default: <emphasis>no forced group</emphasis></para>
2740 <para>Example: <command>force group = agroup</command></para>
2741 </listitem>
2742 </varlistentry>
2746 <varlistentry>
2747 <term><anchor id="FORCESECURITYMODE">force security mode (S)</term>
2748 <listitem><para>This parameter controls what UNIX permission
2749 bits can be modified when a Windows NT client is manipulating
2750 the UNIX permission on a file using the native NT security dialog
2751 box.</para>
2753 <para>This parameter is applied as a mask (OR'ed with) to the
2754 changed permission bits, thus forcing any bits in this mask that
2755 the user may have modified to be on. Essentially, one bits in this
2756 mask may be treated as a set of bits that, when modifying security
2757 on a file, the user has always set to be 'on'.</para>
2759 <para>If not set explicitly this parameter is set to the same
2760 value as the <link linkend="FORCECREATEMODE"><parameter>force
2761 create mode</parameter></link> parameter. To allow a user to
2762 modify all the user/group/world permissions on a file, with no
2763 restrictions set this parameter to 000.</para>
2765 <para><emphasis>Note</emphasis> that users who can access
2766 the Samba server through other means can easily bypass this restriction,
2767 so it is primarily useful for standalone "appliance" systems.
2768 Administrators of most normal systems will probably want to set
2769 it to 0000.</para>
2771 <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE"><parameter>
2772 force directory security mode</parameter></link>,
2773 <link linkend="DIRECTORYSECURITYMASK"><parameter>directory security
2774 mask</parameter></link>, <link linkend="SECURITYMASK"><parameter>
2775 security mask</parameter></link> parameters.</para>
2777 <para>Default: <command>force security mode = &lt;same as force
2778 create mode&gt;</command></para>
2779 <para>Example: <command>force security mode = 0</command></para>
2780 </listitem>
2781 </varlistentry>
2785 <varlistentry>
2786 <term><anchor id="FORCEUSER">force user (S)</term>
2787 <listitem><para>This specifies a UNIX user name that will be
2788 assigned as the default user for all users connecting to this service.
2789 This is useful for sharing files. You should also use it carefully
2790 as using it incorrectly can cause security problems.</para>
2792 <para>This user name only gets used once a connection is established.
2793 Thus clients still need to connect as a valid user and supply a
2794 valid password. Once connected, all file operations will be performed
2795 as the "forced user", no matter what username the client connected
2796 as. This can be very useful.</para>
2798 <para>In Samba 2.0.5 and above this parameter also causes the
2799 primary group of the forced user to be used as the primary group
2800 for all file activity. Prior to 2.0.5 the primary group was left
2801 as the primary group of the connecting user (this was a bug).</para>
2803 <para>See also <link linkend="FORCEGROUP"><parameter>force group
2804 </parameter></link></para>
2806 <para>Default: <emphasis>no forced user</emphasis></para>
2807 <para>Example: <command>force user = auser</command></para>
2808 </listitem>
2809 </varlistentry>
2813 <varlistentry>
2814 <term><anchor id="FSTYPE">fstype (S)</term>
2815 <listitem><para>This parameter allows the administrator to
2816 configure the string that specifies the type of filesystem a share
2817 is using that is reported by <ulink url="smbd.8.html"><command>smbd(8)
2818 </command></ulink> when a client queries the filesystem type
2819 for a share. The default type is <constant>NTFS</constant> for
2820 compatibility with Windows NT but this can be changed to other
2821 strings such as <constant>Samba</constant> or <constant>FAT
2822 </constant> if required.</para>
2824 <para>Default: <command>fstype = NTFS</command></para>
2825 <para>Example: <command>fstype = Samba</command></para></listitem>
2826 </varlistentry>
2830 <varlistentry>
2831 <term><anchor id="GETWDCACHE">getwd cache (G)</term>
2832 <listitem><para>This is a tuning option. When this is enabled a
2833 caching algorithm will be used to reduce the time taken for getwd()
2834 calls. This can have a significant impact on performance, especially
2835 when the <link linkend="WIDELINKS"><parameter>wide links</parameter>
2836 </link>parameter is set to <constant>False</constant>.</para>
2838 <para>Default: <command>getwd cache = yes</command></para>
2839 </listitem>
2840 </varlistentry>
2844 <varlistentry>
2845 <term><anchor id="GROUP">group (S)</term>
2846 <listitem><para>Synonym for <link linkend="FORCEGROUP"><parameter>force
2847 group</parameter></link>.</para></listitem>
2848 </varlistentry>
2852 <varlistentry>
2853 <term><anchor id="GUESTACCOUNT">guest account (S)</term>
2854 <listitem><para>This is a username which will be used for access
2855 to services which are specified as <link linkend="GUESTOK"><parameter>
2856 guest ok</parameter></link> (see below). Whatever privileges this
2857 user has will be available to any client connecting to the guest service.
2858 Typically this user will exist in the password file, but will not
2859 have a valid login. The user account "ftp" is often a good choice
2860 for this parameter. If a username is specified in a given service,
2861 the specified username overrides this one.</para>
2863 <para>One some systems the default guest account "nobody" may not
2864 be able to print. Use another account in this case. You should test
2865 this by trying to log in as your guest user (perhaps by using the
2866 <command>su -</command> command) and trying to print using the
2867 system print command such as <command>lpr(1)</command> or <command>
2868 lp(1)</command>.</para>
2870 <para>Default: <emphasis>specified at compile time, usually
2871 "nobody"</emphasis></para>
2873 <para>Example: <command>guest account = ftp</command></para></listitem>
2874 </varlistentry>
2878 <varlistentry>
2879 <term><anchor id="GUESTOK">guest ok (S)</term>
2880 <listitem><para>If this parameter is <constant>yes</constant> for
2881 a service, then no password is required to connect to the service.
2882 Privileges will be those of the <link linkend="GUESTACCOUNT"><parameter>
2883 guest account</parameter></link>.</para>
2885 <para>See the section below on <link linkend="SECURITY"><parameter>
2886 security</parameter></link> for more information about this option.
2887 </para>
2889 <para>Default: <command>guest ok = no</command></para></listitem>
2890 </varlistentry>
2894 <varlistentry>
2895 <term><anchor id="GUESTONLY">guest only (S)</term>
2896 <listitem><para>If this parameter is <constant>yes</constant> for
2897 a service, then only guest connections to the service are permitted.
2898 This parameter will have no effect if <link linkend="GUESTOK">
2899 <parameter>guest ok</parameter></link> is not set for the service.</para>
2901 <para>See the section below on <link linkend="SECURITY"><parameter>
2902 security</parameter></link> for more information about this option.
2903 </para>
2905 <para>Default: <command>guest only = no</command></para></listitem>
2906 </varlistentry>
2910 <varlistentry>
2911 <term><anchor id="HIDEDOTFILES">hide dot files (S)</term>
2912 <listitem><para>This is a boolean parameter that controls whether
2913 files starting with a dot appear as hidden files.</para>
2915 <para>Default: <command>hide dot files = yes</command></para></listitem>
2916 </varlistentry>
2920 <varlistentry>
2921 <term><anchor id="HIDEFILES">hide files(S)</term>
2922 <listitem><para>This is a list of files or directories that are not
2923 visible but are accessible. The DOS 'hidden' attribute is applied
2924 to any files or directories that match.</para>
2926 <para>Each entry in the list must be separated by a '/',
2927 which allows spaces to be included in the entry. '*'
2928 and '?' can be used to specify multiple files or directories
2929 as in DOS wildcards.</para>
2931 <para>Each entry must be a Unix path, not a DOS path and must
2932 not include the Unix directory separator '/'.</para>
2934 <para>Note that the case sensitivity option is applicable
2935 in hiding files.</para>
2937 <para>Setting this parameter will affect the performance of Samba,
2938 as it will be forced to check all files and directories for a match
2939 as they are scanned.</para>
2941 <para>See also <link linkend="HIDEDOTFILES"><parameter>hide
2942 dot files</parameter></link>, <link linkend="VETOFILES"><parameter>
2943 veto files</parameter></link> and <link linkend="CASESENSITIVE">
2944 <parameter>case sensitive</parameter></link>.</para>
2946 <para>Default: <emphasis>no file are hidden</emphasis></para>
2947 <para>Example: <command>hide files =
2948 /.*/DesktopFolderDB/TrashFor%m/resource.frk/</command></para>
2950 <para>The above example is based on files that the Macintosh
2951 SMB client (DAVE) available from <ulink url="http://www.thursby.com">
2952 Thursby</ulink> creates for internal use, and also still hides
2953 all files beginning with a dot.</para></listitem>
2954 </varlistentry>
2958 <varlistentry>
2959 <term><anchor id="HIDELOCALUSERS">hide local users(G)</term>
2960 <listitem><para>This parameter toggles the hiding of local UNIX
2961 users (root, wheel, floppy, etc) from remote clients.</para>
2963 <para>Default: <command>hide local users = no</command></para></listitem>
2964 </varlistentry>
2968 <varlistentry>
2969 <term><anchor id="HOMEDIRMAP">homedir map (G)</term>
2970 <listitem><para>If<link linkend="NISHOMEDIR"><parameter>nis homedir
2971 </parameter></link> is <constant>True</constant>, and <ulink
2972 url="smbd.8.html"><command>smbd(8)</command></ulink> is also acting
2973 as a Win95/98 <parameter>logon server</parameter> then this parameter
2974 specifies the NIS (or YP) map from which the server for the user's
2975 home directory should be extracted. At present, only the Sun
2976 auto.home map format is understood. The form of the map is:</para>
2978 <para><command>username server:/some/file/system</command></para>
2980 <para>and the program will extract the servername from before
2981 the first ':'. There should probably be a better parsing system
2982 that copes with different map formats and also Amd (another
2983 automounter) maps.</para>
2985 <para><emphasis>NOTE :</emphasis>A working NIS client is required on
2986 the system for this option to work.</para>
2988 <para>See also <link linkend="NISHOMEDIR"><parameter>nis homedir</parameter>
2989 </link>, <link linkend="DOMAINLOGONS"><parameter>domain logons</parameter>
2990 </link>.</para>
2992 <para>Default: <command>homedir map = &lt;empty string&gt;</command></para>
2993 <para>Example: <command>homedir map = amd.homedir</command></para>
2994 </listitem>
2995 </varlistentry>
3001 <varlistentry>
3002 <term><anchor id="HOSTMSDFS">host msdfs (G)</term>
3003 <listitem><para>This boolean parameter is only available
3004 if Samba has been configured and compiled with the <command>
3005 --with-msdfs</command> option. If set to <constant>yes</constant>,
3006 Samba will act as a Dfs server, and allow Dfs-aware clients
3007 to browse Dfs trees hosted on the server.</para>
3009 <para>See also the <link linkend="MSDFSROOT"><parameter>
3010 msdfs root</parameter></link> share level parameter. For
3011 more information on setting up a Dfs tree on Samba,
3012 refer to <ulink url="msdfs_setup.html">msdfs_setup.html</ulink>.
3013 </para>
3015 <para>Default: <command>host msdfs = no</command></para>
3016 </listitem>
3017 </varlistentry>
3020 <varlistentry>
3021 <term><anchor id="HOSTSALLOW">hosts allow (S)</term>
3022 <listitem><para>A synonym for this parameter is <parameter>allow
3023 hosts</parameter>.</para>
3025 <para>This parameter is a comma, space, or tab delimited
3026 set of hosts which are permitted to access a service.</para>
3028 <para>If specified in the [global] section then it will
3029 apply to all services, regardless of whether the individual
3030 service has a different setting.</para>
3032 <para>You can specify the hosts by name or IP number. For
3033 example, you could restrict access to only the hosts on a
3034 Class C subnet with something like <command>allow hosts = 150.203.5.
3035 </command>. The full syntax of the list is described in the man
3036 page <filename>hosts_access(5)</filename>. Note that this man
3037 page may not be present on your system, so a brief description will
3038 be given here also.</para>
3040 <para>Note that the localhost address 127.0.0.1 will always
3041 be allowed access unless specifically denied by a <link
3042 linkend="HOSTSDENY"><parameter>hosts deny</parameter></link> option.</para>
3044 <para>You can also specify hosts by network/netmask pairs and
3045 by netgroup names if your system supports netgroups. The
3046 <emphasis>EXCEPT</emphasis> keyword can also be used to limit a
3047 wildcard list. The following examples may provide some help:</para>
3049 <para>Example 1: allow all IPs in 150.203.*.*; except one</para>
3051 <para><command>hosts allow = 150.203. EXCEPT 150.203.6.66</command></para>
3053 <para>Example 2: allow hosts that match the given network/netmask</para>
3055 <para><command>hosts allow = 150.203.15.0/255.255.255.0</command></para>
3057 <para>Example 3: allow a couple of hosts</para>
3059 <para><command>hosts allow = lapland, arvidsjaur</command></para>
3061 <para>Example 4: allow only hosts in NIS netgroup "foonet", but
3062 deny access from one particular host</para>
3064 <para><command>hosts allow = @foonet</command></para>
3066 <para><command>hosts deny = pirate</command></para>
3068 <para>Note that access still requires suitable user-level passwords.</para>
3070 <para>See <ulink url="testparm.1.html"><command>testparm(1)</command>
3071 </ulink> for a way of testing your host access to see if it does
3072 what you expect.</para>
3074 <para>Default: <emphasis>none (i.e., all hosts permitted access)
3075 </emphasis></para>
3077 <para>Example: <command>allow hosts = 150.203.5. myhost.mynet.edu.au
3078 </command></para>
3079 </listitem>
3080 </varlistentry>
3084 <varlistentry>
3085 <term><anchor id="HOSTSDENY">hosts deny (S)</term>
3086 <listitem><para>The opposite of <parameter>hosts allow</parameter>
3087 - hosts listed here are <emphasis>NOT</emphasis> permitted access to
3088 services unless the specific services have their own lists to override
3089 this one. Where the lists conflict, the <parameter>allow</parameter>
3090 list takes precedence.</para>
3092 <para>Default: <emphasis>none (i.e., no hosts specifically excluded)
3093 </emphasis></para>
3095 <para>Example: <command>hosts deny = 150.203.4. badhost.mynet.edu.au
3096 </command></para></listitem>
3097 </varlistentry>
3101 <varlistentry>
3102 <term><anchor id="HOSTSEQUIV">hosts equiv (G)</term>
3103 <listitem><para>If this global parameter is a non-null string,
3104 it specifies the name of a file to read for the names of hosts
3105 and users who will be allowed access without specifying a password.
3106 </para>
3108 <para>This is not be confused with <link linkend="HOSTSALLOW">
3109 <parameter>hosts allow</parameter></link> which is about hosts
3110 access to services and is more useful for guest services. <parameter>
3111 hosts equiv</parameter> may be useful for NT clients which will
3112 not supply passwords to samba.</para>
3114 <para><emphasis>NOTE :</emphasis> The use of <parameter>hosts equiv
3115 </parameter> can be a major security hole. This is because you are
3116 trusting the PC to supply the correct username. It is very easy to
3117 get a PC to supply a false username. I recommend that the
3118 <parameter>hosts equiv</parameter> option be only used if you really
3119 know what you are doing, or perhaps on a home network where you trust
3120 your spouse and kids. And only if you <emphasis>really</emphasis> trust
3121 them :-).</para>
3123 <para>Default: <emphasis>no host equivalences</emphasis></para>
3124 <para>Example: <command>hosts equiv = /etc/hosts.equiv</command></para>
3125 </listitem>
3126 </varlistentry>
3130 <varlistentry>
3131 <term><anchor id="INCLUDE">include (G)</term>
3132 <listitem><para>This allows you to include one config file
3133 inside another. The file is included literally, as though typed
3134 in place.</para>
3136 <para>It takes the standard substitutions, except <parameter>%u
3137 </parameter>, <parameter>%P</parameter> and <parameter>%S</parameter>.
3138 </para>
3140 <para>Default: <emphasis>no file included</emphasis></para>
3141 <para>Example: <command>include = /usr/local/samba/lib/admin_smb.conf
3142 </command></para></listitem>
3143 </varlistentry>
3147 <varlistentry>
3148 <term><anchor id="INHERITPERMISSIONS">inherit permissions (S)</term>
3149 <listitem><para>The permissions on new files and directories
3150 are normally governed by <link linkend="CREATEMASK"><parameter>
3151 create mask</parameter></link>, <link linkend="DIRECTORYMASK">
3152 <parameter>directory mask</parameter></link>, <link
3153 linkend="FORCECREATEMODE"><parameter>force create mode</parameter>
3154 </link> and <link linkend="FORCEDIRECTORYMODE"><parameter>force
3155 directory mode</parameter></link> but the boolean inherit
3156 permissions parameter overrides this.</para>
3158 <para>New directories inherit the mode of the parent directory,
3159 including bits such as setgid.</para>
3161 <para>New files inherit their read/write bits from the parent
3162 directory. Their execute bits continue to be determined by
3163 <link linkend="MAPARCHIVE"><parameter>map archive</parameter>
3164 </link>, <link linkend="MAPHIDDEN"><parameter>map hidden</parameter>
3165 </link> and <link linkend="MAPSYSTEM"><parameter>map system</parameter>
3166 </link> as usual.</para>
3168 <para>Note that the setuid bit is <emphasis>never</emphasis> set via
3169 inheritance (the code explicitly prohibits this).</para>
3171 <para>This can be particularly useful on large systems with
3172 many users, perhaps several thousand,to allow a single [homes]
3173 share to be used flexibly by each user.</para>
3175 <para>See also <link linkend="CREATEMASK"><parameter>create mask
3176 </parameter></link>, <link linkend="DIRECTORYMASK"><parameter>
3177 directory mask</parameter></link>, <link linkend="FORCECREATEMODE">
3178 <parameter>force create mode</parameter></link> and <link
3179 linkend="FORCEDIRECTORYMODE"><parameter>force directory mode</parameter>
3180 </link>.</para>
3182 <para>Default: <command>inherit permissions = no</command></para>
3183 </listitem>
3184 </varlistentry>
3188 <varlistentry>
3189 <term><anchor id="INTERFACES">interfaces (G)</term>
3190 <listitem><para>This option allows you to override the default
3191 network interfaces list that Samba will use for browsing, name
3192 registration and other NBT traffic. By default Samba will query
3193 the kernel for the list of all active interfaces and use any
3194 interfaces except 127.0.0.1 that are broadcast capable.</para>
3196 <para>The option takes a list of interface strings. Each string
3197 can be in any of the following forms:</para>
3199 <itemizedlist>
3200 <listitem><para>a network interface name (such as eth0).
3201 This may include shell-like wildcards so eth* will match
3202 any interface starting with the substring "eth"</para></listitem>
3204 <listitem><para>an IP address. In this case the netmask is
3205 determined from the list of interfaces obtained from the
3206 kernel</para></listitem>
3208 <listitem><para>an IP/mask pair. </para></listitem>
3210 <listitem><para>a broadcast/mask pair.</para></listitem>
3211 </itemizedlist>
3213 <para>The "mask" parameters can either be a bit length (such
3214 as 24 for a C class network) or a full netmask in dotted
3215 decimal form.</para>
3217 <para>The "IP" parameters above can either be a full dotted
3218 decimal IP address or a hostname which will be looked up via
3219 the OS's normal hostname resolution mechanisms.</para>
3221 <para>For example, the following line:</para>
3223 <para><command>interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
3224 </command></para>
3226 <para>would configure three network interfaces corresponding
3227 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
3228 The netmasks of the latter two interfaces would be set to 255.255.255.0.</para>
3230 <para>See also <link linkend="BINDINTERFACESONLY"><parameter>bind
3231 interfaces only</parameter></link>.</para>
3233 <para>Default: <emphasis>all active interfaces except 127.0.0.1
3234 that are broadcast capable</emphasis></para>
3235 </listitem>
3236 </varlistentry>
3240 <varlistentry>
3241 <term><anchor id="INVALIDUSERS">invalid users (S)</term>
3242 <listitem><para>This is a list of users that should not be allowed
3243 to login to this service. This is really a <emphasis>paranoid</emphasis>
3244 check to absolutely ensure an improper setting does not breach
3245 your security.</para>
3247 <para>A name starting with a '@' is interpreted as an NIS
3248 netgroup first (if your system supports NIS), and then as a UNIX
3249 group if the name was not found in the NIS netgroup database.</para>
3251 <para>A name starting with '+' is interpreted only
3252 by looking in the UNIX group database. A name starting with
3253 '&' is interpreted only by looking in the NIS netgroup database
3254 (this requires NIS to be working on your system). The characters
3255 '+' and '&' may be used at the start of the name in either order
3256 so the value <parameter>+&amp;group</parameter> means check the
3257 UNIX group database, followed by the NIS netgroup database, and
3258 the value <parameter>&+group"</parameter> means check the NIS
3259 netgroup database, followed by the UNIX group database (the
3260 same as the '@' prefix).</para>
3262 <para>The current servicename is substituted for <parameter>%S</parameter>.
3263 This is useful in the [homes] section.</para>
3265 <para>See also <link linkend="VALIDUSERS"><parameter>valid users
3266 </parameter></link>.</para>
3268 <para>Default: <emphasis>no invalid users</emphasis></para>
3269 <para>Example: <command>invalid users = root fred admin @wheel
3270 </command></para>
3271 </listitem>
3272 </varlistentry>
3276 <varlistentry>
3277 <term><anchor id="KEEPALIVE">keepalive (G)</term>
3278 <listitem><para>The value of the parameter (an integer) represents
3279 the number of seconds between <parameter>keepalive</parameter>
3280 packets. If this parameter is zero, no keepalive packets will be
3281 sent. Keepalive packets, if sent, allow the server to tell whether
3282 a client is still present and responding.</para>
3284 <para>Keepalives should, in general, not be needed if the socket
3285 being used has the SO_KEEPALIVE attribute set on it (see <link
3286 linkend="SOCKETOPTIONS"><parameter>socket options</parameter></link>).
3287 Basically you should only use this option if you strike difficulties.</para>
3289 <para>Default: <command>keepalive = 300</command></para>
3290 <para>Example: <command>keepalive = 600</command></para>
3291 </listitem>
3292 </varlistentry>
3296 <varlistentry>
3297 <term><anchor id="KERNELOPLOCKS">kernel oplocks (G)</term>
3298 <listitem><para>For UNIXes that support kernel based <link
3299 linkend="OPLOCKS"><parameter>oplocks</parameter></link>
3300 (currently only IRIX and the Linux 2.4 kernel), this parameter
3301 allows the use of them to be turned on or off.</para>
3303 <para>Kernel oplocks support allows Samba <parameter>oplocks
3304 </parameter> to be broken whenever a local UNIX process or NFS operation
3305 accesses a file that <ulink url="smbd.8.html"><command>smbd(8)</command>
3306 </ulink> has oplocked. This allows complete data consistency between
3307 SMB/CIFS, NFS and local file access (and is a <emphasis>very</emphasis>
3308 cool feature :-).</para>
3310 <para>This parameter defaults to <constant>on</constant> on systems
3311 that have the support, and <constant>off</constant> on systems that
3312 don't. You should never need to touch this parameter.</para>
3314 <para>See also the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
3315 </link> and <link linkend="LEVEL2OPLOCKS"><parameter>level2 oplocks
3316 </parameter></link> parameters.</para>
3318 <para>Default: <command>kernel oplocks = yes</command></para>
3319 </listitem>
3320 </varlistentry>
3325 <varlistentry>
3326 <term><anchor id="LANMANAUTH">lanman auth (G)</term>
3327 <listitem><para>This parameter determines whether or not smbd will
3328 attempt to authentication users using the LANMAN password hash.
3329 If disabled, only clients which support NT password hashes (e.g. Windows
3330 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
3331 network client) will be able to connect to the Samba host.</para>
3333 <para>Default : <command>lanman auth = yes</command></para>
3334 </listitem>
3335 </varlistentry>
3340 <varlistentry>
3341 <term><anchor id="LEVEL2OPLOCKS">level2 oplocks (S)</term>
3342 <listitem><para>This parameter controls whether Samba supports
3343 level2 (read-only) oplocks on a share.</para>
3345 <para>Level2, or read-only oplocks allow Windows NT clients
3346 that have an oplock on a file to downgrade from a read-write oplock
3347 to a read-only oplock once a second client opens the file (instead
3348 of releasing all oplocks on a second open, as in traditional,
3349 exclusive oplocks). This allows all openers of the file that
3350 support level2 oplocks to cache the file for read-ahead only (ie.
3351 they may not cache writes or lock requests) and increases performance
3352 for many accesses of files that are not commonly written (such as
3353 application .EXE files).</para>
3355 <para>Once one of the clients which have a read-only oplock
3356 writes to the file all clients are notified (no reply is needed
3357 or waited for) and told to break their oplocks to "none" and
3358 delete any read-ahead caches.</para>
3360 <para>It is recommended that this parameter be turned on
3361 to speed access to shared executables.</para>
3363 <para>For more discussions on level2 oplocks see the CIFS spec.</para>
3365 <para>Currently, if <link linkend="KERNELOPLOCKS"><parameter>kernel
3366 oplocks</parameter></link> are supported then level2 oplocks are
3367 not granted (even if this parameter is set to <constant>yes</constant>).
3368 Note also, the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
3369 </link> parameter must be set to "true" on this share in order for
3370 this parameter to have any effect.</para>
3372 <para>See also the <link linkend="OPLOCKS"><parameter>oplocks</parameter>
3373 </link> and <link linkend="OPLOCKS"><parameter>kernel oplocks</parameter>
3374 </link> parameters.</para>
3376 <para>Default: <command>level2 oplocks = yes</command></para>
3377 </listitem>
3378 </varlistentry>
3384 <varlistentry>
3385 <term><anchor id="LMANNOUNCE">lm announce (G)</term>
3386 <listitem><para>This parameter determines if <ulink url="nmbd.8.html">
3387 <command>nmbd(8)</command></ulink> will produce Lanman announce
3388 broadcasts that are needed by OS/2 clients in order for them to see
3389 the Samba server in their browse list. This parameter can have three
3390 values, <constant>true</constant>, <constant>false</constant>, or
3391 <constant>auto</constant>. The default is <constant>auto</constant>.
3392 If set to <constant>false</constant> Samba will never produce these
3393 broadcasts. If set to <constant>true</constant> Samba will produce
3394 Lanman announce broadcasts at a frequency set by the parameter
3395 <parameter>lm interval</parameter>. If set to <constant>auto</constant>
3396 Samba will not send Lanman announce broadcasts by default but will
3397 listen for them. If it hears such a broadcast on the wire it will
3398 then start sending them at a frequency set by the parameter
3399 <parameter>lm interval</parameter>.</para>
3401 <para>See also <link linkend="LMINTERVAL"><parameter>lm interval
3402 </parameter></link>.</para>
3404 <para>Default: <command>lm announce = auto</command></para>
3405 <para>Example: <command>lm announce = yes</command></para>
3406 </listitem>
3407 </varlistentry>
3411 <varlistentry>
3412 <term><anchor id="LMINTERVAL">lm interval (G)</term>
3413 <listitem><para>If Samba is set to produce Lanman announce
3414 broadcasts needed by OS/2 clients (see the <link linkend="LMANNOUNCE">
3415 <parameter>lm announce</parameter></link> parameter) then this
3416 parameter defines the frequency in seconds with which they will be
3417 made. If this is set to zero then no Lanman announcements will be
3418 made despite the setting of the <parameter>lm announce</parameter>
3419 parameter.</para>
3421 <para>See also <link linkend="LMANNOUNCE"><parameter>lm
3422 announce</parameter></link>.</para>
3424 <para>Default: <command>lm interval = 60</command></para>
3425 <para>Example: <command>lm interval = 120</command></para>
3426 </listitem>
3427 </varlistentry>
3431 <varlistentry>
3432 <term><anchor id="LOADPRINTERS">load printers (G)</term>
3433 <listitem><para>A boolean variable that controls whether all
3434 printers in the printcap will be loaded for browsing by default.
3435 See the <link linkend="PRINTERSSECT">printers</link> section for
3436 more details.</para>
3438 <para>Default: <command>load printers = yes</command></para></listitem>
3439 </varlistentry>
3444 <varlistentry>
3445 <term><anchor id="LOCALMASTER">local master (G)</term>
3446 <listitem><para>This option allows <ulink url="nmbd.8.html"><command>
3447 nmbd(8)</command></ulink> to try and become a local master browser
3448 on a subnet. If set to <constant>False</constant> then <command>
3449 nmbd</command> will not attempt to become a local master browser
3450 on a subnet and will also lose in all browsing elections. By
3451 default this value is set to true. Setting this value to true doesn't
3452 mean that Samba will <emphasis>become</emphasis> the local master
3453 browser on a subnet, just that <command>nmbd</command> will <emphasis>
3454 participate</emphasis> in elections for local master browser.</para>
3456 <para>Setting this value to False will cause <command>nmbd</command>
3457 <emphasis>never</emphasis> to become a local master browser.</para>
3459 <para>Default: <command>local master = yes</command></para>
3460 </listitem>
3461 </varlistentry>
3465 <varlistentry>
3466 <term><anchor id="LOCKDIR">lock dir (G)</term>
3467 <listitem><para>Synonym for <link linkend="LOCKDIRECTORY"><parameter>
3468 lock directory</parameter></link>.</para></listitem>
3469 </varlistentry>
3473 <varlistentry>
3474 <term><anchor id="LOCKDIRECTORY">lock directory (G)</term>
3475 <listitem><para>This option specifies the directory where lock
3476 files will be placed. The lock files are used to implement the
3477 <link linkend="MAXCONNECTIONS"><parameter>max connections</parameter>
3478 </link> option.</para>
3480 <para>Default: <command>lock directory = ${prefix}/var/locks</command></para>
3481 <para>Example: <command>lock directory = /var/run/samba/locks</command>
3482 </para></listitem>
3483 </varlistentry>
3487 <varlistentry>
3488 <term><anchor id="LOCKING">locking (S)</term>
3489 <listitem><para>This controls whether or not locking will be
3490 performed by the server in response to lock requests from the
3491 client.</para>
3493 <para>If <command>locking = no</command>, all lock and unlock
3494 requests will appear to succeed and all lock queries will report
3495 that the file in question is available for locking.</para>
3497 <para>If <command>locking = yes</command>, real locking will be performed
3498 by the server.</para>
3500 <para>This option <emphasis>may</emphasis> be useful for read-only
3501 filesystems which <emphasis>may</emphasis> not need locking (such as
3502 cdrom drives), although setting this parameter of <constant>no</constant>
3503 is not really recommended even in this case.</para>
3505 <para>Be careful about disabling locking either globally or in a
3506 specific service, as lack of locking may result in data corruption.
3507 You should never need to set this parameter.</para>
3509 <para>Default: <command>locking = yes</command></para>
3510 </listitem>
3511 </varlistentry>
3515 <varlistentry>
3516 <term><anchor id="LOGFILE">log file (G)</term>
3517 <listitem><para>This option allows you to override the name
3518 of the Samba log file (also known as the debug file).</para>
3520 <para>This option takes the standard substitutions, allowing
3521 you to have separate log files for each user or machine.</para>
3523 <para>Example: <command>log file = /usr/local/samba/var/log.%m
3524 </command></para></listitem>
3525 </varlistentry>
3529 <varlistentry>
3530 <term><anchor id="LOGLEVEL">log level (G)</term>
3531 <listitem><para>Synonym for <link linkend="DEBUGLEVEL"><parameter>
3532 debug level</parameter></link>.</para>
3533 </listitem>
3534 </varlistentry>
3538 <varlistentry>
3539 <term><anchor id="LOGONDRIVE">logon drive (G)</term>
3540 <listitem><para>This parameter specifies the local path to
3541 which the home directory will be connected (see <link
3542 linkend="LOGONHOME"><parameter>logon home</parameter></link>)
3543 and is only used by NT Workstations. </para>
3545 <para>Note that this option is only useful if Samba is set up as a
3546 logon server.</para>
3548 <para>Default: <command>logon drive = z:</command></para>
3549 <para>Example: <command>logon drive = h:</command></para>
3550 </listitem>
3551 </varlistentry>
3555 <varlistentry>
3556 <term><anchor id="LOGONHOME">logon home (G)</term>
3557 <listitem><para>This parameter specifies the home directory
3558 location when a Win95/98 or NT Workstation logs into a Samba PDC.
3559 It allows you to do </para>
3561 <para><prompt>C:\> </prompt><userinput>NET USE H: /HOME</userinput>
3562 </para>
3564 <para>from a command prompt, for example.</para>
3566 <para>This option takes the standard substitutions, allowing
3567 you to have separate logon scripts for each user or machine.</para>
3569 <para>This parameter can be used with Win9X workstations to ensure
3570 that roaming profiles are stored in a subdirectory of the user's
3571 home directory. This is done in the following way:</para>
3573 <para><command>logon home = \\%N\%U\profile</command></para>
3575 <para>This tells Samba to return the above string, with
3576 substitutions made when a client requests the info, generally
3577 in a NetUserGetInfo request. Win9X clients truncate the info to
3578 \\server\share when a user does <command>net use /home"</command>
3579 but use the whole string when dealing with profiles.</para>
3581 <para>Note that in prior versions of Samba, the <link linkend="LOGONPATH">
3582 <parameter>logon path</parameter></link> was returned rather than
3583 <parameter>logon home</parameter>. This broke <command>net use
3584 /home</command> but allowed profiles outside the home directory.
3585 The current implementation is correct, and can be used for
3586 profiles if you use the above trick.</para>
3588 <para>This option is only useful if Samba is set up as a logon
3589 server.</para>
3591 <para>Default: <command>logon home = "\\%N\%U"</command></para>
3592 <para>Example: <command>logon home = "\\remote_smb_server\%U"</command>
3593 </para></listitem>
3594 </varlistentry>
3597 <varlistentry>
3598 <term><anchor id="LOGONPATH">logon path (G)</term>
3599 <listitem><para>This parameter specifies the home directory
3600 where roaming profiles (NTuser.dat etc files for Windows NT) are
3601 stored. Contrary to previous versions of these manual pages, it has
3602 nothing to do with Win 9X roaming profiles. To find out how to
3603 handle roaming profiles for Win 9X system, see the <link linkend="LOGONHOME">
3604 <parameter>logon home</parameter></link> parameter.</para>
3606 <para>This option takes the standard substitutions, allowing you
3607 to have separate logon scripts for each user or machine. It also
3608 specifies the directory from which the "Application Data",
3609 (<filename>desktop</filename>, <filename>start menu</filename>,
3610 <filename>network neighborhood</filename>, <filename>programs</filename>
3611 and other folders, and their contents, are loaded and displayed on
3612 your Windows NT client.</para>
3614 <para>The share and the path must be readable by the user for
3615 the preferences and directories to be loaded onto the Windows NT
3616 client. The share must be writeable when the logs in for the first
3617 time, in order that the Windows NT client can create the NTuser.dat
3618 and other directories.</para>
3620 <para>Thereafter, the directories and any of the contents can,
3621 if required, be made read-only. It is not advisable that the
3622 NTuser.dat file be made read-only - rename it to NTuser.man to
3623 achieve the desired effect (a <emphasis>MAN</emphasis>datory
3624 profile). </para>
3626 <para>Windows clients can sometimes maintain a connection to
3627 the [homes] share, even though there is no user logged in.
3628 Therefore, it is vital that the logon path does not include a
3629 reference to the homes share (i.e. setting this parameter to
3630 \%N\%U\profile_path will cause problems).</para>
3632 <para>This option takes the standard substitutions, allowing
3633 you to have separate logon scripts for each user or machine.</para>
3635 <para>Note that this option is only useful if Samba is set up
3636 as a logon server.</para>
3638 <para>Default: <command>logon path = \\%N\%U\profile</command></para>
3639 <para>Example: <command>logon path = \\PROFILESERVER\PROFILE\%U</command></para>
3640 </listitem>
3641 </varlistentry>
3645 <varlistentry>
3646 <term><anchor id="LOGONSCRIPT">logon script (G)</term>
3647 <listitem><para>This parameter specifies the batch file (.bat) or
3648 NT command file (.cmd) to be downloaded and run on a machine when
3649 a user successfully logs in. The file must contain the DOS
3650 style cr/lf line endings. Using a DOS-style editor to create the
3651 file is recommended.</para>
3653 <para>The script must be a relative path to the [netlogon]
3654 service. If the [netlogon] service specifies a <link linkend="PATH">
3655 <parameter>path</parameter></link> of <filename>/usr/local/samba/netlogon
3656 </filename>, and <command>logon script = STARTUP.BAT</command>, then
3657 the file that will be downloaded is:</para>
3659 <para><filename>/usr/local/samba/netlogon/STARTUP.BAT</filename></para>
3661 <para>The contents of the batch file is entirely your choice. A
3662 suggested command would be to add <command>NET TIME \\SERVER /SET
3663 /YES</command>, to force every machine to synchronize clocks with
3664 the same time server. Another use would be to add <command>NET USE
3665 U: \\SERVER\UTILS</command> for commonly used utilities, or <command>
3666 NET USE Q: \\SERVER\ISO9001_QA</command> for example.</para>
3668 <para>Note that it is particularly important not to allow write
3669 access to the [netlogon] share, or to grant users write permission
3670 on the batch files in a secure environment, as this would allow
3671 the batch files to be arbitrarily modified and security to be
3672 breached.</para>
3674 <para>This option takes the standard substitutions, allowing you
3675 to have separate logon scripts for each user or machine.</para>
3677 <para>This option is only useful if Samba is set up as a logon
3678 server.</para>
3680 <para>Default: <emphasis>no logon script defined</emphasis></para>
3681 <para>Example: <command>logon script = scripts\%U.bat</command></para>
3682 </listitem>
3683 </varlistentry>
3687 <varlistentry>
3688 <term><anchor id="LPPAUSECOMMAND">lppause command (S)</term>
3689 <listitem><para>This parameter specifies the command to be
3690 executed on the server host in order to stop printing or spooling
3691 a specific print job.</para>
3693 <para>This command should be a program or script which takes
3694 a printer name and job number to pause the print job. One way
3695 of implementing this is by using job priorities, where jobs
3696 having a too low priority won't be sent to the printer.</para>
3698 <para>If a <parameter>%p</parameter> is given then the printername
3699 is put in its place. A <parameter>%j</parameter> is replaced with
3700 the job number (an integer). On HPUX (see <parameter>printing=hpux
3701 </parameter>), if the <parameter>-p%p</parameter> option is added
3702 to the lpq command, the job will show up with the correct status, i.e.
3703 if the job priority is lower than the set fence priority it will
3704 have the PAUSED status, whereas if the priority is equal or higher it
3705 will have the SPOOLED or PRINTING status.</para>
3707 <para>Note that it is good practice to include the absolute path
3708 in the lppause command as the PATH may not be available to the server.</para>
3710 <para>See also the <link linkend="PRINTING"><parameter>printing
3711 </parameter></link> parameter.</para>
3713 <para>Default: Currently no default value is given to
3714 this string, unless the value of the <parameter>printing</parameter>
3715 parameter is <constant>SYSV</constant>, in which case the default is :</para>
3717 <para><command>lp -i %p-%j -H hold</command></para>
3719 <para>or if the value of the <parameter>printing</parameter> parameter
3720 is <constant>SOFTQ</constant>, then the default is:</para>
3722 <para><command>qstat -s -j%j -h</command></para>
3724 <para>Example for HPUX: <command>lppause command = /usr/bin/lpalt
3725 %p-%j -p0</command></para>
3726 </listitem>
3727 </varlistentry>
3731 <varlistentry>
3732 <term><anchor id="LPQCACHETIME">lpq cache time (G)</term>
3733 <listitem><para>This controls how long lpq info will be cached
3734 for to prevent the <command>lpq</command> command being called too
3735 often. A separate cache is kept for each variation of the <command>
3736 lpq</command> command used by the system, so if you use different
3737 <command>lpq</command> commands for different users then they won't
3738 share cache information.</para>
3740 <para>The cache files are stored in <filename>/tmp/lpq.xxxx</filename>
3741 where xxxx is a hash of the <command>lpq</command> command in use.</para>
3743 <para>The default is 10 seconds, meaning that the cached results
3744 of a previous identical <command>lpq</command> command will be used
3745 if the cached data is less than 10 seconds old. A large value may
3746 be advisable if your <command>lpq</command> command is very slow.</para>
3748 <para>A value of 0 will disable caching completely.</para>
3750 <para>See also the <link linkend="PRINTING"><parameter>printing
3751 </parameter></link> parameter.</para>
3753 <para>Default: <command>lpq cache time = 10</command></para>
3754 <para>Example: <command>lpq cache time = 30</command></para>
3755 </listitem>
3756 </varlistentry>
3760 <varlistentry>
3761 <term><anchor id="LPQCOMMAND">lpq command (S)</term>
3762 <listitem><para>This parameter specifies the command to be
3763 executed on the server host in order to obtain <command>lpq
3764 </command>-style printer status information.</para>
3766 <para>This command should be a program or script which
3767 takes a printer name as its only parameter and outputs printer
3768 status information.</para>
3770 <para>Currently eight styles of printer status information
3771 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
3772 This covers most UNIX systems. You control which type is expected
3773 using the <parameter>printing =</parameter> option.</para>
3775 <para>Some clients (notably Windows for Workgroups) may not
3776 correctly send the connection number for the printer they are
3777 requesting status information about. To get around this, the
3778 server reports on the first printer service connected to by the
3779 client. This only happens if the connection number sent is invalid.</para>
3781 <para>If a <parameter>%p</parameter> is given then the printername
3782 is put in its place. Otherwise it is placed at the end of the
3783 command.</para>
3785 <para>Note that it is good practice to include the absolute path
3786 in the <parameter>lpq command</parameter> as the <envar>$PATH
3787 </envar> may not be available to the server.</para>
3789 <para>See also the <link linkend="PRINTING"><parameter>printing
3790 </parameter></link> parameter.</para>
3792 <para>Default: <emphasis>depends on the setting of <parameter>
3793 printing</parameter></emphasis></para>
3795 <para>Example: <command>lpq command = /usr/bin/lpq -P%p</command></para>
3796 </listitem>
3797 </varlistentry>
3801 <varlistentry>
3802 <term><anchor id="LPRESUMECOMMAND">lpresume command (S)</term>
3803 <listitem><para>This parameter specifies the command to be
3804 executed on the server host in order to restart or continue
3805 printing or spooling a specific print job.</para>
3807 <para>This command should be a program or script which takes
3808 a printer name and job number to resume the print job. See
3809 also the <link linkend="LPPAUSECOMMAND"><parameter>lppause command
3810 </parameter></link> parameter.</para>
3812 <para>If a <parameter>%p</parameter> is given then the printername
3813 is put in its place. A <parameter>%j</parameter> is replaced with
3814 the job number (an integer).</para>
3816 <para>Note that it is good practice to include the absolute path
3817 in the <parameter>lpresume command</parameter> as the PATH may not
3818 be available to the server.</para>
3820 <para>See also the <link linkend="PRINTING"><parameter>printing
3821 </parameter></link> parameter.</para>
3823 <para>Default: Currently no default value is given
3824 to this string, unless the value of the <parameter>printing</parameter>
3825 parameter is <constant>SYSV</constant>, in which case the default is :</para>
3827 <para><command>lp -i %p-%j -H resume</command></para>
3829 <para>or if the value of the <parameter>printing</parameter> parameter
3830 is <constant>SOFTQ</constant>, then the default is:</para>
3832 <para><command>qstat -s -j%j -r</command></para>
3834 <para>Example for HPUX: <command>lpresume command = /usr/bin/lpalt
3835 %p-%j -p2</command></para>
3836 </listitem>
3837 </varlistentry>
3841 <varlistentry>
3842 <term><anchor id="LPRMCOMMAND">lprm command (S)</term>
3843 <listitem><para>This parameter specifies the command to be
3844 executed on the server host in order to delete a print job.</para>
3846 <para>This command should be a program or script which takes
3847 a printer name and job number, and deletes the print job.</para>
3849 <para>If a <parameter>%p</parameter> is given then the printername
3850 is put in its place. A <parameter>%j</parameter> is replaced with
3851 the job number (an integer).</para>
3853 <para>Note that it is good practice to include the absolute
3854 path in the <parameter>lprm command</parameter> as the PATH may not be
3855 available to the server.</para>
3857 <para>See also the <link linkend="PRINTING"><parameter>printing
3858 </parameter></link> parameter.</para>
3860 <para>Default: <emphasis>depends on the setting of <parameter>printing
3861 </parameter></emphasis></para>
3863 <para>Example 1: <command>lprm command = /usr/bin/lprm -P%p %j
3864 </command></para>
3865 <para>Example 2: <command>lprm command = /usr/bin/cancel %p-%j
3866 </command></para></listitem>
3867 </varlistentry>
3871 <varlistentry>
3872 <term><anchor id="MACHINEPASSWORDTIMEOUT">machine password timeout (G)</term>
3873 <listitem><para>If a Samba server is a member of an Windows
3874 NT Domain (see the <link linkend="SECURITYEQUALSDOMAIN">security=domain</link>)
3875 parameter) then periodically a running <ulink url="smbd.8.html">
3876 smbd(8)</ulink> process will try and change the MACHINE ACCOUNT
3877 PASSWORD stored in the TDB called <filename>private/secrets.tdb
3878 </filename>. This parameter specifies how often this password
3879 will be changed, in seconds. The default is one week (expressed in
3880 seconds), the same as a Windows NT Domain member server.</para>
3882 <para>See also <ulink url="smbpasswd.8.html"><command>smbpasswd(8)
3883 </command></ulink>, and the <link linkend="SECURITYEQUALSDOMAIN">
3884 security=domain</link>) parameter.</para>
3886 <para>Default: <command>machine password timeout = 604800</command></para>
3887 </listitem>
3888 </varlistentry>
3891 <varlistentry>
3892 <term><anchor id="MAGICOUTPUT">magic output (S)</term>
3893 <listitem><para>This parameter specifies the name of a file
3894 which will contain output created by a magic script (see the
3895 <link linkend="MAGICSCRIPT"><parameter>magic script</parameter></link>
3896 parameter below).</para>
3898 <para>Warning: If two clients use the same <parameter>magic script
3899 </parameter> in the same directory the output file content
3900 is undefined.</para>
3902 <para>Default: <command>magic output = &lt;magic script name&gt;.out
3903 </command></para>
3905 <para>Example: <command>magic output = myfile.txt</command></para>
3906 </listitem>
3907 </varlistentry>
3911 <varlistentry>
3912 <term><anchor id="MAGICSCRIPT">magic script (S)</term>
3913 <listitem><para>This parameter specifies the name of a file which,
3914 if opened, will be executed by the server when the file is closed.
3915 This allows a UNIX script to be sent to the Samba host and
3916 executed on behalf of the connected user.</para>
3918 <para>Scripts executed in this way will be deleted upon
3919 completion assuming that the user has the appripriate level
3920 of priviledge and the ile permissions allow the deletion.</para>
3922 <para>If the script generates output, output will be sent to
3923 the file specified by the <link linkend="MAGICOUTPUT"><parameter>
3924 magic output</parameter></link> parameter (see above).</para>
3926 <para>Note that some shells are unable to interpret scripts
3927 containing CR/LF instead of CR as
3928 the end-of-line marker. Magic scripts must be executable
3929 <emphasis>as is</emphasis> on the host, which for some hosts and
3930 some shells will require filtering at the DOS end.</para>
3932 <para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and
3933 should <emphasis>NOT</emphasis> be relied upon.</para>
3935 <para>Default: <emphasis>None. Magic scripts disabled.</emphasis></para>
3936 <para>Example: <command>magic script = user.csh</command></para>
3937 </listitem>
3938 </varlistentry>
3942 <varlistentry>
3943 <term><anchor id="MANGLECASE">mangle case (S)</term>
3944 <listitem><para>See the section on <link linkend="NAMEMANGLINGSECT">
3945 NAME MANGLING</link></para>
3947 <para>Default: <command>mangle case = no</command></para>
3948 </listitem>
3949 </varlistentry>
3952 <varlistentry>
3953 <term><anchor id="MANGLEDMAP">mangled map (S)</term>
3954 <listitem><para>This is for those who want to directly map UNIX
3955 file names which can not be represented on Windows/DOS. The mangling
3956 of names is not always what is needed. In particular you may have
3957 documents with file extensions that differ between DOS and UNIX.
3958 For example, under UNIX it is common to use <filename>.html</filename>
3959 for HTML files, whereas under Windows/DOS <filename>.htm</filename>
3960 is more commonly used.</para>
3962 <para>So to map <filename>html</filename> to <filename>htm</filename>
3963 you would use:</para>
3965 <para><command>mangled map = (*.html *.htm)</command></para>
3967 <para>One very useful case is to remove the annoying <filename>;1
3968 </filename> off the ends of filenames on some CDROMS (only visible
3969 under some UNIXes). To do this use a map of (*;1 *;).</para>
3971 <para>Default: <emphasis>no mangled map</emphasis></para>
3972 <para>Example: <command>mangled map = (*;1 *;)</command></para>
3973 </listitem>
3974 </varlistentry>
3977 <varlistentry>
3978 <term><anchor id="MANGLEDNAMES">mangled names (S)</term>
3979 <listitem><para>This controls whether non-DOS names under UNIX
3980 should be mapped to DOS-compatible names ("mangled") and made visible,
3981 or whether non-DOS names should simply be ignored.</para>
3983 <para>See the section on <link linkend="NAMEMANGLINGSECT">
3984 NAME MANGLING</link> for details on how to control the mangling process.</para>
3986 <para>If mangling is used then the mangling algorithm is as follows:</para>
3988 <itemizedlist>
3989 <listitem><para>The first (up to) five alphanumeric characters
3990 before the rightmost dot of the filename are preserved, forced
3991 to upper case, and appear as the first (up to) five characters
3992 of the mangled name.</para></listitem>
3994 <listitem><para>A tilde "~" is appended to the first part of the mangled
3995 name, followed by a two-character unique sequence, based on the
3996 original root name (i.e., the original filename minus its final
3997 extension). The final extension is included in the hash calculation
3998 only if it contains any upper case characters or is longer than three
3999 characters.</para>
4001 <para>Note that the character to use may be specified using
4002 the <link linkend="MANGLINGCHAR"><parameter>mangling char</parameter>
4003 </link> option, if you don't like '~'.</para></listitem>
4005 <listitem><para>The first three alphanumeric characters of the final
4006 extension are preserved, forced to upper case and appear as the
4007 extension of the mangled name. The final extension is defined as that
4008 part of the original filename after the rightmost dot. If there are no
4009 dots in the filename, the mangled name will have no extension (except
4010 in the case of "hidden files" - see below).</para></listitem>
4012 <listitem><para>Files whose UNIX name begins with a dot will be
4013 presented as DOS hidden files. The mangled name will be created as
4014 for other filenames, but with the leading dot removed and "___" as
4015 its extension regardless of actual original extension (that's three
4016 underscores).</para></listitem>
4017 </itemizedlist>
4019 <para>The two-digit hash value consists of upper case
4020 alphanumeric characters.</para>
4022 <para>This algorithm can cause name collisions only if files
4023 in a directory share the same first five alphanumeric characters.
4024 The probability of such a clash is 1/1300.</para>
4026 <para>The name mangling (if enabled) allows a file to be
4027 copied between UNIX directories from Windows/DOS while retaining
4028 the long UNIX filename. UNIX files can be renamed to a new extension
4029 from Windows/DOS and will retain the same basename. Mangled names
4030 do not change between sessions.</para>
4032 <para>Default: <command>mangled names = yes</command></para>
4033 </listitem>
4034 </varlistentry>
4038 <varlistentry>
4039 <term><anchor id="MANGLEDSTACK">mangled stack (G)</term>
4040 <listitem><para>This parameter controls the number of mangled names
4041 that should be cached in the Samba server <ulink url="smbd.8.html">
4042 smbd(8)</ulink>.</para>
4044 <para>This stack is a list of recently mangled base names
4045 (extensions are only maintained if they are longer than 3 characters
4046 or contains upper case characters).</para>
4048 <para>The larger this value, the more likely it is that mangled
4049 names can be successfully converted to correct long UNIX names.
4050 However, large stack sizes will slow most directory access. Smaller
4051 stacks save memory in the server (each stack element costs 256 bytes).
4052 </para>
4054 <para>It is not possible to absolutely guarantee correct long
4055 file names, so be prepared for some surprises!</para>
4057 <para>Default: <command>mangled stack = 50</command></para>
4058 <para>Example: <command>mangled stack = 100</command></para>
4059 </listitem>
4060 </varlistentry>
4065 <varlistentry>
4066 <term><anchor id="MANGLINGCHAR">mangling char (S)</term>
4067 <listitem><para>This controls what character is used as
4068 the <emphasis>magic</emphasis> character in <link
4069 linkend="NAMEMANGLINGSECT">name mangling</link>. The default is a '~'
4070 but this may interfere with some software. Use this option to set
4071 it to whatever you prefer.</para>
4073 <para>Default: <command>mangling char = ~</command></para>
4074 <para>Example: <command>mangling char = ^</command></para>
4075 </listitem>
4076 </varlistentry>
4082 <varlistentry>
4083 <term><anchor id="MAPARCHIVE">map archive (S)</term>
4084 <listitem><para>This controls whether the DOS archive attribute
4085 should be mapped to the UNIX owner execute bit. The DOS archive bit
4086 is set when a file has been modified since its last backup. One
4087 motivation for this option it to keep Samba/your PC from making
4088 any file it touches from becoming executable under UNIX. This can
4089 be quite annoying for shared source code, documents, etc...</para>
4091 <para>Note that this requires the <parameter>create mask</parameter>
4092 parameter to be set such that owner execute bit is not masked out
4093 (i.e. it must include 100). See the parameter <link linkend="CREATEMASK">
4094 <parameter>create mask</parameter></link> for details.</para>
4096 <para>Default: <command>map archive = yes</command></para>
4097 </listitem>
4098 </varlistentry>
4102 <varlistentry>
4103 <term><anchor id="MAPHIDDEN">map hidden (S)</term>
4104 <listitem><para>This controls whether DOS style hidden files
4105 should be mapped to the UNIX world execute bit.</para>
4107 <para>Note that this requires the <parameter>create mask</parameter>
4108 to be set such that the world execute bit is not masked out (i.e.
4109 it must include 001). See the parameter <link linkend="CREATEMASK">
4110 <parameter>create mask</parameter></link> for details.</para>
4112 <para>Default: <command>map hidden = no</command></para>
4113 </listitem>
4114 </varlistentry>
4117 <varlistentry>
4118 <term><anchor id="MAPSYSTEM">map system (S)</term>
4119 <listitem><para>This controls whether DOS style system files
4120 should be mapped to the UNIX group execute bit.</para>
4122 <para>Note that this requires the <parameter>create mask</parameter>
4123 to be set such that the group execute bit is not masked out (i.e.
4124 it must include 010). See the parameter <link linkend="CREATEMASK">
4125 <parameter>create mask</parameter></link> for details.</para>
4127 <para>Default: <command>map system = no</command></para>
4128 </listitem>
4129 </varlistentry>
4132 <varlistentry>
4133 <term><anchor id="MAPTOGUEST">map to guest (G)</term>
4134 <listitem><para>This parameter is only useful in <link linkend="SECURITY">
4135 security</link> modes other than <parameter>security=share</parameter>
4136 - i.e. <constant>user</constant>, <constant>server</constant>,
4137 and <constant>domain</constant>.</para>
4139 <para>This parameter can take three different values, which tell
4140 <ulink url="smbd.8.html">smbd(8)</ulink> what to do with user
4141 login requests that don't match a valid UNIX user in some way.</para>
4143 <para>The three settings are :</para>
4145 <itemizedlist>
4146 <listitem><para><constant>Never</constant> - Means user login
4147 requests with an invalid password are rejected. This is the
4148 default.</para></listitem>
4150 <listitem><para><constant>Bad User</constant> - Means user
4151 logins with an invalid password are rejected, unless the username
4152 does not exist, in which case it is treated as a guest login and
4153 mapped into the <link linkend="GUESTACCOUNT"><parameter>
4154 guest account</parameter></link>.</para></listitem>
4156 <listitem><para><constant>Bad Password</constant> - Means user logins
4157 with an invalid password are treated as a guest login and mapped
4158 into the <link linkend="GUESTACCOUNT">guest account</link>. Note that
4159 this can cause problems as it means that any user incorrectly typing
4160 their password will be silently logged on as "guest" - and
4161 will not know the reason they cannot access files they think
4162 they should - there will have been no message given to them
4163 that they got their password wrong. Helpdesk services will
4164 <emphasis>hate</emphasis> you if you set the <parameter>map to
4165 guest</parameter> parameter this way :-).</para></listitem>
4166 </itemizedlist>
4168 <para>Note that this parameter is needed to set up "Guest"
4169 share services when using <parameter>security</parameter> modes other than
4170 share. This is because in these modes the name of the resource being
4171 requested is <emphasis>not</emphasis> sent to the server until after
4172 the server has successfully authenticated the client so the server
4173 cannot make authentication decisions at the correct time (connection
4174 to the share) for "Guest" shares.</para>
4176 <para>For people familiar with the older Samba releases, this
4177 parameter maps to the old compile-time setting of the <constant>
4178 GUEST_SESSSETUP</constant> value in local.h.</para>
4180 <para>Default: <command>map to guest = Never</command></para>
4181 <para>Example: <command>map to guest = Bad User</command></para>
4182 </listitem>
4183 </varlistentry>
4187 <varlistentry>
4188 <term><anchor id="MAXCONNECTIONS">max connections (S)</term>
4189 <listitem><para>This option allows the number of simultaneous
4190 connections to a service to be limited. If <parameter>max connections
4191 </parameter> is greater than 0 then connections will be refused if
4192 this number of connections to the service are already open. A value
4193 of zero mean an unlimited number of connections may be made.</para>
4195 <para>Record lock files are used to implement this feature. The
4196 lock files will be stored in the directory specified by the <link
4197 linkend="LOCKDIRECTORY"><parameter>lock directory</parameter></link>
4198 option.</para>
4200 <para>Default: <command>max connections = 0</command></para>
4201 <para>Example: <command>max connections = 10</command></para>
4202 </listitem>
4203 </varlistentry>
4207 <varlistentry>
4208 <term><anchor id="MAXDISKSIZE">max disk size (G)</term>
4209 <listitem><para>This option allows you to put an upper limit
4210 on the apparent size of disks. If you set this option to 100
4211 then all shares will appear to be not larger than 100 MB in
4212 size.</para>
4214 <para>Note that this option does not limit the amount of
4215 data you can put on the disk. In the above case you could still
4216 store much more than 100 MB on the disk, but if a client ever asks
4217 for the amount of free disk space or the total disk size then the
4218 result will be bounded by the amount specified in <parameter>max
4219 disk size</parameter>.</para>
4221 <para>This option is primarily useful to work around bugs
4222 in some pieces of software that can't handle very large disks,
4223 particularly disks over 1GB in size.</para>
4225 <para>A <parameter>max disk size</parameter> of 0 means no limit.</para>
4227 <para>Default: <command>max disk size = 0</command></para>
4228 <para>Example: <command>max disk size = 1000</command></para>
4229 </listitem>
4230 </varlistentry>
4234 <varlistentry>
4235 <term><anchor id="MAXLOGSIZE">max log size (G)</term>
4236 <listitem><para>This option (an integer in kilobytes) specifies
4237 the max size the log file should grow to. Samba periodically checks
4238 the size and if it is exceeded it will rename the file, adding
4239 a <filename>.old</filename> extension.</para>
4241 <para>A size of 0 means no limit.</para>
4243 <para>Default: <command>max log size = 5000</command></para>
4244 <para>Example: <command>max log size = 1000</command></para>
4245 </listitem>
4246 </varlistentry>
4250 <varlistentry>
4251 <term><anchor id="MAXMUX">max mux (G)</term>
4252 <listitem><para>This option controls the maximum number of
4253 outstanding simultaneous SMB operations that samba tells the client
4254 it will allow. You should never need to set this parameter.</para>
4256 <para>Default: <command>max mux = 50</command></para>
4257 </listitem>
4258 </varlistentry>
4262 <varlistentry>
4263 <term><anchor id="MAXOPENFILES">max open files (G)</term>
4264 <listitem><para>This parameter limits the maximum number of
4265 open files that one <ulink url="smbd.8.html">smbd(8)</ulink> file
4266 serving process may have open for a client at any one time. The
4267 default for this parameter is set very high (10,000) as Samba uses
4268 only one bit per unopened file.</para>
4270 <para>The limit of the number of open files is usually set
4271 by the UNIX per-process file descriptor limit rather than
4272 this parameter so you should never need to touch this parameter.</para>
4274 <para>Default: <command>max open files = 10000</command></para>
4275 </listitem>
4276 </varlistentry>
4280 <varlistentry>
4281 <term><anchor id="MAXPRINTJOBS">max print jobs (S)</term>
4282 <listitem><para>This parameter limits the maximum number of
4283 jobs allowable in a Samba printer queue at any given moment.
4284 If this number is exceeded, <ulink url="smbd.8.html"><command>
4285 smbd(8)</command></ulink> will remote "Out of Space" to the client.
4286 See all <link linkend="TOTALPRINTJOBS"><parameter>total
4287 print jobs</parameter></link>.
4288 </para>
4290 <para>Default: <command>max print jobs = 1000</command></para>
4291 <para>Example: <command>max print jobs = 5000</command></para>
4292 </listitem>
4293 </varlistentry>
4296 <varlistentry>
4297 <term><anchor id="MAXPROTOCOL">max protocol (G)</term>
4298 <listitem><para>The value of the parameter (a string) is the highest
4299 protocol level that will be supported by the server.</para>
4301 <para>Possible values are :</para>
4302 <itemizedlist>
4303 <listitem><para><constant>CORE</constant>: Earliest version. No
4304 concept of user names.</para></listitem>
4306 <listitem><para><constant>COREPLUS</constant>: Slight improvements on
4307 CORE for efficiency.</para></listitem>
4309 <listitem><para><constant>LANMAN1</constant>: First <emphasis>
4310 modern</emphasis> version of the protocol. Long filename
4311 support.</para></listitem>
4313 <listitem><para><constant>LANMAN2</constant>: Updates to Lanman1 protocol.
4314 </para></listitem>
4316 <listitem><para><constant>NT1</constant>: Current up to date version of
4317 the protocol. Used by Windows NT. Known as CIFS.</para></listitem>
4318 </itemizedlist>
4320 <para>Normally this option should not be set as the automatic
4321 negotiation phase in the SMB protocol takes care of choosing
4322 the appropriate protocol.</para>
4324 <para>See also <link linkend="MINPROTOCOL"><parameter>min
4325 protocol</parameter></link></para>
4327 <para>Default: <command>max protocol = NT1</command></para>
4328 <para>Example: <command>max protocol = LANMAN1</command></para>
4329 </listitem>
4330 </varlistentry>
4334 <varlistentry>
4335 <term><anchor id="MAXSMBDPROCESSES">max smbd processes (G)</term>
4336 <listitem><para>This parameter limits the maximum number of
4337 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
4338 processes concurrently running on a system and is intended
4339 as a stop gap to prevent degrading service to clients in the event
4340 that the server has insufficient resources to handle more than this
4341 number of connections. Remember that under normal operating
4342 conditions, each user will have an smbd associated with him or her
4343 to handle connections to all shares from a given host.
4344 </para>
4346 <para>Default: <command>max smbd processes = 0</command> ## no limit</para>
4347 <para>Example: <command>max smbd processes = 1000</command></para>
4348 </listitem>
4349 </varlistentry>
4354 <varlistentry>
4355 <term><anchor id="MAXTTL">max ttl (G)</term>
4356 <listitem><para>This option tells <ulink url="nmbd.8.html">nmbd(8)</ulink>
4357 what the default 'time to live' of NetBIOS names should be (in seconds)
4358 when <command>nmbd</command> is requesting a name using either a
4359 broadcast packet or from a WINS server. You should never need to
4360 change this parameter. The default is 3 days.</para>
4362 <para>Default: <command>max ttl = 259200</command></para>
4363 </listitem>
4364 </varlistentry>
4368 <varlistentry>
4369 <term><anchor id="MAXWINSTTL">max wins ttl (G)</term>
4370 <listitem><para>This option tells <ulink url="nmbd.8.html">nmbd(8)
4371 </ulink> when acting as a WINS server (<link linkend="WINSSUPPORT">
4372 <parameter>wins support=yes</parameter></link>) what the maximum
4373 'time to live' of NetBIOS names that <command>nmbd</command>
4374 will grant will be (in seconds). You should never need to change this
4375 parameter. The default is 6 days (518400 seconds).</para>
4377 <para>See also the <link linkend="MINWINSTTL"><parameter>min
4378 wins ttl"</parameter></link> parameter.</para>
4380 <para>Default: <command>max wins ttl = 518400</command></para>
4381 </listitem>
4382 </varlistentry>
4386 <varlistentry>
4387 <term><anchor id="MAXXMIT">max xmit (G)</term>
4388 <listitem><para>This option controls the maximum packet size
4389 that will be negotiated by Samba. The default is 65535, which
4390 is the maximum. In some cases you may find you get better performance
4391 with a smaller value. A value below 2048 is likely to cause problems.
4392 </para>
4394 <para>Default: <command>max xmit = 65535</command></para>
4395 <para>Example: <command>max xmit = 8192</command></para>
4396 </listitem>
4397 </varlistentry>
4401 <varlistentry>
4402 <term><anchor id="MESSAGECOMMAND">message command (G)</term>
4403 <listitem><para>This specifies what command to run when the
4404 server receives a WinPopup style message.</para>
4406 <para>This would normally be a command that would
4407 deliver the message somehow. How this is to be done is
4408 up to your imagination.</para>
4410 <para>An example is:</para>
4412 <para><command>message command = csh -c 'xedit %s;rm %s' &</command>
4413 </para>
4415 <para>This delivers the message using <command>xedit</command>, then
4416 removes it afterwards. <emphasis>NOTE THAT IT IS VERY IMPORTANT
4417 THAT THIS COMMAND RETURN IMMEDIATELY</emphasis>. That's why I
4418 have the '&' on the end. If it doesn't return immediately then
4419 your PCs may freeze when sending messages (they should recover
4420 after 30secs, hopefully).</para>
4422 <para>All messages are delivered as the global guest user.
4423 The command takes the standard substitutions, although <parameter>
4424 %u</parameter> won't work (<parameter>%U</parameter> may be better
4425 in this case).</para>
4427 <para>Apart from the standard substitutions, some additional
4428 ones apply. In particular:</para>
4430 <itemizedlist>
4431 <listitem><para><parameter>%s</parameter> = the filename containing
4432 the message.</para></listitem>
4434 <listitem><para><parameter>%t</parameter> = the destination that
4435 the message was sent to (probably the server name).</para></listitem>
4437 <listitem><para><parameter>%f</parameter> = who the message
4438 is from.</para></listitem>
4439 </itemizedlist>
4441 <para>You could make this command send mail, or whatever else
4442 takes your fancy. Please let us know of any really interesting
4443 ideas you have.</para>
4446 <para>Here's a way of sending the messages as mail to root:</para>
4448 <para><command>message command = /bin/mail -s 'message from %f on
4449 %m' root &lt; %s; rm %s</command></para>
4451 <para>If you don't have a message command then the message
4452 won't be delivered and Samba will tell the sender there was
4453 an error. Unfortunately WfWg totally ignores the error code
4454 and carries on regardless, saying that the message was delivered.
4455 </para>
4457 <para>If you want to silently delete it then try:</para>
4459 <para><command>message command = rm %s</command></para>
4461 <para>Default: <emphasis>no message command</emphasis></para>
4462 <para>Example: <command>message command = csh -c 'xedit %s;
4463 rm %s' &</command></para>
4464 </listitem>
4465 </varlistentry>
4470 <varlistentry>
4471 <term><anchor id="MINPASSWDLENGTH">min passwd length (G)</term>
4472 <listitem><para>Synonym for <link linkend="MINPASSWORDLENGTH">
4473 <parameter>min password length</parameter></link>.</para>
4474 </listitem>
4475 </varlistentry>
4479 <varlistentry>
4480 <term><anchor id="MINPASSWORDLENGTH">min password length (G)</term>
4481 <listitem><para>This option sets the minimum length in characters
4482 of a plaintext password that <command>smbd</command> will accept when performing
4483 UNIX password changing.</para>
4485 <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix
4486 password sync</parameter></link>, <link linkend="PASSWDPROGRAM">
4487 <parameter>passwd program</parameter></link> and <link
4488 linkend="PASSWDCHATDEBUG"><parameter>passwd chat debug</parameter>
4489 </link>.</para>
4491 <para>Default: <command>min password length = 5</command></para>
4492 </listitem>
4493 </varlistentry>
4497 <varlistentry>
4498 <term><anchor id="MINPRINTSPACE">min print space (S)</term>
4499 <listitem><para>This sets the minimum amount of free disk
4500 space that must be available before a user will be able to spool
4501 a print job. It is specified in kilobytes. The default is 0, which
4502 means a user can always spool a print job.</para>
4504 <para>See also the <link linkend="PRINTING"><parameter>printing
4505 </parameter></link> parameter.</para>
4507 <para>Default: <command>min print space = 0</command></para>
4508 <para>Example: <command>min print space = 2000</command></para>
4509 </listitem>
4510 </varlistentry>
4515 <varlistentry>
4516 <term><anchor id="MINPROTOCOL">min protocol (G)</term>
4517 <listitem><para>The value of the parameter (a string) is the
4518 lowest SMB protocol dialect than Samba will support. Please refer
4519 to the <link linkend="MAXPROTOCOL"><parameter>max protocol</parameter></link>
4520 parameter for a list of valid protocol names and a brief description
4521 of each. You may also wish to refer to the C source code in
4522 <filename>source/smbd/negprot.c</filename> for a listing of known protocol
4523 dialects supported by clients.</para>
4525 <para>If you are viewing this parameter as a security measure, you should
4526 also refer to the <link linkend="LANMANAUTH"><parameter>lanman
4527 auth</parameter></link> parameter. Otherwise, you should never need
4528 to change this parameter.</para>
4530 <para>Default : <command>min protocol = CORE</command></para>
4531 <para>Example : <command>min protocol = NT1</command> # disable DOS
4532 clients</para>
4533 </listitem>
4534 </varlistentry>
4539 <varlistentry>
4540 <term><anchor id="MINWINSTTL">min wins ttl (G)</term>
4541 <listitem><para>This option tells <ulink url="nmbd.8.html">nmbd(8)</ulink>
4542 when acting as a WINS server (<link linkend="WINSSUPPORT"><parameter>
4543 wins support = yes</parameter></link>) what the minimum 'time to live'
4544 of NetBIOS names that <command>nmbd</command> will grant will be (in
4545 seconds). You should never need to change this parameter. The default
4546 is 6 hours (21600 seconds).</para>
4548 <para>Default: <command>min wins ttl = 21600</command></para>
4549 </listitem>
4550 </varlistentry>
4555 <varlistentry>
4556 <term><anchor id="MSDFSROOT">msdfs root (S)</term>
4557 <listitem><para>This boolean parameter is only available if
4558 Samba is configured and compiled with the <command>
4559 --with-msdfs</command> option. If set to <constant>yes></constant>,
4560 Samba treats the share as a Dfs root and allows clients to browse
4561 the distributed file system tree rooted at the share directory.
4562 Dfs links are specified in the share directory by symbolic
4563 links of the form <filename>msdfs:serverA\shareA,serverB\shareB
4564 </filename> and so on. For more information on setting up a Dfs tree
4565 on Samba, refer to <ulink url="msdfs_setup.html">msdfs_setup.html
4566 </ulink>.</para>
4568 <para>See also <link linkend="HOSTMSDFS"><parameter>host msdfs
4569 </parameter></link></para>
4571 <para>Default: <command>msdfs root = no</command></para>
4572 </listitem>
4573 </varlistentry>
4576 <varlistentry>
4577 <term><anchor id="NAMERESOLVEORDER">name resolve order (G)</term>
4578 <listitem><para>This option is used by the programs in the Samba
4579 suite to determine what naming services to use and in what order
4580 to resolve host names to IP addresses. The option takes a space
4581 separated string of name resolution options.</para>
4583 <para>The options are :"lmhosts", "host", "wins" and "bcast". They
4584 cause names to be resolved as follows :</para>
4586 <itemizedlist>
4587 <listitem><para><constant>lmhosts</constant> : Lookup an IP
4588 address in the Samba lmhosts file. If the line in lmhosts has
4589 no name type attached to the NetBIOS name (see the <ulink
4590 url="lmhosts.5.html">lmhosts(5)</ulink> for details) then
4591 any name type matches for lookup.</para></listitem>
4593 <listitem><para><constant>host</constant> : Do a standard host
4594 name to IP address resolution, using the system <filename>/etc/hosts
4595 </filename>, NIS, or DNS lookups. This method of name resolution
4596 is operating system depended for instance on IRIX or Solaris this
4597 may be controlled by the <filename>/etc/nsswitch.conf</filename>
4598 file). Note that this method is only used if the NetBIOS name
4599 type being queried is the 0x20 (server) name type, otherwise
4600 it is ignored.</para></listitem>
4602 <listitem><para><constant>wins</constant> : Query a name with
4603 the IP address listed in the <link linkend="WINSSERVER"><parameter>
4604 wins server</parameter></link> parameter. If no WINS server has
4605 been specified this method will be ignored.</para></listitem>
4607 <listitem><para><constant>bcast</constant> : Do a broadcast on
4608 each of the known local interfaces listed in the <link
4609 linkend="INTERFACES"><parameter>interfaces</parameter></link>
4610 parameter. This is the least reliable of the name resolution
4611 methods as it depends on the target host being on a locally
4612 connected subnet.</para></listitem>
4613 </itemizedlist>
4615 <para>Default: <command>name resolve order = lmhosts host wins bcast
4616 </command></para>
4617 <para>Example: <command>name resolve order = lmhosts bcast host
4618 </command></para>
4620 <para>This will cause the local lmhosts file to be examined
4621 first, followed by a broadcast attempt, followed by a normal
4622 system hostname lookup.</para>
4623 </listitem>
4624 </varlistentry>
4629 <varlistentry>
4630 <term><anchor id="NETBIOSALIASES">netbios aliases (G)</term>
4631 <listitem><para>This is a list of NetBIOS names that <ulink
4632 url="nmbd.8.html">nmbd(8)</ulink> will advertise as additional
4633 names by which the Samba server is known. This allows one machine
4634 to appear in browse lists under multiple names. If a machine is
4635 acting as a browse server or logon server none
4636 of these names will be advertised as either browse server or logon
4637 servers, only the primary name of the machine will be advertised
4638 with these capabilities.</para>
4640 <para>See also <link linkend="NETBIOSNAME"><parameter>netbios
4641 name</parameter></link>.</para>
4643 <para>Default: <emphasis>empty string (no additional names)</emphasis></para>
4644 <para>Example: <command>netbios aliases = TEST TEST1 TEST2</command></para>
4645 </listitem>
4646 </varlistentry>
4650 <varlistentry>
4651 <term><anchor id="NETBIOSNAME">netbios name (G)</term>
4652 <listitem><para>This sets the NetBIOS name by which a Samba
4653 server is known. By default it is the same as the first component
4654 of the host's DNS name. If a machine is a browse server or
4655 logon server this name (or the first component
4656 of the hosts DNS name) will be the name that these services are
4657 advertised under.</para>
4659 <para>See also <link linkend="NETBIOSALIASES"><parameter>netbios
4660 aliases</parameter></link>.</para>
4662 <para>Default: <emphasis>machine DNS name</emphasis></para>
4663 <para>Example: <command>netbios name = MYNAME</command></para>
4664 </listitem>
4665 </varlistentry>
4669 <varlistentry>
4670 <term><anchor id="NETBIOSSCOPE">netbios scope (G)</term>
4671 <listitem><para>This sets the NetBIOS scope that Samba will
4672 operate under. This should not be set unless every machine
4673 on your LAN also sets this value.</para>
4674 </listitem>
4675 </varlistentry>
4678 <varlistentry>
4679 <term><anchor id="NISHOMEDIR">nis homedir (G)</term>
4680 <listitem><para>Get the home share server from a NIS map. For
4681 UNIX systems that use an automounter, the user's home directory
4682 will often be mounted on a workstation on demand from a remote
4683 server. </para>
4685 <para>When the Samba logon server is not the actual home directory
4686 server, but is mounting the home directories via NFS then two
4687 network hops would be required to access the users home directory
4688 if the logon server told the client to use itself as the SMB server
4689 for home directories (one over SMB and one over NFS). This can
4690 be very slow.</para>
4692 <para>This option allows Samba to return the home share as
4693 being on a different server to the logon server and as
4694 long as a Samba daemon is running on the home directory server,
4695 it will be mounted on the Samba client directly from the directory
4696 server. When Samba is returning the home share to the client, it
4697 will consult the NIS map specified in <link linkend="HOMEDIRMAP">
4698 <parameter>homedir map</parameter></link> and return the server
4699 listed there.</para>
4701 <para>Note that for this option to work there must be a working
4702 NIS system and the Samba server with this option must also
4703 be a logon server.</para>
4705 <para>Default: <command>nis homedir = no</command></para>
4706 </listitem>
4707 </varlistentry>
4711 <varlistentry>
4712 <term><anchor id="NTACLSUPPORT">nt acl support (G)</term>
4713 <listitem><para>This boolean parameter controls whether
4714 <ulink url="smbd.8.html">smbd(8)</ulink> will attempt to map
4715 UNIX permissions into Windows NT access control lists.</para>
4717 <para>Default: <command>nt acl support = yes</command></para>
4718 </listitem>
4719 </varlistentry>
4723 <varlistentry>
4724 <term><anchor id="NTPIPESUPPORT">nt pipe support (G)</term>
4725 <listitem><para>This boolean parameter controls whether
4726 <ulink url="smbd.8.html">smbd(8)</ulink> will allow Windows NT
4727 clients to connect to the NT SMB specific <constant>IPC$</constant>
4728 pipes. This is a developer debugging option and can be left
4729 alone.</para>
4731 <para>Default: <command>nt pipe support = yes</command></para>
4732 </listitem>
4733 </varlistentry>
4737 <varlistentry>
4738 <term><anchor id="NTSMBSUPPORT">nt smb support (G)</term>
4739 <listitem><para>This boolean parameter controls whether <ulink
4740 url="smbd.8.html">smbd(8)</ulink> will negotiate NT specific SMB
4741 support with Windows NT clients. Although this is a developer
4742 debugging option and should be left alone, benchmarking has discovered
4743 that Windows NT clients give faster performance with this option
4744 set to <constant>no</constant>. This is still being investigated.
4745 If this option is set to <constant>no</constant> then Samba offers
4746 exactly the same SMB calls that versions prior to Samba 2.0 offered.
4747 This information may be of use if any users are having problems
4748 with NT SMB support.</para>
4750 <para>You should not need to ever disable this parameter.</para>
4752 <para>Default: <command>nt smb support = yes</command></para>
4753 </listitem>
4754 </varlistentry>
4758 <varlistentry>
4759 <term><anchor id="NULLPASSWORDS">null passwords (G)</term>
4760 <listitem><para>Allow or disallow client access to accounts
4761 that have null passwords. </para>
4763 <para>See also <ulink url="smbpasswd.5.html">smbpasswd (5)</ulink>.</para>
4765 <para>Default: <command>null passwords = no</command></para>
4766 </listitem>
4767 </varlistentry>
4772 <varlistentry>
4773 <term><anchor id="OBEYPAMRESTRICTIONS">obey pam restrictions (G)</term>
4774 <listitem><para>When Samba 2.2 is configure to enable PAM support
4775 (i.e. --with-pam), this parameter will control whether or not Samba
4776 should obey PAM's account and session management directives. The
4777 default behavior is to use PAM for clear text authentication only
4778 and to ignore any account or session management. Note that Samba
4779 always ignores PAM for authentication in the case of <link
4780 linkend="ENCRYPTPASSWORDS"><parameter>encrypt passwords = yes</parameter>
4781 </link>. The reason is that PAM modules cannot support the challenge/response
4782 authentication mechanism needed in the presence of SMB password encryption.
4783 </para>
4785 <para>Default: <command>obey pam restrictions = no</command></para>
4786 </listitem>
4787 </varlistentry>
4793 <varlistentry>
4794 <term><anchor id="ONLYUSER">only user (S)</term>
4795 <listitem><para>This is a boolean option that controls whether
4796 connections with usernames not in the <parameter>user</parameter>
4797 list will be allowed. By default this option is disabled so that a
4798 client can supply a username to be used by the server. Enabling
4799 this parameter will force the server to only user the login
4800 names from the <parameter>user</parameter> list and is only really
4801 useful in <link linkend="SECURITYEQUALSSHARE">shave level</link>
4802 security.</para>
4804 <para>Note that this also means Samba won't try to deduce
4805 usernames from the service name. This can be annoying for
4806 the [homes] section. To get around this you could use <command>user =
4807 %S</command> which means your <parameter>user</parameter> list
4808 will be just the service name, which for home directories is the
4809 name of the user.</para>
4811 <para>See also the <link linkend="USER"><parameter>user</parameter>
4812 </link> parameter.</para>
4814 <para>Default: <command>only user = no</command></para>
4815 </listitem>
4816 </varlistentry>
4821 <varlistentry>
4822 <term><anchor id="ONLYGUEST">only guest (S)</term>
4823 <listitem><para>A synonym for <link linkend="GUESTONLY"><parameter>
4824 guest only</parameter></link>.</para>
4825 </listitem>
4826 </varlistentry>
4830 <varlistentry>
4831 <term><anchor id="OPLOCKBREAKWAITTIME">oplock break wait time (G)</term>
4832 <listitem><para>This is a tuning parameter added due to bugs in
4833 both Windows 9x and WinNT. If Samba responds to a client too
4834 quickly when that client issues an SMB that can cause an oplock
4835 break request, then the network client can fail and not respond
4836 to the break request. This tuning parameter (which is set in milliseconds)
4837 is the amount of time Samba will wait before sending an oplock break
4838 request to such (broken) clients.</para>
4840 <para><emphasis>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4841 AND UNDERSTOOD THE SAMBA OPLOCK CODE</emphasis>.</para>
4843 <para>Default: <command>oplock break wait time = 0</command></para>
4844 </listitem>
4845 </varlistentry>
4848 <varlistentry>
4849 <term><anchor id="OPLOCKCONTENTIONLIMIT">oplock contention limit (S)</term>
4850 <listitem><para>This is a <emphasis>very</emphasis> advanced
4851 <ulink url="smbd.8.html">smbd(8)</ulink> tuning option to
4852 improve the efficiency of the granting of oplocks under multiple
4853 client contention for the same file.</para>
4855 <para>In brief it specifies a number, which causes smbd not to
4856 grant an oplock even when requested if the approximate number of
4857 clients contending for an oplock on the same file goes over this
4858 limit. This causes <command>smbd</command> to behave in a similar
4859 way to Windows NT.</para>
4861 <para><emphasis>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
4862 AND UNDERSTOOD THE SAMBA OPLOCK CODE</emphasis>.</para>
4864 <para>Default: <command>oplock contention limit = 2</command></para>
4865 </listitem>
4866 </varlistentry>
4872 <varlistentry>
4873 <term><anchor id="OPLOCKS">oplocks (S)</term>
4874 <listitem><para>This boolean option tells smbd whether to
4875 issue oplocks (opportunistic locks) to file open requests on this
4876 share. The oplock code can dramatically (approx. 30% or more) improve
4877 the speed of access to files on Samba servers. It allows the clients
4878 to aggressively cache files locally and you may want to disable this
4879 option for unreliable network environments (it is turned on by
4880 default in Windows NT Servers). For more information see the file
4881 <filename>Speed.txt</filename> in the Samba <filename>docs/</filename>
4882 directory.</para>
4884 <para>Oplocks may be selectively turned off on certain files with a
4885 share. See the <link linkend="VETOOPLOCKFILES"><parameter>
4886 veto oplock files</parameter></link> parameter. On some systems
4887 oplocks are recognized by the underlying operating system. This
4888 allows data synchronization between all access to oplocked files,
4889 whether it be via Samba or NFS or a local UNIX process. See the
4890 <parameter>kernel oplocks</parameter> parameter for details.</para>
4892 <para>See also the <link linkend="KERNELOPLOCKS"><parameter>kernel
4893 oplocks</parameter></link> and <link linkend="LEVEL2OPLOCKS"><parameter>
4894 level2 oplocks</parameter></link> parameters.</para>
4896 <para>Default: <command>oplocks = yes</command></para>
4897 </listitem>
4898 </varlistentry>
4902 <varlistentry>
4903 <term><anchor id="OSLEVEL">os level (G)</term>
4904 <listitem><para>This integer value controls what level Samba
4905 advertises itself as for browse elections. The value of this
4906 parameter determines whether <ulink url="nmbd.8.html">nmbd(8)</ulink>
4907 has a chance of becoming a local master browser for the <parameter>
4908 WORKGROUP</parameter> in the local broadcast area.</para>
4910 <para><emphasis>Note :</emphasis>By default, Samba will win
4911 a local master browsing election over all Microsoft operating
4912 systems except a Windows NT 4.0/2000 Domain Controller. This
4913 means that a misconfigured Samba host can effectively isolate
4914 a subnet for browsing purposes. See <filename>BROWSING.txt
4915 </filename> in the Samba <filename>docs/</filename> directory
4916 for details.</para>
4918 <para>Default: <command>os level = 20</command></para>
4919 <para>Example: <command>os level = 65 </command></para>
4920 </listitem>
4921 </varlistentry>
4925 <varlistentry>
4926 <term><anchor id="OS2DRIVERMAP">os2 driver map (G)</term>
4927 <listitem><para>The parameter is used to define the absolute
4928 path to a file containing a mapping of Windows NT printer driver
4929 names to OS/2 printer driver names. The format is:</para>
4931 <para>&lt;nt driver name&gt; = &lt;os2 driver
4932 name&gt;.&lt;device name&gt;</para>
4934 <para>For example, a valid entry using the HP LaserJet 5
4935 printer driver woudl appear as <command>HP LaserJet 5L = LASERJET.HP
4936 LaserJet 5L</command>.</para>
4938 <para>The need for the file is due to the printer driver namespace
4939 problem described in the <ulink url="printer_driver2.html">Samba
4940 Printing HOWTO</ulink>. For more details on OS/2 clients, please
4941 refer to the <ulink url="OS2-Client-HOWTO.html">OS2-Client-HOWTO
4942 </ulink> containing in the Samba documentation.</para>
4944 <para>Default: <command>os2 driver map = &lt;empty string&gt;
4945 </command></para>
4946 </listitem>
4947 </varlistentry>
4950 <varlistentry>
4951 <term><anchor id="PAMPASSWORDCHANGE">pam password change (G)</term>
4952 <listitem><para>With the addition of better PAM support in Samba 2.2,
4953 this parameter, it is possible to use PAM's password change control
4954 flag for Samba. If enabled, then PAM will be used for password
4955 changes when requested by an SMB client, and the <link
4956 linkend="PASSWDCHAT"><parameter>passwd chat</parameter></link> string will
4957 be ignored.
4958 </para>
4960 <para>Default: <command>pam password change = no</command></para>
4962 </listitem>
4963 </varlistentry>
4966 <varlistentry>
4967 <term><anchor id="PANICACTION">panic action (G)</term>
4968 <listitem><para>This is a Samba developer option that allows a
4969 system command to be called when either <ulink url="smbd.8.html">
4970 smbd(8)</ulink> or <ulink url="nmbd.8.html">nmbd(8)</ulink>
4971 crashes. This is usually used to draw attention to the fact that
4972 a problem occurred.</para>
4974 <para>Default: <command>panic action = &lt;empty string&gt;</command></para>
4975 <para>Example: <command>panic action = "/bin/sleep 90000"</command></para>
4976 </listitem>
4977 </varlistentry>
4980 <varlistentry>
4981 <term><anchor id="PASSWDCHAT">passwd chat (G)</term>
4982 <listitem><para>This string controls the <emphasis>"chat"</emphasis>
4983 conversation that takes places between <ulink
4984 url="smbd.8.html">smbd</ulink> and the local password changing
4985 program to change the users password. The string describes a
4986 sequence of response-receive pairs that <ulink url="smbd.8.html">
4987 smbd(8)</ulink> uses to determine what to send to the
4988 <link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter>
4989 </link> and what to expect back. If the expected output is not
4990 received then the password is not changed.</para>
4992 <para>This chat sequence is often quite site specific, depending
4993 on what local methods are used for password control (such as NIS
4994 etc).</para>
4996 <para>The string can contain the macros <parameter>%o</parameter>
4997 and <parameter>%n</parameter> which are substituted for the old
4998 and new passwords respectively. It can also contain the standard
4999 macros <constant>\n</constant>, <constant>\r</constant>, <constant>
5000 \t</constant> and <constant>%s</constant> to give line-feed,
5001 carriage-return, tab and space.</para>
5003 <para>The string can also contain a '*' which matches
5004 any sequence of characters.</para>
5006 <para>Double quotes can be used to collect strings with spaces
5007 in them into a single string.</para>
5009 <para>If the send string in any part of the chat sequence
5010 is a fullstop ".", then no string is sent. Similarly,
5011 if the expect string is a fullstop then no string is expected.</para>
5013 <para>Note that if the <link linkend="UNIXPASSWORDSYNC"><parameter>unix
5014 password sync</parameter></link> parameter is set to true, then this
5015 sequence is called <emphasis>AS ROOT</emphasis> when the SMB password
5016 in the smbpasswd file is being changed, without access to the old
5017 password cleartext. In this case the old password cleartext is set
5018 to "" (the empty string).</para>
5020 <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix password
5021 sync</parameter></link>, <link linkend="PASSWDPROGRAM"><parameter>
5022 passwd program</parameter></link> and <link linkend="PASSWDCHATDEBUG">
5023 <parameter>passwd chat debug</parameter></link>.</para>
5025 <para>Default: <command>passwd chat = *new*password* %n\n
5026 *new*password* %n\n *changed*</command></para>
5027 <para>Example: <command>passwd chat = "*Enter OLD password*" %o\n
5028 "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password
5029 changed*"</command></para>
5030 </listitem>
5031 </varlistentry>
5035 <varlistentry>
5036 <term><anchor id="PASSWDCHATDEBUG">passwd chat debug (G)</term>
5037 <listitem><para>This boolean specifies if the passwd chat script
5038 parameter is run in <emphasis>debug</emphasis> mode. In this mode the
5039 strings passed to and received from the passwd chat are printed
5040 in the <ulink url="smbd.8.html">smbd(8)</ulink> log with a
5041 <link linkend="DEBUGLEVEL"><parameter>debug level</parameter></link>
5042 of 100. This is a dangerous option as it will allow plaintext passwords
5043 to be seen in the <command>smbd</command> log. It is available to help
5044 Samba admins debug their <parameter>passwd chat</parameter> scripts
5045 when calling the <parameter>passwd program</parameter> and should
5046 be turned off after this has been done. This parameter is off by
5047 default.</para>
5049 <para>See also <<link linkend="PASSWDCHAT"><parameter>passwd chat</parameter>
5050 </link>, <link linkend="PASSWDPROGRAM"><parameter>passwd program</parameter>
5051 </link>.</para>
5053 <para>Default: <command>passwd chat debug = no</command></para>
5054 </listitem>
5055 </varlistentry>
5059 <varlistentry>
5060 <term><anchor id="PASSWDPROGRAM">passwd program (G)</term>
5061 <listitem><para>The name of a program that can be used to set
5062 UNIX user passwords. Any occurrences of <parameter>%u</parameter>
5063 will be replaced with the user name. The user name is checked for
5064 existence before calling the password changing program.</para>
5066 <para>Also note that many passwd programs insist in <emphasis>reasonable
5067 </emphasis> passwords, such as a minimum length, or the inclusion
5068 of mixed case chars and digits. This can pose a problem as some clients
5069 (such as Windows for Workgroups) uppercase the password before sending
5070 it.</para>
5072 <para><emphasis>Note</emphasis> that if the <parameter>unix
5073 password sync</parameter> parameter is set to <constant>True
5074 </constant> then this program is called <emphasis>AS ROOT</emphasis>
5075 before the SMB password in the <ulink url="smbpasswd.5.html">smbpasswd(5)
5076 </ulink> file is changed. If this UNIX password change fails, then
5077 <command>smbd</command> will fail to change the SMB password also
5078 (this is by design).</para>
5080 <para>If the <parameter>unix password sync</parameter> parameter
5081 is set this parameter <emphasis>MUST USE ABSOLUTE PATHS</emphasis>
5082 for <emphasis>ALL</emphasis> programs called, and must be examined
5083 for security implications. Note that by default <parameter>unix
5084 password sync</parameter> is set to <constant>False</constant>.</para>
5086 <para>See also <link linkend="UNIXPASSWORDSYNC"><parameter>unix
5087 password sync</parameter></link>.</para>
5089 <para>Default: <command>passwd program = /bin/passwd</command></para>
5090 <para>Example: <command>passwd program = /sbin/npasswd %u</command>
5091 </para>
5092 </listitem>
5093 </varlistentry>
5097 <varlistentry>
5098 <term><anchor id="PASSWORDLEVEL">password level (G)</term>
5099 <listitem><para>Some client/server combinations have difficulty
5100 with mixed-case passwords. One offending client is Windows for
5101 Workgroups, which for some reason forces passwords to upper
5102 case when using the LANMAN1 protocol, but leaves them alone when
5103 using COREPLUS! Another problem child is the Windows 95/98
5104 family of operating systems. These clients upper case clear
5105 text passwords even when NT LM 0.12 selected by the protocol
5106 negotiation request/response.</para>
5108 <para>This parameter defines the maximum number of characters
5109 that may be upper case in passwords.</para>
5111 <para>For example, say the password given was "FRED". If <parameter>
5112 password level</parameter> is set to 1, the following combinations
5113 would be tried if "FRED" failed:</para>
5115 <para>"Fred", "fred", "fRed", "frEd","freD"</para>
5117 <para>If <parameter>password level</parameter> was set to 2,
5118 the following combinations would also be tried: </para>
5120 <para>"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..</para>
5122 <para>And so on.</para>
5124 <para>The higher value this parameter is set to the more likely
5125 it is that a mixed case password will be matched against a single
5126 case password. However, you should be aware that use of this
5127 parameter reduces security and increases the time taken to
5128 process a new connection.</para>
5130 <para>A value of zero will cause only two attempts to be
5131 made - the password as is and the password in all-lower case.</para>
5133 <para>Default: <command>password level = 0</command></para>
5134 <para>Example: <command>password level = 4</command</para>
5135 </listitem>
5136 </varlistentry>
5140 <varlistentry>
5141 <term><anchor id="PASSWORDSERVER">password server (G)</term>
5142 <listitem><para>By specifying the name of another SMB server (such
5143 as a WinNT box) with this option, and using <command>security = domain
5144 </command> or <command>security = server</command> you can get Samba
5145 to do all its username/password validation via a remote server.</para>
5147 <para>This option sets the name of the password server to use.
5148 It must be a NetBIOS name, so if the machine's NetBIOS name is
5149 different from its Internet name then you may have to add its NetBIOS
5150 name to the lmhosts file which is stored in the same directory
5151 as the <filename>smb.conf</filename> file.</para>
5153 <para>The name of the password server is looked up using the
5154 parameter <link linkend="NAMERESOLVEORDER"><parameter>name
5155 resolve order</parameter></link> and so may resolved
5156 by any method and order described in that parameter.</para>
5158 <para>The password server much be a machine capable of using
5159 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
5160 user level security mode.</para>
5162 <para><emphasis>NOTE:</emphasis> Using a password server
5163 means your UNIX box (running Samba) is only as secure as your
5164 password server. <emphasis>DO NOT CHOOSE A PASSWORD SERVER THAT
5165 YOU DON'T COMPLETELY TRUST</emphasis>.</para>
5167 <para>Never point a Samba server at itself for password
5168 serving. This will cause a loop and could lock up your Samba
5169 server!</para>
5171 <para>The name of the password server takes the standard
5172 substitutions, but probably the only useful one is <parameter>%m
5173 </parameter>, which means the Samba server will use the incoming
5174 client as the password server. If you use this then you better
5175 trust your clients, and you had better restrict them with hosts allow!</para>
5177 <para>If the <parameter>security</parameter> parameter is set to
5178 <constant>domain</constant>, then the list of machines in this
5179 option must be a list of Primary or Backup Domain controllers for the
5180 Domain or the character '*', as the Samba server is effectively
5181 in that domain, and will use cryptographically authenticated RPC calls
5182 to authenticate the user logging on. The advantage of using <command>
5183 security = domain</command> is that if you list several hosts in the
5184 <parameter>password server</parameter> option then <command>smbd
5185 </command> will try each in turn till it finds one that responds. This
5186 is useful in case your primary server goes down.</para>
5188 <para>If the <parameter>password server</parameter> option is set
5189 to the character '*', then Samba will attempt to auto-locate the
5190 Primary or Backup Domain controllers to authenticate against by
5191 doing a query for the name <constant>WORKGROUP&lt;1C&gt;</constant>
5192 and then contacting each server returned in the list of IP
5193 addresses from the name resolution source. </para>
5195 <para>If the <parameter>security</parameter> parameter is
5196 set to <constant>server</constant>, then there are different
5197 restrictions that <command>security = domain</command> doesn't
5198 suffer from:</para>
5200 <itemizedlist>
5201 <listitem><para>You may list several password servers in
5202 the <parameter>password server</parameter> parameter, however if an
5203 <command>smbd</command> makes a connection to a password server,
5204 and then the password server fails, no more users will be able
5205 to be authenticated from this <command>smbd</command>. This is a
5206 restriction of the SMB/CIFS protocol when in <command>security=server
5207 </command> mode and cannot be fixed in Samba.</para></listitem>
5209 <listitem><para>If you are using a Windows NT server as your
5210 password server then you will have to ensure that your users
5211 are able to login from the Samba server, as when in <command>
5212 security=server</command> mode the network logon will appear to
5213 come from there rather than from the users workstation.</para></listitem>
5214 </itemizedlist>
5216 <para>See also the <link linkend="SECURITY"><parameter>security
5217 </parameter></link> parameter.</para>
5219 <para>Default: <command>password server = &lt;empty string&gt;</command>
5220 </para>
5221 <para>Example: <command>password server = NT-PDC, NT-BDC1, NT-BDC2
5222 </command></para>
5223 <para>Example: <command>password server = *</command></para>
5224 </listitem>
5225 </varlistentry>
5229 <varlistentry>
5230 <term><anchor id="PATH">path (S)</term>
5231 <listitem><para>This parameter specifies a directory to which
5232 the user of the service is to be given access. In the case of
5233 printable services, this is where print data will spool prior to
5234 being submitted to the host for printing.</para>
5236 <para>For a printable service offering guest access, the service
5237 should be readonly and the path should be world-writeable and
5238 have the sticky bit set. This is not mandatory of course, but
5239 you probably won't get the results you expect if you do
5240 otherwise.</para>
5242 <para>Any occurrences of <parameter>%u</parameter> in the path
5243 will be replaced with the UNIX username that the client is using
5244 on this connection. Any occurrences of <parameter>%m</parameter>
5245 will be replaced by the NetBIOS name of the machine they are
5246 connecting from. These replacements are very useful for setting
5247 up pseudo home directories for users.</para>
5249 <para>Note that this path will be based on <link linkend="ROOTDIR">
5250 <parameter>root dir</parameter></link> if one was specified.</para>
5252 <para>Default: <emphasis>none</emphasis></para>
5253 <para>Example: <command>path = /home/fred</command></para>
5254 </listitem>
5255 </varlistentry>
5260 <varlistentry>
5261 <term><anchor id="POSIXLOCKING">posix locking (S)</term>
5262 <listitem><para>The <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>
5263 daemon maintains an database of file locks obtained by SMB clients.
5264 The default behavior is to map this internal database to POSIX
5265 locks. This means that file locks obtained by SMB clients are
5266 consistent with those seen by POSIX compliant applications accessing
5267 the files via a non-SMB method (e.g. NFS or local file access).
5268 You should never need to disable this parameter.</para>
5270 <para>Default: <command>posix locking = yes</command></para>
5271 </listitem>
5272 </varlistentry>
5277 <varlistentry>
5278 <term><anchor id="POSTEXEC">postexec (S)</term>
5279 <listitem><para>This option specifies a command to be run
5280 whenever the service is disconnected. It takes the usual
5281 substitutions. The command may be run as the root on some
5282 systems.</para>
5284 <para>An interesting example may be do unmount server
5285 resources:</para>
5287 <para><command>postexec = /etc/umount /cdrom</command></para>
5289 <para>See also <link linkend="PREEXEC"><parameter>preexec</parameter>
5290 </link>.</para>
5292 <para>Default: <emphasis>none (no command executed)</emphasis>
5293 </para>
5295 <para>Example: <command>postexec = echo \"%u disconnected from %S
5296 from %m (%I)\" &gt;&gt; /tmp/log</command></para>
5297 </listitem>
5298 </varlistentry>
5302 <varlistentry>
5303 <term><anchor id="POSTSCRIPT">postscript (S)</term>
5304 <listitem><para>This parameter forces a printer to interpret
5305 the print files as postscript. This is done by adding a <constant>%!
5306 </constant> to the start of print output.</para>
5308 <para>This is most useful when you have lots of PCs that persist
5309 in putting a control-D at the start of print jobs, which then
5310 confuses your printer.</para>
5312 <para>Default: <command>postscript = no</command></para>
5313 </listitem>
5314 </varlistentry>
5318 <varlistentry>
5319 <term><anchor id="PREEXEC">preexec (S)</term>
5320 <listitem><para>This option specifies a command to be run whenever
5321 the service is connected to. It takes the usual substitutions.</para>
5323 <para>An interesting example is to send the users a welcome
5324 message every time they log in. Maybe a message of the day? Here
5325 is an example:</para>
5327 <para><command>preexec = csh -c 'echo \"Welcome to %S!\" |
5328 /usr/local/samba/bin/smbclient -M %m -I %I' & </command></para>
5330 <para>Of course, this could get annoying after a while :-)</para>
5332 <para>See also <link linkend="PREEXECCLOSE"><parameter>preexec close
5333 </parameter</link> and <link linkend="POSTEXEC"><parameter>postexec
5334 </parameter></link>.</para>
5336 <para>Default: <emphasis>none (no command executed)</emphasis></para>
5337 <para>Example: <command>preexec = echo \"%u connected to %S from %m
5338 (%I)\" &gt;&gt; /tmp/log</command></para>
5339 </listitem>
5340 </varlistentry>
5344 <varlistentry>
5345 <term><anchor id="PREEXECCLOSE">preexec close (S)</term>
5346 <listitem><para>This boolean option controls whether a non-zero
5347 return code from <link linkend="PREEXEC"><parameter>preexec
5348 </parameter></link> should close the service being connected to.</para>
5350 <para>Default: <command>preexec close = no</command></para>
5351 </listitem>
5352 </varlistentry>
5355 <varlistentry>
5356 <term><anchor id="PREFERREDMASTER">preferred master (G)</term>
5357 <listitem><para>This boolean parameter controls if <ulink
5358 url="nmbd.8.html">nmbd(8)</ulink> is a preferred master browser
5359 for its workgroup.</para>
5361 <para>If this is set to true, on startup, <command>nmbd</command>
5362 will force an election, and it will have a slight advantage in
5363 winning the election. It is recommended that this parameter is
5364 used in conjunction with <command><link linkend="DOMAINMASTER"><parameter>
5365 domain master</parameter></link> = yes</command>, so that <command>
5366 nmbd</command> can guarantee becoming a domain master.</para>
5368 <para>Use this option with caution, because if there are several
5369 hosts (whether Samba servers, Windows 95 or NT) that are preferred
5370 master browsers on the same subnet, they will each periodically
5371 and continuously attempt to become the local master browser.
5372 This will result in unnecessary broadcast traffic and reduced browsing
5373 capabilities.</para>
5375 <para>See also <link linkend="OSLEVEL"><parameter>os level</parameter>
5376 </link>.</para>
5378 <para>Default: <command>preferred master = auto</command></para>
5379 </listitem>
5380 </varlistentry>
5384 <varlistentry>
5385 <term><anchor id="PREFEREDMASTER">prefered master (G)</term>
5386 <listitem><para>Synonym for <link linkend="PREFERREDMASTER"><parameter>
5387 preferred master</parameter></link> for people who cannot spell :-).</para>
5388 </listitem>
5389 </varlistentry>
5393 <varlistentry>
5394 <term><anchor id="PRELOAD">preload</term>
5395 <listitem><para>This is a list of services that you want to be
5396 automatically added to the browse lists. This is most useful
5397 for homes and printers services that would otherwise not be
5398 visible.</para>
5400 <para>Note that if you just want all printers in your
5401 printcap file loaded then the <link linkend="LOADPRINTERS">
5402 <parameter>load printers</parameter></link> option is easier.</para>
5404 <para>Default: <emphasis>no preloaded services</emphasis></para>
5406 <para>Example: <command>preload = fred lp colorlp</command></para>
5407 </listitem>
5408 </varlistentry>
5411 <varlistentry>
5412 <term><anchor id="PRESERVECASE">preserve case (S)</term>
5413 <listitem><para> This controls if new filenames are created
5414 with the case that the client passes, or if they are forced to
5415 be the <link linkend="DEFAULTCASE"><parameter>default case
5416 </parameter></link>.</para>
5418 <para>Default: <command>preserve case = yes</command></para>
5420 <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME
5421 MANGLING</link> for a fuller discussion.</para>
5422 </listitem>
5423 </varlistentry>
5427 <varlistentry>
5428 <term><anchor id="PRINTCOMMAND">print command (S)</term>
5429 <listitem><para>After a print job has finished spooling to
5430 a service, this command will be used via a <command>system()</command>
5431 call to process the spool file. Typically the command specified will
5432 submit the spool file to the host's printing subsystem, but there
5433 is no requirement that this be the case. The server will not remove
5434 the spool file, so whatever command you specify should remove the
5435 spool file when it has been processed, otherwise you will need to
5436 manually remove old spool files.</para>
5438 <para>The print command is simply a text string. It will be used
5439 verbatim, with two exceptions: All occurrences of <parameter>%s
5440 </parameter> and <parameter>%f</parameter> will be replaced by the
5441 appropriate spool file name, and all occurrences of <parameter>%p
5442 </parameter> will be replaced by the appropriate printer name. The
5443 spool file name is generated automatically by the server, the printer
5444 name is discussed below.</para>
5446 <para>The print command <emphasis>MUST</emphasis> contain at least
5447 one occurrence of <parameter>%s</parameter> or <parameter>%f
5448 </parameter> - the <parameter>%p</parameter> is optional. At the time
5449 a job is submitted, if no printer name is supplied the <parameter>%p
5450 </parameter> will be silently removed from the printer command.</para>
5452 <para>If specified in the [global] section, the print command given
5453 will be used for any printable service that does not have its own
5454 print command specified.</para>
5456 <para>If there is neither a specified print command for a
5457 printable service nor a global print command, spool files will
5458 be created but not processed and (most importantly) not removed.</para>
5460 <para>Note that printing may fail on some UNIXes from the
5461 <constant>nobody</constant> account. If this happens then create
5462 an alternative guest account that can print and set the <link
5463 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>
5464 in the [global] section.</para>
5466 <para>You can form quite complex print commands by realizing
5467 that they are just passed to a shell. For example the following
5468 will log a print job, print the file, then remove it. Note that
5469 ';' is the usual separator for command in shell scripts.</para>
5471 <para><command>print command = echo Printing %s &gt;&gt;
5472 /tmp/print.log; lpr -P %p %s; rm %s</command></para>
5474 <para>You may have to vary this command considerably depending
5475 on how you normally print files on your system. The default for
5476 the parameter varies depending on the setting of the <link linkend="PRINTING">
5477 <parameter>printing</parameter></link> parameter.</para>
5479 <para>Default: For <command>printing= BSD, AIX, QNX, LPRNG
5480 or PLP :</command></para>
5481 <para><command>print command = lpr -r -P%p %s</command></para>
5483 <para>For <command>printing= SYS or HPUX :</command></para>
5484 <para><command>print command = lp -c -d%p %s; rm %s</command></para>
5486 <para>For <command>printing=SOFTQ :</command></para>
5487 <para><command>print command = lp -d%p -s %s; rm %s</command></para>
5489 <para>Example: <command>print command = /usr/local/samba/bin/myprintscript
5490 %p %s</command></para>
5491 </listitem>
5492 </varlistentry>
5496 <varlistentry>
5497 <term><anchor id="PRINTOK">print ok (S)</term>
5498 <listitem><para>Synonym for <link linkend="PRINTABLE">
5499 <parameter>printable</parameter></link>.</para>
5500 </listitem>
5501 </varlistentry>
5506 <varlistentry>
5507 <term><anchor id="PRINTABLE">printable (S)</term>
5508 <listitem><para>If this parameter is <constant>yes</constant>, then
5509 clients may open, write to and submit spool files on the directory
5510 specified for the service. </para>
5512 <para>Note that a printable service will ALWAYS allow writing
5513 to the service path (user privileges permitting) via the spooling
5514 of print data. The <link linkend="WRITEABLE"><parameter>writeable
5515 </parameter></link> parameter controls only non-printing access to
5516 the resource.</para>
5518 <para>Default: <command>printable = no</command></para>
5519 </listitem>
5520 </varlistentry>
5524 <varlistentry>
5525 <term><anchor id="PRINTCAP">printcap (G)</term>
5526 <listitem><para>Synonym for <link linkend="PRINTCAPNAME"><parameter>
5527 printcap name</parameter></link>.</para>
5528 </listitem>
5529 </varlistentry>
5534 <varlistentry>
5535 <term><anchor id="PRINTCAPNAME">printcap name (G)</term>
5536 <listitem><para>This parameter may be used to override the
5537 compiled-in default printcap name used by the server (usually <filename>
5538 /etc/printcap</filename>). See the discussion of the <link
5539 linkend="PRINTERSSECT">[printers]</link> section above for reasons
5540 why you might want to do this.</para>
5542 <para>On System V systems that use <command>lpstat</command> to
5543 list available printers you can use <command>printcap name = lpstat
5544 </command> to automatically obtain lists of available printers. This
5545 is the default for systems that define SYSV at configure time in
5546 Samba (this includes most System V based systems). If <parameter>
5547 printcap name</parameter> is set to <command>lpstat</command> on
5548 these systems then Samba will launch <command>lpstat -v</command> and
5549 attempt to parse the output to obtain a printer list.</para>
5551 <para>A minimal printcap file would look something like this:</para>
5553 <para><programlisting>
5554 print1|My Printer 1
5555 print2|My Printer 2
5556 print3|My Printer 3
5557 print4|My Printer 4
5558 print5|My Printer 5
5559 </programlisting></para>
5561 <para>where the '|' separates aliases of a printer. The fact
5562 that the second alias has a space in it gives a hint to Samba
5563 that it's a comment.</para>
5565 <para><emphasis>NOTE</emphasis>: Under AIX the default printcap
5566 name is <filename>/etc/qconfig</filename>. Samba will assume the
5567 file is in AIX <filename>qconfig</filename> format if the string
5568 <filename>qconfig</filename> appears in the printcap filename.</para>
5570 <para>Default: <command>printcap name = /etc/printcap</command></para>
5571 <para>Example: <command>printcap name = /etc/myprintcap</command></para>
5572 </listitem>
5573 </varlistentry>
5579 <varlistentry>
5580 <term><anchor id="PRINTERADMIN">printer admin (S)</term>
5581 <listitem><para>This is a list of users that can do anything to
5582 printers via the remote administration interfaces offered by MS-RPC
5583 (usually using a NT workstation). Note that the root user always
5584 has admin rights.</para>
5586 <para>Default: <command>printer admin = &lt;empty string&gt;</command>
5587 </para>
5588 <para>Example: <command>printer admin = admin, @staff</command></para>
5589 </listitem>
5590 </varlistentry>
5596 <varlistentry>
5597 <term><anchor id="PRINTERDRIVER">printer driver (S)</term>
5598 <listitem><para><emphasis>Note :</emphasis>This is a depreciated
5599 parameter and will be removed in the next major release
5600 following version 2.2. Please see the instructions in
5601 <filename>PRINTER_DRIVER2.txt</filename> in the <filename>docs
5602 </filename> of the Samba distribution for more information
5603 on the new method of loading printer drivers onto a Samba server.
5604 </para>
5606 <para>This option allows you to control the string
5607 that clients receive when they ask the server for the printer driver
5608 associated with a printer. If you are using Windows95 or Windows NT
5609 then you can use this to automate the setup of printers on your
5610 system.</para>
5612 <para>You need to set this parameter to the exact string (case
5613 sensitive) that describes the appropriate printer driver for your
5614 system. If you don't know the exact string to use then you should
5615 first try with no <link linkend="PRINTERDRIVER"><parameter>
5616 printer driver</parameter></link> option set and the client will
5617 give you a list of printer drivers. The appropriate strings are
5618 shown in a scroll box after you have chosen the printer manufacturer.</para>
5620 <para>See also <link linkend="PRINTERDRIVERFILE"><parameter>printer
5621 driver file</parameter></link>.</para>
5623 <para>Example: <command>printer driver = HP LaserJet 4L</command></para>
5624 </listitem>
5625 </varlistentry>
5629 <varlistentry>
5630 <term><anchor id="PRINTERDRIVERFILE">printer driver file (G)</term>
5631 <listitem><para><emphasis>Note :</emphasis>This is a depreciated
5632 parameter and will be removed in the next major release
5633 following version 2.2. Please see the instructions in
5634 <filename>PRINTER_DRIVER2.txt</filename> in the <filename>docs
5635 </filename> of the Samba distribution for more information
5636 on the new method of loading printer drivers onto a Samba server.
5637 </para>
5639 <para>This parameter tells Samba where the printer driver
5640 definition file, used when serving drivers to Windows 95 clients, is
5641 to be found. If this is not set, the default is :</para>
5643 <para><filename><replaceable>SAMBA_INSTALL_DIRECTORY</replaceable>
5644 /lib/printers.def</filename></para>
5646 <para>This file is created from Windows 95 <filename>msprint.inf
5647 </filename> files found on the Windows 95 client system. For more
5648 details on setting up serving of printer drivers to Windows 95
5649 clients, see the documentation file in the <filename>docs/</filename>
5650 directory, <filename>PRINTER_DRIVER.txt</filename>.</para>
5652 <para>See also <link linkend="PRINTERDRIVERLOCATION"><parameter>
5653 printer driver location</parameter></link>.</para>
5655 <para>Default: <emphasis>None (set in compile).</emphasis></para>
5657 <para>Example: <command>printer driver file =
5658 /usr/local/samba/printers/drivers.def</command></para>
5659 </listitem>
5660 </varlistentry>
5665 <varlistentry>
5666 <term><anchor id="PRINTERDRIVERLOCATION">printer driver location (S)</term>
5667 <listitem><para><emphasis>Note :</emphasis>This is a depreciated
5668 parameter and will be removed in the next major release
5669 following version 2.2. Please see the instructions in
5670 <filename>PRINTER_DRIVER2.txt</filename> in the <filename>docs
5671 </filename> of the Samba distribution for more information
5672 on the new method of loading printer drivers onto a Samba server.
5673 </para>
5675 <para>This parameter tells clients of a particular printer
5676 share where to find the printer driver files for the automatic
5677 installation of drivers for Windows 95 machines. If Samba is set up
5678 to serve printer drivers to Windows 95 machines, this should be set to</para>
5680 <para><command>\\MACHINE\PRINTER$</command></para>
5682 <para>Where MACHINE is the NetBIOS name of your Samba server,
5683 and PRINTER$ is a share you set up for serving printer driver
5684 files. For more details on setting this up see the documentation
5685 file in the <filename>docs/</filename> directory, <filename>
5686 PRINTER_DRIVER.txt</filename>.</para>
5688 <para>See also <link linkend="PRINTERDRIVERFILE"><parameter>
5689 printer driver file</parameter></link>.</para>
5691 <para>Default: <command>none</command></para>
5692 <para>Example: <command>printer driver location = \\MACHINE\PRINTER$
5693 </command></para>
5694 </listitem>
5695 </varlistentry>
5699 <varlistentry>
5700 <term><anchor id="PRINTERNAME">printer name (S)</term>
5701 <listitem><para>This parameter specifies the name of the printer
5702 to which print jobs spooled through a printable service will be sent.</para>
5704 <para>If specified in the [global] section, the printer
5705 name given will be used for any printable service that does
5706 not have its own printer name specified.</para>
5708 <para>Default: <emphasis>none (but may be <constant>lp</constant>
5709 on many systems)</emphasis></para>
5711 <para>Example: <command>printer name = laserwriter</command></para>
5712 </listitem>
5713 </varlistentry>
5716 <varlistentry>
5717 <term><anchor id="PRINTER">printer (S)</term>
5718 <listitem><para>Synonym for <link linkend="PRINTERNAME"><parameter>
5719 printer name</parameter></link>.</para>
5720 </listitem>
5721 </varlistentry>
5725 <varlistentry>
5726 <term><anchor id="PRINTING">printing (S)</term>
5727 <listitem><para>This parameters controls how printer status
5728 information is interpreted on your system. It also affects the
5729 default values for the <parameter>print command</parameter>,
5730 <parameter>lpq command</parameter>, <parameter>lppause command
5731 </parameter>, <parameter>lpresume command</parameter>, and
5732 <parameter>lprm command</parameter> if specified in the
5733 [global]f> section.</para>
5735 <para>Currently eight printing styles are supported. They are
5736 <constant>BSD</constant>, <constant>AIX</constant>,
5737 <constant>LPRNG</constant>, <constant>PLP</constant>,
5738 <constant>SYSV</constant>, <constant>HPUX</constant>,
5739 <constant>QNX</constant>, <constant>SOFTQ</constant>,
5740 and <constant>CUPS</constant>.</para>
5742 <para>To see what the defaults are for the other print
5743 commands when using the various options use the <ulink
5744 url="testparm.1.html">testparm(1)</ulink> program.</para>
5746 <para>This option can be set on a per printer basis</para>
5748 <para>See also the discussion in the <link linkend="PRINTERSSECT">
5749 [printers]</link> section.</para>
5750 </listitem>
5751 </varlistentry>
5756 <varlistentry>
5757 <term><anchor id="PROTOCOL">protocol (G)</term>
5758 <listitem><para>Synonym for <link linkend="MAXPROTOCOL">
5759 <parameter>max protocol</parameter></link>.</para></listitem>
5760 </varlistentry>
5765 <varlistentry>
5766 <term><anchor id="PUBLIC">public (S)</term>
5767 <listitem><para>Synonym for <link linkend="GUESTOK"><parameter>guest
5768 ok</parameter></link>.</para>
5769 </listitem>
5770 </varlistentry>
5774 <varlistentry>
5775 <term><anchor id="QUEUEPAUSECOMMAND">queuepause command (S)</term>
5776 <listitem><para>This parameter specifies the command to be
5777 executed on the server host in order to pause the printerqueue.</para>
5779 <para>This command should be a program or script which takes
5780 a printer name as its only parameter and stops the printerqueue,
5781 such that no longer jobs are submitted to the printer.</para>
5783 <para>This command is not supported by Windows for Workgroups,
5784 but can be issued from the Printer's window under Windows 95
5785 and NT.</para>
5787 <para>If a <parameter>%p</parameter> is given then the printername
5788 is put in its place. Otherwise it is placed at the end of the command.
5789 </para>
5791 <para>Note that it is good practice to include the absolute
5792 path in the command as the PATH may not be available to the
5793 server.</para>
5795 <para>Default: <emphasis>depends on the setting of <parameter>printing
5796 </parameter></emphasis></para>
5797 <para>Example: <command>queuepause command = disable %p</command></para>
5798 </listitem>
5799 </varlistentry>
5803 <varlistentry>
5804 <term><anchor id="QUEUERESUMECOMMAND">queueresume command (S)</term>
5805 <listitem><para>This parameter specifies the command to be
5806 executed on the server host in order to resume the printerqueue. It
5807 is the command to undo the behavior that is caused by the
5808 previous parameter (<link linkend="QUEUEPAUSECOMMAND"><parameter>
5809 queuepause command</parameter></link>).</para>
5811 <para>This command should be a program or script which takes
5812 a printer name as its only parameter and resumes the printerqueue,
5813 such that queued jobs are resubmitted to the printer.</para>
5815 <para>This command is not supported by Windows for Workgroups,
5816 but can be issued from the Printer's window under Windows 95
5817 and NT.</para>
5819 <para>If a <parameter>%p</parameter> is given then the printername
5820 is put in its place. Otherwise it is placed at the end of the
5821 command.</para>
5823 <para>Note that it is good practice to include the absolute
5824 path in the command as the PATH may not be available to the
5825 server.</para>
5827 <para>Default: <emphasis>depends on the setting of <link
5828 linkend="PRINTING"><parameter>printing</parameter></link></emphasis>
5829 </para>
5831 <para>Example: <command>queuepause command = enable %p
5832 </command></para>
5833 </listitem>
5834 </varlistentry>
5838 <varlistentry>
5839 <term><anchor id="READBMPX">read bmpx (G)</term>
5840 <listitem><para>This boolean parameter controls whether <ulink
5841 url="smbd.8.html">smbd(8)</ulink> will support the "Read
5842 Block Multiplex" SMB. This is now rarely used and defaults to
5843 <constant>no</constant>. You should never need to set this
5844 parameter.</para>
5846 <para>Default: <command>read bmpx = no</command></para>
5847 </listitem>
5848 </varlistentry>
5853 <varlistentry>
5854 <term><anchor id="READLIST">read list (S)</term>
5855 <listitem><para>This is a list of users that are given read-only
5856 access to a service. If the connecting user is in this list then
5857 they will not be given write access, no matter what the <link
5858 linkend="WRITEABLE"><parameter>writeable</parameter></link>
5859 option is set to. The list can include group names using the
5860 syntax described in the <link linkend="INVALIDUSERS"><parameter>
5861 invalid users</parameter></link> parameter.</para>
5863 <para>See also the <link linkend="WRITELIST"><parameter>
5864 write list</parameter></link> parameter and the <link
5865 linkend="INVALIDUSERS"><parameter>invalid users</parameter>
5866 </link> parameter.</para>
5868 <para>Default: <command>read list = &lt;empty string&gt;</command></para>
5869 <para>Example: <command>read list = mary, @students</command></para>
5870 </listitem>
5871 </varlistentry>
5875 <varlistentry>
5876 <term><anchor id="READONLY">read only (S)</term>
5877 <listitem><para>Note that this is an inverted synonym for <link
5878 linkend="WRITEABLE"><parameter>writeable</parameter></link>.</para>
5879 </listitem>
5880 </varlistentry>
5884 <varlistentry>
5885 <term><anchor id="READRAW">read raw (G)</term>
5886 <listitem><para>This parameter controls whether or not the server
5887 will support the raw read SMB requests when transferring data
5888 to clients.</para>
5890 <para>If enabled, raw reads allow reads of 65535 bytes in
5891 one packet. This typically provides a major performance benefit.
5892 </para>
5894 <para>However, some clients either negotiate the allowable
5895 block size incorrectly or are incapable of supporting larger block
5896 sizes, and for these clients you may need to disable raw reads.</para>
5898 <para>In general this parameter should be viewed as a system tuning
5899 tool and left severely alone. See also <link linkend="WRITERAW">
5900 <parameter>write raw</parameter></link>.</para>
5902 <para>Default: <command>read raw = yes</command></para>
5903 </listitem>
5904 </varlistentry>
5907 <varlistentry>
5908 <term><anchor id="READSIZE">read size (G)</term>
5909 <listitem><para>The option <parameter>read size</parameter>
5910 affects the overlap of disk reads/writes with network reads/writes.
5911 If the amount of data being transferred in several of the SMB
5912 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
5913 than this value then the server begins writing the data before it
5914 has received the whole packet from the network, or in the case of
5915 SMBreadbraw, it begins writing to the network before all the data
5916 has been read from disk.</para>
5918 <para>This overlapping works best when the speeds of disk and
5919 network access are similar, having very little effect when the
5920 speed of one is much greater than the other.</para>
5922 <para>The default value is 16384, but very little experimentation
5923 has been done yet to determine the optimal value, and it is likely
5924 that the best value will vary greatly between systems anyway.
5925 A value over 65536 is pointless and will cause you to allocate
5926 memory unnecessarily.</para>
5928 <para>Default: <command>read size = 16384</command></para>
5929 <para>Example: <command>read size = 8192</command></para>
5930 </listitem>
5931 </varlistentry>
5935 <varlistentry>
5936 <term><anchor id="REMOTEANNOUNCE">remote announce (G)</term>
5937 <listitem><para>This option allows you to setup <ulink
5938 url="nmbd.8.html">nmbd(8)</ulink> to periodically announce itself
5939 to arbitrary IP addresses with an arbitrary workgroup name.</para>
5941 <para>This is useful if you want your Samba server to appear
5942 in a remote workgroup for which the normal browse propagation
5943 rules don't work. The remote workgroup can be anywhere that you
5944 can send IP packets to.</para>
5946 <para>For example:</para>
5948 <para><command>remote announce = 192.168.2.255/SERVERS
5949 192.168.4.255/STAFF</command></para>
5951 <para>the above line would cause nmbd to announce itself
5952 to the two given IP addresses using the given workgroup names.
5953 If you leave out the workgroup name then the one given in
5954 the <link linkend="WORKGROUP"><parameter>workgroup</parameter></link>
5955 parameter is used instead.</para>
5957 <para>The IP addresses you choose would normally be the broadcast
5958 addresses of the remote networks, but can also be the IP addresses
5959 of known browse masters if your network config is that stable.</para>
5961 <para>See the documentation file <filename>BROWSING.txt</filename>
5962 in the <filename>docs/</filename> directory.</para>
5964 <para>Default: <command>remote announce = &lt;empty string&gt;
5965 </command></para>
5966 </listitem>
5967 </varlistentry>
5971 <varlistentry>
5972 <term><anchor id="REMOTEBROWSESYNC">remote browse sync (G)</term>
5973 <listitem><para>This option allows you to setup <ulink
5974 url="nmbd.8.html">nmbd(8)</ulink> to periodically request
5975 synchronization of browse lists with the master browser of a samba
5976 server that is on a remote segment. This option will allow you to
5977 gain browse lists for multiple workgroups across routed networks. This
5978 is done in a manner that does not work with any non-samba servers.</para>
5980 <para>This is useful if you want your Samba server and all local
5981 clients to appear in a remote workgroup for which the normal browse
5982 propagation rules don't work. The remote workgroup can be anywhere
5983 that you can send IP packets to.</para>
5985 <para>For example:</para>
5987 <para><command>remote browse sync = 192.168.2.255 192.168.4.255
5988 </command></para>
5990 <para>the above line would cause <command>nmbd</command> to request
5991 the master browser on the specified subnets or addresses to
5992 synchronize their browse lists with the local server.</para>
5994 <para>The IP addresses you choose would normally be the broadcast
5995 addresses of the remote networks, but can also be the IP addresses
5996 of known browse masters if your network config is that stable. If
5997 a machine IP address is given Samba makes NO attempt to validate
5998 that the remote machine is available, is listening, nor that it
5999 is in fact the browse master on it's segment.</para>
6001 <para>Default: <command>remote browse sync = &lt;empty string&gt;
6002 </command></para>
6003 </listitem>
6004 </varlistentry>
6008 <varlistentry>
6009 <term><anchor id="RESTRICTACLWITHMASK">restrict acl with mask (S)</term>
6010 <listitem><para>This is a boolean parameter. If set to false (default), then
6011 Creation of files with access control lists (ACLS) and modification of ACLs
6012 using the Windows NT/2000 ACL editor will be applied directly to the file
6013 or directory.</para>
6015 <para>If set to True, then all requests to set an ACL on a file will have the
6016 parameters <link linkend="CREATEMASK"><parameter>create mask</parameter></link>,
6017 <link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>
6018 applied before setting the ACL, and all requests to set an ACL on a directory will
6019 have the parameters <link linkend="DIRECTORYMASK"><parameter>directory
6020 mask</parameter></link>, <link linkend="FORCEDIRECTORYMODE"><parameter>force
6021 directory mode</parameter></link> applied before setting the ACL.
6022 </para>
6024 <para>See also <link linkend="CREATEMASK"><parameter>create mask</parameter></link>,
6025 <link linkend="FORCECREATEMODE"><parameter>force create mode</parameter></link>,
6026 <link linkend="DIRECTORYMASK"><parameter>directory mask</parameter></link>,
6027 <link linkend="FORCEDIRECTORYMODE"><parameter>force directory mode</parameter></link>
6028 </para>
6030 <para>Default: <command>restrict acl with mask = no</command></para>
6031 </listitem>
6032 </varlistentry>
6037 <varlistentry>
6038 <term><anchor id="RESTRICTANONYMOUS">restrict anonymous (G)</term>
6039 <listitem><para>This is a boolean parameter. If it is true, then
6040 anonymous access to the server will be restricted, namely in the
6041 case where the server is expecting the client to send a username,
6042 but it doesn't. Setting it to true will force these anonymous
6043 connections to be denied, and the client will be required to always
6044 supply a username and password when connecting. Use of this parameter
6045 is only recommended for homogeneous NT client environments.</para>
6047 <para>This parameter makes the use of macro expansions that rely
6048 on the username (%U, %G, etc) consistent. NT 4.0
6049 likes to use anonymous connections when refreshing the share list,
6050 and this is a way to work around that.</para>
6052 <para>When restrict anonymous is true, all anonymous connections
6053 are denied no matter what they are for. This can effect the ability
6054 of a machine to access the samba Primary Domain Controller to revalidate
6055 it's machine account after someone else has logged on the client
6056 interactively. The NT client will display a message saying that
6057 the machine's account in the domain doesn't exist or the password is
6058 bad. The best way to deal with this is to reboot NT client machines
6059 between interactive logons, using "Shutdown and Restart", rather
6060 than "Close all programs and logon as a different user".</para>
6062 <para>Default: <command>restrict anonymous = no</command></para>
6063 </listitem>
6064 </varlistentry>
6068 <varlistentry>
6069 <term><anchor id="ROOT">root (G)</term>
6070 <listitem><para>Synonym for <link linkend="ROOTDIRECTORY">
6071 <parameter>root directory"</parameter></link>.</para>
6072 </listitem>
6073 </varlistentry>
6077 <varlistentry>
6078 <term><anchor id="ROOTDIR">root dir (G)</term>
6079 <listitem><para>Synonym for <link linkend="ROOTDIRECTORY">
6080 <parameter>root directory"</parameter></link>.</para>
6081 </listitem>
6082 </varlistentry>
6085 <varlistentry>
6086 <term><anchor id="ROOTDIRECTORY">root directory (G)</term>
6087 <listitem><para>The server will <command>chroot()</command> (i.e.
6088 Change it's root directory) to this directory on startup. This is
6089 not strictly necessary for secure operation. Even without it the
6090 server will deny access to files not in one of the service entries.
6091 It may also check for, and deny access to, soft links to other
6092 parts of the filesystem, or attempts to use ".." in file names
6093 to access other directories (depending on the setting of the <link
6094 linkend="WIDELINKS"><parameter>wide links</parameter></link>
6095 parameter).</para>
6097 <para>Adding a <parameter>root directory</parameter> entry other
6098 than "/" adds an extra level of security, but at a price. It
6099 absolutely ensures that no access is given to files not in the
6100 sub-tree specified in the <parameter>root directory</parameter>
6101 option, <emphasis>including</emphasis> some files needed for
6102 complete operation of the server. To maintain full operability
6103 of the server you will need to mirror some system files
6104 into the <parameter>root directory</parameter> tree. In particular
6105 you will need to mirror <filename>/etc/passwd</filename> (or a
6106 subset of it), and any binaries or configuration files needed for
6107 printing (if required). The set of files that must be mirrored is
6108 operating system dependent.</para>
6110 <para>Default: <command>root directory = /</command></para>
6111 <para>Example: <command>root directory = /homes/smb</command></para>
6112 </listitem>
6113 </varlistentry>
6117 <varlistentry>
6118 <term><anchor id="ROOTPOSTEXEC">root postexec (S)</term>
6119 <listitem><para>This is the same as the <parameter>postexec</parameter>
6120 parameter except that the command is run as root. This
6121 is useful for unmounting filesystems
6122 (such as cdroms) after a connection is closed.</para>
6124 <para>See also <link linkend="POSTEXEC"><parameter>
6125 postexec</parameter></link>.</para>
6127 <para>Default: <command>root postexec = &lt;empty string&gt;
6128 </command></para>
6129 </listitem>
6130 </varlistentry>
6132 <varlistentry>
6133 <term><anchor id="ROOTPREEXEC">root preexec (S)</term>
6134 <listitem><para>This is the same as the <parameter>preexec</parameter>
6135 parameter except that the command is run as root. This
6136 is useful for mounting filesystems (such as cdroms) after a
6137 connection is closed.</para>
6139 <para>See also <link linkend="PREEXEC"><parameter>
6140 preexec</parameter></link> and <link linkend="PREEXECCLOSE">
6141 <parameter>preexec close</parameter></link>.</para>
6143 <para>Default: <command>root preexec = &lt;empty string&gt;
6144 </command></para>
6145 </listitem>
6146 </varlistentry>
6150 <varlistentry>
6151 <term><anchor id="ROOTPREEXECCLOSE">root preexec close (S)</term>
6152 <listitem><para>This is the same as the <parameter>preexec close
6153 </parameter> parameter except that the command is run as root.</para>
6155 <para>See also <link linkend="PREEXEC"><parameter>
6156 preexec</parameter></link> and <link linkend="PREEXECCLOSE">
6157 <parameter>preexec close</parameter></link>.</para>
6159 <para>Default: <command>root preexec close = no</command></para>
6160 </listitem>
6161 </varlistentry>
6164 <varlistentry>
6165 <term><anchor id="SECURITY">security (G)</term>
6166 <listitem><para>This option affects how clients respond to
6167 Samba and is one of the most important settings in the <filename>
6168 smb.conf</filename> file.</para>
6170 <para>The option sets the "security mode bit" in replies to
6171 protocol negotiations with <ulink url="smbd.8.html">smbd(8)
6172 </ulink> to turn share level security on or off. Clients decide
6173 based on this bit whether (and how) to transfer user and password
6174 information to the server.</para>
6177 <para>The default is <command>security = user</command>, as this is
6178 the most common setting needed when talking to Windows 98 and
6179 Windows NT.</para>
6181 <para>The alternatives are <command>security = share</command>,
6182 <command>security = server</command> or <command>security=domain
6183 </command>.</para>
6185 <para>In versions of Samba prior to 2..0, the default was
6186 <command>security = share</command> mainly because that was
6187 the only option at one stage.</para>
6189 <para>There is a bug in WfWg that has relevance to this
6190 setting. When in user or server level security a WfWg client
6191 will totally ignore the password you type in the "connect
6192 drive" dialog box. This makes it very difficult (if not impossible)
6193 to connect to a Samba service as anyone except the user that
6194 you are logged into WfWg as.</para>
6196 <para>If your PCs use usernames that are the same as their
6197 usernames on the UNIX machine then you will want to use
6198 <command>security = user</command>. If you mostly use usernames
6199 that don't exist on the UNIX box then use <command>security =
6200 share</command>.</para>
6202 <para>You should also use <command>security = share</command> if you
6203 want to mainly setup shares without a password (guest shares). This
6204 is commonly used for a shared printer server. It is more difficult
6205 to setup guest shares with <command>security = user</command>, see
6206 the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6207 </link>parameter for details.</para>
6209 <para>It is possible to use <command>smbd</command> in a <emphasis>
6210 hybrid mode</emphasis> where it is offers both user and share
6211 level security under different <link linkend="NETBIOSALIASES">
6212 <parameter>NetBIOS aliases</parameter></link>. </para>
6214 <para>The different settings will now be explained.</para>
6217 <para><anchor id="SECURITYEQUALSSHARE"><emphasis>SECURITY = SHARE
6218 </emphasis></para>
6220 <para>When clients connect to a share level security server then
6221 need not log onto the server with a valid username and password before
6222 attempting to connect to a shared resource (although modern clients
6223 such as Windows 95/98 and Windows NT will send a logon request with
6224 a username but no password when talking to a <command>security = share
6225 </command> server). Instead, the clients send authentication information
6226 (passwords) on a per-share basis, at the time they attempt to connect
6227 to that share.</para>
6229 <para>Note that <command>smbd</command> <emphasis>ALWAYS</emphasis>
6230 uses a valid UNIX user to act on behalf of the client, even in
6231 <command>security = share</command> level security.</para>
6233 <para>As clients are not required to send a username to the server
6234 in share level security, <command>smbd</command> uses several
6235 techniques to determine the correct UNIX user to use on behalf
6236 of the client.</para>
6238 <para>A list of possible UNIX usernames to match with the given
6239 client password is constructed using the following methods :</para>
6241 <itemizedlist>
6242 <listitem><para>If the <link linkend="GUESTONLY"><parameter>guest
6243 only</parameter></link> parameter is set, then all the other
6244 stages are missed and only the <link linkend="GUESTACCOUNT">
6245 <parameter>guest account</parameter></link> username is checked.
6246 </para></listitem>
6248 <listitem><para>Is a username is sent with the share connection
6249 request, then this username (after mapping - see <link
6250 linkend="USERNAMEMAP"><parameter>username map</parameter></link>),
6251 is added as a potential username.</para></listitem>
6253 <listitem><para>If the client did a previous <emphasis>logon
6254 </emphasis> request (the SessionSetup SMB call) then the
6255 username sent in this SMB will be added as a potential username.
6256 </para></listitem>
6258 <listitem><para>The name of the service the client requested is
6259 added as a potential username.</para></listitem>
6261 <listitem><para>The NetBIOS name of the client is added to
6262 the list as a potential username.</para></listitem>
6264 <listitem><para>Any users on the <link linkend="USER"><parameter>
6265 user</parameter></link> list are added as potential usernames.
6266 </para></listitem>
6267 </itemizedlist>
6269 <para>If the <parameter>guest only</parameter> parameter is
6270 not set, then this list is then tried with the supplied password.
6271 The first user for whom the password matches will be used as the
6272 UNIX user.</para>
6274 <para>If the <parameter>guest only</parameter> parameter is
6275 set, or no username can be determined then if the share is marked
6276 as available to the <parameter>guest account</parameter>, then this
6277 guest user will be used, otherwise access is denied.</para>
6279 <para>Note that it can be <emphasis>very</emphasis> confusing
6280 in share-level security as to which UNIX username will eventually
6281 be used in granting access.</para>
6283 <para>See also the section <link linkend="VALIDATIONSECT">
6284 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6286 <para><anchor id="SECURITYEQUALSUSER"><emphasis>SECURIYT = USER
6287 </emphasis></para>
6289 <para>This is the default security setting in Samba 2.2.
6290 With user-level security a client must first "log=on" with a
6291 valid username and password (which can be mapped using the <link
6292 linkend="USERNAMEMAP"><parameter>username map</parameter></link>
6293 parameter). Encrypted passwords (see the <link linkend="ENCRYPTPASSWORDS">
6294 <parameter>encrypted passwords</parameter></link> parameter) can also
6295 be used in this security mode. Parameters such as <link linkend="USER">
6296 <parameter>user</parameter></link> and <link linkend="GUESTONLY">
6297 <parameter>guest only</parameter></link> if set are then applied and
6298 may change the UNIX user to use on this connection, but only after
6299 the user has been successfully authenticated.</para>
6301 <para><emphasis>Note</emphasis> that the name of the resource being
6302 requested is <emphasis>not</emphasis> sent to the server until after
6303 the server has successfully authenticated the client. This is why
6304 guest shares don't work in user level security without allowing
6305 the server to automatically map unknown users into the <link
6306 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>.
6307 See the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6308 </link> parameter for details on doing this.</para>
6310 <para>See also the section <link linkend="VALIDATIONSECT">
6311 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6313 <para><anchor id="SECURITYEQUALSSERVER"><emphasis>SECURITY = SERVER
6314 </emphasis></para>
6316 <para>In this mode Samba will try to validate the username/password
6317 by passing it to another SMB server, such as an NT box. If this
6318 fails it will revert to <command>security = user</command>, but note
6319 that if encrypted passwords have been negotiated then Samba cannot
6320 revert back to checking the UNIX password file, it must have a valid
6321 <filename>smbpasswd</filename> file to check users against. See the
6322 documentation file in the <filename>docs/</filename> directory
6323 <filename>ENCRYPTION.txt</filename> for details on how to set this
6324 up.</para>
6326 <para><emphasis>Note</emphasis> that from the clients point of
6327 view <command>security = server</command> is the same as <command>
6328 security = user</command>. It only affects how the server deals
6329 with the authentication, it does not in any way affect what the
6330 client sees.</para>
6332 <para><emphasis>Note</emphasis> that the name of the resource being
6333 requested is <emphasis>not</emphasis> sent to the server until after
6334 the server has successfully authenticated the client. This is why
6335 guest shares don't work in user level security without allowing
6336 the server to automatically map unknown users into the <link
6337 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>.
6338 See the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6339 </link> parameter for details on doing this.</para>
6341 <para>See also the section <link linkend="VALIDATIONSECT">
6342 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6344 <para>See also the <link linkend="PASSWORDSERVER"><parameter>password
6345 server</parameter></link> parameter and the <link
6346 linkend="ENCRYPTPASSWORDS"><parameter>encrypted passwords</parameter>
6347 </link> parameter.</para>
6349 <para><anchor id="SECURITYEQUALSDOMAIN"><emphasis>SECURITY = DOMAIN
6350 </emphasis></para>
6352 <para>This mode will only work correctly if <ulink
6353 url="smbpasswd.8.html">smbpasswd(8)</ulink> has been used to add this
6354 machine into a Windows NT Domain. It expects the <link
6355 linkend="ENCRYPTPASSWORDS"><parameter>encrypted passwords</parameter>
6356 </link> parameter to be set to <constant>true</constant>. In this
6357 mode Samba will try to validate the username/password by passing
6358 it to a Windows NT Primary or Backup Domain Controller, in exactly
6359 the same way that a Windows NT Server would do.</para>
6361 <para><emphasis>Note</emphasis> that a valid UNIX user must still
6362 exist as well as the account on the Domain Controller to allow
6363 Samba to have a valid UNIX account to map file access to.</para>
6365 <para><emphasis>Note</emphasis> that from the clients point
6366 of view <command>security = domain</command> is the same as <command>security = user
6367 </command>. It only affects how the server deals with the authentication,
6368 it does not in any way affect what the client sees.</para>
6370 <para><emphasis>Note</emphasis> that the name of the resource being
6371 requested is <emphasis>not</emphasis> sent to the server until after
6372 the server has successfully authenticated the client. This is why
6373 guest shares don't work in user level security without allowing
6374 the server to automatically map unknown users into the <link
6375 linkend="GUESTACCOUNT"><parameter>guest account</parameter></link>.
6376 See the <link linkend="MAPTOGUEST"><parameter>map to guest</parameter>
6377 </link> parameter for details on doing this.</para>
6379 <para><emphasis>BUG:</emphasis> There is currently a bug in the
6380 implementation of <command>security = domain</command> with respect
6381 to multi-byte character set usernames. The communication with a
6382 Domain Controller must be done in UNICODE and Samba currently
6383 does not widen multi-byte user names to UNICODE correctly, thus
6384 a multi-byte username will not be recognized correctly at the
6385 Domain Controller. This issue will be addressed in a future release.</para>
6387 <para>See also the section <link linkend="VALIDATIONSECT">
6388 NOTE ABOUT USERNAME/PASSWORD VALIDATION</link>.</para>
6390 <para>See also the <link linkend="PASSWORDSERVER"><parameter>password
6391 server</parameter></link> parameter and the <link
6392 linkend="ENCRYPTPASSWORDS"><parameter>encrypted passwords</parameter>
6393 </link> parameter.</para>
6395 <para>Default: <command>security = USER</command></para>
6396 <para>Example: <command>security = DOMAIN</command></para>
6397 </listitem>
6398 </varlistentry>
6402 <varlistentry>
6403 <term><anchor id="SECURITYMASK">security mask (S)</term>
6404 <listitem><para>This parameter controls what UNIX permission
6405 bits can be modified when a Windows NT client is manipulating
6406 the UNIX permission on a file using the native NT security
6407 dialog box.</para>
6409 <para>This parameter is applied as a mask (AND'ed with) to
6410 the changed permission bits, thus preventing any bits not in
6411 this mask from being modified. Essentially, zero bits in this
6412 mask may be treated as a set of bits the user is not allowed
6413 to change.</para>
6415 <para>If not set explicitly this parameter is set to the same
6416 value as the <link linkend="CREATEMASK"><parameter>create mask
6417 </parameter></link> parameter. To allow a user to modify all the
6418 user/group/world permissions on a file, set this parameter to
6419 0777.</para>
6421 <para><emphasis>Note</emphasis> that users who can access the
6422 Samba server through other means can easily bypass this
6423 restriction, so it is primarily useful for standalone
6424 "appliance" systems. Administrators of most normal systems will
6425 probably want to set it to 0777.</para>
6427 <para>See also the <link linkend="FORCEDIRECTORYSECURITYMODE">
6428 <parameter>force directory security mode</parameter></link>,
6429 <link linkend="DIRECTORYSECURITYMASK"><parameter>directory
6430 security mask</parameter></link>, <link linkend="FORCESECURITYMODE">
6431 <parameter>force security mode</parameter></link> parameters.</para>
6433 <para>Default: <command>security mask = &lt;same as create mask&gt;
6434 </command></para>
6435 <para>Example: <command>security mask = 0777</command></para>
6436 </listitem>
6437 </varlistentry>
6440 <varlistentry>
6441 <term><anchor id="SERVERSTRING">server string (G)</term>
6442 <listitem><para>This controls what string will show up in the
6443 printer comment box in print manager and next to the IPC connection
6444 in <command>net view"</command>. It can be any string that you wish
6445 to show to your users.</para>
6447 <para>It also sets what will appear in browse lists next
6448 to the machine name.</para>
6450 <para>A <parameter>%v</parameter> will be replaced with the Samba
6451 version number.</para>
6453 <para>A <parameter>%h</parameter> will be replaced with the
6454 hostname.</para>
6456 <para>Default: <command>server string = Samba %v</command></para>
6458 <para>Example: <command>server string = University of GNUs Samba
6459 Server</command></para>
6460 </listitem>
6461 </varlistentry>
6465 <varlistentry>
6466 <term><anchor id="SETDIRECTORY">set directory (S)</term>
6467 <listitem><para>If <command>set directory = no</command>, then
6468 users of the service may not use the setdir command to change
6469 directory.</para>
6471 <para>The <command>setdir</command> command is only implemented
6472 in the Digital Pathworks client. See the Pathworks documentation
6473 for details.</para>
6475 <para>Default: <command>set directory = no</command></para>
6476 </listitem>
6477 </varlistentry>
6482 <varlistentry>
6483 <term><anchor id="SHAREMODES">share modes (S)</term>
6484 <listitem><para>This enables or disables the honoring of
6485 the <parameter>share modes</parameter> during a file open. These
6486 modes are used by clients to gain exclusive read or write access
6487 to a file.</para>
6489 <para>These open modes are not directly supported by UNIX, so
6490 they are simulated using shared memory, or lock files if your
6491 UNIX doesn't support shared memory (almost all do).</para>
6493 <para>The share modes that are enabled by this option are
6494 <constant>DENY_DOS</constant>, <constant>DENY_ALL</constant>,
6495 <constant>DENY_READ</constant>, <constant>DENY_WRITE</constant>,
6496 <constant>DENY_NONE</constant> and <constant>DENY_FCB</constant>.
6497 </para>
6499 <para>This option gives full share compatibility and enabled
6500 by default.</para>
6502 <para>You should <emphasis>NEVER</emphasis> turn this parameter
6503 off as many Windows applications will break if you do so.</para>
6505 <para>Default: <command>share modes = yes</command></para>
6506 </listitem>
6507 </varlistentry>
6512 <varlistentry>
6513 <term><anchor id="SHORTPRESERVECASE">short preserve case (S)</term>
6514 <listitem><para>This boolean parameter controls if new files
6515 which conform to 8.3 syntax, that is all in upper case and of
6516 suitable length, are created upper case, or if they are forced
6517 to be the <link linkend="DEFAULTCASE"><parameter>default case
6518 </parameter></link>. This option can be use with <link
6519 linkend="PRESERVECASE"><command>preserve case = yes</command>
6520 </link> to permit long filenames to retain their case, while short
6521 names are lowered. </para>
6523 <para>See the section on <link linkend="NAMEMANGLINGSECT">
6524 NAME MANGLING</link>.</para>
6526 <para>Default: <command>short preserve case = yes</command></para>
6527 </listitem>
6528 </varlistentry>
6532 <varlistentry>
6533 <term><anchor id="SHOWADDPRINTERWIZARD">show add printer wizard (G)</term>
6534 <listitem><para>With the introduction of MS-RPC based printing support
6535 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
6536 appear on Samba hosts in the share listing. Normally this folder will
6537 contain an icon for the MS Add Printer Wizard (APW). However, it is
6538 possible to disable this feature regardless of the level of privilege
6539 of the connected user.</para>
6541 <para>Under normal circumstances, the Windows NT/2000 client will
6542 open a handle on the printer server with OpenPrinterEx() asking for
6543 Administrator privileges. If the user does not have administrative
6544 access on the print server (i.e is not root or a member of the
6545 <parameter>printer admin</parameter> group), the OpenPrinterEx()
6546 call fails and the clients another open call with a request for
6547 a lower privilege level. This should succeed, however the APW
6548 icon will not be displayed.</para>
6550 <para>Disabling the <parameter>show add printer wizard</parameter>
6551 parameter will always cause the OpenPrinterEx() on the server
6552 to fail. Thus the APW icon will never be displayed. <emphasis>
6553 Note :</emphasis>This does not prevent the same user from having
6554 administrative privilege on an individual printer.</para>
6556 <para>See also <link linkend="ADDPRINTERCOMMAND"><parameter>addprinter
6557 command</parameter></link>, <link linkend="DELETEPRINTERCOMMAND">
6558 <parameter>deleteprinter command</parameter></link>, <link
6559 linkend="PRINTERADMIN"><parameter>printer admin</parameter></link></para>
6561 <para>Default :<command>show add printer wizard = yes</command></para>
6562 </listitem>
6563 </varlistentry>
6568 <varlistentry>
6569 <term><anchor id="SMBPASSWDFILE">smb passwd file (G)</term>
6570 <listitem><para>This option sets the path to the encrypted
6571 smbpasswd file. By default the path to the smbpasswd file
6572 is compiled into Samba.</para>
6574 <para>Default: <command>smb passwd file = ${prefix}/private/smbpasswd
6575 </command></para>
6577 <para>Example: <command>smb passwd file = /etc/samba/smbpasswd
6578 </command></para>
6579 </listitem>
6580 </varlistentry>
6585 <varlistentry>
6586 <term><anchor id="SOCKETADDRESS">socket address (G)</term>
6587 <listitem><para>This option allows you to control what
6588 address Samba will listen for connections on. This is used to
6589 support multiple virtual interfaces on the one server, each
6590 with a different configuration.</para>
6592 <para>By default samba will accept connections on any
6593 address.</para>
6595 <para>Example: <command>socket address = 192.168.2.20</command>
6596 </para>
6597 </listitem>
6598 </varlistentry>
6602 <varlistentry>
6603 <term><anchor id="SOCKETOPTIONS">socket options (G)</term>
6604 <listitem><para>This option allows you to set socket options
6605 to be used when talking with the client.</para>
6607 <para>Socket options are controls on the networking layer
6608 of the operating systems which allow the connection to be
6609 tuned.</para>
6611 <para>This option will typically be used to tune your Samba
6612 server for optimal performance for your local network. There is
6613 no way that Samba can know what the optimal parameters are for
6614 your net, so you must experiment and choose them yourself. We
6615 strongly suggest you read the appropriate documentation for your
6616 operating system first (perhaps <command>man setsockopt</command>
6617 will help).</para>
6619 <para>You may find that on some systems Samba will say
6620 "Unknown socket option" when you supply an option. This means you
6621 either incorrectly typed it or you need to add an include file
6622 to includes.h for your OS. If the latter is the case please
6623 send the patch to <ulink url="mailto:samba@samba.org">
6624 samba@samba.org</ulink>.</para>
6626 <para>Any of the supported socket options may be combined
6627 in any way you like, as long as your OS allows it.</para>
6629 <para>This is the list of socket options currently settable
6630 using this option:</para>
6632 <itemizedlist>
6633 <listitem><para>SO_KEEPALIVE</para></listitem>
6634 <listitem><para>SO_REUSEADDR</para></listitem>
6635 <listitem><para>SO_BROADCAST</para></listitem>
6636 <listitem><para>TCP_NODELAY</para></listitem>
6637 <listitem><para>IPTOS_LOWDELAY</para></listitem>
6638 <listitem><para>IPTOS_THROUGHPUT</para></listitem>
6639 <listitem><para>SO_SNDBUF *</para></listitem>
6640 <listitem><para>SO_RCVBUF *</para></listitem>
6641 <listitem><para>SO_SNDLOWAT *</para></listitem>
6642 <listitem><para>SO_RCVLOWAT *</para></listitem>
6643 </itemizedlist>
6645 <para>Those marked with a <emphasis>'*'</emphasis> take an integer
6646 argument. The others can optionally take a 1 or 0 argument to enable
6647 or disable the option, by default they will be enabled if you
6648 don't specify 1 or 0.</para>
6650 <para>To specify an argument use the syntax SOME_OPTION=VALUE
6651 for example <command>SO_SNDBUF=8192</command>. Note that you must
6652 not have any spaces before or after the = sign.</para>
6654 <para>If you are on a local network then a sensible option
6655 might be</para>
6656 <para><command>socket options = IPTOS_LOWDELAY</command></para>
6658 <para>If you have a local network then you could try:</para>
6659 <para><command>socket options = IPTOS_LOWDELAY TCP_NODELAY</command></para>
6661 <para>If you are on a wide area network then perhaps try
6662 setting IPTOS_THROUGHPUT. </para>
6664 <para>Note that several of the options may cause your Samba
6665 server to fail completely. Use these options with caution!</para>
6667 <para>Default: <command>socket options = TCP_NODELAY</command></para>
6668 <para>Example: <command>socket options = IPTOS_LOWDELAY</command></para>
6669 </listitem>
6670 </varlistentry>
6675 <varlistentry>
6676 <term><anchor id="SOURCEENVIRONMENT">source environment (G)</term>
6677 <listitem><para>This parameter causes Samba to set environment
6678 variables as per the content of the file named.</para>
6680 <para>If the value of this parameter starts with a "|" character
6681 then Samba will treat that value as a pipe command to open and
6682 will set the environment variables from the output of the pipe.</para>
6684 <para>The contents of the file or the output of the pipe should
6685 be formatted as the output of the standard Unix <command>env(1)
6686 </command> command. This is of the form :</para>
6687 <para>Example environment entry:</para>
6688 <para><command>SAMBA_NETBIOS_NAME=myhostname</command></para>
6690 <para>Default: <emphasis>No default value</emphasis></para>
6691 <para>Examples: <command>source environment = |/etc/smb.conf.sh
6692 </command></para>
6694 <para>Example: <command>source environment =
6695 /usr/local/smb_env_vars</command></para>
6696 </listitem>
6697 </varlistentry>
6701 <varlistentry>
6702 <term><anchor id="SSL">ssl (G)</term>
6703 <listitem><para>This variable is part of SSL-enabled Samba. This
6704 is only available if the SSL libraries have been compiled on your
6705 system and the configure option <command>--with-ssl</command> was
6706 given at configure time.</para>
6708 <para><emphasis>Note</emphasis> that for export control reasons
6709 this code is <emphasis>NOT</emphasis> enabled by default in any
6710 current binary version of Samba.</para>
6712 <para>This variable enables or disables the entire SSL mode. If
6713 it is set to <constant>no</constant>, the SSL enabled samba behaves
6714 exactly like the non-SSL samba. If set to <constant>yes</constant>,
6715 it depends on the variables <link linkend="SSLHOSTS"><parameter>
6716 ssl hosts</parameter></link> and <link linkend="SSLHOSTSRESIGN">
6717 <parameter>ssl hosts resign</parameter></link> whether an SSL
6718 connection will be required.</para>
6720 <para>Default: <command>ssl=no</command></para>
6721 </listitem>
6722 </varlistentry>
6726 <varlistentry>
6727 <term><anchor id="SSLCACERTDIR">ssl CA certDir (G)</term>
6728 <listitem><para>This variable is part of SSL-enabled Samba. This
6729 is only available if the SSL libraries have been compiled on your
6730 system and the configure option <command>--with-ssl</command> was
6731 given at configure time.</para>
6733 <para><emphasis>Note</emphasis> that for export control reasons
6734 this code is <emphasis>NOT</emphasis> enabled by default in any
6735 current binary version of Samba.</para>
6737 <para>This variable defines where to look up the Certification
6738 Authorities. The given directory should contain one file for
6739 each CA that samba will trust. The file name must be the hash
6740 value over the "Distinguished Name" of the CA. How this directory
6741 is set up is explained later in this document. All files within the
6742 directory that don't fit into this naming scheme are ignored. You
6743 don't need this variable if you don't verify client certificates.</para>
6745 <para>Default: <command>ssl CA certDir = /usr/local/ssl/certs
6746 </command></para>
6747 </listitem>
6748 </varlistentry>
6752 <varlistentry>
6753 <term><anchor id="SSLCACERTFILE">ssl CA certFile (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 is a second way to define the trusted CAs.
6764 The certificates of the trusted CAs are collected in one big
6765 file and this variable points to the file. You will probably
6766 only use one of the two ways to define your CAs. The first choice is
6767 preferable if you have many CAs or want to be flexible, the second
6768 is preferable if you only have one CA and want to keep things
6769 simple (you won't need to create the hashed file names). You
6770 don't need this variable if you don't verify client certificates.</para>
6772 <para>Default: <command>ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
6773 </command></para>
6774 </listitem>
6775 </varlistentry>
6779 <varlistentry>
6780 <term><anchor id="SSLCIPHERS">ssl ciphers (G)</term>
6781 <listitem><para>This variable is part of SSL-enabled Samba. This
6782 is only available if the SSL libraries have been compiled on your
6783 system and the configure option <command>--with-ssl</command> was
6784 given at configure time.</para>
6786 <para><emphasis>Note</emphasis> that for export control reasons
6787 this code is <emphasis>NOT</emphasis> enabled by default in any
6788 current binary version of Samba.</para>
6790 <para>This variable defines the ciphers that should be offered
6791 during SSL negotiation. You should not set this variable unless
6792 you know what you are doing.</para>
6793 </listitem>
6794 </varlistentry>
6797 <varlistentry>
6798 <term><anchor id="SSLCLIENTCERT">ssl client cert (G)</term>
6799 <listitem><para>This variable is part of SSL-enabled Samba. This
6800 is only available if the SSL libraries have been compiled on your
6801 system and the configure option <command>--with-ssl</command> was
6802 given at configure time.</para>
6804 <para><emphasis>Note</emphasis> that for export control reasons
6805 this code is <emphasis>NOT</emphasis> enabled by default in any
6806 current binary version of Samba.</para>
6808 <para>The certificate in this file is used by <ulink url="smbclient.1.html">
6809 <command>smbclient(1)</command></ulink> if it exists. It's needed
6810 if the server requires a client certificate.</para>
6812 <para>Default: <command>ssl client cert = /usr/local/ssl/certs/smbclient.pem
6813 </command></para>
6814 </listitem>
6815 </varlistentry>
6819 <varlistentry>
6820 <term><anchor id="SSLCLIENTKEY">ssl client key (G)</term>
6821 <listitem><para>This variable is part of SSL-enabled Samba. This
6822 is only available if the SSL libraries have been compiled on your
6823 system and the configure option <command>--with-ssl</command> was
6824 given at configure time.</para>
6826 <para><emphasis>Note</emphasis> that for export control reasons
6827 this code is <emphasis>NOT</emphasis> enabled by default in any
6828 current binary version of Samba.</para>
6830 <para>This is the private key for <ulink url="smbclient.1.html">
6831 <command>smbclient(1)</command></ulink>. It's only needed if the
6832 client should have a certificate. </para>
6834 <para>Default: <command>ssl client key = /usr/local/ssl/private/smbclient.pem
6835 </command></para>
6836 </listitem>
6837 </varlistentry>
6841 <varlistentry>
6842 <term><anchor id="SSLCOMPATIBILITY">ssl compatibility (G)</term>
6843 <listitem><para>This variable is part of SSL-enabled Samba. This
6844 is only available if the SSL libraries have been compiled on your
6845 system and the configure option <command>--with-ssl</command> was
6846 given at configure time.</para>
6848 <para><emphasis>Note</emphasis> that for export control reasons
6849 this code is <emphasis>NOT</emphasis> enabled by default in any
6850 current binary version of Samba.</para>
6852 <para>This variable defines whether SSLeay should be configured
6853 for bug compatibility with other SSL implementations. This is
6854 probably not desirable because currently no clients with SSL
6855 implementations other than SSLeay exist.</para>
6857 <para>Default: <command>ssl compatibility = no</command></para>
6858 </listitem>
6859 </varlistentry>
6862 <varlistentry>
6863 <term><anchor id="SSLHOSTS">ssl hosts (G)</term>
6864 <listitem><para>See <link linkend="SSLHOSTSRESIGN"><parameter>
6865 ssl hosts resign</parameter></link>.</para>
6866 </listitem>
6867 </varlistentry>
6870 <varlistentry>
6871 <term><anchor id="SSLHOSTSRESIGN">ssl hosts resign (G)</term>
6872 <listitem><para>This variable is part of SSL-enabled Samba. This
6873 is only available if the SSL libraries have been compiled on your
6874 system and the configure option <command>--with-ssl</command> was
6875 given at configure time.</para>
6877 <para><emphasis>Note</emphasis> that for export control reasons
6878 this code is <emphasis>NOT</emphasis> enabled by default in any
6879 current binary version of Samba.</para>
6881 <para>These two variables define whether samba will go
6882 into SSL mode or not. If none of them is defined, samba will
6883 allow only SSL connections. If the <link linkend="SSLHOSTS">
6884 <parameter>ssl hosts</parameter></link> variable lists
6885 hosts (by IP-address, IP-address range, net group or name),
6886 only these hosts will be forced into SSL mode. If the <parameter>
6887 ssl hosts resign</parameter> variable lists hosts, only these
6888 hosts will NOT be forced into SSL mode. The syntax for these two
6889 variables is the same as for the <link linkend="HOSTSALLOW"><parameter>
6890 hosts allow</parameter></link> and <link linkend="HOSTSDENY">
6891 <parameter>hosts deny</parameter></link> pair of variables, only
6892 that the subject of the decision is different: It's not the access
6893 right but whether SSL is used or not. </para>
6895 <para>The example below requires SSL connections from all hosts
6896 outside the local net (which is 192.168.*.*).</para>
6898 <para>Default: <command>ssl hosts = &lt;empty string&gt;</command></para>
6899 <para><command>ssl hosts resign = &lt;empty string&gt;</command></para>
6901 <para>Example: <command>ssl hosts resign = 192.168.</command></para>
6902 </listitem>
6903 </varlistentry>
6907 <varlistentry>
6908 <term><anchor id="SSLREQUIRECLIENTCERT">ssl require clientcert (G)</term>
6909 <listitem><para>This variable is part of SSL-enabled Samba. This
6910 is only available if the SSL libraries have been compiled on your
6911 system and the configure option <command>--with-ssl</command> was
6912 given at configure time.</para>
6914 <para><emphasis>Note</emphasis> that for export control reasons
6915 this code is <emphasis>NOT</emphasis> enabled by default in any
6916 current binary version of Samba.</para>
6918 <para>If this variable is set to <constant>yes</constant>, the
6919 server will not tolerate connections from clients that don't
6920 have a valid certificate. The directory/file given in <link
6921 linkend="SSLCACERTDIR"><parameter>ssl CA certDir</parameter>
6922 </link> and <link linkend="SSLCACERTFILE"><parameter>ssl CA certFile
6923 </parameter></link> will be used to look up the CAs that issued
6924 the client's certificate. If the certificate can't be verified
6925 positively, the connection will be terminated. If this variable
6926 is set to <constant>no</constant>, clients don't need certificates.
6927 Contrary to web applications you really <emphasis>should</emphasis>
6928 require client certificates. In the web environment the client's
6929 data is sensitive (credit card numbers) and the server must prove
6930 to be trustworthy. In a file server environment the server's data
6931 will be sensitive and the clients must prove to be trustworthy.</para>
6933 <para>Default: <command>ssl require clientcert = no</command></para>
6934 </listitem>
6935 </varlistentry>
6939 <varlistentry>
6940 <term><anchor id="SSLREQUIRESERVERCERT">ssl require servercert (G)</term>
6941 <listitem><para>This variable is part of SSL-enabled Samba. This
6942 is only available if the SSL libraries have been compiled on your
6943 system and the configure option <command>--with-ssl</command> was
6944 given at configure time.</para>
6946 <para><emphasis>Note</emphasis> that for export control reasons
6947 this code is <emphasis>NOT</emphasis> enabled by default in any
6948 current binary version of Samba.</para>
6950 <para>If this variable is set to <constant>yes</constant>, the
6951 <ulink url="smbclient.1.html"><command>smbclient(1)</command>
6952 </ulink> will request a certificate from the server. Same as
6953 <link linkend="SSLREQUIRECLIENTCERT"><parameter>ssl require
6954 clientcert</parameter></link> for the server.</para>
6956 <para>Default: <command>ssl require servercert = no</command>
6957 </para>
6958 </listitem>
6959 </varlistentry>
6961 <varlistentry>
6962 <term><anchor id="SSLSERVERCERT">ssl server cert (G)</term>
6963 <listitem><para>This variable is part of SSL-enabled Samba. This
6964 is only available if the SSL libraries have been compiled on your
6965 system and the configure option <command>--with-ssl</command> was
6966 given at configure time.</para>
6968 <para><emphasis>Note</emphasis> that for export control reasons
6969 this code is <emphasis>NOT</emphasis> enabled by default in any
6970 current binary version of Samba.</para>
6972 <para>This is the file containing the server's certificate.
6973 The server <emphasis>must</emphasis> have a certificate. The
6974 file may also contain the server's private key. See later for
6975 how certificates and private keys are created.</para>
6977 <para>Default: <command>ssl server cert = &lt;empty string&gt;
6978 </command></para>
6979 </listitem>
6980 </varlistentry>
6983 <varlistentry>
6984 <term><anchor id="SSLSERVERKEY">ssl server key (G)</term>
6985 <listitem><para>This variable is part of SSL-enabled Samba. This
6986 is only available if the SSL libraries have been compiled on your
6987 system and the configure option <command>--with-ssl</command> was
6988 given at configure time.</para>
6990 <para><emphasis>Note</emphasis> that for export control reasons
6991 this code is <emphasis>NOT</emphasis> enabled by default in any
6992 current binary version of Samba.</para>
6994 <para>This file contains the private key of the server. If
6995 this variable is not defined, the key is looked up in the
6996 certificate file (it may be appended to the certificate).
6997 The server <emphasis>must</emphasis> have a private key
6998 and the certificate <emphasis>must</emphasis>
6999 match this private key.</para>
7001 <para>Default: <command>ssl server key = &lt;empty string&gt;
7002 </command></para>
7003 </listitem>
7004 </varlistentry>
7007 <varlistentry>
7008 <term><anchor id="SSLVERSION">ssl version (G)</term>
7009 <listitem><para>This variable is part of SSL-enabled Samba. This
7010 is only available if the SSL libraries have been compiled on your
7011 system and the configure option <command>--with-ssl</command> was
7012 given at configure time.</para>
7014 <para><emphasis>Note</emphasis> that for export control reasons
7015 this code is <emphasis>NOT</emphasis> enabled by default in any
7016 current binary version of Samba.</para>
7018 <para>This enumeration variable defines the versions of the
7019 SSL protocol that will be used. <constant>ssl2or3</constant> allows
7020 dynamic negotiation of SSL v2 or v3, <constant>ssl2</constant> results
7021 in SSL v2, <constant>ssl3</constant> results in SSL v3 and
7022 <constant>tls1</constant> results in TLS v1. TLS (Transport Layer
7023 Security) is the new standard for SSL.</para>
7025 <para>Default: <command>ssl version = "ssl2or3"</command></para>
7026 </listitem>
7027 </varlistentry>
7031 <varlistentry>
7032 <term><anchor id="STATCACHE">stat cache (G)</term>
7033 <listitem><para>This parameter determines if <ulink
7034 url="smbd.8.html">smbd(8)</ulink> will use a cache in order to
7035 speed up case insensitive name mappings. You should never need
7036 to change this parameter.</para>
7038 <para>Default: <command>stat cache = yes</command></para>
7039 </listitem>
7040 </varlistentry>
7042 <varlistentry>
7043 <term><anchor id="STATCACHESIZE">stat cache size (G)</term>
7044 <listitem><para>This parameter determines the number of
7045 entries in the <parameter>stat cache</parameter>. You should
7046 never need to change this parameter.</para>
7048 <para>Default: <command>stat cache size = 50</command></para>
7049 </listitem>
7050 </varlistentry>
7054 <varlistentry>
7055 <term><anchor id="STATUS">status (G)</term>
7056 <listitem><para>This enables or disables logging of connections
7057 to a status file that <ulink url="smbstatus.1.html">smbstatus(1)</ulink>
7058 can read.</para>
7060 <para>With this disabled <command>smbstatus</command> won't be able
7061 to tell you what connections are active. You should never need to
7062 change this parameter.</para>
7064 <para>Default: <command>status = yes</command></para>
7065 </listitem>
7066 </varlistentry>
7070 <varlistentry>
7071 <term><anchor id="STRICTLOCKING">strict locking (S)</term>
7072 <listitem><para>This is a boolean that controls the handling of
7073 file locking in the server. When this is set to <constant>yes</constant>
7074 the server will check every read and write access for file locks, and
7075 deny access if locks exist. This can be slow on some systems.</para>
7077 <para>When strict locking is <constant>no</constant> the server does file
7078 lock checks only when the client explicitly asks for them.</para>
7080 <para>Well behaved clients always ask for lock checks when it
7081 is important, so in the vast majority of cases <command>strict
7082 locking = no</command> is preferable.</para>
7084 <para>Default: <command>strict locking = no</command></para>
7085 </listitem>
7086 </varlistentry>
7090 <varlistentry>
7091 <term><anchor id="STRICTSYNC">strict sync (S)</term>
7092 <listitem><para>Many Windows applications (including the Windows
7093 98 explorer shell) seem to confuse flushing buffer contents to
7094 disk with doing a sync to disk. Under UNIX, a sync call forces
7095 the process to be suspended until the kernel has ensured that
7096 all outstanding data in kernel disk buffers has been safely stored
7097 onto stable storage. This is very slow and should only be done
7098 rarely. Setting this parameter to <constant>no</constant> (the
7099 default) means that smbd ignores the Windows applications requests for
7100 a sync call. There is only a possibility of losing data if the
7101 operating system itself that Samba is running on crashes, so there is
7102 little danger in this default setting. In addition, this fixes many
7103 performance problems that people have reported with the new Windows98
7104 explorer shell file copies.</para>
7106 <para>See also the <link linkend="SYNCALWAYS"><parameter>sync
7107 always></parameter></link> parameter.</para>
7109 <para>Default: <command>strict sync = no</command></para>
7110 </listitem>
7111 </varlistentry>
7114 <varlistentry>
7115 <term><anchor id="STRIPDOT">strip dot (G)</term>
7116 <listitem><para>This is a boolean that controls whether to
7117 strip trailing dots off UNIX filenames. This helps with some
7118 CDROMs that have filenames ending in a single dot.</para>
7120 <para>Default: <command>strip dot = no</command></para>
7121 </listitem>
7122 </varlistentry>
7126 <varlistentry>
7127 <term><anchor id="SYNCALWAYS">sync always (S)</term>
7128 <listitem><para>This is a boolean parameter that controls
7129 whether writes will always be written to stable storage before
7130 the write call returns. If this is false then the server will be
7131 guided by the client's request in each write call (clients can
7132 set a bit indicating that a particular write should be synchronous).
7133 If this is true then every write will be followed by a <command>fsync()
7134 </command> call to ensure the data is written to disk. Note that
7135 the <parameter>strict sync</parameter> parameter must be set to
7136 <constant>yes</constant> in order for this parameter to have
7137 any affect.</para>
7139 <para>See also the <link linkend="STRICTSYNC"><parameter>strict
7140 sync</parameter></link> parameter.</para>
7142 <para>Default: <command>sync always = no</command></para>
7143 </listitem>
7144 </varlistentry>
7148 <varlistentry>
7149 <term><anchor id="SYSLOG">syslog (G)</term>
7150 <listitem><para>This parameter maps how Samba debug messages
7151 are logged onto the system syslog logging levels. Samba debug
7152 level zero maps onto syslog <constant>LOG_ERR</constant>, debug
7153 level one maps onto <constant>LOG_WARNING</constant>, debug level
7154 two maps onto <constant>LOG_NOTICE</constant>, debug level three
7155 maps onto LOG_INFO. All higher levels are mapped to <constant>
7156 LOG_DEBUG</constant>.</para>
7158 <para>This parameter sets the threshold for sending messages
7159 to syslog. Only messages with debug level less than this value
7160 will be sent to syslog.</para>
7162 <para>Default: <command>syslog = 1</command></para>
7163 </listitem>
7164 </varlistentry>
7168 <varlistentry>
7169 <term><anchor id="SYSLOGONLY">syslog only (G)</term>
7170 <listitem><para>If this parameter is set then Samba debug
7171 messages are logged into the system syslog only, and not to
7172 the debug log files.</para>
7174 <para>Default: <command>syslog only = no</command></para>
7175 </listitem>
7176 </varlistentry>
7180 <varlistentry>
7181 <term><anchor id="TEMPLATEHOMEDIR">template homedir (G)</term>
7182 <listitem><para><emphasis>NOTE:</emphasis> this parameter is
7183 only available in Samba 3.0.</para>
7185 <para>When filling out the user information for a Windows NT
7186 user, the <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon
7187 uses this parameter to fill in the home directory for that user.
7188 If the string <parameter>%D</parameter> is present it is substituted
7189 with the user's Windows NT domain name. If the string <parameter>%U
7190 </parameter> is present it is substituted with the user's Windows
7191 NT user name.</para>
7193 <para>Default: <command>template homedir = /home/%D/%U</command></para>
7194 </listitem>
7195 </varlistentry>
7199 <varlistentry>
7200 <term><anchor id="TEMPLATESHELL">template shell (G)</term>
7201 <listitem><para><emphasis>NOTE:</emphasis> this parameter is
7202 only available in Samba 3.0.</para>
7204 <para>When filling out the user information for a Windows NT
7205 user, the <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon
7206 uses this parameter to fill in the login shell for that user.</para>
7208 <para>Default: <command>template shell = /bin/false</command></para>
7209 </listitem>
7210 </varlistentry>
7214 <varlistentry>
7215 <term><anchor id="TIMEOFFSET">time offset (G)</term>
7216 <listitem><para>This parameter is a setting in minutes to add
7217 to the normal GMT to local time conversion. This is useful if
7218 you are serving a lot of PCs that have incorrect daylight
7219 saving time handling.</para>
7221 <para>Default: <command>time offset = 0</command></para>
7222 <para>Example: <command>time offset = 60</command></para>
7223 </listitem>
7224 </varlistentry>
7228 <varlistentry>
7229 <term><anchor id="TIMESERVER">time server (G)</term>
7230 <listitem><para>This parameter determines if <ulink url="nmbd.8.html">
7231 nmbd(8)</ulink> advertises itself as a time server to Windows
7232 clients.</para>
7234 <para>Default: <command>time server = no</command></para>
7235 </listitem>
7236 </varlistentry>
7239 <varlistentry>
7240 <term><anchor id="TIMESTAMPLOGS">timestamp logs (G)</term>
7241 <listitem><para>Synonym for <link linkend="DEBUGTIMESTAMP"><parameter>
7242 debug timestamp</parameter></link>.</para>
7243 </listitem>
7244 </varlistentry>
7250 <varlistentry>
7251 <term><anchor id="TOTALPRINTJOBS">total print jobs (G)</term>
7252 <listitem><para>This parameter accepts an integer value which defines
7253 a limit on the maximum number of print jobs that will be accepted
7254 system wide at any given time. If a print job is submitted
7255 by a client which will exceed this number, then smbd will return an
7256 error indicating that no space is available on the server. The
7257 default value of 0 means that no such limit exists. This parameter
7258 can be used to prevent a server from exceeding its capacity and is
7259 designed as a printing throttle. See also
7260 <link linkend="MAXPRINTJOBS"><parameter>max print jobs</parameter</link>.
7261 </para>
7263 <para>Default: <command>total print jobs = 0</command></para>
7264 <para>Example: <command>total print jobs = 5000</command></para>
7265 </listitem>
7266 </varlistentry>
7271 <varlistentry>
7272 <term><anchor id="UNIXPASSWORDSYNC">unix password sync (G)</term>
7273 <listitem><para>This boolean parameter controls whether Samba
7274 attempts to synchronize the UNIX password with the SMB password
7275 when the encrypted SMB password in the smbpasswd file is changed.
7276 If this is set to true the program specified in the <parameter>passwd
7277 program</parameter>parameter is called <emphasis>AS ROOT</emphasis> -
7278 to allow the new UNIX password to be set without access to the
7279 old UNIX password (as the SMB password has change code has no
7280 access to the old password cleartext, only the new).</para>
7282 <para>See also <link linkend="PASSWDPROGRAM"><parameter>passwd
7283 program</parameter></link>, <link linkend="PASSWDCHAT"><parameter>
7284 passwd chat</parameter></link>.</para>
7286 <para>Default: <command>unix password sync = no</command></para>
7287 </listitem>
7288 </varlistentry>
7292 <varlistentry>
7293 <term><anchor id="UPDATEENCRYPTED">update encrypted (G)</term>
7294 <listitem><para>This boolean parameter allows a user logging
7295 on with a plaintext password to have their encrypted (hashed)
7296 password in the smbpasswd file to be updated automatically as
7297 they log on. This option allows a site to migrate from plaintext
7298 password authentication (users authenticate with plaintext
7299 password over the wire, and are checked against a UNIX account
7300 database) to encrypted password authentication (the SMB
7301 challenge/response authentication mechanism) without forcing
7302 all users to re-enter their passwords via smbpasswd at the time the
7303 change is made. This is a convenience option to allow the change over
7304 to encrypted passwords to be made over a longer period. Once all users
7305 have encrypted representations of their passwords in the smbpasswd
7306 file this parameter should be set to <constant>no</constant>.</para>
7308 <para>In order for this parameter to work correctly the <link
7309 linkend="ENCRYPTPASSWORDS"><parameter>encrypt passwords</parameter>
7310 </link> parameter must be set to <constant>no</constant> when
7311 this parameter is set to <constant>yes</constant>.</para>
7313 <para>Note that even when this parameter is set a user
7314 authenticating to <command>smbd</command> must still enter a valid
7315 password in order to connect correctly, and to update their hashed
7316 (smbpasswd) passwords.</para>
7318 <para>Default: <command>update encrypted = no</command></para>
7319 </listitem>
7320 </varlistentry>
7324 <varlistentry>
7325 <term><anchor id="USERHOSTS">use rhosts (G)</term>
7326 <listitem><para>If this global parameter is a true, it specifies
7327 that the UNIX users <filename>.rhosts</filename> file in their home directory
7328 will be read to find the names of hosts and users who will be allowed
7329 access without specifying a password.</para>
7331 <para><emphasis>NOTE:</emphasis> The use of <parameter>use rhosts
7332 </parameter> can be a major security hole. This is because you are
7333 trusting the PC to supply the correct username. It is very easy to
7334 get a PC to supply a false username. I recommend that the <parameter>
7335 use rhosts</parameter> option be only used if you really know what
7336 you are doing.</para>
7338 <para>Default: <command>use rhosts = no</command></para>
7339 </listitem>
7340 </varlistentry>
7344 <varlistentry>
7345 <term><anchor id="USER">user (S)</term>
7346 <listitem><para>Synonym for <link linkend="USERNAME"><parameter>
7347 username</parameter></link>.</para>
7348 </listitem>
7349 </varlistentry>
7353 <varlistentry>
7354 <term><anchor id="USERS">users (S)</term>
7355 <listitem><para>Synonym for <link linkend="USERNAME"><parameter>
7356 username</parameter></link>.</para>
7357 </listitem>
7358 </varlistentry>
7361 <varlistentry>
7362 <term><anchor id="USERNAME">username (S)</term>
7363 <listitem><para>Multiple users may be specified in a comma-delimited
7364 list, in which case the supplied password will be tested against
7365 each username in turn (left to right).</para>
7367 <para>The <parameter>username</parameter> line is needed only when
7368 the PC is unable to supply its own username. This is the case
7369 for the COREPLUS protocol or where your users have different WfWg
7370 usernames to UNIX usernames. In both these cases you may also be
7371 better using the \\server\share%user syntax instead.</para>
7373 <para>The <parameter>username</parameter> line is not a great
7374 solution in many cases as it means Samba will try to validate
7375 the supplied password against each of the usernames in the
7376 <parameter>username</parameter> line in turn. This is slow and
7377 a bad idea for lots of users in case of duplicate passwords.
7378 You may get timeouts or security breaches using this parameter
7379 unwisely.</para>
7381 <para>Samba relies on the underlying UNIX security. This
7382 parameter does not restrict who can login, it just offers hints
7383 to the Samba server as to what usernames might correspond to the
7384 supplied password. Users can login as whoever they please and
7385 they will be able to do no more damage than if they started a
7386 telnet session. The daemon runs as the user that they log in as,
7387 so they cannot do anything that user cannot do.</para>
7389 <para>To restrict a service to a particular set of users you
7390 can use the <link linkend="VALIDUSERS"><parameter>valid users
7391 </parameter></link> parameter.</para>
7393 <para>If any of the usernames begin with a '@' then the name
7394 will be looked up first in the yp netgroups list (if Samba
7395 is compiled with netgroup support), followed by a lookup in
7396 the UNIX groups database and will expand to a list of all users
7397 in the group of that name.</para>
7399 <para>If any of the usernames begin with a '+' then the name
7400 will be looked up only in the UNIX groups database and will
7401 expand to a list of all users in the group of that name.</para>
7403 <para>If any of the usernames begin with a '&'then the name
7404 will be looked up only in the yp netgroups database (if Samba
7405 is compiled with netgroup support) and will expand to a list
7406 of all users in the netgroup group of that name.</para>
7408 <para>Note that searching though a groups database can take
7409 quite some time, and some clients may time out during the
7410 search.</para>
7412 <para>See the section <link linkend="VALIDATIONSECT">NOTE ABOUT
7413 USERNAME/PASSWORD VALIDATION</link> for more information on how
7414 this parameter determines access to the services.</para>
7416 <para>Default: <command>The guest account if a guest service,
7417 else &lt;empty string&gt;.</command></para>
7419 <para>Examples:<command>username = fred, mary, jack, jane,
7420 @users, @pcgroup</command></para>
7421 </listitem>
7422 </varlistentry>
7426 <varlistentry>
7427 <term><anchor id="USERNAMELEVEL">username level (G)</term>
7428 <listitem><para>This option helps Samba to try and 'guess' at
7429 the real UNIX username, as many DOS clients send an all-uppercase
7430 username. By default Samba tries all lowercase, followed by the
7431 username with the first letter capitalized, and fails if the
7432 username is not found on the UNIX machine.</para>
7434 <para>If this parameter is set to non-zero the behavior changes.
7435 This parameter is a number that specifies the number of uppercase
7436 combinations to try while trying to determine the UNIX user name. The
7437 higher the number the more combinations will be tried, but the slower
7438 the discovery of usernames will be. Use this parameter when you have
7439 strange usernames on your UNIX machine, such as <constant>AstrangeUser
7440 </constant>.</para>
7442 <para>Default: <command>username level = 0</command></para>
7443 <para>Example: <command>username level = 5</command></para>
7444 </listitem>
7445 </varlistentry>
7449 <varlistentry>
7450 <term><anchor id="USERNAMEMAP">username map (G)</term>
7451 <listitem><para>This option allows you to specify a file containing
7452 a mapping of usernames from the clients to the server. This can be
7453 used for several purposes. The most common is to map usernames
7454 that users use on DOS or Windows machines to those that the UNIX
7455 box uses. The other is to map multiple users to a single username
7456 so that they can more easily share files.</para>
7458 <para>The map file is parsed line by line. Each line should
7459 contain a single UNIX username on the left then a '=' followed
7460 by a list of usernames on the right. The list of usernames on the
7461 right may contain names of the form @group in which case they
7462 will match any UNIX username in that group. The special client
7463 name '*' is a wildcard and matches any name. Each line of the
7464 map file may be up to 1023 characters long.</para>
7466 <para>The file is processed on each line by taking the
7467 supplied username and comparing it with each username on the right
7468 hand side of the '=' signs. If the supplied name matches any of
7469 the names on the right hand side then it is replaced with the name
7470 on the left. Processing then continues with the next line.</para>
7472 <para>If any line begins with a '#' or a ';' then it is
7473 ignored</para>
7475 <para>If any line begins with an '!' then the processing
7476 will stop after that line if a mapping was done by the line.
7477 Otherwise mapping continues with every line being processed.
7478 Using '!' is most useful when you have a wildcard mapping line
7479 later in the file.</para>
7481 <para>For example to map from the name <constant>admin</constant>
7482 or <constant>administrator</constant> to the UNIX name <constant>
7483 root</constant> you would use:</para>
7485 <para><command>root = admin administrator</command></para>
7487 <para>Or to map anyone in the UNIX group <constant>system</constant>
7488 to the UNIX name <constant>sys</constant> you would use:</para>
7490 <para><command>sys = @system</command></para>
7492 <para>You can have as many mappings as you like in a username
7493 map file.</para>
7496 <para>If your system supports the NIS NETGROUP option then
7497 the netgroup database is checked before the <filename>/etc/group
7498 </filename> database for matching groups.</para>
7500 <para>You can map Windows usernames that have spaces in them
7501 by using double quotes around the name. For example:</para>
7503 <para><command>tridge = "Andrew Tridgell"</command></para>
7505 <para>would map the windows username "Andrew Tridgell" to the
7506 unix username "tridge".</para>
7508 <para>The following example would map mary and fred to the
7509 unix user sys, and map the rest to guest. Note the use of the
7510 '!' to tell Samba to stop processing if it gets a match on
7511 that line.</para>
7513 <para><programlisting>
7514 !sys = mary fred
7515 guest = *
7516 </programlisting></para>
7518 <para>Note that the remapping is applied to all occurrences
7519 of usernames. Thus if you connect to \\server\fred and <constant>
7520 fred</constant> is remapped to <constant>mary</constant> then you
7521 will actually be connecting to \\server\mary and will need to
7522 supply a password suitable for <constant>mary</constant> not
7523 <constant>fred</constant>. The only exception to this is the
7524 username passed to the <link linkend="PASSWORDSERVER"><parameter>
7525 password server</parameter></link> (if you have one). The password
7526 server will receive whatever username the client supplies without
7527 modification.</para>
7529 <para>Also note that no reverse mapping is done. The main effect
7530 this has is with printing. Users who have been mapped may have
7531 trouble deleting print jobs as PrintManager under WfWg will think
7532 they don't own the print job.</para>
7534 <para>Default: <emphasis>no username map</emphasis></para>
7535 <para>Example: <command>username map = /usr/local/samba/lib/users.map
7536 </command></para>
7537 </listitem>
7538 </varlistentry>
7542 <varlistentry>
7543 <term><anchor id="UTMP">utmp (S)</term>
7544 <listitem><para>This boolean parameter is only available if
7545 Samba has been configured and compiled with the option <command>
7546 --with-utmp</command>. If set to True then Samba will attempt
7547 to add utmp or utmpx records (depending on the UNIX system) whenever a
7548 connection is made to a Samba server. Sites may use this to record the
7549 user connecting to a Samba share.</para>
7551 <para>See also the <link linkend="UTMPDIRECTORY"><parameter>
7552 utmp directory</parameter></link> parameter.</para>
7554 <para>Default: <command>utmp = no</command></para>
7555 </listitem>
7556 </varlistentry>
7560 <varlistentry>
7561 <term><anchor id="UTMPDIRECTORY">utmp directory(G)</term>
7562 <listitem><para>This parameter is only available if Samba has
7563 been configured and compiled with the option <command>
7564 --with-utmp</command>. It specifies a directory pathname that is
7565 used to store the utmp or utmpx files (depending on the UNIX system) that
7566 record user connections to a Samba server. See also the <link linkend="UTMP">
7567 <parameter>utmp</parameter></link> parameter. By default this is
7568 not set, meaning the system will use whatever utmp file the
7569 native system is set to use (usually
7570 <filename>/var/run/utmp</filename> on Linux).</para>
7572 <para>Default: <emphasis>no utmp directory</emphasis></para>
7573 </listitem>
7574 </varlistentry>
7578 <varlistentry>
7579 <term><anchor id="VALIDCHARS">valid chars (G)</term>
7580 <listitem><para>The option allows you to specify additional
7581 characters that should be considered valid by the server in
7582 filenames. This is particularly useful for national character
7583 sets, such as adding u-umlaut or a-ring.</para>
7585 <para>The option takes a list of characters in either integer
7586 or character form with spaces between them. If you give two
7587 characters with a colon between them then it will be taken as
7588 an lowercase:uppercase pair.</para>
7590 <para>If you have an editor capable of entering the characters
7591 into the config file then it is probably easiest to use this
7592 method. Otherwise you can specify the characters in octal,
7593 decimal or hexadecimal form using the usual C notation.</para>
7595 <para>For example to add the single character 'Z' to the charset
7596 (which is a pointless thing to do as it's already there) you could
7597 do one of the following</para>
7599 <para><programlisting>
7600 valid chars = Z
7601 valid chars = z:Z
7602 valid chars = 0132:0172
7603 </programlisting></para>
7605 <para>The last two examples above actually add two characters,
7606 and alter the uppercase and lowercase mappings appropriately.</para>
7608 <para>Note that you <emphasis>MUST</emphasis> specify this parameter
7609 after the <parameter>client code page</parameter> parameter if you
7610 have both set. If <parameter>client code page</parameter> is set after
7611 the <parameter>valid chars</parameter> parameter the <parameter>valid
7612 chars</parameter> settings will be overwritten.</para>
7614 <para>See also the <link linkend="CLIENTCODEPAGE"><parameter>client
7615 code page</parameter></link> parameter.</para>
7617 <para>Default: <emphasis>Samba defaults to using a reasonable set
7618 of valid characters for English systems</emphasis></para>
7620 <para>Example: <command>valid chars = 0345:0305 0366:0326 0344:0304
7621 </command></para>
7623 <para>The above example allows filenames to have the Swedish
7624 characters in them.</para>
7626 <para><emphasis>NOTE:</emphasis> It is actually quite difficult to
7627 correctly produce a <parameter>valid chars</parameter> line for
7628 a particular system. To automate the process <ulink
7629 url="mailto:tino@augsburg.net">tino@augsburg.net</ulink> has written
7630 a package called <command>validchars</command> which will automatically
7631 produce a complete <parameter>valid chars</parameter> line for
7632 a given client system. Look in the <filename>examples/validchars/
7633 </filename> subdirectory of your Samba source code distribution
7634 for this package.</para>
7635 </listitem>
7636 </varlistentry>
7640 <varlistentry>
7641 <term><anchor id="VALIDUSERS">valid users (S)</term>
7642 <listitem><para>This is a list of users that should be allowed
7643 to login to this service. Names starting with '@', '+' and '&'
7644 are interpreted using the same rules as described in the
7645 <parameter>invalid users</parameter> parameter.</para>
7647 <para>If this is empty (the default) then any user can login.
7648 If a username is in both this list and the <parameter>invalid
7649 users</parameter> list then access is denied for that user.</para>
7651 <para>The current servicename is substituted for <parameter>%S
7652 </parameter>. This is useful in the [homes] section.</para>
7654 <para>See also <link linkend="INVALIDUSERS"><parameter>invalid users
7655 </parameter></link></para>
7657 <para>Default: <emphasis>No valid users list (anyone can login)
7658 </emphasis></para>
7660 <para>Example: <command>valid users = greg, @pcusers</command></para>
7661 </listitem>
7662 </varlistentry>
7667 <varlistentry>
7668 <term><anchor id="VETOFILES">veto files(S)</term>
7669 <listitem><para>This is a list of files and directories that
7670 are neither visible nor accessible. Each entry in the list must
7671 be separated by a '/', which allows spaces to be included
7672 in the entry. '*' and '?' can be used to specify multiple files
7673 or directories as in DOS wildcards.</para>
7675 <para>Each entry must be a unix path, not a DOS path and
7676 must <emphasis>not</emphasis> include the unix directory
7677 separator '/'.</para>
7679 <para>Note that the <parameter>case sensitive</parameter> option
7680 is applicable in vetoing files.</para>
7682 <para>One feature of the veto files parameter that it is important
7683 to be aware of, is that if a directory contains nothing but files
7684 that match the veto files parameter (which means that Windows/DOS
7685 clients cannot ever see them) is deleted, the veto files within
7686 that directory <emphasis>are automatically deleted</emphasis> along
7687 with it, if the user has UNIX permissions to do so.</para>
7689 <para>Setting this parameter will affect the performance
7690 of Samba, as it will be forced to check all files and directories
7691 for a match as they are scanned.</para>
7693 <para>See also <link linkend="HIDEFILES"><parameter>hide files
7694 </parameter></link> and <link linkend="CASESENSITIVE"><parameter>
7695 case sensitive</parameter></link>.</para>
7697 <para>Default: <emphasis>No files or directories are vetoed.
7698 </emphasis></para>
7700 <para>Examples:<programlisting>
7701 ; Veto any files containing the word Security,
7702 ; any ending in .tmp, and any directory containing the
7703 ; word root.
7704 veto files = /*Security*/*.tmp/*root*/
7706 ; Veto the Apple specific files that a NetAtalk server
7707 ; creates.
7708 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
7709 </programlisting></para>
7710 </listitem>
7711 </varlistentry>
7714 <varlistentry>
7715 <term><anchor id="VETOOPLOCKFILES">veto oplock files (S)</term>
7716 <listitem><para>This parameter is only valid when the <link
7717 linkend="OPLOCKS"><parameter>oplocks</parameter></link>
7718 parameter is turned on for a share. It allows the Samba administrator
7719 to selectively turn off the granting of oplocks on selected files that
7720 match a wildcarded list, similar to the wildcarded list used in the
7721 <link linkend="VETOFILES"><parameter>veto files</parameter></link>
7722 parameter.</para>
7724 <para>Default: <emphasis>No files are vetoed for oplock
7725 grants</emphasis></para>
7727 <para>You might want to do this on files that you know will
7728 be heavily contended for by clients. A good example of this
7729 is in the NetBench SMB benchmark program, which causes heavy
7730 client contention for files ending in <filename>.SEM</filename>.
7731 To cause Samba not to grant oplocks on these files you would use
7732 the line (either in the [global] section or in the section for
7733 the particular NetBench share :</para>
7735 <para>Example: <command>veto oplock files = /*;.SEM/
7736 </command></para>
7737 </listitem>
7738 </varlistentry>
7742 <varlistentry>
7743 <term><anchor id="VFSOBJECT">vfs object (S)</term>
7744 <listitem><para>This parameter specifies a shared object file that
7745 is used for Samba VFS I/O operations. By default, normal
7746 disk I/O operations are used but these can be overloaded
7747 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
7748 must be enabled at compile time with --with-vfs.</para>
7750 <para>Default : <emphasis>no value</emphasis></para>
7751 </listitem>
7752 </varlistentry>
7757 <varlistentry>
7758 <term><anchor id="VFSOPTIONS">vfs options (S)</term>
7759 <listitem><para>This parameter allows parameters to be passed
7760 to the vfs layer at initialisation time. The Samba VFS layer
7761 is new to Samba 2.2 and must be enabled at compile time
7762 with --with-vfs. See also <link linkend="VFSOBJECT"><parameter>
7763 vfs object</parameter></link>.</para>
7765 <para>Default : <emphasis>no value</emphasis></para>
7766 </listitem>
7767 </varlistentry>
7771 <varlistentry>
7772 <term><anchor id="VOLUME">volume (S)</term>
7773 <listitem><para> This allows you to override the volume label
7774 returned for a share. Useful for CDROMs with installation programs
7775 that insist on a particular volume label.</para>
7777 <para>Default: <emphasis>the name of the share</emphasis></para>
7778 </listitem>
7779 </varlistentry>
7783 <varlistentry>
7784 <term><anchor id="WIDELINKS">wide links (S)</term>
7785 <listitem><para>This parameter controls whether or not links
7786 in the UNIX file system may be followed by the server. Links
7787 that point to areas within the directory tree exported by the
7788 server are always allowed; this parameter controls access only
7789 to areas that are outside the directory tree being exported.</para>
7791 <para>Note that setting this parameter can have a negative
7792 effect on your server performance due to the extra system calls
7793 that Samba has to do in order to perform the link checks.</para>
7795 <para>Default: <command>wide links = yes</command></para>
7796 </listitem>
7797 </varlistentry>
7802 <varlistentry>
7803 <term><anchor id="WINBINDCACHETIME">winbind cache time</term>
7804 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7805 available in Samba 3.0.</para>
7807 <para>This parameter specifies the number of seconds the
7808 <ulink url="winbindd.8.html">winbindd(8)</ulink> daemon will cache
7809 user and group information before querying a Windows NT server
7810 again.</para>
7812 <para>Default: <command>winbind cache type = 15</command></para>
7813 </listitem>
7814 </varlistentry>
7819 <varlistentry>
7820 <term><anchor id="WINBINDGID">winbind gid</term>
7821 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7822 available in Samba 3.0.</para>
7824 <para>The winbind gid parameter specifies the range of group
7825 ids that are allocated by the <ulink url="winbindd.8.html">
7826 winbindd(8)</ulink> daemon. This range of group ids should have no
7827 existing local or nis groups within it as strange conflicts can
7828 occur otherwise.</para>
7830 <para>Default: <command>winbind gid = &lt;empty string&gt;
7831 </command></para>
7833 <para>Example: <command>winbind gid = 10000-20000</command></para>
7834 </listitem>
7835 </varlistentry>
7838 <varlistentry>
7839 <term><anchor id="WINBINDSEPARATOR">winbind separator</term>
7840 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7841 available in Samba 3.0.</para>
7843 <para>This parameter allows an admin to define the character
7844 used when listing a username of the form of <replaceable>DOMAIN
7845 </replaceable>\<replaceable>user</replaceable>. This parameter
7846 is only applicable when using the <filename>pam_winbind.so</filename>
7847 and <filename>nss_winbind.so</filename> modules for UNIX services.
7848 </para>
7850 <para>Example: <command>winbind separator = \</command></para>
7851 <para>Example: <command>winbind separator = +</command></para>
7852 </listitem>
7853 </varlistentry>
7858 <varlistentry>
7859 <term><anchor id="WINBINDUID">winbind uid</term>
7860 <listitem><para><emphasis>NOTE:</emphasis> this parameter is only
7861 available in Samba 3.0.</para>
7863 <para>The winbind gid parameter specifies the range of group
7864 ids that are allocated by the <ulink url="winbindd.8.html">
7865 winbindd(8)</ulink> daemon. This range of ids should have no
7866 existing local or nis users within it as strange conflicts can
7867 occur otherwise.</para>
7869 <para>Default: <command>winbind uid = &lt;empty string&gt;
7870 </command></para>
7872 <para>Example: <command>winbind uid = 10000-20000</command></para>
7873 </listitem>
7874 </varlistentry>
7880 <varlistentry>
7881 <term><anchor id="WINSHOOK">wins hook (G)</term>
7882 <listitem><para>When Samba is running as a WINS server this
7883 allows you to call an external program for all changes to the
7884 WINS database. The primary use for this option is to allow the
7885 dynamic update of external name resolution databases such as
7886 dynamic DNS.</para>
7888 <para>The wins hook parameter specifies the name of a script
7889 or executable that will be called as follows:</para>
7891 <para><command>wins_hook operation name nametype ttl IP_list
7892 </command></para>
7894 <itemizedlist>
7895 <listitem><para>The first argument is the operation and is one
7896 of "add", "delete", or "refresh". In most cases the operation can
7897 be ignored as the rest of the parameters provide sufficient
7898 information. Note that "refresh" may sometimes be called when the
7899 name has not previously been added, in that case it should be treated
7900 as an add.</para></listitem>
7902 <listitem><para>The second argument is the netbios name. If the
7903 name is not a legal name then the wins hook is not called.
7904 Legal names contain only letters, digits, hyphens, underscores
7905 and periods.</para></listitem>
7907 <listitem><para>The third argument is the netbios name
7908 type as a 2 digit hexadecimal number. </para></listitem>
7910 <listitem><para>The fourth argument is the TTL (time to live)
7911 for the name in seconds.</para></listitem>
7913 <listitem><para>The fifth and subsequent arguments are the IP
7914 addresses currently registered for that name. If this list is
7915 empty then the name should be deleted.</para></listitem>
7916 </itemizedlist>
7918 <para>An example script that calls the BIND dynamic DNS update
7919 program <command>nsupdate</command> is provided in the examples
7920 directory of the Samba source code. </para>
7921 </listitem>
7922 </varlistentry>
7928 <varlistentry>
7929 <term><anchor id="WINSPROXY">wins proxy (G)</term>
7930 <listitem><para>This is a boolean that controls if <ulink
7931 url="nmbd.8.html">nmbd(8)</ulink> will respond to broadcast name
7932 queries on behalf of other hosts. You may need to set this
7933 to <constant>yes</constant> for some older clients.</para>
7935 <para>Default: <command>wins proxy = no</command></para>
7936 </listitem>
7937 </varlistentry>
7942 <varlistentry>
7943 <term><anchor id="WINSSERVER">wins server (G)</term>
7944 <listitem><para>This specifies the IP address (or DNS name: IP
7945 address for preference) of the WINS server that <ulink url="nmbd.8.html">
7946 nmbd(8)</ulink> should register with. If you have a WINS server on
7947 your network then you should set this to the WINS server's IP.</para>
7949 <para>You should point this at your WINS server if you have a
7950 multi-subnetted network.</para>
7952 <para><emphasis>NOTE</emphasis>. You need to set up Samba to point
7953 to a WINS server if you have multiple subnets and wish cross-subnet
7954 browsing to work correctly.</para>
7956 <para>See the documentation file <filename>BROWSING.txt</filename>
7957 in the docs/ directory of your Samba source distribution.</para>
7959 <para>Default: <emphasis>not enabled</emphasis></para>
7960 <para>Example: <command>wins server = 192.9.200.1</command></para>
7961 </listitem>
7962 </varlistentry>
7966 <varlistentry>
7967 <term><anchor id="WINSSUPPORT">wins support (G)</term>
7968 <listitem><para>This boolean controls if the <ulink url="nmbd.8.html">
7969 nmbd(8)</ulink> process in Samba will act as a WINS server. You should
7970 not set this to true unless you have a multi-subnetted network and
7971 you wish a particular <command>nmbd</command> to be your WINS server.
7972 Note that you should <emphasis>NEVER</emphasis> set this to true
7973 on more than one machine in your network.</para>
7975 <para>Default: <command>wins support = no</command></para>
7976 </listitem>
7977 </varlistentry>
7981 <varlistentry>
7982 <term><anchor id="WORKGROUP">workgroup (G)</term>
7983 <listitem><para>This controls what workgroup your server will
7984 appear to be in when queried by clients. Note that this parameter
7985 also controls the Domain name used with the <link
7986 linkend="SECURITYEQUALSDOMAIN"><command>security=domain</command></link>
7987 setting.</para>
7989 <para>Default: <emphasis>set at compile time to WORKGROUP</emphasis></para>
7990 <para>Example: <command>workgroup = MYGROUP</command></para>
7991 </listitem>
7992 </varlistentry>
7997 <varlistentry>
7998 <term><anchor id="WRITABLE">writable (S)</term>
7999 <listitem><para>Synonym for <link linkend="WRITEABLE"><parameter>
8000 writeable</parameter></link> for people who can't spell :-).</para>
8001 </listitem>
8002 </varlistentry>
8006 <varlistentry>
8007 <term><anchor id="WRITECACHESIZE">write cache size (S)</term>
8008 <listitem><para>If this integer parameter is set to non-zero value,
8009 Samba will create an in-memory cache for each oplocked file
8010 (it does <emphasis>not</emphasis> do this for
8011 non-oplocked files). All writes that the client does not request
8012 to be flushed directly to disk will be stored in this cache if possible.
8013 The cache is flushed onto disk when a write comes in whose offset
8014 would not fit into the cache or when the file is closed by the client.
8015 Reads for the file are also served from this cache if the data is stored
8016 within it.</para>
8018 <para>This cache allows Samba to batch client writes into a more
8019 efficient write size for RAID disks (ie. writes may be tuned to
8020 be the RAID stripe size) and can improve performance on systems
8021 where the disk subsystem is a bottleneck but there is free
8022 memory for userspace programs.</para>
8024 <para>The integer parameter specifies the size of this cache
8025 (per oplocked file) in bytes.</para>
8027 <para>Default: <command>write cache size = 0</command></para>
8028 <para>Example: <command>write cache size = 262144</command></para>
8030 <para>for a 256k cache size per file.</para>
8031 </listitem>
8032 </varlistentry>
8038 <varlistentry>
8039 <term><anchor id="WRITELIST">write list (S)</term>
8040 <listitem><para>This is a list of users that are given read-write
8041 access to a service. If the connecting user is in this list then
8042 they will be given write access, no matter what the <link
8043 linkend="WRITEABLE"><parameter>writeable</parameter></link>
8044 option is set to. The list can include group names using the
8045 @group syntax.</para>
8047 <para>Note that if a user is in both the read list and the
8048 write list then they will be given write access.</para>
8050 <para>See also the <link linkend="READLIST"><parameter>read list
8051 </parameter></link> option.</para>
8053 <para>Default: <command>write list = &lt;empty string&gt;
8054 </command></para>
8056 <para>Example: <command>write list = admin, root, @staff
8057 </command></para>
8058 </listitem>
8059 </varlistentry>
8065 <varlistentry>
8066 <term><anchor id="WRITEOK">write ok (S)</term>
8067 <listitem><para>Synonym for <link linkend="WRITEABLE"><parameter>
8068 writeable</parameter></link>.</para>
8069 </listitem>
8070 </varlistentry>
8074 <varlistentry>
8075 <term><anchor id="WRITERAW">write raw (G)</term>
8076 <listitem><para>This parameter controls whether or not the server
8077 will support raw writes SMB's when transferring data from clients.
8078 You should never need to change this parameter.</para>
8080 <para>Default: <command>write raw = yes</command></para>
8081 </listitem>
8082 </varlistentry>
8086 <varlistentry>
8087 <term><anchor id="WRITEABLE">writeable (S)</term>
8088 <listitem><para>An inverted synonym is <link linkend="READONLY">
8089 <parameter>read only</parameter></link>.</para>
8091 <para>If this parameter is <constant>no</constant>, then users
8092 of a service may not create or modify files in the service's
8093 directory.</para>
8095 <para>Note that a printable service (<command>printable = yes</command>)
8096 will <emphasis>ALWAYS</emphasis> allow writing to the directory
8097 (user privileges permitting), but only via spooling operations.</para>
8099 <para>Default: <command>writeable = no</command></para>
8100 </listitem>
8101 </varlistentry>
8104 </variablelist>
8106 </refsect1>
8108 <refsect1>
8109 <title>WARNINGS</title>
8111 <para>Although the configuration file permits service names
8112 to contain spaces, your client software may not. Spaces will
8113 be ignored in comparisons anyway, so it shouldn't be a
8114 problem - but be aware of the possibility.</para>
8116 <para>On a similar note, many clients - especially DOS clients -
8117 limit service names to eight characters. <ulink url="smbd.8.html">smbd(8)
8118 </ulink> has no such limitation, but attempts to connect from such
8119 clients will fail if they truncate the service names. For this reason
8120 you should probably keep your service names down to eight characters
8121 in length.</para>
8123 <para>Use of the [homes] and [printers] special sections make life
8124 for an administrator easy, but the various combinations of default
8125 attributes can be tricky. Take extreme care when designing these
8126 sections. In particular, ensure that the permissions on spool
8127 directories are correct.</para>
8128 </refsect1>
8130 <refsect1>
8131 <title>VERSION</title>
8133 <para>This man page is correct for version 2.2 of
8134 the Samba suite.</para>
8135 </refsect1>
8137 <refsect1>
8138 <title>SEE ALSO</title>
8139 <para><ulink url="samba.7.html">samba(7)</ulink>,
8140 <ulink url="smbpasswd.8.html"><command>smbpasswd(8)</command></ulink>,
8141 <ulink url="swat.8.html"><command>swat(8)</command></ulink>,
8142 <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>,
8143 <ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>,
8144 <ulink url="smbclient.1.html"><command>smbclient(1)</command></ulink>,
8145 <ulink url="nmblookup.1.html"><command>nmblookup(1)</command></ulink>,
8146 <ulink url="testparm.1.html"><command>testparm(1)</command></ulink>,
8147 <ulink url="testprns.1.html"><command>testprns(1)</command></ulink>
8148 </para>
8149 </refsect1>
8151 <refsect1>
8152 <title>AUTHOR</title>
8154 <para>The original Samba software and related utilities
8155 were created by Andrew Tridgell. Samba is now developed
8156 by the Samba Team as an Open Source project similar
8157 to the way the Linux kernel is developed.</para>
8159 <para>The original Samba man pages were written by Karl Auer.
8160 The man page sources were converted to YODL format (another
8161 excellent piece of Open Source software, available at
8162 <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
8163 ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
8164 release by Jeremy Allison. The conversion to DocBook for
8165 Samba 2.2 was done by Gerald Carter</para>
8166 </refsect1>
8168 </refentry>