docs/htmldocs/smb.conf.5.html

   1
   2
   3
   4
   5
   6 <html><head><title>smb.conf (5)</title>
   7
   8 <link rev="made" href="mailto:samba-bugs@samba.org">
   9 </head>
  10 <body>
  11
  12 <hr>
  13
  14 <h1>smb.conf (5)</h1>
  15 <h2>Samba</h2>
  16 <h2>23 Oct 1998</h2>
  17
  18
  19
  20
  21 <p><br><a name="NAME"></a>
  22 <h2>NAME</h2>
  23     smb.conf - The configuration file for the Samba suite
  24 <p><br><a name="SYNOPSIS"></a>
  25 <h2>SYNOPSIS</h2>
  26
  27 <p><br><strong>smb.conf</strong> The <strong>smb.conf</strong> file is a configuration file for the
  28 Samba suite. <strong>smb.conf</strong> contains runtime configuration information
  29 for the Samba programs. The <strong>smb.conf</strong> file is designed to be
  30 configured and administered by the <a href="swat.8.html"><strong>swat (8)</strong></a>
  31 program. The complete description of the file format and possible
  32 parameters held within are here for reference purposes.
  33 <p><br><a name="FILEFORMAT"></a>
  34 <h2>FILE FORMAT</h2>
  35
  36 <p><br>The file consists of sections and parameters. A section begins with
  37 the name of the section in square brackets and continues until the
  38 next section begins. Sections contain parameters of the form
  39 <p><br><code>'name = value'</code>
  40 <p><br>The file is line-based - that is, each newline-terminated line
  41 represents either a comment, a section name or a parameter.
  42 <p><br>Section and parameter names are not case sensitive.
  43 <p><br>Only the first equals sign in a parameter is significant. Whitespace
  44 before or after the first equals sign is discarded. Leading, trailing
  45 and internal whitespace in section and parameter names is
  46 irrelevant. Leading and trailing whitespace in a parameter value is
  47 discarded. Internal whitespace within a parameter value is retained
  48 verbatim.
  49 <p><br>Any line beginning with a semicolon (';') or a hash ('#') character is
  50 ignored, as are lines containing only whitespace.
  51 <p><br>Any line ending in a <code>'\'</code> is "continued" on the next line in the
  52 customary UNIX fashion.
  53 <p><br>The values following the equals sign in parameters are all either a
  54 string (no quotes needed) or a boolean, which may be given as yes/no,
  55 0/1 or true/false. Case is not significant in boolean values, but is
  56 preserved in string values. Some items such as create modes are
  57 numeric.
  58 <p><br><a name="SECTIONDESCRIPTIONS"></a>
  59 <h2>SECTION DESCRIPTIONS</h2>
  60
  61 <p><br>Each section in the configuration file (except for the
  62 <a href="smb.conf.5.html#global"><strong>[global]</strong></a> section) describes a shared resource (known
  63 as a <em>"share"</em>). The section name is the name of the shared resource
  64 and the parameters within the section define the shares attributes.
  65 <p><br>There are three special sections, <a href="smb.conf.5.html#global"><strong>[global]</strong></a>,
  66 <a href="smb.conf.5.html#homes"><strong>[homes]</strong></a> and <a href="smb.conf.5.html#printers"><strong>[printers]</strong></a>, which are
  67 described under <a href="smb.conf.5.html#SPECIALSECTIONS"><strong>'special sections'</strong></a>. The
  68 following notes apply to ordinary section descriptions.
  69 <p><br>A share consists of a directory to which access is being given plus
  70 a description of the access rights which are granted to the user of
  71 the service. Some housekeeping options are also specifiable.
  72 <p><br>Sections are either filespace services (used by the client as an
  73 extension of their native file systems) or printable services (used by
  74 the client to access print services on the host running the server).
  75 <p><br>Sections may be designated <a href="smb.conf.5.html#guestok"><strong>guest</strong></a> services, in which
  76 case no password is required to access them. A specified UNIX
  77 <a href="smb.conf.5.html#guestaccount"><strong>guest account</strong></a> is used to define access
  78 privileges in this case.
  79 <p><br>Sections other than guest services will require a password to access
  80 them. The client provides the username. As older clients only provide
  81 passwords and not usernames, you may specify a list of usernames to
  82 check against the password using the <a href="smb.conf.5.html#user"><strong>"user="</strong></a> option in
  83 the share definition. For modern clients such as Windows 95/98 and
  84 Windows NT, this should not be necessary.
  85 <p><br>Note that the access rights granted by the server are masked by the
  86 access rights granted to the specified or guest UNIX user by the host
  87 system. The server does not grant more access than the host system
  88 grants.
  89 <p><br>The following sample section defines a file space share. The user has
  90 write access to the path <code>/home/bar</code>. The share is accessed via
  91 the share name "foo":
  92 <p><br><pre>
  93
  94
  95         [foo]
  96                 path = /home/bar
  97                 writeable = true
  98
  99
 100 </pre>
 101
 102 <p><br>The following sample section defines a printable share. The share
 103 is readonly, but printable. That is, the only write access permitted
 104 is via calls to open, write to and close a spool file. The
 105 <a href="smb.conf.5.html#guestok"><strong>'guest ok'</strong></a> parameter means access will be permitted
 106 as the default guest user (specified elsewhere):
 107 <p><br><pre>
 108
 109         [aprinter]
 110                 path = /usr/spool/public
 111                 read only = true
 112                 printable = true
 113                 guest ok = true
 114
 115 </pre>
 116
 117 <p><br><a name="SPECIALSECTIONS"></a>
 118 <h2>SPECIAL SECTIONS</h2>
 119
 120 <p><br><ul>
 121 <p><br><a name="global"></a>
 122 <li><strong><strong>The [global] section</strong></strong>
 123 <p><br>Parameters in this section apply to the server as a whole, or are
 124 defaults for sections which do not specifically define certain
 125 items. See the notes under <a href="smb.conf.5.html#PARAMETERS"><strong>'PARAMETERS'</strong></a> for more
 126 information.
 127 <p><br><a name="homes"></a>
 128 <li><strong><strong>The [homes] section</strong></strong>
 129 <p><br>If a section called <code>'homes'</code> is included in the configuration file,
 130 services connecting clients to their home directories can be created
 131 on the fly by the server.
 132 <p><br>When the connection request is made, the existing sections are
 133 scanned. If a match is found, it is used. If no match is found, the
 134 requested section name is treated as a user name and looked up in the
 135 local password file. If the name exists and the correct password has
 136 been given, a share is created by cloning the [homes] section.
 137 <p><br>Some modifications are then made to the newly created share:
 138 <p><br><ul>
 139 <p><br><li > The share name is changed from <code>'homes'</code> to the located
 140 username
 141 <p><br><li > If no path was given, the path is set to the user's home
 142 directory.
 143 <p><br></ul>
 144 <p><br>If you decide to use a <a href="smb.conf.5.html#path"><strong>path=</strong></a> line in your [homes]
 145 section then you may find it useful to use the <a href="smb.conf.5.html#percentS"><strong>%S</strong></a>
 146 macro. For example :
 147 <p><br><code>path=/data/pchome/%S</code>
 148 <p><br>would be useful if you have different home directories for your PCs
 149 than for UNIX access.
 150 <p><br>This is a fast and simple way to give a large number of clients access
 151 to their home directories with a minimum of fuss.
 152 <p><br>A similar process occurs if the requested section name is <code>"homes"</code>,
 153 except that the share name is not changed to that of the requesting
 154 user. This method of using the [homes] section works well if different
 155 users share a client PC.
 156 <p><br>The [homes] section can specify all the parameters a normal service
 157 section can specify, though some make more sense than others. The
 158 following is a typical and suitable [homes] section:
 159 <p><br><pre>
 160
 161         [homes]
 162                 writeable = yes
 163
 164 </pre>
 165
 166 <p><br>An important point is that if guest access is specified in the [homes]
 167 section, all home directories will be visible to all clients
 168 <strong>without a password</strong>. In the very unlikely event that this is
 169 actually desirable, it would be wise to also specify <a href="smb.conf.5.html#readonly"><strong>read only
 170 access</strong></a>.
 171 <p><br>Note that the <a href="smb.conf.5.html#browseable"><strong>browseable</strong></a> flag for auto home
 172 directories will be inherited from the global browseable flag, not the
 173 [homes] browseable flag. This is useful as it means setting
 174 browseable=no in the [homes] section will hide the [homes] share but
 175 make any auto home directories visible.
 176 <p><br><a name="printers"></a>
 177 <li><strong><strong>The [printers] section</strong></strong>
 178 <p><br>This section works like <a href="smb.conf.5.html#homes"><strong>[homes]</strong></a>, but for printers.
 179 <p><br>If a [printers] section occurs in the configuration file, users are
 180 able to connect to any printer specified in the local host's printcap
 181 file.
 182 <p><br>When a connection request is made, the existing sections are
 183 scanned. If a match is found, it is used. If no match is found, but a
 184 <a href="smb.conf.5.html#homes"><strong>[homes]</strong></a> section exists, it is used as described
 185 above. Otherwise, the requested section name is treated as a printer
 186 name and the appropriate printcap file is scanned to see if the
 187 requested section name is a valid printer share name. If a match is
 188 found, a new printer share is created by cloning the [printers]
 189 section.
 190 <p><br>A few modifications are then made to the newly created share:
 191 <p><br><ul>
 192 <p><br><li > The share name is set to the located printer name
 193 <p><br><li > If no printer name was given, the printer name is set to the
 194 located printer name
 195 <p><br><li > If the share does not permit guest access and no username was
 196 given, the username is set to the located printer name.
 197 <p><br></ul>
 198 <p><br>Note that the [printers] service MUST be printable - if you specify
 199 otherwise, the server will refuse to load the configuration file.
 200 <p><br>Typically the path specified would be that of a world-writeable spool
 201 directory with the sticky bit set on it. A typical [printers] entry
 202 would look like this:
 203 <p><br><pre>
 204
 205         [printers]
 206                 path = /usr/spool/public
 207                 writeable = no
 208                 guest ok = yes
 209                 printable = yes
 210
 211 </pre>
 212
 213 <p><br>All aliases given for a printer in the printcap file are legitimate
 214 printer names as far as the server is concerned. If your printing
 215 subsystem doesn't work like that, you will have to set up a
 216 pseudo-printcap. This is a file consisting of one or more lines like
 217 this:
 218 <p><br><pre>
 219         alias|alias|alias|alias...
 220 </pre>
 221
 222 <p><br>Each alias should be an acceptable printer name for your printing
 223 subsystem. In the <a href="smb.conf.5.html#global"><strong>[global]</strong></a> section, specify the new
 224 file as your printcap.  The server will then only recognize names
 225 found in your pseudo-printcap, which of course can contain whatever
 226 aliases you like. The same technique could be used simply to limit
 227 access to a subset of your local printers.
 228 <p><br>An alias, by the way, is defined as any component of the first entry
 229 of a printcap record. Records are separated by newlines, components
 230 (if there are more than one) are separated by vertical bar symbols
 231 ("|").
 232 <p><br>NOTE: On SYSV systems which use lpstat to determine what printers are
 233 defined on the system you may be able to use <a href="smb.conf.5.html#printcapname"><strong>"printcap name =
 234 lpstat"</strong></a> to automatically obtain a list of
 235 printers. See the <a href="smb.conf.5.html#printcapname"><strong>"printcap name"</strong></a> option for
 236 more details.
 237 <p><br></ul>
 238 <p><br><a name="PARAMETERS"></a>
 239 <h2>PARAMETERS</h2>
 240
 241 <p><br>Parameters define the specific attributes of sections.
 242 <p><br>Some parameters are specific to the <a href="smb.conf.5.html#global"><strong>[global]</strong></a> section
 243 (e.g., <a href="smb.conf.5.html#security"><strong>security</strong></a>).  Some parameters are usable in
 244 all sections (e.g., <a href="smb.conf.5.html#createmode"><strong>create mode</strong></a>). All others are
 245 permissible only in normal sections. For the purposes of the following
 246 descriptions the <a href="smb.conf.5.html#homes"><strong>[homes]</strong></a> and
 247 <a href="smb.conf.5.html#printers"><strong>[printers]</strong></a> sections will be considered normal.
 248 The letter <code>'G'</code> in parentheses indicates that a parameter is
 249 specific to the <a href="smb.conf.5.html#global"><strong>[global]</strong></a> section. The letter <code>'S'</code>
 250 indicates that a parameter can be specified in a service specific
 251 section. Note that all <code>'S'</code> parameters can also be specified in the
 252 <a href="smb.conf.5.html#global"><strong>[global]</strong></a> section - in which case they will define
 253 the default behavior for all services.
 254 <p><br>Parameters are arranged here in alphabetical order - this may not
 255 create best bedfellows, but at least you can find them! Where there
 256 are synonyms, the preferred synonym is described, others refer to the
 257 preferred synonym.
 258 <p><br><a name="VARIABLESUBSTITUTIONS"></a>
 259 <h2>VARIABLE SUBSTITUTIONS</h2>
 260
 261 <p><br>Many of the strings that are settable in the config file can take
 262 substitutions. For example the option <a href="smb.conf.5.html#path"><strong><code>"path =
 263 /tmp/%u"</code></strong></a> would be interpreted as <code>"path = /tmp/john"</code> if
 264 the user connected with the username john.
 265 <p><br>These substitutions are mostly noted in the descriptions below, but
 266 there are some general substitutions which apply whenever they might
 267 be relevant. These are:
 268 <p><br><ul>
 269 <p><br><a name="percentS"></a>
 270 <li > <strong>%S</strong> = the name of the current service, if any.
 271 <p><br><a name="percentP"></a>
 272 <li > <strong>%P</strong> = the root directory of the current service, if any.
 273 <p><br><a name="percentu"></a>
 274 <li > <strong>%u</strong> = user name of the current service, if any.
 275 <p><br><a name="percentg"></a>
 276 <li > <strong>%g</strong> = primary group name of <a href="smb.conf.5.html#percentu"><strong>%u</strong></a>.
 277 <p><br><a name="percentU"></a>
 278 <li > <strong>%U</strong> = session user name (the user name that
 279 the client wanted, not necessarily the same as the one they got).
 280 <p><br><a name="percentG"></a>
 281 <li > <strong>%G</strong> = primary group name of <a href="smb.conf.5.html#percentU"><strong>%U</strong></a>.
 282 <p><br><a name="percentH"></a>
 283 <li > <strong>%H</strong> = the home directory of the user given by <a href="smb.conf.5.html#percentu"><strong>%u</strong></a>.
 284 <p><br><a name="percentv"></a>
 285 <li > <strong>%v</strong> = the Samba version.
 286 <p><br><a name="percenth"></a>
 287 <li > <strong>%h</strong> = the internet hostname that Samba is running on.
 288 <p><br><a name="percentm"></a>
 289 <li > <strong>%m</strong> = the NetBIOS name of the client machine (very useful).
 290 <p><br><a name="percentL"></a>
 291 <li > <strong>%L</strong> = the NetBIOS name of the server. This allows you to change your
 292 config based on what the client calls you. Your server can have a "dual
 293 personality".
 294 <p><br><a name="percentM"></a>
 295 <li > <strong>%M</strong> = the internet name of the client machine.
 296 <p><br><a name="percentN"></a>
 297 <li > <strong>%N</strong> = the name of your NIS home directory server.  This is
 298 obtained from your NIS auto.map entry.  If you have not compiled Samba
 299 with the <strong>--with-automount</strong> option then this value will be the same
 300 as <a href="smb.conf.5.html#percentL"><strong>%L</strong></a>.
 301 <p><br><a name="percentp"></a>
 302 <li > <strong>%p</strong> = the path of the service's home directory, obtained from your NIS
 303 auto.map entry. The NIS auto.map entry is split up as "%N:%p".
 304 <p><br><a name="percentR"></a>
 305 <li > <strong>%R</strong> = the selected protocol level after protocol
 306 negotiation. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1.
 307 <p><br><a name="percentd"></a>
 308 <li > <strong>%d</strong> = The process id of the current server process.
 309 <p><br><a name="percenta"></a>
 310 <li > <strong>%a</strong> = the architecture of the remote
 311 machine. Only some are recognized, and those may not be 100%
 312 reliable. It currently recognizes Samba, WfWg, WinNT and
 313 Win95. Anything else will be known as "UNKNOWN". If it gets it wrong
 314 then sending a level 3 log to <a href="mailto:samba-bugs@samba.org"><em>samba-bugs@samba.org</em></a>
 315 should allow it to be fixed.
 316 <p><br><a name="percentI"></a>
 317 <li > <strong>%I</strong> = The IP address of the client machine.
 318 <p><br><a name="percentT"></a>
 319 <li > <strong>%T</strong> = the current date and time.
 320 <p><br></ul>
 321 <p><br>There are some quite creative things that can be done with these
 322 substitutions and other smb.conf options.
 323 <p><br><a name="NAMEMANGLING"></a>
 324 <h2>NAME MANGLING</h2>
 325
 326 <p><br>Samba supports <em>"name mangling"</em> so that DOS and Windows clients can
 327 use files that don't conform to the 8.3 format. It can also be set to
 328 adjust the case of 8.3 format filenames.
 329 <p><br>There are several options that control the way mangling is performed,
 330 and they are grouped here rather than listed separately. For the
 331 defaults look at the output of the testparm program.
 332 <p><br>All of these options can be set separately for each service (or
 333 globally, of course).
 334 <p><br>The options are:
 335 <p><br><a name="manglecaseoption"></a>
 336 <strong>"mangle case = yes/no"</strong> controls if names that have characters that
 337 aren't of the "default" case are mangled. For example, if this is yes
 338 then a name like <code>"Mail"</code> would be mangled. Default <em>no</em>.
 339 <p><br><a name="casesensitiveoption"></a>
 340 <strong>"case sensitive = yes/no"</strong> controls whether filenames are case
 341 sensitive. If they aren't then Samba must do a filename search and
 342 match on passed names. Default <em>no</em>.
 343 <p><br><a name="defaultcaseoption"></a>
 344 <strong>"default case = upper/lower"</strong> controls what the default case is for new
 345 filenames. Default <em>lower</em>.
 346 <p><br><a name="preservecaseoption"></a>
 347 <strong>"preserve case = yes/no"</strong> controls if new files are created with the
 348 case that the client passes, or if they are forced to be the <code>"default"</code>
 349 case. Default <em>Yes</em>.
 350 <p><br><a name="shortpreservecaseoption"></a>
 351 <p><br><strong>"short preserve case = yes/no"</strong> controls if new files which conform
 352 to 8.3 syntax, that is all in upper case and of suitable length, are
 353 created upper case, or if they are forced to be the <code>"default"</code>
 354 case. This option can be use with <a href="smb.conf.5.html#preservecaseoption"><strong>"preserve case =
 355 yes"</strong></a> to permit long filenames to retain their
 356 case, while short names are lowered. Default <em>Yes</em>.
 357 <p><br>By default, Samba 2.0 has the same semantics as a Windows NT
 358 server, in that it is case insensitive but case preserving.
 359 <p><br><a name="NOTEABOUTUSERNAMEPASSWORDVALIDATION"></a>
 360 <h2>NOTE ABOUT USERNAME/PASSWORD VALIDATION</h2>
 361
 362 <p><br>There are a number of ways in which a user can connect to a
 363 service. The server follows the following steps in determining if it
 364 will allow a connection to a specified service. If all the steps fail
 365 then the connection request is rejected. If one of the steps pass then
 366 the following steps are not checked.
 367 <p><br>If the service is marked <a href="smb.conf.5.html#guestonly"><strong>"guest only = yes"</strong></a> then
 368 steps 1 to 5 are skipped.
 369 <p><br><ol>
 370 <p><br><li> Step 1: If the client has passed a username/password pair and
 371 that username/password pair is validated by the UNIX system's password
 372 programs then the connection is made as that username. Note that this
 373 includes the <code>\\server\service%username</code> method of passing a
 374 username.
 375 <p><br><li> Step 2: If the client has previously registered a username with
 376 the system and now supplies a correct password for that username then
 377 the connection is allowed.
 378 <p><br><li> Step 3: The client's netbios name and any previously used user
 379 names are checked against the supplied password, if they match then
 380 the connection is allowed as the corresponding user.
 381 <p><br><li> Step 4: If the client has previously validated a
 382 username/password pair with the server and the client has passed the
 383 validation token then that username is used. This step is skipped if
 384 <a href="smb.conf.5.html#revalidate"><strong>"revalidate = yes"</strong></a> for this service.
 385 <p><br><li> Step 5: If a <a href="smb.conf.5.html#user"><strong>"user = "</strong></a> field is given in the
 386 smb.conf file for the service and the client has supplied a password,
 387 and that password matches (according to the UNIX system's password
 388 checking) with one of the usernames from the <a href="smb.conf.5.html#user"><strong>user=</strong></a>
 389 field then the connection is made as the username in the
 390 <a href="smb.conf.5.html#user"><strong>"user="</strong></a> line. If one of the username in the
 391 <a href="smb.conf.5.html#user"><strong>user=</strong></a> list begins with a <code>'@'</code> then that name
 392 expands to a list of names in the group of the same name.
 393 <p><br><li> Step 6: If the service is a guest service then a connection is
 394 made as the username given in the <a href="smb.conf.5.html#guestaccount"><strong>"guest account
 395 ="</strong></a> for the service, irrespective of the supplied
 396 password.
 397 <p><br></ol>
 398 <p><br><a name="COMPLETELISTOFGLOBALPARAMETERS"></a>
 399 <h2>COMPLETE LIST OF GLOBAL PARAMETERS</h2>
 400
 401 <p><br>Here is a list of all global parameters. See the section of each
 402 parameter for details.  Note that some are synonyms.
 403 <p><br><ul>
 404 <p><br><li > <a href="smb.conf.5.html#adduserscript"><strong>add user script</strong></a>
 405 <p><br><li > <a href="smb.conf.5.html#allowtrusteddomains"><strong>allow trusted domains</strong></a>
 406 <p><br><li > <a href="smb.conf.5.html#announceas"><strong>announce as</strong></a>
 407 <p><br><li > <a href="smb.conf.5.html#announceversion"><strong>announce version</strong></a>
 408 <p><br><li > <a href="smb.conf.5.html#autoservices"><strong>auto services</strong></a>
 409 <p><br><li > <a href="smb.conf.5.html#bindinterfacesonly"><strong>bind interfaces only</strong></a>
 410 <p><br><li > <a href="smb.conf.5.html#browselist"><strong>browse list</strong></a>
 411 <p><br><li > <a href="smb.conf.5.html#changenotifytimeout"><strong>change notify timeout</strong></a>
 412 <p><br><li > <a href="smb.conf.5.html#characterset"><strong>character set</strong></a>
 413 <p><br><li > <a href="smb.conf.5.html#clientcodepage"><strong>client code page</strong></a>
 414 <p><br><li > <a href="smb.conf.5.html#codingsystem"><strong>coding system</strong></a>
 415 <p><br><li > <a href="smb.conf.5.html#configfile"><strong>config file</strong></a>
 416 <p><br><li > <a href="smb.conf.5.html#deadtime"><strong>deadtime</strong></a>
 417 <p><br><li > <a href="smb.conf.5.html#debughirestimestamp"><strong>debug hires timestamp</strong></a>
 418 <p><br><li > <a href="smb.conf.5.html#debugpid"><strong>debug pid</strong></a>
 419 <p><br><li > <a href="smb.conf.5.html#debugtimestamp"><strong>debug timestamp</strong></a>
 420 <p><br><li > <a href="smb.conf.5.html#debuguid"><strong>debug uid</strong></a>
 421 <p><br><li > <a href="smb.conf.5.html#debuglevel"><strong>debuglevel</strong></a>
 422 <p><br><li > <a href="smb.conf.5.html#default"><strong>default</strong></a>
 423 <p><br><li > <a href="smb.conf.5.html#defaultservice"><strong>default service</strong></a>
 424 <p><br><li > <a href="smb.conf.5.html#deleteuserscript"><strong>delete user script</strong></a>
 425 <p><br><li > <a href="smb.conf.5.html#dfreecommand"><strong>dfree command</strong></a>
 426 <p><br><li > <a href="smb.conf.5.html#dnsproxy"><strong>dns proxy</strong></a>
 427 <p><br><li > <a href="smb.conf.5.html#domainadmingroup"><strong>domain admin group</strong></a>
 428 <p><br><li > <a href="smb.conf.5.html#domainadminusers"><strong>domain admin users</strong></a>
 429 <p><br><li > <a href="smb.conf.5.html#domaincontroller"><strong>domain controller</strong></a>
 430 <p><br><li > <a href="smb.conf.5.html#domaingroups"><strong>domain groups</strong></a>
 431 <p><br><li > <a href="smb.conf.5.html#domainguestgroup"><strong>domain guest group</strong></a>
 432 <p><br><li > <a href="smb.conf.5.html#domainguestusers"><strong>domain guest users</strong></a>
 433 <p><br><li > <a href="smb.conf.5.html#domainlogons"><strong>domain logons</strong></a>
 434 <p><br><li > <a href="smb.conf.5.html#domainmaster"><strong>domain master</strong></a>
 435 <p><br><li > <a href="smb.conf.5.html#encryptpasswords"><strong>encrypt passwords</strong></a>
 436 <p><br><li > <a href="smb.conf.5.html#getwdcache"><strong>getwd cache</strong></a>
 437 <p><br><li > <a href="smb.conf.5.html#homedirmap"><strong>homedir map</strong></a>
 438 <p><br><li > <a href="smb.conf.5.html#hostsequiv"><strong>hosts equiv</strong></a>
 439 <p><br><li > <a href="smb.conf.5.html#interfaces"><strong>interfaces</strong></a>
 440 <p><br><li > <a href="smb.conf.5.html#keepalive"><strong>keepalive</strong></a>
 441 <p><br><li > <a href="smb.conf.5.html#kerneloplocks"><strong>kernel oplocks</strong></a>
 442 <p><br><li > <a href="smb.conf.5.html#ldapfilter"><strong>ldap filter</strong></a>
 443 <p><br><li > <a href="smb.conf.5.html#ldapport"><strong>ldap port</strong></a>
 444 <p><br><li > <a href="smb.conf.5.html#ldaproot"><strong>ldap root</strong></a>
 445 <p><br><li > <a href="smb.conf.5.html#ldaprootpasswd"><strong>ldap root passwd</strong></a>
 446 <p><br><li > <a href="smb.conf.5.html#ldapserver"><strong>ldap server</strong></a>
 447 <p><br><li > <a href="smb.conf.5.html#ldapsuffix"><strong>ldap suffix</strong></a>
 448 <p><br><li > <a href="smb.conf.5.html#lmannounce"><strong>lm announce</strong></a>
 449 <p><br><li > <a href="smb.conf.5.html#lminterval"><strong>lm interval</strong></a>
 450 <p><br><li > <a href="smb.conf.5.html#loadprinters"><strong>load printers</strong></a>
 451 <p><br><li > <a href="smb.conf.5.html#localmaster"><strong>local master</strong></a>
 452 <p><br><li > <a href="smb.conf.5.html#lockdir"><strong>lock dir</strong></a>
 453 <p><br><li > <a href="smb.conf.5.html#lockdirectory"><strong>lock directory</strong></a>
 454 <p><br><li > <a href="smb.conf.5.html#logfile"><strong>log file</strong></a>
 455 <p><br><li > <a href="smb.conf.5.html#loglevel"><strong>log level</strong></a>
 456 <p><br><li > <a href="smb.conf.5.html#logondrive"><strong>logon drive</strong></a>
 457 <p><br><li > <a href="smb.conf.5.html#logonhome"><strong>logon home</strong></a>
 458 <p><br><li > <a href="smb.conf.5.html#logonpath"><strong>logon path</strong></a>
 459 <p><br><li > <a href="smb.conf.5.html#logonscript"><strong>logon script</strong></a>
 460 <p><br><li > <a href="smb.conf.5.html#lpqcachetime"><strong>lpq cache time</strong></a>
 461 <p><br><li > <a href="smb.conf.5.html#machinepasswordtimeout"><strong>machine password timeout</strong></a>
 462 <p><br><li > <a href="smb.conf.5.html#mangledstack"><strong>mangled stack</strong></a>
 463 <p><br><li > <a href="smb.conf.5.html#maptoguest"><strong>map to guest</strong></a>
 464 <p><br><li > <a href="smb.conf.5.html#maxdisksize"><strong>max disk size</strong></a>
 465 <p><br><li > <a href="smb.conf.5.html#maxlogsize"><strong>max log size</strong></a>
 466 <p><br><li > <a href="smb.conf.5.html#maxmux"><strong>max mux</strong></a>
 467 <p><br><li > <a href="smb.conf.5.html#maxopenfiles"><strong>max open files</strong></a>
 468 <p><br><li > <a href="smb.conf.5.html#maxpacket"><strong>max packet</strong></a>
 469 <p><br><li > <a href="smb.conf.5.html#maxttl"><strong>max ttl</strong></a>
 470 <p><br><li > <a href="smb.conf.5.html#maxwinsttl"><strong>max wins ttl</strong></a>
 471 <p><br><li > <a href="smb.conf.5.html#maxxmit"><strong>max xmit</strong></a>
 472 <p><br><li > <a href="smb.conf.5.html#messagecommand"><strong>message command</strong></a>
 473 <p><br><li > <a href="smb.conf.5.html#minpasswdlength"><strong>min passwd length</strong></a>
 474 <p><br><li > <a href="smb.conf.5.html#minwinsttl"><strong>min wins ttl</strong></a>
 475 <p><br><li > <a href="smb.conf.5.html#nameresolveorder"><strong>name resolve order</strong></a>
 476 <p><br><li > <a href="smb.conf.5.html#netbiosaliases"><strong>netbios aliases</strong></a>
 477 <p><br><li > <a href="smb.conf.5.html#netbiosname"><strong>netbios name</strong></a>
 478 <p><br><li > <a href="smb.conf.5.html#nishomedir"><strong>nis homedir</strong></a>
 479 <p><br><li > <a href="smb.conf.5.html#ntaclsupport"><strong>nt acl support</strong></a>
 480 <p><br><li > <a href="smb.conf.5.html#ntpipesupport"><strong>nt pipe support</strong></a>
 481 <p><br><li > <a href="smb.conf.5.html#ntsmbsupport"><strong>nt smb support</strong></a>
 482 <p><br><li > <a href="smb.conf.5.html#nullpasswords"><strong>null passwords</strong></a>
 483 <p><br><li > <a href="smb.conf.5.html#olelockingcompatibility"><strong>ole locking compatibility</strong></a>
 484 <p><br><li > <a href="smb.conf.5.html#oplockbreakwaittime"><strong>oplock break wait time</strong></a>
 485 <p><br><li > <a href="smb.conf.5.html#oslevel"><strong>os level</strong></a>
 486 <p><br><li > <a href="smb.conf.5.html#packetsize"><strong>packet size</strong></a>
 487 <p><br><li > <a href="smb.conf.5.html#panicaction"><strong>panic action</strong></a>
 488 <p><br><li > <a href="smb.conf.5.html#passwdchat"><strong>passwd chat</strong></a>
 489 <p><br><li > <a href="smb.conf.5.html#passwdchatdebug"><strong>passwd chat debug</strong></a>
 490 <p><br><li > <a href="smb.conf.5.html#passwdprogram"><strong>passwd program</strong></a>
 491 <p><br><li > <a href="smb.conf.5.html#passwordlevel"><strong>password level</strong></a>
 492 <p><br><li > <a href="smb.conf.5.html#passwordserver"><strong>password server</strong></a>
 493 <p><br><li > <a href="smb.conf.5.html#preferedmaster"><strong>prefered master</strong></a>
 494 <p><br><li > <a href="smb.conf.5.html#preferredmaster"><strong>preferred master</strong></a>
 495 <p><br><li > <a href="smb.conf.5.html#preload"><strong>preload</strong></a>
 496 <p><br><li > <a href="smb.conf.5.html#printcap"><strong>printcap</strong></a>
 497 <p><br><li > <a href="smb.conf.5.html#printcapname"><strong>printcap name</strong></a>
 498 <p><br><li > <a href="smb.conf.5.html#printerdriverfile"><strong>printer driver file</strong></a>
 499 <p><br><li > <a href="smb.conf.5.html#protocol"><strong>protocol</strong></a>
 500 <p><br><li > <a href="smb.conf.5.html#readbmpx"><strong>read bmpx</strong></a>
 501 <p><br><li > <a href="smb.conf.5.html#readprediction"><strong>read prediction</strong></a>
 502 <p><br><li > <a href="smb.conf.5.html#readraw"><strong>read raw</strong></a>
 503 <p><br><li > <a href="smb.conf.5.html#readsize"><strong>read size</strong></a>
 504 <p><br><li > <a href="smb.conf.5.html#remoteannounce"><strong>remote announce</strong></a>
 505 <p><br><li > <a href="smb.conf.5.html#remotebrowsesync"><strong>remote browse sync</strong></a>
 506 <p><br><li > <a href="smb.conf.5.html#restrictanonymous"><strong>restrict anonymous</strong></a>
 507 <p><br><li > <a href="smb.conf.5.html#root"><strong>root</strong></a>
 508 <p><br><li > <a href="smb.conf.5.html#rootdir"><strong>root dir</strong></a>
 509 <p><br><li > <a href="smb.conf.5.html#rootdirectory"><strong>root directory</strong></a>
 510 <p><br><li > <a href="smb.conf.5.html#security"><strong>security</strong></a>
 511 <p><br><li > <a href="smb.conf.5.html#serverstring"><strong>server string</strong></a>
 512 <p><br><li > <a href="smb.conf.5.html#sharedmemsize"><strong>shared mem size</strong></a>
 513 <p><br><li > <a href="smb.conf.5.html#smbpasswdfile"><strong>smb passwd file</strong></a>
 514 <p><br><li > <a href="smb.conf.5.html#smbrun"><strong>smbrun</strong></a>
 515 <p><br><li > <a href="smb.conf.5.html#socketaddress"><strong>socket address</strong></a>
 516 <p><br><li > <a href="smb.conf.5.html#socketoptions"><strong>socket options</strong></a>
 517 <p><br><li > <a href="smb.conf.5.html#ssl"><strong>ssl</strong></a>
 518 <p><br><li > <a href="smb.conf.5.html#sslCAcertDir"><strong>ssl CA certDir</strong></a>
 519 <p><br><li > <a href="smb.conf.5.html#sslCAcertFile"><strong>ssl CA certFile</strong></a>
 520 <p><br><li > <a href="smb.conf.5.html#sslciphers"><strong>ssl ciphers</strong></a>
 521 <p><br><li > <a href="smb.conf.5.html#sslclientcert"><strong>ssl client cert</strong></a>
 522 <p><br><li > <a href="smb.conf.5.html#sslclientkey"><strong>ssl client key</strong></a>
 523 <p><br><li > <a href="smb.conf.5.html#sslcompatibility"><strong>ssl compatibility</strong></a>
 524 <p><br><li > <a href="smb.conf.5.html#sslhosts"><strong>ssl hosts</strong></a>
 525 <p><br><li > <a href="smb.conf.5.html#sslhostsresign"><strong>ssl hosts resign</strong></a>
 526 <p><br><li > <a href="smb.conf.5.html#sslrequireclientcert"><strong>ssl require clientcert</strong></a>
 527 <p><br><li > <a href="smb.conf.5.html#sslrequireservercert"><strong>ssl require servercert</strong></a>
 528 <p><br><li > <a href="smb.conf.5.html#sslservercert"><strong>ssl server cert</strong></a>
 529 <p><br><li > <a href="smb.conf.5.html#sslserverkey"><strong>ssl server key</strong></a>
 530 <p><br><li > <a href="smb.conf.5.html#sslversion"><strong>ssl version</strong></a>
 531 <p><br><li > <a href="smb.conf.5.html#statcache"><strong>stat cache</strong></a>
 532 <p><br><li > <a href="smb.conf.5.html#statcachesize"><strong>stat cache size</strong></a>
 533 <p><br><li > <a href="smb.conf.5.html#stripdot"><strong>strip dot</strong></a>
 534 <p><br><li > <a href="smb.conf.5.html#syslog"><strong>syslog</strong></a>
 535 <p><br><li > <a href="smb.conf.5.html#syslogonly"><strong>syslog only</strong></a>
 536 <p><br><li > <a href="smb.conf.5.html#timeoffset"><strong>time offset</strong></a>
 537 <p><br><li > <a href="smb.conf.5.html#timeserver"><strong>time server</strong></a>
 538 <p><br><li > <a href="smb.conf.5.html#timestamplogs"><strong>timestamp logs</strong></a>
 539 <p><br><li > <a href="smb.conf.5.html#unixpasswordsync"><strong>unix password sync</strong></a>
 540 <p><br><li > <a href="smb.conf.5.html#unixrealname"><strong>unix realname</strong></a>
 541 <p><br><li > <a href="smb.conf.5.html#updateencrypted"><strong>update encrypted</strong></a>
 542 <p><br><li > <a href="smb.conf.5.html#userhosts"><strong>use rhosts</strong></a>
 543 <p><br><li > <a href="smb.conf.5.html#usernamelevel"><strong>username level</strong></a>
 544 <p><br><li > <a href="smb.conf.5.html#usernamemap"><strong>username map</strong></a>
 545 <p><br><li > <a href="smb.conf.5.html#validchars"><strong>valid chars</strong></a>
 546 <p><br><li > <a href="smb.conf.5.html#winsproxy"><strong>wins proxy</strong></a>
 547 <p><br><li > <a href="smb.conf.5.html#winsserver"><strong>wins server</strong></a>
 548 <p><br><li > <a href="smb.conf.5.html#winshook"><strong>wins hook</strong></a>
 549 <p><br><li > <a href="smb.conf.5.html#winssupport"><strong>wins support</strong></a>
 550 <p><br><li > <a href="smb.conf.5.html#workgroup"><strong>workgroup</strong></a>
 551 <p><br><li > <a href="smb.conf.5.html#writeraw"><strong>write raw</strong></a>
 552 <p><br></ul>
 553 <p><br><a name="COMPLETELISTOFSERVICEPARAMETERS"></a>
 554 <h2>COMPLETE LIST OF SERVICE PARAMETERS</h2>
 555
 556 <p><br>Here is a list of all service parameters. See the section of each
 557 parameter for details. Note that some are synonyms.
 558 <p><br><ul>
 559 <p><br><li > <a href="smb.conf.5.html#adminusers"><strong>admin users</strong></a>
 560 <p><br><li > <a href="smb.conf.5.html#allowhosts"><strong>allow hosts</strong></a>
 561 <p><br><li > <a href="smb.conf.5.html#alternatepermissions"><strong>alternate permissions</strong></a>
 562 <p><br><li > <a href="smb.conf.5.html#available"><strong>available</strong></a>
 563 <p><br><li > <a href="smb.conf.5.html#blockinglocks"><strong>blocking locks</strong></a>
 564 <p><br><li > <a href="smb.conf.5.html#browsable"><strong>browsable</strong></a>
 565 <p><br><li > <a href="smb.conf.5.html#browseable"><strong>browseable</strong></a>
 566 <p><br><li > <a href="smb.conf.5.html#casesensitive"><strong>case sensitive</strong></a>
 567 <p><br><li > <a href="smb.conf.5.html#casesignames"><strong>casesignames</strong></a>
 568 <p><br><li > <a href="smb.conf.5.html#comment"><strong>comment</strong></a>
 569 <p><br><li > <a href="smb.conf.5.html#copy"><strong>copy</strong></a>
 570 <p><br><li > <a href="smb.conf.5.html#createmask"><strong>create mask</strong></a>
 571 <p><br><li > <a href="smb.conf.5.html#createmode"><strong>create mode</strong></a>
 572 <p><br><li > <a href="smb.conf.5.html#defaultcase"><strong>default case</strong></a>
 573 <p><br><li > <a href="smb.conf.5.html#deletereadonly"><strong>delete readonly</strong></a>
 574 <p><br><li > <a href="smb.conf.5.html#deletevetofiles"><strong>delete veto files</strong></a>
 575 <p><br><li > <a href="smb.conf.5.html#denyhosts"><strong>deny hosts</strong></a>
 576 <p><br><li > <a href="smb.conf.5.html#directory"><strong>directory</strong></a>
 577 <p><br><li > <a href="smb.conf.5.html#directorymask"><strong>directory mask</strong></a>
 578 <p><br><li > <a href="smb.conf.5.html#directorymode"><strong>directory mode</strong></a>
 579 <p><br><li > <a href="smb.conf.5.html#directorysecuritymask"><strong>directory security mask</strong></a>
 580 <p><br><li > <a href="smb.conf.5.html#dontdescend"><strong>dont descend</strong></a>
 581 <p><br><li > <a href="smb.conf.5.html#dosfiletimeresolution"><strong>dos filetime resolution</strong></a>
 582 <p><br><li > <a href="smb.conf.5.html#dosfiletimes"><strong>dos filetimes</strong></a>
 583 <p><br><li > <a href="smb.conf.5.html#exec"><strong>exec</strong></a>
 584 <p><br><li > <a href="smb.conf.5.html#fakedirectorycreatetimes"><strong>fake directory create times</strong></a>
 585 <p><br><li > <a href="smb.conf.5.html#fakeoplocks"><strong>fake oplocks</strong></a>
 586 <p><br><li > <a href="smb.conf.5.html#followsymlinks"><strong>follow symlinks</strong></a>
 587 <p><br><li > <a href="smb.conf.5.html#forcecreatemode"><strong>force create mode</strong></a>
 588 <p><br><li > <a href="smb.conf.5.html#forcedirectorymode"><strong>force directory mode</strong></a>
 589 <p><br><li > <a href="smb.conf.5.html#forcedirectorysecuritymode"><strong>force directory security mode</strong></a>
 590 <p><br><li > <a href="smb.conf.5.html#forcegroup"><strong>force group</strong></a>
 591 <p><br><li > <a href="smb.conf.5.html#forcesecuritymode"><strong>force security mode</strong></a>
 592 <p><br><li > <a href="smb.conf.5.html#forceuser"><strong>force user</strong></a>
 593 <p><br><li > <a href="smb.conf.5.html#fstype"><strong>fstype</strong></a>
 594 <p><br><li > <a href="smb.conf.5.html#group"><strong>group</strong></a>
 595 <p><br><li > <a href="smb.conf.5.html#guestaccount"><strong>guest account</strong></a>
 596 <p><br><li > <a href="smb.conf.5.html#guestok"><strong>guest ok</strong></a>
 597 <p><br><li > <a href="smb.conf.5.html#guestonly"><strong>guest only</strong></a>
 598 <p><br><li > <a href="smb.conf.5.html#hidedotfiles"><strong>hide dot files</strong></a>
 599 <p><br><li > <a href="smb.conf.5.html#hidefiles"><strong>hide files</strong></a>
 600 <p><br><li > <a href="smb.conf.5.html#hostsallow"><strong>hosts allow</strong></a>
 601 <p><br><li > <a href="smb.conf.5.html#hostsdeny"><strong>hosts deny</strong></a>
 602 <p><br><li > <a href="smb.conf.5.html#include"><strong>include</strong></a>
 603 <p><br><li > <a href="smb.conf.5.html#invalidusers"><strong>invalid users</strong></a>
 604 <p><br><li > <a href="smb.conf.5.html#level2oplocks"><strong>level2 oplocks</strong></a>
 605 <p><br><li > <a href="smb.conf.5.html#locking"><strong>locking</strong></a>
 606 <p><br><li > <a href="smb.conf.5.html#lppausecommand"><strong>lppause command</strong></a>
 607 <p><br><li > <a href="smb.conf.5.html#lpqcommand"><strong>lpq command</strong></a>
 608 <p><br><li > <a href="smb.conf.5.html#lpresumecommand"><strong>lpresume command</strong></a>
 609 <p><br><li > <a href="smb.conf.5.html#lprmcommand"><strong>lprm command</strong></a>
 610 <p><br><li > <a href="smb.conf.5.html#magicoutput"><strong>magic output</strong></a>
 611 <p><br><li > <a href="smb.conf.5.html#magicscript"><strong>magic script</strong></a>
 612 <p><br><li > <a href="smb.conf.5.html#manglecase"><strong>mangle case</strong></a>
 613 <p><br><li > <a href="smb.conf.5.html#manglelocks"><strong>mangle locks</strong></a>
 614 <p><br><li > <a href="smb.conf.5.html#mangledmap"><strong>mangled map</strong></a>
 615 <p><br><li > <a href="smb.conf.5.html#manglednames"><strong>mangled names</strong></a>
 616 <p><br><li > <a href="smb.conf.5.html#manglingchar"><strong>mangling char</strong></a>
 617 <p><br><li > <a href="smb.conf.5.html#maparchive"><strong>map archive</strong></a>
 618 <p><br><li > <a href="smb.conf.5.html#maphidden"><strong>map hidden</strong></a>
 619 <p><br><li > <a href="smb.conf.5.html#mapsystem"><strong>map system</strong></a>
 620 <p><br><li > <a href="smb.conf.5.html#maxconnections"><strong>max connections</strong></a>
 621 <p><br><li > <a href="smb.conf.5.html#minprintspace"><strong>min print space</strong></a>
 622 <p><br><li > <a href="smb.conf.5.html#onlyguest"><strong>only guest</strong></a>
 623 <p><br><li > <a href="smb.conf.5.html#onlyuser"><strong>only user</strong></a>
 624 <p><br><li > <a href="smb.conf.5.html#oplocks"><strong>oplocks</strong></a>
 625 <p><br><li > <a href="smb.conf.5.html#oplockcontentionlimit"><strong>oplock contention limit</strong></a>
 626 <p><br><li > <a href="smb.conf.5.html#path"><strong>path</strong></a>
 627 <p><br><li > <a href="smb.conf.5.html#postexec"><strong>postexec</strong></a>
 628 <p><br><li > <a href="smb.conf.5.html#postscript"><strong>postscript</strong></a>
 629 <p><br><li > <a href="smb.conf.5.html#preexec"><strong>preexec</strong></a>
 630 <p><br><li > <a href="smb.conf.5.html#preexecclose"><strong>preexec close</strong></a>
 631 <p><br><li > <a href="smb.conf.5.html#preservecase"><strong>preserve case</strong></a>
 632 <p><br><li > <a href="smb.conf.5.html#printcommand"><strong>print command</strong></a>
 633 <p><br><li > <a href="smb.conf.5.html#printok"><strong>print ok</strong></a>
 634 <p><br><li > <a href="smb.conf.5.html#printable"><strong>printable</strong></a>
 635 <p><br><li > <a href="smb.conf.5.html#printer"><strong>printer</strong></a>
 636 <p><br><li > <a href="smb.conf.5.html#printerdriver"><strong>printer driver</strong></a>
 637 <p><br><li > <a href="smb.conf.5.html#printerdriverlocation"><strong>printer driver location</strong></a>
 638 <p><br><li > <a href="smb.conf.5.html#printername"><strong>printer name</strong></a>
 639 <p><br><li > <a href="smb.conf.5.html#printing"><strong>printing</strong></a>
 640 <p><br><li > <a href="smb.conf.5.html#public"><strong>public</strong></a>
 641 <p><br><li > <a href="smb.conf.5.html#queuepausecommand"><strong>queuepause command</strong></a>
 642 <p><br><li > <a href="smb.conf.5.html#queueresumecommand"><strong>queueresume command</strong></a>
 643 <p><br><li > <a href="smb.conf.5.html#readlist"><strong>read list</strong></a>
 644 <p><br><li > <a href="smb.conf.5.html#readonly"><strong>read only</strong></a>
 645 <p><br><li > <a href="smb.conf.5.html#revalidate"><strong>revalidate</strong></a>
 646 <p><br><li > <a href="smb.conf.5.html#rootpostexec"><strong>root postexec</strong></a>
 647 <p><br><li > <a href="smb.conf.5.html#rootpreexec"><strong>root preexec</strong></a>
 648 <p><br><li > <a href="smb.conf.5.html#securitymask"><strong>security mask</strong></a>
 649 <p><br><li > <a href="smb.conf.5.html#rootpreexecclose"><strong>root preexec close</strong></a>
 650 <p><br><li > <a href="smb.conf.5.html#setdirectory"><strong>set directory</strong></a>
 651 <p><br><li > <a href="smb.conf.5.html#sharemodes"><strong>share modes</strong></a>
 652 <p><br><li > <a href="smb.conf.5.html#shortpreservecase"><strong>short preserve case</strong></a>
 653 <p><br><li > <a href="smb.conf.5.html#status"><strong>status</strong></a>
 654 <p><br><li > <a href="smb.conf.5.html#strictlocking"><strong>strict locking</strong></a>
 655 <p><br><li > <a href="smb.conf.5.html#strictsync"><strong>strict sync</strong></a>
 656 <p><br><li > <a href="smb.conf.5.html#syncalways"><strong>sync always</strong></a>
 657 <p><br><li > <a href="smb.conf.5.html#user"><strong>user</strong></a>
 658 <p><br><li > <a href="smb.conf.5.html#username"><strong>username</strong></a>
 659 <p><br><li > <a href="smb.conf.5.html#users"><strong>users</strong></a>
 660 <p><br><li > <a href="smb.conf.5.html#validusers"><strong>valid users</strong></a>
 661 <p><br><li > <a href="smb.conf.5.html#vetofiles"><strong>veto files</strong></a>
 662 <p><br><li > <a href="smb.conf.5.html#vetooplockfiles"><strong>veto oplock files</strong></a>
 663 <p><br><li > <a href="smb.conf.5.html#volume"><strong>volume</strong></a>
 664 <p><br><li > <a href="smb.conf.5.html#widelinks"><strong>wide links</strong></a>
 665 <p><br><li > <a href="smb.conf.5.html#writable"><strong>writable</strong></a>
 666 <p><br><li > <a href="smb.conf.5.html#writelist"><strong>write list</strong></a>
 667 <p><br><li > <a href="smb.conf.5.html#writeok"><strong>write ok</strong></a>
 668 <p><br><li > <a href="smb.conf.5.html#writeable"><strong>writeable</strong></a>
 669 <p><br></ul>
 670 <p><br><a name="EXPLANATIONOFEACHPARAMETER"></a>
 671 <h2>EXPLANATION OF EACH PARAMETER</h2>
 672
 673 <p><br><ul>
 674 <p><br><a name="adduserscript"></a>
 675 <li><strong><strong>add user script (G)</strong></strong>
 676 <p><br>This is the full pathname to a script that will be run <em>AS ROOT</em> by
 677 <a href="smbd.8.html"><strong>smbd (8)</strong></a> under special circumstances decribed
 678 below.
 679 <p><br>Normally, a Samba server requires that UNIX users are created for all
 680 users accessing files on this server. For sites that use Windows NT
 681 account databases as their primary user database creating these users
 682 and keeping the user list in sync with the Windows NT PDC is an
 683 onerous task. This option allows <a href="smbd.8.html"><strong>smbd</strong></a> to create
 684 the required UNIX users <em>ON DEMAND</em> when a user accesses the Samba
 685 server.
 686 <p><br>In order to use this option, <a href="smbd.8.html"><strong>smbd</strong></a> must be set to
 687 <a href="smb.conf.5.html#securityequalserver"><strong>security=server</strong></a> or
 688 <a href="smb.conf.5.html#securityequaldomain"><strong>security=domain</strong></a> and <strong>"add user script"</strong>
 689 must be set to a full pathname for a script that will create a UNIX user
 690 given one argument of <strong>%u</strong>, which expands into the UNIX user name to
 691 create.
 692 <p><br>When the Windows user attempts to access the Samba server, at
 693 <em>"login"</em>(session setup in the SMB protocol) time,
 694 <a href="smbd.8.html"><strong>smbd</strong></a> contacts the <a href="smb.conf.5.html#passwordserver"><strong>password
 695 server</strong></a> and attempts to authenticate the given user
 696 with the given password. If the authentication succeeds then
 697 <a href="smbd.8.html"><strong>smbd</strong></a> attempts to find a UNIX user in the UNIX
 698 password database to map the Windows user into. If this lookup fails,
 699 and <strong>"add user script"</strong> is set then <a href="smbd.8.html"><strong>smbd</strong></a> will
 700 call the specified script <em>AS ROOT</em>, expanding any <strong>%u</strong> argument
 701 to be the user name to create.
 702 <p><br>If this script successfully creates the user then
 703 <a href="smbd.8.html"><strong>smbd</strong></a> will continue on as though the UNIX user
 704 already existed. In this way, UNIX users are dynamically created to
 705 match existing Windows NT accounts.
 706 <p><br>See also <a href="smb.conf.5.html#securityequalserver"><strong>security=server</strong></a>,
 707 <a href="smb.conf.5.html#securityequaldomain"><strong>security=domain</strong></a>, <a href="smb.conf.5.html#passwordserver"><strong>password
 708 server</strong></a>, <a href="smb.conf.5.html#deleteuserscript"><strong>delete user
 709 script</strong></a>.
 710 <p><br><strong>Default:</strong>
 711 <code>  add user script = &lt;empty string&gt;</code>
 712 <p><br><strong>Example:</strong>
 713 <code>  add user script = /usr/local/samba/bin/add_user %u</code>
 714 <p><br><a name="adminusers"></a>
 715 <li><strong><strong>admin users (S)</strong></strong>
 716 <p><br>This is a list of users who will be granted administrative privileges
 717 on the share. This means that they will do all file operations as the
 718 super-user (root).
 719 <p><br>You should use this option very carefully, as any user in this list
 720 will be able to do anything they like on the share, irrespective of
 721 file permissions.
 722 <p><br><strong>Default:</strong> <br>
 723 <code>  no admin users</code>
 724 <p><br><strong>Example:</strong> <br>
 725 <code>  admin users = jason</code>
 726 <p><br><a name="allowhosts"></a>
 727 <li><strong><strong>allow hosts (S)</strong></strong>
 728 <p><br>Synonym for <a href="smb.conf.5.html#hostsallow"><strong>hosts allow</strong></a>.
 729 <p><br><a name="allowtrusteddomains"></a>
 730 <li><strong><strong>allow trusted domains (G)</strong></strong>
 731 <p><br>This option only takes effect when the <a href="smb.conf.5.html#security"><strong>security</strong></a>
 732 option is set to <strong>server</strong> or <strong>domain</strong>.  If it is set to no,
 733 then attempts to connect to a resource from a domain or workgroup other than
 734 the one which smbd is running in will fail, even if that domain
 735 is trusted by the remote server doing the authentication.
 736 <p><br>This is useful if you only want your Samba server to serve resources
 737 to users in the domain it is a member of. As an example, suppose that there are
 738 two domains DOMA and DOMB.  DOMB is trusted by DOMA, which contains
 739 the Samba server.  Under normal circumstances, a user with an account
 740 in DOMB can then access the resources of a UNIX account with the same
 741 account name on the Samba server even if they do not have an account
 742 in DOMA.  This can make implementing a security boundary difficult.
 743 <p><br><strong>Default:</strong>
 744 <code>     allow trusted domains = Yes</code>
 745 <p><br><strong>Example:</strong>
 746 <code>     allow trusted domains = No</code>
 747 <p><br><a name="alternatepermissions"></a>
 748 <li><strong><strong>alternate permissions (S)</strong></strong>
 749 <p><br>This is a deprecated parameter. It no longer has any effect in Samba2.0.
 750 In previous versions of Samba it affected the way the DOS "read only"
 751 attribute was mapped for a file. In Samba2.0 a file is marked "read only"
 752 if the UNIX file does not have the 'w' bit set for the owner of the file,
 753 regardless if the owner of the file is the currently logged on user or not.
 754 <p><br><a name="announceas"></a>
 755 <li><strong><strong>announce as (G)</strong></strong>
 756 <p><br>This specifies what type of server <a href="nmbd.8.html"><strong>nmbd</strong></a> will
 757 announce itself as, to a network neighborhood browse list. By default
 758 this is set to Windows NT. The valid options are : "NT", which is a
 759 synonym for "NT Server", "NT Server", "NT Workstation", "Win95" or
 760 "WfW" meaning Windows NT Server, Windows NT Workstation, Windows 95
 761 and Windows for Workgroups respectively. Do not change this parameter
 762 unless you have a specific need to stop Samba appearing as an NT server
 763 as this may prevent Samba servers from participating as browser servers correctly.
 764 <p><br><strong>Default:</strong>
 765 <code>  announce as = NT Server</code>
 766 <p><br><strong>Example</strong>
 767 <code>  announce as = Win95</code>
 768 <p><br><a name="announceversion"></a>
 769 <li><strong><strong>announce version (G)</strong></strong>
 770 <p><br>This specifies the major and minor version numbers that nmbd will use
 771 when announcing itself as a server. The default is 4.2.  Do not change
 772 this parameter unless you have a specific need to set a Samba server
 773 to be a downlevel server.
 774 <p><br><strong>Default:</strong>
 775 <code>  announce version = 4.2</code>
 776 <p><br><strong>Example:</strong>
 777 <code>  announce version = 2.0</code>
 778 <p><br><a name="autoservices"></a>
 779 <li><strong><strong>auto services (G)</strong></strong>
 780 <p><br>This is a list of services that you want to be automatically added to
 781 the browse lists. This is most useful for homes and printers services
 782 that would otherwise not be visible.
 783 <p><br>Note that if you just want all printers in your printcap file loaded
 784 then the <a href="smb.conf.5.html#loadprinters"><strong>"load printers"</strong></a> option is easier.
 785 <p><br><strong>Default:</strong>
 786 <code>  no auto services</code>
 787 <p><br><strong>Example:</strong>
 788 <code>  auto services = fred lp colorlp</code>
 789 <p><br><a name="available"></a>
 790 <li><strong><strong>available (S)</strong></strong>
 791 <p><br>This parameter lets you <em>'turn off'</em> a service. If <code>'available = no'</code>,
 792 then <em>ALL</em> attempts to connect to the service will fail. Such failures
 793 are logged.
 794 <p><br><strong>Default:</strong>
 795 <code>  available = yes</code>
 796 <p><br><strong>Example:</strong>
 797 <code>  available = no</code>
 798 <p><br><a name="bindinterfacesonly"></a>
 799 <li><strong><strong>bind interfaces only (G)</strong></strong>
 800 <p><br>This global parameter allows the Samba admin to limit what interfaces
 801 on a machine will serve smb requests. If affects file service
 802 <a href="smbd.8.html"><strong>smbd</strong></a> and name service <a href="nmbd.8.html"><strong>nmbd</strong></a>
 803 in slightly different ways.
 804 <p><br>For name service it causes <a href="nmbd.8.html"><strong>nmbd</strong></a> to bind to ports
 805 137 and 138 on the interfaces listed in the
 806 <a href="smb.conf.5.html#interfaces"><strong>'interfaces'</strong></a>
 807 parameter. <a href="nmbd.8.html"><strong>nmbd</strong></a> also binds to the 'all
 808 addresses' interface (0.0.0.0) on ports 137 and 138 for the purposes
 809 of reading broadcast messages. If this option is not set then
 810 <a href="nmbd.8.html"><strong>nmbd</strong></a> will service name requests on all of these
 811 sockets. If <strong>"bind interfaces only"</strong> is set then
 812 <a href="nmbd.8.html"><strong>nmbd</strong></a> will check the source address of any
 813 packets coming in on the broadcast sockets and discard any that don't
 814 match the broadcast addresses of the interfaces in the
 815 <a href="smb.conf.5.html#interfaces"><strong>'interfaces'</strong></a> parameter list. As unicast packets
 816 are received on the other sockets it allows <a href="nmbd.8.html"><strong>nmbd</strong></a>
 817 to refuse to serve names to machines that send packets that arrive
 818 through any interfaces not listed in the
 819 <a href="smb.conf.5.html#interfaces"><strong>"interfaces"</strong></a> list.  IP Source address spoofing
 820 does defeat this simple check, however so it must not be used
 821 seriously as a security feature for <a href="nmbd.8.html"><strong>nmbd</strong></a>.
 822 <p><br>For file service it causes <a href="smbd.8.html"><strong>smbd</strong></a> to bind only to
 823 the interface list given in the <a href="smb.conf.5.html#interfaces"><strong>'interfaces'</strong></a>
 824 parameter. This restricts the networks that <a href="smbd.8.html"><strong>smbd</strong></a>
 825 will serve to packets coming in those interfaces.  Note that you
 826 should not use this parameter for machines that are serving PPP or
 827 other intermittent or non-broadcast network interfaces as it will not
 828 cope with non-permanent interfaces.
 829 <p><br>If <strong>"bind interfaces only"</strong> is set then unless the network address
 830 <em>127.0.0.1</em> is added to the <a href="smb.conf.5.html#interfaces"><strong>'interfaces'</strong></a> parameter
 831 list <a href="smbpasswd.8.html"><strong>smbpasswd</strong></a> and
 832 <a href="swat.8.html"><strong>swat</strong></a> may not work as expected due to the
 833 reasons covered below.
 834 <p><br>To change a users SMB password, the <a href="smbpasswd.8.html"><strong>smbpasswd</strong></a>
 835 by default connects to the <em>"localhost" - 127.0.0.1</em> address as an SMB
 836 client to issue the password change request. If <strong>"bind interfaces only"</strong>
 837 is set then unless the network address <em>127.0.0.1</em> is added to the
 838 <a href="smb.conf.5.html#interfaces"><strong>'interfaces'</strong></a> parameter list then
 839 <a href="smbpasswd.8.html"><strong>smbpasswd</strong></a> will fail to connect in it's
 840 default mode. <a href="smbpasswd.8.html"><strong>smbpasswd</strong></a> can be forced to
 841 use the primary IP interface of the local host by using its
 842 <a href="smbpasswd.8.html#minusr"><strong>"-r remote machine"</strong></a> parameter, with
 843 <strong>"remote machine"</strong> set to the IP name of the primary interface
 844 of the local host.
 845 <p><br>The <a href="swat.8.html"><strong>swat</strong></a> status page tries to connect with
 846 <a href="smbd.8.html"><strong>smbd</strong></a> and <a href="nmbd.8.html"><strong>nmbd</strong></a> at the address
 847 <em>127.0.0.1</em> to determine if they are running.  Not adding <em>127.0.0.1</em>  will cause
 848 <a href="smbd.8.html"><strong>smbd</strong></a> and <a href="nmbd.8.html"><strong>nmbd</strong></a> to always show
 849 "not running" even if they really are.  This can prevent
 850 <a href="swat.8.html"><strong>swat</strong></a> from starting/stopping/restarting
 851 <a href="smbd.8.html"><strong>smbd</strong></a> and <a href="nmbd.8.html"><strong>nmbd</strong></a>.
 852 <p><br><strong>Default:</strong>
 853 <code>  bind interfaces only = False</code>
 854 <p><br><strong>Example:</strong>
 855 <code>  bind interfaces only = True</code>
 856 <p><br><a name="blockinglocks"></a>
 857 <li><strong><strong>blocking locks (S)</strong></strong>
 858 <p><br>This parameter controls the behavior of <a href="smbd.8.html"><strong>smbd</strong></a> when
 859 given a request by a client to obtain a byte range lock on a region
 860 of an open file, and the request has a time limit associated with it.
 861 <p><br>If this parameter is set and the lock range requested cannot be
 862 immediately satisfied, Samba 2.0 will internally queue the lock
 863 request, and periodically attempt to obtain the lock until the
 864 timeout period expires.
 865 <p><br>If this parameter is set to "False", then Samba 2.0 will behave
 866 as previous versions of Samba would and will fail the lock
 867 request immediately if the lock range cannot be obtained.
 868 <p><br>This parameter can be set per share.
 869 <p><br><strong>Default:</strong>
 870 <code>  blocking locks = True</code>
 871 <p><br><strong>Example:</strong>
 872 <code>  blocking locks = False</code>
 873 <p><br><a name="browsable"></a>
 874 <li><strong><strong>browsable (S)</strong></strong>
 875 <p><br>Synonym for <a href="smb.conf.5.html#browseable"><strong>browseable</strong></a>.
 876 <p><br><a name="browselist"></a>
 877 <li><strong><strong>browse list(G)</strong></strong>
 878 <p><br>This controls whether <a href="smbd.8.html"><strong>smbd</strong></a> will serve a browse
 879 list to a client doing a NetServerEnum call. Normally set to true. You
 880 should never need to change this.
 881 <p><br><strong>Default:</strong>
 882 <code>  browse list = Yes</code>
 883 <p><br><a name="browseable"></a>
 884 <li><strong><strong>browseable</strong></strong>
 885 <p><br>This controls whether this share is seen in the list of available
 886 shares in a net view and in the browse list.
 887 <p><br><strong>Default:</strong>
 888 <code>  browseable = Yes</code>
 889 <p><br><strong>Example:</strong>
 890 <code>  browseable = No</code>
 891 <p><br><a name="casesensitive"></a>
 892 <li><strong><strong>case sensitive (G)</strong></strong>
 893 <p><br>See the discussion in the section <a href="smb.conf.5.html#NAMEMANGLING"><strong>NAME MANGLING</strong></a>.
 894 <p><br><a name="casesignames"></a>
 895 <li><strong><strong>casesignames (G)</strong></strong>
 896 <p><br>Synonym for <a href="smb.conf.5.html#casesensitive"><strong>"case sensitive"</strong></a>.
 897 <p><br><a name="changenotifytimeout"></a>
 898 <li><strong><strong>change notify timeout (G)</strong></strong>
 899 <p><br>One of the new NT SMB requests that Samba 2.0 supports is the
 900 "ChangeNotify" requests. This SMB allows a client to tell a server to
 901 <em>"watch"</em> a particular directory for any changes and only reply to
 902 the SMB request when a change has occurred. Such constant scanning of
 903 a directory is expensive under UNIX, hence an
 904 <a href="smbd.8.html"><strong>smbd</strong></a> daemon only performs such a scan on each
 905 requested directory once every <strong>change notify timeout</strong> seconds.
 906 <p><br><strong>change notify timeout</strong> is specified in units of seconds.
 907 <p><br><strong>Default:</strong>
 908 <code>  change notify timeout = 60</code>
 909 <p><br><strong>Example:</strong>
 910 <code>  change notify timeout = 300</code>
 911 <p><br>Would change the scan time to every 5 minutes.
 912 <p><br><a name="characterset"></a>
 913 <li><strong><strong>character set (G)</strong></strong>
 914 <p><br>This allows a smbd to map incoming filenames from a DOS Code page (see
 915 the <a href="smb.conf.5.html#clientcodepage"><strong>client code page</strong></a> parameter) to several
 916 built in UNIX character sets. The built in code page translations are:
 917 <p><br><ul>
 918 <p><br><li > <strong>ISO8859-1</strong> Western European UNIX character set. The parameter
 919 <a href="smb.conf.5.html#clientcodepage"><strong>client code page</strong></a> <em>MUST</em> be set to code
 920 page 850 if the <strong>character set</strong> parameter is set to iso8859-1
 921 in order for the conversion to the UNIX character set to be done
 922 correctly.
 923 <p><br><li > <strong>ISO8859-2</strong> Eastern European UNIX character set. The parameter
 924 <a href="smb.conf.5.html#clientcodepage"><strong>client code page</strong></a> <em>MUST</em> be set to code
 925 page 852 if the <strong>character set</strong> parameter is set to ISO8859-2
 926 in order for the conversion to the UNIX character set to be done
 927 correctly.
 928 <p><br><li > <strong>ISO8859-5</strong> Russian Cyrillic UNIX character set. The parameter
 929 <a href="smb.conf.5.html#clientcodepage"><strong>client code page</strong></a> <em>MUST</em> be set to code
 930 page 866 if the <strong>character set</strong> parameter is set to ISO8859-5
 931 in order for the conversion to the UNIX character set to be done
 932 correctly.
 933 <p><br><li > <strong>ISO8859-7</strong> Greek UNIX character set. The parameter
 934 <a href="smb.conf.5.html#clientcodepage"><strong>client code page</strong></a> <em>MUST</em> be set to code
 935 page 737 if the <strong>character set</strong> parameter is set to ISO8859-7
 936 in order for the conversion to the UNIX character set to be done
 937 correctly.
 938 <p><br><li > <strong>KOI8-R</strong> Alternate mapping for Russian Cyrillic UNIX
 939 character set. The parameter <a href="smb.conf.5.html#clientcodepage"><strong>client code
 940 page</strong></a> <em>MUST</em> be set to code page 866 if the
 941 <strong>character set</strong> parameter is set to KOI8-R in order for the
 942 conversion to the UNIX character set to be done correctly.
 943 <p><br></ul>
 944 <p><br><em>BUG</em>. These MSDOS code page to UNIX character set mappings should
 945 be dynamic, like the loading of MS DOS code pages, not static.
 946 <p><br>See also <a href="smb.conf.5.html#clientcodepage"><strong>client code page</strong></a>.  Normally this
 947 parameter is not set, meaning no filename translation is done.
 948 <p><br><strong>Default:</strong>
 949 <code>  character set = &lt;empty string&gt;</code>
 950 <p><br><strong>Example:</strong>
 951 <code>  character set = ISO8859-1</code>
 952 <p><br><a name="clientcodepage"></a>
 953 <li><strong><strong>client code page (G)</strong></strong>
 954 <p><br>This parameter specifies the DOS code page that the clients accessing
 955 Samba are using. To determine what code page a Windows or DOS client
 956 is using, open a DOS command prompt and type the command "chcp". This
 957 will output the code page. The default for USA MS-DOS, Windows 95, and
 958 Windows NT releases is code page 437. The default for western european
 959 releases of the above operating systems is code page 850.
 960 <p><br>This parameter tells <a href="smbd.8.html"><strong>smbd</strong></a> which of the
 961 <code>codepage.XXX</code> files to dynamically load on startup. These files,
 962 described more fully in the manual page <a href="make_smbcodepage.1.html"><strong>make_smbcodepage
 963 (1)</strong></a>, tell <a href="smbd.8.html"><strong>smbd</strong></a> how
 964 to map lower to upper case characters to provide the case insensitivity
 965 of filenames that Windows clients expect.
 966 <p><br>Samba currently ships with the following code page files :
 967 <p><br><ul>
 968 <p><br><li > <strong>Code Page 437 - MS-DOS Latin US</strong>
 969 <p><br><li > <strong>Code Page 737 - Windows '95 Greek</strong>
 970 <p><br><li > <strong>Code Page 850 - MS-DOS Latin 1</strong>
 971 <p><br><li > <strong>Code Page 852 - MS-DOS Latin 2</strong>
 972 <p><br><li > <strong>Code Page 861 - MS-DOS Icelandic</strong>
 973 <p><br><li > <strong>Code Page 866 - MS-DOS Cyrillic</strong>
 974 <p><br><li > <strong>Code Page 932 - MS-DOS Japanese SJIS</strong>
 975 <p><br><li > <strong>Code Page 936 - MS-DOS Simplified Chinese</strong>
 976 <p><br><li > <strong>Code Page 949 - MS-DOS Korean Hangul</strong>
 977 <p><br><li > <strong>Code Page 950 - MS-DOS Traditional Chinese</strong>
 978 <p><br></ul>
 979 <p><br>Thus this parameter may have any of the values 437, 737, 850, 852,
 980 861, 932, 936, 949, or 950.  If you don't find the codepage you need,
 981 read the comments in one of the other codepage files and the
 982 <a href="make_smbcodepage.1.html"><strong>make_smbcodepage (1)</strong></a> man page and
 983 write one. Please remember to donate it back to the Samba user
 984 community.
 985 <p><br>This parameter co-operates with the <a href="smb.conf.5.html#validchars"><strong>"valid
 986 chars"</strong></a> parameter in determining what characters are
 987 valid in filenames and how capitalization is done. If you set both
 988 this parameter and the <a href="smb.conf.5.html#validchars"><strong>"valid chars"</strong></a> parameter
 989 the <strong>"client code page"</strong> parameter <em>MUST</em> be set before the
 990 <a href="smb.conf.5.html#validchars"><strong>"valid chars"</strong></a> parameter in the <strong>smb.conf</strong>
 991 file. The <a href="smb.conf.5.html#validchars"><strong>"valid chars"</strong></a> string will then augment
 992 the character settings in the "client code page" parameter.
 993 <p><br>If not set, <strong>"client code page"</strong> defaults to 850.
 994 <p><br>See also : <a href="smb.conf.5.html#validchars"><strong>"valid chars"</strong></a>
 995 <p><br><strong>Default:</strong>
 996 <code>  client code page = 850</code>
 997 <p><br><strong>Example:</strong>
 998 <code>  client code page = 936</code>
 999 <p><br><a name="codingsystem"></a>
