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