1000 <li><strong><strong>codingsystem (G)</strong></strong>
1001 <p><br>This parameter is used to determine how incoming Shift-JIS Japanese
1002 characters are mapped from the incoming <a href="smb.conf.5.html#clientcodepage"><strong>"client code
1003 page"</strong></a> used by the client, into file names in the
1004 UNIX filesystem. Only useful if <a href="smb.conf.5.html#clientcodepage"><strong>"client code
1005 page"</strong></a> is set to 932 (Japanese Shift-JIS).
1006 <p><br>The options are :
1007 <p><br><ul>
1008 <p><br><li > <strong>SJIS</strong>  Shift-JIS. Does no conversion of the incoming filename.
1009 <p><br><li > <strong>JIS8, J8BB, J8BH, J8@B, J8@J, J8@H </strong> Convert from incoming
1010 Shift-JIS to eight bit JIS code with different shift-in, shift out
1011 codes.
1012 <p><br><li > <strong>JIS7, J7BB, J7BH, J7@B, J7@J, J7@H </strong> Convert from incoming
1013 Shift-JIS to seven bit JIS code with different shift-in, shift out
1014 codes.
1015 <p><br><li > <strong>JUNET, JUBB, JUBH, JU@B, JU@J, JU@H </strong> Convert from incoming
1016 Shift-JIS to JUNET code with different shift-in, shift out codes.
1017 <p><br><li > <strong>EUC</strong>  Convert an incoming Shift-JIS character to EUC code.
1018 <p><br><li > <strong>HEX</strong> Convert an incoming Shift-JIS character to a 3 byte hex
1019 representation, i.e. <code>:AB</code>.
1020 <p><br><li > <strong>CAP</strong> Convert an incoming Shift-JIS character to the 3 byte hex
1021 representation used by the Columbia AppleTalk Program (CAP),
1022 i.e. <code>:AB</code>.  This is used for compatibility between Samba and CAP.
1023 <p><br></ul>
1024 <p><br><a name="comment"></a>
1025 <li><strong><strong>comment (S)</strong></strong>
1026 <p><br>This is a text field that is seen next to a share when a client does a
1027 queries the server, either via the network neighborhood or via "net
1028 view" to list what shares are available.
1029 <p><br>If you want to set the string that is displayed next to the machine
1030 name then see the server string command.
1031 <p><br><strong>Default:</strong>
1032 <code>  No comment string</code>
1033 <p><br><strong>Example:</strong>
1034 <code>  comment = Fred's Files</code>
1035 <p><br><a name="configfile"></a>
1036 <li><strong><strong>config file (G)</strong></strong>
1037 <p><br>This allows you to override the config file to use, instead of the
1038 default (usually <strong>smb.conf</strong>). There is a chicken and egg problem
1039 here as this option is set in the config file!
1040 <p><br>For this reason, if the name of the config file has changed when the
1041 parameters are loaded then it will reload them from the new config
1042 file.
1043 <p><br>This option takes the usual substitutions, which can be very useful.
1044 <p><br>If the config file doesn't exist then it won't be loaded (allowing you
1045 to special case the config files of just a few clients).
1046 <p><br><strong>Example:</strong>
1047 <code>  config file = /usr/local/samba/lib/smb.conf.%m</code>
1048 <p><br><a name="copy"></a>
1049 <li><strong><strong>copy (S)</strong></strong>
1050 <p><br>This parameter allows you to <em>'clone'</em> service entries. The specified
1051 service is simply duplicated under the current service's name. Any
1052 parameters specified in the current section will override those in the
1053 section being copied.
1054 <p><br>This feature lets you set up a 'template' service and create similar
1055 services easily. Note that the service being copied must occur earlier
1056 in the configuration file than the service doing the copying.
1057 <p><br><strong>Default:</strong>
1058 <code>  none</code>
1059 <p><br><strong>Example:</strong>
1060 <code>  copy = otherservice</code>
1061 <p><br><a name="createmask"></a>
1062 <li><strong><strong>create mask (S)</strong></strong>
1063 <p><br>A synonym for this parameter is <a href="smb.conf.5.html#createmode"><strong>'create mode'</strong></a>.
1064 <p><br>When a file is created, the necessary permissions are calculated
1065 according to the mapping from DOS modes to UNIX permissions, and the
1066 resulting UNIX mode is then bit-wise 'AND'ed with this parameter.
1067 This parameter may be thought of as a bit-wise MASK for the UNIX modes
1068 of a file. Any bit <em>*not*</em> set here will be removed from the modes set
1069 on a file when it is created.
1070 <p><br>The default value of this parameter removes the 'group' and 'other'
1071 write and execute bits from the UNIX modes.
1072 <p><br>Following this Samba will bit-wise 'OR' the UNIX mode created from
1073 this parameter with the value of the "force create mode" parameter
1074 which is set to 000 by default.
1075 <p><br>This parameter does not affect directory modes. See the parameter
1076 <a href="smb.conf.5.html#directorymode"><strong>'directory mode'</strong></a> for details.
1077 <p><br>See also the <a href="smb.conf.5.html#forcecreatemode"><strong>"force create mode"</strong></a> parameter
1078 for forcing particular mode bits to be set on created files. See also
1079 the <a href="smb.conf.5.html#directorymode"><strong>"directory mode"</strong></a> parameter for masking
1080 mode bits on created directories.
1081 <p><br><strong>Default:</strong>
1082 <code>  create mask = 0744</code>
1083 <p><br><strong>Example:</strong>
1084 <code>  create mask = 0775</code>
1085 <p><br><a name="createmode"></a>
1086 <li><strong><strong>create mode (S)</strong></strong>
1087 <p><br>This is a synonym for <a href="smb.conf.5.html#createmask"><strong>create mask</strong></a>.
1088 <p><br><a name="deadtime"></a>
1089 <li><strong><strong>deadtime (G)</strong></strong>
1090 <p><br>The value of the parameter (a decimal integer) represents the number
1091 of minutes of inactivity before a connection is considered dead, and
1092 it is disconnected. The deadtime only takes effect if the number of
1093 open files is zero.
1094 <p><br>This is useful to stop a server's resources being exhausted by a large
1095 number of inactive connections.
1096 <p><br>Most clients have an auto-reconnect feature when a connection is
1097 broken so in most cases this parameter should be transparent to users.
1098 <p><br>Using this parameter with a timeout of a few minutes is recommended
1099 for most systems.
1100 <p><br>A deadtime of zero indicates that no auto-disconnection should be
1101 performed.
1102 <p><br><strong>Default:</strong>
1103 <code>  deadtime = 0</code>
1104 <p><br><strong>Example:</strong>
1105 <code>  deadtime = 15</code>
1106 <p><br><a name="debughirestimestamp"></a>
1107 <li><strong><strong>debug hires timestamp (G)</strong></strong>
1108 <p><br>Sometimes the timestamps in the log messages are needed with a
1109 resolution of higher that seconds, this boolean parameter adds
1110 microsecond resolution to the timestamp message header when turned on.
1111 <p><br>Note that the parameter <a href="smb.conf.5.html#debugtimestamp"><strong>debug timestamp</strong></a>
1112 must be on for this to have an effect.
1113 <p><br><strong>Default:</strong>
1114 <code> debug hires timestamp = No</code>
1115 <p><br><strong>Example:</strong>
1116 <code> debug hires timestamp = Yes</code>
1117 <p><br><a name="debugtimestamp"></a>
1118 <li><strong><strong>debug timestamp (G)</strong></strong>
1119 <p><br>Samba2.0 debug log messages are timestamped by default. If you are
1120 running at a high <a href="smb.conf.5.html#debuglevel"><strong>"debug level"</strong></a> these timestamps
1121 can be distracting. This boolean parameter allows them to be turned
1122 off.
1123 <p><br><strong>Default:</strong>
1124 <code>  debug timestamp = Yes</code>
1125 <p><br><strong>Example:</strong>
1126 <code>  debug timestamp = No</code>
1127 <p><br><a name="debugpid"></a>
1128 <li><strong><strong>debug pid (G)</strong></strong>
1129 <p><br>When using only one log file for more then one forked smbd-process
1130 there may be hard to follow which process outputs which message.
1131 This boolean parameter is adds the process-id to the timestamp message
1132 headers in the logfile when turned on.
1133 <p><br>Note that the parameter <a href="smb.conf.5.html#debugtimestamp"><strong>debug timestamp</strong></a>
1134 must be on for this to have an effect.
1135 <p><br><strong>Default:</strong>
1136 <code>  debug pid = No</code>
1137 <p><br><strong>Example:</strong>
1138 <code>  debug pid = Yes</code>
1139 <p><br><a name="debuguid"></a>
1140 <li><strong><strong>debug uid (G)</strong></strong>
1141 <p><br>Samba is sometimes run as root and sometime run as the connected
1142 user, this boolean parameter inserts the current euid, egid, uid
1143 and gid to the timestamp message headers in the log file if turned on.
1144 <p><br>Note that the parameter <a href="smb.conf.5.html#debugtimestamp"><strong>debug timestamp</strong></a>
1145 must be on for this to have an effect.
1146 <p><br><strong>Default:</strong>
1147 <code>  debug uid = No</code>
1148 <p><br><strong>Example:</strong>
1149 <code>  debug uid = Yes</code>
1150 <p><br><a name="debuglevel"></a>
1151 <li><strong><strong>debug level (G)</strong></strong>
1152 <p><br>The value of the parameter (an integer) allows the debug level
1153 (logging level) to be specified in the <strong>smb.conf</strong> file. This is to
1154 give greater flexibility in the configuration of the system.
1155 <p><br>The default will be the debug level specified on the command line
1156 or level zero if none was specified.
1157 <p><br><strong>Example:</strong>
1158 <code>  debug level = 3</code>
1159 <p><br><a name="default"></a>
1160 <li><strong><strong>default (G)</strong></strong>
1161 <p><br>A synonym for <a href="smb.conf.5.html#defaultservice"><strong>default service</strong></a>.
1162 <p><br><a name="defaultcase"></a>
1163 <li><strong><strong>default case (S)</strong></strong>
1164 <p><br>See the section on <a href="smb.conf.5.html#NAMEMANGLING"><strong>"NAME MANGLING"</strong></a>. Also note
1165 the <a href="smb.conf.5.html#shortpreservecase"><strong>"short preserve case"</strong></a> parameter.
1166 <p><br><a name="defaultservice"></a>
1167 <li><strong><strong>default service (G)</strong></strong>
1168 <p><br>This parameter specifies the name of a service which will be connected
1169 to if the service actually requested cannot be found. Note that the
1170 square brackets are <em>NOT</em> given in the parameter value (see example
1171 below).
1172 <p><br>There is no default value for this parameter. If this parameter is not
1173 given, attempting to connect to a nonexistent service results in an
1174 error.
1175 <p><br>Typically the default service would be a <a href="smb.conf.5.html#guestok"><strong>guest ok</strong></a>,
1176 <a href="smb.conf.5.html#readonly"><strong>read-only</strong></a> service.
1177 <p><br>Also note that the apparent service name will be changed to equal that
1178 of the requested service, this is very useful as it allows you to use
1179 macros like <a href="smb.conf.5.html#percentS"><strong>%S</strong></a> to make a wildcard service.
1180 <p><br>Note also that any <code>'_'</code> characters in the name of the service used
1181 in the default service will get mapped to a <code>'/'</code>. This allows for
1182 interesting things.
1183 <p><br><strong>Example:</strong>
1184 <pre>
1185
1186         default service = pub
1187
1188         [pub]
1189                 path = /%S
1190
1191 </pre>
1192
1193 <p><br><a name="deleteuserscript"></a>
1194 <li><strong><strong>delete user script (G)</strong></strong>
1195 <p><br>This is the full pathname to a script that will be run <em>AS ROOT</em> by
1196 <a href="smbd.8.html"><strong>smbd (8)</strong></a> under special circumstances decribed
1197 below.
1198 <p><br>Normally, a Samba server requires that UNIX users are created for all
1199 users accessing files on this server. For sites that use Windows NT
1200 account databases as their primary user database creating these users
1201 and keeping the user list in sync with the Windows NT PDC is an
1202 onerous task. This option allows <a href="smbd.8.html"><strong>smbd</strong></a> to delete
1203 the required UNIX users <em>ON DEMAND</em> when a user accesses the Samba
1204 server and the Windows NT user no longer exists.
1205 <p><br>In order to use this option, <a href="smbd.8.html"><strong>smbd</strong></a> must be set to
1206 <a href="smb.conf.5.html#securityequaldomain"><strong>security=domain</strong></a> and <strong>"delete user
1207 script"</strong> must be set to a full pathname for a script that will delete
1208 a UNIX user given one argument of <strong>%u</strong>, which expands into the UNIX
1209 user name to delete. <em>NOTE</em> that this is different to the
1210 <a href="smb.conf.5.html#adduserscript"><strong>add user script</strong></a> which will work with the
1211 <a href="smb.conf.5.html#securityequalserver"><strong>security=server</strong></a> option as well as
1212 <a href="smb.conf.5.html#securityequaldomain"><strong>security=domain</strong></a>. The reason for this
1213 is only when Samba is a domain member does it get the information
1214 on an attempted user logon that a user no longer exists. In the
1215 <a href="smb.conf.5.html#securityequalserver"><strong>security=server</strong></a> mode a missing user
1216 is treated the same as an invalid password logon attempt. Deleting
1217 the user in this circumstance would not be a good idea.
1218 <p><br>When the Windows user attempts to access the Samba server, at
1219 <em>"login"</em>(session setup in the SMB protocol) time,
1220 <a href="smbd.8.html"><strong>smbd</strong></a> contacts the <a href="smb.conf.5.html#passwordserver"><strong>password
1221 server</strong></a> and attempts to authenticate the given user
1222 with the given password. If the authentication fails with the specific
1223 Domain error code meaning that the user no longer exists then
1224 <a href="smbd.8.html"><strong>smbd</strong></a> attempts to find a UNIX user in the UNIX
1225 password database that matches the Windows user account. If this lookup succeeds,
1226 and <strong>"delete user script"</strong> is set then <a href="smbd.8.html"><strong>smbd</strong></a> will
1227 call the specified script <em>AS ROOT</em>, expanding any <strong>%u</strong> argument
1228 to be the user name to delete.
1229 <p><br>This script should delete the given UNIX username. In this way, UNIX
1230 users are dynamically deleted to match existing Windows NT accounts.
1231 <p><br>See also <a href="smb.conf.5.html#securityequaldomain"><strong>security=domain</strong></a>,
1232 <a href="smb.conf.5.html#passwordserver"><strong>password server</strong></a>, <a href="smb.conf.5.html#adduserscript"><strong>add user
1233 script</strong></a>.
1234 <p><br><strong>Default:</strong>
1235 <code>  delete user script = &lt;empty string&gt;</code>
1236 <p><br><strong>Example:</strong>
1237 <code>  delete user script = /usr/local/samba/bin/del_user %u</code>
1238 <p><br><a name="deletereadonly"></a>
1239 <li><strong><strong>delete readonly (S)</strong></strong>
1240 <p><br>This parameter allows readonly files to be deleted.  This is not
1241 normal DOS semantics, but is allowed by UNIX.
1242 <p><br>This option may be useful for running applications such as rcs, where
1243 UNIX file ownership prevents changing file permissions, and DOS
1244 semantics prevent deletion of a read only file.
1245 <p><br><strong>Default:</strong>
1246 <code>  delete readonly = No</code>
1247 <p><br><strong>Example:</strong>
1248 <code>  delete readonly = Yes</code>
1249 <p><br><a name="deletevetofiles"></a>
1250 <li><strong><strong>delete veto files (S)</strong></strong>
1251 <p><br>This option is used when Samba is attempting to delete a directory
1252 that contains one or more vetoed directories (see the <a href="smb.conf.5.html#vetofiles"><strong>'veto
1253 files'</strong></a> option).  If this option is set to False (the
1254 default) then if a vetoed directory contains any non-vetoed files or
1255 directories then the directory delete will fail. This is usually what
1256 you want.
1257 <p><br>If this option is set to True, then Samba will attempt to recursively
1258 delete any files and directories within the vetoed directory. This can
1259 be useful for integration with file serving systems such as <strong>NetAtalk</strong>,
1260 which create meta-files within directories you might normally veto
1261 DOS/Windows users from seeing (e.g. <code>.AppleDouble</code>)
1262 <p><br>Setting <code>'delete veto files = True'</code> allows these directories to be
1263 transparently deleted when the parent directory is deleted (so long
1264 as the user has permissions to do so).
1265 <p><br>See also the <a href="smb.conf.5.html#vetofiles"><strong>veto files</strong></a> parameter.
1266 <p><br><strong>Default:</strong>
1267 <code>  delete veto files = False</code>
1268 <p><br><strong>Example:</strong>
1269 <code>  delete veto files = True</code>
1270 <p><br><a name="denyhosts"></a>
1271 <li><strong><strong>deny hosts (S)</strong></strong>
1272 <p><br>Synonym for <a href="smb.conf.5.html#hostsdeny"><strong>hosts deny</strong></a>.
1273 <p><br><a name="dfreecommand"></a>
1274 <li><strong><strong>dfree command (G)</strong></strong>
1275 <p><br>The dfree command setting should only be used on systems where a
1276 problem occurs with the internal disk space calculations. This has
1277 been known to happen with Ultrix, but may occur with other operating
1278 systems. The symptom that was seen was an error of "Abort Retry
1279 Ignore" at the end of each directory listing.
1280 <p><br>This setting allows the replacement of the internal routines to
1281 calculate the total disk space and amount available with an external
1282 routine. The example below gives a possible script that might fulfill
1283 this function.
1284 <p><br>The external program will be passed a single parameter indicating a
1285 directory in the filesystem being queried. This will typically consist
1286 of the string <code>"./"</code>. The script should return two integers in
1287 ascii. The first should be the total disk space in blocks, and the
1288 second should be the number of available blocks. An optional third
1289 return value can give the block size in bytes. The default blocksize
1290 is 1024 bytes.
1291 <p><br>Note: Your script should <em>NOT</em> be setuid or setgid and should be
1292 owned by (and writeable only by) root!
1293 <p><br><strong>Default:</strong>
1294 <code>  By default internal routines for determining the disk capacity
1295 and remaining space will be used.</code>
1296 <p><br><strong>Example:</strong>
1297 <code>  dfree command = /usr/local/samba/bin/dfree</code>
1298 <p><br>Where the script dfree (which must be made executable) could be:
1299 <p><br><pre>
1300
1301         #!/bin/sh
1302         df $1 | tail -1 | awk '{print $2" "$4}'
1303
1304 </pre>
1305
1306 <p><br>or perhaps (on Sys V based systems):
1307 <p><br><pre>
1308
1309         #!/bin/sh
1310         /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
1311
1312 </pre>
1313
1314 <p><br>Note that you may have to replace the command names with full
1315 path names on some systems.
1316 <p><br><a name="directory"></a>
1317 <li><strong><strong>directory (S)</strong></strong>
1318 <p><br>Synonym for <a href="smb.conf.5.html#path"><strong>path</strong></a>.
1319 <p><br><a name="directorymask"></a>
1320 <li><strong><strong>directory mask (S)</strong></strong>
1321 <p><br>This parameter is the octal modes which are used when converting DOS
1322 modes to UNIX modes when creating UNIX directories.
1323 <p><br>When a directory is created, the necessary permissions are calculated
1324 according to the mapping from DOS modes to UNIX permissions, and the
1325 resulting UNIX mode is then bit-wise 'AND'ed with this parameter.
1326 This parameter may be thought of as a bit-wise MASK for the UNIX modes
1327 of a directory. Any bit <em>*not*</em> set here will be removed from the
1328 modes set on a directory when it is created.
1329 <p><br>The default value of this parameter removes the 'group' and 'other'
1330 write bits from the UNIX mode, allowing only the user who owns the
1331 directory to modify it.
1332 <p><br>Following this Samba will bit-wise 'OR' the UNIX mode created from
1333 this parameter with the value of the "force directory mode"
1334 parameter. This parameter is set to 000 by default (i.e. no extra mode
1335 bits are added).
1336 <p><br>See the <a href="smb.conf.5.html#forcedirectorymode"><strong>"force directory mode"</strong></a> parameter
1337 to cause particular mode bits to always be set on created directories.
1338 <p><br>See also the <a href="smb.conf.5.html#createmode"><strong>"create mode"</strong></a> parameter for masking
1339 mode bits on created files, and the <a href="smb.conf.5.html#directorysecuritymask"><strong>"directory security mask"</strong></a>
1340 parameter.
1341 <p><br><strong>Default:</strong>
1342 <code>  directory mask = 0755</code>
1343 <p><br><strong>Example:</strong>
1344 <code>  directory mask = 0775</code>
1345 <p><br><a name="directorymode"></a>
1346 <li><strong><strong>directory mode (S)</strong></strong>
1347 <p><br>Synonym for <a href="smb.conf.5.html#directorymask"><strong>directory mask</strong></a>.
1348 <p><br><a name="directorysecuritymask"></a>
1349 <li><strong><strong>directory security mask (S)</strong></strong>
1350 <p><br>This parameter controls what UNIX permission bits can be modified
1351 when a Windows NT client is manipulating the UNIX permission on a
1352 directory using the native NT security dialog box.
1353 <p><br>This parameter is applied as a mask (AND'ed with) to the changed
1354 permission bits, thus preventing any bits not in this mask from
1355 being modified. Essentially, zero bits in this mask may be treated
1356 as a set of bits the user is not allowed to change.
1357 <p><br>If not set explicitly this parameter is set to the same value as the
1358 <a href="smb.conf.5.html#directorymask"><strong>directory mask</strong></a> parameter. To allow a user to
1359 modify all the user/group/world permissions on a directory, set this
1360 parameter to 0777.
1361 <p><br><em>Note</em> that users who can access the Samba server through other
1362 means can easily bypass this restriction, so it is primarily
1363 useful for standalone "appliance" systems.  Administrators of
1364 most normal systems will probably want to set it to 0777.
1365 <p><br>See also the <a href="smb.conf.5.html#forcedirectorysecuritymode"><strong>force directory security
1366 mode</strong></a>, <a href="smb.conf.5.html#securitymask"><strong>security
1367 mask</strong></a>, <a href="smb.conf.5.html#forcesecuritymode"><strong>force security mode</strong></a>
1368 parameters.
1369 <p><br><strong>Default:</strong>
1370 <code>  directory security mask = &lt;same as directory mask&gt;</code>
1371 <p><br><strong>Example:</strong>
1372 <code>  directory security mask = 0777</code>
1373 <p><br><a name="dnsproxy"></a>
1374 <li><strong><strong>dns proxy (G)</strong></strong>
1375 <p><br>Specifies that <a href="nmbd.8.html"><strong>nmbd</strong></a> when acting as a WINS
1376 server and finding that a NetBIOS name has not been registered, should
1377 treat the NetBIOS name word-for-word as a DNS name and do a lookup
1378 with the DNS server for that name on behalf of the name-querying
1379 client.
1380 <p><br>Note that the maximum length for a NetBIOS name is 15 characters, so
1381 the DNS name (or DNS alias) can likewise only be 15 characters,
1382 maximum.
1383 <p><br><a href="nmbd.8.html"><strong>nmbd</strong></a> spawns a second copy of itself to do the
1384 DNS name lookup requests, as doing a name lookup is a blocking action.
1385 <p><br>See also the parameter <a href="smb.conf.5.html#winssupport"><strong>wins support</strong></a>.
1386 <p><br><strong>Default:</strong>
1387 <code>  dns proxy = yes</code>
1388 <p><br><a name="domainadmingroup"></a>
1389 <strong>domain admin group (G)</strong>
1390 <p><br>This is an <strong>EXPERIMENTAL</strong> parameter that is part of the unfinished
1391 Samba NT Domain Controller Code. It may be removed in a later release.
1392 To work with the latest code builds that may have more support for
1393 Samba NT Domain Controller functionality please subscribe to the
1394 mailing list <strong>Samba-ntdom</strong> available by sending email to
1395 <a href="mailto:listproc@samba.org"><em>listproc@samba.org</em></a>
1396 <p><br><a name="domainadminusers"></a>
1397 <li><strong><strong>domain admin users (G)</strong></strong>
1398 <p><br>This is an <strong>EXPERIMENTAL</strong> parameter that is part of the unfinished
1399 Samba NT Domain Controller Code. It may be removed in a later release.
1400 To work with the latest code builds that may have more support for
1401 Samba NT Domain Controller functionality please subscribe to the
1402 mailing list <strong>Samba-ntdom</strong> available by sending email to
1403 <a href="mailto:listproc@samba.org"><em>listproc@samba.org</em></a>
1404 <p><br><a name="domaincontroller"></a>
1405 <li><strong><strong>domain controller (G)</strong></strong>
1406 <p><br>This is a <strong>DEPRECATED</strong> parameter. It is currently not used within
1407 the Samba source and should be removed from all current smb.conf
1408 files. It is left behind for compatibility reasons.
1409 <p><br><a name="domaingroups"></a>
1410 <li><strong><strong>domain groups (G)</strong></strong>
1411 <p><br>This is an <strong>EXPERIMENTAL</strong> parameter that is part of the unfinished
1412 Samba NT Domain Controller Code. It may be removed in a later release.
1413 To work with the latest code builds that may have more support for
1414 Samba NT Domain Controller functionality please subscribe to the
1415 mailing list <strong>Samba-ntdom</strong> available by sending email to
1416 <a href="mailto:listproc@samba.org"><em>listproc@samba.org</em></a>
1417 <p><br><a name="domainguestgroup"></a>
1418 <li><strong><strong>domain guest group (G)</strong></strong>
1419 <p><br>This is an <strong>EXPERIMENTAL</strong> parameter that is part of the unfinished
1420 Samba NT Domain Controller Code. It may be removed in a later release.
1421 To work with the latest code builds that may have more support for
1422 Samba NT Domain Controller functionality please subscribe to the
1423 mailing list <strong>Samba-ntdom</strong> available by sending email to
1424 <a href="mailto:listproc@samba.org"><em>listproc@samba.org</em></a>
1425 <p><br><a name="domainguestusers"></a>
1426 <li><strong><strong>domain guest users (G)</strong></strong>
1427 <p><br>This is an <strong>EXPERIMENTAL</strong> parameter that is part of the unfinished
1428 Samba NT Domain Controller Code. It may be removed in a later release.
1429 To work with the latest code builds that may have more support for
1430 Samba NT Domain Controller functionality please subscribe to the
1431 mailing list <strong>Samba-ntdom</strong> available by sending email to
1432 <a href="mailto:listproc@samba.org"><em>listproc@samba.org</em></a>
1433 <p><br><a name="domainlogons"></a>
1434 <li><strong><strong>domain logons (G)</strong></strong>
1435 <p><br>If set to true, the Samba server will serve Windows 95/98 Domain
1436 logons for the <a href="smb.conf.5.html#workgroup"><strong>workgroup</strong></a> it is in. For more
1437 details on setting up this feature see the file DOMAINS.txt in the
1438 Samba documentation directory <code>docs/</code> shipped with the source code.
1439 <p><br>Note that Win95/98 Domain logons are <em>NOT</em> the same as Windows
1440 NT Domain logons. NT Domain logons require a Primary Domain Controller
1441 (PDC) for the Domain. It is intended that in a future release Samba
1442 will be able to provide this functionality for Windows NT clients
1443 also.
1444 <p><br><strong>Default:</strong>
1445 <code>  domain logons = no</code>
1446 <p><br><a name="domainmaster"></a>
1447 <li><strong><strong>domain master (G)</strong></strong>
1448 <p><br>Tell <a href="nmbd.8.html"><strong>nmbd</strong></a> to enable WAN-wide browse list
1449 collation. Setting this option causes <a href="nmbd.8.html"><strong>nmbd</strong></a> to
1450 claim a special domain specific NetBIOS name that identifies it as a
1451 domain master browser for its given
1452 <a href="smb.conf.5.html#workgroup"><strong>workgroup</strong></a>. Local master browsers in the same
1453 <a href="smb.conf.5.html#workgroup"><strong>workgroup</strong></a> on broadcast-isolated subnets will give
1454 this <a href="nmbd.8.html"><strong>nmbd</strong></a> their local browse lists, and then
1455 ask <a href="smbd.8.html"><strong>smbd</strong></a> for a complete copy of the browse list
1456 for the whole wide area network.  Browser clients will then contact
1457 their local master browser, and will receive the domain-wide browse
1458 list, instead of just the list for their broadcast-isolated subnet.
1459 <p><br>Note that Windows NT Primary Domain Controllers expect to be able to
1460 claim this <a href="smb.conf.5.html#workgroup"><strong>workgroup</strong></a> specific special NetBIOS
1461 name that identifies them as domain master browsers for that
1462 <a href="smb.conf.5.html#workgroup"><strong>workgroup</strong></a> by default (i.e. there is no way to
1463 prevent a Windows NT PDC from attempting to do this). This means that
1464 if this parameter is set and <a href="nmbd.8.html"><strong>nmbd</strong></a> claims the
1465 special name for a <a href="smb.conf.5.html#workgroup"><strong>workgroup</strong></a> before a Windows NT
1466 PDC is able to do so then cross subnet browsing will behave strangely
1467 and may fail.
1468 <p><br><strong>Default:</strong>
1469 <code>  domain master = no</code>
1470 <p><br><a name="dontdescend"></a>
1471 <li><strong><strong>dont descend (S)</strong></strong>
1472 <p><br>There are certain directories on some systems (e.g., the <code>/proc</code> tree
1473 under Linux) that are either not of interest to clients or are
1474 infinitely deep (recursive). This parameter allows you to specify a
1475 comma-delimited list of directories that the server should always show
1476 as empty.
1477 <p><br>Note that Samba can be very fussy about the exact format of the "dont
1478 descend" entries. For example you may need <code>"./proc"</code> instead of
1479 just <code>"/proc"</code>. Experimentation is the best policy :-)
1480 <p><br><strong>Default:</strong>
1481 <code>  none (i.e., all directories are OK to descend)</code>
1482 <p><br><strong>Example:</strong>
1483 <code>  dont descend = /proc,/dev</code>
1484 <p><br><a name="dosfiletimeresolution"></a>
1485 <li><strong><strong>dos filetime resolution (S)</strong></strong>
1486 <p><br>Under the DOS and Windows FAT filesystem, the finest granularity on
1487 time resolution is two seconds. Setting this parameter for a share
1488 causes Samba to round the reported time down to the nearest two second
1489 boundary when a query call that requires one second resolution is made
1490 to <a href="smbd.8.html"><strong>smbd</strong></a>.
1491 <p><br>This option is mainly used as a compatibility option for Visual C++
1492 when used against Samba shares. If oplocks are enabled on a share,
1493 Visual C++ uses two different time reading calls to check if a file
1494 has changed since it was last read. One of these calls uses a
1495 one-second granularity, the other uses a two second granularity. As
1496 the two second call rounds any odd second down, then if the file has a
1497 timestamp of an odd number of seconds then the two timestamps will not
1498 match and Visual C++ will keep reporting the file has changed. Setting
1499 this option causes the two timestamps to match, and Visual C++ is
1500 happy.
1501 <p><br><strong>Default:</strong>
1502 <code>  dos filetime resolution = False</code>
1503 <p><br><strong>Example:</strong>
1504 <code>  dos filetime resolution = True</code>
1505 <p><br><a name="dosfiletimes"></a>
1506 <li><strong><strong>dos filetimes (S)</strong></strong>
1507 <p><br>Under DOS and Windows, if a user can write to a file they can change
1508 the timestamp on it. Under POSIX semantics, only the owner of the file
1509 or root may change the timestamp. By default, Samba runs with POSIX
1510 semantics and refuses to change the timestamp on a file if the user
1511 smbd is acting on behalf of is not the file owner. Setting this option
1512 to True allows DOS semantics and smbd will change the file timestamp as
1513 DOS requires.
1514 <p><br><strong>Default:</strong>
1515 <code>  dos filetimes = False</code>
1516 <p><br><strong>Example:</strong>
1517 <code>  dos filetimes = True</code>
1518 <p><br><a name="encryptpasswords"></a>
1519 <li><strong><strong>encrypt passwords (G)</strong></strong>
1520 <p><br>This boolean controls whether encrypted passwords will be negotiated
1521 with the client. Note that Windows NT 4.0 SP3 and above and also
1522 Windows 98 will by default expect encrypted passwords unless a
1523 registry entry is changed. To use encrypted passwords in Samba see the
1524 file ENCRYPTION.txt in the Samba documentation directory <code>docs/</code>
1525 shipped with the source code.
1526 <p><br>In order for encrypted passwords to work correctly
1527 <a href="smbd.8.html"><strong>smbd</strong></a> must either have access to a local
1528 <a href="smbpasswd.5.html"><strong>smbpasswd (5)</strong></a> file (see the
1529 <a href="smbpasswd.8.html"><strong>smbpasswd (8)</strong></a> program for information on
1530 how to set up and maintain this file), or set the
1531 <a href="smb.conf.5.html#security"><strong>security=</strong></a> parameter to either
1532 <a href="smb.conf.5.html#securityequalserver"><strong>"server"</strong></a> or
1533 <a href="smb.conf.5.html#securityequaldomain"><strong>"domain"</strong></a> which causes
1534 <a href="smbd.8.html"><strong>smbd</strong></a> to authenticate against another server.
1535 <p><br><a name="exec"></a>
1536 <li><strong><strong>exec (S)</strong></strong>
1537 <p><br>This is a synonym for <a href="smb.conf.5.html#preexec"><strong>preexec</strong></a>.
1538 <p><br><a name="fakedirectorycreatetimes"></a>
1539 <li><strong><strong>fake directory create times (S)</strong></strong>
1540 <p><br>NTFS and Windows VFAT file systems keep a create time for all files
1541 and directories. This is not the same as the ctime - status change
1542 time - that Unix keeps, so Samba by default reports the earliest of
1543 the various times Unix does keep. Setting this parameter for a share
1544 causes Samba to always report midnight 1-1-1980 as the create time for
1545 directories.
1546 <p><br>This option is mainly used as a compatibility option for Visual C++
1547 when used against Samba shares. Visual C++ generated makefiles have
1548 the object directory as a dependency for each object file, and a make
1549 rule to create the directory. Also, when NMAKE compares timestamps it
1550 uses the creation time when examining a directory. Thus the object
1551 directory will be created if it does not exist, but once it does exist
1552 it will always have an earlier timestamp than the object files it
1553 contains.
1554 <p><br>However, Unix time semantics mean that the create time reported by
1555 Samba will be updated whenever a file is created or deleted in the
1556 directory. NMAKE therefore finds all object files in the object
1557 directory bar the last one built are out of date compared to the
1558 directory and rebuilds them. Enabling this option ensures directories
1559 always predate their contents and an NMAKE build will proceed as
1560 expected.
1561 <p><br><strong>Default:</strong>
1562 <code>  fake directory create times = False</code>
1563 <p><br><strong>Example:</strong>
1564 <code>  fake directory create times = True</code>
1565 <p><br><a name="fakeoplocks"></a>
1566 <li><strong><strong>fake oplocks (S)</strong></strong>
1567 <p><br>Oplocks are the way that SMB clients get permission from a server to
1568 locally cache file operations. If a server grants an oplock
1569 (opportunistic lock) then the client is free to assume that it is the
1570 only one accessing the file and it will aggressively cache file
1571 data. With some oplock types the client may even cache file open/close
1572 operations. This can give enormous performance benefits.
1573 <p><br>When you set <code>"fake oplocks = yes"</code> <a href="smbd.8.html"><strong>smbd</strong></a> will
1574 always grant oplock requests no matter how many clients are using the
1575 file.
1576 <p><br>It is generally much better to use the real <a href="smb.conf.5.html#oplocks"><strong>oplocks</strong></a>
1577 support rather than this parameter.
1578 <p><br>If you enable this option on all read-only shares or shares that you
1579 know will only be accessed from one client at a time such as
1580 physically read-only media like CDROMs, you will see a big performance
1581 improvement on many operations. If you enable this option on shares
1582 where multiple clients may be accessing the files read-write at the
1583 same time you can get data corruption. Use this option carefully!
1584 <p><br>This option is disabled by default.
1585 <p><br><a name="followsymlinks"></a>
1586 <li><strong><strong>follow symlinks (S)</strong></strong>
1587 <p><br>This parameter allows the Samba administrator to stop
1588 <a href="smbd.8.html"><strong>smbd</strong></a> from following symbolic links in a
1589 particular share. Setting this parameter to <em>"No"</em> prevents any file
1590 or directory that is a symbolic link from being followed (the user
1591 will get an error).  This option is very useful to stop users from
1592 adding a symbolic link to <code>/etc/passwd</code> in their home directory for
1593 instance.  However it will slow filename lookups down slightly.
1594 <p><br>This option is enabled (i.e. <a href="smbd.8.html"><strong>smbd</strong></a> will follow
1595 symbolic links) by default.
1596 <p><br><a name="forcecreatemode"></a>
1597 <li><strong><strong>force create mode (S)</strong></strong>
1598 <p><br>This parameter specifies a set of UNIX mode bit permissions that will
1599 <em>*always*</em> be set on a file created by Samba. This is done by
1600 bitwise 'OR'ing these bits onto the mode bits of a file that is being
1601 created. The default for this parameter is (in octal) 000. The modes
1602 in this parameter are bitwise 'OR'ed onto the file mode after the mask
1603 set in the <a href="smb.conf.5.html#createmask"><strong>"create mask"</strong></a> parameter is applied.
1604 <p><br>See also the parameter <a href="smb.conf.5.html#createmask"><strong>"create mask"</strong></a> for details
1605 on masking mode bits on created files.
1606 <p><br><strong>Default:</strong>
1607 <code>  force create mode = 000</code>
1608 <p><br><strong>Example:</strong>
1609 <code>  force create mode = 0755</code>
1610 <p><br>would force all created files to have read and execute permissions set
1611 for 'group' and 'other' as well as the read/write/execute bits set for
1612 the 'user'.
1613 <p><br><a name="forcedirectorymode"></a>
1614 <li><strong><strong>force directory mode (S)</strong></strong>
1615 <p><br>This parameter specifies a set of UNIX mode bit permissions that will
1616 <em>*always*</em> be set on a directory created by Samba. This is done by
1617 bitwise 'OR'ing these bits onto the mode bits of a directory that is
1618 being created. The default for this parameter is (in octal) 0000 which
1619 will not add any extra permission bits to a created directory. This
1620 operation is done after the mode mask in the parameter
1621 <a href="smb.conf.5.html#directorymask"><strong>"directory mask"</strong></a> is applied.
1622 <p><br>See also the parameter <a href="smb.conf.5.html#directorymask"><strong>"directory mask"</strong></a> for
1623 details on masking mode bits on created directories.
1624 <p><br><strong>Default:</strong>
1625 <code>  force directory mode = 000</code>
1626 <p><br><strong>Example:</strong>
1627 <code>  force directory mode = 0755</code>
1628 <p><br>would force all created directories to have read and execute
1629 permissions set for 'group' and 'other' as well as the
1630 read/write/execute bits set for the 'user'.
1631 <p><br><a name="forcedirectorysecuritymode"></a>
1632 <li><strong><strong>force directory security mode (S)</strong></strong>
1633 <p><br>This parameter controls what UNIX permission bits can be modified when
1634 a Windows NT client is manipulating the UNIX permission on a directory
1635 using the native NT security dialog box.
1636 <p><br>This parameter is applied as a mask (OR'ed with) to the changed
1637 permission bits, thus forcing any bits in this mask that the user may
1638 have modified to be on. Essentially, one bits in this mask may be
1639 treated as a set of bits that, when modifying security on a directory,
1640 the user has always set to be 'on'.
1641 <p><br>If not set explicitly this parameter is set to the same value as the
1642 <a href="smb.conf.5.html#forcedirectorymode"><strong>force directory mode</strong></a> parameter. To allow
1643 a user to modify all the user/group/world permissions on a directory,
1644 with restrictions set this parameter to 000.
1645 <p><br><em>Note</em> that users who can access the Samba server through other
1646 means can easily bypass this restriction, so it is primarily
1647 useful for standalone "appliance" systems.  Administrators of
1648 most normal systems will probably want to set it to 0000.
1649 <p><br>See also the <a href="smb.conf.5.html#directorysecuritymask"><strong>directory security mask</strong></a>,
1650 <a href="smb.conf.5.html#securitymask"><strong>security mask</strong></a>, <a href="smb.conf.5.html#forcesecuritymode"><strong>force security
1651 mode</strong></a> parameters.
1652 <p><br><strong>Default:</strong>
1653 <code>  force directory security mode = &lt;same as force directory mode&gt;</code>
1654 <p><br><strong>Example:</strong>
1655 <code>  force directory security mode = 0</code>
1656 <p><br><a name="forcegroup"></a>
1657 <li><strong><strong>force group (S)</strong></strong>
1658 <p><br>This specifies a UNIX group name that will be assigned as the default
1659 primary group for all users connecting to this service. This is useful
1660 for sharing files by ensuring that all access to files on service will
1661 use the named group for their permissions checking. Thus, by assigning
1662 permissions for this group to the files and directories within this
1663 service the Samba administrator can restrict or allow sharing of these
1664 files.
1665 <p><br>In Samba 2.0.5 and above this parameter has extended functionality in the following
1666 way. If the group name listed here has a '+' character prepended to it
1667 then the current user accessing the share only has the primary group
1668 default assigned to this group if they are already assigned as a member
1669 of that group. This allows an administrator to decide that only users
1670 who are already in a particular group will create files with group
1671 ownership set to that group. This gives a finer granularity of ownership
1672 assignment. For example, the setting <code>force group = +sys</code> means
1673 that only users who are already in group sys will have their default
1674 primary group assigned to sys when accessing this Samba share. All
1675 other users will retain their ordinary primary group.
1676 <p><br>If the <a href="smb.conf.5.html#forceuser"><strong>"force user"</strong></a> parameter is also set the
1677 group specified in <strong>force group</strong> will override the primary group
1678 set in <a href="smb.conf.5.html#forceuser"><strong>"force user"</strong></a>.
1679 <p><br>See also <a href="smb.conf.5.html#forceuser"><strong>"force user"</strong></a>
1680 <p><br><strong>Default:</strong>
1681 <code>  no forced group</code>
1682 <p><br><strong>Example:</strong>
1683 <code>  force group = agroup</code>
1684 <p><br><a name="forcesecuritymode"></a>
1685 <li><strong><strong>force security mode (S)</strong></strong>
1686 <p><br>This parameter controls what UNIX permission bits can be modified when
1687 a Windows NT client is manipulating the UNIX permission on a file
1688 using the native NT security dialog box.
1689 <p><br>This parameter is applied as a mask (OR'ed with) to the changed
1690 permission bits, thus forcing any bits in this mask that the user may
1691 have modified to be on. Essentially, one bits in this mask may be
1692 treated as a set of bits that, when modifying security on a file, the
1693 user has always set to be 'on'.
1694 <p><br>If not set explicitly this parameter is set to the same value as the
1695 <a href="smb.conf.5.html#forcecreatemode"><strong>force create mode</strong></a> parameter. To allow
1696 a user to modify all the user/group/world permissions on a file,
1697 with no restrictions set this parameter to 000.
1698 <p><br><em>Note</em> that users who can access the Samba server through other
1699 means can easily bypass this restriction, so it is primarily
1700 useful for standalone "appliance" systems.  Administrators of
1701 most normal systems will probably want to set it to 0000.
1702 <p><br>See also the <a href="smb.conf.5.html#forcedirectorysecuritymode"><strong>force directory security
1703 mode</strong></a>, <a href="smb.conf.5.html#directorysecuritymask"><strong>directory security
1704 mask</strong></a>, <a href="smb.conf.5.html#securitymask"><strong>security mask</strong></a>
1705 parameters.
1706 <p><br><strong>Default:</strong>
1707 <code>  force security mode = &lt;same as force create mode&gt;</code>
1708 <p><br><strong>Example:</strong>
1709 <code>  force security mode = 0</code>
1710 <p><br><a name="forceuser"></a>
1711 <li><strong><strong>force user (S)</strong></strong>
1712 <p><br>This specifies a UNIX user name that will be assigned as the default
1713 user for all users connecting to this service. This is useful for
1714 sharing files. You should also use it carefully as using it
1715 incorrectly can cause security problems.
1716 <p><br>This user name only gets used once a connection is established. Thus
1717 clients still need to connect as a valid user and supply a valid
1718 password. Once connected, all file operations will be performed as the
1719 <code>"forced user"</code>, no matter what username the client connected as.
1720 <p><br>This can be very useful.
1721 <p><br>In Samba 2.0.5 and above this parameter also causes the primary
1722 group of the forced user to be used as the primary group for all
1723 file activity. Prior to 2.0.5 the primary group was left as the
1724 primary group of the connecting user (this was a bug).
1725 <p><br>See also <a href="smb.conf.5.html#forcegroup"><strong>"force group"</strong></a>
1726 <p><br><strong>Default:</strong>
1727 <code>  no forced user</code>
1728 <p><br><strong>Example:</strong>
1729 <code>  force user = auser</code>
1730 <p><br><a name="fstype"></a>
1731 <li><strong><strong>fstype (S)</strong></strong>
1732 <p><br>This parameter allows the administrator to configure the string that
1733 specifies the type of filesystem a share is using that is reported by
1734 <a href="smbd.8.html"><strong>smbd</strong></a> when a client queries the filesystem type
1735 for a share. The default type is <strong>"NTFS"</strong> for compatibility with
1736 Windows NT but this can be changed to other strings such as "Samba" or
1737 "FAT" if required.
1738 <p><br><strong>Default:</strong>
1739 <code>  fstype = NTFS</code>
1740 <p><br><strong>Example:</strong>
1741 <code>  fstype = Samba</code>
1742 <p><br><a name="getwdcache"></a>
1743 <li><strong><strong>getwd cache (G)</strong></strong>
1744 <p><br>This is a tuning option. When this is enabled a caching algorithm
1745 will be used to reduce the time taken for getwd() calls. This can have
1746 a significant impact on performance, especially when the
1747 <a href="smb.conf.5.html#widelinks"><strong>widelinks</strong></a> parameter is set to False.
1748 <p><br><strong>Default:</strong>
1749 <code>  getwd cache = No</code>
1750 <p><br><strong>Example:</strong>
1751 <code>  getwd cache = Yes</code>
1752 <p><br><a name="group"></a>
1753 <li><strong><strong>group (S)</strong></strong>
1754 <p><br>Synonym for <a href="smb.conf.5.html#forcegroup"><strong>"force group"</strong></a>.
1755 <p><br><a name="guestaccount"></a>
1756 <li><strong><strong>guest account (S)</strong></strong>
1757 <p><br>This is a username which will be used for access to services which are
1758 specified as <a href="smb.conf.5.html#guestok"><strong>'guest ok'</strong></a> (see below). Whatever
1759 privileges this user has will be available to any client connecting to
1760 the guest service. Typically this user will exist in the password
1761 file, but will not have a valid login. The user account <strong>"ftp"</strong> is
1762 often a good choice for this parameter. If a username is specified in
1763 a given service, the specified username overrides this one.
1764 <p><br>One some systems the default guest account "nobody" may not be able to
1765 print. Use another account in this case. You should test this by
1766 trying to log in as your guest user (perhaps by using the <code>"su -"</code>
1767 command) and trying to print using the system print command such as
1768 <strong>lpr (1)</strong> or <strong>lp (1)</strong>.
1769 <p><br><strong>Default:</strong>
1770 <code>  specified at compile time, usually "nobody"</code>
1771 <p><br><strong>Example:</strong>
1772 <code>  guest account = ftp</code>
1773 <p><br><a name="guestok"></a>
1774 <li><strong><strong>guest ok (S)</strong></strong>
1775 <p><br>If this parameter is <em>'yes'</em> for a service, then no password is
1776 required to connect to the service. Privileges will be those of the
1777 <a href="smb.conf.5.html#guestaccount"><strong>guest account</strong></a>.
1778 <p><br>See the section below on <a href="smb.conf.5.html#security"><strong>security</strong></a> for more
1779 information about this option.
1780 <p><br><strong>Default:</strong>
1781 <code>  guest ok = no</code>
1782 <p><br><strong>Example:</strong>
1783 <code>  guest ok = yes</code>
1784 <p><br><a name="guestonly"></a>
1785 <li><strong><strong>guest only (S)</strong></strong>
1786 <p><br>If this parameter is <em>'yes'</em> for a service, then only guest
1787 connections to the service are permitted. This parameter will have no
1788 affect if <a href="smb.conf.5.html#guestok"><strong>"guest ok"</strong></a> or <a href="smb.conf.5.html#public"><strong>"public"</strong></a>
1789 is not set for the service.
1790 <p><br>See the section below on <a href="smb.conf.5.html#security"><strong>security</strong></a> for more
1791 information about this option.
1792 <p><br><strong>Default:</strong>
1793 <code>  guest only = no</code>
1794 <p><br><strong>Example:</strong>
1795 <code>  guest only = yes</code>
1796 <p><br><a name="hidedotfiles"></a>
1797 <li><strong><strong>hide dot files (S)</strong></strong>
1798 <p><br>This is a boolean parameter that controls whether files starting with
1799 a dot appear as hidden files.
1800 <p><br><strong>Default:</strong>
1801 <code>  hide dot files = yes</code>
1802 <p><br><strong>Example:</strong>
1803 <code>  hide dot files = no</code>
1804 <p><br><a name="hidefiles"></a>
1805 <li><strong><strong>hide files(S)</strong></strong>
1806 <p><br>This is a list of files or directories that are not visible but are
1807 accessible.  The DOS 'hidden' attribute is applied to any files or
1808 directories that match.
1809 <p><br>Each entry in the list must be separated by a <code>'/'</code>, which allows
1810 spaces to be included in the entry.  <code>'*'</code> and <code>'?'</code> can be used
1811 to specify multiple files or directories as in DOS wildcards.
1812 <p><br>Each entry must be a Unix path, not a DOS path and must not include the
1813 Unix directory separator <code>'/'</code>.
1814 <p><br>Note that the case sensitivity option is applicable in hiding files.
1815 <p><br>Setting this parameter will affect the performance of Samba, as it
1816 will be forced to check all files and directories for a match as they
1817 are scanned.
1818 <p><br>See also <a href="smb.conf.5.html#hidedotfiles"><strong>"hide dot files"</strong></a>, <a href="smb.conf.5.html#vetofiles"><strong>"veto
1819 files"</strong></a> and <a href="smb.conf.5.html#casesensitive"><strong>"case sensitive"</strong></a>.
1820 <p><br><strong>Default</strong>
1821 <pre>
1822
1823         No files or directories are hidden by this option (dot files are
1824         hidden by default because of the "hide dot files" option).
1825
1826 </pre>
1827
1828 <p><br><strong>Example</strong>
1829 <code>  hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/</code>
1830 <p><br>The above example is based on files that the Macintosh SMB client
1831 (DAVE) available from <a href="http://www.thursby.com"><strong>Thursby</strong></a> creates for
1832 internal use, and also still hides all files beginning with a dot.
1833 <p><br><a name="homedirmap"></a>
1834 <li><strong><strong>homedir map (G)</strong></strong>
1835 <p><br>If <a href="smb.conf.5.html#nishomedir"><strong>"nis homedir"</strong></a> is true, and
1836 <a href="smbd.8.html"><strong>smbd</strong></a> is also acting as a Win95/98 <a href="smb.conf.5.html#domainlogons"><strong>logon
1837 server</strong></a> then this parameter specifies the NIS (or YP)
1838 map from which the server for the user's home directory should be
1839 extracted.  At present, only the Sun auto.home map format is
1840 understood. The form of the map is:
1841 <p><br><code>username   server:/some/file/system</code>
1842 <p><br>and the program will extract the servername from before the first
1843 <code>':'</code>.  There should probably be a better parsing system that copes
1844 with different map formats and also Amd (another automounter) maps.
1845 <p><br>NB: A working NIS is required on the system for this option to work.
1846 <p><br>See also <a href="smb.conf.5.html#nishomedir"><strong>"nis homedir"</strong></a>, <a href="smb.conf.5.html#domainlogons"><strong>domain
1847 logons</strong></a>.
1848 <p><br><strong>Default:</strong>
1849 <code>  homedir map = auto.home</code>
1850 <p><br><strong>Example:</strong>
1851 <code>  homedir map = amd.homedir</code>
1852 <p><br><a name="hostsallow"></a>
1853 <li><strong><strong>hosts allow (S)</strong></strong>
1854 <p><br>A synonym for this parameter is <a href="smb.conf.5.html#allowhosts"><strong>'allow hosts'</strong></a>
1855 <p><br>This parameter is a comma, space, or tab delimited set of hosts which
1856 are permitted to access a service.
1857 <p><br>If specified in the <a href="smb.conf.5.html#global"><strong>[global]</strong></a> section then it will
1858 apply to all services, regardless of whether the individual service
1859 has a different setting.
1860 <p><br>You can specify the hosts by name or IP number. For example, you could
1861 restrict access to only the hosts on a Class C subnet with something
1862 like <code>"allow hosts = 150.203.5."</code>. The full syntax of the list is
1863 described in the man page <strong>hosts_access (5)</strong>. Note that this man
1864 page may not be present on your system, so a brief description will
1865 be given here also.
1866 <p><br>Note that the localhost address 127.0.0.1 will always be allowed
1867 access unless specifically denied by a "hosts deny" option.
1868 <p><br>You can also specify hosts by network/netmask pairs and by netgroup
1869 names if your system supports netgroups. The <em>EXCEPT</em> keyword can also
1870 be used to limit a wildcard list. The following examples may provide
1871 some help:
1872 <p><br><strong>Example 1</strong>: allow all IPs in 150.203.*.* except one
1873 <p><br><code>   hosts allow = 150.203. EXCEPT 150.203.6.66</code>
1874 <p><br><strong>Example 2</strong>: allow hosts that match the given network/netmask
1875 <p><br><code>   hosts allow = 150.203.15.0/255.255.255.0</code>
1876 <p><br><strong>Example 3</strong>: allow a couple of hosts
1877 <p><br><code>   hosts allow = lapland, arvidsjaur</code>
1878 <p><br><strong>Example 4</strong>: allow only hosts in NIS netgroup "foonet", but
1879 deny access from one particular host
1880 <p><br><code>   hosts allow = @foonet</code>
1881 <p><br><code>   hosts deny = pirate</code>
1882 <p><br>Note that access still requires suitable user-level passwords.
1883 <p><br>See <a href="testparm.1.html"><strong>testparm (1)</strong></a> for a way of testing your
1884 host access to see if it does what you expect.
1885 <p><br><strong>Default:</strong>
1886 <code>  none (i.e., all hosts permitted access)</code>
1887 <p><br><strong>Example:</strong>
1888 <code>  allow hosts = 150.203.5. myhost.mynet.edu.au</code>
1889 <p><br><a name="hostsdeny"></a>
1890 <li><strong><strong>hosts deny (S)</strong></strong>
1891 <p><br>The opposite of <a href="smb.conf.5.html#hostsallow"><strong>'hosts allow'</strong></a> - hosts listed
1892 here are <em>NOT</em> permitted access to services unless the specific
1893 services have their own lists to override this one. Where the lists
1894 conflict, the <a href="smb.conf.5.html#hostsallow"><strong>'allow'</strong></a> list takes precedence.
1895 <p><br><strong>Default:</strong>
1896 <code>  none (i.e., no hosts specifically excluded)</code>
1897 <p><br><strong>Example:</strong>
1898 <code>  hosts deny = 150.203.4. badhost.mynet.edu.au</code>
1899 <p><br><a name="hostsequiv"></a>
1900 <li><strong><strong>hosts equiv (G)</strong></strong>
1901 <p><br>If this global parameter is a non-null string, it specifies the name
1902 of a file to read for the names of hosts and users who will be allowed
1903 access without specifying a password.
1904 <p><br>This is not be confused with <a href="smb.conf.5.html#hostsallow"><strong>hosts allow</strong></a> which
1905 is about hosts access to services and is more useful for guest
1906 services. <strong>hosts equiv</strong> may be useful for NT clients which will not
1907 supply passwords to samba.
1908 <p><br>NOTE: The use of <strong>hosts equiv</strong> can be a major security hole. This is
1909 because you are trusting the PC to supply the correct username. It is
1910 very easy to get a PC to supply a false username. I recommend that the
1911 <strong>hosts equiv</strong> option be only used if you really know what you are
1912 doing, or perhaps on a home network where you trust your spouse and
1913 kids. And only if you <em>really</em> trust them :-).
1914 <p><br><strong>Default</strong>
1915 <code>  No host equivalences</code>
1916 <p><br><strong>Example</strong>
1917 <code>  hosts equiv = /etc/hosts.equiv</code>
1918 <p><br><a name="include"></a>
1919 <li><strong><strong>include (G)</strong></strong>
1920 <p><br>This allows you to include one config file inside another.  The file
1921 is included literally, as though typed in place.
1922 <p><br>It takes the standard substitutions, except <a href="smb.conf.5.html#percentu"><strong>%u</strong></a>,
1923 <a href="smb.conf.5.html#percentP"><strong>%P</strong></a> and <a href="smb.conf.5.html#percentS"><strong>%S</strong></a>.
1924 <p><br><a name="interfaces"></a>
1925 <li><strong><strong>interfaces (G)</strong></strong>
1926 <p><br>This option allows you to override the default network interfaces list
1927 that Samba will use for browsing, name registration and other NBT
1928 traffic. By default Samba will query the kernel for the list of all
1929 active interfaces and use any interfaces except 127.0.0.1 that are
1930 broadcast capable.
1931 <p><br>The option takes a list of interface strings. Each string can be in
1932 any of the following forms:
1933 <p><br><ul>
1934 <li > a network interface name (such as eth0). This may include
1935      shell-like wildcards so eth* will match any interface starting
1936      with the substring "eth"
1937 if() a IP address. In this case the netmask is determined
1938      from the list of interfaces obtained from the kernel
1939 if() a IP/mask pair.
1940 if() a broadcast/mask pair.
1941 </ul>
1942 <p><br>The "mask" parameters can either be a bit length (such as 24 for a C
1943 class network) or a full netmask in dotted decmal form.
1944 <p><br>The "IP" parameters above can either be a full dotted decimal IP
1945 address or a hostname which will be looked up via the OSes normal
1946 hostname resolution mechanisms.
1947 <p><br>For example, the following line:
1948 <p><br><code>interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</code>
1949 <p><br>would configure three network interfaces corresponding to the eth0
1950 device and IP addresses 192.168.2.10 and 192.168.3.10. The netmasks of
1951 the latter two interfaces would be set to 255.255.255.0.
1952 <p><br>See also <a href="smb.conf.5.html#bindinterfacesonly"><strong>"bind interfaces only"</strong></a>.
1953 <p><br><a name="invalidusers"></a>
1954 <li><strong><strong>invalid users (S)</strong></strong>
1955 <p><br>This is a list of users that should not be allowed to login to this
1956 service. This is really a <em>"paranoid"</em> check to absolutely ensure an
1957 improper setting does not breach your security.
1958 <p><br>A name starting with a <code>'@'</code> is interpreted as an NIS netgroup first
1959 (if your system supports NIS), and then as a UNIX group if the name
1960 was not found in the NIS netgroup database.
1961 <p><br>A name starting with <code>'+'</code> is interpreted only by looking in the
1962 UNIX group database. A name starting with <code>'&amp;'</code> is interpreted only
1963 by looking in the NIS netgroup database (this requires NIS to be
1964 working on your system). The characters <code>'+'</code> and <code>'&amp;'</code> may be
1965 used at the start of the name in either order so the value
1966 <code>"+&amp;group"</code> means check the UNIX group database, followed by the NIS
1967 netgroup database, and the value <code>"&amp;+group"</code> means check the NIS
1968 netgroup database, followed by the UNIX group database (the same as
1969 the <code>'@'</code> prefix).
1970 <p><br>The current servicename is substituted for
1971 <a href="smb.conf.5.html#percentS"><strong>%S</strong></a>. This is useful in the <a href="smb.conf.5.html#homes"><strong>[homes]</strong></a>
1972 section.
1973 <p><br>See also <a href="smb.conf.5.html#validusers"><strong>"valid users"</strong></a>.
1974 <p><br><strong>Default:</strong>
1975 <code>  No invalid users</code>
1976 <p><br><strong>Example:</strong>
1977 <code>  invalid users = root fred admin @wheel</code>
1978 <p><br><a name="keepalive"></a>
1979 <li><strong><strong>keepalive (G)</strong></strong>
1980 <p><br>The value of the parameter (an integer) represents the number of
1981 seconds between <strong>'keepalive'</strong> packets. If this parameter is zero, no
1982 keepalive packets will be sent. Keepalive packets, if sent, allow the
1983 server to tell whether a client is still present and responding.
1984 <p><br>Keepalives should, in general, not be needed if the socket being used
1985 has the SO_KEEPALIVE attribute set on it (see <a href="smb.conf.5.html#socketoptions"><strong>"socket
1986 options"</strong></a>). Basically you should only use this option
1987 if you strike difficulties.
1988 <p><br><strong>Default:</strong>
1989 <code>  keepalive = 0</code>
1990 <p><br><strong>Example:</strong>
1991 <code>  keepalive = 60</code>
1992 <p><br><a name="kerneloplocks"></a>
1993 <li><strong><strong>kernel oplocks (G)</strong></strong>
1994 <p><br>For UNIXs that support kernel based <a href="smb.conf.5.html#oplocks"><strong>oplocks</strong></a>
1995 (currently only IRIX but hopefully also Linux and FreeBSD soon) this
1996 parameter allows the use of them to be turned on or off.
1997 <p><br>Kernel oplocks support allows Samba <a href="smb.conf.5.html#oplocks"><strong>oplocks</strong></a> to be
1998 broken whenever a local UNIX process or NFS operation accesses a file
1999 that <a href="smbd.8.html"><strong>smbd</strong></a> has oplocked. This allows complete
2000 data consistency between SMB/CIFS, NFS and local file access (and is a
2001 <em>very</em> cool feature :-).
2002 <p><br>This parameter defaults to <em>"On"</em> on systems that have the support,
2003 and <em>"off"</em> on systems that don't. You should never need to touch
2004 this parameter.
2005 <p><br>See also the <a href="smb.conf.5.html#oplocks"><strong>"oplocks"</strong></a> and <a href="smb.conf.5.html#level2oplocks"><strong>"level2 oplocks"</strong></a>
2006 parameters.
2007 <p><br><a name="ldapfilter"></a>
2008 <li><strong><strong>ldap filter (G)</strong></strong>
2009 <p><br>This parameter is part of the <em>EXPERIMENTAL</em> Samba support for a
2010 password database stored on an LDAP server back-end. These options
2011 are only available if your version of Samba was configured with
2012 the <strong>--with-ldap</strong> option.
2013 <p><br>This parameter specifies an LDAP search filter used to search for a
2014 user name in the LDAP database. It must contain the string
2015 <a href="smb.conf.5.html#percentU"><strong>%u</strong></a> which will be replaced with the user being
2016 searched for.
2017 <p><br><strong>Default:</strong>
2018 <code>  empty string.</code>
2019 <p><br><a name="ldapport"></a>
2020 <li><strong><strong>ldap port (G)</strong></strong>
2021 <p><br>This parameter is part of the <em>EXPERIMENTAL</em> Samba support for a
2022 password database stored on an LDAP server back-end. These options
2023 are only available if your version of Samba was configured with
2024 the <strong>--with-ldap</strong> option.
2025 <p><br>This parameter specifies the TCP port number to use to contact
2026 the LDAP server on.
2027 <p><br><strong>Default:</strong>
2028 <code>  ldap port = 389.</code>
2029 <p><br><a name="ldaproot"></a>
2030 <li><strong><strong>ldap root (G)</strong></strong>
2031 <p><br>This parameter is part of the <em>EXPERIMENTAL</em> Samba support for a
2032 password database stored on an LDAP server back-end. These options
2033 are only available if your version of Samba was configured with
2034 the <strong>--with-ldap</strong> option.
2035 <p><br>This parameter specifies the entity to bind to the LDAP server
2036 as (essentially the LDAP username) in order to be able to perform
2037 queries and modifications on the LDAP database.
2038 <p><br>See also <a href="smb.conf.5.html#ldaprootpasswd"><strong>ldap root passwd</strong></a>.
2039 <p><br><strong>Default:</strong>
2040 <code>  empty string (no user defined)</code>
2041 <p><br><a name="ldaprootpasswd"></a>
2042 <li><strong><strong>ldap root passwd (G)</strong></strong>
2043 <p><br>This parameter is part of the <em>EXPERIMENTAL</em> Samba support for a
2044 password database stored on an LDAP server back-end. These options
2045 are only available if your version of Samba was configured with
2046 the <strong>--with-ldap</strong> option.
2047 <p><br>This parameter specifies the password for the entity to bind to the
2048 LDAP server as (the password for this LDAP username) in order to be
2049 able to perform queries and modifications on the LDAP database.
2050 <p><br><em>BUGS:</em> This parameter should <em>NOT</em> be a readable parameter
2051 in the <strong>smb.conf</strong> file and will be removed once a correct
2052 storage place is found.
2053 <p><br>See also <a href="smb.conf.5.html#ldaproot"><strong>ldap root</strong></a>.
2054 <p><br><strong>Default:</strong>
2055 <code>  empty string.</code>
2056 <p><br><a name="ldapserver"></a>
2057 <li><strong><strong>ldap server (G)</strong></strong>
2058 <p><br>This parameter is part of the <em>EXPERIMENTAL</em> Samba support for a
2059 password database stored on an LDAP server back-end. These options
2060 are only available if your version of Samba was configured with
2061 the <strong>--with-ldap</strong> option.
2062 <p><br>This parameter specifies the DNS name of the LDAP server to use
2063 for SMB/CIFS authentication purposes.
2064 <p><br><strong>Default:</strong>
2065 <code>  ldap server = localhost</code>
2066 <p><br><a name="ldapsuffix"></a>
2067 <li><strong><strong>ldap suffix (G)</strong></strong>
2068 <p><br>This parameter is part of the <em>EXPERIMENTAL</em> Samba support for a
2069 password database stored on an LDAP server back-end. These options
2070 are only available if your version of Samba was configured with
2071 the <strong>--with-ldap</strong> option.
2072 <p><br>This parameter specifies the <code>"dn"</code> or LDAP <em>"distinguished name"</em>
2073 that tells <a href="smbd.8.html"><strong>smbd</strong></a> to start from when searching
2074 for an entry in the LDAP password database.
2075 <p><br><strong>Default:</strong>
2076 <code>  empty string.</code>
2077 <p><br><a name="level2oplocks"></a>
2078 <li><strong><strong>level2 oplocks (S)</strong></strong>
2079 <p><br>This parameter (new in Samba 2.0.5) controls whether Samba supports
2080 level2 (read-only) oplocks on a share. In Samba 2.0.4 this parameter
2081 defaults to "False" as the code is new, but will default to "True"
2082 in a later release.
2083 <p><br>Level2, or read-only oplocks allow Windows NT clients that have an
2084 oplock on a file to downgrade from a read-write oplock to a read-only
2085 oplock once a second client opens the file (instead of releasing all
2086 oplocks on a second open, as in traditional, exclusive oplocks). This
2087 allows all openers of the file that support level2 oplocks to cache
2088 the file for read-ahead only (ie. they may not cache writes or lock
2089 requests) and increases performance for many acesses of files that
2090 are not commonly written (such as application .EXE files).
2091 <p><br>Once one of the clients which have a read-only oplock writes to
2092 the file all clients are notified (no reply is needed or waited
2093 for) and told to break their oplocks to "none" and delete any
2094 read-ahead caches.
2095 <p><br>It is recommended that this parameter be turned on to speed access
2096 to shared executables (and also to test the code :-).
2097 <p><br>For more discussions on level2 oplocks see the CIFS spec.
2098 <p><br>Currently, if <a href="smb.conf.5.html#kerneloplocks"><strong>"kernel oplocks"</strong></a> are supported
2099 then level2 oplocks are not granted (even if this parameter is set
2100 to <code>"true"</code>). Note also, the <a href="smb.conf.5.html#oplocks"><strong>"oplocks"</strong></a> parameter must
2101 be set to "true" on this share in order for this parameter to have any
2102 effect.
2103 <p><br>See also the <a href="smb.conf.5.html#oplocks"><strong>"oplocks"</strong></a> and <a href="smb.conf.5.html#kerneloplocks"><strong>"kernel oplocks"</strong></a> parameters.
2104 <p><br><strong>Default:</strong>
2105 <code> level2 oplocks = False</code>
2106 <p><br><strong>Example:</strong>
2107 <code> level2 oplocks = True</code>
2108 <p><br><a name="lmannounce"></a>
2109 <li><strong><strong>lm announce (G)</strong></strong>
2110 <p><br>This parameter determines if <a href="nmbd.8.html"><strong>nmbd</strong></a> will produce
2111 Lanman announce broadcasts that are needed by <strong>OS/2</strong> clients in order
2112 for them to see the Samba server in their browse list. This parameter
2113 can have three values, <code>"true"</code>, <code>"false"</code>, or <code>"auto"</code>. The
2114 default is <code>"auto"</code>.  If set to <code>"false"</code> Samba will never produce
2115 these broadcasts. If set to <code>"true"</code> Samba will produce Lanman
2116 announce broadcasts at a frequency set by the parameter <a href="smb.conf.5.html#lminterval"><strong>"lm
2117 interval"</strong></a>. If set to <code>"auto"</code> Samba will not send Lanman
2118 announce broadcasts by default but will listen for them. If it hears
2119 such a broadcast on the wire it will then start sending them at a
2120 frequency set by the parameter <a href="smb.conf.5.html#lminterval"><strong>"lm interval"</strong></a>.
2121 <p><br>See also <a href="smb.conf.5.html#lminterval"><strong>"lm interval"</strong></a>.
2122 <p><br><strong>Default:</strong>
2123 <code>  lm announce = auto</code>
2124 <p><br><strong>Example:</strong>
2125 <code>  lm announce = true</code>
2126 <p><br><a name="lminterval"></a>
2127 <li><strong><strong>lm interval (G)</strong></strong>
2128 <p><br>If Samba is set to produce Lanman announce broadcasts needed by
2129 <strong>OS/2</strong> clients (see the <a href="smb.conf.5.html#lmannounce"><strong>"lm announce"</strong></a>
2130 parameter) then this parameter defines the frequency in seconds with
2131 which they will be made.  If this is set to zero then no Lanman
2132 announcements will be made despite the setting of the <a href="smb.conf.5.html#lmannounce"><strong>"lm
2133 announce"</strong></a> parameter.
2134 <p><br>See also <a href="smb.conf.5.html#lmannounce"><strong>"lm announce"</strong></a>.
2135 <p><br><strong>Default:</strong>
2136 <code>  lm interval = 60</code>
2137 <p><br><strong>Example:</strong>
2138 <code>  lm interval = 120</code>
2139 <p><br><a name="loadprinters"></a>
2140 <li><strong><strong>load printers (G)</strong></strong>
2141 <p><br>A boolean variable that controls whether all printers in the printcap
2142 will be loaded for browsing by default. See the
2143 <a href="smb.conf.5.html#printers"><strong>"printers"</strong></a> section for more details.
2144 <p><br><strong>Default:</strong>
2145 <code>  load printers = yes</code>
2146 <p><br><strong>Example:</strong>
2147 <code>  load printers = no</code>
2148 <p><br><a name="localmaster"></a>
2149 <li><strong><strong>local master (G)</strong></strong>
2150 <p><br>This option allows <a href="nmbd.8.html"><strong>nmbd</strong></a> to try and become a
2151 local master browser on a subnet. If set to False then
2152 <a href="nmbd.8.html"><strong>nmbd</strong></a> will not attempt to become a local master
2153 browser on a subnet and will also lose in all browsing elections. By
2154 default this value is set to true. Setting this value to true doesn't
2155 mean that Samba will <em>become</em> the local master browser on a subnet,
2156 just that <a href="nmbd.8.html"><strong>nmbd</strong></a> will <em>participate</em> in
2157 elections for local master browser.
2158 <p><br>Setting this value to False will cause <a href="nmbd.8.html"><strong>nmbd</strong></a>
2159 <em>never</em> to become a local master browser.
2160 <p><br><strong>Default:</strong>
2161 <code>  local master = yes</code>
2162 <p><br><a name="lockdir"></a>
2163 <li><strong><strong>lock dir (G)</strong></strong>
2164 <p><br>Synonym for <a href="smb.conf.5.html#lockdirectory"><strong>"lock directory"</strong></a>.
2165 <p><br><a name="lockdirectory"></a>
2166 <li><strong><strong>lock directory (G)</strong></strong>
2167 <p><br>This option specifies the directory where lock files will be placed.
2168 The lock files are used to implement the <a href="smb.conf.5.html#maxconnections"><strong>"max
2169 connections"</strong></a> option.
2170 <p><br><strong>Default:</strong>
2171 <code>  lock directory = /tmp/samba</code>
2172 <p><br><strong>Example:</strong>
2173 <code>  lock directory = /usr/local/samba/var/locks</code>
2174 <p><br><a name="locking"></a>
2175 <li><strong><strong>locking (S)</strong></strong>
2176 <p><br>This controls whether or not locking will be performed by the server
2177 in response to lock requests from the client.
2178 <p><br>If <code>"locking = no"</code>, all lock and unlock requests will appear to
2179 succeed and all lock queries will indicate that the queried lock is
2180 clear.
2181 <p><br>If <code>"locking = yes"</code>, real locking will be performed by the server.
2182 <p><br>This option <em>may</em> be useful for read-only filesystems which <em>may</em>
2183 not need locking (such as cdrom drives), although setting this
2184 parameter of <code>"no"</code> is not really recommended even in this case.
2185 <p><br>Be careful about disabling locking either globally or in a specific
2186 service, as lack of locking may result in data corruption. You should
2187 never need to set this parameter.
2188 <p><br><strong>Default:</strong>
2189 <code>  locking = yes</code>
2190 <p><br><strong>Example:</strong>
2191 <code>  locking = no</code>
2192 <p><br><a name="logfile"></a>
2193 <li><strong><strong>log file (G)</strong></strong>
2194 <p><br>This options allows you to override the name of the Samba log file
2195 (also known as the debug file).
2196 <p><br>This option takes the standard substitutions, allowing you to have
2197 separate log files for each user or machine.
2198 <p><br><strong>Example:</strong>
2199 <code>  log file = /usr/local/samba/var/log.%m</code>
2200 <p><br><a name="loglevel"></a>
2201 <li><strong><strong>log level (G)</strong></strong>
2202 <p><br>Synonym for <a href="smb.conf.5.html#debuglevel"><strong>"debug level"</strong></a>.
2203 <p><br><a name="logondrive"></a>
2204 <li><strong><strong>logon drive (G)</strong></strong>
2205 <p><br>This parameter specifies the local path to which the home directory
2206 will be connected (see <a href="smb.conf.5.html#logonhome"><strong>"logon home"</strong></a>) and is only
2207 used by NT Workstations.
2208 <p><br>Note that this option is only useful if Samba is set up as a
2209 <a href="smb.conf.5.html#domainlogons"><strong>logon server</strong></a>.
2210 <p><br><strong>Example:</strong>
2211 <code>  logon drive = h:</code>
2212 <p><br><a name="logonhome"></a>
2213 <li><strong><strong>logon home (G)</strong></strong>
2214 <p><br>This parameter specifies the home directory location when a Win95/98 or
2215 NT Workstation logs into a Samba PDC.  It allows you to do
2216 <p><br><code>"NET USE H: /HOME"</code>
2217 <p><br>from a command prompt, for example.
2218 <p><br>This option takes the standard substitutions, allowing you to have
2219 separate logon scripts for each user or machine.
2220 <p><br>Note that this option is only useful if Samba is set up as a
2221 <a href="smb.conf.5.html#domainlogons"><strong>logon server</strong></a>.
2222 <p><br><strong>Example:</strong>
2223 <code>  logon home = "\\remote_smb_server\%U"</code>
2224 <p><br><strong>Default:</strong>
2225 <code>  logon home = "\\%N\%U"</code>
2226 <p><br><a name="logonpath"></a>
2227 <li><strong><strong>logon path (G)</strong></strong>
2228 <p><br>This parameter specifies the home directory where roaming profiles
2229 (USER.DAT / USER.MAN files for Windows 95/98) are stored.
2230 <p><br>This option takes the standard substitutions, allowing you to have
2231 separate logon scripts for each user or machine.  It also specifies
2232 the directory from which the <code>"desktop"</code>, <code>"start menu"</code>,
2233 <code>"network neighborhood"</code> and <code>"programs"</code> folders, and their
2234 contents, are loaded and displayed on your Windows 95/98 client.
2235 <p><br>The share and the path must be readable by the user for the
2236 preferences and directories to be loaded onto the Windows 95/98
2237 client.  The share must be writeable when the logs in for the first
2238 time, in order that the Windows 95/98 client can create the user.dat
2239 and other directories.
2240 <p><br>Thereafter, the directories and any of the contents can, if required, be
2241 made read-only.  It is not advisable that the USER.DAT file be made
2242 read-only - rename it to USER.MAN to achieve the desired effect (a
2243 <em>MAN</em>datory profile).
2244 <p><br>Windows clients can sometimes maintain a connection to the [homes]
2245 share, even though there is no user logged in.  Therefore, it is vital
2246 that the logon path does not include a reference to the homes share
2247 (i.e. setting this parameter to <code>\\%N\HOMES\profile_path</code> will cause
2248 problems).
2249 <p><br>This option takes the standard substitutions, allowing you to have
2250 separate logon scripts for each user or machine.
2251 <p><br>Note that this option is only useful if Samba is set up as a
2252 <a href="smb.conf.5.html#domainlogons"><strong>logon server</strong></a>.
2253 <p><br><strong>Default:</strong>
2254 <code>  logon path = \\%N\%U\profile</code>
2255 <p><br><strong>Example:</strong>
2256 <code>  logon path = \\PROFILESERVER\HOME_DIR\%U\PROFILE</code>
2257 <p><br><a name="logonscript"></a>
2258 <li><strong><strong>logon script (G)</strong></strong>
2259 <p><br>This parameter specifies the batch file (.bat) or NT command file
2260 (.cmd) to be downloaded and run on a machine when a user successfully
2261 logs in.  The file must contain the DOS style cr/lf line endings.
2262 Using a DOS-style editor to create the file is recommended.
2263 <p><br>The script must be a relative path to the <code>[netlogon]</code> service.  If
2264 the <code>[netlogon]</code> service specifies a <a href="smb.conf.5.html#path"><strong>path</strong></a> of
2265 /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the
2266 file that will be downloaded is:
2267 <p><br><code>/usr/local/samba/netlogon/STARTUP.BAT</code>
2268 <p><br>The contents of the batch file is entirely your choice.  A suggested
2269 command would be to add <code>NET TIME \\SERVER /SET /YES</code>, to force every
2270 machine to synchronize clocks with the same time server.  Another use
2271 would be to add <code>NET USE U: \\SERVER\UTILS</code> for commonly used
2272 utilities, or <code>NET USE Q: \\SERVER\ISO9001_QA</code> for example.
2273 <p><br>Note that it is particularly important not to allow write access to
2274 the <code>[netlogon]</code> share, or to grant users write permission on the
2275 batch files in a secure environment, as this would allow the batch
2276 files to be arbitrarily modified and security to be breached.
2277 <p><br>This option takes the standard substitutions, allowing you to have
2278 separate logon scripts for each user or machine.
2279 <p><br>Note that this option is only useful if Samba is set up as a
2280 <a href="smb.conf.5.html#domainlogons"><strong>logon server</strong></a>.
2281 <p><br><strong>Example:</strong>
2282 <code>  logon script = scripts\%U.bat</code>
2283 <p><br><a name="lppausecommand"></a>
2284 <li><strong><strong>lppause command (S)</strong></strong>
2285 <p><br>This parameter specifies the command to be executed on the server host
2286 in order to stop printing or spooling a specific print job.
2287 <p><br>This command should be a program or script which takes a printer name
2288 and job number to pause the print job. One way of implementing this is
2289 by using job priorities, where jobs having a too low priority won't be
2290 sent to the printer.
2291 <p><br>If a <code>"%p"</code> is given then the printername is put in its place. A
2292 <code>"%j"</code> is replaced with the job number (an integer).  On HPUX (see
2293 <a href="smb.conf.5.html#printing"><strong>printing=hpux</strong></a>), if the <code>"-p%p"</code> option is added
2294 to the lpq command, the job will show up with the correct status,
2295 i.e. if the job priority is lower than the set fence priority it will
2296 have the PAUSED status, whereas if the priority is equal or higher it
2297 will have the SPOOLED or PRINTING status.
2298 <p><br>Note that it is good practice to include the absolute path in the
2299 lppause command as the PATH may not be available to the server.
2300 <p><br>See also the <a href="smb.conf.5.html#printing"><strong>"printing"</strong></a> parameter.
2301 <p><br><strong>Default:</strong>
2302         Currently no default value is given to this string, unless the
2303 value of the <a href="smb.conf.5.html#printing"><strong>"printing"</strong></a> parameter is <code>SYSV</code>, in
2304 which case the default is :
2305 <p><br><code>   lp -i %p-%j -H hold</code>
2306 <p><br>or if the value of the <a href="smb.conf.5.html#printing"><strong>"printing"</strong></a> parameter is <code>softq</code>,
2307 then the default is:
2308 <p><br><code>   qstat -s -j%j -h</code>
2309 <p><br><strong>Example for HPUX:</strong>
2310         lppause command = /usr/bin/lpalt %p-%j -p0
2311 <p><br><a name="lpqcachetime"></a>
2312 <li><strong><strong>lpq cache time (G)</strong></strong>
2313 <p><br>This controls how long lpq info will be cached for to prevent the
2314 <strong>lpq</strong> command being called too often. A separate cache is kept for
2315 each variation of the <strong>lpq</strong> command used by the system, so if you
2316 use different <strong>lpq</strong> commands for different users then they won't
2317 share cache information.
2318 <p><br>The cache files are stored in <code>/tmp/lpq.xxxx</code> where xxxx is a hash of
2319 the <strong>lpq</strong> command in use.
2320 <p><br>The default is 10 seconds, meaning that the cached results of a
2321 previous identical <strong>lpq</strong> command will be used if the cached data is
2322 less than 10 seconds old. A large value may be advisable if your
2323 <strong>lpq</strong> command is very slow.
2324 <p><br>A value of 0 will disable caching completely.
2325 <p><br>See also the <a href="smb.conf.5.html#printing"><strong>"printing"</strong></a> parameter.
2326 <p><br><strong>Default:</strong>
2327 <code>  lpq cache time = 10</code>
2328 <p><br><strong>Example:</strong>
2329 <code>  lpq cache time = 30</code>
2330 <p><br><a name="lpqcommand"></a>
2331 <li><strong><strong>lpq command (S)</strong></strong>
2332 <p><br>This parameter specifies the command to be executed on the server host
2333 in order to obtain <code>"lpq"</code>-style printer status information.
2334 <p><br>This command should be a program or script which takes a printer name
2335 as its only parameter and outputs printer status information.
2336 <p><br>Currently eight styles of printer status information are supported;
2337 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ. This covers most UNIX
2338 systems. You control which type is expected using the
2339 <a href="smb.conf.5.html#printing"><strong>"printing ="</strong></a> option.
2340 <p><br>Some clients (notably Windows for Workgroups) may not correctly send
2341 the connection number for the printer they are requesting status
2342 information about. To get around this, the server reports on the first
2343 printer service connected to by the client. This only happens if the
2344 connection number sent is invalid.
2345 <p><br>If a <code>%p</code> is given then the printername is put in its place. Otherwise
2346 it is placed at the end of the command.
2347 <p><br>Note that it is good practice to include the absolute path in the <strong>lpq
2348 command</strong> as the PATH may not be available to the server.
2349 <p><br>See also the <a href="smb.conf.5.html#printing"><strong>"printing"</strong></a> parameter.
2350 <p><br><strong>Default:</strong>
2351 <code>        depends on the setting of printing =</code>
2352 <p><br><strong>Example:</strong>
2353 <code>  lpq command = /usr/bin/lpq %p</code>
2354 <p><br><a name="lpresumecommand"></a>
2355 <li><strong><strong>lpresume command (S)</strong></strong>
2356 <p><br>This parameter specifies the command to be executed on the server host
2357 in order to restart or continue printing or spooling a specific print
2358 job.
2359 <p><br>This command should be a program or script which takes a printer name
2360 and job number to resume the print job. See also the <a href="smb.conf.5.html#lppausecommand"><strong>"lppause
2361 command"</strong></a> parameter.
2362 <p><br>If a <code>%p</code> is given then the printername is put in its place. A
2363 <code>%j</code> is replaced with the job number (an integer).
2364 <p><br>Note that it is good practice to include the absolute path in the <strong>lpresume
2365 command</strong> as the PATH may not be available to the server.
2366 <p><br>See also the <a href="smb.conf.5.html#printing"><strong>"printing"</strong></a> parameter.
2367 <p><br><strong>Default:</strong>
2368 <p><br>Currently no default value is given to this string, unless the
2369 value of the <a href="smb.conf.5.html#printing"><strong>"printing"</strong></a> parameter is <code>SYSV</code>, in
2370 which case the default is :
2371 <p><br><code>   lp -i %p-%j -H resume</code>
2372 <p><br>or if the value of the <a href="smb.conf.5.html#printing"><strong>"printing"</strong></a> parameter is <code>softq</code>,
2373 then the default is:
2374 <p><br><code>   qstat -s -j%j -r</code>
2375 <p><br><strong>Example for HPUX:</strong>
2376 <code>        lpresume command = /usr/bin/lpalt %p-%j -p2</code>
2377 <p><br><a name="lprmcommand"></a>
2378 <li><strong><strong>lprm command (S)</strong></strong>
2379 <p><br>This parameter specifies the command to be executed on the server host
2380 in order to delete a print job.
2381 <p><br>This command should be a program or script which takes a printer name
2382 and job number, and deletes the print job.
2383 <p><br>If a <code>%p</code> is given then the printername is put in its place. A
2384 <code>%j</code> is replaced with the job number (an integer).
2385 <p><br>Note that it is good practice to include the absolute path in the
2386 <strong>lprm command</strong> as the PATH may not be available to the server.
2387 <p><br>See also the <a href="smb.conf.5.html#printing"><strong>"printing"</strong></a> parameter.
2388 <p><br><strong>Default:</strong>
2389 <code>  depends on the setting of "printing ="</code>
2390 <p><br><strong>Example 1:</strong>
2391 <code>  lprm command = /usr/bin/lprm -P%p %j</code>
2392 <p><br><strong>Example 2:</strong>
2393 <code>  lprm command = /usr/bin/cancel %p-%j</code>
2394 <p><br><a name="machinepasswordtimeout"></a>
2395 <li><strong><strong>machine password timeout (G)</strong></strong>
2396 <p><br>If a Samba server is a member of an Windows NT Domain (see the
2397 <a href="smb.conf.5.html#securityequaldomain"><strong>"security=domain"</strong></a>) parameter) then
2398 periodically a running <a href="smbd.8.html"><strong>smbd</strong></a> process will try and
2399 change the <strong>MACHINE ACCOUNT PASWORD</strong> stored in the file called
2400 <code>&lt;Domain&gt;.&lt;Machine&gt;.mac</code> where <code>&lt;Domain&gt;</code> is the name of the
2401 Domain we are a member of and <code>&lt;Machine&gt;</code> is the primary
2402 <a href="smb.conf.5.html#netbiosname"><strong>"NetBIOS name"</strong></a> of the machine
2403 <a href="smbd.8.html"><strong>smbd</strong></a> is running on. This parameter specifies how
2404 often this password will be changed, in seconds. The default is one
2405 week (expressed in seconds), the same as a Windows NT Domain member
2406 server.
2407 <p><br>See also <a href="smbpasswd.8.html"><strong>smbpasswd (8)</strong></a>, and the
2408 <a href="smb.conf.5.html#securityequaldomain"><strong>"security=domain"</strong></a>) parameter.
2409 <p><br><strong>Default:</strong>
2410 <code>  machine password timeout = 604800</code>
2411 <p><br><a name="magicoutput"></a>
2412 <li><strong><strong>magic output (S)</strong></strong>
2413 <p><br>This parameter specifies the name of a file which will contain output
2414 created by a magic script (see the <a href="smb.conf.5.html#magicscript"><strong>"magic
2415 script"</strong></a> parameter below).
2416 <p><br>Warning: If two clients use the same <a href="smb.conf.5.html#magicscript"><strong>"magic
2417 script"</strong></a> in the same directory the output file content
2418 is undefined.
2419 <p><br><strong>Default:</strong>
2420 <code>  magic output = &lt;magic script name&gt;.out</code>
2421 <p><br><strong>Example:</strong>
2422 <code>  magic output = myfile.txt</code>
2423 <p><br><a name="magicscript"></a>
2424 <li><strong><strong>magic script (S)</strong></strong>
2425 <p><br>This parameter specifies the name of a file which, if opened, will be
2426 executed by the server when the file is closed. This allows a UNIX
2427 script to be sent to the Samba host and executed on behalf of the
2428 connected user.
2429 <p><br>Scripts executed in this way will be deleted upon completion,
2430 permissions permitting.
2431 <p><br>If the script generates output, output will be sent to the file
2432 specified by the <a href="smb.conf.5.html#magicoutput"><strong>"magic output"</strong></a> parameter (see
2433 above).
2434 <p><br>Note that some shells are unable to interpret scripts containing
2435 carriage-return-linefeed instead of linefeed as the end-of-line
2436 marker. Magic scripts must be executable <em>"as is"</em> on the host,
2437 which for some hosts and some shells will require filtering at the DOS
2438 end.
2439 <p><br>Magic scripts are <em>EXPERIMENTAL</em> and should <em>NOT</em> be relied upon.
2440 <p><br><strong>Default:</strong>
2441 <code>  None. Magic scripts disabled.</code>
2442 <p><br><strong>Example:</strong>
2443 <code>  magic script = user.csh</code>
2444 <p><br><a name="manglecase"></a>
2445 <li><strong><strong>mangle case (S)</strong></strong>
2446 <p><br>See the section on <a href="smb.conf.5.html#NAMEMANGLING"><strong>"NAME MANGLING"</strong></a>.
2447 <p><br><a name="manglelocks"></a>
2448 <li><strong><strong>mangle locks (S)</strong></strong>
2449 <p><br>This option is was introduced with Samba 2.0.4 and above and has been
2450 removed in Samba 2.0.6 as Samba now dynamically configures such things
2451 on 32 bit systems.
2452 <p><br><a name="mangledmap"></a>
2453 <li><strong><strong>mangled map (S)</strong></strong>
2454 <p><br>This is for those who want to directly map UNIX file names which can
2455 not be represented on Windows/DOS.  The mangling of names is not always
2456 what is needed.  In particular you may have documents with file
2457 extensions that differ between DOS and UNIX. For example, under UNIX
2458 it is common to use <code>".html"</code> for HTML files, whereas under
2459 Windows/DOS <code>".htm"</code> is more commonly used.
2460 <p><br>So to map <code>"html"</code> to <code>"htm"</code> you would use:
2461 <p><br><code>  mangled map = (*.html *.htm)</code>
2462 <p><br>One very useful case is to remove the annoying <code>";1"</code> off the ends
2463 of filenames on some CDROMS (only visible under some UNIXs). To do
2464 this use a map of (*;1 *).
2465 <p><br><strong>default:</strong>
2466 <code>  no mangled map</code>
2467 <p><br><strong>Example:</strong>
2468 <code>  mangled map = (*;1 *)</code>
2469 <p><br><a name="manglednames"></a>
2470 <li><strong><strong>mangled names (S)</strong></strong>
2471 <p><br>This controls whether non-DOS names under UNIX should be mapped to
2472 DOS-compatible names ("mangled") and made visible, or whether non-DOS
2473 names should simply be ignored.
2474 <p><br>See the section on <a href="smb.conf.5.html#NAMEMANGLING"><strong>"NAME MANGLING"</strong></a> for details
2475 on how to control the mangling process.
2476 <p><br>If mangling is used then the mangling algorithm is as follows:
2477 <p><br><ul>
2478 <p><br><li > The first (up to) five alphanumeric characters before the
2479 rightmost dot of the filename are preserved, forced to upper case, and
2480 appear as the first (up to) five characters of the mangled name.
2481 <p><br><li > A tilde <code>"~"</code> is appended to the first part of the mangled
2482 name, followed by a two-character unique sequence, based on the
2483 original root name (i.e., the original filename minus its final
2484 extension). The final extension is included in the hash calculation
2485 only if it contains any upper case characters or is longer than three
2486 characters.
2487 <p><br>Note that the character to use may be specified using the
2488 <a href="smb.conf.5.html#manglingchar"><strong>"mangling char"</strong></a> option, if you don't like
2489 <code>'~'</code>.
2490 <p><br><li > The first three alphanumeric characters of the final extension
2491 are preserved, forced to upper case and appear as the extension of the
2492 mangled name. The final extension is defined as that part of the
2493 original filename after the rightmost dot. If there are no dots in the
2494 filename, the mangled name will have no extension (except in the case
2495 of <a href="smb.conf.5.html#hidefiles"><strong>"hidden files"</strong></a> - see below).
2496 <p><br><li > Files whose UNIX name begins with a dot will be presented as DOS
2497 hidden files. The mangled name will be created as for other filenames,
2498 but with the leading dot removed and <code>"___"</code> as its extension regardless
2499 of actual original extension (that's three underscores).
2500 <p><br></ul>
2501 <p><br>The two-digit hash value consists of upper case alphanumeric
2502 characters.
2503 <p><br>This algorithm can cause name collisions only if files in a directory
2504 share the same first five alphanumeric characters. The probability of
2505 such a clash is 1/1300.
2506 <p><br>The name mangling (if enabled) allows a file to be copied between UNIX
2507 directories from Windows/DOS while retaining the long UNIX
2508 filename. UNIX files can be renamed to a new extension from
2509 Windows/DOS and will retain the same basename. Mangled names do not
2510 change between sessions.
2511 <p><br><strong>Default:</strong>
2512 <code>  mangled names = yes</code>
2513 <p><br><strong>Example:</strong>
2514 <code>  mangled names = no</code>
2515 <p><br><a name="manglingchar"></a>
2516 <li><strong><strong>mangling char (S)</strong></strong>
2517 <p><br>This controls what character is used as the <em>"magic"</em> character in
2518 <a href="smb.conf.5.html#manglednames"><strong>name mangling</strong></a>. The default is a <code>'~'</code> but
2519 this may interfere with some software. Use this option to set it to
2520 whatever you prefer.
2521 <p><br><strong>Default:</strong>
2522 <code>  mangling char = ~</code>
2523 <p><br><strong>Example:</strong>
2524 <code>  mangling char = ^</code>
2525 <p><br><a name="mangledstack"></a>
2526 <li><strong><strong>mangled stack (G)</strong></strong>
2527 <p><br>This parameter controls the number of mangled names that should be
2528 cached in the Samba server <a href="smbd.8.html"><strong>smbd</strong></a>.
2529 <p><br>This stack is a list of recently mangled base names (extensions are
2530 only maintained if they are longer than 3 characters or contains upper
2531 case characters).
2532 <p><br>The larger this value, the more likely it is that mangled names can be
2533 successfully converted to correct long UNIX names. However, large
2534 stack sizes will slow most directory access. Smaller stacks save
2535 memory in the server (each stack element costs 256 bytes).
2536 <p><br>It is not possible to absolutely guarantee correct long file names, so
2537 be prepared for some surprises!
2538 <p><br><strong>Default:</strong>
2539 <code>  mangled stack = 50</code>
2540 <p><br><strong>Example:</strong>
2541 <code>  mangled stack = 100</code>
2542 <p><br><a name="maparchive"></a>
2543 <li><strong><strong>map archive (S)</strong></strong>
2544 <p><br>This controls whether the DOS archive attribute should be mapped to
2545 the UNIX owner execute bit.  The DOS archive bit is set when a file
2546 has been modified since its last backup.  One motivation for this
2547 option it to keep Samba/your PC from making any file it touches from
2548 becoming executable under UNIX.  This can be quite annoying for shared
2549 source code, documents, etc...
2550 <p><br>Note that this requires the <a href="smb.conf.5.html#createmask"><strong>"create mask"</strong></a>
2551 parameter to be set such that owner execute bit is not masked out
2552 (i.e. it must include 100). See the parameter <a href="smb.conf.5.html#createmask"><strong>"create
2553 mask"</strong></a> for details.
2554 <p><br><strong>Default:</strong>
2555 <code>      map archive = yes</code>
2556 <p><br><strong>Example:</strong>
2557 <code>      map archive = no</code>
2558 <p><br><a name="maphidden"></a>
2559 <li><strong><strong>map hidden (S)</strong></strong>
2560 <p><br>This controls whether DOS style hidden files should be mapped to the
2561 UNIX world execute bit.
2562 <p><br>Note that this requires the <a href="smb.conf.5.html#createmask"><strong>"create mask"</strong></a> to be
2563 set such that the world execute bit is not masked out (i.e. it must
2564 include 001). See the parameter <a href="smb.conf.5.html#createmask"><strong>"create mask"</strong></a>
2565 for details.
2566 <p><br><strong>Default:</strong>
2567 <code>  map hidden = no</code>
2568 <p><br><strong>Example:</strong>
2569 <code>  map hidden = yes</code>
2570 <p><br><a name="mapsystem"></a>
2571 <li><strong><strong>map system (S)</strong></strong>
2572 <p><br>This controls whether DOS style system files should be mapped to the
2573 UNIX group execute bit.
2574 <p><br>Note that this requires the <a href="smb.conf.5.html#createmask"><strong>"create mask"</strong></a> to be
2575 set such that the group execute bit is not masked out (i.e. it must
2576 include 010). See the parameter <a href="smb.conf.5.html#createmask"><strong>"create mask"</strong></a>
2577 for details.
2578 <p><br><strong>Default:</strong>
2579 <code>  map system = no</code>
2580 <p><br><strong>Example:</strong>
2581 <code>  map system = yes</code>
2582 <p><br><a name="maptoguest"></a>
2583 <li><strong><strong>map to guest (G)</strong></strong>
2584 <p><br>This parameter is only useful in <a href="smb.conf.5.html#security"><strong>security</strong></a> modes
2585 other than <a href="smb.conf.5.html#securityequalshare"><strong>"security=share"</strong></a> - i.e. user,
2586 server, and domain.
2587 <p><br>This parameter can take three different values, which tell
2588 <a href="smbd.8.html"><strong>smbd</strong></a> what to do with user login requests that
2589 don't match a valid UNIX user in some way.
2590 <p><br>The three settings are :
2591 <p><br><ul>
2592 <p><br><li > <strong>"Never"</strong> - Means user login requests with an invalid password
2593 are rejected. This is the default.
2594 <p><br><li > <strong>"Bad User"</strong> - Means user logins with an invalid password are
2595 rejected, unless the username does not exist, in which case it is
2596 treated as a guest login and mapped into the <a href="smb.conf.5.html#guestaccount"><strong>"guest
2597 account"</strong></a>.
2598 <p><br><li > <strong>"Bad Password"</strong> - Means user logins with an invalid
2599 password are treated as a guest login and mapped into the
2600 <a href="smb.conf.5.html#guestaccount"><strong>"guest account"</strong></a>. Note that this can
2601 cause problems as it means that any user incorrectly typing their
2602 password will be silently logged on a <strong>"guest"</strong> - and
2603 will not know the reason they cannot access files they think
2604 they should - there will have been no message given to them
2605 that they got their password wrong. Helpdesk services will
2606 <em>*hate*</em> you if you set the <strong>"map to guest"</strong> parameter
2607 this way :-).
2608 <p><br></ul>
2609 <p><br>Note that this parameter is needed to set up <strong>"Guest"</strong> share
2610 services when using <a href="smb.conf.5.html#security"><strong>security</strong></a> modes other than
2611 share. This is because in these modes the name of the resource being
2612 requested is <em>*not*</em> sent to the server until after the server has
2613 successfully authenticated the client so the server cannot make
2614 authentication decisions at the correct time (connection to the
2615 share) for <strong>"Guest"</strong> shares.
2616 <p><br>For people familiar with the older Samba releases, this parameter
2617 maps to the old compile-time setting of the GUEST_SESSSETUP value
2618 in local.h.
2619 <p><br><strong>Default:</strong>
2620 <code>  map to guest = Never</code>
2621   <strong>Example</strong>:
2622 <code>  map to guest = Bad User</code>
2623 <p><br><a name="maxconnections"></a>
2624 <li><strong><strong>max connections (S)</strong></strong>
2625 <p><br>This option allows the number of simultaneous connections to a service
2626 to be limited. If <strong>"max connections"</strong> is greater than 0 then
2627 connections will be refused if this number of connections to the
2628 service are already open. A value of zero mean an unlimited number of
2629 connections may be made.
2630 <p><br>Record lock files are used to implement this feature. The lock files
2631 will be stored in the directory specified by the <a href="smb.conf.5.html#lockdirectory"><strong>"lock
2632 directory"</strong></a> option.
2633 <p><br><strong>Default:</strong>
2634 <code>  max connections = 0</code>
2635 <p><br><strong>Example:</strong>
2636 <code>  max connections = 10</code>
2637 <p><br><a name="maxdisksize"></a>
2638 <li><strong><strong>max disk size (G)</strong></strong>
2639 <p><br>This option allows you to put an upper limit on the apparent size of
2640 disks. If you set this option to 100 then all shares will appear to be
2641 not larger than 100 MB in size.
2642 <p><br>Note that this option does not limit the amount of data you can put on
2643 the disk. In the above case you could still store much more than 100
2644 MB on the disk, but if a client ever asks for the amount of free disk
2645 space or the total disk size then the result will be bounded by the
2646 amount specified in <strong>"max disk size"</strong>.
2647 <p><br>This option is primarily useful to work around bugs in some pieces of
2648 software that can't handle very large disks, particularly disks over
2649 1GB in size.
2650 <p><br>A <strong>"max disk size"</strong> of 0 means no limit.
2651 <p><br><strong>Default:</strong>
2652 <code>  max disk size = 0</code>
2653 <p><br><strong>Example:</strong>
2654 <code>  max disk size = 1000</code>
2655 <p><br><a name="maxlogsize"></a>
2656 <li><strong><strong>max log size (G)</strong></strong>
2657 <p><br>This option (an integer in kilobytes) specifies the max size the log
2658 file should grow to. Samba periodically checks the size and if it is
2659 exceeded it will rename the file, adding a <code>".old"</code> extension.
2660 <p><br>A size of 0 means no limit.
2661 <p><br><strong>Default:</strong>
2662 <code>  max log size = 5000</code>
2663 <p><br><strong>Example:</strong>
2664 <code>  max log size = 1000</code>
2665 <p><br><a name="maxmux"></a>
2666 <li><strong><strong>max mux (G)</strong></strong>
2667 <p><br>This option controls the maximum number of outstanding simultaneous
2668 SMB operations that samba tells the client it will allow. You should
2669 never need to set this parameter.
2670 <p><br><strong>Default:</strong>
2671 <code>  max mux = 50</code>
2672 <p><br><a name="maxopenfiles"></a>
2673 <li><strong><strong>max open files (G)</strong></strong>
2674 <p><br>This parameter limits the maximum number of open files that one
2675 <a href="smbd.8.html"><strong>smbd</strong></a> file serving process may have open for
2676 a client at any one time. The default for this parameter is set
2677 very high (10,000) as Samba uses only one bit per unopened file.
2678 <p><br>The limit of the number of open files is usually set by the
2679 UNIX per-process file descriptor limit rather than this parameter
2680 so you should never need to touch this parameter.
2681 <p><br><strong>Default:</strong>
2682 <code>  max open files = 10000</code>
2683 <p><br><a name="maxpacket"></a>
2684 <li><strong><strong>max packet (G)</strong></strong>
2685 <p><br>Synonym for <a name="<strong>"packetsize"</strong>"></a>(packetsize).
2686 <p><br><a name="maxttl"></a>
2687 <li><strong><strong>max ttl (G)</strong></strong>
2688 <p><br>This option tells <a href="nmbd.8.html"><strong>nmbd</strong></a> what the default 'time
2689 to live' of NetBIOS names should be (in seconds) when
2690 <a href="nmbd.8.html"><strong>nmbd</strong></a> is requesting a name using either a
2691 broadcast packet or from a WINS server. You should never need to
2692 change this parameter. The default is 3 days.
2693 <p><br><strong>Default:</strong>
2694 <code>  max ttl = 259200</code>
2695 <p><br><a name="maxwinsttl"></a>
2696 <li><strong><strong>max wins ttl (G)</strong></strong>
2697 <p><br>This option tells <a href="nmbd.8.html"><strong>nmbd</strong></a> when acting as a WINS
2698 server <a href="smb.conf.5.html#winssupport"><strong>(wins support =true)</strong></a> what the maximum
2699 'time to live' of NetBIOS names that <a href="nmbd.8.html"><strong>nmbd</strong></a> will
2700 grant will be (in seconds). You should never need to change this
2701 parameter.  The default is 6 days (518400 seconds).
2702 <p><br>See also the <a href="smb.conf.5.html#minwinsttl"><strong>"min wins ttl"</strong></a> parameter.
2703 <p><br><strong>Default:</strong>
2704 <code>        max wins ttl = 518400</code>
2705 <p><br><a name="maxxmit"></a>
2706 <li><strong><strong>max xmit (G)</strong></strong>
2707 <p><br>This option controls the maximum packet size that will be negotiated
2708 by Samba. The default is 65535, which is the maximum. In some cases
2709 you may find you get better performance with a smaller value. A value
2710 below 2048 is likely to cause problems.
2711 <p><br><strong>Default:</strong>
2712 <code>  max xmit = 65535</code>
2713 <p><br><strong>Example:</strong>
2714 <code>  max xmit = 8192</code>
2715 <p><br><a name="messagecommand"></a>
2716 <li><strong><strong>message command (G)</strong></strong>
2717 <p><br>This specifies what command to run when the server receives a WinPopup
2718 style message.
2719 <p><br>This would normally be a command that would deliver the message
2720 somehow. How this is to be done is up to your imagination.
2721 <p><br>An example is:
2722 <p><br><code>   message command = csh -c 'xedit %s;rm %s' &amp;</code>
2723 <p><br>This delivers the message using <strong>xedit</strong>, then removes it
2724 afterwards. <em>NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
2725 IMMEDIATELY</em>. That's why I have the <code>'&amp;'</code> on the end. If it doesn't
2726 return immediately then your PCs may freeze when sending messages
2727 (they should recover after 30secs, hopefully).
2728 <p><br>All messages are delivered as the global guest user. The command takes
2729 the standard substitutions, although <a href="smb.conf.5.html#percentu"><strong>%u</strong></a> won't work
2730 (<a href="smb.conf.5.html#percentU"><strong>%U</strong></a> may be better in this case).
2731 <p><br>Apart from the standard substitutions, some additional ones apply. In
2732 particular:
2733 <p><br><ul>
2734 <p><br><li > <code>"%s"</code> = the filename containing the message.
2735 <p><br><li > <code>"%t"</code> = the destination that the message was sent to (probably the server
2736 name).
2737 <p><br><li > <code>"%f"</code> = who the message is from.
2738 <p><br></ul>
2739 <p><br>You could make this command send mail, or whatever else takes your
2740 fancy. Please let us know of any really interesting ideas you have.
2741 <p><br>Here's a way of sending the messages as mail to root:
2742 <p><br><code>message command = /bin/mail -s 'message from %f on %m' root &lt; %s; rm %s</code>
2743 <p><br>If you don't have a message command then the message won't be
2744 delivered and Samba will tell the sender there was an
2745 error. Unfortunately WfWg totally ignores the error code and carries
2746 on regardless, saying that the message was delivered.
2747 <p><br>If you want to silently delete it then try:
2748 <p><br><code>"message command = rm %s"</code>.
2749 <p><br><strong>Default:</strong>
2750 <code>  no message command</code>
2751 <p><br><strong>Example:</strong>
2752 <code>        message command = csh -c 'xedit %s;rm %s' &amp;</code>
2753 <p><br><a name="minprintspace"></a>
2754 <li><strong><strong>min print space (S)</strong></strong>
2755 <p><br>This sets the minimum amount of free disk space that must be available
2756 before a user will be able to spool a print job. It is specified in
2757 kilobytes. The default is 0, which means a user can always spool a print
2758 job.
2759 <p><br>See also the <a href="smb.conf.5.html#printing"><strong>printing</strong></a> parameter.
2760 <p><br><strong>Default:</strong>
2761 <code>  min print space = 0</code>
2762 <p><br><strong>Example:</strong>
2763 <code>  min print space = 2000</code>
2764 <p><br><a name="minpasswdlength"></a>
2765 <li><strong><strong>min passwd length (G)</strong></strong>
2766 <p><br>This option sets the minimum length in characters of a plaintext password
2767 than smbd will accept when performing UNIX password changing.
2768 <p><br>See also <a href="smb.conf.5.html#unixpasswordsync"><strong>"unix password sync"</strong></a>,
2769 <a href="smb.conf.5.html#passwdprogram"><strong>"passwd program"</strong></a> and <a href="smb.conf.5.html#passwdchatdebug"><strong>"passwd chat
2770 debug"</strong></a>.
2771 <p><br><strong>Default:</strong>
2772 <code>  min passwd length = 5</code>
2773 <p><br><a name="minwinsttl"></a>
2774 <li><strong><strong>min wins ttl (G)</strong></strong>
2775 <p><br>This option tells <a href="nmbd.8.html"><strong>nmbd</strong></a> when acting as a WINS
2776 server <a href="smb.conf.5.html#winssupport"><strong>(wins support = true)</strong></a> what the minimum
2777 'time to live' of NetBIOS names that <a href="nmbd.8.html"><strong>nmbd</strong></a> will
2778 grant will be (in seconds). You should never need to change this
2779 parameter.  The default is 6 hours (21600 seconds).
2780 <p><br><strong>Default:</strong>
2781 <code>  min wins ttl = 21600</code>
2782 <p><br><a name="nameresolveorder"></a>
2783 <li><strong><strong>name resolve order (G)</strong></strong>
2784 <p><br>This option is used by the programs in the Samba suite to determine
2785 what naming services and in what order to resolve host names to IP
2786 addresses. The option takes a space separated string of different name
2787 resolution options.
2788 <p><br>The options are :"lmhosts", "host", "wins" and "bcast". They cause
2789 names to be resolved as follows :
2790 <p><br><ul>
2791 <p><br><li > <strong>lmhosts</strong> : Lookup an IP address in the Samba lmhosts file.
2792 If the line in lmhosts has no name type attached to the NetBIOS
2793 name (see the <a href="lmhosts.5.html"><strong>lmhosts (5)</strong></a> for details) then
2794 any name type matches for lookup.
2795 <p><br><li > <strong>host</strong> : Do a standard host name to IP address resolution,
2796 using the system /etc/hosts, NIS, or DNS lookups. This method of name
2797 resolution is operating system depended for instance on IRIX or
2798 Solaris this may be controlled by the <em>/etc/nsswitch.conf</em> file).
2799 Note that this method is only used if the NetBIOS name type being
2800 queried is the 0x20 (server) name type, otherwise it is ignored.
2801 <p><br><li > <strong>wins</strong> : Query a name with the IP address listed in the
2802 <a href="smb.conf.5.html#winsserver"><strong>wins server</strong></a> parameter. If no WINS server has
2803 been specified this method will be ignored.
2804 <p><br><li > <strong>bcast</strong> : Do a broadcast on each of the known local interfaces
2805 listed in the <a href="smb.conf.5.html#interfaces"><strong>interfaces</strong></a> parameter. This is the
2806 least reliable of the name resolution methods as it depends on the
2807 target host being on a locally connected subnet.
2808 <p><br></ul>
2809 <p><br><strong>Default:</strong>
2810 <code>  name resolve order = lmhosts host wins bcast</code>
2811 <p><br><strong>Example:</strong>
2812 <code>  name resolve order = lmhosts bcast host</code>
2813 <p><br>This will cause the local lmhosts file to be examined first, followed
2814 by a broadcast attempt, followed by a normal system hostname lookup.
2815 <p><br><a name="netbiosaliases"></a>
2816 <li><strong><strong>netbios aliases (G)</strong></strong>
2817 <p><br>This is a list of NetBIOS names that <a href="nmbd.8.html"><strong>nmbd</strong></a> will
2818 advertise as additional names by which the Samba server is known. This
2819 allows one machine to appear in browse lists under multiple names. If
2820 a machine is acting as a <a href="smb.conf.5.html#localmaster"><strong>browse server</strong></a> or
2821 <a href="smb.conf.5.html#domainlogons"><strong>logon server</strong></a> none of these names will be
2822 advertised as either browse server or logon servers, only the primary
2823 name of the machine will be advertised with these capabilities.
2824 <p><br>See also <a href="smb.conf.5.html#netbiosname"><strong>"netbios name"</strong></a>.
2825 <p><br><strong>Default:</strong>
2826 <code>  empty string (no additional names)</code>
2827 <p><br><strong>Example:</strong>
2828 <code>  netbios aliases = TEST TEST1 TEST2</code>
2829 <p><br><a name="netbiosname"></a>
2830 <li><strong><strong>netbios name (G)</strong></strong>
2831 <p><br>This sets the NetBIOS name by which a Samba server is known. By
2832 default it is the same as the first component of the host's DNS name.
2833 If a machine is a <a href="smb.conf.5.html#localmaster"><strong>browse server</strong></a> or
2834 <a href="smb.conf.5.html#domainlogons"><strong>logon server</strong></a> this name (or the first component
2835 of the hosts DNS name) will be the name that these services are
2836 advertised under.
2837 <p><br>See also <a href="smb.conf.5.html#netbiosaliases"><strong>"netbios aliases"</strong></a>.
2838 <p><br><strong>Default:</strong>
2839 <code>  Machine DNS name.</code>
2840 <p><br><strong>Example:</strong>
2841 <code>  netbios name = MYNAME</code>
2842 <p><br><a name="nishomedir"></a>
2843 <li><strong><strong>nis homedir (G)</strong></strong>
2844 <p><br>Get the home share server from a NIS map. For UNIX systems that use an
2845 automounter, the user's home directory will often be mounted on a
2846 workstation on demand from a remote server.
2847 <p><br>When the Samba logon server is not the actual home directory server,
2848 but is mounting the home directories via NFS then two network hops
2849 would be required to access the users home directory if the logon
2850 server told the client to use itself as the SMB server for home
2851 directories (one over SMB and one over NFS). This can be very
2852 slow.
2853 <p><br>This option allows Samba to return the home share as being on a
2854 different server to the logon server and as long as a Samba daemon is
2855 running on the home directory server, it will be mounted on the Samba
2856 client directly from the directory server. When Samba is returning the
2857 home share to the client, it will consult the NIS map specified in
2858 <a href="smb.conf.5.html#homedirmap"><strong>"homedir map"</strong></a> and return the server listed
2859 there.
2860 <p><br>Note that for this option to work there must be a working NIS
2861 system and the Samba server with this option must also be a
2862 <a href="smb.conf.5.html#domainlogons"><strong>logon server</strong></a>.
2863 <p><br><strong>Default:</strong>
2864 <code>  nis homedir = false</code>
2865 <p><br><strong>Example:</strong>
2866 <code>  nis homedir = true</code>
2867 <p><br><a name="ntaclsupport"></a>
2868 <li><strong><strong>nt acl support (G)</strong></strong>
2869 <p><br>This boolean parameter controls whether <a href="smbd.8.html"><strong>smbd</strong></a>
2870 will attempt to map UNIX permissions into Windows NT access control lists.
2871 <p><br><strong>Default:</strong>
2872 <code>  nt acl support = yes</code>
2873 <p><br><strong>Example:</strong>
2874 <code>  nt acl support = no</code>
2875 <p><br><a name="ntpipesupport"></a>
2876 <li><strong><strong>nt pipe support (G)</strong></strong>
2877 <p><br>This boolean parameter controls whether <a href="smbd.8.html"><strong>smbd</strong></a>
2878 will allow Windows NT clients to connect to the NT SMB specific
2879 <code>IPC$</code> pipes. This is a developer debugging option and can be left
2880 alone.
2881 <p><br><strong>Default:</strong>
2882 <code>  nt pipe support = yes</code>
2883 <p><br><a name="ntsmbsupport"></a>
2884 <li><strong><strong>nt smb support (G)</strong></strong>
2885 <p><br>This boolean parameter controls whether <a href="smbd.8.html"><strong>smbd</strong></a>
2886 will negotiate NT specific SMB support with Windows NT
2887 clients. Although this is a developer debugging option and should be
2888 left alone, benchmarking has discovered that Windows NT clients give
2889 faster performance with this option set to <code>"no"</code>. This is still
2890 being investigated. If this option is set to <code>"no"</code> then Samba
2891 offers exactly the same SMB calls that versions prior to Samba2.0
2892 offered. This information may be of use if any users are having
2893 problems with NT SMB support.
2894 <p><br><strong>Default:</strong>
2895 <code>  nt support = yes</code>
2896 <p><br><a name="nullpasswords"></a>
2897 <li><strong><strong>null passwords (G)</strong></strong>
2898 <p><br>Allow or disallow client access to accounts that have null passwords.
2899 <p><br>See also <a href="smbpasswd.5.html"><strong>smbpasswd (5)</strong></a>.
2900 <p><br><strong>Default:</strong>
2901 <code>  null passwords = no</code>
2902 <p><br><strong>Example:</strong>
2903 <code>  null passwords = yes</code>
2904 <p><br><a name="olelockingcompatibility"></a>
2905 <li><strong><strong>ole locking compatibility (G)</strong></strong>
2906 <p><br>This parameter allows an administrator to turn off the byte range lock
2907 manipulation that is done within Samba to give compatibility for OLE
2908 applications. Windows OLE applications use byte range locking as a
2909 form of inter-process communication, by locking ranges of bytes around
2910 the 2^32 region of a file range. This can cause certain UNIX lock
2911 managers to crash or otherwise cause problems. Setting this parameter
2912 to <code>"no"</code> means you trust your UNIX lock manager to handle such cases
2913 correctly.
2914 <p><br><strong>Default:</strong>
2915 <code>  ole locking compatibility = yes</code>
2916 <p><br><strong>Example:</strong>
2917 <code>  ole locking compatibility = no</code>
2918 <p><br><a name="onlyguest"></a>
2919 <li><strong><strong>only guest (S)</strong></strong>
2920 <p><br>A synonym for <a href="smb.conf.5.html#guestonly"><strong>"guest only"</strong></a>.
2921 <p><br><a name="onlyuser"></a>
2922 <li><strong><strong>only user (S)</strong></strong>
2923 <p><br>This is a boolean option that controls whether connections with
2924 usernames not in the <a href="smb.conf.5.html#user"><strong>user=</strong></a> list will be allowed. By
2925 default this option is disabled so a client can supply a username to
2926 be used by the server.
2927 <p><br>Note that this also means Samba won't try to deduce usernames from the
2928 service name. This can be annoying for the <a href="smb.conf.5.html#homes"><strong>[homes]</strong></a>
2929 section. To get around this you could use "<a href="smb.conf.5.html#user"><strong>user</strong></a> =
2930 <a href="smb.conf.5.html#percentS"><strong>%S</strong></a>" which means your <a href="smb.conf.5.html#user"><strong>"user"</strong></a> list
2931 will be just the service name, which for home directories is the name
2932 of the user.
2933 <p><br>See also the <a href="smb.conf.5.html#user"><strong>user</strong></a> parameter.
2934 <p><br><strong>Default:</strong>
2935 <code>  only user = False</code>
2936 <p><br><strong>Example:</strong>
2937 <code>  only user = True</code>
2938 <p><br><a name="oplocks"></a>
2939 <li><strong><strong>oplocks (S)</strong></strong>
2940 <p><br>This boolean option tells smbd whether to issue oplocks (opportunistic
2941 locks) to file open requests on this share. The oplock code can
2942 dramatically (approx. 30% or more) improve the speed of access to files
2943 on Samba servers. It allows the clients to aggressively cache files
2944 locally and you may want to disable this option for unreliable network
2945 environments (it is turned on by default in Windows NT Servers).  For
2946 more information see the file Speed.txt in the Samba docs/ directory.
2947 <p><br>Oplocks may be selectively turned off on certain files on a per share basis.
2948 See the 'veto oplock files' parameter. On some systems oplocks are recognized
2949 by the underlying operating system. This allows data synchronization between
2950 all access to oplocked files, whether it be via Samba or NFS or a local
2951 UNIX process. See the <a href="smb.conf.5.html#kerneloplocks"><strong>kernel oplocks</strong></a> parameter
2952 for details.
2953 <p><br>See also the <a href="smb.conf.5.html#kerneloplocks"><strong>"kernel oplocks"</strong></a> and
2954 <a href="smb.conf.5.html#level2oplocks"><strong>"level2 oplocks"</strong></a> parameters.
2955 <p><br><strong>Default:</strong>
2956 <code>  oplocks = True</code>
2957 <p><br><strong>Example:</strong>
2958 <code>  oplocks = False</code>
2959 <p><br><a name="oplockbreakwaittime"></a>
2960 <li><strong><strong>oplock break wait time (G)</strong></strong>
2961 <p><br>This is a tuning parameter added due to bugs in both Windows 9x and WinNT.
2962 If Samba responds to a client too quickly when that client issues an SMB that
2963 can cause an oplock break request, then the client redirector can fail and
2964 not respond to the break request. This tuning parameter (which is set in
2965 milliseconds) is the amount of time Samba will wait before sending an
2966 oplock break request to such (broken) clients.
2967 <p><br><em>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA
2968 OPLOCK CODE</em>.
2969 <p><br><strong>Default:</strong>
2970 <code>  oplock break wait time = 10</code>
2971 <p><br><a name="oplockcontentionlimit"></a>
2972 <li><strong><strong>oplock contention limit (S)</strong></strong>
2973 <p><br>This is a <em>very</em> advanced <a href="smbd.8.html"><strong>smbd</strong></a> tuning option to improve
2974 the efficiency of the granting of oplocks under multiple client contention for the same file.
2975 <p><br>In brief it specifies a number, which causes smbd not to grant an oplock even
2976 when requested if the approximate number of clients contending for an oplock on
2977 the same file goes over this limit. This causes <a href="smbd.8.html"><strong>smbd</strong></a> to
2978 behave in a similar way to Windows NT.
2979 <p><br><em>DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA
2980 OPLOCK CODE</em>.
2981 <p><br><strong>Default:</strong>
2982 <code> oplock contention limit = 2</code>
2983 <p><br><a name="oslevel"></a>
2984 <li><strong><strong>os level (G)</strong></strong>
2985 <p><br>This integer value controls what level Samba advertises itself as for
2986 browse elections. The value of this parameter determines whether
2987 <a href="nmbd.8.html"><strong>nmbd</strong></a> has a chance of becoming a local master
2988 browser for the <a href="smb.conf.5.html#workgroup"><strong>WORKGROUP</strong></a> in the local broadcast
2989 area. The default is zero, which means <a href="nmbd.8.html"><strong>nmbd</strong></a> will
2990 lose elections to Windows machines. See BROWSING.txt in the Samba
2991 docs/ directory for details.
2992 <p><br><strong>Default:</strong>
2993 <code>  os level = 20</code>
2994 <p><br><strong>Example:</strong>
2995 <code>  os level = 65    ; This will win against any NT Server</code>
2996 <p><br><a name="packetsize"></a>
2997 <li><strong><strong>packet size (G)</strong></strong>
2998 <p><br>This is a deprecated parameter that how no effect on the current
2999 Samba code. It is left in the parameter list to prevent breaking
3000 old <strong>smb.conf</strong> files.
3001 <p><br><a name="panicaction"></a>
3002 <li><strong><strong>panic action (G)</strong></strong>
3003 <p><br>This is a Samba developer option that allows a system command to be
3004 called when either <a href="smbd.8.html"><strong>smbd</strong></a> or
3005 <a href="nmbd.8.html"><strong>nmbd</strong></a> crashes. This is usually used to draw
3006 attention to the fact that a problem occurred.
3007 <p><br><strong>Default:</strong>
3008 <code>  panic action = &lt;empty string&gt;</code>
3009 <p><br><a name="passwdchat"></a>
3010 <li><strong><strong>passwd chat (G)</strong></strong>
3011 <p><br>This string controls the <em>"chat"</em> conversation that takes places
3012 between <a href="smbd.8.html"><strong>smbd</strong></a> and the local password changing
3013 program to change the users password. The string describes a sequence
3014 of response-receive pairs that <a href="smbd.8.html"><strong>smbd</strong></a> uses to
3015 determine what to send to the <a href="smb.conf.5.html#passwdprogram"><strong>passwd</strong></a> program
3016 and what to expect back. If the expected output is not received then
3017 the password is not changed.
3018 <p><br>This chat sequence is often quite site specific, depending on what
3019 local methods are used for password control (such as NIS etc).
3020 <p><br>The string can contain the macros <code>"%o"</code> and <code>"%n"</code> which are
3021 substituted for the old and new passwords respectively. It can also
3022 contain the standard macros <code>"\n"</code>, <code>"\r"</code>, <code>"\t"</code> and <code>"\s"</code>
3023 to give line-feed, carriage-return, tab and space.
3024 <p><br>The string can also contain a <code>'*'</code> which matches any sequence of
3025 characters.
3026 <p><br>Double quotes can be used to collect strings with spaces in them into
3027 a single string.
3028 <p><br>If the send string in any part of the chat sequence is a fullstop
3029 <code>"."</code>  then no string is sent. Similarly, is the expect string is a
3030 fullstop then no string is expected.
3031 <p><br>Note that if the <a href="smb.conf.5.html#unixpasswordsync"><strong>"unix password sync"</strong></a>
3032 parameter is set to true, then this sequence is called <em>*AS ROOT*</em>
3033 when the SMB password in the smbpasswd file is being changed, without
3034 access to the old password cleartext. In this case the old password
3035 cleartext is set to <code>""</code> (the empty string).
3036 <p><br>See also <a href="smb.conf.5.html#unixpasswordsync"><strong>"unix password sync"</strong></a>,
3037 <a href="smb.conf.5.html#passwdprogram"><strong>"passwd program"</strong></a> and <a href="smb.conf.5.html#passwdchatdebug"><strong>"passwd chat
3038 debug"</strong></a>.
3039 <p><br><strong>Example:</strong>
3040 <pre>
3041  passwd chat = "*Enter OLD password*" %o\n "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password changed*"
3042
3043 </pre>
3044
3045 <p><br><strong>Default:</strong>
3046 <pre>
3047        passwd chat = *old*password* %o\n *new*password* %n\n *new*password* %n\n *changed*
3048 </pre>
3049
3050 <p><br><a name="passwdchatdebug"></a>
3051 <li><strong><strong>passwd chat debug (G)</strong></strong>
3052 <p><br>This boolean specifies if the passwd chat script parameter is run in
3053 <code>"debug"</code> mode. In this mode the strings passed to and received from
3054 the passwd chat are printed in the <a href="smbd.8.html"><strong>smbd</strong></a> log with
3055 a <a href="smb.conf.5.html#debuglevel"><strong>"debug level"</strong></a> of 100. This is a dangerous
3056 option as it will allow plaintext passwords to be seen in the
3057 <a href="smbd.8.html"><strong>smbd</strong></a> log. It is available to help Samba admins
3058 debug their <a href="smb.conf.5.html#passwdchat"><strong>"passwd chat"</strong></a> scripts when calling
3059 the <a href="smb.conf.5.html#passwdprogram"><strong>"passwd program"</strong></a> and should be turned off
3060 after this has been done. This parameter is off by default.
3061 <p><br>See also <a href="smb.conf.5.html#passwdchat"><strong>"passwd chat"</strong></a>, <a href="smb.conf.5.html#passwdprogram"><strong>"passwd
3062 program"</strong></a>.
3063 <p><br><strong>Example:</strong>
3064 <code>     passwd chat debug = True</code>
3065 <p><br><strong>Default:</strong>
3066 <code>     passwd chat debug = False</code>
3067 <p><br><a name="passwdprogram"></a>
3068 <li><strong><strong>passwd program (G)</strong></strong>
3069 <p><br>The name of a program that can be used to set UNIX user passwords.
3070 Any occurrences of <a href="smb.conf.5.html#percentu"><strong>%u</strong></a> will be replaced with the
3071 user name. The user name is checked for existence before calling the
3072 password changing program.
3073 <p><br>Also note that many passwd programs insist in <em>"reasonable"</em>
3074 passwords, such as a minimum length, or the inclusion of mixed case
3075 chars and digits. This can pose a problem as some clients (such as
3076 Windows for Workgroups) uppercase the password before sending it.
3077 <p><br><em>Note</em> that if the <a href="smb.conf.5.html#unixpasswordsync"><strong>"unix password sync"</strong></a>
3078 parameter is set to <code>"True"</code> then this program is called <em>*AS
3079 ROOT*</em> before the SMB password in the
3080 <a href="smbpasswd.5.html"><strong>smbpasswd</strong></a> file is changed. If this UNIX
3081 password change fails, then <a href="smbd.8.html"><strong>smbd</strong></a> will fail to
3082 change the SMB password also (this is by design).
3083 <p><br>If the <a href="smb.conf.5.html#unixpasswordsync"><strong>"unix password sync"</strong></a> parameter is
3084 set this parameter <em>MUST USE ABSOLUTE PATHS</em> for <em>ALL</em> programs
3085 called, and must be examined for security implications. Note that by
3086 default <a href="smb.conf.5.html#unixpasswordsync"><strong>"unix password sync"</strong></a> is set to
3087 <code>"False"</code>.
3088 <p><br>See also <a href="smb.conf.5.html#unixpasswordsync"><strong>"unix password sync"</strong></a>.
3089 <p><br><strong>Default:</strong>
3090 <code>  passwd program = /bin/passwd</code>
3091 <p><br><strong>Example:</strong>
3092 <code>  passwd program = /sbin/passwd %u</code>
3093 <p><br><a name="passwordlevel"></a>
3094 <li><strong><strong>password level (G)</strong></strong>
3095 <p><br>Some client/server combinations have difficulty with mixed-case
3096 passwords.  One offending client is Windows for Workgroups, which for
3097 some reason forces passwords to upper case when using the LANMAN1
3098 protocol, but leaves them alone when using COREPLUS!
3099 <p><br>This parameter defines the maximum number of characters that may be
3100 upper case in passwords.
3101 <p><br>For example, say the password given was <code>"FRED"</code>. If <strong>password
3102 level</strong> is set to 1, the following combinations would be tried if
3103 <code>"FRED"</code> failed:
3104 <p><br><code>"Fred"</code>, <code>"fred"</code>, <code>"fRed"</code>, <code>"frEd"</code>, <code>"freD"</code>
3105 <p><br>If <strong>password level</strong> was set to 2, the following combinations would
3106 also be tried:
3107 <p><br><code>"FRed"</code>, <code>"FrEd"</code>, <code>"FreD"</code>, <code>"fREd"</code>, <code>"fReD"</code>,
3108 <code>"frED"</code>, <code>..</code>
3109 <p><br>And so on.
3110 <p><br>The higher value this parameter is set to the more likely it is that a
3111 mixed case password will be matched against a single case
3112 password. However, you should be aware that use of this parameter
3113 reduces security and increases the time taken to process a new
3114 connection.
3115 <p><br>A value of zero will cause only two attempts to be made - the password
3116 as is and the password in all-lower case.
3117 <p><br><strong>Default:</strong>
3118 <code>  password level = 0</code>
3119 <p><br><strong>Example:</strong>
3120 <code>  password level = 4</code>
3121 <p><br><a name="passwordserver"></a>
3122 <li><strong><strong>password server (G)</strong></strong>
3123 <p><br>By specifying the name of another SMB server (such as a WinNT box)
3124 with this option, and using <a href="smb.conf.5.html#security"><strong>"security = domain"</strong></a> or
3125 <a href="smb.conf.5.html#security"><strong>"security = server"</strong></a> you can get Samba to do all
3126 its username/password validation via a remote server.
3127 <p><br>This options sets the name of the password server to use. It must be a
3128 NetBIOS name, so if the machine's NetBIOS name is different from its
3129 internet name then you may have to add its NetBIOS name to the lmhosts
3130 file which is stored in the same directory as the <strong>smb.conf</strong> file.
3131 <p><br>The name of the password server is looked up using the parameter
3132 <a href="smb.conf.5.html#nameresolveorder"><strong>"name resolve order="</strong></a> and so may resolved
3133 by any method and order described in that parameter.
3134 <p><br>The password server much be a machine capable of using the "LM1.2X002"
3135 or the "LM NT 0.12" protocol, and it must be in user level security
3136 mode.
3137 <p><br>NOTE: Using a password server means your UNIX box (running Samba) is
3138 only as secure as your password server. <em>DO NOT CHOOSE A PASSWORD
3139 SERVER THAT YOU DON'T COMPLETELY TRUST</em>.
3140 <p><br>Never point a Samba server at itself for password serving. This will
3141 cause a loop and could lock up your Samba server!
3142 <p><br>The name of the password server takes the standard substitutions, but
3143 probably the only useful one is <a href="smb.conf.5.html#percentm"><strong>%m</strong></a>, which means
3144 the Samba server will use the incoming client as the password
3145 server. If you use this then you better trust your clients, and you
3146 better restrict them with hosts allow!
3147 <p><br>If the <a href="smb.conf.5.html#security"><strong>"security"</strong></a> parameter is set to
3148 <strong>"domain"</strong>, then the list of machines in this option must be a list
3149 of Primary or Backup Domain controllers for the
3150 <a href="smb.conf.5.html#workgroup"><strong>Domain</strong></a> or the character <code>*</code>, as the Samba server is cryptographicly
3151 in that domain, and will use cryptographicly authenticated RPC calls
3152 to authenticate the user logging on. The advantage of using
3153 <a href="smb.conf.5.html#securityequaldomain"><strong>"security=domain"</strong></a> is that if you list
3154 several hosts in the <strong>"password server"</strong> option then
3155 <a href="smbd.8.html"><strong>smbd</strong></a> will try each in turn till it finds one
3156 that responds. This is useful in case your primary server goes down.
3157 <p><br>If the <strong>"password server"</strong> option is set to the character <code>*</code>,
3158 then Samba will attempt to auto-locate the Primary or Backup Domain controllers
3159 to authenticate against by doing a query for the name <code>WORKGROUP&lt;1C&gt;</code>
3160 and then contacting each server returned in the list of IP addresses
3161 from the <a href="smb.conf.5.html#nameresolveorder"><strong>name resolution</strong></a> source.
3162 <p><br>If the <a href="smb.conf.5.html#security"><strong>"security"</strong></a> parameter is set to
3163 <a href="smb.conf.5.html#securityequalserver"><strong>"server"</strong></a>, then there are different
3164 restrictions that <a href="smb.conf.5.html#securityequaldomain"><strong>"security=domain"</strong></a>
3165 doesn't suffer from:
3166 <p><br><ul>
3167 <p><br><li > You may list several password servers in the <strong>"password server"</strong>
3168 parameter, however if an <a href="smbd.8.html"><strong>smbd</strong></a> makes a connection
3169 to a password server, and then the password server fails, no more
3170 users will be able to be authenticated from this
3171 <a href="smbd.8.html"><strong>smbd</strong></a>.  This is a restriction of the SMB/CIFS
3172 protocol when in <a href="smb.conf.5.html#securityequalserver"><strong>"security=server"</strong></a> mode
3173 and cannot be fixed in Samba.
3174 <p><br><li > If you are using a Windows NT server as your password server then
3175 you will have to ensure that your users are able to login from the
3176 Samba server, as when in
3177 <a href="smb.conf.5.html#securityequalserver"><strong>"security=server"</strong></a> mode the network
3178 logon will appear to come from there rather than from the users
3179 workstation.
3180 <p><br></ul>
3181 <p><br>See also the <a href="smb.conf.5.html#security"><strong>"security"</strong></a> parameter.
3182 <p><br><strong>Default:</strong>
3183 <code>  password server = &lt;empty string&gt;</code>
3184 <p><br><strong>Example:</strong>
3185 <code>  password server = NT-PDC, NT-BDC1, NT-BDC2</code>
3186 <p><br><strong>Example:</strong>
3187 <code>  password server = *</code>
3188 <p><br><a name="path"></a>
3189 <li><strong><strong>path (S)</strong></strong>
3190 <p><br>This parameter specifies a directory to which the user of the service
3191 is to be given access. In the case of printable services, this is
3192 where print data will spool prior to being submitted to the host for
3193 printing.
3194 <p><br>For a printable service offering guest access, the service should be
3195 readonly and the path should be world-writeable and have the sticky bit
3196 set. This is not mandatory of course, but you probably won't get the
3197 results you expect if you do otherwise.
3198 <p><br>Any occurrences of <a href="smb.conf.5.html#percentu"><strong>%u</strong></a> in the path will be replaced
3199 with the UNIX username that the client is using on this
3200 connection. Any occurrences of <a href="smb.conf.5.html#percentm"><strong>%m</strong></a> will be replaced
3201 by the NetBIOS name of the machine they are connecting from. These
3202 replacements are very useful for setting up pseudo home directories
3203 for users.
3204 <p><br>Note that this path will be based on <a href="smb.conf.5.html#rootdir"><strong>"root dir"</strong></a> if
3205 one was specified.
3206 <p><br><strong>Default:</strong>
3207 <code>  none</code>
3208 <p><br><strong>Example:</strong>
3209 <code>  path = /home/fred</code>
3210 <p><br><a name="postexec"></a>
3211 <li><strong><strong>postexec (S)</strong></strong>
3212 <p><br>This option specifies a command to be run whenever the service is
3213 disconnected. It takes the usual substitutions. The command may be run
3214 as the root on some systems.
3215 <p><br>An interesting example may be do unmount server resources:
3216 <p><br><code>postexec = /etc/umount /cdrom</code>
3217 <p><br>See also <a href="smb.conf.5.html#preexec"><strong>preexec</strong></a>.
3218 <p><br><strong>Default:</strong>
3219 <code>      none (no command executed)</code>
3220 <p><br><strong>Example:</strong>
3221 <code>      postexec = echo "%u disconnected from %S from %m (%I)" &gt;&gt; /tmp/log</code>
3222 <p><br><a name="postscript"></a>
3223 <li><strong><strong>postscript (S)</strong></strong>
3224 <p><br>This parameter forces a printer to interpret the print files as
3225 postscript. This is done by adding a <code>%!</code> to the start of print output.
3226 <p><br>This is most useful when you have lots of PCs that persist in putting
3227 a control-D at the start of print jobs, which then confuses your
3228 printer.
3229 <p><br><strong>Default:</strong>
3230 <code>  postscript = False</code>
3231 <p><br><strong>Example:</strong>
3232 <code>  postscript = True</code>
3233 <p><br><a name="preexec"></a>
3234 <li><strong><strong>preexec (S)</strong></strong>
3235 <p><br>This option specifies a command to be run whenever the service is
3236 connected to. It takes the usual substitutions.
3237 <p><br>An interesting example is to send the users a welcome message every
3238 time they log in. Maybe a message of the day? Here is an example:
3239 <p><br><pre>
3240
3241         preexec = csh -c 'echo \"Welcome to %S!\" | /usr/local/samba/bin/smbclient -M %m -I %I' &amp;
3242
3243 </pre>
3244
3245 <p><br>Of course, this could get annoying after a while :-)
3246 <p><br>See also <a href="smb.conf.5.html#preexecclose"><strong>preexec close</strong></a> and <a href="smb.conf.5.html#postexec"><strong>postexec</strong></a>.
3247 <p><br><strong>Default:</strong>
3248 <code>  none (no command executed)</code>
3249 <p><br><strong>Example:</strong>
3250 <code>        preexec = echo \"%u connected to %S from %m (%I)\" &gt;&gt; /tmp/log</code>
3251 <p><br><a name="preexecclose"></a>
3252 <li><strong><strong>preexec close (S)</strong></strong>
3253 <p><br>This boolean option controls whether a non-zero return code from
3254 <a href="smb.conf.5.html#preexec"><strong>"preexec"</strong></a> should close the service being connected to.
3255 <p><br><strong>Default:</strong>
3256 <code>  preexec close = no</code>
3257 <p><br><strong>Example:</strong>
3258 <code>  preexec close = yes</code>
3259 <p><br><a name="preferredmaster"></a>
3260 <li><strong><strong>preferred master (G)</strong></strong>
3261 <p><br>This boolean parameter controls if <a href="nmbd.8.html"><strong>nmbd</strong></a> is a
3262 preferred master browser for its workgroup.
3263 <p><br>If this is set to true, on startup, <a href="nmbd.8.html"><strong>nmbd</strong></a> will
3264 force an election, and it will have a slight advantage in winning the
3265 election.  It is recommended that this parameter is used in
3266 conjunction with <a href="smb.conf.5.html#domainmaster"><strong>"domain master = yes"</strong></a>, so
3267 that <a href="nmbd.8.html"><strong>nmbd</strong></a> can guarantee becoming a domain
3268 master.
3269 <p><br>Use this option with caution, because if there are several hosts
3270 (whether Samba servers, Windows 95 or NT) that are preferred master
3271 browsers on the same subnet, they will each periodically and
3272 continuously attempt to become the local master browser.  This will
3273 result in unnecessary broadcast traffic and reduced browsing
3274 capabilities.
3275 <p><br>See also <a href="smb.conf.5.html#oslevel"><strong>os level</strong></a>.
3276 <p><br><strong>Default:</strong>
3277 <code>  preferred master = no</code>
3278 <p><br><strong>Example:</strong>
3279 <code>  preferred master = yes</code>
3280 <p><br><a name="preferedmaster"></a>
3281 <li><strong><strong>prefered master (G)</strong></strong>
3282 <p><br>Synonym for <a href="smb.conf.5.html#preferredmaster"><strong>"preferred master"</strong></a> for people
3283 who cannot spell :-).
3284 <p><br><a name="preload"></a>
3285 <li><strong><strong>preload</strong></strong>
3286 Synonym for <a href="smb.conf.5.html#autoservices"><strong>"auto services"</strong></a>.
3287 <p><br><a name="preservecase"></a>
3288 <li><strong><strong>preserve case (S)</strong></strong>
3289 <p><br>This controls if new filenames are created with the case that the
3290 client passes, or if they are forced to be the <code>"default"</code> case.
3291 <p><br><strong>Default:</strong>
3292 <code>       preserve case = yes</code>
3293 <p><br>See the section on <a href="smb.conf.5.html#NAMEMANGLING"><strong>"NAME MANGLING"</strong></a> for a
3294 fuller discussion.
3295 <p><br><a name="printcommand"></a>
3296 <li><strong><strong>print command (S)</strong></strong>
3297 <p><br>After a print job has finished spooling to a service, this command
3298 will be used via a <code>system()</code> call to process the spool
3299 file. Typically the command specified will submit the spool file to
3300 the host's printing subsystem, but there is no requirement that this
3301 be the case. The server will not remove the spool file, so whatever
3302 command you specify should remove the spool file when it has been
3303 processed, otherwise you will need to manually remove old spool files.
3304 <p><br>The print command is simply a text string. It will be used verbatim,
3305 with two exceptions: All occurrences of <code>"%s"</code> will be replaced by
3306 the appropriate spool file name, and all occurrences of <code>"%p"</code> will
3307 be replaced by the appropriate printer name. The spool file name is
3308 generated automatically by the server, the printer name is discussed
3309 below.
3310 <p><br>The full path name will be used for the filename if <code>"%s"</code> is not
3311 preceded by a <code>'/'</code>. If you don't like this (it can stuff up some
3312 lpq output) then use <code>"%f"</code> instead. Any occurrences of <code>"%f"</code> get
3313 replaced by the spool filename without the full path at the front.
3314 <p><br>The print command <em>MUST</em> contain at least one occurrence of <code>"%s"</code>
3315 or <code>"%f"</code> - the <code>"%p"</code> is optional. At the time a job is
3316 submitted, if no printer name is supplied the <code>"%p"</code> will be
3317 silently removed from the printer command.
3318 <p><br>If specified in the <a href="smb.conf.5.html#global"><strong>"[global]"</strong></a> section, the print
3319 command given will be used for any printable service that does not
3320 have its own print command specified.
3321 <p><br>If there is neither a specified print command for a printable service
3322 nor a global print command, spool files will be created but not
3323 processed and (most importantly) not removed.
3324 <p><br>Note that printing may fail on some UNIXs from the <code>"nobody"</code>
3325 account. If this happens then create an alternative guest account that
3326 can print and set the <a href="smb.conf.5.html#guestaccount"><strong>"guest account"</strong></a> in the
3327 <a href="smb.conf.5.html#global"><strong>"[global]"</strong></a> section.
3328 <p><br>You can form quite complex print commands by realizing that they are
3329 just passed to a shell. For example the following will log a print
3330 job, print the file, then remove it. Note that <code>';'</code> is the usual
3331 separator for command in shell scripts.
3332 <p><br><code>print command = echo Printing %s &gt;&gt; /tmp/print.log; lpr -P %p %s; rm %s</code>
3333 <p><br>You may have to vary this command considerably depending on how you
3334 normally print files on your system. The default for the parameter
3335 varies depending on the setting of the <a href="smb.conf.5.html#printing"><strong>"printing="</strong></a>
3336 parameter.
3337 <p><br><strong>Default:</strong>
3338         For <a href="smb.conf.5.html#printing"><strong>"printing="</strong></a> BSD, AIX, QNX, LPRNG or PLP :
3339 <code>  print command = lpr -r -P%p %s</code>
3340 <p><br>For <a href="smb.conf.5.html#printing"><strong>"printing="</strong></a> SYS or HPUX :
3341 <code>  print command = lp -c -d%p %s; rm %s</code>
3342 <p><br>For <a href="smb.conf.5.html#printing"><strong>"printing="</strong></a> SOFTQ :
3343 <code>  print command = lp -d%p -s %s; rm %s</code>
3344 <p><br><strong>Example:</strong>
3345 <code>  print command = /usr/local/samba/bin/myprintscript %p %s</code>
3346 <p><br><a name="printok"></a>
3347 <li><strong><strong>print ok (S)</strong></strong>
3348 <p><br>Synonym for <a href="smb.conf.5.html#printable"><strong>printable</strong></a>.
3349 <p><br><a name="printable"></a>
3350 <li><strong><strong>printable (S)</strong></strong>
3351 <p><br>If this parameter is <code>"yes"</code>, then clients may open, write to and
3352 submit spool files on the directory specified for the service.
3353 <p><br>Note that a printable service will ALWAYS allow writing to the service
3354 path (user privileges permitting) via the spooling of print data. The
3355 <a href="smb.conf.5.html#readonly"><strong>"read only"</strong></a> parameter controls only non-printing
3356 access to the resource.
3357 <p><br><strong>Default:</strong>
3358 <code>  printable = no</code>
3359 <p><br><strong>Example:</strong>
3360 <code>  printable = yes</code>
3361 <p><br><a name="printcap"></a>
3362 <li><strong><strong>printcap (G)</strong></strong>
3363 <p><br>Synonym for <a href="smb.conf.5.html#printcapname"><strong>printcapname</strong></a>.
3364 <p><br><a name="printcapname"></a>
3365 <li><strong><strong>printcap name (G)</strong></strong>
3366 <p><br>This parameter may be used to override the compiled-in default
3367 printcap name used by the server (usually /etc/printcap). See the
3368 discussion of the <a href="smb.conf.5.html#printers"><strong>[printers]</strong></a> section above for
3369 reasons why you might want to do this.
3370 <p><br>On System V systems that use <strong>lpstat</strong> to list available printers you
3371 can use <code>"printcap name = lpstat"</code> to automatically obtain lists of
3372 available printers. This is the default for systems that define SYSV
3373 at configure time in Samba (this includes most System V based
3374 systems). If <strong>"printcap name"</strong> is set to <strong>lpstat</strong> on these systems
3375 then Samba will launch <code>"lpstat -v"</code> and attempt to parse the output
3376 to obtain a printer list.
3377 <p><br>A minimal printcap file would look something like this:
3378 <p><br><pre>
3379
3380         print1|My Printer 1
3381         print2|My Printer 2
3382         print3|My Printer 3
3383         print4|My Printer 4
3384         print5|My Printer 5
3385
3386 </pre>
3387
3388 <p><br>where the <code>'|'</code> separates aliases of a printer. The fact that the
3389 second alias has a space in it gives a hint to Samba that it's a
3390 comment.
3391 <p><br><em>NOTE</em>: Under AIX the default printcap name is
3392 <code>"/etc/qconfig"</code>. Samba will assume the file is in AIX <code>"qconfig"</code>
3393 format if the string <code>"/qconfig"</code> appears in the printcap filename.
3394 <p><br><strong>Default:</strong>
3395 <code>  printcap name = /etc/printcap</code>
3396 <p><br><strong>Example:</strong>
3397 <code>  printcap name = /etc/myprintcap</code>
3398 <p><br><a name="printer"></a>
3399 <li><strong><strong>printer (S)</strong></strong>
3400 <p><br>This parameter specifies the name of the printer to which print jobs
3401 spooled through a printable service will be sent.
3402 <p><br>If specified in the <a href="smb.conf.5.html#global"><strong>[global]</strong></a> section, the printer
3403 name given will be used for any printable service that does not have
3404 its own printer name specified.
3405 <p><br><strong>Default:</strong>
3406         none (but may be <code>"lp"</code> on many systems)
3407 <p><br><strong>Example:</strong>
3408         printer name = laserwriter
3409 <p><br><a name="printerdriver"></a>
3410 <li><strong><strong>printer driver (S)</strong></strong>
3411 <p><br>This option allows you to control the string that clients receive when
3412 they ask the server for the printer driver associated with a
3413 printer. If you are using Windows95 or WindowsNT then you can use this
3414 to automate the setup of printers on your system.
3415 <p><br>You need to set this parameter to the exact string (case sensitive)
3416 that describes the appropriate printer driver for your system. If you
3417 don't know the exact string to use then you should first try with no
3418 <strong>"printer driver"</strong> option set and the client will give you a list of
3419 printer drivers. The appropriate strings are shown in a scrollbox
3420 after you have chosen the printer manufacturer.
3421 <p><br>See also <a href="smb.conf.5.html#printerdriverfile"><strong>"printer driver file"</strong></a>.
3422 <p><br><strong>Example:</strong>
3423         printer driver = HP LaserJet 4L
3424 <p><br><a name="printerdriverfile"></a>
3425 <li><strong><strong>printer driver file (G)</strong></strong>
3426 <p><br>This parameter tells Samba where the printer driver definition file,
3427 used when serving drivers to Windows 95 clients, is to be found. If
3428 this is not set, the default is :
3429 <p><br><code>SAMBA_INSTALL_DIRECTORY/lib/printers.def</code>
3430 <p><br>This file is created from Windows 95 <code>"msprint.def"</code> files found on
3431 the Windows 95 client system. For more details on setting up serving
3432 of printer drivers to Windows 95 clients, see the documentation file
3433 in the docs/ directory, PRINTER_DRIVER.txt.
3434 <p><br><strong>Default:</strong>
3435 <code>  None (set in compile).</code>
3436 <p><br><strong>Example:</strong>
3437 <code>  printer driver file = /usr/local/samba/printers/drivers.def</code>
3438 <p><br>See also <a href="smb.conf.5.html#printerdriverlocation"><strong>"printer driver location"</strong></a>.
3439 <p><br><a name="printerdriverlocation"></a>
3440 <li><strong><strong>printer driver location (S)</strong></strong>
3441 <p><br>This parameter tells clients of a particular printer share where to
3442 find the printer driver files for the automatic installation of
3443 drivers for Windows 95 machines. If Samba is set up to serve printer
3444 drivers to Windows 95 machines, this should be set to
3445 <p><br><code>\\MACHINE\aPRINTER$</code>
3446 <p><br>Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$
3447 is a share you set up for serving printer driver files. For more
3448 details on setting this up see the documentation file in the docs/
3449 directory, PRINTER_DRIVER.txt.
3450 <p><br><strong>Default:</strong>
3451 <code>  None</code>
3452 <p><br><strong>Example:</strong>
3453 <code>  printer driver location = \\MACHINE\PRINTER$</code>
3454 <p><br>See also <a href="smb.conf.5.html#printerdriverfile"><strong>"printer driver file"</strong></a>.
3455 <p><br><a name="printername"></a>
3456 <li><strong><strong>printer name (S)</strong></strong>
3457 <p><br>Synonym for <a href="smb.conf.5.html#printer"><strong>printer</strong></a>.
3458 <p><br><a name="printing"></a>
3459 <li><strong><strong>printing (S)</strong></strong>
3460 <p><br>This parameters controls how printer status information is interpreted
3461 on your system, and also affects the default values for the
3462 <a href="smb.conf.5.html#printcommand"><strong>"print command"</strong></a>, <a href="smb.conf.5.html#lpqcommand"><strong>"lpq
3463 command"</strong></a> <a href="smb.conf.5.html#lppausecommand"><strong>"lppause command"</strong></a>,
3464 <a href="smb.conf.5.html#lpresumecommand"><strong>"lpresume command"</strong></a>, and <a href="smb.conf.5.html#lprmcommand"><strong>"lprm
3465 command"</strong></a>.
3466 <p><br>Currently eight printing styles are supported. They are
3467 <strong>"printing=BSD"</strong>, <strong>"printing=AIX"</strong>, <strong>"printing=LPRNG"</strong>,
3468 <strong>"printing=PLP"</strong>,
3469 <strong>"printing=SYSV"</strong>,<strong>"printing="HPUX"</strong>,<strong>"printing=QNX"</strong> and
3470 <strong>"printing=SOFTQ"</strong>.
3471 <p><br>To see what the defaults are for the other print commands when using
3472 these three options use the <a href="testparm.1.html"><strong>"testparm"</strong></a> program.
3473 <p><br>This option can be set on a per printer basis
3474 <p><br>See also the discussion in the <a href="smb.conf.5.html#printers"><strong>[printers]</strong></a> section.
3475 <p><br><a name="protocol"></a>
3476 <li><strong><strong>protocol (G)</strong></strong>
3477 <p><br>The value of the parameter (a string) is the highest protocol level
3478 that will be supported by the server.
3479 <p><br>Possible values are :
3480 <p><br><ul>
3481 <p><br><li > CORE: Earliest version. No concept of user names.
3482 <p><br><li > COREPLUS: Slight improvements on CORE for efficiency.
3483 <p><br><li > LANMAN1: First <em>"modern"</em> version of the protocol. Long
3484 filename support.
3485 <p><br><li > LANMAN2: Updates to Lanman1 protocol.
3486 <p><br><li > NT1: Current up to date version of the protocol. Used by Windows
3487 NT. Known as CIFS.
3488 <p><br></ul>
3489 <p><br>Normally this option should not be set as the automatic negotiation
3490 phase in the SMB protocol takes care of choosing the appropriate
3491 protocol.
3492 <p><br><strong>Default:</strong>
3493 <code>  protocol = NT1</code>
3494 <p><br><strong>Example:</strong>
3495 <code>  protocol = LANMAN1</code>
3496 <p><br><a name="public"></a>
3497 <li><strong><strong>public (S)</strong></strong>
3498 <p><br>Synonym for <a href="smb.conf.5.html#guestok"><strong>"guest ok"</strong></a>.
3499 <p><br><a name="queuepausecommand"></a>
3500 <li><strong><strong>queuepause command (S)</strong></strong>
3501 <p><br>This parameter specifies the command to be executed on the server host
3502 in order to pause the printerqueue.
3503 <p><br>This command should be a program or script which takes a printer name
3504 as its only parameter and stops the printerqueue, such that no longer
3505 jobs are submitted to the printer.
3506 <p><br>This command is not supported by Windows for Workgroups, but can be
3507 issued from the Printer's window under Windows 95 &amp; NT.
3508 <p><br>If a <code>"%p"</code> is given then the printername is put in its
3509 place. Otherwise it is placed at the end of the command.
3510 <p><br>Note that it is good practice to include the absolute path in the
3511 command as the PATH may not be available to the server.
3512 <p><br><strong>Default:</strong>
3513 <code>        depends on the setting of "printing ="</code>
3514 <p><br><strong>Example:</strong>
3515 <code>      queuepause command = disable %p</code>
3516 <p><br><a name="queueresumecommand"></a>
3517 <li><strong><strong>queueresume command (S)</strong></strong>
3518 <p><br>This parameter specifies the command to be executed on the server host
3519 in order to resume the printerqueue. It is the command to undo the
3520 behavior that is caused by the previous parameter
3521 (<a href="smb.conf.5.html#queuepausecommand"><strong>"queuepause command</strong></a>).
3522 <p><br>This command should be a program or script which takes a printer name
3523 as its only parameter and resumes the printerqueue, such that queued
3524 jobs are resubmitted to the printer.
3525 <p><br>This command is not supported by Windows for Workgroups, but can be
3526 issued from the Printer's window under Windows 95 &amp; NT.
3527 <p><br>If a <code>"%p"</code> is given then the printername is put in its
3528 place. Otherwise it is placed at the end of the command.
3529 <p><br>Note that it is good practice to include the absolute path in the
3530 command as the PATH may not be available to the server.
3531 <p><br><strong>Default:</strong>
3532 <code>        depends on the setting of "printing ="</code>
3533 <p><br><strong>Example:</strong>
3534 <code>      queuepause command = enable %p</code>
3535 <p><br><a name="readbmpx"></a>
3536 <li><strong><strong>read bmpx (G)</strong></strong>
3537 <p><br>This boolean parameter controls whether <a href="smbd.8.html"><strong>smbd</strong></a>
3538 will support the "Read Block Multiplex" SMB. This is now rarely used
3539 and defaults to off. You should never need to set this parameter.
3540 <p><br><strong>Default:</strong>
3541         read bmpx = No
3542 <p><br><a name="readlist"></a>
3543 <li><strong><strong>read list (S)</strong></strong>
3544 <p><br>This is a list of users that are given read-only access to a
3545 service. If the connecting user is in this list then they will not be
3546 given write access, no matter what the <a href="smb.conf.5.html#readonly"><strong>"read only"</strong></a>
3547 option is set to. The list can include group names using the syntax
3548 described in the <a href="smb.conf.5.html#invalidusers"><strong>"invalid users"</strong></a> parameter.
3549 <p><br>See also the <a href="smb.conf.5.html#writelist"><strong>"write list"</strong></a> parameter and
3550 the <a href="smb.conf.5.html#invalidusers"><strong>"invalid users"</strong></a> parameter.
3551 <p><br><strong>Default:</strong>
3552 <code>  read list = &lt;empty string&gt;</code>
3553 <p><br><strong>Example:</strong>
3554 <code>  read list = mary, @students</code>
3555 <p><br><a name="readonly"></a>
3556 <li><strong><strong>read only (S)</strong></strong>
3557 <p><br>Note that this is an inverted synonym for
3558 <a href="smb.conf.5.html#writeable"><strong>"writeable"</strong></a> and <a href="smb.conf.5.html#writeok"><strong>"write ok"</strong></a>.
3559 <p><br>See also <a href="smb.conf.5.html#writeable"><strong>"writeable"</strong></a> and <a href="smb.conf.5.html#writeok"><strong>"write
3560 ok"</strong></a>.
3561 <p><br><a name="readprediction"></a>
3562 <li><strong><strong>read prediction (G)</strong></strong>
3563 <p><br><em>NOTE</em>: This code is currently disabled in Samba2.0 and
3564 may be removed at a later date. Hence this parameter has
3565 no effect.
3566 <p><br>This options enables or disables the read prediction code used to
3567 speed up reads from the server. When enabled the server will try to
3568 pre-read data from the last accessed file that was opened read-only
3569 while waiting for packets.
3570 <p><br><strong>Default:</strong>
3571 <code>  read prediction = False</code>
3572 <p><br><a name="readraw"></a>
3573 <li><strong><strong>read raw (G)</strong></strong>
3574 <p><br>This parameter controls whether or not the server will support the raw
3575 read SMB requests when transferring data to clients.
3576 <p><br>If enabled, raw reads allow reads of 65535 bytes in one packet. This
3577 typically provides a major performance benefit.
3578 <p><br>However, some clients either negotiate the allowable block size
3579 incorrectly or are incapable of supporting larger block sizes, and for
3580 these clients you may need to disable raw reads.
3581 <p><br>In general this parameter should be viewed as a system tuning tool and left
3582 severely alone. See also <a href="smb.conf.5.html#writeraw"><strong>"write raw"</strong></a>.
3583 <p><br><strong>Default:</strong>
3584 <code>  read raw = yes</code>
3585 <p><br><a name="readsize"></a>
3586 <li><strong><strong>read size (G)</strong></strong>
3587 <p><br>The option <strong>"read size"</strong> affects the overlap of disk reads/writes
3588 with network reads/writes. If the amount of data being transferred in
3589 several of the SMB commands (currently SMBwrite, SMBwriteX and
3590 SMBreadbraw) is larger than this value then the server begins writing
3591 the data before it has received the whole packet from the network, or
3592 in the case of SMBreadbraw, it begins writing to the network before
3593 all the data has been read from disk.
3594 <p><br>This overlapping works best when the speeds of disk and network access
3595 are similar, having very little effect when the speed of one is much
3596 greater than the other.
3597 <p><br>The default value is 16384, but very little experimentation has been
3598 done yet to determine the optimal value, and it is likely that the
3599 best value will vary greatly between systems anyway. A value over
3600 65536 is pointless and will cause you to allocate memory
3601 unnecessarily.
3602 <p><br><strong>Default:</strong>
3603 <code>  read size = 16384</code>
3604 <p><br><strong>Example:</strong>
3605 <code>  read size = 8192</code>
3606 <p><br><a name="remoteannounce"></a>
3607 <li><strong><strong>remote announce (G)</strong></strong>
3608 <p><br>This option allows you to setup <a href="nmbd.8.html"><strong>nmbd</strong></a> to
3609 periodically announce itself to arbitrary IP addresses with an
3610 arbitrary workgroup name.
3611 <p><br>This is useful if you want your Samba server to appear in a remote
3612 workgroup for which the normal browse propagation rules don't
3613 work. The remote workgroup can be anywhere that you can send IP
3614 packets to.
3615 <p><br>For example:
3616 <p><br><code>   remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF</code>
3617 <p><br>the above line would cause nmbd to announce itself to the two given IP
3618 addresses using the given workgroup names. If you leave out the
3619 workgroup name then the one given in the
3620 <a href="smb.conf.5.html#workgroup"><strong>"workgroup"</strong></a> parameter is used instead.
3621 <p><br>The IP addresses you choose would normally be the broadcast addresses
3622 of the remote networks, but can also be the IP addresses of known
3623 browse masters if your network config is that stable.
3624 <p><br>See the documentation file BROWSING.txt in the docs/ directory.
3625 <p><br><strong>Default:</strong>
3626 <code>  remote announce = &lt;empty string&gt;</code>
3627 <p><br><strong>Example:</strong>
3628 <code>  remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF</code>
3629 <p><br><a name="remotebrowsesync"></a>
3630 <li><strong><strong>remote browse sync (G)</strong></strong>
3631 <p><br>This option allows you to setup <a href="nmbd.8.html"><strong>nmbd</strong></a> to
3632 periodically request synchronization of browse lists with the master
3633 browser of a samba server that is on a remote segment. This option
3634 will allow you to gain browse lists for multiple workgroups across
3635 routed networks. This is done in a manner that does not work with any
3636 non-samba servers.
3637 <p><br>This is useful if you want your Samba server and all local clients to
3638 appear in a remote workgroup for which the normal browse propagation
3639 rules don't work. The remote workgroup can be anywhere that you can
3640 send IP packets to.
3641 <p><br>For example:
3642 <p><br><code>   remote browse sync = 192.168.2.255 192.168.4.255</code>
3643 <p><br>the above line would cause <a href="nmbd.8.html"><strong>nmbd</strong></a> to request the
3644 master browser on the specified subnets or addresses to synchronize
3645 their browse lists with the local server.
3646 <p><br>The IP addresses you choose would normally be the broadcast addresses
3647 of the remote networks, but can also be the IP addresses of known
3648 browse masters if your network config is that stable. If a machine IP
3649 address is given Samba makes NO attempt to validate that the remote
3650 machine is available, is listening, nor that it is in fact the browse
3651 master on it's segment.
3652 <p><br><strong>Default:</strong>
3653 <code>  remote browse sync = &lt;empty string&gt;</code>
3654 <p><br><strong>Example:</strong>
3655 <code>  remote browse sync = 192.168.2.255 192.168.4.255</code>
3656 <p><br><a name="restrictanonymous"></a>
3657 <li><strong><strong>restrict anonymous (G)</strong></strong>
3658 <p><br>This is a boolean parameter.  If it is true, then anonymous access
3659 to the server will be restricted, namely in the case where the server
3660 is expecting the client to send a username, but it doesn't.  Setting
3661 it to true will force these anonymous connections to be denied, and
3662 the client will be required to always supply a username and password
3663 when connecting. Use of this parameter is only recommened for homogenous
3664 NT client environments.
3665 <p><br>This parameter makes the use of macro expansions that rely
3666 on the username (%U, %G, etc) consistant.  NT 4.0 likes to use
3667 anonymous connections when refreshing the share list, and this
3668 is a way to work around that.
3669 <p><br>When restrict anonymous is true, all anonymous connections are denied
3670 no matter what they are for.  This can effect the ability of a machine
3671 to access the samba Primary Domain Controller to revalidate it's machine
3672 account after someone else has logged on the client interactively.  The
3673 NT client will display a message saying that the machine's account in
3674 the domain doesn't exist or the password is bad.  The best way to deal
3675 with this is to reboot NT client machines between interactive logons,
3676 using "Shutdown and Restart", rather than "Close all programs and logon
3677 as a different user".
3678 <p><br><strong>Default:</strong>
3679 <code>     restrict anonymous = false</code>
3680 <p><br><strong>Example:</strong>
3681 <code>     restrict anonymous = true</code>
3682 <p><br><a name="revalidate"></a>
3683 <li><strong><strong>revalidate (S)</strong></strong>
3684 <p><br>Note that this option only works with
3685 <a href="smb.conf.5.html#securityequalshare"><strong>"security=share"</strong></a> and will be ignored if
3686 this is not the case.
3687 <p><br>This option controls whether Samba will allow a previously validated
3688 username/password pair to be used to attach to a share. Thus if you
3689 connect to <code>\\server\share1</code> then to <code>\\server\share2</code> it won't
3690 automatically allow the client to request connection to the second
3691 share as the same username as the first without a password.
3692 <p><br>If <strong>"revalidate"</strong> is <code>"True"</code> then the client will be denied
3693 automatic access as the same username.
3694 <p><br><strong>Default:</strong>
3695 <code>  revalidate = False</code>
3696 <p><br><strong>Example:</strong>
3697 <code>  revalidate = True</code>
3698 <p><br><a name="root"></a>
3699 <li><strong><strong>root (G)</strong></strong>
3700 <p><br>Synonym for <a href="smb.conf.5.html#rootdirectory"><strong>"root directory"</strong></a>.
3701 <p><br><a name="rootdir"></a>
3702 <li><strong><strong>root dir (G)</strong></strong>
3703 <p><br>Synonym for <a href="smb.conf.5.html#rootdirectory"><strong>"root directory"</strong></a>.
3704 <p><br><a name="rootdirectory"></a>
3705 <li><strong><strong>root directory (G)</strong></strong>
3706 <p><br>The server will <code>"chroot()"</code> (i.e. Change it's root directory) to
3707 this directory on startup. This is not strictly necessary for secure
3708 operation. Even without it the server will deny access to files not in
3709 one of the service entries. It may also check for, and deny access to,
3710 soft links to other parts of the filesystem, or attempts to use
3711 <code>".."</code> in file names to access other directories (depending on the
3712 setting of the <a href="smb.conf.5.html#widelinks"><strong>"wide links"</strong></a> parameter).
3713 <p><br>Adding a <strong>"root directory"</strong> entry other than <code>"/"</code> adds an extra
3714 level of security, but at a price. It absolutely ensures that no
3715 access is given to files not in the sub-tree specified in the <strong>"root
3716 directory"</strong> option, <em>*including*</em> some files needed for complete
3717 operation of the server. To maintain full operability of the server
3718 you will need to mirror some system files into the <strong>"root
3719 directory"</strong> tree. In particular you will need to mirror /etc/passwd
3720 (or a subset of it), and any binaries or configuration files needed
3721 for printing (if required). The set of files that must be mirrored is
3722 operating system dependent.
3723 <p><br><strong>Default:</strong>
3724 <code>  root directory = /</code>
3725 <p><br><strong>Example:</strong>
3726 <code>  root directory = /homes/smb</code>
3727 <p><br><a name="rootpostexec"></a>
3728 <li><strong><strong>root postexec (S)</strong></strong>
3729 <p><br>This is the same as the <a href="smb.conf.5.html#postexec"><strong>"postexec"</strong></a> parameter
3730 except that the command is run as root. This is useful for unmounting
3731 filesystems (such as cdroms) after a connection is closed.
3732 <p><br>See also <a href="smb.conf.5.html#postexec"><strong>"postexec"</strong></a>.
3733 <p><br><a name="rootpreexec"></a>
3734 <li><strong><strong>root preexec (S)</strong></strong>
3735 <p><br>This is the same as the <a href="smb.conf.5.html#preexec"><strong>"preexec"</strong></a> parameter except
3736 that the command is run as root. This is useful for mounting
3737 filesystems (such as cdroms) before a connection is finalized.
3738 <p><br>See also <a href="smb.conf.5.html#preexec"><strong>"preexec"</strong></a>
3739 and <a href="smb.conf.5.html#rootpreexecclose"><strong>"root preexec close"</strong></a>.
3740 <p><br><a name="rootpreexecclose"></a>
3741 <li><strong><strong>root preexec close (S)</strong></strong>
3742 <p><br>This is the same as the <a href="smb.conf.5.html#preexecclose"><strong>"preexec close"</strong></a> parameter
3743 except that the command is run as root.
3744 <p><br>See also <a href="smb.conf.5.html#preexec"><strong>"preexec"</strong></a>, <a href="smb.conf.5.html#preexecclose"><strong>"preexec close"</strong></a>.
3745 <p><br><a name="security"></a>
3746 <li><strong><strong>security (G)</strong></strong>
3747 <p><br>This option affects how clients respond to Samba and is one of the most
3748 important settings in the <strong>smb.conf</strong> file.
3749 <p><br>The option sets the <code>"security mode bit"</code> in replies to protocol
3750 negotiations with <a href="smbd.8.html"><strong>smbd</strong></a> to turn share level
3751 security on or off. Clients decide based on this bit whether (and how)
3752 to transfer user and password information to the server.
3753 <p><br>The default is <a href="smb.conf.5.html#securityequaluser">"security=user"</a>, as this is
3754 the most common setting needed when talking to Windows 98 and Windows
3755 NT.
3756 <p><br>The alternatives are <a href="smb.conf.5.html#securityequalshare"><strong>"security = share"</strong></a>,
3757 <a href="smb.conf.5.html#securityequalserver"><strong>"security = server"</strong></a> or
3758 <a href="smb.conf.5.html#securityequaldomain"><strong>"security=domain"</strong></a>.
3759 <p><br><em>*****NOTE THAT THIS DEFAULT IS DIFFERENT IN SAMBA2.0 THAN FOR
3760 PREVIOUS VERSIONS OF SAMBA *******</em>.
3761 <p><br>In previous versions of Samba the default was
3762 <a href="smb.conf.5.html#securityequalshare"><strong>"security=share"</strong></a> mainly because that was
3763 the only option at one stage.
3764 <p><br>There is a bug in WfWg that has relevance to this setting. When in
3765 user or server level security a WfWg client will totally ignore the
3766 password you type in the "connect drive" dialog box. This makes it
3767 very difficult (if not impossible) to connect to a Samba service as
3768 anyone except the user that you are logged into WfWg as.
3769 <p><br>If your PCs use usernames that are the same as their usernames on the
3770 UNIX machine then you will want to use <strong>"security = user"</strong>. If you
3771 mostly use usernames that don't exist on the UNIX box then use
3772 <strong>"security = share"</strong>.
3773 <p><br>You should also use <a href="smb.conf.5.html#securityequalshare"><strong>security=share</strong></a> if
3774 you want to mainly setup shares without a password (guest
3775 shares). This is commonly used for a shared printer server. It is more
3776 difficult to setup guest shares with
3777 <a href="smb.conf.5.html#securityequaluser"><strong>security=user</strong></a>, see the <a href="smb.conf.5.html#maptoguest"><strong>"map to
3778 guest"</strong></a>parameter for details.
3779 <p><br>It is possible to use <a href="smbd.8.html"><strong>smbd</strong></a> in a <em>"hybrid
3780 mode"</em> where it is offers both user and share level security under
3781 different <a href="smb.conf.5.html#netbiosaliases"><strong>NetBIOS aliases</strong></a>. See the
3782 <a href="smb.conf.5.html#netbiosaliases"><strong>NetBIOS aliases</strong></a> and the
3783 <a href="smb.conf.5.html#include"><strong>include</strong></a> parameters for more information.
3784 <p><br>The different settings will now be explained.
3785 <p><br><ul>
3786 <p><br><a name="securityequalshare"></a>
3787 <li><strong><strong>"security=share"</strong></strong> When clients connect to a share level
3788 security server then need not log onto the server with a valid
3789 username and password before attempting to connect to a shared
3790 resource (although modern clients such as Windows 95/98 and Windows NT
3791 will send a logon request with a username but no password when talking
3792 to a <strong>security=share</strong> server). Instead, the clients send
3793 authentication information (passwords) on a per-share basis, at the
3794 time they attempt to connect to that share.
3795 <p><br>Note that <a href="smbd.8.html"><strong>smbd</strong></a> <em>*ALWAYS*</em> uses a valid UNIX
3796 user to act on behalf of the client, even in <strong>"security=share"</strong>
3797 level security.
3798 <p><br>As clients are not required to send a username to the server
3799 in share level security, <a href="smbd.8.html"><strong>smbd</strong></a> uses several
3800 techniques to determine the correct UNIX user to use on behalf
3801 of the client.
3802 <p><br>A list of possible UNIX usernames to match with the given
3803 client password is constructed using the following methods :
3804 <p><br><ul>
3805 <p><br><li > If the <a href="smb.conf.5.html#guestonly"><strong>"guest only"</strong></a> parameter is set, then
3806 all the other stages are missed and only the <a href="smb.conf.5.html#guestaccount"><strong>"guest
3807 account"</strong></a> username is checked.
3808 <p><br><li > Is a username is sent with the share connection request, then
3809 this username (after mapping - see <a href="smb.conf.5.html#usernamemap"><strong>"username
3810 map"</strong></a>), is added as a potential username.
3811 <p><br><li > If the client did a previous <em>"logon"</em> request (the
3812 SessionSetup SMB call) then the username sent in this SMB
3813 will be added as a potential username.
3814 <p><br><li > The name of the service the client requested is added
3815 as a potential username.
3816 <p><br><li > The NetBIOS name of the client is added to the list as a
3817 potential username.
3818 <p><br><li > Any users on the <a href="smb.conf.5.html#user"><strong>"user"</strong></a> list are added
3819 as potential usernames.
3820 <p><br></ul>
3821 <p><br>If the <a href="smb.conf.5.html#guestonly"><strong>"guest only"</strong></a> parameter is not set, then
3822 this list is then tried with the supplied password. The first user for
3823 whom the password matches will be used as the UNIX user.
3824 <p><br>If the <a href="smb.conf.5.html#guestonly"><strong>"guest only"</strong></a> parameter is set, or no
3825 username can be determined then if the share is marked as available to
3826 the <a href="smb.conf.5.html#guestaccount"><strong>"guest account"</strong></a>, then this guest user will
3827 be used, otherwise access is denied.
3828 <p><br>Note that it can be <em>*very*</em> confusing in share-level security as to
3829 which UNIX username will eventually be used in granting access.
3830 <p><br>See also the section <a href="smb.conf.5.html#NOTEABOUTUSERNAMEPASSWORDVALIDATION"><strong>"NOTE ABOUT USERNAME/PASSWORD
3831 VALIDATION"</strong></a>.
3832 <p><br><a name="securityequaluser"></a>
3833 <li><strong><strong>"security=user"</strong></strong>
3834 <p><br>This is the default security setting in Samba2.0. With user-level
3835 security a client must first <code>"log-on"</code> with a valid username and
3836 password (which can be mapped using the <a href="smb.conf.5.html#usernamemap"><strong>"username
3837 map"</strong></a> parameter). Encrypted passwords (see the
3838 <a href="smb.conf.5.html#encryptpasswords"><strong>"encrypted passwords"</strong></a> parameter) can also
3839 be used in this security mode. Parameters such as
3840 <a href="smb.conf.5.html#user"><strong>"user"</strong></a> and <a href="smb.conf.5.html#guestonly"><strong>"guest only"</strong></a>, if set
3841 are then applied and may change the UNIX user to use on this
3842 connection, but only after the user has been successfully
3843 authenticated.
3844 <p><br><em>Note</em> that the name of the resource being requested is
3845 <em>*not*</em> sent to the server until after the server has successfully
3846 authenticated the client. This is why guest shares don't work in user
3847 level security without allowing the server to automatically map unknown
3848 users into the <a href="smb.conf.5.html#guestaccount"><strong>"guest account"</strong></a>. See the
3849 <a href="smb.conf.5.html#maptoguest"><strong>"map to guest"</strong></a> parameter for details on
3850 doing this.
3851 <p><br>See also the section <a href="smb.conf.5.html#NOTEABOUTUSERNAMEPASSWORDVALIDATION"><strong>"NOTE ABOUT USERNAME/PASSWORD
3852 VALIDATION"</strong></a>.
3853 <p><br><a name="securityequalserver"></a>
3854 <li><strong><strong>"security=server"</strong></strong>
3855 <p><br>In this mode Samba will try to validate the username/password by
3856 passing it to another SMB server, such as an NT box. If this fails it
3857 will revert to <strong>"security = user"</strong>, but note that if encrypted
3858 passwords have been negotiated then Samba cannot revert back to
3859 checking the UNIX password file, it must have a valid smbpasswd file
3860 to check users against. See the documentation file in the docs/
3861 directory ENCRYPTION.txt for details on how to set this up.
3862 <p><br><em>Note</em> that from the clients point of view <strong>"security=server"</strong> is
3863 the same as <a href="smb.conf.5.html#securityequaluser"><strong>"security=user"</strong></a>. It only
3864 affects how the server deals with the authentication, it does not in
3865 any way affect what the client sees.
3866 <p><br><em>Note</em> that the name of the resource being requested is
3867 <em>*not*</em> sent to the server until after the server has successfully
3868 authenticated the client. This is why guest shares don't work in server
3869 level security without allowing the server to automatically map unknown
3870 users into the <a href="smb.conf.5.html#guestaccount"><strong>"guest account"</strong></a>. See the
3871 <a href="smb.conf.5.html#maptoguest"><strong>"map to guest"</strong></a> parameter for details on
3872 doing this.
3873 <p><br>See also the section <a href="smb.conf.5.html#NOTEABOUTUSERNAMEPASSWORDVALIDATION"><strong>"NOTE ABOUT USERNAME/PASSWORD
3874 VALIDATION"</strong></a>.
3875 <p><br>See also the <a href="smb.conf.5.html#passwordserver"><strong>"password server"</strong></a> parameter.
3876 and the <a href="smb.conf.5.html#encryptpasswords"><strong>"encrypted passwords"</strong></a> parameter.
3877 <p><br><a name="securityequaldomain"></a>
3878 <li><strong><strong>"security=domain"</strong></strong>
3879 <p><br>This mode will only work correctly if
3880 <a href="smbpasswd.8.html"><strong>smbpasswd</strong></a> has been used to add this machine
3881 into a Windows NT Domain. It expects the <a href="smb.conf.5.html#encryptpasswords"><strong>"encrypted
3882 passwords"</strong></a> parameter to be set to <code>"true"</code>. In
3883 this mode Samba will try to validate the username/password by passing
3884 it to a Windows NT Primary or Backup Domain Controller, in exactly the
3885 same way that a Windows NT Server would do.
3886 <p><br><em>Note</em> that a valid UNIX user must still exist as well as the
3887 account on the Domain Controller to allow Samba to have a valid
3888 UNIX account to map file access to.
3889 <p><br><em>Note</em> that from the clients point of view <strong>"security=domain"</strong> is
3890 the same as <a href="smb.conf.5.html#securityequaluser"><strong>"security=user"</strong></a>. It only
3891 affects how the server deals with the authentication, it does not in
3892 any way affect what the client sees.
3893 <p><br><em>Note</em> that the name of the resource being requested is
3894 <em>*not*</em> sent to the server until after the server has successfully
3895 authenticated the client. This is why guest shares don't work in domain
3896 level security without allowing the server to automatically map unknown
3897 users into the <a href="smb.conf.5.html#guestaccount"><strong>"guest account"</strong></a>. See the
3898 <a href="smb.conf.5.html#maptoguest"><strong>"map to guest"</strong></a> parameter for details on
3899 doing this.
3900 <p><br><em>BUG:</em> There is currently a bug in the implementation of
3901 <strong>"security=domain</strong> with respect to multi-byte character
3902 set usernames. The communication with a Domain Controller
3903 must be done in UNICODE and Samba currently does not widen
3904 multi-byte user names to UNICODE correctly, thus a multi-byte
3905 username will not be recognized correctly at the Domain Controller.
3906 This issue will be addressed in a future release.
3907 <p><br>See also the section <a href="smb.conf.5.html#NOTEABOUTUSERNAMEPASSWORDVALIDATION"><strong>"NOTE ABOUT USERNAME/PASSWORD
3908 VALIDATION"</strong></a>.
3909 <p><br>See also the <a href="smb.conf.5.html#passwordserver"><strong>"password server"</strong></a> parameter.
3910 and the <a href="smb.conf.5.html#encryptpasswords"><strong>"encrypted passwords"</strong></a> parameter.
3911 <p><br></ul>
3912 <p><br><strong>Default:</strong>
3913 <code>  security = USER</code>
3914 <p><br><strong>Example:</strong>
3915 <code>  security = DOMAIN</code>
3916 <p><br><a name="securitymask"></a>
3917 <li><strong><strong>security mask (S)</strong></strong>
3918 <p><br>This parameter controls what UNIX permission bits can be modified
3919 when a Windows NT client is manipulating the UNIX permission on a
3920 file using the native NT security dialog box.
3921 <p><br>This parameter is applied as a mask (AND'ed with) to the changed
3922 permission bits, thus preventing any bits not in this mask from
3923 being modified. Essentially, zero bits in this mask may be treated
3924 as a set of bits the user is not allowed to change.
3925 <p><br>If not set explicitly this parameter is set to the same value as the
3926 <a href="smb.conf.5.html#createmask"><strong>create mask</strong></a> parameter. To allow a user to
3927 modify all the user/group/world permissions on a file, set this
3928 parameter to 0777.
3929 <p><br><em>Note</em> that users who can access the Samba server through other
3930 means can easily bypass this restriction, so it is primarily
3931 useful for standalone "appliance" systems.  Administrators of
3932 most normal systems will probably want to set it to 0777.
3933 <p><br>See also the <a href="smb.conf.5.html#forcedirectorysecuritymode"><strong>force directory security
3934 mode</strong></a>, <a href="smb.conf.5.html#directorysecuritymask"><strong>directory security
3935 mask</strong></a>, <a href="smb.conf.5.html#forcesecuritymode"><strong>force security
3936 mode</strong></a> parameters.
3937 <p><br><strong>Default:</strong>
3938 <code>  security mask = &lt;same as create mask&gt;</code>
3939 <p><br><strong>Example:</strong>
3940 <code>  security mask = 0777</code>
3941 <p><br><a name="serverstring"></a>
3942 <li><strong><strong>server string (G)</strong></strong>
3943 <p><br>This controls what string will show up in the printer comment box in
3944 print manager and next to the IPC connection in <code>"net view"</code>. It can be
3945 any string that you wish to show to your users.
3946 <p><br>It also sets what will appear in browse lists next to the machine
3947 name.
3948 <p><br>A <code>"%v"</code> will be replaced with the Samba version number.
3949 <p><br>A <code>"%h"</code> will be replaced with the hostname.
3950 <p><br><strong>Default:</strong>
3951 <code>  server string = Samba %v</code>
3952 <p><br><strong>Example:</strong>
3953 <code>  server string = University of GNUs Samba Server</code>
3954 <p><br><a name="setdirectory"></a>
3955 <li><strong><strong>set directory (S)</strong></strong>
3956 <p><br>If <code>"set directory = no"</code>, then users of the service may not use the
3957 setdir command to change directory.
3958 <p><br>The setdir command is only implemented in the Digital Pathworks
3959 client. See the Pathworks documentation for details.
3960 <p><br><strong>Default:</strong>
3961 <code>  set directory = no</code>
3962 <p><br><strong>Example:</strong>
3963 <code>  set directory = yes</code>
3964 <p><br><a name="sharemodes"></a>
3965 <li><strong><strong>share modes (S)</strong></strong>
3966 <p><br>This enables or disables the honoring of the <code>"share modes"</code> during a
3967 file open. These modes are used by clients to gain exclusive read or
3968 write access to a file.
3969 <p><br>These open modes are not directly supported by UNIX, so they are
3970 simulated using shared memory, or lock files if your UNIX doesn't
3971 support shared memory (almost all do).
3972 <p><br>The share modes that are enabled by this option are DENY_DOS,
3973 DENY_ALL, DENY_READ, DENY_WRITE, DENY_NONE and DENY_FCB.
3974 <p><br>This option gives full share compatibility and enabled by default.
3975 <p><br>You should <em>*NEVER*</em> turn this parameter off as many Windows
3976 applications will break if you do so.
3977 <p><br><strong>Default:</strong>
3978 <code>  share modes = yes</code>
3979 <p><br><a name="sharedmemsize"></a>
3980 <li><strong><strong>shared mem size (G)</strong></strong>
3981 <p><br>It specifies the size of the shared memory (in bytes) to use between
3982 <a href="smbd.8.html"><strong>smbd</strong></a> processes. This parameter defaults to one
3983 megabyte of shared memory. It is possible that if you have a large
3984 server with many files open simultaneously that you may need to
3985 increase this parameter. Signs that this parameter is set too low are
3986 users reporting strange problems trying to save files (locking errors)
3987 and error messages in the smbd log looking like <code>"ERROR
3988 smb_shm_alloc : alloc of XX bytes failed"</code>.
3989 <p><br>If your OS refuses the size that Samba asks for then Samba will try a
3990 smaller size, reducing by a factor of 0.8 until the OS accepts it.
3991 <p><br><strong>Default:</strong>
3992 <code>  shared mem size = 1048576</code>
3993 <p><br><strong>Example:</strong>
3994 <code>  shared mem size = 5242880 ; Set to 5mb for a large number of files.</code>
3995 <p><br><a name="shortpreservecase"></a>
3996 <li><strong><strong>short preserve case (G)</strong></strong>
3997 <p><br>This boolean parameter controls if new files which conform to 8.3
3998 syntax, that is all in upper case and of suitable length, are created
3999 upper case, or if they are forced to be the <code>"default"</code> case. This
4000 option can be use with <a href="smb.conf.5.html#preservecaseoption"><strong>"preserve case
4001 =yes"</strong></a> to permit long filenames to retain their
4002 case, while short names are lowered. Default <em>Yes</em>.
4003 <p><br>See the section on <a href="smb.conf.5.html#NAMEMANGLING"><strong>NAME MANGLING</strong></a>.
4004 <p><br><strong>Default:</strong>
4005 <code>  short preserve case = yes</code>
4006 <p><br><a name="smbpasswdfile"></a>
4007 <li><strong><strong>smb passwd file (G)</strong></strong>
4008 <p><br>This option sets the path to the encrypted smbpasswd file.  By default
4009 the path to the smbpasswd file is compiled into Samba.
4010 <p><br><strong>Default:</strong>
4011 <code>  smb passwd file= &lt;compiled default&gt;</code>
4012 <p><br><strong>Example:</strong>
4013 <code>  smb passwd file = /usr/samba/private/smbpasswd</code>
4014 <p><br><a name="smbrun"></a>
4015 <li><strong><strong>smbrun (G)</strong></strong>
4016 <p><br>This sets the full path to the <strong>smbrun</strong> binary. This defaults to the
4017 value in the Makefile.
4018 <p><br>You must get this path right for many services to work correctly.
4019 <p><br>You should not need to change this parameter so long as Samba
4020 is installed correctly.
4021 <p><br><strong>Default:</strong>
4022 <code>  smbrun=&lt;compiled default&gt;</code>
4023 <p><br><strong>Example:</strong>
4024 <code>  smbrun = /usr/local/samba/bin/smbrun</code>
4025 <p><br><a name="socketaddress"></a>
4026 <li><strong><strong>socket address (G)</strong></strong>
4027 <p><br>This option allows you to control what address Samba will listen for
4028 connections on. This is used to support multiple virtual interfaces on
4029 the one server, each with a different configuration.
4030 <p><br>By default samba will accept connections on any address.
4031 <p><br><strong>Example:</strong>
4032 <code>  socket address = 192.168.2.20</code>
4033 <p><br><a name="socketoptions"></a>
4034 <li><strong><strong>socket options (G)</strong></strong>
4035 <p><br>This option allows you to set socket options to be used when talking
4036 with the client.
4037 <p><br>Socket options are controls on the networking layer of the operating
4038 systems which allow the connection to be tuned.
4039 <p><br>This option will typically be used to tune your Samba server for
4040 optimal performance for your local network. There is no way that Samba
4041 can know what the optimal parameters are for your net, so you must
4042 experiment and choose them yourself. We strongly suggest you read the
4043 appropriate documentation for your operating system first (perhaps
4044 <strong>"man setsockopt"</strong> will help).
4045 <p><br>You may find that on some systems Samba will say "Unknown socket
4046 option" when you supply an option. This means you either incorrectly
4047 typed it or you need to add an include file to includes.h for your OS.
4048 If the latter is the case please send the patch to
4049 <a href="mailto:samba-bugs@samba.org"><em>samba-bugs@samba.org</em></a>.
4050 <p><br>Any of the supported socket options may be combined in any way you
4051 like, as long as your OS allows it.
4052 <p><br>This is the list of socket options currently settable using this
4053 option:
4054 <p><br><ul>
4055 <p><br><li > SO_KEEPALIVE
4056 <p><br><li > SO_REUSEADDR
4057 <p><br><li > SO_BROADCAST
4058 <p><br><li > TCP_NODELAY
4059 <p><br><li > IPTOS_LOWDELAY
4060 <p><br><li > IPTOS_THROUGHPUT
4061 <p><br><li > SO_SNDBUF *
4062 <p><br><li > SO_RCVBUF *
4063 <p><br><li > SO_SNDLOWAT *
4064 <p><br><li > SO_RCVLOWAT *
4065 <p><br></ul>
4066 <p><br>Those marked with a <code>*</code> take an integer argument. The others can
4067 optionally take a 1 or 0 argument to enable or disable the option, by
4068 default they will be enabled if you don't specify 1 or 0.
4069 <p><br>To specify an argument use the syntax SOME_OPTION=VALUE for example
4070 <code>SO_SNDBUF=8192</code>. Note that you must not have any spaces before or after
4071 the = sign.
4072 <p><br>If you are on a local network then a sensible option might be
4073 <p><br><code>socket options = IPTOS_LOWDELAY</code>
4074 <p><br>If you have a local network then you could try:
4075 <p><br><code>socket options = IPTOS_LOWDELAY TCP_NODELAY</code>
4076 <p><br>If you are on a wide area network then perhaps try setting
4077 IPTOS_THROUGHPUT.
4078 <p><br>Note that several of the options may cause your Samba server to fail
4079 completely. Use these options with caution!
4080 <p><br><strong>Default:</strong>
4081 <code>  socket options = TCP_NODELAY</code>
4082 <p><br><strong>Example:</strong>
4083 <code>  socket options = IPTOS_LOWDELAY</code>
4084 <p><br><a name="ssl"></a>
4085 <li><strong><strong>ssl (G)</strong></strong>
4086 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4087 the SSL libraries have been compiled on your system and the configure
4088 option <code>"--with-ssl"</code> was given at configure time.
4089 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4090 enabled by default in any current binary version of Samba.
4091 <p><br>This variable enables or disables the entire SSL mode. If it is set to
4092 "no", the SSL enabled samba behaves exactly like the non-SSL samba. If
4093 set to "yes", it depends on the variables <a href="smb.conf.5.html#sslhosts"><strong>"ssl
4094 hosts"</strong></a> and <a href="smb.conf.5.html#sslhostsresign"><strong>"ssl hosts resign"</strong></a>
4095 whether an SSL connection will be required.
4096 <p><br><strong>Default:</strong>
4097 <code>  ssl=no</code>
4098   <strong>Example:</strong>
4099 <code>  ssl=yes</code>
4100 <p><br><a name="sslCAcertDir"></a>
4101 <li><strong><strong>ssl CA certDir (G)</strong></strong>
4102 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4103 the SSL libraries have been compiled on your system and the configure
4104 option <code>"--with-ssl"</code> was given at configure time.
4105 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4106 enabled by default in any current binary version of Samba.
4107 <p><br>This variable defines where to look up the Certification
4108 Authorities. The given directory should contain one file for each CA
4109 that samba will trust.  The file name must be the hash value over the
4110 "Distinguished Name" of the CA. How this directory is set up is
4111 explained later in this document. All files within the directory that
4112 don't fit into this naming scheme are ignored. You don't need this
4113 variable if you don't verify client certificates.
4114 <p><br><strong>Default:</strong>
4115 <code>  ssl CA certDir = /usr/local/ssl/certs</code>
4116 <p><br><a name="sslCAcertFile"></a>
4117 <li><strong><strong>ssl CA certFile (G)</strong></strong>
4118 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4119 the SSL libraries have been compiled on your system and the configure
4120 option <code>"--with-ssl"</code> was given at configure time.
4121 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4122 enabled by default in any current binary version of Samba.
4123 <p><br>This variable is a second way to define the trusted CAs. The
4124 certificates of the trusted CAs are collected in one big file and this
4125 variable points to the file. You will probably only use one of the two
4126 ways to define your CAs. The first choice is preferable if you have
4127 many CAs or want to be flexible, the second is preferable if you only
4128 have one CA and want to keep things simple (you won't need to create
4129 the hashed file names). You don't need this variable if you don't
4130 verify client certificates.
4131 <p><br><strong>Default:</strong>
4132 <code>  ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem</code>
4133 <p><br><a name="sslciphers"></a>
4134 <li><strong><strong>ssl ciphers (G)</strong></strong>
4135 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4136 the SSL libraries have been compiled on your system and the configure
4137 option <code>"--with-ssl"</code> was given at configure time.
4138 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4139 enabled by default in any current binary version of Samba.
4140 <p><br>This variable defines the ciphers that should be offered during SSL
4141 negotiation. You should not set this variable unless you know what you
4142 are doing.
4143 <p><br><a name="sslclientcert"></a>
4144 <li><strong><strong>ssl client cert (G)</strong></strong>
4145 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4146 the SSL libraries have been compiled on your system and the configure
4147 option <code>"--with-ssl"</code> was given at configure time.
4148 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4149 enabled by default in any current binary version of Samba.
4150 <p><br>The certificate in this file is used by
4151 <a href="smbclient.1.html"><strong>smbclient</strong></a> if it exists. It's needed if the
4152 server requires a client certificate.
4153 <p><br><strong>Default:</strong>
4154 <code>  ssl client cert = /usr/local/ssl/certs/smbclient.pem</code>
4155 <p><br><a name="sslclientkey"></a>
4156 <li><strong><strong>ssl client key (G)</strong></strong>
4157 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4158 the SSL libraries have been compiled on your system and the configure
4159 option <code>"--with-ssl"</code> was given at configure time.
4160 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4161 enabled by default in any current binary version of Samba.
4162 <p><br>This is the private key for <a href="smbclient.1.html"><strong>smbclient</strong></a>. It's
4163 only needed if the client should have a certificate.
4164 <p><br><strong>Default:</strong>
4165 <code>  ssl client key = /usr/local/ssl/private/smbclient.pem</code>
4166 <p><br><a name="sslcompatibility"></a>
4167 <li><strong><strong>ssl compatibility (G)</strong></strong>
4168 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4169 the SSL libraries have been compiled on your system and the configure
4170 option <code>"--with-ssl"</code> was given at configure time.
4171 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4172 enabled by default in any current binary version of Samba.
4173 <p><br>This variable defines whether SSLeay should be configured for bug
4174 compatibility with other SSL implementations. This is probably not
4175 desirable because currently no clients with SSL implementations other
4176 than SSLeay exist.
4177 <p><br><strong>Default:</strong>
4178 <code>  ssl compatibility = no</code>
4179 <p><br><a name="sslhosts"></a>
4180 <li><strong><strong>ssl hosts (G)</strong></strong>
4181 <p><br>See <a href="smb.conf.5.html#sslhostsresign"><strong>"ssl hosts resign"</strong></a>.
4182 <p><br><a name="sslhostsresign"></a>
4183 <li><strong><strong>ssl hosts resign (G)</strong></strong>
4184 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4185 the SSL libraries have been compiled on your system and the configure
4186 option <code>"--with-ssl"</code> was given at configure time.
4187 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4188 enabled by default in any current binary version of Samba.
4189 <p><br>These two variables define whether samba will go into SSL mode or
4190 not. If none of them is defined, samba will allow only SSL
4191 connections. If the <a href="smb.conf.5.html#sslhosts"><strong>"ssl hosts"</strong></a> variable lists
4192 hosts (by IP-address, IP-address range, net group or name), only these
4193 hosts will be forced into SSL mode. If the <strong>"ssl hosts resign"</strong>
4194 variable lists hosts, only these hosts will NOT be forced into SSL
4195 mode. The syntax for these two variables is the same as for the
4196 <a href="smb.conf.5.html#hostsallow"><strong>"hosts allow"</strong></a> and <a href="smb.conf.5.html#hostsdeny"><strong>"hosts
4197 deny"</strong></a> pair of variables, only that the subject of the
4198 decision is different: It's not the access right but whether SSL is
4199 used or not. See the <a href="smb.conf.5.html#allowhosts"><strong>"allow hosts"</strong></a> parameter for
4200 details. The example below requires SSL connections from all hosts
4201 outside the local net (which is 192.168.*.*).
4202 <p><br><strong>Default:</strong>
4203 <code>  ssl hosts = &lt;empty string&gt;</code>
4204 <code>  ssl hosts resign = &lt;empty string&gt;</code>
4205 <p><br><strong>Example:</strong>
4206 <code>  ssl hosts resign = 192.168.</code>
4207 <p><br><a name="sslrequireclientcert"></a>
4208 <li><strong><strong>ssl require clientcert (G)</strong></strong>
4209 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4210 the SSL libraries have been compiled on your system and the configure
4211 option <code>"--with-ssl"</code> was given at configure time.
4212 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4213 enabled by default in any current binary version of Samba.
4214 <p><br>If this variable is set to <code>"yes"</code>, the server will not tolerate
4215 connections from clients that don't have a valid certificate. The
4216 directory/file given in <a href="smb.conf.5.html#sslCAcertDir"><strong>"ssl CA certDir"</strong></a> and
4217 <a href="smb.conf.5.html#sslCAcertFile"><strong>"ssl CA certFile"</strong></a> will be used to look up the
4218 CAs that issued the client's certificate. If the certificate can't be
4219 verified positively, the connection will be terminated.  If this
4220 variable is set to <code>"no"</code>, clients don't need certificates. Contrary
4221 to web applications you really <em>*should*</em> require client
4222 certificates. In the web environment the client's data is sensitive
4223 (credit card numbers) and the server must prove to be trustworthy. In
4224 a file server environment the server's data will be sensitive and the
4225 clients must prove to be trustworthy.
4226 <p><br><strong>Default:</strong>
4227 <code>  ssl require clientcert = no</code>
4228 <p><br><a name="sslrequireservercert"></a>
4229 <li><strong><strong>ssl require servercert (G)</strong></strong>
4230 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4231 the SSL libraries have been compiled on your system and the configure
4232 option <code>"--with-ssl"</code> was given at configure time.
4233 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4234 enabled by default in any current binary version of Samba.
4235 <p><br>If this variable is set to <code>"yes"</code>, the
4236 <a href="smbclient.1.html"><strong>smbclient</strong></a> will request a certificate from
4237 the server. Same as <a href="smb.conf.5.html#sslrequireclientcert"><strong>"ssl require
4238 clientcert"</strong></a> for the server.
4239 <p><br><strong>Default:</strong>
4240 <code>  ssl require servercert = no</code>
4241 <p><br><a name="sslservercert"></a>
4242 <li><strong><strong>ssl server cert (G)</strong></strong>
4243 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4244 the SSL libraries have been compiled on your system and the configure
4245 option <code>"--with-ssl"</code> was given at configure time.
4246 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4247 enabled by default in any current binary version of Samba.
4248 <p><br>This is the file containing the server's certificate. The server _must_
4249 have a certificate. The file may also contain the server's private key.
4250 See later for how certificates and private keys are created.
4251 <p><br><strong>Default:</strong>
4252 <code>  ssl server cert = &lt;empty string&gt;</code>
4253 <p><br><a name="sslserverkey"></a>
4254 <li><strong><strong>ssl server key (G)</strong></strong>
4255 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4256 the SSL libraries have been compiled on your system and the configure
4257 option <code>"--with-ssl"</code> was given at configure time.
4258 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4259 enabled by default in any current binary version of Samba.
4260 <p><br>This file contains the private key of the server. If this variable is
4261 not defined, the key is looked up in the certificate file (it may be
4262 appended to the certificate). The server <em>*must*</em> have a private key
4263 and the certificate <em>*must*</em> match this private key.
4264 <p><br><strong>Default:</strong>
4265 <code>  ssl server key = &lt;empty string&gt;</code>
4266 <p><br><a name="sslversion"></a>
4267 <li><strong><strong>ssl version (G)</strong></strong>
4268 <p><br>This variable is part of SSL-enabled Samba. This is only available if
4269 the SSL libraries have been compiled on your system and the configure
4270 option <code>"--with-ssl"</code> was given at configure time.
4271 <p><br><em>Note</em> that for export control reasons this code is <em>**NOT**</em>
4272 enabled by default in any current binary version of Samba.
4273 <p><br>This enumeration variable defines the versions of the SSL protocol
4274 that will be used. <code>"ssl2or3"</code> allows dynamic negotiation of SSL v2
4275 or v3, <code>"ssl2"</code> results in SSL v2, <code>"ssl3"</code> results in SSL v3 and
4276 "tls1" results in TLS v1. TLS (Transport Layer Security) is the
4277 (proposed?) new standard for SSL.
4278 <p><br><strong>Default:</strong>
4279 <code>  ssl version = "ssl2or3"</code>
4280 <p><br><a name="statcache"></a>
4281 <li><strong><strong>stat cache (G)</strong></strong>
4282 <p><br>This parameter determines if <a href="smbd.8.html"><strong>smbd</strong></a> will use a
4283 cache in order to speed up case insensitive name mappings. You should
4284 never need to change this parameter.
4285 <p><br><strong>Default:</strong>
4286 <code>  stat cache = yes</code>
4287 <p><br><a name="statcachesize"></a>
4288 <li><strong><strong>stat cache size (G)</strong></strong>
4289 <p><br>This parameter determines the number of entries in the <a href="smb.conf.5.html#statcache"><strong>stat
4290 cache</strong></a>.  You should never need to change this parameter.
4291 <p><br><strong>Default:</strong>
4292 <code>  stat cache size = 50</code>
4293 <p><br><a name="status"></a>
4294 <li><strong><strong>status (G)</strong></strong>
4295 <p><br>This enables or disables logging of connections to a status file that
4296 <a href="smbstatus.1.html"><strong>smbstatus</strong></a> can read.
4297 <p><br>With this disabled <a href="smbstatus.1.html"><strong>smbstatus</strong></a> won't be able
4298 to tell you what connections are active. You should never need to
4299 change this parameter.
4300 <p><br><strong>Default:</strong>
4301         status = yes
4302 <p><br><a name="strictlocking"></a>
4303 <li><strong><strong>strict locking (S)</strong></strong>
4304 <p><br>This is a boolean that controls the handling of file locking in the
4305 server. When this is set to <code>"yes"</code> the server will check every read and
4306 write access for file locks, and deny access if locks exist. This can
4307 be slow on some systems.
4308 <p><br>When strict locking is <code>"no"</code> the server does file lock checks only
4309 when the client explicitly asks for them.
4310 <p><br>Well behaved clients always ask for lock checks when it is important,
4311 so in the vast majority of cases <strong>"strict locking = no"</strong> is
4312 preferable.
4313 <p><br><strong>Default:</strong>
4314 <code>  strict locking = no</code>
4315 <p><br><strong>Example:</strong>
4316 <code>  strict locking = yes</code>
4317 <p><br><a name="strictsync"></a>
4318 <li><strong><strong>strict sync (S)</strong></strong>
4319 <p><br>Many Windows applications (including the Windows 98 explorer shell)
4320 seem to confuse flushing buffer contents to disk with doing a sync to
4321 disk. Under UNIX, a sync call forces the process to be suspended until
4322 the kernel has ensured that all outstanding data in kernel disk
4323 buffers has been safely stored onto stable storage. This is very slow
4324 and should only be done rarely. Setting this parameter to "no" (the
4325 default) means that smbd ignores the Windows applications requests for
4326 a sync call. There is only a possibility of losing data if the
4327 operating system itself that Samba is running on crashes, so there is
4328 little danger in this default setting. In addition, this fixes many
4329 performance problems that people have reported with the new Windows98
4330 explorer shell file copies.
4331 <p><br>See also the <a href="smb.conf.5.html#syncalways"><strong>"sync always"</strong></a> parameter.
4332 <p><br><strong>Default:</strong>
4333 <code>  strict sync = no</code>
4334 <p><br><strong>Example:</strong>
4335 <code>  strict sync = yes</code>
4336 <p><br><a name="stripdot"></a>
4337 <li><strong><strong>strip dot (G)</strong></strong>
4338 <p><br>This is a boolean that controls whether to strip trailing dots off
4339 UNIX filenames. This helps with some CDROMs that have filenames ending
4340 in a single dot.
4341 <p><br><strong>Default:</strong>
4342 <code>  strip dot = no</code>
4343 <p><br><strong>Example:</strong>
4344 <code>  strip dot = yes</code>
4345 <p><br><a name="syncalways"></a>
4346 <li><strong><strong>sync always (S)</strong></strong>
4347 <p><br>This is a boolean parameter that controls whether writes will always
4348 be written to stable storage before the write call returns. If this is
4349 false then the server will be guided by the client's request in each
4350 write call (clients can set a bit indicating that a particular write
4351 should be synchronous). If this is true then every write will be
4352 followed by a fsync() call to ensure the data is written to disk.
4353 Note that the <a href="smb.conf.5.html#strictsync"><strong>"strict sync"</strong></a> parameter must be
4354 set to <code>"yes"</code> in order for this parameter to have any affect.
4355 <p><br>See also the <a href="smb.conf.5.html#strictsync"><strong>"strict sync"</strong></a> parameter.
4356 <p><br><strong>Default:</strong>
4357 <code>  sync always = no</code>
4358 <p><br><strong>Example:</strong>
4359 <code>  sync always = yes</code>
4360 <p><br><a name="syslog"></a>
4361 <li><strong><strong>syslog (G)</strong></strong>
4362 <p><br>This parameter maps how Samba debug messages are logged onto the
4363 system syslog logging levels. Samba debug level zero maps onto syslog
4364 LOG_ERR, debug level one maps onto LOG_WARNING, debug level two maps
4365 onto LOG_NOTICE, debug level three maps onto LOG_INFO. All higher
4366 levels are mapped to LOG_DEBUG.
4367 <p><br>This paramter sets the threshold for sending messages to syslog.
4368 Only messages with debug level less than this value will be sent
4369 to syslog.
4370 <p><br><strong>Default:</strong>
4371 <code>  syslog = 1</code>
4372 <p><br><a name="syslogonly"></a>
4373 <li><strong><strong>syslog only (G)</strong></strong>
4374 <p><br>If this parameter is set then Samba debug messages are logged into the
4375 system syslog only, and not to the debug log files.
4376 <p><br><strong>Default:</strong>
4377 <code>  syslog only = no</code>
4378 <p><br><a name="timeoffset"></a>
4379 <li><strong><strong>time offset (G)</strong></strong>
4380 <p><br>This parameter is a setting in minutes to add to the normal GMT to
4381 local time conversion. This is useful if you are serving a lot of PCs
4382 that have incorrect daylight saving time handling.
4383 <p><br><strong>Default:</strong>
4384 <code>  time offset = 0</code>
4385 <p><br><strong>Example:</strong>
4386 <code>  time offset = 60</code>
4387 <p><br><a name="timeserver"></a>
4388 <p><br><li><strong><strong>time server (G)</strong></strong>
4389 <p><br>This parameter determines if <a href="nmbd.8.html"><strong>nmbd</strong></a> advertises
4390 itself as a time server to Windows clients. The default is False.
4391 <p><br><strong>Default:</strong>
4392 <code>  time server = False</code>
4393 <p><br><strong>Example:</strong>
4394 <code>  time server = True</code>
4395 <p><br><a name="timestamplogs"></a>
4396 <li><strong><strong>timestamp logs (G)</strong></strong>
4397 <p><br>Samba2.0 will a timestamps to all log entries by default. This
4398 can be distracting if you are attempting to debug a problem. This
4399 parameter allows the timestamping to be turned off.
4400 <p><br><strong>Default:</strong>
4401 <code>  timestamp logs = True</code>
4402 <p><br><strong>Example:</strong>
4403 <code>  timestamp logs = False</code>
4404 <p><br><a name="unixpasswordsync"></a>
4405 <li><strong><strong>unix password sync (G)</strong></strong>
4406 <p><br>This boolean parameter controls whether Samba attempts to synchronize
4407 the UNIX password with the SMB password when the encrypted SMB
4408 password in the smbpasswd file is changed. If this is set to true the
4409 program specified in the <a href="smb.conf.5.html#passwdprogram"><strong>"passwd program"</strong></a>
4410 parameter is called <em>*AS ROOT*</em> - to allow the new UNIX password to be
4411 set without access to the old UNIX password (as the SMB password has
4412 change code has no access to the old password cleartext, only the
4413 new). By default this is set to <code>"false"</code>.
4414 <p><br>See also <a href="smb.conf.5.html#passwdprogram"><strong>"passwd program"</strong></a>, <a href="smb.conf.5.html#passwdchat"><strong>"passwd
4415 chat"</strong></a>.
4416 <p><br><strong>Default:</strong>
4417 <code>  unix password sync = False</code>
4418 <p><br><strong>Example:</strong>
4419 <code>  unix password sync = True</code>
4420 <p><br><a name="unixrealname"></a>
4421 <li><strong><strong>unix realname (G)</strong></strong>
4422 <p><br>This boolean parameter when set causes samba to supply the real name
4423 field from the unix password file to the client. This is useful for
4424 setting up mail clients and WWW browsers on systems used by more than
4425 one person.
4426 <p><br><strong>Default:</strong>
4427 <code>  unix realname = no</code>
4428 <p><br><strong>Example:</strong>
4429 <code>  unix realname = yes</code>
4430 <p><br><a name="updateencrypted"></a>
4431 <li><strong><strong>update encrypted (G)</strong></strong>
4432 <p><br>This boolean parameter allows a user logging on with a plaintext
4433 password to have their encrypted (hashed) password in the smbpasswd
4434 file to be updated automatically as they log on. This option allows a
4435 site to migrate from plaintext password authentication (users
4436 authenticate with plaintext password over the wire, and are checked
4437 against a UNIX account database) to encrypted password authentication
4438 (the SMB challenge/response authentication mechanism) without forcing
4439 all users to re-enter their passwords via smbpasswd at the time the
4440 change is made. This is a convenience option to allow the change over
4441 to encrypted passwords to be made over a longer period. Once all users
4442 have encrypted representations of their passwords in the smbpasswd
4443 file this parameter should be set to <code>"off"</code>.
4444 <p><br>In order for this parameter to work correctly the <a href="smb.conf.5.html#encryptpasswords"><strong>"encrypt
4445 passwords"</strong></a> parameter must be set to <code>"no"</code> when
4446 this parameter is set to <code>"yes"</code>.
4447 <p><br>Note that even when this parameter is set a user authenticating to
4448 smbd must still enter a valid password in order to connect correctly,
4449 and to update their hashed (smbpasswd) passwords.
4450 <p><br><strong>Default:</strong>
4451 <code>  update encrypted = no</code>
4452 <p><br><strong>Example:</strong>
4453 <code>  update encrypted = yes</code>
4454 <p><br><a name="userhosts"></a>
4455 <li><strong><strong>use rhosts (G)</strong></strong>
4456 <p><br>If this global parameter is a true, it specifies that the UNIX users
4457 <code>".rhosts"</code> file in their home directory will be read to find the
4458 names of hosts and users who will be allowed access without specifying
4459 a password.
4460 <p><br>NOTE: The use of <strong>use rhosts</strong> can be a major security hole. This is
4461 because you are trusting the PC to supply the correct username. It is
4462 very easy to get a PC to supply a false username. I recommend that the
4463 <strong>use rhosts</strong> option be only used if you really know what you are
4464 doing.
4465 <p><br><strong>Default:</strong>
4466 <code>  use rhosts = no</code>
4467 <p><br><strong>Example:</strong>
4468 <code>  use rhosts = yes</code>
4469 <p><br><a name="user"></a>
4470 <li><strong><strong>user (S)</strong></strong>
4471 <p><br>Synonym for <a href="smb.conf.5.html#username"><strong>"username"</strong></a>.
4472 <p><br><a name="users"></a>
4473 <li><strong><strong>users (S)</strong></strong>
4474 <p><br>Synonym for <a href="smb.conf.5.html#username"><strong>"username"</strong></a>.
4475 <p><br><a name="username"></a>
4476 <li><strong><strong>username (S)</strong></strong>
4477 <p><br>Multiple users may be specified in a comma-delimited list, in which
4478 case the supplied password will be tested against each username in
4479 turn (left to right).
4480 <p><br>The <strong>username=</strong> line is needed only when the PC is unable to supply
4481 its own username. This is the case for the COREPLUS protocol or where
4482 your users have different WfWg usernames to UNIX usernames. In both
4483 these cases you may also be better using the <code>\\server\share%user</code>
4484 syntax instead.
4485 <p><br>The <strong>username=</strong> line is not a great solution in many cases as it
4486 means Samba will try to validate the supplied password against each of
4487 the usernames in the username= line in turn. This is slow and a bad
4488 idea for lots of users in case of duplicate passwords. You may get
4489 timeouts or security breaches using this parameter unwisely.
4490 <p><br>Samba relies on the underlying UNIX security. This parameter does not
4491 restrict who can login, it just offers hints to the Samba server as to
4492 what usernames might correspond to the supplied password. Users can
4493 login as whoever they please and they will be able to do no more
4494 damage than if they started a telnet session. The daemon runs as the
4495 user that they log in as, so they cannot do anything that user cannot
4496 do.
4497 <p><br>To restrict a service to a particular set of users you can use the
4498 <a href="smb.conf.5.html#validusers"><strong>"valid users="</strong></a> parameter.
4499 <p><br>If any of the usernames begin with a <code>'@'</code> then the name will be
4500 looked up first in the yp netgroups list (if Samba is compiled with
4501 netgroup support), followed by a lookup in the UNIX groups database
4502 and will expand to a list of all users in the group of that name.
4503 <p><br>If any of the usernames begin with a <code>'+'</code> then the name will be
4504 looked up only in the UNIX groups database and will expand to a list
4505 of all users in the group of that name.
4506 <p><br>If any of the usernames begin with a <code>'&amp;'</code> then the name will be
4507 looked up only in the yp netgroups database (if Samba is compiled with
4508 netgroup support) and will expand to a list of all users in the
4509 netgroup group of that name.
4510 <p><br>Note that searching though a groups database can take quite some time,
4511 and some clients may time out during the search.
4512 <p><br>See the section <a href="smb.conf.5.html#NOTEABOUTUSERNAMEPASSWORDVALIDATION"><strong>"NOTE ABOUT USERNAME/PASSWORD
4513 VALIDATION"</strong></a> for more
4514 information on how this parameter determines access to the services.
4515 <p><br><strong>Default:</strong>
4516 <code>  The guest account if a guest service, else the name of the service.</code>
4517 <p><br><strong>Examples:</strong>
4518 <pre>
4519
4520         username = fred
4521         username = fred, mary, jack, jane, @users, @pcgroup
4522
4523 </pre>
4524
4525 <p><br><a name="usernamelevel"></a>
4526 <li><strong><strong>username level (G)</strong></strong>
4527 <p><br>This option helps Samba to try and 'guess' at the real UNIX username,
4528 as many DOS clients send an all-uppercase username. By default Samba
4529 tries all lowercase, followed by the username with the first letter
4530 capitalized, and fails if the username is not found on the UNIX
4531 machine.
4532 <p><br>If this parameter is set to non-zero the behavior changes. This
4533 parameter is a number that specifies the number of uppercase
4534 combinations to try whilst trying to determine the UNIX user name. The
4535 higher the number the more combinations will be tried, but the slower
4536 the discovery of usernames will be. Use this parameter when you have
4537 strange usernames on your UNIX machine, such as <code>"AstrangeUser"</code>.
4538 <p><br><strong>Default:</strong>
4539 <code>  username level = 0</code>
4540 <p><br><strong>Example:</strong>
4541 <code>  username level = 5</code>
4542 <p><br><a name="usernamemap"></a>
4543 <li><strong><strong>username map (G)</strong></strong>
4544 <p><br>This option allows you to specify a file containing a mapping of
4545 usernames from the clients to the server. This can be used for several
4546 purposes. The most common is to map usernames that users use on DOS or
4547 Windows machines to those that the UNIX box uses. The other is to map
4548 multiple users to a single username so that they can more easily share
4549 files.
4550 <p><br>The map file is parsed line by line. Each line should contain a single
4551 UNIX username on the left then a <code>'='</code> followed by a list of
4552 usernames on the right. The list of usernames on the right may contain
4553 names of the form @group in which case they will match any UNIX
4554 username in that group. The special client name <code>'*'</code> is a wildcard
4555 and matches any name. Each line of the map file may be up to 1023
4556 characters long.
4557 <p><br>The file is processed on each line by taking the supplied username and
4558 comparing it with each username on the right hand side of the <code>'='</code>
4559 signs. If the supplied name matches any of the names on the right hand
4560 side then it is replaced with the name on the left. Processing then
4561 continues with the next line.
4562 <p><br>If any line begins with a <code>'#'</code> or a <code>';'</code> then it is ignored
4563 <p><br>If any line begins with an <code>'!'</code> then the processing will stop after
4564 that line if a mapping was done by the line. Otherwise mapping
4565 continues with every line being processed. Using <code>'!'</code> is most
4566 useful when you have a wildcard mapping line later in the file.
4567 <p><br>For example to map from the name <code>"admin"</code> or <code>"administrator"</code> to
4568 the UNIX name <code>"root"</code> you would use:
4569 <p><br><code>   root = admin administrator</code>
4570 <p><br>Or to map anyone in the UNIX group <code>"system"</code> to the UNIX name
4571 <code>"sys"</code> you would use:
4572 <p><br><code>   sys = @system</code>
4573 <p><br>You can have as many mappings as you like in a username map file.
4574 <p><br>If your system supports the NIS NETGROUP option then the netgroup
4575 database is checked before the <code>/etc/group</code> database for matching
4576 groups.
4577 <p><br>You can map Windows usernames that have spaces in them by using double
4578 quotes around the name. For example:
4579 <p><br><code>   tridge = "Andrew Tridgell"</code>
4580 <p><br>would map the windows username <code>"Andrew Tridgell"</code> to the unix
4581 username tridge.
4582 <p><br>The following example would map mary and fred to the unix user sys,
4583 and map the rest to guest. Note the use of the <code>'!'</code> to tell Samba
4584 to stop processing if it gets a match on that line.
4585 <p><br><pre>
4586
4587         !sys = mary fred
4588         guest = *
4589
4590 </pre>
4591
4592 <p><br>Note that the remapping is applied to all occurrences of
4593 usernames. Thus if you connect to <code>"\\server\fred"</code> and <code>"fred"</code>
4594 is remapped to <code>"mary"</code> then you will actually be connecting to
4595 <code>"\\server\mary"</code> and will need to supply a password suitable for
4596 <code>"mary"</code> not <code>"fred"</code>. The only exception to this is the username
4597 passed to the <a href="smb.conf.5.html#passwordserver"><strong>"password server"</strong></a> (if you have
4598 one). The password server will receive whatever username the client
4599 supplies without modification.
4600 <p><br>Also note that no reverse mapping is done. The main effect this has is
4601 with printing. Users who have been mapped may have trouble deleting
4602 print jobs as PrintManager under WfWg will think they don't own the
4603 print job.
4604 <p><br><strong>Default:</strong>
4605 <code>  no username map</code>
4606 <p><br><strong>Example:</strong>
4607 <code>  username map = /usr/local/samba/lib/users.map</code>
4608 <p><br><a name="validchars"></a>
4609 <li><strong><strong>valid chars (S)</strong></strong>
4610 <p><br>The option allows you to specify additional characters that should be
4611 considered valid by the server in filenames. This is particularly
4612 useful for national character sets, such as adding u-umlaut or a-ring.
4613 <p><br>The option takes a list of characters in either integer or character
4614 form with spaces between them. If you give two characters with a colon
4615 between them then it will be taken as an lowercase:uppercase pair.
4616 <p><br>If you have an editor capable of entering the characters into the
4617 config file then it is probably easiest to use this method. Otherwise
4618 you can specify the characters in octal, decimal or hexadecimal form
4619 using the usual C notation.
4620 <p><br>For example to add the single character <code>'Z'</code> to the charset (which
4621 is a pointless thing to do as it's already there) you could do one of
4622 the following
4623 <p><br><pre>
4624
4625         valid chars = Z
4626         valid chars = z:Z
4627         valid chars = 0132:0172
4628
4629 </pre>
4630
4631 <p><br>The last two examples above actually add two characters, and alter the
4632 uppercase and lowercase mappings appropriately.
4633 <p><br>Note that you MUST specify this parameter after the <a href="smb.conf.5.html#clientcodepage"><strong>"client
4634 code page"</strong></a> parameter if you have both set. If
4635 <a href="smb.conf.5.html#clientcodepage"><strong>"client code page"</strong></a> is set after the
4636 <strong>"valid chars"</strong> parameter the <strong>"valid chars"</strong> settings will be
4637 overwritten.
4638 <p><br>See also the <a href="smb.conf.5.html#clientcodepage"><strong>"client code page"</strong></a> parameter.
4639 <p><br><strong>Default:</strong>
4640 <pre>
4641
4642         Samba defaults to using a reasonable set of valid characters
4643         for English systems
4644
4645 </pre>
4646
4647 <p><br><strong>Example</strong>
4648 <code>  valid chars = 0345:0305 0366:0326 0344:0304</code>
4649 <p><br>The above example allows filenames to have the Swedish characters in
4650 them.
4651 <p><br>NOTE: It is actually quite difficult to correctly produce a <strong>"valid
4652 chars"</strong> line for a particular system. To automate the process
4653 <a href="mailto:tino@augsburg.net"><em>tino@augsburg.net</em></a> has written a package called <strong>"validchars"</strong>
4654 which will automatically produce a complete <strong>"valid chars"</strong> line for
4655 a given client system. Look in the examples/validchars/ subdirectory
4656 of your Samba source code distribution for this package.
4657 <p><br><a name="validusers"></a>
4658 <li><strong><strong>valid users (S)</strong></strong>
4659 <p><br>This is a list of users that should be allowed to login to this
4660 service. Names starting with <code>'@'</code>, <code>'+'</code> and <code>'&amp;'</code> are
4661 interpreted using the same rules as described in the <a href="smb.conf.5.html#invalidusers"><strong>"invalid
4662 users"</strong></a> parameter.
4663 <p><br>If this is empty (the default) then any user can login. If a username
4664 is in both this list and the <a href="smb.conf.5.html#invalidusers"><strong>"invalid users"</strong></a>
4665 list then access is denied for that user.
4666 <p><br>The current servicename is substituted for
4667 <a href="smb.conf.5.html#percentS"><strong>"%S"</strong></a>. This is useful in the
4668 <a href="smb.conf.5.html#homes"><strong>[homes]</strong></a> section.
4669 <p><br>See also <a href="smb.conf.5.html#invalidusers"><strong>"invalid users"</strong></a>.
4670 <p><br><strong>Default:</strong>
4671 <code>  No valid users list. (anyone can login)</code>
4672 <p><br><strong>Example:</strong>
4673 <code>  valid users = greg, @pcusers</code>
4674 <p><br><a name="vetofiles"></a>
4675 <li><strong><strong>veto files(S)</strong></strong>
4676 <p><br>This is a list of files and directories that are neither visible nor
4677 accessible.  Each entry in the list must be separated by a <code>'/'</code>,
4678 which allows spaces to be included in the entry. <code>'*'</code> and <code>'?'</code>
4679 can be used to specify multiple files or directories as in DOS
4680 wildcards.
4681 <p><br>Each entry must be a unix path, not a DOS path and must <em>*not*</em> include the
4682 unix directory separator <code>'/'</code>.
4683 <p><br>Note that the <a href="smb.conf.5.html#casesensitive"><strong>"case sensitive"</strong></a> option is
4684 applicable in vetoing files.
4685 <p><br>One feature of the veto files parameter that it is important to be
4686 aware of, is that if a directory contains nothing but files that match
4687 the veto files parameter (which means that Windows/DOS clients cannot
4688 ever see them) is deleted, the veto files within that directory *are
4689 automatically deleted* along with it, if the user has UNIX permissions
4690 to do so.
4691 <p><br>Setting this parameter will affect the performance of Samba, as it
4692 will be forced to check all files and directories for a match as they
4693 are scanned.
4694 <p><br>See also <a href="smb.conf.5.html#hidefiles"><strong>"hide files"</strong></a> and <a href="smb.conf.5.html#casesensitive"><strong>"case
4695 sensitive"</strong></a>.
4696 <p><br><strong>Default:</strong>
4697 <code>  No files or directories are vetoed.</code>
4698 <p><br><strong>Examples:</strong>
4699 <p><br>Example 1.
4700 <p><br><pre>
4701
4702
4703     Veto any files containing the word Security,
4704     any ending in .tmp, and any directory containing the
4705     word root.
4706
4707         veto files = /*Security*/*.tmp/*root*/
4708
4709 </pre>
4710
4711 <p><br>Example 2.
4712 <p><br><pre>
4713
4714     Veto the Apple specific files that a NetAtalk server
4715     creates.
4716
4717     veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
4718
4719 </pre>
4720
4721 <p><br><a name="vetooplockfiles"></a>
4722 <li><strong><strong>veto oplock files (S)</strong></strong>
4723 <p><br>This parameter is only valid when the <a href="smb.conf.5.html#oplocks"><strong>"oplocks"</strong></a>
4724 parameter is turned on for a share. It allows the Samba administrator
4725 to selectively turn off the granting of oplocks on selected files that
4726 match a wildcarded list, similar to the wildcarded list used in the
4727 <a href="smb.conf.5.html#vetofiles"><strong>"veto files"</strong></a> parameter.
4728 <p><br><strong>Default:</strong>
4729 <code>  No files are vetoed for oplock grants.</code>
4730 <p><br><strong>Examples:</strong>
4731 <p><br>You might want to do this on files that you know will be heavily
4732 contended for by clients. A good example of this is in the NetBench
4733 SMB benchmark program, which causes heavy client contention for files
4734 ending in <code>".SEM"</code>. To cause Samba not to grant oplocks on these
4735 files you would use the line (either in the <a href="smb.conf.5.html#global"><strong>[global]</strong></a>
4736 section or in the section for the particular NetBench share :
4737 <p><br><code>     veto oplock files = /*.SEM/</code>
4738 <p><br><a name="volume"></a>
4739 <li><strong><strong>volume (S)</strong></strong>
4740 <p><br>This allows you to override the volume label returned for a
4741 share. Useful for CDROMs with installation programs that insist on a
4742 particular volume label.
4743 <p><br>The default is the name of the share.
4744 <p><br><a name="widelinks"></a>
4745 <li><strong><strong>wide links (S)</strong></strong>
4746 <p><br>This parameter controls whether or not links in the UNIX file system
4747 may be followed by the server. Links that point to areas within the
4748 directory tree exported by the server are always allowed; this
4749 parameter controls access only to areas that are outside the directory
4750 tree being exported.
4751 <p><br>Note that setting this parameter can have a negative effect on your
4752 server performance due to the extra system calls that Samba has to
4753 do in order to perform the link checks.
4754 <p><br><strong>Default:</strong>
4755 <code>  wide links = yes</code>
4756 <p><br><strong>Example:</strong>
4757 <code>  wide links = no</code>
4758 <p><br><a name="winsproxy"></a>
4759 <li><strong><strong>wins proxy (G)</strong></strong>
4760 <p><br>This is a boolean that controls if <a href="nmbd.8.html"><strong>nmbd</strong></a> will
4761 respond to broadcast name queries on behalf of other hosts. You may
4762 need to set this to <code>"yes"</code> for some older clients.
4763 <p><br><strong>Default:</strong>
4764 <code>  wins proxy = no</code>
4765 <p><br><a name="winsserver"></a>
4766 <li><strong><strong>wins server (G)</strong></strong>
4767 <p><br>This specifies the IP address (or DNS name: IP address for preference)
4768 of the WINS server that <a href="nmbd.8.html"><strong>nmbd</strong></a> should register with.
4769 If you have a WINS server on your network then you should set this to
4770 the WINS server's IP.
4771 <p><br>You should point this at your WINS server if you have a
4772 multi-subnetted network.
4773 <p><br><em>NOTE</em>. You need to set up Samba to point to a WINS server if you
4774 have multiple subnets and wish cross-subnet browsing to work correctly.
4775 <p><br>See the documentation file BROWSING.txt in the docs/ directory of your
4776 Samba source distribution.
4777 <p><br><strong>Default:</strong>
4778 <code>  wins server = </code>
4779 <p><br><strong>Example:</strong>
4780 <code>  wins server = 192.9.200.1</code>
4781 <p><br><a name="winshook"></a>
4782 <li><strong><strong>wins hook (G)</strong></strong>
4783 <p><br>When Samba is running as a WINS server this allows you to call an
4784 external program for all changes to the WINS database. The primary use
4785 for this option is to allow the dynamic update of external name
4786 resolution databases such as dynamic DNS.
4787 <p><br>The wins hook parameter specifies the name of a script or executable
4788 that will be called as follows:
4789 <p><br>wins_hook operation name nametype ttl IP_list
4790 <p><br>The first argument is the operation and is one of "add", "delete",
4791 or "refresh". In most cases the operation can be ignored as the rest
4792 of the parameters provide sufficient information. Note that "refresh"
4793 may sometimes be called when the name has not previously been added,
4794 in that case it should be treated as an add.
4795 <p><br>The second argument is the netbios name. If the name is not a legal
4796 name then the wins hook is not called. Legal names contain only
4797 letters, digits, hyphens, underscores and periods.
4798 <p><br>The third argument is the netbios name type as a 2 digit hexadecimal
4799 number.
4800 <p><br>The fourth argument is the TTL (time to live) for the name in seconds.
4801 <p><br>The fifth and subsequent arguments are the IP addresses currently
4802 registered for that name. If this list is empty then the name should
4803 be deleted.
4804 <p><br>An example script that calls the BIND dynamic DNS update program
4805 "nsupdate" is provided in the examples directory of the Samba source
4806 code.
4807 <p><br><a name="winssupport"></a>
4808 <li><strong><strong>wins support (G)</strong></strong>
4809 <p><br>This boolean controls if the <a href="nmbd.8.html"><strong>nmbd</strong></a> process in
4810 Samba will act as a WINS server. You should not set this to true
4811 unless you have a multi-subnetted network and you wish a particular
4812 <a href="nmbd.8.html"><strong>nmbd</strong></a> to be your WINS server. Note that you
4813 should <em>*NEVER*</em> set this to true on more than one machine in your
4814 network.
4815 <p><br><strong>Default:</strong>
4816 <code>  wins support = no</code>
4817 <p><br><a name="workgroup"></a>
4818 <li><strong><strong>workgroup (G)</strong></strong>
4819 <p><br>This controls what workgroup your server will appear to be in when
4820 queried by clients. Note that this parameter also controls the Domain
4821 name used with the <a href="smb.conf.5.html#securityequaldomain"><strong>"security=domain"</strong></a>
4822 setting.
4823 <p><br><strong>Default:</strong>
4824 <code>  set at compile time to WORKGROUP</code>
4825 <p><br><strong>Example:</strong>
4826         workgroup = MYGROUP
4827 <p><br><a name="writable"></a>
4828 <li><strong><strong>writable (S)</strong></strong>
4829 <p><br>Synonym for <a href="smb.conf.5.html#writeable"><strong>"writeable"</strong></a> for people who can't spell :-).
4830 <p><br><a name="writelist"></a>
4831 <li><strong><strong>write list (S)</strong></strong>
4832 <p><br>This is a list of users that are given read-write access to a
4833 service. If the connecting user is in this list then they will be
4834 given write access, no matter what the <a href="smb.conf.5.html#readonly"><strong>"read only"</strong></a>
4835 option is set to. The list can include group names using the @group
4836 syntax.
4837 <p><br>Note that if a user is in both the read list and the write list then
4838 they will be given write access.
4839 <p><br>See also the <a href="smb.conf.5.html#readlist"><strong>"read list"</strong></a> option.
4840 <p><br><strong>Default:</strong>
4841 <code>     write list = &lt;empty string&gt;</code>
4842 <p><br><strong>Example:</strong>
4843 <code>  write list = admin, root, @staff</code>
4844 <p><br><a name="writeok"></a>
4845 <li><strong><strong>write ok (S)</strong></strong>
4846 <p><br>Synonym for <a href="smb.conf.5.html#writeable"><strong>writeable</strong></a>.
4847 <p><br><a name="writeraw"></a>
4848 <li><strong><strong>write raw (G)</strong></strong>
4849 <p><br>This parameter controls whether or not the server will support raw
4850 writes SMB's when transferring data from clients. You should never
4851 need to change this parameter.
4852 <p><br><strong>Default:</strong>
4853 <code>  write raw = yes</code>
4854 <p><br><a name="writeable"></a>
4855 <li><strong><strong>writeable</strong></strong>
4856 <p><br>An inverted synonym is <a href="smb.conf.5.html#readonly"><strong>"read only"</strong></a>.
4857 <p><br>If this parameter is <code>"no"</code>, then users of a service may not create
4858 or modify files in the service's directory.
4859 <p><br>Note that a printable service <a href="smb.conf.5.html#printable"><strong>("printable = yes")</strong></a>
4860 will <em>*ALWAYS*</em> allow writing to the directory (user privileges
4861 permitting), but only via spooling operations.
4862 <p><br><strong>Default:</strong>
4863 <code>  writeable = no</code>
4864 <p><br><strong>Examples:</strong>
4865 <pre>
4866
4867         read only = no
4868         writeable = yes
4869         write ok = yes
4870
4871 </pre>
4872
4873 <p><br></ul>
4874 <p><br><a name="WARNINGS"></a>
4875 <h2>WARNINGS</h2>
4876
4877 <p><br>Although the configuration file permits service names to contain
4878 spaces, your client software may not. Spaces will be ignored in
4879 comparisons anyway, so it shouldn't be a problem - but be aware of the
4880 possibility.
4881 <p><br>On a similar note, many clients - especially DOS clients - limit
4882 service names to eight characters. <a href="smbd.8.html"><strong>Smbd</strong></a> has no
4883 such limitation, but attempts to connect from such clients will fail
4884 if they truncate the service names.  For this reason you should
4885 probably keep your service names down to eight characters in length.
4886 <p><br>Use of the <a href="smb.conf.5.html#homes"><strong>[homes]</strong></a> and <a href="smb.conf.5.html#printers"><strong>[printers]</strong></a>
4887 special sections make life for an administrator easy, but the various
4888 combinations of default attributes can be tricky. Take extreme care
4889 when designing these sections. In particular, ensure that the
4890 permissions on spool directories are correct.
4891 <p><br><a name="VERSION"></a>
4892 <h2>VERSION</h2>
4893
4894 <p><br>This man page is correct for version 2.0 of the Samba suite.
4895 <p><br><a name="SEEALSO"></a>
4896 <h2>SEE ALSO</h2>
4897
4898 <p><br><a href="smbd.8.html"><strong>smbd (8)</strong></a>, <a href="smbclient.1.html"><strong>smbclient (1)</strong></a>,
4899 <a href="nmbd.8.html"><strong>nmbd (8)</strong></a>, <a href="testparm.1.html"><strong>testparm (1)</strong></a>,
4900 <a href="testprns.1.html"><strong>testprns (1)</strong></a>, <a href="samba.7.html"><strong>Samba</strong></a>,
4901 <a href="nmblookup.1.html"><strong>nmblookup (1)</strong></a>, <a href="smbpasswd.5.html"><strong>smbpasswd (5)</strong></a>,
4902 <a href="smbpasswd.8.html"><strong>smbpasswd (8)</strong></a>.
4903 <p><br><a name="AUTHOR"></a>
4904 <h2>AUTHOR</h2>
4905
4906 <p><br>The original Samba software and related utilities were created by
4907 Andrew Tridgell <a href="mailto:samba-bugs@samba.org"><em>samba-bugs@samba.org</em></a>. Samba is now developed
4908 by the Samba Team as an Open Source project similar to the way the
4909 Linux kernel is developed.
4910 <p><br>The original Samba man pages were written by Karl Auer. The man page
4911 sources were converted to YODL format (another excellent piece of Open
4912 Source software, available at
4913 <a href="ftp://ftp.icce.rug.nl/pub/unix/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>)
4914 and updated for the Samba2.0 release by Jeremy Allison.
4915 <a href="mailto:samba-bugs@samba.org"><em>samba-bugs@samba.org</em></a>.
4916 <p><br>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full
4917 list of contributors and details on how to submit bug reports,
4918 comments etc.
4919 </body>
4920 </html>