7 CONTENT=
"Modular DocBook HTML Stylesheet Version 1.57"></HEAD
27 >smb.conf
--
The configuration file for the Samba suite
</DIV
39 > file is a configuration
40 file for the Samba suite.
<TT
44 runtime configuration information for the Samba programs. The
48 > file is designed to be configured and
49 administered by the
<A
57 > program. The complete description of the file format and
58 possible parameters held within are here for reference purposes.
</P
68 >The file consists of sections and parameters. A section
69 begins with the name of the section in square brackets and continues
70 until the next section begins. Sections contain parameters of the
86 >The file is line-based - that is, each newline-terminated
87 line represents either a comment, a section name or a parameter.
</P
89 >Section and parameter names are not case sensitive.
</P
91 >Only the first equals sign in a parameter is significant.
92 Whitespace before or after the first equals sign is discarded.
93 Leading, trailing and internal whitespace in section and parameter
94 names is irrelevant. Leading and trailing whitespace in a parameter
95 value is discarded. Internal whitespace within a parameter value
96 is retained verbatim.
</P
98 >Any line beginning with a semicolon (';') or a hash ('#')
99 character is ignored, as are lines containing only whitespace.
</P
101 >Any line ending in a '\' is continued
102 on the next line in the customary UNIX fashion.
</P
104 >The values following the equals sign in parameters are all
105 either a string (no quotes needed) or a boolean, which may be given
106 as yes/no,
0/
1 or true/false. Case is not significant in boolean
107 values, but is preserved in string values. Some items such as
108 create modes are numeric.
</P
116 >SECTION DESCRIPTIONS
</H2
118 >Each section in the configuration file (except for the
119 [global] section) describes a shared resource (known
120 as a
"share"). The section name is the name of the
121 shared resource and the parameters within the section define
122 the shares attributes.
</P
124 >There are three special sections, [global],
125 [homes] and [printers], which are
127 >special sections
</EM
129 following notes apply to ordinary section descriptions.
</P
131 >A share consists of a directory to which access is being
132 given plus a description of the access rights which are granted
133 to the user of the service. Some housekeeping options are
136 >Sections are either file share services (used by the
137 client as an extension of their native file systems) or
138 printable services (used by the client to access print services
139 on the host running the server).
</P
141 >Sections may be designated
<EM
144 in which case no password is required to access them. A specified
147 > is used to define access
148 privileges in this case.
</P
150 >Sections other than guest services will require a password
151 to access them. The client provides the username. As older clients
152 only provide passwords and not usernames, you may specify a list
153 of usernames to check against the password using the
"user ="
154 option in the share definition. For modern clients such as
155 Windows
95/
98/ME/NT/
2000, this should not be necessary.
</P
157 >Note that the access rights granted by the server are
158 masked by the access rights granted to the specified or guest
159 UNIX user by the host system. The server does not grant more
160 access than the host system grants.
</P
162 >The following sample section defines a file space share.
163 The user has write access to the path
<TT
167 The share is accessed via the share name
"foo":
</P
177 CLASS=
"COMPUTEROUTPUT"
188 >The following sample section defines a printable share.
189 The share is readonly, but printable. That is, the only write
190 access permitted is via calls to open, write to and close a
194 access will be permitted as the default guest user (specified
205 CLASS=
"COMPUTEROUTPUT"
207 path = /usr/spool/public
224 >SPECIAL SECTIONS
</H2
231 >The [global] section
</H3
233 >parameters in this section apply to the server
234 as a whole, or are defaults for sections which do not
235 specifically define certain items. See the notes
236 under PARAMETERS for more information.
</P
244 >The [homes] section
</H3
246 >If a section called homes is included in the
247 configuration file, services connecting clients to their
248 home directories can be created on the fly by the server.
</P
250 >When the connection request is made, the existing
251 sections are scanned. If a match is found, it is used. If no
252 match is found, the requested section name is treated as a
253 user name and looked up in the local password file. If the
254 name exists and the correct password has been given, a share is
255 created by cloning the [homes] section.
</P
257 >Some modifications are then made to the newly
264 >The share name is changed from homes to
265 the located username.
</P
269 >If no path was given, the path is set to
270 the user's home directory.
</P
274 >If you decide to use a
<EM
277 in your [homes] section then you may find it useful
278 to use the %S macro. For example :
</P
283 >path = /data/pchome/%S
</B
287 >would be useful if you have different home directories
288 for your PCs than for UNIX access.
</P
290 >This is a fast and simple way to give a large number
291 of clients access to their home directories with a minimum
294 >A similar process occurs if the requested section
295 name is
"homes", except that the share name is not
296 changed to that of the requesting user. This method of using
297 the [homes] section works well if different users share
300 >The [homes] section can specify all the parameters
301 a normal service section can specify, though some make more sense
302 than others. The following is a typical and suitable [homes]
313 CLASS=
"COMPUTEROUTPUT"
323 >An important point is that if guest access is specified
324 in the [homes] section, all home directories will be
325 visible to all clients
<EM
326 >without a password
</EM
328 In the very unlikely event that this is actually desirable, it
329 would be wise to also specify
<EM
337 auto home directories will be inherited from the global browseable
338 flag, not the [homes] browseable flag. This is useful as
342 the [homes] section will hide the [homes] share but make
343 any auto home directories visible.
</P
351 >The [printers] section
</H3
353 >This section works like [homes],
356 >If a [printers] section occurs in the
357 configuration file, users are able to connect to any printer
358 specified in the local host's printcap file.
</P
360 >When a connection request is made, the existing sections
361 are scanned. If a match is found, it is used. If no match is found,
362 but a [homes] section exists, it is used as described
363 above. Otherwise, the requested section name is treated as a
364 printer name and the appropriate printcap file is scanned to see
365 if the requested section name is a valid printer share name. If
366 a match is found, a new printer share is created by cloning
367 the [printers] section.
</P
369 >A few modifications are then made to the newly created
376 >The share name is set to the located printer
381 >If no printer name was given, the printer name
382 is set to the located printer name
</P
386 >If the share does not permit guest access and
387 no username was given, the username is set to the located
392 >Note that the [printers] service MUST be
393 printable - if you specify otherwise, the server will refuse
394 to load the configuration file.
</P
396 >Typically the path specified would be that of a
397 world-writeable spool directory with the sticky bit set on
398 it. A typical [printers] entry would look like
409 CLASS=
"COMPUTEROUTPUT"
411 path = /usr/spool/public
420 >All aliases given for a printer in the printcap file
421 are legitimate printer names as far as the server is concerned.
422 If your printing subsystem doesn't work like that, you will have
423 to set up a pseudo-printcap. This is a file consisting of one or
424 more lines like this:
</P
434 CLASS=
"COMPUTEROUTPUT"
435 > alias|alias|alias|alias...
443 >Each alias should be an acceptable printer name for
444 your printing subsystem. In the [global] section, specify
445 the new file as your printcap. The server will then only recognize
446 names found in your pseudo-printcap, which of course can contain
447 whatever aliases you like. The same technique could be used
448 simply to limit access to a subset of your local printers.
</P
450 >An alias, by the way, is defined as any component of the
451 first entry of a printcap record. Records are separated by newlines,
452 components (if there are more than one) are separated by vertical
453 bar symbols ('|').
</P
455 >NOTE: On SYSV systems which use lpstat to determine what
456 printers are defined on the system you may be able to use
457 "printcap name = lpstat" to automatically obtain a list
458 of printers. See the
"printcap name" option
470 >parameters define the specific attributes of sections.
</P
472 >Some parameters are specific to the [global] section
475 >). Some parameters are usable
476 in all sections (e.g.,
<EM
479 are permissible only in normal sections. For the purposes of the
480 following descriptions the [homes] and [printers]
481 sections will be considered normal. The letter
<EM
484 in parentheses indicates that a parameter is specific to the
485 [global] section. The letter
<EM
488 indicates that a parameter can be specified in a service specific
489 section. Note that all
<EM
491 > parameters can also be specified in
492 the [global] section - in which case they will define
493 the default behavior for all services.
</P
495 >parameters are arranged here in alphabetical order - this may
496 not create best bedfellows, but at least you can find them! Where
497 there are synonyms, the preferred synonym is described, others refer
498 to the preferred synonym.
</P
506 >VARIABLE SUBSTITUTIONS
</H2
508 >Many of the strings that are settable in the config file
509 can take substitutions. For example the option
"path =
510 /tmp/%u" would be interpreted as
"path =
511 /tmp/john" if the user connected with the username john.
</P
513 >These substitutions are mostly noted in the descriptions below,
514 but there are some general substitutions which apply whenever they
515 might be relevant. These are:
</P
525 >the name of the current service, if any.
</P
531 >the root directory of the current service,
538 >user name of the current service, if any.
</P
544 >primary group name of %u.
</P
550 >session user name (the user name that the client
551 wanted, not necessarily the same as the one they got).
</P
557 >primary group name of %U.
</P
563 >the home directory of the user given
570 >the Samba version.
</P
576 >the Internet hostname that Samba is running
583 >the NetBIOS name of the client machine
590 >the NetBIOS name of the server. This allows you
591 to change your config based on what the client calls you. Your
592 server can have a
"dual personality".
</P
594 >Note that this paramater is not available when Samba listens
595 on port
445, as clients no longer send this information
</P
601 >the Internet name of the client machine.
608 >the name of your NIS home directory server.
609 This is obtained from your NIS auto.map entry. If you have
610 not compiled Samba with the
<EM
611 >--with-automount
</EM
613 option then this value will be the same as %L.
</P
619 >the path of the service's home directory,
620 obtained from your NIS auto.map entry. The NIS auto.map entry
621 is split up as
"%N:%p".
</P
627 >the selected protocol level after
628 protocol negotiation. It can be one of CORE, COREPLUS,
629 LANMAN1, LANMAN2 or NT1.
</P
635 >The process id of the current server
642 >the architecture of the remote
643 machine. Only some are recognized, and those may not be
644 100% reliable. It currently recognizes Samba, WfWg, Win95,
645 WinNT and Win2k. Anything else will be known as
646 "UNKNOWN". If it gets it wrong then sending a level
648 HREF=
"mailto:samba@samba.org"
652 > should allow it to be fixed.
</P
658 >The IP address of the client machine.
</P
664 >the current date and time.
</P
675 >The value of the environment variable
686 >There are some quite creative things that can be done
687 with these substitutions and other smb.conf options.
</P
697 >Samba supports
"name mangling" so that DOS and
698 Windows clients can use files that don't conform to the
8.3 format.
699 It can also be set to adjust the case of
8.3 format filenames.
</P
701 >There are several options that control the way mangling is
702 performed, and they are grouped here rather than listed separately.
703 For the defaults look at the output of the testparm program.
</P
705 >All of these options can be set separately for each service
706 (or globally, of course).
</P
708 >The options are:
</P
718 > controls the algorithm used for the generating
719 the mangled names. Can take two different values,
"hash" and
720 "hash2".
"hash" is the default and is the algorithm that has been
721 used in Samba for many years.
"hash2" is a newer and considered
722 a better algorithm (generates less collisions) in the names.
723 However, many Win32 applications store the
724 mangled names and so changing to the new algorithm must not be done
725 lightly as these applications may break unless reinstalled.
726 New installations of Samba may set the default to hash2.
732 >mangle case = yes/no
</DT
735 > controls if names that have characters that
736 aren't of the
"default" case are mangled. For example,
737 if this is yes then a name like
"Mail" would be mangled.
743 >case sensitive = yes/no
</DT
746 >controls whether filenames are case sensitive. If
747 they aren't then Samba must do a filename search and match on passed
753 >default case = upper/lower
</DT
756 >controls what the default case is for new
757 filenames. Default
<EM
762 >preserve case = yes/no
</DT
765 >controls if new files are created with the
766 case that the client passes, or if they are forced to be the
767 "default" case. Default
<EM
773 >short preserve case = yes/no
</DT
776 >controls if new files which conform to
8.3 syntax,
777 that is all in upper case and of suitable length, are created
778 upper case, or if they are forced to be the
"default"
779 case. This option can be use with
"preserve case = yes"
780 to permit long filenames to retain their case, while short names
781 are lowercased. Default
<EM
788 >By default, Samba
2.2 has the same semantics as a Windows
789 NT server, in that it is case insensitive but case preserving.
</P
797 >NOTE ABOUT USERNAME/PASSWORD VALIDATION
</H2
799 >There are a number of ways in which a user can connect
800 to a service. The server uses the following steps in determining
801 if it will allow a connection to a specified service. If all the
802 steps fail, then the connection request is rejected. However, if one of the
803 steps succeeds, then the following steps are not checked.
</P
805 >If the service is marked
"guest only = yes" and the
806 server is running with share-level security (
"security = share")
807 then steps
1 to
5 are skipped.
</P
814 >If the client has passed a username/password
815 pair and that username/password pair is validated by the UNIX
816 system's password programs then the connection is made as that
817 username. Note that this includes the
828 >If the client has previously registered a username
829 with the system and now supplies a correct password for that
830 username then the connection is allowed.
</P
834 >The client's NetBIOS name and any previously
835 used user names are checked against the supplied password, if
836 they match then the connection is allowed as the corresponding
841 >If the client has previously validated a
842 username/password pair with the server and the client has passed
843 the validation token then that username is used.
</P
847 >If a
"user = " field is given in the
851 > file for the service and the client
852 has supplied a password, and that password matches (according to
853 the UNIX system's password checking) with one of the usernames
854 from the
"user =" field then the connection is made as
855 the username in the
"user =" line. If one
856 of the username in the
"user =" list begins with a
857 '@' then that name expands to a list of names in
858 the group of the same name.
</P
862 >If the service is a guest service then a
863 connection is made as the username given in the
"guest
864 account =" for the service, irrespective of the
865 supplied password.
</P
875 >COMPLETE LIST OF GLOBAL PARAMETERS
</H2
877 >Here is a list of all global parameters. See the section of
878 each parameter for details. Note that some are synonyms.
</P
885 HREF=
"#ADDPRINTERCOMMAND"
889 >add printer command
</I
897 HREF=
"#ADDSHARECOMMAND"
901 >add share command
</I
909 HREF=
"#ADDUSERSCRIPT"
921 HREF=
"#ALLOWTRUSTEDDOMAINS"
925 >allow trusted domains
</I
945 HREF=
"#ANNOUNCEVERSION"
969 HREF=
"#BINDINTERFACESONLY"
973 >bind interfaces only
</I
993 HREF=
"#CHANGENOTIFYTIMEOUT"
997 >change notify timeout
</I
1005 HREF=
"#CHANGESHARECOMMAND"
1009 >change share command
</I
1017 HREF=
"#CHARACTERSET"
1029 HREF=
"#CLIENTCODEPAGE"
1033 >client code page
</I
1041 HREF=
"#CODEPAGEDIRECTORY"
1045 >code page directory
</I
1053 HREF=
"#CODINGSYSTEM"
1089 HREF=
"#DEBUGHIRESTIMESTAMP"
1093 >debug hires timestamp
</I
1113 HREF=
"#DEBUGTIMESTAMP"
1161 HREF=
"#DEFAULTSERVICE"
1173 HREF=
"#DELETEPRINTERCOMMAND"
1177 >delete printer command
</I
1185 HREF=
"#DELETESHARECOMMAND"
1189 >delete share command
</I
1197 HREF=
"#DELETEUSERSCRIPT"
1201 >delete user script
</I
1209 HREF=
"#DFREECOMMAND"
1221 HREF=
"#DISABLESPOOLSS"
1245 HREF=
"#DOMAINADMINGROUP"
1249 >domain admin group
</I
1257 HREF=
"#DOMAINGUESTGROUP"
1261 >domain guest group
</I
1269 HREF=
"#DOMAINLOGONS"
1281 HREF=
"#DOMAINMASTER"
1293 HREF=
"#ENCRYPTPASSWORDS"
1297 >encrypt passwords
</I
1305 HREF=
"#ENHANCEDBROWSING"
1309 >enhanced browsing
</I
1317 HREF=
"#ENUMPORTSCOMMAND"
1321 >enumports command
</I
1341 HREF=
"#HIDELOCALUSERS"
1345 >hide local users
</I
1353 HREF=
"#HIDEUNREADABLE"
1425 HREF=
"#KERNELOPLOCKS"
1449 HREF=
"#LARGEREADWRITE"
1557 HREF=
"#LOADPRINTERS"
1593 HREF=
"#LOCKDIRECTORY"
1605 HREF=
"#LOCKSPINCOUNT"
1617 HREF=
"#LOCKSPINTIME"
1629 HREF=
"#PIDDIRECTORY"
1713 HREF=
"#LPQCACHETIME"
1725 HREF=
"#MACHINEPASSWORDTIMEOUT"
1729 >machine password timeout
</I
1737 HREF=
"#MANGLEDSTACK"
1749 HREF=
"#MANGLINGMETHOD"
1809 HREF=
"#MAXOPENFILES"
1833 HREF=
"#MAXSMBDPROCESSES"
1837 >max smbd processes
</I
1881 HREF=
"#MESSAGECOMMAND"
1893 HREF=
"#MINPASSWDLENGTH"
1897 >min passwd length
</I
1905 HREF=
"#MINPASSWORDLENGTH"
1909 >min password length
</I
1941 HREF=
"#NAMERESOLVEORDER"
1945 >name resolve order
</I
1953 HREF=
"#NETBIOSALIASES"
1977 HREF=
"#NETBIOSSCOPE"
2001 HREF=
"#NTPIPESUPPORT"
2013 HREF=
"#NTSMBSUPPORT"
2025 HREF=
"#NTSTATUSSUPPORT"
2029 >nt status support
</I
2037 HREF=
"#NULLPASSWORDS"
2049 HREF=
"#OBEYPAMRESTRICTIONS"
2053 >obey pam restrictions
</I
2061 HREF=
"#OPLOCKBREAKWAITTIME"
2065 >oplock break wait time
</I
2085 HREF=
"#OS2DRIVERMAP"
2097 HREF=
"#PAMPASSWORDCHANGE"
2101 >pam password change
</I
2133 HREF=
"#PASSWDCHATDEBUG"
2137 >passwd chat debug
</I
2145 HREF=
"#PASSWDPROGRAM"
2157 HREF=
"#PASSWORDLEVEL"
2169 HREF=
"#PASSWORDSERVER"
2181 HREF=
"#PREFEREDMASTER"
2193 HREF=
"#PREFERREDMASTER"
2197 >preferred master
</I
2229 HREF=
"#PRINTCAPNAME"
2241 HREF=
"#PRINTERDRIVERFILE"
2245 >printer driver file
</I
2301 HREF=
"#REMOTEANNOUNCE"
2313 HREF=
"#REMOTEBROWSESYNC"
2317 >remote browse sync
</I
2325 HREF=
"#RESTRICTANONYMOUS"
2329 >restrict anonymous
</I
2361 HREF=
"#ROOTDIRECTORY"
2385 HREF=
"#SERVERSTRING"
2397 HREF=
"#SHOWADDPRINTERWIZARD"
2401 >show add printer wizard
</I
2409 HREF=
"#SMBPASSWDFILE"
2421 HREF=
"#SOCKETADDRESS"
2433 HREF=
"#SOCKETOPTIONS"
2445 HREF=
"#SOURCEENVIRONMENT"
2449 >source environment
</I
2469 HREF=
"#SSLCACERTDIR"
2481 HREF=
"#SSLCACERTFILE"
2505 HREF=
"#SSLCLIENTCERT"
2517 HREF=
"#SSLCLIENTKEY"
2529 HREF=
"#SSLCOMPATIBILITY"
2533 >ssl compatibility
</I
2541 HREF=
"#SSLEGDSOCKET"
2553 HREF=
"#SSLENTROPYBYTES"
2557 >ssl entropy bytes
</I
2565 HREF=
"#SSLENTROPYFILE"
2569 >ssl entropy file
</I
2589 HREF=
"#SSLHOSTSRESIGN"
2593 >ssl hosts resign
</I
2601 HREF=
"#SSLREQUIRECLIENTCERT"
2605 >ssl require clientcert
</I
2613 HREF=
"#SSLREQUIRESERVERCERT"
2617 >ssl require servercert
</I
2625 HREF=
"#SSLSERVERCERT"
2637 HREF=
"#SSLSERVERKEY"
2673 HREF=
"#STATCACHESIZE"
2721 HREF=
"#TEMPLATEHOMEDIR"
2725 >template homedir
</I
2733 HREF=
"#TEMPLATESHELL"
2769 HREF=
"#TIMESTAMPLOGS"
2781 HREF=
"#TOTALPRINTJOBS"
2785 >total print jobs
</I
2793 HREF=
"#UNIXEXTENSIONS"
2805 HREF=
"#UNIXPASSWORDSYNC"
2809 >unix password sync
</I
2817 HREF=
"#UPDATEENCRYPTED"
2821 >update encrypted
</I
2865 HREF=
"#USERNAMELEVEL"
2901 HREF=
"#UTMPDIRECTORY"
2925 HREF=
"#WINBINDCACHETIME"
2929 >winbind cache time
</I
2937 HREF=
"#WINBINDENUMUSERS"
2941 >winbind enum users
</I
2949 HREF=
"#WINBINDENUMGROUPS"
2953 >winbind enum groups
</I
2973 HREF=
"#WINBINDSEPARATOR"
2977 >winbind separator
</I
2997 HREF=
"#WINBINDUSEDEFAULTDOMAIN"
3001 >winbind use default domain
</I
3086 >COMPLETE LIST OF SERVICE PARAMETERS
</H2
3088 >Here is a list of all service parameters. See the section on
3089 each parameter for details. Note that some are synonyms.
</P
3132 HREF=
"#BLOCKINGLOCKS"
3180 HREF=
"#CASESENSITIVE"
3192 HREF=
"#CASESIGNAMES"
3276 HREF=
"#DEFAULTDEVMODE"
3288 HREF=
"#DELETEREADONLY"
3300 HREF=
"#DELETEVETOFILES"
3304 >delete veto files
</I
3336 HREF=
"#DIRECTORYMASK"
3348 HREF=
"#DIRECTORYMODE"
3360 HREF=
"#DIRECTORYSECURITYMASK"
3364 >directory security mask
</I
3396 HREF=
"#DOSFILETIMERESOLUTION"
3400 >dos filetime resolution
</I
3408 HREF=
"#DOSFILETIMES"
3432 HREF=
"#FAKEDIRECTORYCREATETIMES"
3436 >fake directory create times
</I
3456 HREF=
"#FOLLOWSYMLINKS"
3468 HREF=
"#FORCECREATEMODE"
3472 >force create mode
</I
3480 HREF=
"#FORCEDIRECTORYMODE"
3484 >force directory mode
</I
3492 HREF=
"#FORCEDIRECTORYSECURITYMODE"
3496 >force directory security mode
</I
3516 HREF=
"#FORCESECURITYMODE"
3520 >force security mode
</I
3528 HREF=
"#FORCEUNKNOWNACLUSER"
3532 >force unknown acl user
</I
3576 HREF=
"#GUESTACCOUNT"
3612 HREF=
"#HIDEDOTFILES"
3684 HREF=
"#INHERITPERMISSIONS"
3688 >inherit permissions
</I
3696 HREF=
"#INVALIDUSERS"
3708 HREF=
"#LEVEL2OPLOCKS"
3732 HREF=
"#LPPAUSECOMMAND"
3756 HREF=
"#LPRESUMECOMMAND"
3760 >lpresume command
</I
3828 HREF=
"#MANGLEDNAMES"
3840 HREF=
"#MANGLINGCHAR"
3888 HREF=
"#MAXCONNECTIONS"
3900 HREF=
"#MAXPRINTJOBS"
3912 HREF=
"#MINPRINTSPACE"
3936 HREF=
"#NTACLSUPPORT"
3972 HREF=
"#OPLOCKCONTENTIONLIMIT"
3976 >oplock contention limit
</I
4008 HREF=
"#POSIXLOCKING"
4056 HREF=
"#PREEXECCLOSE"
4068 HREF=
"#PRESERVECASE"
4080 HREF=
"#PRINTCOMMAND"
4128 HREF=
"#PRINTERADMIN"
4140 HREF=
"#PRINTERDRIVER"
4152 HREF=
"#PRINTERDRIVERLOCATION"
4156 >printer driver location
</I
4200 HREF=
"#QUEUEPAUSECOMMAND"
4204 >queuepause command
</I
4212 HREF=
"#QUEUERESUMECOMMAND"
4216 >queueresume command
</I
4248 HREF=
"#ROOTPOSTEXEC"
4272 HREF=
"#ROOTPREEXECCLOSE"
4276 >root preexec close
</I
4284 HREF=
"#SECURITYMASK"
4296 HREF=
"#SETDIRECTORY"
4320 HREF=
"#SHORTPRESERVECASE"
4324 >short preserve case
</I
4344 HREF=
"#STRICTALLOCATE"
4356 HREF=
"#STRICTLOCKING"
4392 HREF=
"#USECLIENTDRIVER"
4396 >use client driver
</I
4464 HREF=
"#VETOOPLOCKFILES"
4468 >veto oplock files
</I
4536 HREF=
"#WRITECACHESIZE"
4540 >write cache size
</I
4589 >EXPLANATION OF EACH PARAMETER
</H2
4593 CLASS=
"VARIABLELIST"
4597 NAME=
"ADDPRINTERCOMMAND"
4599 >add printer command (G)
</DT
4602 >With the introduction of MS-RPC based printing
4603 support for Windows NT/
2000 clients in Samba
2.2, The MS Add
4604 Printer Wizard (APW) icon is now also available in the
4605 "Printers..." folder displayed a share listing. The APW
4606 allows for printers to be add remotely to a Samba or Windows
4607 NT/
2000 print server.
</P
4609 >For a Samba host this means that the printer must be
4610 physically added to the underlying printing system. The
<TT
4616 > defines a script to be run which
4617 will perform the necessary operations for adding the printer
4618 to the print system and to add the appropriate service definition
4622 > file in order that it can be
4636 >add printer command
</I
4639 automatically invoked with the following parameter (in
4694 >Windows
9x driver location
</I
4701 >All parameters are filled in from the PRINTER_INFO_2 structure sent
4702 by the Windows NT/
2000 client with one exception. The
"Windows 9x
4703 driver location" parameter is included for backwards compatibility
4704 only. The remaining fields in the structure are generated from answers
4705 to the APW questions.
</P
4710 >add printer command
</I
4716 > will reparse the
<TT
4719 > to determine if the share defined by the APW
4720 exists. If the sharename is still invalid, then
<B
4724 > will return an ACCESS_DENIED error to the client.
</P
4727 HREF=
"#DELETEPRINTERCOMMAND"
4731 > delete printer command
</I
4744 HREF=
"#SHOWADDPRINTERWIZARD"
4760 >addprinter command = /usr/bin/addprinter
4766 NAME=
"ADDSHARECOMMAND"
4768 >add share command (G)
</DT
4771 >Samba
2.2.0 introduced the ability to dynamically
4772 add and delete shares via the Windows NT
4.0 Server Manager. The
4776 >add share command
</I
4778 > is used to define an
4779 external program or script which will add a new service definition
4783 >. In order to successfully
4787 >add share command
</I
4793 requires that the administrator be connected using a root account (i.e.
4800 > will automatically invoke the
4804 >add share command
</I
4806 > with four parameters.
4832 > - the name of the new
4843 > - path to an **existing**
4854 > - comment string to associate
4860 > This parameter is only used for add file shares. To add printer shares,
4862 HREF=
"#ADDPRINTERCOMMAND"
4874 HREF=
"#CHANGESHARECOMMAND"
4883 HREF=
"#DELETESHARECOMMAND"
4900 >add share command = /usr/local/bin/addshare
</B
4905 NAME=
"ADDUSERSCRIPT"
4907 >add user script (G)
</DT
4910 >This is the full pathname to a script that will
4918 > under special circumstances described below.
</P
4920 >Normally, a Samba server requires that UNIX users are
4921 created for all users accessing files on this server. For sites
4922 that use Windows NT account databases as their primary user database
4923 creating these users and keeping the user list in sync with the
4924 Windows NT PDC is an onerous task. This option allows
<A
4928 > to create the required UNIX users
4931 > when a user accesses the Samba server.
</P
4933 >In order to use this option,
<A
4943 >security = share
</I
4952 must be set to a full pathname for a script that will create a UNIX
4953 user given one argument of
<TT
4958 >, which expands into
4959 the UNIX user name to create.
</P
4961 >When the Windows user attempts to access the Samba server,
4962 at login (session setup in the SMB protocol) time,
<A
4972 attempts to authenticate the given user with the given password. If the
4973 authentication succeeds then
<B
4977 attempts to find a UNIX user in the UNIX password database to map the
4978 Windows user into. If this lookup fails, and
<TT
4988 call the specified script
<EM
4996 > argument to be the user name to create.
</P
4998 >If this script successfully creates the user then
<B
5002 > will continue on as though the UNIX user
5003 already existed. In this way, UNIX users are dynamically created to
5004 match existing Windows NT accounts.
</P
5015 HREF=
"#PASSWORDSERVER"
5024 HREF=
"#DELETEUSERSCRIPT"
5036 >add user script =
<empty string
>
5042 >add user script = /usr/local/samba/bin/add_user
5050 >admin users (S)
</DT
5053 >This is a list of users who will be granted
5054 administrative privileges on the share. This means that they
5055 will do all file operations as the super-user (root).
</P
5057 >You should use this option very carefully, as any user in
5058 this list will be able to do anything they like on the share,
5059 irrespective of file permissions.
</P
5067 >admin users = jason
</B
5074 >allow hosts (S)
</DT
5089 NAME=
"ALLOWTRUSTEDDOMAINS"
5091 >allow trusted domains (G)
</DT
5094 >This option only takes effect when the
<A
5110 If it is set to no, then attempts to connect to a resource from
5111 a domain or workgroup other than the one which
<A
5116 in will fail, even if that domain is trusted by the remote server
5117 doing the authentication.
</P
5119 >This is useful if you only want your Samba server to
5120 serve resources to users in the domain it is a member of. As
5121 an example, suppose that there are two domains DOMA and DOMB. DOMB
5122 is trusted by DOMA, which contains the Samba server. Under normal
5123 circumstances, a user with an account in DOMB can then access the
5124 resources of a UNIX account with the same account name on the
5125 Samba server even if they do not have an account in DOMA. This
5126 can make implementing a security boundary difficult.
</P
5130 >allow trusted domains = yes
</B
5137 >announce as (G)
</DT
5140 >This specifies what type of server
5149 will announce itself as, to a network neighborhood browse
5150 list. By default this is set to Windows NT. The valid options
5151 are :
"NT Server" (which can also be written as
"NT"),
5152 "NT Workstation",
"Win95" or
"WfW" meaning Windows NT Server,
5153 Windows NT Workstation, Windows
95 and Windows for Workgroups
5154 respectively. Do not change this parameter unless you have a
5155 specific need to stop Samba appearing as an NT server as this
5156 may prevent Samba servers from participating as browser servers
5161 >announce as = NT Server
</B
5166 >announce as = Win95
</B
5171 NAME=
"ANNOUNCEVERSION"
5173 >announce version (G)
</DT
5176 >This specifies the major and minor version numbers
5177 that nmbd will use when announcing itself as a server. The default
5178 is
4.5. Do not change this parameter unless you have a specific
5179 need to set a Samba server to be a downlevel server.
</P
5183 >announce version =
4.5</B
5188 >announce version =
2.0</B
5195 >auto services (G)
</DT
5198 >This is a synonym for the
<A
5215 >This parameter lets you
"turn off" a service. If
5224 attempts to connect to the service will fail. Such failures are
5234 NAME=
"BINDINTERFACESONLY"
5236 >bind interfaces only (G)
</DT
5239 >This global parameter allows the Samba admin
5240 to limit what interfaces on a machine will serve SMB requests. If
5241 affects file service
<A
5253 >For name service it causes
<B
5257 to ports
137 and
138 on the interfaces listed in the
<A
5264 > also binds to the
"all addresses" interface (
0.0.0.0)
5265 on ports
137 and
138 for the purposes of reading broadcast messages.
5266 If this option is not set then
<B
5270 name requests on all of these sockets. If
<TT
5280 source address of any packets coming in on the broadcast sockets
5281 and discard any that don't match the broadcast addresses of the
5282 interfaces in the
<TT
5288 As unicast packets are received on the other sockets it allows
5292 > to refuse to serve names to machines that
5293 send packets that arrive through any interfaces not listed in the
5299 > list. IP Source address spoofing
5300 does defeat this simple check, however so it must not be used
5301 seriously as a security feature for
<B
5306 >For file service it causes
<A
5311 to bind only to the interface list given in the
<A
5314 > parameter. This restricts the networks that
5318 > will serve to packets coming in those
5319 interfaces. Note that you should not use this parameter for machines
5320 that are serving PPP or other intermittent or non-broadcast network
5321 interfaces as it will not cope with non-permanent interfaces.
</P
5326 >bind interfaces only
</I
5329 unless the network address
<EM
5338 HREF=
"smbpasswd.8.html"
5353 not work as expected due to the reasons covered below.
</P
5355 >To change a users SMB password, the
<B
5359 by default connects to the
<EM
5360 >localhost -
127.0.0.1</EM
5362 address as an SMB client to issue the password change request. If
5366 >bind interfaces only
</I
5368 > is set then unless the
5377 > parameter list then
<B
5380 > will fail to connect in it's default mode.
5384 > can be forced to use the primary IP interface
5385 of the local host by using its
<A
5386 HREF=
"smbpasswd.8.html#minusr"
5400 > parameter, with
<TT
5406 to the IP name of the primary interface of the local host.
</P
5411 > status page tries to connect with
5421 > to determine if they are running.
5431 "not running" even if they really are. This can prevent
<B
5434 > from starting/stopping/restarting
<B
5445 >bind interfaces only = no
</B
5455 >This parameter controls the behavior of
<A
5459 > when reporting disk free sizes.
5460 By default, this reports a disk block size of
1024 bytes.
</P
5462 >Changing this parameter may have some effect on the
5463 efficiency of client writes, this is not yet confirmed. This
5464 parameter was added to allow advanced administrators to change
5465 it (usually to a higher value) and test the effect it has on
5466 client write performance without re-compiling the code. As this
5467 is an experimental option it may be removed in a future release.
5470 >Changing this option does not change the disk free reporting
5471 size, just the block size unit reported to the client.
</P
5475 >block size =
1024</B
5480 >block size =
65536</B
5485 NAME=
"BLOCKINGLOCKS"
5487 >blocking locks (S)
</DT
5490 >This parameter controls the behavior of
<A
5494 > when given a request by a client
5495 to obtain a byte range lock on a region of an open file, and the
5496 request has a time limit associated with it.
</P
5498 >If this parameter is set and the lock range requested
5499 cannot be immediately satisfied, Samba
2.2 will internally
5500 queue the lock request, and periodically attempt to obtain
5501 the lock until the timeout period expires.
</P
5503 >If this parameter is set to
<TT
5507 Samba
2.2 will behave as previous versions of Samba would and
5508 will fail the lock request immediately if the lock range
5509 cannot be obtained.
</P
5513 >blocking locks = yes
</B
5537 >browse list (G)
</DT
5540 >This controls whether
<A
5547 > will serve a browse list to
5555 >. You should never need to change
5560 >browse list = yes
</B
5570 >This controls whether this share is seen in
5571 the list of available shares in a net view and in the browse list.
</P
5575 >browseable = yes
</B
5580 NAME=
"CASESENSITIVE"
5582 >case sensitive (S)
</DT
5585 >See the discussion in the section
<A
5592 >case sensitive = no
</B
5599 >casesignames (S)
</DT
5603 HREF=
"#CASESENSITIVE"
5610 NAME=
"CHANGENOTIFYTIMEOUT"
5612 >change notify timeout (G)
</DT
5615 >This SMB allows a client to tell a server to
5616 "watch" a particular directory for any changes and only reply to
5617 the SMB request when a change has occurred. Such constant scanning of
5618 a directory is expensive under UNIX, hence an
<A
5625 > daemon only performs such a scan
5626 on each requested directory once every
<TT
5636 >change notify timeout =
60</B
5641 >change notify timeout =
300</B
5644 >Would change the scan time to every
5 minutes.
</P
5648 NAME=
"CHANGESHARECOMMAND"
5650 >change share command (G)
</DT
5653 >Samba
2.2.0 introduced the ability to dynamically
5654 add and delete shares via the Windows NT
4.0 Server Manager. The
5658 >change share command
</I
5660 > is used to define an
5661 external program or script which will modify an existing service definition
5665 >. In order to successfully
5669 >change share command
</I
5675 requires that the administrator be connected using a root account (i.e.
5682 > will automatically invoke the
5686 >change share command
</I
5688 > with four parameters.
5714 > - the name of the new
5725 > - path to an **existing**
5736 > - comment string to associate
5742 > This parameter is only used modify existing file shares definitions. To modify
5743 printer shares, use the
"Printers..." folder as seen when browsing the Samba host.
5747 HREF=
"#ADDSHARECOMMAND"
5756 HREF=
"#DELETESHARECOMMAND"
5773 >change share command = /usr/local/bin/addshare
</B
5780 >character set (G)
</DT
5787 > to map incoming filenames
5788 from a DOS Code page (see the
<A
5789 HREF=
"#CLIENTCODEPAGE"
5792 > parameter) to several built in UNIX character sets.
5793 The built in code page translations are:
</P
5802 > : Western European
5803 UNIX character set. The parameter
<TT
5806 >client code page
</I
5811 > be set to code page
850 if the
5817 > parameter is set to
5821 > in order for the conversion to the
5822 UNIX character set to be done correctly.
</P
5829 > : Eastern European
5830 UNIX character set. The parameter
<TT
5838 > be set to code page
852 if
5848 > in order for the conversion
5849 to the UNIX character set to be done correctly.
</P
5856 > : Russian Cyrillic
5857 UNIX character set. The parameter
<TT
5865 > be set to code page
5875 > in order for the conversion
5876 to the UNIX character set to be done correctly.
</P
5884 character set. The parameter
<TT
5892 > be set to code page
5902 > in order for the conversion
5903 to the UNIX character set to be done correctly.
</P
5910 > : Alternate mapping
5911 for Russian Cyrillic UNIX character set. The parameter
5915 >client code page
</I
5920 be set to code page
866 if the
<TT
5926 parameter is set to
<TT
5930 conversion to the UNIX character set to be done correctly.
</P
5936 >. These MSDOS code page to UNIX character
5937 set mappings should be dynamic, like the loading of MS DOS code pages,
5940 >Normally this parameter is not set, meaning no filename
5941 translation is done.
</P
5945 >character set =
<empty string
></B
5950 >character set = ISO8859-
1</B
5955 NAME=
"CLIENTCODEPAGE"
5957 >client code page (G)
</DT
5960 >This parameter specifies the DOS code page
5961 that the clients accessing Samba are using. To determine what code
5962 page a Windows or DOS client is using, open a DOS command prompt
5963 and type the command
<B
5967 the code page. The default for USA MS-DOS, Windows
95, and
5968 Windows NT releases is code page
437. The default for western
5969 European releases of the above operating systems is code page
850.
</P
5971 >This parameter tells
<A
5985 > files to dynamically load on startup. These files,
5986 described more fully in the manual page
<A
5987 HREF=
"make_smbcodepage.1.html"
5991 >make_smbcodepage(
1)
</B
5996 > how to map lower to upper case characters to provide
5997 the case insensitivity of filenames that Windows clients expect.
</P
5999 >Samba currently ships with the following code page files :
</P
6005 >Code Page
437 - MS-DOS Latin US
</P
6009 >Code Page
737 - Windows '
95 Greek
</P
6013 >Code Page
850 - MS-DOS Latin
1</P
6017 >Code Page
852 - MS-DOS Latin
2</P
6021 >Code Page
861 - MS-DOS Icelandic
</P
6025 >Code Page
866 - MS-DOS Cyrillic
</P
6029 >Code Page
932 - MS-DOS Japanese SJIS
</P
6033 >Code Page
936 - MS-DOS Simplified Chinese
</P
6037 >Code Page
949 - MS-DOS Korean Hangul
</P
6041 >Code Page
950 - MS-DOS Traditional Chinese
</P
6045 >Thus this parameter may have any of the values
437,
737,
850,
852,
6046 861,
932,
936,
949, or
950. If you don't find the codepage you need,
6047 read the comments in one of the other codepage files and the
6050 >make_smbcodepage(
1)
</B
6051 > man page and write one. Please
6052 remember to donate it back to the Samba user community.
</P
6054 >This parameter co-operates with the
<TT
6060 > parameter in determining what characters are
6061 valid in filenames and how capitalization is done. If you set both
6062 this parameter and the
<TT
6071 >client code page
</I
6076 > be set before the
<TT
6082 > parameter in the
<TT
6092 augment the character settings in the
<TT
6095 >client code page
</I
6103 >client code page
</I
6118 HREF=
"#CODEPAGEDIRECTORY"
6122 >code page directory
</I
6129 >client code page =
850</B
6134 >client code page =
936</B
6139 NAME=
"CODEPAGEDIRECTORY"
6141 >code page directory (G)
</DT
6144 >Define the location of the various client code page
6148 HREF=
"#CLIENTCODEPAGE"
6160 >code page directory = ${prefix}/lib/codepages
6166 >code page directory = /usr/share/samba/codepages
6174 >coding system (G)
</DT
6177 >This parameter is used to determine how incoming
6178 Shift-JIS Japanese characters are mapped from the incoming
<A
6179 HREF=
"#CLIENTCODEPAGE"
6183 >client code page
</I
6187 > used by the client, into file names in the UNIX filesystem.
6191 >client code page
</I
6194 932 (Japanese Shift-JIS). The options are :
</P
6203 > - Shift-JIS. Does no
6204 conversion of the incoming filename.
</P
6210 >JIS8, J8BB, J8BH, J8@B,
6212 > - Convert from incoming Shift-JIS to eight
6213 bit JIS code with different shift-in, shift out codes.
</P
6219 >JIS7, J7BB, J7BH, J7@B, J7@J,
6221 > - Convert from incoming Shift-JIS to seven bit
6222 JIS code with different shift-in, shift out codes.
</P
6228 >JUNET, JUBB, JUBH, JU@B, JU@J, JU@H
</TT
6230 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
6238 > - Convert an incoming
6239 Shift-JIS character to EUC code.
</P
6246 > - Convert an incoming
6247 Shift-JIS character to a
3 byte hex representation, i.e.
6258 > - Convert an incoming
6259 Shift-JIS character to the
3 byte hex representation used by
6260 the Columbia AppleTalk Program (CAP), i.e.
<TT
6264 This is used for compatibility between Samba and CAP.
</P
6270 >coding system =
<empty value
></B
6281 >This is a text field that is seen next to a share
6282 when a client does a queries the server, either via the network
6283 neighborhood or via
<B
6286 > to list what shares
6289 >If you want to set the string that is displayed next to the
6290 machine name then see the
<A
6291 HREF=
"#SERVERSTRING"
6301 >No comment string
</EM
6306 >comment = Fred's Files
</B
6313 >config file (G)
</DT
6316 >This allows you to override the config file
6317 to use, instead of the default (usually
<TT
6321 There is a chicken and egg problem here as this option is set
6322 in the config file!
</P
6324 >For this reason, if the name of the config file has changed
6325 when the parameters are loaded then it will reload them from
6326 the new config file.
</P
6328 >This option takes the usual substitutions, which can
6331 >If the config file doesn't exist then it won't be loaded
6332 (allowing you to special case the config files of just a few
6337 >config file = /usr/local/samba/lib/smb.conf.%m
6348 >This parameter allows you to
"clone" service
6349 entries. The specified service is simply duplicated under the
6350 current service's name. Any parameters specified in the current
6351 section will override those in the section being copied.
</P
6353 >This feature lets you set up a 'template' service and
6354 create similar services easily. Note that the service being
6355 copied must occur earlier in the configuration file than the
6356 service doing the copying.
</P
6364 >copy = otherservice
</B
6371 >create mask (S)
</DT
6374 >A synonym for this parameter is
6386 >When a file is created, the necessary permissions are
6387 calculated according to the mapping from DOS modes to UNIX
6388 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
6389 with this parameter. This parameter may be thought of as a bit-wise
6390 MASK for the UNIX modes of a file. Any bit
<EM
6393 set here will be removed from the modes set on a file when it is
6396 >The default value of this parameter removes the
6397 'group' and 'other' write and execute bits from the UNIX modes.
</P
6399 >Following this Samba will bit-wise 'OR' the UNIX mode created
6400 from this parameter with the value of the
<A
6401 HREF=
"#FORCECREATEMODE"
6405 >force create mode
</I
6409 parameter which is set to
000 by default.
</P
6411 >This parameter does not affect directory modes. See the
6413 HREF=
"#DIRECTORYMODE"
6424 HREF=
"#FORCECREATEMODE"
6432 > parameter for forcing particular mode
6433 bits to be set on created files. See also the
<A
6434 HREF=
"#DIRECTORYMODE"
6441 > parameter for masking
6442 mode bits on created directories. See also the
<A
6443 HREF=
"#INHERITPERMISSIONS"
6447 >inherit permissions
</I
6452 >Note that this parameter does not apply to permissions
6453 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
6454 a mask on access control lists also, they need to set the
<A
6455 HREF=
"#SECURITYMASK"
6466 >create mask =
0744</B
6471 >create mask =
0775</B
6478 >create mode (S)
</DT
6481 >This is a synonym for
<A
6498 >This stands for
<EM
6499 >client-side caching
6501 >, and specifies how clients capable of offline
6502 caching will cache the files in the share. The valid values
6503 are: manual, documents, programs, disable.
</P
6505 >These values correspond to those used on Windows
6508 >For example, shares containing roaming profiles can have
6509 offline caching disabled using
<B
6511 >csc policy = disable
6517 >csc policy = manual
</B
6522 >csc policy = programs
</B
6532 >The value of the parameter (a decimal integer)
6533 represents the number of minutes of inactivity before a connection
6534 is considered dead, and it is disconnected. The deadtime only takes
6535 effect if the number of open files is zero.
</P
6537 >This is useful to stop a server's resources being
6538 exhausted by a large number of inactive connections.
</P
6540 >Most clients have an auto-reconnect feature when a
6541 connection is broken so in most cases this parameter should be
6542 transparent to users.
</P
6544 >Using this parameter with a timeout of a few minutes
6545 is recommended for most systems.
</P
6547 >A deadtime of zero indicates that no auto-disconnection
6548 should be performed.
</P
6562 NAME=
"DEBUGHIRESTIMESTAMP"
6564 >debug hires timestamp (G)
</DT
6567 >Sometimes the timestamps in the log messages
6568 are needed with a resolution of higher that seconds, this
6569 boolean parameter adds microsecond resolution to the timestamp
6570 message header when turned on.
</P
6572 >Note that the parameter
<A
6573 HREF=
"#DEBUGTIMESTAMP"
6577 > debug timestamp
</I
6580 > must be on for this to have an
6585 >debug hires timestamp = no
</B
6595 >When using only one log file for more then one
6600 >-process there may be hard to follow which process
6601 outputs which message. This boolean parameter is adds the process-id
6602 to the timestamp message headers in the logfile when turned on.
</P
6604 >Note that the parameter
<A
6605 HREF=
"#DEBUGTIMESTAMP"
6609 > debug timestamp
</I
6612 > must be on for this to have an
6622 NAME=
"DEBUGTIMESTAMP"
6624 >debug timestamp (G)
</DT
6627 >Samba
2.2 debug log messages are timestamped
6628 by default. If you are running at a high
<A
6637 can be distracting. This boolean parameter allows timestamping
6638 to be turned off.
</P
6642 >debug timestamp = yes
</B
6652 >Samba is sometimes run as root and sometime
6653 run as the connected user, this boolean parameter inserts the
6654 current euid, egid, uid and gid to the timestamp message headers
6655 in the log file if turned on.
</P
6657 >Note that the parameter
<A
6658 HREF=
"#DEBUGTIMESTAMP"
6662 > debug timestamp
</I
6665 > must be on for this to have an
6698 HREF=
"#DEFAULTSERVICE"
6702 > default service
</I
6711 >default case (S)
</DT
6714 >See the section on
<A
6718 HREF=
"#SHORTPRESERVECASE"
6722 >short preserve case
</I
6729 >default case = lower
</B
6734 NAME=
"DEFAULTDEVMODE"
6736 >default devmode (S)
</DT
6739 >This parameter is only applicable to
<A
6742 > services. When smbd is serving
6743 Printer Drivers to Windows NT/
2k/XP clients, each printer on the Samba
6744 server has a Device Mode which defines things such as paper size and
6745 orientation and duplex settings. The device mode can only correctly be
6746 generated by the printer driver itself (which can only be executed on a
6747 Win32 platform). Because smbd is unable to execute the driver code
6748 to generate the device mode, the default behavior is to set this field
6752 >Most problems with serving printer drivers to Windows NT/
2k/XP clients
6753 can be traced to a problem with the generated device mode. Certain drivers
6754 will do things such as crashing the client's Explorer.exe with a NULL devmode.
6755 However, other printer drivers can cause the client's spooler service
6756 (spoolsv.exe) to die if the devmode was not created by the driver itself
6757 (i.e. smbd generates a default devmode).
6760 >This parameter should be used with care and tested with the printer
6761 driver in question. It is better to leave the device mode to NULL
6762 and let the Windows client set the correct values. Because drivers do not
6763 do this all the time, setting
<B
6765 >default devmode = yes
</B
6767 will instruct smbd to generate a default one.
6770 >For more information on Windows NT/
2k printing and Device Modes,
6772 HREF=
"http://msdn.microsoft.com/"
6774 >MSDN documentation
</A
6780 >default devmode = no
</B
6785 NAME=
"DEFAULTSERVICE"
6787 >default service (G)
</DT
6790 >This parameter specifies the name of a service
6791 which will be connected to if the service actually requested cannot
6792 be found. Note that the square brackets are
<EM
6795 given in the parameter value (see example below).
</P
6797 >There is no default value for this parameter. If this
6798 parameter is not given, attempting to connect to a nonexistent
6799 service results in an error.
</P
6801 >Typically the default service would be a
<A
6819 >Also note that the apparent service name will be changed
6820 to equal that of the requested service, this is very useful as it
6821 allows you to use macros like
<TT
6827 a wildcard service.
</P
6829 >Note also that any
"_" characters in the name of the service
6830 used in the default service will get mapped to a
"/". This allows for
6831 interesting things.
</P
6842 CLASS=
"PROGRAMLISTING"
6844 default service = pub
6856 NAME=
"DELETEPRINTERCOMMAND"
6858 >delete printer command (G)
</DT
6861 >With the introduction of MS-RPC based printer
6862 support for Windows NT/
2000 clients in Samba
2.2, it is now
6863 possible to delete printer at run time by issuing the
6864 DeletePrinter() RPC call.
</P
6866 >For a Samba host this means that the printer must be
6867 physically deleted from underlying printing system. The
<TT
6870 > deleteprinter command
</I
6872 > defines a script to be run which
6873 will perform the necessary operations for removing the printer
6874 from the print system and from
<TT
6883 >delete printer command
</I
6886 automatically called with only one parameter:
<TT
6896 >delete printer command
</I
6902 > will reparse the
<TT
6905 > to associated printer no longer exists.
6906 If the sharename is still valid, then
<B
6910 > will return an ACCESS_DENIED error to the client.
</P
6913 HREF=
"#ADDPRINTERCOMMAND"
6917 > add printer command
</I
6930 HREF=
"#SHOWADDPRINTERWIZARD"
6946 >deleteprinter command = /usr/bin/removeprinter
6952 NAME=
"DELETEREADONLY"
6954 >delete readonly (S)
</DT
6957 >This parameter allows readonly files to be deleted.
6958 This is not normal DOS semantics, but is allowed by UNIX.
</P
6960 >This option may be useful for running applications such
6961 as rcs, where UNIX file ownership prevents changing file
6962 permissions, and DOS semantics prevent deletion of a read only file.
</P
6966 >delete readonly = no
</B
6971 NAME=
"DELETESHARECOMMAND"
6973 >delete share command (G)
</DT
6976 >Samba
2.2.0 introduced the ability to dynamically
6977 add and delete shares via the Windows NT
4.0 Server Manager. The
6981 >delete share command
</I
6983 > is used to define an
6984 external program or script which will remove an existing service
6988 >. In order to successfully
6992 >delete share command
</I
6998 requires that the administrator be connected using a root account (i.e.
7005 > will automatically invoke the
7009 >delete share command
</I
7011 > with two parameters.
7038 the existing service.
7043 > This parameter is only used to remove file shares. To delete printer shares,
7045 HREF=
"#DELETEPRINTERCOMMAND"
7057 HREF=
"#ADDSHARECOMMAND"
7066 HREF=
"#CHANGESHARECOMMAND"
7083 >delete share command = /usr/local/bin/delshare
</B
7088 NAME=
"DELETEUSERSCRIPT"
7090 >delete user script (G)
</DT
7093 >This is the full pathname to a script that will
7103 > under special circumstances
7106 >Normally, a Samba server requires that UNIX users are
7107 created for all users accessing files on this server. For sites
7108 that use Windows NT account databases as their primary user database
7109 creating these users and keeping the user list in sync with the
7110 Windows NT PDC is an onerous task. This option allows
<B
7113 > to delete the required UNIX users
<EM
7116 > when a user accesses the Samba server and the
7117 Windows NT user no longer exists.
</P
7119 >In order to use this option,
<B
7126 >security = domain
</I
7137 >delete user script
</I
7140 must be set to a full pathname for a script
7141 that will delete a UNIX user given one argument of
<TT
7147 which expands into the UNIX user name to delete.
</P
7149 >When the Windows user attempts to access the Samba server,
7152 > (session setup in the SMB protocol)
7157 HREF=
"#PASSWORDSERVER"
7164 > and attempts to authenticate
7165 the given user with the given password. If the authentication fails
7166 with the specific Domain error code meaning that the user no longer
7170 > attempts to find a UNIX user in
7171 the UNIX password database that matches the Windows user account. If
7172 this lookup succeeds, and
<TT
7175 >delete user script
</I
7181 > will all the specified script
7184 >, expanding any
<TT
7190 argument to be the user name to delete.
</P
7192 >This script should delete the given UNIX username. In this way,
7193 UNIX users are dynamically deleted to match existing Windows NT
7197 HREF=
"#SECURITYEQUALSDOMAIN"
7198 >security = domain
</A
7201 HREF=
"#PASSWORDSERVER"
7210 HREF=
"#ADDUSERSCRIPT"
7222 >delete user script =
<empty string
>
7228 >delete user script = /usr/local/samba/bin/del_user
7234 NAME=
"DELETEVETOFILES"
7236 >delete veto files (S)
</DT
7239 >This option is used when Samba is attempting to
7240 delete a directory that contains one or more vetoed directories
7250 option). If this option is set to
<TT
7253 > (the default) then if a vetoed
7254 directory contains any non-vetoed files or directories then the
7255 directory delete will fail. This is usually what you want.
</P
7257 >If this option is set to
<TT
7261 will attempt to recursively delete any files and directories within
7262 the vetoed directory. This can be useful for integration with file
7263 serving systems such as NetAtalk which create meta-files within
7264 directories you might normally veto DOS/Windows users from seeing
7272 >delete veto files = yes
</B
7274 directories to be transparently deleted when the parent directory
7275 is deleted (so long as the user has permissions to do so).
</P
7290 >delete veto files = no
</B
7315 >dfree command (G)
</DT
7324 only be used on systems where a problem occurs with the internal
7325 disk space calculations. This has been known to happen with Ultrix,
7326 but may occur with other operating systems. The symptom that was
7327 seen was an error of
"Abort Retry Ignore" at the end of each
7328 directory listing.
</P
7330 >This setting allows the replacement of the internal routines to
7331 calculate the total disk space and amount available with an external
7332 routine. The example below gives a possible script that might fulfill
7335 >The external program will be passed a single parameter indicating
7336 a directory in the filesystem being queried. This will typically consist
7340 >. The script should return two
7341 integers in ASCII. The first should be the total disk space in blocks,
7342 and the second should be the number of available blocks. An optional
7343 third return value can give the block size in bytes. The default
7344 blocksize is
1024 bytes.
</P
7346 >Note: Your script should
<EM
7349 setgid and should be owned by (and writeable only by) root!
</P
7352 >By default internal routines for
7353 determining the disk capacity and remaining space will be used.
7359 >dfree command = /usr/local/samba/bin/dfree
7363 >Where the script dfree (which must be made executable) could be:
</P
7372 CLASS=
"PROGRAMLISTING"
7375 df $
1 | tail -
1 | awk '{print $
2" "$
4}'
7382 >or perhaps (on Sys V based systems):
</P
7391 CLASS=
"PROGRAMLISTING"
7394 /usr/bin/df -k $
1 | tail -
1 | awk '{print $
3" "$
5}'
7401 >Note that you may have to replace the command names
7402 with full path names on some systems.
</P
7424 NAME=
"DIRECTORYMASK"
7426 >directory mask (S)
</DT
7429 >This parameter is the octal modes which are
7430 used when converting DOS modes to UNIX modes when creating UNIX
7433 >When a directory is created, the necessary permissions are
7434 calculated according to the mapping from DOS modes to UNIX permissions,
7435 and the resulting UNIX mode is then bit-wise 'AND'ed with this
7436 parameter. This parameter may be thought of as a bit-wise MASK for
7437 the UNIX modes of a directory. Any bit
<EM
7440 here will be removed from the modes set on a directory when it is
7443 >The default value of this parameter removes the 'group'
7444 and 'other' write bits from the UNIX mode, allowing only the
7445 user who owns the directory to modify it.
</P
7447 >Following this Samba will bit-wise 'OR' the UNIX mode
7448 created from this parameter with the value of the
<A
7449 HREF=
"#FORCEDIRECTORYMODE"
7453 >force directory mode
7457 > parameter. This parameter is set to
000 by
7458 default (i.e. no extra mode bits are added).
</P
7460 >Note that this parameter does not apply to permissions
7461 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
7462 a mask on access control lists also, they need to set the
<A
7463 HREF=
"#DIRECTORYSECURITYMASK"
7467 >directory security mask
</I
7473 HREF=
"#FORCEDIRECTORYMODE"
7481 > parameter to cause particular mode
7482 bits to always be set on created directories.
</P
7493 > parameter for masking mode bits on created files,
7495 HREF=
"#DIRECTORYSECURITYMASK"
7505 >Also refer to the
<A
7506 HREF=
"#INHERITPERMISSIONS"
7510 > inherit permissions
</I
7517 >directory mask =
0755</B
7522 >directory mask =
0775</B
7527 NAME=
"DIRECTORYMODE"
7529 >directory mode (S)
</DT
7533 HREF=
"#DIRECTORYMASK"
7544 NAME=
"DIRECTORYSECURITYMASK"
7546 >directory security mask (S)
</DT
7549 >This parameter controls what UNIX permission bits
7550 can be modified when a Windows NT client is manipulating the UNIX
7551 permission on a directory using the native NT security dialog
7554 >This parameter is applied as a mask (AND'ed with) to
7555 the changed permission bits, thus preventing any bits not in
7556 this mask from being modified. Essentially, zero bits in this
7557 mask may be treated as a set of bits the user is not allowed
7560 >If not set explicitly this parameter is set to
0777
7561 meaning a user is allowed to modify all the user/group/world
7562 permissions on a directory.
</P
7566 > that users who can access the
7567 Samba server through other means can easily bypass this restriction,
7568 so it is primarily useful for standalone
"appliance" systems.
7569 Administrators of most normal systems will probably want to leave
7570 it as the default of
<TT
7576 HREF=
"#FORCEDIRECTORYSECURITYMODE"
7580 > force directory security mode
</I
7584 HREF=
"#SECURITYMASK"
7593 HREF=
"#FORCESECURITYMODE"
7597 >force security mode
7605 >directory security mask =
0777</B
7610 >directory security mask =
0700</B
7615 NAME=
"DISABLESPOOLSS"
7617 >disable spoolss (G)
</DT
7620 >Enabling this parameter will disables Samba's support
7621 for the SPOOLSS set of MS-RPC's and will yield identical behavior
7622 as Samba
2.0.x. Windows NT/
2000 clients will downgrade to using
7623 Lanman style printing commands. Windows
9x/ME will be uneffected by
7624 the parameter. However, this will also disable the ability to upload
7625 printer drivers to a Samba server via the Windows NT Add Printer
7626 Wizard or by using the NT printer properties dialog window. It will
7627 also disable the capability of Windows NT/
2000 clients to download
7628 print drivers from the Samba host upon demand.
7630 >Be very careful about enabling this parameter.
</EM
7635 HREF=
"#USECLIENTDRIVER"
7636 >use client driver
</A
7642 >disable spoolss = no
</B
7657 when acting as a WINS server and finding that a NetBIOS name has not
7658 been registered, should treat the NetBIOS name word-for-word as a DNS
7659 name and do a lookup with the DNS server for that name on behalf of
7660 the name-querying client.
</P
7662 >Note that the maximum length for a NetBIOS name is
15
7663 characters, so the DNS name (or DNS alias) can likewise only be
7664 15 characters, maximum.
</P
7669 > spawns a second copy of itself to do the
7670 DNS name lookup requests, as doing a name lookup is a blocking
7673 >See also the parameter
<A
7690 NAME=
"DOMAINADMINGROUP"
7692 >domain admin group (G)
</DT
7695 >This parameter is intended as a temporary solution
7696 to enable users to be a member of the
"Domain Admins" group when
7697 a Samba host is acting as a PDC. A complete solution will be provided
7698 by a system for mapping Windows NT/
2000 groups onto UNIX groups.
7699 Please note that this parameter has a somewhat confusing name. It
7700 accepts a list of usernames and of group names in standard
7708 HREF=
"#DOMAINGUESTGROUP"
7717 HREF=
"#DOMAINLOGONS"
7729 >no domain administrators
</EM
7734 >domain admin group = root @wheel
</B
7739 NAME=
"DOMAINGUESTGROUP"
7741 >domain guest group (G)
</DT
7744 >This parameter is intended as a temporary solution
7745 to enable users to be a member of the
"Domain Guests" group when
7746 a Samba host is acting as a PDC. A complete solution will be provided
7747 by a system for mapping Windows NT/
2000 groups onto UNIX groups.
7748 Please note that this parameter has a somewhat confusing name. It
7749 accepts a list of usernames and of group names in standard
7757 HREF=
"#DOMAINADMINGROUP"
7766 HREF=
"#DOMAINLOGONS"
7778 >no domain guests
</EM
7783 >domain guest group = nobody @guest
</B
7790 >domain logons (G)
</DT
7796 >, the Samba server will serve
7797 Windows
95/
98 Domain logons for the
<A
7805 > it is in. Samba
2.2 also
7806 has limited capability to act as a domain controller for Windows
7807 NT
4 Domains. For more details on setting up this feature see
7808 the Samba-PDC-HOWTO included in the
<TT
7812 directory shipped with the source code.
</P
7816 >domain logons = no
</B
7823 >domain master (G)
</DT
7833 > to enable WAN-wide browse list
7834 collation. Setting this option causes
<B
7838 claim a special domain specific NetBIOS name that identifies
7839 it as a domain master browser for its given
<A
7847 >. Local master browsers
7853 > on broadcast-isolated
7854 subnets will give this
<B
7857 > their local browse lists,
7866 for a complete copy of the browse list for the whole wide area
7867 network. Browser clients will then contact their local master browser,
7868 and will receive the domain-wide browse list, instead of just the list
7869 for their broadcast-isolated subnet.
</P
7871 >Note that Windows NT Primary Domain Controllers expect to be
7872 able to claim this
<TT
7878 NetBIOS name that identifies them as domain master browsers for
7884 > by default (i.e. there is no
7885 way to prevent a Windows NT PDC from attempting to do this). This
7886 means that if this parameter is set and
<B
7890 the special name for a
<TT
7896 NT PDC is able to do so then cross subnet browsing will behave
7897 strangely and may fail.
</P
7900 HREF=
"#DOMAINLOGONS"
7903 >domain logons = yes
</B
7906 >, then the default behavior is to enable the
<TT
7918 not enabled (the default setting), then neither will
<TT
7924 > be enabled by default.
</P
7928 >domain master = auto
</B
7935 >dont descend (S)
</DT
7938 >There are certain directories on some systems
7942 > tree under Linux) that are either not
7943 of interest to clients or are infinitely deep (recursive). This
7944 parameter allows you to specify a comma-delimited list of directories
7945 that the server should always show as empty.
</P
7947 >Note that Samba can be very fussy about the exact format
7948 of the
"dont descend" entries. For example you may need
<TT
7951 > instead of just
<TT
7955 Experimentation is the best policy :-)
</P
7958 >none (i.e., all directories are OK
7964 >dont descend = /proc,/dev
</B
7971 >dos filemode (S)
</DT
7974 > The default behavior in Samba is to provide
7975 UNIX-like behavior where only the owner of a file/directory is
7976 able to change the permissions on it. However, this behavior
7977 is often confusing to DOS/Windows users. Enabling this parameter
7978 allows a user who has write access to the file (by whatever
7979 means) to modify the permissions on it. Note that a user
7980 belonging to the group owning the file will not be allowed to
7981 change permissions if the group is only granted read access.
7982 Ownership of the file/directory is not changed, only the permissions
7987 >dos filemode = no
</B
7992 NAME=
"DOSFILETIMERESOLUTION"
7994 >dos filetime resolution (S)
</DT
7997 >Under the DOS and Windows FAT filesystem, the finest
7998 granularity on time resolution is two seconds. Setting this parameter
7999 for a share causes Samba to round the reported time down to the
8000 nearest two second boundary when a query call that requires one second
8001 resolution is made to
<A
8011 >This option is mainly used as a compatibility option for Visual
8012 C++ when used against Samba shares. If oplocks are enabled on a
8013 share, Visual C++ uses two different time reading calls to check if a
8014 file has changed since it was last read. One of these calls uses a
8015 one-second granularity, the other uses a two second granularity. As
8016 the two second call rounds any odd second down, then if the file has a
8017 timestamp of an odd number of seconds then the two timestamps will not
8018 match and Visual C++ will keep reporting the file has changed. Setting
8019 this option causes the two timestamps to match, and Visual C++ is
8024 >dos filetime resolution = no
</B
8031 >dos filetimes (S)
</DT
8034 >Under DOS and Windows, if a user can write to a
8035 file they can change the timestamp on it. Under POSIX semantics,
8036 only the owner of the file or root may change the timestamp. By
8037 default, Samba runs with POSIX semantics and refuses to change the
8038 timestamp on a file if the user
<B
8042 on behalf of is not the file owner. Setting this option to
<TT
8045 > allows DOS semantics and
<A
8049 > will change the file
8050 timestamp as DOS requires.
</P
8054 >dos filetimes = no
</B
8059 NAME=
"ENCRYPTPASSWORDS"
8061 >encrypt passwords (G)
</DT
8064 >This boolean controls whether encrypted passwords
8065 will be negotiated with the client. Note that Windows NT
4.0 SP3 and
8066 above and also Windows
98 will by default expect encrypted passwords
8067 unless a registry entry is changed. To use encrypted passwords in
8068 Samba see the file ENCRYPTION.txt in the Samba documentation
8072 > shipped with the source code.
</P
8074 >In order for encrypted passwords to work correctly
8083 have access to a local
<A
8084 HREF=
"smbpasswd.5.html"
8092 HREF=
"smbpasswd.8.html"
8098 > program for information on how to set up
8099 and maintain this file), or set the
<A
8101 >security = [server|domain]
</A
8106 > to authenticate against another
8111 >encrypt passwords = no
</B
8116 NAME=
"ENHANCEDBROWSING"
8118 >enhanced browsing (G)
</DT
8121 >This option enables a couple of enhancements to
8122 cross-subnet browse propagation that have been added in Samba
8123 but which are not standard in Microsoft implementations.
8126 >The first enhancement to browse propagation consists of a regular
8127 wildcard query to a Samba WINS server for all Domain Master Browsers,
8128 followed by a browse synchronization with each of the returned
8129 DMBs. The second enhancement consists of a regular randomised browse
8130 synchronization with all currently known DMBs.
</P
8132 >You may wish to disable this option if you have a problem with empty
8133 workgroups not disappearing from browse lists. Due to the restrictions
8134 of the browse protocols these enhancements can cause a empty workgroup
8135 to stay around forever which can be annoying.
</P
8137 >In general you should leave this option enabled as it makes
8138 cross-subnet browse propagation much more reliable.
</P
8142 >enhanced browsing = yes
</B
8147 NAME=
"ENUMPORTSCOMMAND"
8149 >enumports command (G)
</DT
8152 >The concept of a
"port" is fairly foreign
8153 to UNIX hosts. Under Windows NT/
2000 print servers, a port
8154 is associated with a port monitor and generally takes the form of
8155 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
8156 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
8159 >"Samba Printer Port"</TT
8161 Windows NT/
2000, all printers must have a valid port name.
8162 If you wish to have a list of ports displayed (
<B
8166 > does not use a port name for anything) other than
8169 >"Samba Printer Port"</TT
8174 >enumports command
</I
8177 a program which should generate a list of ports, one per line,
8178 to standard output. This listing will then be used in response
8179 to the level
1 and
2 EnumPorts() RPC.
</P
8182 >no enumports command
</EM
8187 >enumports command = /usr/bin/listports
8198 >This is a synonym for
<A
8210 NAME=
"FAKEDIRECTORYCREATETIMES"
8212 >fake directory create times (S)
</DT
8215 >NTFS and Windows VFAT file systems keep a create
8216 time for all files and directories. This is not the same as the
8217 ctime - status change time - that Unix keeps, so Samba by default
8218 reports the earliest of the various times Unix does keep. Setting
8219 this parameter for a share causes Samba to always report midnight
8220 1-
1-
1980 as the create time for directories.
</P
8222 >This option is mainly used as a compatibility option for
8223 Visual C++ when used against Samba shares. Visual C++ generated
8224 makefiles have the object directory as a dependency for each object
8225 file, and a make rule to create the directory. Also, when NMAKE
8226 compares timestamps it uses the creation time when examining a
8227 directory. Thus the object directory will be created if it does not
8228 exist, but once it does exist it will always have an earlier
8229 timestamp than the object files it contains.
</P
8231 >However, Unix time semantics mean that the create time
8232 reported by Samba will be updated whenever a file is created or
8233 or deleted in the directory. NMAKE finds all object files in
8234 the object directory. The timestamp of the last one built is then
8235 compared to the timestamp of the object directory. If the
8236 directory's timestamp if newer, then all object files
8237 will be rebuilt. Enabling this option
8238 ensures directories always predate their contents and an NMAKE build
8239 will proceed as expected.
</P
8243 >fake directory create times = no
</B
8250 >fake oplocks (S)
</DT
8253 >Oplocks are the way that SMB clients get permission
8254 from a server to locally cache file operations. If a server grants
8255 an oplock (opportunistic lock) then the client is free to assume
8256 that it is the only one accessing the file and it will aggressively
8257 cache file data. With some oplock types the client may even cache
8258 file open/close operations. This can give enormous performance benefits.
8263 >fake oplocks = yes
</B
8272 always grant oplock requests no matter how many clients are using
8275 >It is generally much better to use the real
<A
8284 than this parameter.
</P
8286 >If you enable this option on all read-only shares or
8287 shares that you know will only be accessed from one client at a
8288 time such as physically read-only media like CDROMs, you will see
8289 a big performance improvement on many operations. If you enable
8290 this option on shares where multiple clients may be accessing the
8291 files read-write at the same time you can get data corruption. Use
8292 this option carefully!
</P
8296 >fake oplocks = no
</B
8301 NAME=
"FOLLOWSYMLINKS"
8303 >follow symlinks (S)
</DT
8306 >This parameter allows the Samba administrator
8315 from following symbolic links in a particular share. Setting this
8319 > prevents any file or directory
8320 that is a symbolic link from being followed (the user will get an
8321 error). This option is very useful to stop users from adding a
8322 symbolic link to
<TT
8326 directory for instance. However it will slow filename lookups
8329 >This option is enabled (i.e.
<B
8333 follow symbolic links) by default.
</P
8337 >follow symlinks = yes
</B
8342 NAME=
"FORCECREATEMODE"
8344 >force create mode (S)
</DT
8347 >This parameter specifies a set of UNIX mode bit
8348 permissions that will
<EM
8351 file created by Samba. This is done by bitwise 'OR'ing these bits onto
8352 the mode bits of a file that is being created or having its
8353 permissions changed. The default for this parameter is (in octal)
8354 000. The modes in this parameter are bitwise 'OR'ed onto the file
8355 mode after the mask set in the
<TT
8361 parameter is applied.
</P
8363 >See also the parameter
<A
8372 > for details on masking mode bits on files.
</P
8375 HREF=
"#INHERITPERMISSIONS"
8387 >force create mode =
000</B
8392 >force create mode =
0755</B
8395 >would force all created files to have read and execute
8396 permissions set for 'group' and 'other' as well as the
8397 read/write/execute bits set for the 'user'.
</P
8401 NAME=
"FORCEDIRECTORYMODE"
8403 >force directory mode (S)
</DT
8406 >This parameter specifies a set of UNIX mode bit
8407 permissions that will
<EM
8409 > be set on a directory
8410 created by Samba. This is done by bitwise 'OR'ing these bits onto the
8411 mode bits of a directory that is being created. The default for this
8412 parameter is (in octal)
0000 which will not add any extra permission
8413 bits to a created directory. This operation is done after the mode
8414 mask in the parameter
<TT
8422 >See also the parameter
<A
8423 HREF=
"#DIRECTORYMASK"
8430 > for details on masking mode bits
8431 on created directories.
</P
8434 HREF=
"#INHERITPERMISSIONS"
8438 > inherit permissions
</I
8445 >force directory mode =
000</B
8450 >force directory mode =
0755</B
8453 >would force all created directories to have read and execute
8454 permissions set for 'group' and 'other' as well as the
8455 read/write/execute bits set for the 'user'.
</P
8459 NAME=
"FORCEDIRECTORYSECURITYMODE"
8462 security mode (S)
</DT
8465 >This parameter controls what UNIX permission bits
8466 can be modified when a Windows NT client is manipulating the UNIX
8467 permission on a directory using the native NT security dialog box.
</P
8469 >This parameter is applied as a mask (OR'ed with) to the
8470 changed permission bits, thus forcing any bits in this mask that
8471 the user may have modified to be on. Essentially, one bits in this
8472 mask may be treated as a set of bits that, when modifying security
8473 on a directory, the user has always set to be 'on'.
</P
8475 >If not set explicitly this parameter is
000, which
8476 allows a user to modify all the user/group/world permissions on a
8477 directory without restrictions.
</P
8481 > that users who can access the
8482 Samba server through other means can easily bypass this restriction,
8483 so it is primarily useful for standalone
"appliance" systems.
8484 Administrators of most normal systems will probably want to leave
8488 HREF=
"#DIRECTORYSECURITYMASK"
8492 > directory security mask
</I
8496 HREF=
"#SECURITYMASK"
8505 HREF=
"#FORCESECURITYMODE"
8509 >force security mode
8517 >force directory security mode =
0</B
8522 >force directory security mode =
700</B
8529 >force group (S)
</DT
8532 >This specifies a UNIX group name that will be
8533 assigned as the default primary group for all users connecting
8534 to this service. This is useful for sharing files by ensuring
8535 that all access to files on service will use the named group for
8536 their permissions checking. Thus, by assigning permissions for this
8537 group to the files and directories within this service the Samba
8538 administrator can restrict or allow sharing of these files.
</P
8540 >In Samba
2.0.5 and above this parameter has extended
8541 functionality in the following way. If the group name listed here
8542 has a '+' character prepended to it then the current user accessing
8543 the share only has the primary group default assigned to this group
8544 if they are already assigned as a member of that group. This allows
8545 an administrator to decide that only users who are already in a
8546 particular group will create files with group ownership set to that
8547 group. This gives a finer granularity of ownership assignment. For
8548 example, the setting
<TT
8550 >force group = +sys
</TT
8552 that only users who are already in group sys will have their default
8553 primary group assigned to sys when accessing this Samba share. All
8554 other users will retain their ordinary primary group.
</P
8565 > parameter is also set the group specified in
8571 > will override the primary group
8591 >no forced group
</EM
8596 >force group = agroup
</B
8601 NAME=
"FORCESECURITYMODE"
8603 >force security mode (S)
</DT
8606 >This parameter controls what UNIX permission
8607 bits can be modified when a Windows NT client is manipulating
8608 the UNIX permission on a file using the native NT security dialog
8611 >This parameter is applied as a mask (OR'ed with) to the
8612 changed permission bits, thus forcing any bits in this mask that
8613 the user may have modified to be on. Essentially, one bits in this
8614 mask may be treated as a set of bits that, when modifying security
8615 on a file, the user has always set to be 'on'.
</P
8617 >If not set explicitly this parameter is set to
0,
8618 and allows a user to modify all the user/group/world permissions on a file,
8619 with no restrictions.
</P
8623 > that users who can access
8624 the Samba server through other means can easily bypass this restriction,
8625 so it is primarily useful for standalone
"appliance" systems.
8626 Administrators of most normal systems will probably want to leave
8627 this set to
0000.
</P
8630 HREF=
"#FORCEDIRECTORYSECURITYMODE"
8634 > force directory security mode
</I
8639 HREF=
"#DIRECTORYSECURITYMASK"
8648 HREF=
"#SECURITYMASK"
8659 >force security mode =
0</B
8664 >force security mode =
700</B
8669 NAME=
"FORCEUNKNOWNACLUSER"
8671 >force unknown acl user (S)
</DT
8674 >If this parameter is set, a Windows NT ACL that contains
8675 an unknown SID (security descriptor, or representation of a user or group id)
8676 as the owner or group owner of the file will be silently mapped into the
8677 current UNIX uid or gid of the currently connected user.
</P
8679 >This is designed to allow Windows NT clients to copy files and
8680 folders containing ACLs that were created locally on the client machine
8681 and contain users local to that machine only (no domain users) to be
8682 copied to a Samba server (usually with XCOPY /O) and have the unknown
8683 userid and groupid of the file owner map to the current connected user.
8684 This can only be fixed correctly when winbindd allows arbitrary mapping
8685 from any Windows NT SID to a UNIX uid or gid.
</P
8687 >Try using this parameter when XCOPY /O gives an ACCESS_DENIED error.
8707 >force unknown acl user = yes
</B
8717 >This specifies a UNIX user name that will be
8718 assigned as the default user for all users connecting to this service.
8719 This is useful for sharing files. You should also use it carefully
8720 as using it incorrectly can cause security problems.
</P
8722 >This user name only gets used once a connection is established.
8723 Thus clients still need to connect as a valid user and supply a
8724 valid password. Once connected, all file operations will be performed
8725 as the
"forced user", no matter what username the client connected
8726 as. This can be very useful.
</P
8728 >In Samba
2.0.5 and above this parameter also causes the
8729 primary group of the forced user to be used as the primary group
8730 for all file activity. Prior to
2.0.5 the primary group was left
8731 as the primary group of the connecting user (this was a bug).
</P
8750 >force user = auser
</B
8760 >This parameter allows the administrator to
8761 configure the string that specifies the type of filesystem a share
8762 is using that is reported by
<A
8770 > when a client queries the filesystem type
8771 for a share. The default type is
<TT
8775 compatibility with Windows NT but this can be changed to other
8799 >getwd cache (G)
</DT
8802 >This is a tuning option. When this is enabled a
8803 caching algorithm will be used to reduce the time taken for getwd()
8804 calls. This can have a significant impact on performance, especially
8814 >parameter is set to
<TT
8821 >getwd cache = yes
</B
8846 >guest account (S)
</DT
8849 >This is a username which will be used for access
8850 to services which are specified as
<A
8858 > (see below). Whatever privileges this
8859 user has will be available to any client connecting to the guest service.
8860 Typically this user will exist in the password file, but will not
8861 have a valid login. The user account
"ftp" is often a good choice
8862 for this parameter. If a username is specified in a given service,
8863 the specified username overrides this one.
</P
8865 >One some systems the default guest account
"nobody" may not
8866 be able to print. Use another account in this case. You should test
8867 this by trying to log in as your guest user (perhaps by using the
8871 > command) and trying to print using the
8872 system print command such as
<B
8881 >specified at compile time, usually
8887 >guest account = ftp
</B
8897 >If this parameter is
<TT
8901 a service, then no password is required to connect to the service.
8902 Privileges will be those of the
<A
8903 HREF=
"#GUESTACCOUNT"
8912 >See the section below on
<A
8920 > for more information about this option.
8935 >If this parameter is
<TT
8939 a service, then only guest connections to the service are permitted.
8940 This parameter will have no effect if
<A
8948 > is not set for the service.
</P
8950 >See the section below on
<A
8958 > for more information about this option.
8970 >hide dot files (S)
</DT
8973 >This is a boolean parameter that controls whether
8974 files starting with a dot appear as hidden files.
</P
8978 >hide dot files = yes
</B
8988 >This is a list of files or directories that are not
8989 visible but are accessible. The DOS 'hidden' attribute is applied
8990 to any files or directories that match.
</P
8992 >Each entry in the list must be separated by a '/',
8993 which allows spaces to be included in the entry. '*'
8994 and '?' can be used to specify multiple files or directories
8995 as in DOS wildcards.
</P
8997 >Each entry must be a Unix path, not a DOS path and must
8998 not include the Unix directory separator '/'.
</P
9000 >Note that the case sensitivity option is applicable
9003 >Setting this parameter will affect the performance of Samba,
9004 as it will be forced to check all files and directories for a match
9005 as they are scanned.
</P
9008 HREF=
"#HIDEDOTFILES"
9025 HREF=
"#CASESENSITIVE"
9035 >no file are hidden
</EM
9041 /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</B
9044 >The above example is based on files that the Macintosh
9045 SMB client (DAVE) available from
<A
9046 HREF=
"http://www.thursby.com"
9050 > creates for internal use, and also still hides
9051 all files beginning with a dot.
</P
9055 NAME=
"HIDELOCALUSERS"
9057 >hide local users(G)
</DT
9060 >This parameter toggles the hiding of local UNIX
9061 users (root, wheel, floppy, etc) from remote clients.
</P
9065 >hide local users = no
</B
9070 NAME=
"HIDEUNREADABLE"
9072 >hide unreadable (S)
</DT
9075 >This parameter prevents clients from seeing the
9076 existance of files that cannot be read. Defaults to off.
</P
9080 >hide unreadable = no
</B
9087 >homedir map (G)
</DT
9115 > then this parameter
9116 specifies the NIS (or YP) map from which the server for the user's
9117 home directory should be extracted. At present, only the Sun
9118 auto.home map format is understood. The form of the map is:
</P
9122 >username server:/some/file/system
</B
9125 >and the program will extract the servername from before
9126 the first ':'. There should probably be a better parsing system
9127 that copes with different map formats and also Amd (another
9128 automounter) maps.
</P
9132 >A working NIS client is required on
9133 the system for this option to work.
</P
9145 HREF=
"#DOMAINLOGONS"
9157 >homedir map =
<empty string
></B
9162 >homedir map = amd.homedir
</B
9172 >This boolean parameter is only available
9173 if Samba has been configured and compiled with the
<B
9176 > option. If set to
<TT
9180 Samba will act as a Dfs server, and allow Dfs-aware clients
9181 to browse Dfs trees hosted on the server.
</P
9191 > share level parameter. For
9192 more information on setting up a Dfs tree on Samba,
9194 HREF=
"msdfs_setup.html"
9196 >msdfs_setup.html
</A
9209 >hosts allow (S)
</DT
9212 >A synonym for this parameter is
<TT
9220 >This parameter is a comma, space, or tab delimited
9221 set of hosts which are permitted to access a service.
</P
9223 >If specified in the [global] section then it will
9224 apply to all services, regardless of whether the individual
9225 service has a different setting.
</P
9227 >You can specify the hosts by name or IP number. For
9228 example, you could restrict access to only the hosts on a
9229 Class C subnet with something like
<B
9231 >allow hosts =
150.203.5.
9233 >. The full syntax of the list is described in the man
9236 >hosts_access(
5)
</TT
9237 >. Note that this man
9238 page may not be present on your system, so a brief description will
9239 be given here also.
</P
9241 >Note that the localhost address
127.0.0.1 will always
9242 be allowed access unless specifically denied by a
<A
9252 >You can also specify hosts by network/netmask pairs and
9253 by netgroup names if your system supports netgroups. The
9256 > keyword can also be used to limit a
9257 wildcard list. The following examples may provide some help:
</P
9259 >Example
1: allow all IPs in
150.203.*.*; except one
</P
9263 >hosts allow =
150.203. EXCEPT
150.203.6.66</B
9266 >Example
2: allow hosts that match the given network/netmask
</P
9270 >hosts allow =
150.203.15.0/
255.255.255.0</B
9273 >Example
3: allow a couple of hosts
</P
9277 >hosts allow = lapland, arvidsjaur
</B
9280 >Example
4: allow only hosts in NIS netgroup
"foonet", but
9281 deny access from one particular host
</P
9285 >hosts allow = @foonet
</B
9290 >hosts deny = pirate
</B
9293 >Note that access still requires suitable user-level passwords.
</P
9296 HREF=
"testparm.1.html"
9303 > for a way of testing your host access to see if it does
9307 >none (i.e., all hosts permitted access)
9313 >allow hosts =
150.203.5. myhost.mynet.edu.au
9324 >The opposite of
<TT
9330 - hosts listed here are
<EM
9332 > permitted access to
9333 services unless the specific services have their own lists to override
9334 this one. Where the lists conflict, the
<TT
9340 list takes precedence.
</P
9343 >none (i.e., no hosts specifically excluded)
9349 >hosts deny =
150.203.4. badhost.mynet.edu.au
9357 >hosts equiv (G)
</DT
9360 >If this global parameter is a non-null string,
9361 it specifies the name of a file to read for the names of hosts
9362 and users who will be allowed access without specifying a password.
9365 >This is not be confused with
<A
9373 > which is about hosts
9374 access to services and is more useful for guest services.
<TT
9379 > may be useful for NT clients which will
9380 not supply passwords to Samba.
</P
9390 > can be a major security hole. This is because you are
9391 trusting the PC to supply the correct username. It is very easy to
9392 get a PC to supply a false username. I recommend that the
9398 > option be only used if you really
9399 know what you are doing, or perhaps on a home network where you trust
9400 your spouse and kids. And only if you
<EM
9406 >no host equivalences
</EM
9411 >hosts equiv = /etc/hosts.equiv
</B
9421 >This allows you to include one config file
9422 inside another. The file is included literally, as though typed
9425 >It takes the standard substitutions, except
<TT
9445 >no file included
</EM
9450 >include = /usr/local/samba/lib/admin_smb.conf
9458 >inherit acls (S)
</DT
9461 >This parameter can be used to ensure
9462 that if default acls exist on parent directories,
9463 they are always honored when creating a subdirectory.
9464 The default behavior is to use the mode specified
9465 when creating the directory. Enabling this option
9466 sets the mode to
0777, thus guaranteeing that
9467 default directory acls are propagated.
9472 >inherit acls = no
</B
9478 NAME=
"INHERITPERMISSIONS"
9480 >inherit permissions (S)
</DT
9483 >The permissions on new files and directories
9484 are normally governed by
<A
9493 HREF=
"#DIRECTORYMASK"
9501 HREF=
"#FORCECREATEMODE"
9505 >force create mode
</I
9510 HREF=
"#FORCEDIRECTORYMODE"
9518 > but the boolean inherit
9519 permissions parameter overrides this.
</P
9521 >New directories inherit the mode of the parent directory,
9522 including bits such as setgid.
</P
9524 >New files inherit their read/write bits from the parent
9525 directory. Their execute bits continue to be determined by
9555 >Note that the setuid bit is
<EM
9558 inheritance (the code explicitly prohibits this).
</P
9560 >This can be particularly useful on large systems with
9561 many users, perhaps several thousand, to allow a single [homes]
9562 share to be used flexibly by each user.
</P
9574 HREF=
"#DIRECTORYMASK"
9582 HREF=
"#FORCECREATEMODE"
9586 >force create mode
</I
9590 HREF=
"#FORCEDIRECTORYMODE"
9594 >force directory mode
</I
9602 >inherit permissions = no
</B
9612 >This option allows you to override the default
9613 network interfaces list that Samba will use for browsing, name
9614 registration and other NBT traffic. By default Samba will query
9615 the kernel for the list of all active interfaces and use any
9616 interfaces except
127.0.0.1 that are broadcast capable.
</P
9618 >The option takes a list of interface strings. Each string
9619 can be in any of the following forms:
</P
9625 >a network interface name (such as eth0).
9626 This may include shell-like wildcards so eth* will match
9627 any interface starting with the substring
"eth"</P
9631 >an IP address. In this case the netmask is
9632 determined from the list of interfaces obtained from the
9637 >an IP/mask pair.
</P
9641 >a broadcast/mask pair.
</P
9645 >The
"mask" parameters can either be a bit length (such
9646 as
24 for a C class network) or a full netmask in dotted
9649 >The
"IP" parameters above can either be a full dotted
9650 decimal IP address or a hostname which will be looked up via
9651 the OS's normal hostname resolution mechanisms.
</P
9653 >For example, the following line:
</P
9657 >interfaces = eth0
192.168.2.10/
24 192.168.3.10/
255.255.255.0
9661 >would configure three network interfaces corresponding
9662 to the eth0 device and IP addresses
192.168.2.10 and
192.168.3.10.
9663 The netmasks of the latter two interfaces would be set to
255.255.255.0.
</P
9666 HREF=
"#BINDINTERFACESONLY"
9677 >all active interfaces except
127.0.0.1
9678 that are broadcast capable
</EM
9685 >invalid users (S)
</DT
9688 >This is a list of users that should not be allowed
9689 to login to this service. This is really a
<EM
9692 check to absolutely ensure an improper setting does not breach
9695 >A name starting with a '@' is interpreted as an NIS
9696 netgroup first (if your system supports NIS), and then as a UNIX
9697 group if the name was not found in the NIS netgroup database.
</P
9699 >A name starting with '+' is interpreted only
9700 by looking in the UNIX group database. A name starting with
9701 '
&' is interpreted only by looking in the NIS netgroup database
9702 (this requires NIS to be working on your system). The characters
9703 '+' and '
&' may be used at the start of the name in either order
9710 UNIX group database, followed by the NIS netgroup database, and
9716 > means check the NIS
9717 netgroup database, followed by the UNIX group database (the
9718 same as the '@' prefix).
</P
9720 >The current servicename is substituted for
<TT
9726 This is useful in the [homes] section.
</P
9740 >no invalid users
</EM
9745 >invalid users = root fred admin @wheel
9756 >The value of the parameter (an integer) represents
9757 the number of seconds between
<TT
9763 packets. If this parameter is zero, no keepalive packets will be
9764 sent. Keepalive packets, if sent, allow the server to tell whether
9765 a client is still present and responding.
</P
9767 >Keepalives should, in general, not be needed if the socket
9768 being used has the SO_KEEPALIVE attribute set on it (see
<A
9769 HREF=
"#SOCKETOPTIONS"
9777 Basically you should only use this option if you strike difficulties.
</P
9791 NAME=
"KERNELOPLOCKS"
9793 >kernel oplocks (G)
</DT
9796 >For UNIXes that support kernel based
<A
9805 (currently only IRIX and the Linux
2.4 kernel), this parameter
9806 allows the use of them to be turned on or off.
</P
9808 >Kernel oplocks support allows Samba
<TT
9814 > to be broken whenever a local UNIX process or NFS operation
9815 accesses a file that
<A
9823 > has oplocked. This allows complete data consistency between
9824 SMB/CIFS, NFS and local file access (and is a
<EM
9827 cool feature :-).
</P
9829 >This parameter defaults to
<TT
9832 >, but is translated
9833 to a no-op on systems that no not have the necessary kernel support.
9834 You should never need to touch this parameter.
</P
9846 HREF=
"#LEVEL2OPLOCKS"
9858 >kernel oplocks = yes
</B
9865 >lanman auth (G)
</DT
9868 >This parameter determines whether or not
<A
9873 attempt to authenticate users using the LANMAN password hash.
9874 If disabled, only clients which support NT password hashes (e.g. Windows
9875 NT/
2000 clients, smbclient, etc... but not Windows
95/
98 or the MS DOS
9876 network client) will be able to connect to the Samba host.
</P
9880 >lanman auth = yes
</B
9885 NAME=
"LARGEREADWRITE"
9887 >large readwrite (G)
</DT
9890 >This parameter determines whether or not
<A
9895 supports the new
64k streaming read and write varient SMB requests introduced
9896 with Windows
2000. Note that due to Windows
2000 client redirector bugs
9897 this requires Samba to be running on a
64-bit capable operating system such
9898 as IRIX, Solaris or a Linux
2.4 kernel. Can improve performance by
10% with
9899 Windows
2000 clients. Defaults to off. Not as tested as some other Samba
9905 >large readwrite = no
</B
9912 >ldap admin dn (G)
</DT
9915 >This parameter is only available if Samba has been
9916 configure to include the
<B
9920 at compile time. This option should be considered experimental and
9921 under active development.
9929 > defines the Distinguished
9930 Name (DN) name used by Samba to contact the
<A
9934 > when retreiving user account information. The
<TT
9940 > is used in conjunction with the admin dn password
9943 >private/secrets.tdb
</TT
9946 HREF=
"smbpasswd.8.html"
9953 page for more information on how to accmplish this.
9964 >ldap filter (G)
</DT
9967 >This parameter is only available if Samba has been
9968 configure to include the
<B
9972 at compile time. This option should be considered experimental and
9973 under active development.
9976 > This parameter specifies the RFC
2254 compliant LDAP search filter.
9977 The default is to match the login name with the
<TT
9981 attribute for all entries matching the
<TT
9985 objectclass. Note that this filter should only return one entry.
9990 >ldap filter = (
&(uid=%u)(objectclass=sambaAccount))
</B
10000 >This parameter is only available if Samba has been
10001 configure to include the
<B
10005 at compile time. This option should be considered experimental and
10006 under active development.
10009 > This option is used to control the tcp port number used to contact
10019 The default is to use the stand LDAPS port
636.
10030 >ldap port =
636 ; if ldap ssl = on
</B
10035 >ldap port =
389 ; if ldap ssl = off
</B
10042 >ldap server (G)
</DT
10045 >This parameter is only available if Samba has been
10046 configure to include the
<B
10050 at compile time. This option should be considered experimental and
10051 under active development.
10054 > This parameter should contains the FQDN of the ldap directory
10055 server which should be queried to locate user account information.
10060 >ldap server = localhost
</B
10070 >This parameter is only available if Samba has been
10071 configure to include the
<B
10075 at compile time. This option should be considered experimental and
10076 under active development.
10079 > This option is used to define whether or not Samba should
10080 use SSL when connecting to the
<A
10092 Samba SSL support which is enabled by specifying the
10096 > option to the
<TT
10116 > can be set to one of three values:
10120 > - Always use SSL when contacting the
10130 Never use SSL when querying the directory, or (c)
<TT
10134 - Use the LDAPv3 StartTLS extended operation
10135 (RFC2830) for communicating with the directory server.
10147 >ldap suffix (G)
</DT
10150 >This parameter is only available if Samba has been
10151 configure to include the
<B
10155 at compile time. This option should be considered experimental and
10156 under active development.
10165 NAME=
"LEVEL2OPLOCKS"
10167 >level2 oplocks (S)
</DT
10170 >This parameter controls whether Samba supports
10171 level2 (read-only) oplocks on a share.
</P
10173 >Level2, or read-only oplocks allow Windows NT clients
10174 that have an oplock on a file to downgrade from a read-write oplock
10175 to a read-only oplock once a second client opens the file (instead
10176 of releasing all oplocks on a second open, as in traditional,
10177 exclusive oplocks). This allows all openers of the file that
10178 support level2 oplocks to cache the file for read-ahead only (ie.
10179 they may not cache writes or lock requests) and increases performance
10180 for many accesses of files that are not commonly written (such as
10181 application .EXE files).
</P
10183 >Once one of the clients which have a read-only oplock
10184 writes to the file all clients are notified (no reply is needed
10185 or waited for) and told to break their oplocks to
"none" and
10186 delete any read-ahead caches.
</P
10188 >It is recommended that this parameter be turned on
10189 to speed access to shared executables.
</P
10191 >For more discussions on level2 oplocks see the CIFS spec.
</P
10194 HREF=
"#KERNELOPLOCKS"
10202 > are supported then level2 oplocks are
10203 not granted (even if this parameter is set to
<TT
10216 > parameter must be set to
<TT
10219 > on this share in order for
10220 this parameter to have any effect.
</P
10244 >level2 oplocks = yes
</B
10251 >lm announce (G)
</DT
10254 >This parameter determines if
<A
10261 > will produce Lanman announce
10262 broadcasts that are needed by OS/
2 clients in order for them to see
10263 the Samba server in their browse list. This parameter can have three
10274 >. The default is
<TT
10281 > Samba will never produce these
10282 broadcasts. If set to
<TT
10285 > Samba will produce
10286 Lanman announce broadcasts at a frequency set by the parameter
10296 Samba will not send Lanman announce broadcasts by default but will
10297 listen for them. If it hears such a broadcast on the wire it will
10298 then start sending them at a frequency set by the parameter
10319 >lm announce = auto
</B
10324 >lm announce = yes
</B
10331 >lm interval (G)
</DT
10334 >If Samba is set to produce Lanman announce
10335 broadcasts needed by OS/
2 clients (see the
<A
10343 > parameter) then this
10344 parameter defines the frequency in seconds with which they will be
10345 made. If this is set to zero then no Lanman announcements will be
10346 made despite the setting of the
<TT
10367 >lm interval =
60</B
10372 >lm interval =
120</B
10377 NAME=
"LOADPRINTERS"
10379 >load printers (G)
</DT
10382 >A boolean variable that controls whether all
10383 printers in the printcap will be loaded for browsing by default.
10392 >load printers = yes
</B
10399 >local master (G)
</DT
10402 >This option allows
<A
10409 > to try and become a local master browser
10410 on a subnet. If set to
<TT
10416 > will not attempt to become a local master browser
10417 on a subnet and will also lose in all browsing elections. By
10418 default this value is set to
<TT
10421 >. Setting this value to
<TT
10425 mean that Samba will
<EM
10428 browser on a subnet, just that
<B
10433 > in elections for local master browser.
</P
10435 >Setting this value to
<TT
10444 > to become a local master browser.
</P
10448 >local master = yes
</B
10459 HREF=
"#LOCKDIRECTORY"
10463 > lock directory
</I
10470 NAME=
"LOCKDIRECTORY"
10472 >lock directory (G)
</DT
10475 >This option specifies the directory where lock
10476 files will be placed. The lock files are used to implement the
10478 HREF=
"#MAXCONNECTIONS"
10482 >max connections
</I
10490 >lock directory = ${prefix}/var/locks
</B
10495 >lock directory = /var/run/samba/locks
</B
10501 NAME=
"LOCKSPINCOUNT"
10503 >lock spin count (G)
</DT
10506 >This parameter controls the number of times
10507 that smbd should attempt to gain a byte range lock on the
10508 behalf of a client request. Experiments have shown that
10509 Windows
2k servers do not reply with a failure if the lock
10510 could not be immediately granted, but try a few more times
10511 in case the lock could later be aquired. This behavior
10512 is used to support PC database formats such as MS Access
10518 >lock spin count =
2</B
10524 NAME=
"LOCKSPINTIME"
10526 >lock spin time (G)
</DT
10529 >The time in microseconds that smbd should
10530 pause before attempting to gain a failed lock. See
10532 HREF=
"#LOCKSPINCOUNT"
10540 > for more details.
10545 >lock spin time =
10</B
10556 >This controls whether or not locking will be
10557 performed by the server in response to lock requests from the
10563 >, all lock and unlock
10564 requests will appear to succeed and all lock queries will report
10565 that the file in question is available for locking.
</P
10570 >, real locking will be performed
10575 > be useful for read-only
10576 filesystems which
<EM
10578 > not need locking (such as
10579 CDROM drives), although setting this parameter of
<TT
10583 is not really recommended even in this case.
</P
10585 >Be careful about disabling locking either globally or in a
10586 specific service, as lack of locking may result in data corruption.
10587 You should never need to set this parameter.
</P
10601 >This option allows you to override the name
10602 of the Samba log file (also known as the debug file).
</P
10604 >This option takes the standard substitutions, allowing
10605 you to have separate log files for each user or machine.
</P
10609 >log file = /usr/local/samba/var/log.%m
10620 >The value of the parameter (an integer) allows
10621 the debug level (logging level) to be specified in the
10625 > file. This is to give greater
10626 flexibility in the configuration of the system.
</P
10628 >The default will be the log level specified on
10629 the command line or level zero if none was specified.
</P
10640 >logon drive (G)
</DT
10643 >This parameter specifies the local path to
10644 which the home directory will be connected (see
<A
10653 and is only used by NT Workstations.
</P
10655 >Note that this option is only useful if Samba is set up as a
10660 >logon drive = z:
</B
10665 >logon drive = h:
</B
10672 >logon home (G)
</DT
10675 >This parameter specifies the home directory
10676 location when a Win95/
98 or NT Workstation logs into a Samba PDC.
10677 It allows you to do
</P
10685 >NET USE H: /HOME
</B
10690 >from a command prompt, for example.
</P
10692 >This option takes the standard substitutions, allowing
10693 you to have separate logon scripts for each user or machine.
</P
10695 >This parameter can be used with Win9X workstations to ensure
10696 that roaming profiles are stored in a subdirectory of the user's
10697 home directory. This is done in the following way:
</P
10701 >logon home = \\%N\%U\profile
</B
10704 >This tells Samba to return the above string, with
10705 substitutions made when a client requests the info, generally
10706 in a NetUserGetInfo request. Win9X clients truncate the info to
10707 \\server\share when a user does
<B
10711 but use the whole string when dealing with profiles.
</P
10713 >Note that in prior versions of Samba, the
<A
10721 > was returned rather than
10731 > but allowed profiles outside the home directory.
10732 The current implementation is correct, and can be used for
10733 profiles if you use the above trick.
</P
10735 >This option is only useful if Samba is set up as a logon
10740 >logon home =
"\\%N\%U"</B
10745 >logon home =
"\\remote_smb_server\%U"</B
10753 >logon path (G)
</DT
10756 >This parameter specifies the home directory
10757 where roaming profiles (NTuser.dat etc files for Windows NT) are
10758 stored. Contrary to previous versions of these manual pages, it has
10759 nothing to do with Win
9X roaming profiles. To find out how to
10760 handle roaming profiles for Win
9X system, see the
<A
10770 >This option takes the standard substitutions, allowing you
10771 to have separate logon scripts for each user or machine. It also
10772 specifies the directory from which the
"Application Data",
10782 >network neighborhood
</TT
10787 and other folders, and their contents, are loaded and displayed on
10788 your Windows NT client.
</P
10790 >The share and the path must be readable by the user for
10791 the preferences and directories to be loaded onto the Windows NT
10792 client. The share must be writeable when the user logs in for the first
10793 time, in order that the Windows NT client can create the NTuser.dat
10794 and other directories.
</P
10796 >Thereafter, the directories and any of the contents can,
10797 if required, be made read-only. It is not advisable that the
10798 NTuser.dat file be made read-only - rename it to NTuser.man to
10799 achieve the desired effect (a
<EM
10804 >Windows clients can sometimes maintain a connection to
10805 the [homes] share, even though there is no user logged in.
10806 Therefore, it is vital that the logon path does not include a
10807 reference to the homes share (i.e. setting this parameter to
10808 \%N\%U\profile_path will cause problems).
</P
10810 >This option takes the standard substitutions, allowing
10811 you to have separate logon scripts for each user or machine.
</P
10813 >Note that this option is only useful if Samba is set up
10814 as a logon server.
</P
10818 >logon path = \\%N\%U\profile
</B
10823 >logon path = \\PROFILESERVER\PROFILE\%U
</B
10830 >logon script (G)
</DT
10833 >This parameter specifies the batch file (.bat) or
10834 NT command file (.cmd) to be downloaded and run on a machine when
10835 a user successfully logs in. The file must contain the DOS
10836 style CR/LF line endings. Using a DOS-style editor to create the
10837 file is recommended.
</P
10839 >The script must be a relative path to the [netlogon]
10840 service. If the [netlogon] service specifies a
<A
10850 >/usr/local/samba/netlogon
10854 >logon script = STARTUP.BAT
</B
10856 the file that will be downloaded is:
</P
10860 >/usr/local/samba/netlogon/STARTUP.BAT
</TT
10863 >The contents of the batch file are entirely your choice. A
10864 suggested command would be to add
<B
10866 >NET TIME \\SERVER /SET
10868 >, to force every machine to synchronize clocks with
10869 the same time server. Another use would be to add
<B
10872 U: \\SERVER\UTILS
</B
10873 > for commonly used utilities, or
<B
10875 > NET USE Q: \\SERVER\ISO9001_QA
</B
10878 >Note that it is particularly important not to allow write
10879 access to the [netlogon] share, or to grant users write permission
10880 on the batch files in a secure environment, as this would allow
10881 the batch files to be arbitrarily modified and security to be
10884 >This option takes the standard substitutions, allowing you
10885 to have separate logon scripts for each user or machine.
</P
10887 >This option is only useful if Samba is set up as a logon
10891 >no logon script defined
</EM
10896 >logon script = scripts\%U.bat
</B
10901 NAME=
"LPPAUSECOMMAND"
10903 >lppause command (S)
</DT
10906 >This parameter specifies the command to be
10907 executed on the server host in order to stop printing or spooling
10908 a specific print job.
</P
10910 >This command should be a program or script which takes
10911 a printer name and job number to pause the print job. One way
10912 of implementing this is by using job priorities, where jobs
10913 having a too low priority won't be sent to the printer.
</P
10920 > is given then the printer name
10921 is put in its place. A
<TT
10927 the job number (an integer). On HPUX (see
<TT
10939 to the lpq command, the job will show up with the correct status, i.e.
10940 if the job priority is lower than the set fence priority it will
10941 have the PAUSED status, whereas if the priority is equal or higher it
10942 will have the SPOOLED or PRINTING status.
</P
10944 >Note that it is good practice to include the absolute path
10945 in the lppause command as the PATH may not be available to the server.
</P
10958 >Default: Currently no default value is given to
10959 this string, unless the value of the
<TT
10968 >, in which case the default is :
</P
10972 >lp -i %p-%j -H hold
</B
10975 >or if the value of the
<TT
10984 >, then the default is:
</P
10988 >qstat -s -j%j -h
</B
10991 >Example for HPUX:
<B
10993 >lppause command = /usr/bin/lpalt
10999 NAME=
"LPQCACHETIME"
11001 >lpq cache time (G)
</DT
11004 >This controls how long lpq info will be cached
11005 for to prevent the
<B
11008 > command being called too
11009 often. A separate cache is kept for each variation of the
<B
11012 > command used by the system, so if you use different
11016 > commands for different users then they won't
11017 share cache information.
</P
11019 >The cache files are stored in
<TT
11023 where xxxx is a hash of the
<B
11026 > command in use.
</P
11028 >The default is
10 seconds, meaning that the cached results
11029 of a previous identical
<B
11032 > command will be used
11033 if the cached data is less than
10 seconds old. A large value may
11034 be advisable if your
<B
11037 > command is very slow.
</P
11039 >A value of
0 will disable caching completely.
</P
11054 >lpq cache time =
10</B
11059 >lpq cache time =
30</B
11066 >lpq command (S)
</DT
11069 >This parameter specifies the command to be
11070 executed on the server host in order to obtain
<B
11074 >-style printer status information.
</P
11076 >This command should be a program or script which
11077 takes a printer name as its only parameter and outputs printer
11078 status information.
</P
11080 >Currently nine styles of printer status information
11081 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ.
11082 This covers most UNIX systems. You control which type is expected
11090 >Some clients (notably Windows for Workgroups) may not
11091 correctly send the connection number for the printer they are
11092 requesting status information about. To get around this, the
11093 server reports on the first printer service connected to by the
11094 client. This only happens if the connection number sent is invalid.
</P
11101 > is given then the printer name
11102 is put in its place. Otherwise it is placed at the end of the
11105 >Note that it is good practice to include the absolute path
11115 > may not be available to the server. When compiled with
11116 the CUPS libraries, no
<TT
11122 needed because smbd will make a library call to obtain the
11123 print queue listing.
</P
11137 >depends on the setting of
<TT
11147 >lpq command = /usr/bin/lpq -P%p
</B
11152 NAME=
"LPRESUMECOMMAND"
11154 >lpresume command (S)
</DT
11157 >This parameter specifies the command to be
11158 executed on the server host in order to restart or continue
11159 printing or spooling a specific print job.
</P
11161 >This command should be a program or script which takes
11162 a printer name and job number to resume the print job. See
11164 HREF=
"#LPPAUSECOMMAND"
11179 > is given then the printer name
11180 is put in its place. A
<TT
11186 the job number (an integer).
</P
11188 >Note that it is good practice to include the absolute path
11192 >lpresume command
</I
11194 > as the PATH may not
11195 be available to the server.
</P
11208 >Default: Currently no default value is given
11209 to this string, unless the value of the
<TT
11218 >, in which case the default is :
</P
11222 >lp -i %p-%j -H resume
</B
11225 >or if the value of the
<TT
11234 >, then the default is:
</P
11238 >qstat -s -j%j -r
</B
11241 >Example for HPUX:
<B
11243 >lpresume command = /usr/bin/lpalt
11251 >lprm command (S)
</DT
11254 >This parameter specifies the command to be
11255 executed on the server host in order to delete a print job.
</P
11257 >This command should be a program or script which takes
11258 a printer name and job number, and deletes the print job.
</P
11265 > is given then the printer name
11266 is put in its place. A
<TT
11272 the job number (an integer).
</P
11274 >Note that it is good practice to include the absolute
11280 > as the PATH may not be
11281 available to the server.
</P
11295 >depends on the setting of
<TT
11306 >lprm command = /usr/bin/lprm -P%p %j
11312 >lprm command = /usr/bin/cancel %p-%j
11318 NAME=
"MACHINEPASSWORDTIMEOUT"
11320 >machine password timeout (G)
</DT
11323 >If a Samba server is a member of a Windows
11324 NT Domain (see the
<A
11325 HREF=
"#SECURITYEQUALSDOMAIN"
11326 >security = domain
</A
11328 parameter) then periodically a running
<A
11332 > process will try and change the MACHINE ACCOUNT
11333 PASSWORD stored in the TDB called
<TT
11335 >private/secrets.tdb
11337 >. This parameter specifies how often this password
11338 will be changed, in seconds. The default is one week (expressed in
11339 seconds), the same as a Windows NT Domain member server.
</P
11342 HREF=
"smbpasswd.8.html"
11350 HREF=
"#SECURITYEQUALSDOMAIN"
11351 > security = domain
</A
11356 >machine password timeout =
604800</B
11363 >magic output (S)
</DT
11366 >This parameter specifies the name of a file
11367 which will contain output created by a magic script (see the
11369 HREF=
"#MAGICSCRIPT"
11377 parameter below).
</P
11379 >Warning: If two clients use the same
<TT
11385 > in the same directory the output file content
11390 >magic output =
<magic script name
>.out
11396 >magic output = myfile.txt
</B
11403 >magic script (S)
</DT
11406 >This parameter specifies the name of a file which,
11407 if opened, will be executed by the server when the file is closed.
11408 This allows a UNIX script to be sent to the Samba host and
11409 executed on behalf of the connected user.
</P
11411 >Scripts executed in this way will be deleted upon
11412 completion assuming that the user has the appropriate level
11413 of privilege and the file permissions allow the deletion.
</P
11415 >If the script generates output, output will be sent to
11416 the file specified by the
<A
11417 HREF=
"#MAGICOUTPUT"
11424 > parameter (see above).
</P
11426 >Note that some shells are unable to interpret scripts
11427 containing CR/LF instead of CR as
11428 the end-of-line marker. Magic scripts must be executable
11431 > on the host, which for some hosts and
11432 some shells will require filtering at the DOS end.
</P
11434 >Magic scripts are
<EM
11439 > be relied upon.
</P
11442 >None. Magic scripts disabled.
</EM
11447 >magic script = user.csh
</B
11454 >mangle case (S)
</DT
11457 >See the section on
<A
11464 >mangle case = no
</B
11471 >mangled map (S)
</DT
11474 >This is for those who want to directly map UNIX
11475 file names which cannot be represented on Windows/DOS. The mangling
11476 of names is not always what is needed. In particular you may have
11477 documents with file extensions that differ between DOS and UNIX.
11478 For example, under UNIX it is common to use
<TT
11482 for HTML files, whereas under Windows/DOS
<TT
11486 is more commonly used.
</P
11499 >mangled map = (*.html *.htm)
</B
11502 >One very useful case is to remove the annoying
<TT
11506 > off the ends of filenames on some CDROMs (only visible
11507 under some UNIXes). To do this use a map of (*;
1 *;).
</P
11510 >no mangled map
</EM
11515 >mangled map = (*;
1 *;)
</B
11520 NAME=
"MANGLEDNAMES"
11522 >mangled names (S)
</DT
11525 >This controls whether non-DOS names under UNIX
11526 should be mapped to DOS-compatible names (
"mangled") and made visible,
11527 or whether non-DOS names should simply be ignored.
</P
11529 >See the section on
<A
11532 > for details on how to control the mangling process.
</P
11534 >If mangling algorithm
"hash" is used then the mangling algorithm is as follows:
</P
11540 >The first (up to) five alphanumeric characters
11541 before the rightmost dot of the filename are preserved, forced
11542 to upper case, and appear as the first (up to) five characters
11543 of the mangled name.
</P
11547 >A tilde
"~" is appended to the first part of the mangled
11548 name, followed by a two-character unique sequence, based on the
11549 original root name (i.e., the original filename minus its final
11550 extension). The final extension is included in the hash calculation
11551 only if it contains any upper case characters or is longer than three
11554 >Note that the character to use may be specified using
11556 HREF=
"#MANGLINGCHAR"
11564 > option, if you don't like '~'.
</P
11568 >The first three alphanumeric characters of the final
11569 extension are preserved, forced to upper case and appear as the
11570 extension of the mangled name. The final extension is defined as that
11571 part of the original filename after the rightmost dot. If there are no
11572 dots in the filename, the mangled name will have no extension (except
11573 in the case of
"hidden files" - see below).
</P
11577 >Files whose UNIX name begins with a dot will be
11578 presented as DOS hidden files. The mangled name will be created as
11579 for other filenames, but with the leading dot removed and
"___" as
11580 its extension regardless of actual original extension (that's three
11585 >The two-digit hash value consists of upper case
11586 alphanumeric characters.
</P
11588 >This algorithm can cause name collisions only if files
11589 in a directory share the same first five alphanumeric characters.
11590 The probability of such a clash is
1/
1300.
</P
11592 >If mangling algorithm
"hash2" is used then the mangling algorithm is as follows:
</P
11598 >The first alphanumeric character
11599 before the rightmost dot of the filename is preserved, forced
11600 to upper case, and appears as the first character of the mangled name.
11605 >A base63 hash of
5 characters is generated and the
11606 first
4 characters of that hash are appended to the first character.
11611 >A tilde
"~" is appended to the first part of the mangled
11612 name, followed by the final character of the base36 hash of the name.
11615 >Note that the character to use may be specified using
11617 HREF=
"#MANGLINGCHAR"
11625 > option, if you don't like '~'.
</P
11629 >The first three alphanumeric characters of the final
11630 extension are preserved, forced to upper case and appear as the
11631 extension of the mangled name. The final extension is defined as that
11632 part of the original filename after the rightmost dot. If there are no
11633 dots in the filename, the mangled name will have no extension (except
11634 in the case of
"hidden files" - see below).
</P
11638 >Files whose UNIX name begins with a dot will be
11639 presented as DOS hidden files. The mangled name will be created as
11640 for other filenames, but with the leading dot removed and
"___" as
11641 its extension regardless of actual original extension (that's three
11646 >The name mangling (if enabled) allows a file to be
11647 copied between UNIX directories from Windows/DOS while retaining
11648 the long UNIX filename. UNIX files can be renamed to a new extension
11649 from Windows/DOS and will retain the same basename. Mangled names
11650 do not change between sessions.
</P
11654 >mangled names = yes
</B
11659 NAME=
"MANGLEDSTACK"
11661 >mangled stack (G)
</DT
11664 >This parameter controls the number of mangled names
11665 that should be cached in the Samba server
<A
11671 >This stack is a list of recently mangled base names
11672 (extensions are only maintained if they are longer than
3 characters
11673 or contains upper case characters).
</P
11675 >The larger this value, the more likely it is that mangled
11676 names can be successfully converted to correct long UNIX names.
11677 However, large stack sizes will slow most directory accesses. Smaller
11678 stacks save memory in the server (each stack element costs
256 bytes).
11681 >It is not possible to absolutely guarantee correct long
11682 filenames, so be prepared for some surprises!
</P
11686 >mangled stack =
50</B
11691 >mangled stack =
100</B
11696 NAME=
"MANGLINGCHAR"
11698 >mangling char (S)
</DT
11701 >This controls what character is used as
11707 >. The default is a '~'
11708 but this may interfere with some software. Use this option to set
11709 it to whatever you prefer.
</P
11713 >mangling char = ~
</B
11718 >mangling char = ^
</B
11723 NAME=
"MANGLINGMETHOD"
11725 >mangling mathod(G)
</DT
11728 > controls the algorithm used for the generating
11729 the mangled names. Can take two different values,
"hash" and
11730 "hash2".
"hash" is the default and is the algorithm that has been
11731 used in Samba for many years.
"hash2" is a newer and considered
11732 a better algorithm (generates less collisions) in the names.
11733 However, many Win32 applications store the mangled names and so
11734 changing to the new algorithm must not be done
11735 lightly as these applications may break unless reinstalled.
11736 New installations of Samba may set the default to hash2.
</P
11740 >mangling method = hash
</B
11745 >mangling method = hash2
</B
11752 >map archive (S)
</DT
11755 >This controls whether the DOS archive attribute
11756 should be mapped to the UNIX owner execute bit. The DOS archive bit
11757 is set when a file has been modified since its last backup. One
11758 motivation for this option it to keep Samba/your PC from making
11759 any file it touches from becoming executable under UNIX. This can
11760 be quite annoying for shared source code, documents, etc...
</P
11762 >Note that this requires the
<TT
11768 parameter to be set such that owner execute bit is not masked out
11769 (i.e. it must include
100). See the parameter
<A
11781 >map archive = yes
</B
11788 >map hidden (S)
</DT
11791 >This controls whether DOS style hidden files
11792 should be mapped to the UNIX world execute bit.
</P
11794 >Note that this requires the
<TT
11800 to be set such that the world execute bit is not masked out (i.e.
11801 it must include
001). See the parameter
<A
11813 >map hidden = no
</B
11820 >map system (S)
</DT
11823 >This controls whether DOS style system files
11824 should be mapped to the UNIX group execute bit.
</P
11826 >Note that this requires the
<TT
11832 to be set such that the group execute bit is not masked out (i.e.
11833 it must include
010). See the parameter
<A
11845 >map system = no
</B
11852 >map to guest (G)
</DT
11855 >This parameter is only useful in
<A
11858 > modes other than
<TT
11861 >security = share
</I
11876 >This parameter can take three different values, which tell
11881 > what to do with user
11882 login requests that don't match a valid UNIX user in some way.
</P
11884 >The three settings are :
</P
11893 > - Means user login
11894 requests with an invalid password are rejected. This is the
11903 logins with an invalid password are rejected, unless the username
11904 does not exist, in which case it is treated as a guest login and
11906 HREF=
"#GUESTACCOUNT"
11920 > - Means user logins
11921 with an invalid password are treated as a guest login and mapped
11923 HREF=
"#GUESTACCOUNT"
11926 this can cause problems as it means that any user incorrectly typing
11927 their password will be silently logged on as
"guest" - and
11928 will not know the reason they cannot access files they think
11929 they should - there will have been no message given to them
11930 that they got their password wrong. Helpdesk services will
11933 > you if you set the
<TT
11939 > parameter this way :-).
</P
11943 >Note that this parameter is needed to set up
"Guest"
11944 share services when using
<TT
11950 share. This is because in these modes the name of the resource being
11953 > sent to the server until after
11954 the server has successfully authenticated the client so the server
11955 cannot make authentication decisions at the correct time (connection
11956 to the share) for
"Guest" shares.
</P
11958 >For people familiar with the older Samba releases, this
11959 parameter maps to the old compile-time setting of the
<TT
11961 > GUEST_SESSSETUP
</TT
11962 > value in local.h.
</P
11966 >map to guest = Never
</B
11971 >map to guest = Bad User
</B
11976 NAME=
"MAXCONNECTIONS"
11978 >max connections (S)
</DT
11981 >This option allows the number of simultaneous
11982 connections to a service to be limited. If
<TT
11988 > is greater than
0 then connections will be refused if
11989 this number of connections to the service are already open. A value
11990 of zero mean an unlimited number of connections may be made.
</P
11992 >Record lock files are used to implement this feature. The
11993 lock files will be stored in the directory specified by the
<A
11994 HREF=
"#LOCKDIRECTORY"
12006 >max connections =
0</B
12011 >max connections =
10</B
12018 >max disk size (G)
</DT
12021 >This option allows you to put an upper limit
12022 on the apparent size of disks. If you set this option to
100
12023 then all shares will appear to be not larger than
100 MB in
12026 >Note that this option does not limit the amount of
12027 data you can put on the disk. In the above case you could still
12028 store much more than
100 MB on the disk, but if a client ever asks
12029 for the amount of free disk space or the total disk size then the
12030 result will be bounded by the amount specified in
<TT
12038 >This option is primarily useful to work around bugs
12039 in some pieces of software that can't handle very large disks,
12040 particularly disks over
1GB in size.
</P
12047 > of
0 means no limit.
</P
12051 >max disk size =
0</B
12056 >max disk size =
1000</B
12063 >max log size (G)
</DT
12066 >This option (an integer in kilobytes) specifies
12067 the max size the log file should grow to. Samba periodically checks
12068 the size and if it is exceeded it will rename the file, adding
12074 >A size of
0 means no limit.
</P
12078 >max log size =
5000</B
12083 >max log size =
1000</B
12093 >This option controls the maximum number of
12094 outstanding simultaneous SMB operations that Samba tells the client
12095 it will allow. You should never need to set this parameter.
</P
12104 NAME=
"MAXOPENFILES"
12106 >max open files (G)
</DT
12109 >This parameter limits the maximum number of
12110 open files that one
<A
12115 serving process may have open for a client at any one time. The
12116 default for this parameter is set very high (
10,
000) as Samba uses
12117 only one bit per unopened file.
</P
12119 >The limit of the number of open files is usually set
12120 by the UNIX per-process file descriptor limit rather than
12121 this parameter so you should never need to touch this parameter.
</P
12125 >max open files =
10000</B
12130 NAME=
"MAXPRINTJOBS"
12132 >max print jobs (S)
</DT
12135 >This parameter limits the maximum number of
12136 jobs allowable in a Samba printer queue at any given moment.
12137 If this number is exceeded,
<A
12144 > will remote
"Out of Space" to the client.
12146 HREF=
"#TOTALPRINTJOBS"
12159 >max print jobs =
1000</B
12164 >max print jobs =
5000</B
12171 >max protocol (G)
</DT
12174 >The value of the parameter (a string) is the highest
12175 protocol level that will be supported by the server.
</P
12177 >Possible values are :
</P
12186 >: Earliest version. No
12187 concept of user names.
</P
12194 >: Slight improvements on
12195 CORE for efficiency.
</P
12204 > version of the protocol. Long filename
12212 >: Updates to Lanman1 protocol.
12220 >: Current up to date version of
12221 the protocol. Used by Windows NT. Known as CIFS.
</P
12225 >Normally this option should not be set as the automatic
12226 negotiation phase in the SMB protocol takes care of choosing
12227 the appropriate protocol.
</P
12230 HREF=
"#MINPROTOCOL"
12242 >max protocol = NT1
</B
12247 >max protocol = LANMAN1
</B
12252 NAME=
"MAXSMBDPROCESSES"
12254 >max smbd processes (G)
</DT
12257 >This parameter limits the maximum number of
12266 processes concurrently running on a system and is intended
12267 as a stopgap to prevent degrading service to clients in the event
12268 that the server has insufficient resources to handle more than this
12269 number of connections. Remember that under normal operating
12270 conditions, each user will have an
<A
12274 > associated with him or her
12275 to handle connections to all shares from a given host.
12280 >max smbd processes =
0</B
12285 >max smbd processes =
1000</B
12295 >This option tells
<A
12300 what the default 'time to live' of NetBIOS names should be (in seconds)
12304 > is requesting a name using either a
12305 broadcast packet or from a WINS server. You should never need to
12306 change this parameter. The default is
3 days.
</P
12310 >max ttl =
259200</B
12317 >max wins ttl (G)
</DT
12320 >This option tells
<A
12325 > when acting as a WINS server (
<A
12326 HREF=
"#WINSSUPPORT"
12330 >wins support = yes
</I
12333 >) what the maximum
12334 'time to live' of NetBIOS names that
<B
12338 will grant will be (in seconds). You should never need to change this
12339 parameter. The default is
6 days (
518400 seconds).
</P
12354 >max wins ttl =
518400</B
12364 >This option controls the maximum packet size
12365 that will be negotiated by Samba. The default is
65535, which
12366 is the maximum. In some cases you may find you get better performance
12367 with a smaller value. A value below
2048 is likely to cause problems.
12372 >max xmit =
65535</B
12377 >max xmit =
8192</B
12382 NAME=
"MESSAGECOMMAND"
12384 >message command (G)
</DT
12387 >This specifies what command to run when the
12388 server receives a WinPopup style message.
</P
12390 >This would normally be a command that would
12391 deliver the message somehow. How this is to be done is
12392 up to your imagination.
</P
12398 >message command = csh -c 'xedit %s;rm %s'
&</B
12402 >This delivers the message using
<B
12406 removes it afterwards.
<EM
12407 >NOTE THAT IT IS VERY IMPORTANT
12408 THAT THIS COMMAND RETURN IMMEDIATELY
</EM
12410 have the '
&' on the end. If it doesn't return immediately then
12411 your PCs may freeze when sending messages (they should recover
12412 after
30 seconds, hopefully).
</P
12414 >All messages are delivered as the global guest user.
12415 The command takes the standard substitutions, although
<TT
12428 >Apart from the standard substitutions, some additional
12429 ones apply. In particular:
</P
12440 > = the filename containing
12450 > = the destination that
12451 the message was sent to (probably the server name).
</P
12460 > = who the message
12465 >You could make this command send mail, or whatever else
12466 takes your fancy. Please let us know of any really interesting
12469 >Here's a way of sending the messages as mail to root:
</P
12473 >message command = /bin/mail -s 'message from %f on
12474 %m' root
< %s; rm %s
</B
12477 >If you don't have a message command then the message
12478 won't be delivered and Samba will tell the sender there was
12479 an error. Unfortunately WfWg totally ignores the error code
12480 and carries on regardless, saying that the message was delivered.
12483 >If you want to silently delete it then try:
</P
12487 >message command = rm %s
</B
12491 >no message command
</EM
12496 >message command = csh -c 'xedit %s;
12502 NAME=
"MINPASSWDLENGTH"
12504 >min passwd length (G)
</DT
12508 HREF=
"#MINPASSWORDLENGTH"
12512 >min password length
</I
12519 NAME=
"MINPASSWORDLENGTH"
12521 >min password length (G)
</DT
12524 >This option sets the minimum length in characters
12525 of a plaintext password that
<B
12528 > will accept when performing
12529 UNIX password changing.
</P
12532 HREF=
"#UNIXPASSWORDSYNC"
12541 HREF=
"#PASSWDPROGRAM"
12549 HREF=
"#PASSWDCHATDEBUG"
12553 >passwd chat debug
</I
12561 >min password length =
5</B
12566 NAME=
"MINPRINTSPACE"
12568 >min print space (S)
</DT
12571 >This sets the minimum amount of free disk
12572 space that must be available before a user will be able to spool
12573 a print job. It is specified in kilobytes. The default is
0, which
12574 means a user can always spool a print job.
</P
12589 >min print space =
0</B
12594 >min print space =
2000</B
12601 >min protocol (G)
</DT
12604 >The value of the parameter (a string) is the
12605 lowest SMB protocol dialect than Samba will support. Please refer
12607 HREF=
"#MAXPROTOCOL"
12615 parameter for a list of valid protocol names and a brief description
12616 of each. You may also wish to refer to the C source code in
12619 >source/smbd/negprot.c
</TT
12620 > for a listing of known protocol
12621 dialects supported by clients.
</P
12623 >If you are viewing this parameter as a security measure, you should
12624 also refer to the
<A
12633 > parameter. Otherwise, you should never need
12634 to change this parameter.
</P
12638 >min protocol = CORE
</B
12643 >min protocol = NT1
</B
12651 >min wins ttl (G)
</DT
12654 >This option tells
<A
12659 when acting as a WINS server (
<A
12660 HREF=
"#WINSSUPPORT"
12664 > wins support = yes
</I
12667 >) what the minimum 'time to live'
12668 of NetBIOS names that
<B
12671 > will grant will be (in
12672 seconds). You should never need to change this parameter. The default
12673 is
6 hours (
21600 seconds).
</P
12677 >min wins ttl =
21600</B
12684 >msdfs root (S)
</DT
12687 >This boolean parameter is only available if
12688 Samba is configured and compiled with the
<B
12691 > option. If set to
<TT
12695 Samba treats the share as a Dfs root and allows clients to browse
12696 the distributed file system tree rooted at the share directory.
12697 Dfs links are specified in the share directory by symbolic
12698 links of the form
<TT
12700 >msdfs:serverA\shareA,serverB\shareB
12702 > and so on. For more information on setting up a Dfs tree
12703 on Samba, refer to
<A
12704 HREF=
"msdfs_setup.html"
12723 >msdfs root = no
</B
12728 NAME=
"NAMERESOLVEORDER"
12730 >name resolve order (G)
</DT
12733 >This option is used by the programs in the Samba
12734 suite to determine what naming services to use and in what order
12735 to resolve host names to IP addresses. The option takes a space
12736 separated string of name resolution options.
</P
12738 >The options are :
"lmhosts",
"host",
"wins" and
"bcast". They
12739 cause names to be resolved as follows :
</P
12749 address in the Samba lmhosts file. If the line in lmhosts has
12750 no name type attached to the NetBIOS name (see the
<A
12751 HREF=
"lmhosts.5.html"
12754 > for details) then
12755 any name type matches for lookup.
</P
12762 > : Do a standard host
12763 name to IP address resolution, using the system
<TT
12767 >, NIS, or DNS lookups. This method of name resolution
12768 is operating system depended for instance on IRIX or Solaris this
12769 may be controlled by the
<TT
12771 >/etc/nsswitch.conf
</TT
12773 file. Note that this method is only used if the NetBIOS name
12774 type being queried is the
0x20 (server) name type, otherwise
12782 > : Query a name with
12783 the IP address listed in the
<A
12791 > parameter. If no WINS server has
12792 been specified this method will be ignored.
</P
12799 > : Do a broadcast on
12800 each of the known local interfaces listed in the
<A
12809 parameter. This is the least reliable of the name resolution
12810 methods as it depends on the target host being on a locally
12811 connected subnet.
</P
12817 >name resolve order = lmhosts host wins bcast
12823 >name resolve order = lmhosts bcast host
12827 >This will cause the local lmhosts file to be examined
12828 first, followed by a broadcast attempt, followed by a normal
12829 system hostname lookup.
</P
12833 NAME=
"NETBIOSALIASES"
12835 >netbios aliases (G)
</DT
12838 >This is a list of NetBIOS names that
<A
12842 > will advertise as additional
12843 names by which the Samba server is known. This allows one machine
12844 to appear in browse lists under multiple names. If a machine is
12845 acting as a browse server or logon server none
12846 of these names will be advertised as either browse server or logon
12847 servers, only the primary name of the machine will be advertised
12848 with these capabilities.
</P
12851 HREF=
"#NETBIOSNAME"
12862 >empty string (no additional names)
</EM
12867 >netbios aliases = TEST TEST1 TEST2
</B
12874 >netbios name (G)
</DT
12877 >This sets the NetBIOS name by which a Samba
12878 server is known. By default it is the same as the first component
12879 of the host's DNS name. If a machine is a browse server or
12880 logon server this name (or the first component
12881 of the hosts DNS name) will be the name that these services are
12882 advertised under.
</P
12885 HREF=
"#NETBIOSALIASES"
12896 >machine DNS name
</EM
12901 >netbios name = MYNAME
</B
12906 NAME=
"NETBIOSSCOPE"
12908 >netbios scope (G)
</DT
12911 >This sets the NetBIOS scope that Samba will
12912 operate under. This should not be set unless every machine
12913 on your LAN also sets this value.
</P
12919 >nis homedir (G)
</DT
12922 >Get the home share server from a NIS map. For
12923 UNIX systems that use an automounter, the user's home directory
12924 will often be mounted on a workstation on demand from a remote
12927 >When the Samba logon server is not the actual home directory
12928 server, but is mounting the home directories via NFS then two
12929 network hops would be required to access the users home directory
12930 if the logon server told the client to use itself as the SMB server
12931 for home directories (one over SMB and one over NFS). This can
12934 >This option allows Samba to return the home share as
12935 being on a different server to the logon server and as
12936 long as a Samba daemon is running on the home directory server,
12937 it will be mounted on the Samba client directly from the directory
12938 server. When Samba is returning the home share to the client, it
12939 will consult the NIS map specified in
<A
12947 > and return the server
12950 >Note that for this option to work there must be a working
12951 NIS system and the Samba server with this option must also
12952 be a logon server.
</P
12956 >nis homedir = no
</B
12961 NAME=
"NTACLSUPPORT"
12963 >nt acl support (S)
</DT
12966 >This boolean parameter controls whether
12971 > will attempt to map
12972 UNIX permissions into Windows NT access control lists.
12973 This parameter was formally a global parameter in releases
12978 >nt acl support = yes
</B
12983 NAME=
"NTPIPESUPPORT"
12985 >nt pipe support (G)
</DT
12988 >This boolean parameter controls whether
12993 > will allow Windows NT
12994 clients to connect to the NT SMB specific
<TT
12998 pipes. This is a developer debugging option and can be left
13003 >nt pipe support = yes
</B
13008 NAME=
"NTSMBSUPPORT"
13010 >nt smb support (G)
</DT
13013 >This boolean parameter controls whether
<A
13017 > will negotiate NT specific SMB
13018 support with Windows NT/
2k/XP clients. Although this is a developer
13019 debugging option and should be left alone, benchmarking has discovered
13020 that Windows NT clients give faster performance with this option
13024 >. This is still being investigated.
13025 If this option is set to
<TT
13028 > then Samba offers
13029 exactly the same SMB calls that versions prior to Samba
2.0 offered.
13030 This information may be of use if any users are having problems
13031 with NT SMB support.
</P
13033 >You should not need to ever disable this parameter.
</P
13037 >nt smb support = yes
</B
13042 NAME=
"NTSTATUSSUPPORT"
13044 >nt status support (G)
</DT
13047 >This boolean parameter controls whether
<A
13051 > will negotiate NT specific status
13052 support with Windows NT/
2k/XP clients. This is a developer
13053 debugging option and should be left alone.
13054 If this option is set to
<TT
13057 > then Samba offers
13058 exactly the same DOS error codes that versions prior to Samba
2.2.3
13061 >You should not need to ever disable this parameter.
</P
13065 >nt status support = yes
</B
13070 NAME=
"NULLPASSWORDS"
13072 >null passwords (G)
</DT
13075 >Allow or disallow client access to accounts
13076 that have null passwords.
</P
13079 HREF=
"smbpasswd.5.html"
13086 >null passwords = no
</B
13091 NAME=
"OBEYPAMRESTRICTIONS"
13093 >obey pam restrictions (G)
</DT
13096 >When Samba
2.2 is configured to enable PAM support
13097 (i.e. --with-pam), this parameter will control whether or not Samba
13098 should obey PAM's account and session management directives. The
13099 default behavior is to use PAM for clear text authentication only
13100 and to ignore any account or session management. Note that Samba
13101 always ignores PAM for authentication in the case of
<A
13102 HREF=
"#ENCRYPTPASSWORDS"
13106 >encrypt passwords = yes
</I
13110 >. The reason is that PAM modules cannot support the challenge/response
13111 authentication mechanism needed in the presence of SMB password encryption.
13116 >obey pam restrictions = no
</B
13126 >This is a boolean option that controls whether
13127 connections with usernames not in the
<TT
13133 list will be allowed. By default this option is disabled so that a
13134 client can supply a username to be used by the server. Enabling
13135 this parameter will force the server to only user the login
13141 > list and is only really
13143 HREF=
"#SECURITYEQUALSSHARE"
13148 >Note that this also means Samba won't try to deduce
13149 usernames from the service name. This can be annoying for
13150 the [homes] section. To get around this you could use
<B
13154 > which means your
<TT
13160 will be just the service name, which for home directories is the
13161 name of the user.
</P
13183 >only guest (S)
</DT
13198 NAME=
"OPLOCKBREAKWAITTIME"
13200 >oplock break wait time (G)
</DT
13203 >This is a tuning parameter added due to bugs in
13204 both Windows
9x and WinNT. If Samba responds to a client too
13205 quickly when that client issues an SMB that can cause an oplock
13206 break request, then the network client can fail and not respond
13207 to the break request. This tuning parameter (which is set in milliseconds)
13208 is the amount of time Samba will wait before sending an oplock break
13209 request to such (broken) clients.
</P
13212 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
13213 AND UNDERSTOOD THE SAMBA OPLOCK CODE
</EM
13218 >oplock break wait time =
0</B
13223 NAME=
"OPLOCKCONTENTIONLIMIT"
13225 >oplock contention limit (S)
</DT
13236 improve the efficiency of the granting of oplocks under multiple
13237 client contention for the same file.
</P
13239 >In brief it specifies a number, which causes
<A
13244 grant an oplock even when requested if the approximate number of
13245 clients contending for an oplock on the same file goes over this
13246 limit. This causes
<B
13249 > to behave in a similar
13250 way to Windows NT.
</P
13253 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
13254 AND UNDERSTOOD THE SAMBA OPLOCK CODE
</EM
13259 >oplock contention limit =
2</B
13269 >This boolean option tells
<B
13273 issue oplocks (opportunistic locks) to file open requests on this
13274 share. The oplock code can dramatically (approx.
30% or more) improve
13275 the speed of access to files on Samba servers. It allows the clients
13276 to aggressively cache files locally and you may want to disable this
13277 option for unreliable network environments (it is turned on by
13278 default in Windows NT Servers). For more information see the file
13288 >Oplocks may be selectively turned off on certain files with a
13290 HREF=
"#VETOOPLOCKFILES"
13294 > veto oplock files
</I
13297 > parameter. On some systems
13298 oplocks are recognized by the underlying operating system. This
13299 allows data synchronization between all access to oplocked files,
13300 whether it be via Samba or NFS or a local UNIX process. See the
13306 > parameter for details.
</P
13309 HREF=
"#KERNELOPLOCKS"
13318 HREF=
"#LEVEL2OPLOCKS"
13322 > level2 oplocks
</I
13339 >This integer value controls what level Samba
13340 advertises itself as for browse elections. The value of this
13341 parameter determines whether
<A
13346 has a chance of becoming a local master browser for the
<TT
13351 > in the local broadcast area.
</P
13355 >By default, Samba will win
13356 a local master browsing election over all Microsoft operating
13357 systems except a Windows NT
4.0/
2000 Domain Controller. This
13358 means that a misconfigured Samba host can effectively isolate
13359 a subnet for browsing purposes. See
<TT
13381 NAME=
"OS2DRIVERMAP"
13383 >os2 driver map (G)
</DT
13386 >The parameter is used to define the absolute
13387 path to a file containing a mapping of Windows NT printer driver
13388 names to OS/
2 printer driver names. The format is:
</P
13390 ><nt driver name
> =
<os2 driver
13391 name
>.
<device name
></P
13393 >For example, a valid entry using the HP LaserJet
5
13394 printer driver would appear as
<B
13396 >HP LaserJet
5L = LASERJET.HP
13400 >The need for the file is due to the printer driver namespace
13401 problem described in the
<A
13402 HREF=
"printer_driver2.html"
13406 >. For more details on OS/
2 clients, please
13408 HREF=
"OS2-Client-HOWTO.html"
13412 > containing in the Samba documentation.
</P
13416 >os2 driver map =
<empty string
>
13422 NAME=
"PAMPASSWORDCHANGE"
13424 >pam password change (G)
</DT
13427 >With the addition of better PAM support in Samba
2.2,
13428 this parameter, it is possible to use PAM's password change control
13429 flag for Samba. If enabled, then PAM will be used for password
13430 changes when requested by an SMB client instead of the program listed in
13432 HREF=
"#PASSWDPROGRAM"
13440 It should be possible to enable this without changing your
13450 parameter for most setups.
13455 >pam password change = no
</B
13462 >panic action (G)
</DT
13465 >This is a Samba developer option that allows a
13466 system command to be called when either
<A
13475 crashes. This is usually used to draw attention to the fact that
13476 a problem occurred.
</P
13480 >panic action =
<empty string
></B
13485 >panic action =
"/bin/sleep 90000"</B
13492 >passwd chat (G)
</DT
13495 >This string controls the
<EM
13498 conversation that takes places between
<A
13502 > and the local password changing
13503 program to change the user's password. The string describes a
13504 sequence of response-receive pairs that
<A
13508 > uses to determine what to send to the
13510 HREF=
"#PASSWDPROGRAM"
13518 > and what to expect back. If the expected output is not
13519 received then the password is not changed.
</P
13521 >This chat sequence is often quite site specific, depending
13522 on what local methods are used for password control (such as NIS
13525 >Note that this parameter only is only used if the
<A
13526 HREF=
"#UNIXPASSWORDSYNC"
13534 > parameter is set to
<TT
13538 sequence is then called
<EM
13540 > when the SMB password
13541 in the smbpasswd file is being changed, without access to the old
13542 password cleartext. This means that root must be able to reset the user's password
13543 without knowing the text of the previous password. In the presence of NIS/YP,
13544 this means that the
<A
13545 HREF=
"#PASSWDPROGRAM"
13548 executed on the NIS master.
13551 >The string can contain the macro
<TT
13556 > which is substituted
13557 for the new password. The chat sequence can also contain the standard
13570 > to give line-feed,
13571 carriage-return, tab and space. The chat sequence string can also contain
13572 a '*' which matches any sequence of characters.
13573 Double quotes can be used to collect strings with spaces
13574 in them into a single string.
</P
13576 >If the send string in any part of the chat sequence
13577 is a full stop
".", then no string is sent. Similarly,
13578 if the expect string is a full stop then no string is expected.
</P
13581 HREF=
"#PAMPASSWORDCHANGE"
13589 > parameter is set to
<TT
13593 may be matched in any order, and success is determined by the PAM result,
13594 not any particular output. The \n macro is ignored for PAM conversions.
13598 HREF=
"#UNIXPASSWORDSYNC"
13607 HREF=
"#PASSWDPROGRAM"
13611 > passwd program
</I
13615 HREF=
"#PASSWDCHATDEBUG"
13619 >passwd chat debug
</I
13623 HREF=
"#PAMPASSWORDCHANGE"
13627 >pam password change
</I
13634 >passwd chat = *new*password* %n\n
13635 *new*password* %n\n *changed*
</B
13640 >passwd chat =
"*Enter OLD password*" %o\n
13641 "*Enter NEW password*" %n\n
"*Reenter NEW password*" %n\n
"*Password
13647 NAME=
"PASSWDCHATDEBUG"
13649 >passwd chat debug (G)
</DT
13652 >This boolean specifies if the passwd chat script
13653 parameter is run in
<EM
13655 > mode. In this mode the
13656 strings passed to and received from the passwd chat are printed
13671 of
100. This is a dangerous option as it will allow plaintext passwords
13672 to be seen in the
<B
13675 > log. It is available to help
13676 Samba admins debug their
<TT
13682 when calling the
<TT
13688 be turned off after this has been done. This option has no effect if the
13690 HREF=
"#PAMPASSWORDCHANGE"
13694 >pam password change
</I
13698 paramter is set. This parameter is off by default.
</P
13710 HREF=
"#PAMPASSWORDCHANGE"
13714 >pam password change
</I
13719 HREF=
"#PASSWDPROGRAM"
13731 >passwd chat debug = no
</B
13736 NAME=
"PASSWDPROGRAM"
13738 >passwd program (G)
</DT
13741 >The name of a program that can be used to set
13742 UNIX user passwords. Any occurrences of
<TT
13748 will be replaced with the user name. The user name is checked for
13749 existence before calling the password changing program.
</P
13751 >Also note that many passwd programs insist in
<EM
13754 > passwords, such as a minimum length, or the inclusion
13755 of mixed case chars and digits. This can pose a problem as some clients
13756 (such as Windows for Workgroups) uppercase the password before sending
13767 > parameter is set to
<TT
13771 > then this program is called
<EM
13774 before the SMB password in the
<A
13775 HREF=
"smbpasswd.5.html"
13779 > file is changed. If this UNIX password change fails, then
13783 > will fail to change the SMB password also
13784 (this is by design).
</P
13789 >unix password sync
</I
13792 is set this parameter
<EM
13793 >MUST USE ABSOLUTE PATHS
</EM
13797 > programs called, and must be examined
13798 for security implications. Note that by default
<TT
13810 HREF=
"#UNIXPASSWORDSYNC"
13822 >passwd program = /bin/passwd
</B
13827 >passwd program = /sbin/npasswd %u
</B
13833 NAME=
"PASSWORDLEVEL"
13835 >password level (G)
</DT
13838 >Some client/server combinations have difficulty
13839 with mixed-case passwords. One offending client is Windows for
13840 Workgroups, which for some reason forces passwords to upper
13841 case when using the LANMAN1 protocol, but leaves them alone when
13842 using COREPLUS! Another problem child is the Windows
95/
98
13843 family of operating systems. These clients upper case clear
13844 text passwords even when NT LM
0.12 selected by the protocol
13845 negotiation request/response.
</P
13847 >This parameter defines the maximum number of characters
13848 that may be upper case in passwords.
</P
13850 >For example, say the password given was
"FRED". If
<TT
13853 > password level
</I
13855 > is set to
1, the following combinations
13856 would be tried if
"FRED" failed:
</P
13858 >"Fred",
"fred",
"fRed",
"frEd",
"freD"</P
13866 the following combinations would also be tried:
</P
13868 >"FRed",
"FrEd",
"FreD",
"fREd",
"fReD",
"frED", ..
</P
13872 >The higher value this parameter is set to the more likely
13873 it is that a mixed case password will be matched against a single
13874 case password. However, you should be aware that use of this
13875 parameter reduces security and increases the time taken to
13876 process a new connection.
</P
13878 >A value of zero will cause only two attempts to be
13879 made - the password as is and the password in all-lower case.
</P
13883 >password level =
0</B
13888 >password level =
4</B
13893 NAME=
"PASSWORDSERVER"
13895 >password server (G)
</DT
13898 >By specifying the name of another SMB server (such
13899 as a WinNT box) with this option, and using
<B
13905 >security = server
</B
13906 > you can get Samba
13907 to do all its username/password validation via a remote server.
</P
13909 >This option sets the name of the password server to use.
13910 It must be a NetBIOS name, so if the machine's NetBIOS name is
13911 different from its Internet name then you may have to add its NetBIOS
13912 name to the lmhosts file which is stored in the same directory
13918 >The name of the password server is looked up using the
13920 HREF=
"#NAMERESOLVEORDER"
13928 > and so may resolved
13929 by any method and order described in that parameter.
</P
13931 >The password server much be a machine capable of using
13932 the
"LM1.2X002" or the
"NT LM 0.12" protocol, and it must be in
13933 user level security mode.
</P
13937 > Using a password server
13938 means your UNIX box (running Samba) is only as secure as your
13939 password server.
<EM
13940 >DO NOT CHOOSE A PASSWORD SERVER THAT
13941 YOU DON'T COMPLETELY TRUST
</EM
13944 >Never point a Samba server at itself for password
13945 serving. This will cause a loop and could lock up your Samba
13948 >The name of the password server takes the standard
13949 substitutions, but probably the only useful one is
<TT
13955 >, which means the Samba server will use the incoming
13956 client as the password server. If you use this then you better
13957 trust your clients, and you had better restrict them with hosts allow!
</P
13964 > parameter is set to
13968 >, then the list of machines in this
13969 option must be a list of Primary or Backup Domain controllers for the
13970 Domain or the character '*', as the Samba server is effectively
13971 in that domain, and will use cryptographically authenticated RPC calls
13972 to authenticate the user logging on. The advantage of using
<B
13974 > security = domain
</B
13975 > is that if you list several hosts in the
13979 >password server
</I
13985 > will try each in turn till it finds one that responds. This
13986 is useful in case your primary server goes down.
</P
13991 >password server
</I
13994 to the character '*', then Samba will attempt to auto-locate the
13995 Primary or Backup Domain controllers to authenticate against by
13996 doing a query for the name
<TT
13998 >WORKGROUP
<1C
></TT
14000 and then contacting each server returned in the list of IP
14001 addresses from the name resolution source.
</P
14012 >, then there are different
14013 restrictions that
<B
14015 >security = domain
</B
14023 >You may list several password servers in
14027 >password server
</I
14029 > parameter, however if an
14033 > makes a connection to a password server,
14034 and then the password server fails, no more users will be able
14035 to be authenticated from this
<B
14039 restriction of the SMB/CIFS protocol when in
<B
14043 > mode and cannot be fixed in Samba.
</P
14047 >If you are using a Windows NT server as your
14048 password server then you will have to ensure that your users
14049 are able to login from the Samba server, as when in
<B
14051 > security = server
</B
14052 > mode the network logon will appear to
14053 come from there rather than from the users workstation.
</P
14070 >password server =
<empty string
></B
14076 >password server = NT-PDC, NT-BDC1, NT-BDC2
14082 >password server = *
</B
14092 >This parameter specifies a directory to which
14093 the user of the service is to be given access. In the case of
14094 printable services, this is where print data will spool prior to
14095 being submitted to the host for printing.
</P
14097 >For a printable service offering guest access, the service
14098 should be readonly and the path should be world-writeable and
14099 have the sticky bit set. This is not mandatory of course, but
14100 you probably won't get the results you expect if you do
14103 >Any occurrences of
<TT
14109 will be replaced with the UNIX username that the client is using
14110 on this connection. Any occurrences of
<TT
14116 will be replaced by the NetBIOS name of the machine they are
14117 connecting from. These replacements are very useful for setting
14118 up pseudo home directories for users.
</P
14120 >Note that this path will be based on
<A
14128 > if one was specified.
</P
14136 >path = /home/fred
</B
14141 NAME=
"PIDDIRECTORY"
14143 >pid directory (G)
</DT
14146 >This option specifies the directory where pid
14147 files will be placed.
</P
14151 >pid directory = ${prefix}/var/locks
</B
14156 >pid directory = /var/run/
</B
14162 NAME=
"POSIXLOCKING"
14164 >posix locking (S)
</DT
14175 daemon maintains an database of file locks obtained by SMB clients.
14176 The default behavior is to map this internal database to POSIX
14177 locks. This means that file locks obtained by SMB clients are
14178 consistent with those seen by POSIX compliant applications accessing
14179 the files via a non-SMB method (e.g. NFS or local file access).
14180 You should never need to disable this parameter.
</P
14184 >posix locking = yes
</B
14194 >This option specifies a command to be run
14195 whenever the service is disconnected. It takes the usual
14196 substitutions. The command may be run as the root on some
14199 >An interesting example may be to unmount server
14204 >postexec = /etc/umount /cdrom
</B
14219 >none (no command executed)
</EM
14225 >postexec = echo \
"%u disconnected from %S
14226 from %m (%I)\" >> /tmp/log
</B
14233 >postscript (S)
</DT
14236 >This parameter forces a printer to interpret
14237 the print files as PostScript. This is done by adding a
<TT
14241 > to the start of print output.
</P
14243 >This is most useful when you have lots of PCs that persist
14244 in putting a control-D at the start of print jobs, which then
14245 confuses your printer.
</P
14249 >postscript = no
</B
14259 >This option specifies a command to be run whenever
14260 the service is connected to. It takes the usual substitutions.
</P
14262 >An interesting example is to send the users a welcome
14263 message every time they log in. Maybe a message of the day? Here
14268 >preexec = csh -c 'echo \
"Welcome to %S!\" |
14269 /usr/local/samba/bin/smbclient -M %m -I %I'
& </B
14272 >Of course, this could get annoying after a while :-)
</P
14275 HREF=
"#PREEXECCLOSE"
14295 >none (no command executed)
</EM
14300 >preexec = echo \
"%u connected to %S from %m
14301 (%I)\" >> /tmp/log
</B
14306 NAME=
"PREEXECCLOSE"
14308 >preexec close (S)
</DT
14311 >This boolean option controls whether a non-zero
14312 return code from
<A
14321 > should close the service being connected to.
</P
14325 >preexec close = no
</B
14330 NAME=
"PREFERREDMASTER"
14332 >preferred master (G)
</DT
14335 >This boolean parameter controls if
<A
14339 > is a preferred master browser
14340 for its workgroup.
</P
14342 >If this is set to
<TT
14349 will force an election, and it will have a slight advantage in
14350 winning the election. It is recommended that this parameter is
14351 used in conjunction with
<B
14354 HREF=
"#DOMAINMASTER"
14365 > can guarantee becoming a domain master.
</P
14367 >Use this option with caution, because if there are several
14368 hosts (whether Samba servers, Windows
95 or NT) that are preferred
14369 master browsers on the same subnet, they will each periodically
14370 and continuously attempt to become the local master browser.
14371 This will result in unnecessary broadcast traffic and reduced browsing
14387 >preferred master = auto
</B
14392 NAME=
"PREFEREDMASTER"
14394 >prefered master (G)
</DT
14398 HREF=
"#PREFERREDMASTER"
14402 > preferred master
</I
14405 > for people who cannot spell :-).
</P
14414 >This is a list of services that you want to be
14415 automatically added to the browse lists. This is most useful
14416 for homes and printers services that would otherwise not be
14419 >Note that if you just want all printers in your
14420 printcap file loaded then the
<A
14421 HREF=
"#LOADPRINTERS"
14428 > option is easier.
</P
14431 >no preloaded services
</EM
14436 >preload = fred lp colorlp
</B
14441 NAME=
"PRESERVECASE"
14443 >preserve case (S)
</DT
14446 > This controls if new filenames are created
14447 with the case that the client passes, or if they are forced to
14449 HREF=
"#DEFAULTCASE"
14461 >preserve case = yes
</B
14464 >See the section on
<A
14468 > for a fuller discussion.
</P
14472 NAME=
"PRINTCOMMAND"
14474 >print command (S)
</DT
14477 >After a print job has finished spooling to
14478 a service, this command will be used via a
<B
14482 call to process the spool file. Typically the command specified will
14483 submit the spool file to the host's printing subsystem, but there
14484 is no requirement that this be the case. The server will not remove
14485 the spool file, so whatever command you specify should remove the
14486 spool file when it has been processed, otherwise you will need to
14487 manually remove old spool files.
</P
14489 >The print command is simply a text string. It will be used
14490 verbatim after macro substitutions have been made:
</P
14492 >s, %p - the path to the spool
14495 >%p - the appropriate printer
14499 name as transmitted by the client.
</P
14501 >%c - The number of printed pages
14502 of the spooled job (if known).
</P
14504 >%z - the size of the spooled
14505 print job (in bytes)
</P
14507 >The print command
<EM
14510 one occurrence of
<TT
14526 > is optional. At the time
14527 a job is submitted, if no printer name is supplied the
<TT
14533 > will be silently removed from the printer command.
</P
14535 >If specified in the [global] section, the print command given
14536 will be used for any printable service that does not have its own
14537 print command specified.
</P
14539 >If there is neither a specified print command for a
14540 printable service nor a global print command, spool files will
14541 be created but not processed and (most importantly) not removed.
</P
14543 >Note that printing may fail on some UNIXes from the
14547 > account. If this happens then create
14548 an alternative guest account that can print and set the
<A
14549 HREF=
"#GUESTACCOUNT"
14557 in the [global] section.
</P
14559 >You can form quite complex print commands by realizing
14560 that they are just passed to a shell. For example the following
14561 will log a print job, print the file, then remove it. Note that
14562 ';' is the usual separator for command in shell scripts.
</P
14566 >print command = echo Printing %s
>>
14567 /tmp/print.log; lpr -P %p %s; rm %s
</B
14570 >You may have to vary this command considerably depending
14571 on how you normally print files on your system. The default for
14572 the parameter varies depending on the setting of the
<A
14584 >printing = BSD, AIX, QNX, LPRNG
14590 >print command = lpr -r -P%p %s
</B
14595 >printing = SYSV or HPUX :
</B
14600 >print command = lp -c -d%p %s; rm %s
</B
14605 >printing = SOFTQ :
</B
14610 >print command = lp -d%p -s %s; rm %s
</B
14613 >For printing = CUPS : If SAMBA is compiled against
14616 >printcap = cups
</A
14618 uses the CUPS API to
14619 submit jobs, etc. Otherwise it maps to the System V
14620 commands with the -oraw option for printing, i.e. it
14623 >lp -c -d%p -oraw; rm %s
</B
14627 >printing = cups
</B
14629 and if SAMBA is compiled against libcups, any manually
14630 set print command will be ignored.
</P
14634 >print command = /usr/local/samba/bin/myprintscript
14662 >If this parameter is
<TT
14666 clients may open, write to and submit spool files on the directory
14667 specified for the service.
</P
14669 >Note that a printable service will ALWAYS allow writing
14670 to the service path (user privileges permitting) via the spooling
14671 of print data. The
<A
14680 > parameter controls only non-printing access to
14696 HREF=
"#PRINTCAPNAME"
14707 NAME=
"PRINTCAPNAME"
14709 >printcap name (G)
</DT
14712 >This parameter may be used to override the
14713 compiled-in default printcap name used by the server (usually
<TT
14715 > /etc/printcap
</TT
14716 >). See the discussion of the
<A
14719 > section above for reasons
14720 why you might want to do this.
</P
14722 >To use the CUPS printing interface set
<B
14724 >printcap name = cups
14726 >. This should be supplemented by an addtional setting
14729 >printing = cups
</A
14733 >printcap name = cups
</B
14735 "dummy" printcap created by CUPS, as specified in your CUPS
14736 configuration file.
14739 >On System V systems that use
<B
14743 list available printers you can use
<B
14745 >printcap name = lpstat
14747 > to automatically obtain lists of available printers. This
14748 is the default for systems that define SYSV at configure time in
14749 Samba (this includes most System V based systems). If
<TT
14758 these systems then Samba will launch
<B
14762 attempt to parse the output to obtain a printer list.
</P
14764 >A minimal printcap file would look something like this:
</P
14773 CLASS=
"PROGRAMLISTING"
14774 > print1|My Printer
1
14775 print2|My Printer
2
14776 print3|My Printer
3
14777 print4|My Printer
4
14778 print5|My Printer
5
14785 >where the '|' separates aliases of a printer. The fact
14786 that the second alias has a space in it gives a hint to Samba
14787 that it's a comment.
</P
14791 >: Under AIX the default printcap
14795 >. Samba will assume the
14799 > format if the string
14803 > appears in the printcap filename.
</P
14807 >printcap name = /etc/printcap
</B
14812 >printcap name = /etc/myprintcap
</B
14817 NAME=
"PRINTERADMIN"
14819 >printer admin (S)
</DT
14822 >This is a list of users that can do anything to
14823 printers via the remote administration interfaces offered by MS-RPC
14824 (usually using a NT workstation). Note that the root user always
14825 has admin rights.
</P
14829 >printer admin =
<empty string
></B
14835 >printer admin = admin, @staff
</B
14840 NAME=
"PRINTERDRIVER"
14842 >printer driver (S)
</DT
14847 >This is a deprecated
14848 parameter and will be removed in the next major release
14849 following version
2.2. Please see the instructions in
14851 HREF=
"printer_driver2.html"
14853 >Samba
2.2. Printing
14855 > for more information
14856 on the new method of loading printer drivers onto a Samba server.
14859 >This option allows you to control the string
14860 that clients receive when they ask the server for the printer driver
14861 associated with a printer. If you are using Windows95 or Windows NT
14862 then you can use this to automate the setup of printers on your
14865 >You need to set this parameter to the exact string (case
14866 sensitive) that describes the appropriate printer driver for your
14867 system. If you don't know the exact string to use then you should
14868 first try with no
<A
14869 HREF=
"#PRINTERDRIVER"
14873 > printer driver
</I
14876 > option set and the client will
14877 give you a list of printer drivers. The appropriate strings are
14878 shown in a scroll box after you have chosen the printer manufacturer.
</P
14881 HREF=
"#PRINTERDRIVERFILE"
14893 >printer driver = HP LaserJet
4L</B
14898 NAME=
"PRINTERDRIVERFILE"
14900 >printer driver file (G)
</DT
14905 >This is a deprecated
14906 parameter and will be removed in the next major release
14907 following version
2.2. Please see the instructions in
14909 HREF=
"printer_driver2.html"
14911 >Samba
2.2. Printing
14913 > for more information
14914 on the new method of loading printer drivers onto a Samba server.
14917 >This parameter tells Samba where the printer driver
14918 definition file, used when serving drivers to Windows
95 clients, is
14919 to be found. If this is not set, the default is :
</P
14924 CLASS=
"REPLACEABLE"
14926 >SAMBA_INSTALL_DIRECTORY
</I
14929 /lib/printers.def
</TT
14932 >This file is created from Windows
95 <TT
14936 > files found on the Windows
95 client system. For more
14937 details on setting up serving of printer drivers to Windows
95
14938 clients, see the outdated documentation file in the
<TT
14944 >PRINTER_DRIVER.txt
</TT
14948 HREF=
"#PRINTERDRIVERLOCATION"
14952 > printer driver location
</I
14958 >None (set in compile).
</EM
14963 >printer driver file =
14964 /usr/local/samba/printers/drivers.def
</B
14969 NAME=
"PRINTERDRIVERLOCATION"
14971 >printer driver location (S)
</DT
14976 >This is a deprecated
14977 parameter and will be removed in the next major release
14978 following version
2.2. Please see the instructions in
14980 HREF=
"printer_driver2.html"
14982 >Samba
2.2. Printing
14984 > for more information
14985 on the new method of loading printer drivers onto a Samba server.
14988 >This parameter tells clients of a particular printer
14989 share where to find the printer driver files for the automatic
14990 installation of drivers for Windows
95 machines. If Samba is set up
14991 to serve printer drivers to Windows
95 machines, this should be set to
</P
14995 >\\MACHINE\PRINTER$
</B
14998 >Where MACHINE is the NetBIOS name of your Samba server,
14999 and PRINTER$ is a share you set up for serving printer driver
15000 files. For more details on setting this up see the outdated documentation
15006 > PRINTER_DRIVER.txt
</TT
15010 HREF=
"#PRINTERDRIVERFILE"
15014 > printer driver file
</I
15026 >printer driver location = \\MACHINE\PRINTER$
15034 >printer name (S)
</DT
15037 >This parameter specifies the name of the printer
15038 to which print jobs spooled through a printable service will be sent.
</P
15040 >If specified in the [global] section, the printer
15041 name given will be used for any printable service that does
15042 not have its own printer name specified.
</P
15045 >none (but may be
<TT
15049 on many systems)
</EM
15054 >printer name = laserwriter
</B
15065 HREF=
"#PRINTERNAME"
15081 >This parameters controls how printer status
15082 information is interpreted on your system. It also affects the
15083 default values for the
<TT
15103 >lpresume command
</I
15111 > if specified in the
15112 [global] section.
</P
15114 >Currently nine printing styles are supported. They are
15148 >To see what the defaults are for the other print
15149 commands when using the various options use the
<A
15150 HREF=
"testparm.1.html"
15155 >This option can be set on a per printer basis
</P
15157 >See also the discussion in the
<A
15170 HREF=
"#MAXPROTOCOL"
15199 NAME=
"QUEUEPAUSECOMMAND"
15201 >queuepause command (S)
</DT
15204 >This parameter specifies the command to be
15205 executed on the server host in order to pause the printer queue.
</P
15207 >This command should be a program or script which takes
15208 a printer name as its only parameter and stops the printer queue,
15209 such that no longer jobs are submitted to the printer.
</P
15211 >This command is not supported by Windows for Workgroups,
15212 but can be issued from the Printers window under Windows
95
15220 > is given then the printer name
15221 is put in its place. Otherwise it is placed at the end of the command.
15224 >Note that it is good practice to include the absolute
15225 path in the command as the PATH may not be available to the
15229 >depends on the setting of
<TT
15240 >queuepause command = disable %p
</B
15245 NAME=
"QUEUERESUMECOMMAND"
15247 >queueresume command (S)
</DT
15250 >This parameter specifies the command to be
15251 executed on the server host in order to resume the printer queue. It
15252 is the command to undo the behavior that is caused by the
15253 previous parameter (
<A
15254 HREF=
"#QUEUEPAUSECOMMAND"
15258 > queuepause command
</I
15263 >This command should be a program or script which takes
15264 a printer name as its only parameter and resumes the printer queue,
15265 such that queued jobs are resubmitted to the printer.
</P
15267 >This command is not supported by Windows for Workgroups,
15268 but can be issued from the Printers window under Windows
95
15276 > is given then the printer name
15277 is put in its place. Otherwise it is placed at the end of the
15280 >Note that it is good practice to include the absolute
15281 path in the command as the PATH may not be available to the
15285 >depends on the setting of
<A
15299 >queuepause command = enable %p
15310 >This boolean parameter controls whether
<A
15314 > will support the
"Read
15315 Block Multiplex" SMB. This is now rarely used and defaults to
15319 >. You should never need to set this
15334 >This is a list of users that are given read-only
15335 access to a service. If the connecting user is in this list then
15336 they will not be given write access, no matter what the
<A
15345 option is set to. The list can include group names using the
15346 syntax described in the
<A
15347 HREF=
"#INVALIDUSERS"
15364 > parameter and the
<A
15365 HREF=
"#INVALIDUSERS"
15377 >read list =
<empty string
></B
15382 >read list = mary, @students
</B
15392 >An inverted synonym is
<A
15402 >If this parameter is
<TT
15406 of a service may not create or modify files in the service's
15409 >Note that a printable service (
<B
15411 >printable = yes
</B
15415 > allow writing to the directory
15416 (user privileges permitting), but only via spooling operations.
</P
15420 >read only = yes
</B
15430 >This parameter controls whether or not the server
15431 will support the raw read SMB requests when transferring data
15434 >If enabled, raw reads allow reads of
65535 bytes in
15435 one packet. This typically provides a major performance benefit.
15438 >However, some clients either negotiate the allowable
15439 block size incorrectly or are incapable of supporting larger block
15440 sizes, and for these clients you may need to disable raw reads.
</P
15442 >In general this parameter should be viewed as a system tuning
15443 tool and left severely alone. See also
<A
15471 affects the overlap of disk reads/writes with network reads/writes.
15472 If the amount of data being transferred in several of the SMB
15473 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
15474 than this value then the server begins writing the data before it
15475 has received the whole packet from the network, or in the case of
15476 SMBreadbraw, it begins writing to the network before all the data
15477 has been read from disk.
</P
15479 >This overlapping works best when the speeds of disk and
15480 network access are similar, having very little effect when the
15481 speed of one is much greater than the other.
</P
15483 >The default value is
16384, but very little experimentation
15484 has been done yet to determine the optimal value, and it is likely
15485 that the best value will vary greatly between systems anyway.
15486 A value over
65536 is pointless and will cause you to allocate
15487 memory unnecessarily.
</P
15491 >read size =
16384</B
15496 >read size =
8192</B
15501 NAME=
"REMOTEANNOUNCE"
15503 >remote announce (G)
</DT
15506 >This option allows you to setup
<A
15510 > to periodically announce itself
15511 to arbitrary IP addresses with an arbitrary workgroup name.
</P
15513 >This is useful if you want your Samba server to appear
15514 in a remote workgroup for which the normal browse propagation
15515 rules don't work. The remote workgroup can be anywhere that you
15516 can send IP packets to.
</P
15522 >remote announce =
192.168.2.255/SERVERS
15523 192.168.4.255/STAFF
</B
15526 >the above line would cause
<B
15529 > to announce itself
15530 to the two given IP addresses using the given workgroup names.
15531 If you leave out the workgroup name then the one given in
15541 parameter is used instead.
</P
15543 >The IP addresses you choose would normally be the broadcast
15544 addresses of the remote networks, but can also be the IP addresses
15545 of known browse masters if your network config is that stable.
</P
15547 >See the documentation file
<TT
15558 >remote announce =
<empty string
>
15564 NAME=
"REMOTEBROWSESYNC"
15566 >remote browse sync (G)
</DT
15569 >This option allows you to setup
<A
15573 > to periodically request
15574 synchronization of browse lists with the master browser of a Samba
15575 server that is on a remote segment. This option will allow you to
15576 gain browse lists for multiple workgroups across routed networks. This
15577 is done in a manner that does not work with any non-Samba servers.
</P
15579 >This is useful if you want your Samba server and all local
15580 clients to appear in a remote workgroup for which the normal browse
15581 propagation rules don't work. The remote workgroup can be anywhere
15582 that you can send IP packets to.
</P
15588 >remote browse sync =
192.168.2.255 192.168.4.255
15592 >the above line would cause
<B
15596 the master browser on the specified subnets or addresses to
15597 synchronize their browse lists with the local server.
</P
15599 >The IP addresses you choose would normally be the broadcast
15600 addresses of the remote networks, but can also be the IP addresses
15601 of known browse masters if your network config is that stable. If
15602 a machine IP address is given Samba makes NO attempt to validate
15603 that the remote machine is available, is listening, nor that it
15604 is in fact the browse master on its segment.
</P
15608 >remote browse sync =
<empty string
>
15614 NAME=
"RESTRICTANONYMOUS"
15616 >restrict anonymous (G)
</DT
15619 >This is a boolean parameter. If it is
<TT
15623 anonymous access to the server will be restricted, namely in the
15624 case where the server is expecting the client to send a username,
15625 but it doesn't. Setting it to
<TT
15628 > will force these anonymous
15629 connections to be denied, and the client will be required to always
15630 supply a username and password when connecting. Use of this parameter
15631 is only recommended for homogeneous NT client environments.
</P
15633 >This parameter makes the use of macro expansions that rely
15634 on the username (%U, %G, etc) consistent. NT
4.0
15635 likes to use anonymous connections when refreshing the share list,
15636 and this is a way to work around that.
</P
15638 >When restrict anonymous is
<TT
15641 >, all anonymous connections
15642 are denied no matter what they are for. This can effect the ability
15643 of a machine to access the Samba Primary Domain Controller to revalidate
15644 its machine account after someone else has logged on the client
15645 interactively. The NT client will display a message saying that
15646 the machine's account in the domain doesn't exist or the password is
15647 bad. The best way to deal with this is to reboot NT client machines
15648 between interactive logons, using
"Shutdown and Restart", rather
15649 than
"Close all programs and logon as a different user".
</P
15653 >restrict anonymous = no
</B
15664 HREF=
"#ROOTDIRECTORY"
15668 >root directory
"</I
15681 HREF="#ROOTDIRECTORY
"
15685 >root directory"</I
15692 NAME=
"ROOTDIRECTORY"
15694 >root directory (G)
</DT
15697 >The server will
<B
15701 Change its root directory) to this directory on startup. This is
15702 not strictly necessary for secure operation. Even without it the
15703 server will deny access to files not in one of the service entries.
15704 It may also check for, and deny access to, soft links to other
15705 parts of the filesystem, or attempts to use
".." in file names
15706 to access other directories (depending on the setting of the
<A
15723 than
"/" adds an extra level of security, but at a price. It
15724 absolutely ensures that no access is given to files not in the
15725 sub-tree specified in the
<TT
15733 > some files needed for
15734 complete operation of the server. To maintain full operability
15735 of the server you will need to mirror some system files
15741 > tree. In particular
15742 you will need to mirror
<TT
15746 subset of it), and any binaries or configuration files needed for
15747 printing (if required). The set of files that must be mirrored is
15748 operating system dependent.
</P
15752 >root directory = /
</B
15757 >root directory = /homes/smb
</B
15762 NAME=
"ROOTPOSTEXEC"
15764 >root postexec (S)
</DT
15767 >This is the same as the
<TT
15773 parameter except that the command is run as root. This
15774 is useful for unmounting filesystems
15775 (such as CDROMs) after a connection is closed.
</P
15789 >root postexec =
<empty string
>
15797 >root preexec (S)
</DT
15800 >This is the same as the
<TT
15806 parameter except that the command is run as root. This
15807 is useful for mounting filesystems (such as CDROMs) when a
15808 connection is opened.
</P
15819 HREF=
"#PREEXECCLOSE"
15830 >root preexec =
<empty string
>
15836 NAME=
"ROOTPREEXECCLOSE"
15838 >root preexec close (S)
</DT
15841 >This is the same as the
<TT
15847 > parameter except that the command is run as root.
</P
15858 HREF=
"#PREEXECCLOSE"
15869 >root preexec close = no
</B
15879 >This option affects how clients respond to
15880 Samba and is one of the most important settings in the
<TT
15885 >The option sets the
"security mode bit" in replies to
15886 protocol negotiations with
<A
15891 > to turn share level security on or off. Clients decide
15892 based on this bit whether (and how) to transfer user and password
15893 information to the server.
</P
15897 >security = user
</B
15899 the most common setting needed when talking to Windows
98 and
15902 >The alternatives are
<B
15904 >security = share
</B
15908 >security = server
</B
15915 >In versions of Samba prior to
2.0.0, the default was
15918 >security = share
</B
15919 > mainly because that was
15920 the only option at one stage.
</P
15922 >There is a bug in WfWg that has relevance to this
15923 setting. When in user or server level security a WfWg client
15924 will totally ignore the password you type in the
"connect
15925 drive" dialog box. This makes it very difficult (if not impossible)
15926 to connect to a Samba service as anyone except the user that
15927 you are logged into WfWg as.
</P
15929 >If your PCs use usernames that are the same as their
15930 usernames on the UNIX machine then you will want to use
15933 >security = user
</B
15934 >. If you mostly use usernames
15935 that don't exist on the UNIX box then use
<B
15941 >You should also use
<B
15943 >security = share
</B
15945 want to mainly setup shares without a password (guest shares). This
15946 is commonly used for a shared printer server. It is more difficult
15947 to setup guest shares with
<B
15949 >security = user
</B
15960 >parameter for details.
</P
15962 >It is possible to use
<B
15967 > where it is offers both user and share
15968 level security under different
<A
15969 HREF=
"#NETBIOSALIASES"
15973 >NetBIOS aliases
</I
15978 >The different settings will now be explained.
</P
15981 NAME=
"SECURITYEQUALSSHARE"
15988 >When clients connect to a share level security server they
15989 need not log onto the server with a valid username and password before
15990 attempting to connect to a shared resource (although modern clients
15991 such as Windows
95/
98 and Windows NT will send a logon request with
15992 a username but no password when talking to a
<B
15996 > server). Instead, the clients send authentication information
15997 (passwords) on a per-share basis, at the time they attempt to connect
16006 uses a valid UNIX user to act on behalf of the client, even in
16009 >security = share
</B
16010 > level security.
</P
16012 >As clients are not required to send a username to the server
16013 in share level security,
<B
16017 techniques to determine the correct UNIX user to use on behalf
16020 >A list of possible UNIX usernames to match with the given
16021 client password is constructed using the following methods :
</P
16036 > parameter is set, then all the other
16037 stages are missed and only the
<A
16038 HREF=
"#GUESTACCOUNT"
16045 > username is checked.
16050 >Is a username is sent with the share connection
16051 request, then this username (after mapping - see
<A
16052 HREF=
"#USERNAMEMAP"
16060 is added as a potential username.
</P
16064 >If the client did a previous
<EM
16067 > request (the SessionSetup SMB call) then the
16068 username sent in this SMB will be added as a potential username.
16073 >The name of the service the client requested is
16074 added as a potential username.
</P
16078 >The NetBIOS name of the client is added to
16079 the list as a potential username.
</P
16083 >Any users on the
<A
16091 > list are added as potential usernames.
16102 not set, then this list is then tried with the supplied password.
16103 The first user for whom the password matches will be used as the
16112 set, or no username can be determined then if the share is marked
16113 as available to the
<TT
16119 guest user will be used, otherwise access is denied.
</P
16121 >Note that it can be
<EM
16124 in share-level security as to which UNIX username will eventually
16125 be used in granting access.
</P
16127 >See also the section
<A
16129 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
16133 NAME=
"SECURITYEQUALSUSER"
16140 >This is the default security setting in Samba
2.2.
16141 With user-level security a client must first
"log-on" with a
16142 valid username and password (which can be mapped using the
<A
16143 HREF=
"#USERNAMEMAP"
16151 parameter). Encrypted passwords (see the
<A
16152 HREF=
"#ENCRYPTPASSWORDS"
16156 >encrypted passwords
</I
16159 > parameter) can also
16160 be used in this security mode. Parameters such as
<A
16176 > if set are then applied and
16177 may change the UNIX user to use on this connection, but only after
16178 the user has been successfully authenticated.
</P
16182 > that the name of the resource being
16185 > sent to the server until after
16186 the server has successfully authenticated the client. This is why
16187 guest shares don't work in user level security without allowing
16188 the server to automatically map unknown users into the
<A
16189 HREF=
"#GUESTACCOUNT"
16206 > parameter for details on doing this.
</P
16208 >See also the section
<A
16210 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
16214 NAME=
"SECURITYEQUALSSERVER"
16221 >In this mode Samba will try to validate the username/password
16222 by passing it to another SMB server, such as an NT box. If this
16223 fails it will revert to
<B
16225 >security = user
</B
16227 that if encrypted passwords have been negotiated then Samba cannot
16228 revert back to checking the UNIX password file, it must have a valid
16232 > file to check users against. See the
16233 documentation file in the
<TT
16239 >ENCRYPTION.txt
</TT
16240 > for details on how to set this
16245 > that from the client's point of
16248 >security = server
</B
16249 > is the same as
<B
16251 > security = user
</B
16252 >. It only affects how the server deals
16253 with the authentication, it does not in any way affect what the
16258 > that the name of the resource being
16261 > sent to the server until after
16262 the server has successfully authenticated the client. This is why
16263 guest shares don't work in user level security without allowing
16264 the server to automatically map unknown users into the
<A
16265 HREF=
"#GUESTACCOUNT"
16282 > parameter for details on doing this.
</P
16284 >See also the section
<A
16286 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
16290 HREF=
"#PASSWORDSERVER"
16298 > parameter and the
<A
16299 HREF=
"#ENCRYPTPASSWORDS"
16303 >encrypted passwords
</I
16310 NAME=
"SECURITYEQUALSDOMAIN"
16317 >This mode will only work correctly if
<A
16318 HREF=
"smbpasswd.8.html"
16321 > has been used to add this
16322 machine into a Windows NT Domain. It expects the
<A
16323 HREF=
"#ENCRYPTPASSWORDS"
16327 >encrypted passwords
</I
16331 > parameter to be set to
<TT
16335 mode Samba will try to validate the username/password by passing
16336 it to a Windows NT Primary or Backup Domain Controller, in exactly
16337 the same way that a Windows NT Server would do.
</P
16341 > that a valid UNIX user must still
16342 exist as well as the account on the Domain Controller to allow
16343 Samba to have a valid UNIX account to map file access to.
</P
16347 > that from the client's point
16350 >security = domain
</B
16351 > is the same as
<B
16355 >. It only affects how the server deals with the authentication,
16356 it does not in any way affect what the client sees.
</P
16360 > that the name of the resource being
16363 > sent to the server until after
16364 the server has successfully authenticated the client. This is why
16365 guest shares don't work in user level security without allowing
16366 the server to automatically map unknown users into the
<A
16367 HREF=
"#GUESTACCOUNT"
16384 > parameter for details on doing this.
</P
16388 > There is currently a bug in the
16389 implementation of
<B
16391 >security = domain
</B
16393 to multi-byte character set usernames. The communication with a
16394 Domain Controller must be done in UNICODE and Samba currently
16395 does not widen multi-byte user names to UNICODE correctly, thus
16396 a multi-byte username will not be recognized correctly at the
16397 Domain Controller. This issue will be addressed in a future release.
</P
16399 >See also the section
<A
16401 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
16405 HREF=
"#PASSWORDSERVER"
16413 > parameter and the
<A
16414 HREF=
"#ENCRYPTPASSWORDS"
16418 >encrypted passwords
</I
16426 >security = USER
</B
16431 >security = DOMAIN
</B
16436 NAME=
"SECURITYMASK"
16438 >security mask (S)
</DT
16441 >This parameter controls what UNIX permission
16442 bits can be modified when a Windows NT client is manipulating
16443 the UNIX permission on a file using the native NT security
16446 >This parameter is applied as a mask (AND'ed with) to
16447 the changed permission bits, thus preventing any bits not in
16448 this mask from being modified. Essentially, zero bits in this
16449 mask may be treated as a set of bits the user is not allowed
16452 >If not set explicitly this parameter is
0777, allowing
16453 a user to modify all the user/group/world permissions on a file.
16458 > that users who can access the
16459 Samba server through other means can easily bypass this
16460 restriction, so it is primarily useful for standalone
16461 "appliance" systems. Administrators of most normal systems will
16462 probably want to leave it set to
<TT
16468 HREF=
"#FORCEDIRECTORYSECURITYMODE"
16472 >force directory security mode
</I
16477 HREF=
"#DIRECTORYSECURITYMASK"
16486 HREF=
"#FORCESECURITYMODE"
16490 >force security mode
</I
16497 >security mask =
0777</B
16502 >security mask =
0770</B
16507 NAME=
"SERVERSTRING"
16509 >server string (G)
</DT
16512 >This controls what string will show up in the
16513 printer comment box in print manager and next to the IPC connection
16517 >. It can be any string that you wish
16518 to show to your users.
</P
16520 >It also sets what will appear in browse lists next
16521 to the machine name.
</P
16528 > will be replaced with the Samba
16536 > will be replaced with the
16541 >server string = Samba %v
</B
16546 >server string = University of GNUs Samba
16552 NAME=
"SETDIRECTORY"
16554 >set directory (S)
</DT
16559 >set directory = no
</B
16561 users of the service may not use the setdir command to change
16567 > command is only implemented
16568 in the Digital Pathworks client. See the Pathworks documentation
16573 >set directory = no
</B
16580 >share modes (S)
</DT
16583 >This enables or disables the honoring of
16589 > during a file open. These
16590 modes are used by clients to gain exclusive read or write access
16593 >These open modes are not directly supported by UNIX, so
16594 they are simulated using shared memory, or lock files if your
16595 UNIX doesn't support shared memory (almost all do).
</P
16597 >The share modes that are enabled by this option are
16621 >This option gives full share compatibility and enabled
16626 > turn this parameter
16627 off as many Windows applications will break if you do so.
</P
16631 >share modes = yes
</B
16636 NAME=
"SHORTPRESERVECASE"
16638 >short preserve case (S)
</DT
16641 >This boolean parameter controls if new files
16642 which conform to
8.3 syntax, that is all in upper case and of
16643 suitable length, are created upper case, or if they are forced
16645 HREF=
"#DEFAULTCASE"
16653 >. This option can be use with
<A
16654 HREF=
"#PRESERVECASE"
16657 >preserve case = yes
</B
16660 > to permit long filenames to retain their case, while short
16661 names are lowered.
</P
16663 >See the section on
<A
16670 >short preserve case = yes
</B
16675 NAME=
"SHOWADDPRINTERWIZARD"
16677 >show add printer wizard (G)
</DT
16680 >With the introduction of MS-RPC based printing support
16681 for Windows NT/
2000 client in Samba
2.2, a
"Printers..." folder will
16682 appear on Samba hosts in the share listing. Normally this folder will
16683 contain an icon for the MS Add Printer Wizard (APW). However, it is
16684 possible to disable this feature regardless of the level of privilege
16685 of the connected user.
</P
16687 >Under normal circumstances, the Windows NT/
2000 client will
16688 open a handle on the printer server with OpenPrinterEx() asking for
16689 Administrator privileges. If the user does not have administrative
16690 access on the print server (i.e is not root or a member of the
16696 > group), the OpenPrinterEx()
16697 call fails and the client makes another open call with a request for
16698 a lower privilege level. This should succeed, however the APW
16699 icon will not be displayed.
</P
16704 >show add printer wizard
</I
16707 parameter will always cause the OpenPrinterEx() on the server
16708 to fail. Thus the APW icon will never be displayed.
<EM
16710 >This does not prevent the same user from having
16711 administrative privilege on an individual printer.
</P
16714 HREF=
"#ADDPRINTERCOMMAND"
16723 HREF=
"#DELETEPRINTERCOMMAND"
16727 >deleteprinter command
</I
16731 HREF=
"#PRINTERADMIN"
16742 >show add printer wizard = yes
</B
16747 NAME=
"SMBPASSWDFILE"
16749 >smb passwd file (G)
</DT
16752 >This option sets the path to the encrypted
16753 smbpasswd file. By default the path to the smbpasswd file
16754 is compiled into Samba.
</P
16758 >smb passwd file = ${prefix}/private/smbpasswd
16764 >smb passwd file = /etc/samba/smbpasswd
16770 NAME=
"SOCKETADDRESS"
16772 >socket address (G)
</DT
16775 >This option allows you to control what
16776 address Samba will listen for connections on. This is used to
16777 support multiple virtual interfaces on the one server, each
16778 with a different configuration.
</P
16780 >By default Samba will accept connections on any
16785 >socket address =
192.168.2.20</B
16791 NAME=
"SOCKETOPTIONS"
16793 >socket options (G)
</DT
16796 >This option allows you to set socket options
16797 to be used when talking with the client.
</P
16799 >Socket options are controls on the networking layer
16800 of the operating systems which allow the connection to be
16803 >This option will typically be used to tune your Samba
16804 server for optimal performance for your local network. There is
16805 no way that Samba can know what the optimal parameters are for
16806 your net, so you must experiment and choose them yourself. We
16807 strongly suggest you read the appropriate documentation for your
16808 operating system first (perhaps
<B
16814 >You may find that on some systems Samba will say
16815 "Unknown socket option" when you supply an option. This means you
16816 either incorrectly typed it or you need to add an include file
16817 to includes.h for your OS. If the latter is the case please
16818 send the patch to
<A
16819 HREF=
"mailto:samba@samba.org"
16821 > samba@samba.org
</A
16824 >Any of the supported socket options may be combined
16825 in any way you like, as long as your OS allows it.
</P
16827 >This is the list of socket options currently settable
16828 using this option:
</P
16854 >IPTOS_THROUGHPUT
</P
16874 >Those marked with a
<EM
16877 argument. The others can optionally take a
1 or
0 argument to enable
16878 or disable the option, by default they will be enabled if you
16879 don't specify
1 or
0.
</P
16881 >To specify an argument use the syntax SOME_OPTION = VALUE
16884 >SO_SNDBUF =
8192</B
16885 >. Note that you must
16886 not have any spaces before or after the = sign.
</P
16888 >If you are on a local network then a sensible option
16893 >socket options = IPTOS_LOWDELAY
</B
16896 >If you have a local network then you could try:
</P
16900 >socket options = IPTOS_LOWDELAY TCP_NODELAY
</B
16903 >If you are on a wide area network then perhaps try
16904 setting IPTOS_THROUGHPUT.
</P
16906 >Note that several of the options may cause your Samba
16907 server to fail completely. Use these options with caution!
</P
16911 >socket options = TCP_NODELAY
</B
16916 >socket options = IPTOS_LOWDELAY
</B
16921 NAME=
"SOURCEENVIRONMENT"
16923 >source environment (G)
</DT
16926 >This parameter causes Samba to set environment
16927 variables as per the content of the file named.
</P
16929 >If the value of this parameter starts with a
"|" character
16930 then Samba will treat that value as a pipe command to open and
16931 will set the environment variables from the output of the pipe.
</P
16933 >The contents of the file or the output of the pipe should
16934 be formatted as the output of the standard Unix
<B
16938 > command. This is of the form :
</P
16940 >Example environment entry:
</P
16944 >SAMBA_NETBIOS_NAME = myhostname
</B
16948 >No default value
</EM
16953 >source environment = |/etc/smb.conf.sh
16959 >source environment =
16960 /usr/local/smb_env_vars
</B
16970 >This variable is part of SSL-enabled Samba. This
16971 is only available if the SSL libraries have been compiled on your
16972 system and the configure option
<B
16976 given at configure time.
</P
16978 >This variable enables or disables the entire SSL mode. If
16982 >, the SSL-enabled Samba behaves
16983 exactly like the non-SSL Samba. If set to
<TT
16987 it depends on the variables
<A
16996 HREF=
"#SSLHOSTSRESIGN"
17000 >ssl hosts resign
</I
17004 connection will be required.
</P
17013 NAME=
"SSLCACERTDIR"
17015 >ssl CA certDir (G)
</DT
17018 >This variable is part of SSL-enabled Samba. This
17019 is only available if the SSL libraries have been compiled on your
17020 system and the configure option
<B
17024 given at configure time.
</P
17026 >This variable defines where to look up the Certification
17027 Authorities. The given directory should contain one file for
17028 each CA that Samba will trust. The file name must be the hash
17029 value over the
"Distinguished Name" of the CA. How this directory
17030 is set up is explained later in this document. All files within the
17031 directory that don't fit into this naming scheme are ignored. You
17032 don't need this variable if you don't verify client certificates.
</P
17036 >ssl CA certDir = /usr/local/ssl/certs
17042 NAME=
"SSLCACERTFILE"
17044 >ssl CA certFile (G)
</DT
17047 >This variable is part of SSL-enabled Samba. This
17048 is only available if the SSL libraries have been compiled on your
17049 system and the configure option
<B
17053 given at configure time.
</P
17055 >This variable is a second way to define the trusted CAs.
17056 The certificates of the trusted CAs are collected in one big
17057 file and this variable points to the file. You will probably
17058 only use one of the two ways to define your CAs. The first choice is
17059 preferable if you have many CAs or want to be flexible, the second
17060 is preferable if you only have one CA and want to keep things
17061 simple (you won't need to create the hashed file names). You
17062 don't need this variable if you don't verify client certificates.
</P
17066 >ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
17074 >ssl ciphers (G)
</DT
17077 >This variable is part of SSL-enabled Samba. This
17078 is only available if the SSL libraries have been compiled on your
17079 system and the configure option
<B
17083 given at configure time.
</P
17085 >This variable defines the ciphers that should be offered
17086 during SSL negotiation. You should not set this variable unless
17087 you know what you are doing.
</P
17091 NAME=
"SSLCLIENTCERT"
17093 >ssl client cert (G)
</DT
17096 >This variable is part of SSL-enabled Samba. This
17097 is only available if the SSL libraries have been compiled on your
17098 system and the configure option
<B
17102 given at configure time.
</P
17104 >The certificate in this file is used by
<A
17105 HREF=
"smbclient.1.html"
17111 > if it exists. It's needed
17112 if the server requires a client certificate.
</P
17116 >ssl client cert = /usr/local/ssl/certs/smbclient.pem
17122 NAME=
"SSLCLIENTKEY"
17124 >ssl client key (G)
</DT
17127 >This variable is part of SSL-enabled Samba. This
17128 is only available if the SSL libraries have been compiled on your
17129 system and the configure option
<B
17133 given at configure time.
</P
17135 >This is the private key for
<A
17136 HREF=
"smbclient.1.html"
17142 >. It's only needed if the
17143 client should have a certificate.
</P
17147 >ssl client key = /usr/local/ssl/private/smbclient.pem
17153 NAME=
"SSLCOMPATIBILITY"
17155 >ssl compatibility (G)
</DT
17158 >This variable is part of SSL-enabled Samba. This
17159 is only available if the SSL libraries have been compiled on your
17160 system and the configure option
<B
17164 given at configure time.
</P
17166 >This variable defines whether OpenSSL should be configured
17167 for bug compatibility with other SSL implementations. This is
17168 probably not desirable because currently no clients with SSL
17169 implementations other than OpenSSL exist.
</P
17173 >ssl compatibility = no
</B
17178 NAME=
"SSLEGDSOCKET"
17180 >ssl egd socket (G)
</DT
17183 >This variable is part of SSL-enabled Samba. This
17184 is only available if the SSL libraries have been compiled on your
17185 system and the configure option
<B
17189 given at configure time.
</P
17191 > This option is used to define the location of the communiation socket of
17192 an EGD or PRNGD daemon, from which entropy can be retrieved. This option
17193 can be used instead of or together with the
<A
17194 HREF=
"#SSLENTROPYFILE"
17198 >ssl entropy file
</I
17202 directive.
255 bytes of entropy will be retrieved from the daemon.
17211 NAME=
"SSLENTROPYBYTES"
17213 >ssl entropy bytes (G)
</DT
17216 >This variable is part of SSL-enabled Samba. This
17217 is only available if the SSL libraries have been compiled on your
17218 system and the configure option
<B
17222 given at configure time.
</P
17224 > This parameter is used to define the number of bytes which should
17225 be read from the
<A
17226 HREF=
"#SSLENTROPYFILE"
17234 > If a -
1 is specified, the entire file will
17240 >ssl entropy bytes =
255</B
17245 NAME=
"SSLENTROPYFILE"
17247 >ssl entropy file (G)
</DT
17250 >This variable is part of SSL-enabled Samba. This
17251 is only available if the SSL libraries have been compiled on your
17252 system and the configure option
<B
17256 given at configure time.
</P
17258 > This parameter is used to specify a file from which processes will
17259 read
"random bytes" on startup. In order to seed the internal pseudo
17260 random number generator, entropy must be provided. On system with a
17264 > device file, the processes
17265 will retrieve its entropy from the kernel. On systems without kernel
17266 entropy support, a file can be supplied that will be read on startup
17267 and that will be used to seed the PRNG.
17282 HREF=
"#SSLHOSTSRESIGN"
17286 > ssl hosts resign
</I
17293 NAME=
"SSLHOSTSRESIGN"
17295 >ssl hosts resign (G)
</DT
17298 >This variable is part of SSL-enabled Samba. This
17299 is only available if the SSL libraries have been compiled on your
17300 system and the configure option
<B
17304 given at configure time.
</P
17306 >These two variables define whether Samba will go
17307 into SSL mode or not. If none of them is defined, Samba will
17308 allow only SSL connections. If the
<A
17317 hosts (by IP-address, IP-address range, net group or name),
17318 only these hosts will be forced into SSL mode. If the
<TT
17321 > ssl hosts resign
</I
17323 > variable lists hosts, only these
17326 > be forced into SSL mode. The syntax for these two
17327 variables is the same as for the
<A
17343 > pair of variables, only
17344 that the subject of the decision is different: It's not the access
17345 right but whether SSL is used or not.
</P
17347 >The example below requires SSL connections from all hosts
17348 outside the local net (which is
192.168.*.*).
</P
17352 >ssl hosts =
<empty string
></B
17357 >ssl hosts resign =
<empty string
></B
17362 >ssl hosts resign =
192.168.
</B
17367 NAME=
"SSLREQUIRECLIENTCERT"
17369 >ssl require clientcert (G)
</DT
17372 >This variable is part of SSL-enabled Samba. This
17373 is only available if the SSL libraries have been compiled on your
17374 system and the configure option
<B
17378 given at configure time.
</P
17380 >If this variable is set to
<TT
17384 server will not tolerate connections from clients that don't
17385 have a valid certificate. The directory/file given in
<A
17386 HREF=
"#SSLCACERTDIR"
17395 HREF=
"#SSLCACERTFILE"
17403 > will be used to look up the CAs that issued
17404 the client's certificate. If the certificate can't be verified
17405 positively, the connection will be terminated. If this variable
17409 >, clients don't need certificates.
17410 Contrary to web applications you really
<EM
17413 require client certificates. In the web environment the client's
17414 data is sensitive (credit card numbers) and the server must prove
17415 to be trustworthy. In a file server environment the server's data
17416 will be sensitive and the clients must prove to be trustworthy.
</P
17420 >ssl require clientcert = no
</B
17425 NAME=
"SSLREQUIRESERVERCERT"
17427 >ssl require servercert (G)
</DT
17430 >This variable is part of SSL-enabled Samba. This
17431 is only available if the SSL libraries have been compiled on your
17432 system and the configure option
<B
17436 given at configure time.
</P
17438 >If this variable is set to
<TT
17443 HREF=
"smbclient.1.html"
17450 > will request a certificate from the server. Same as
17452 HREF=
"#SSLREQUIRECLIENTCERT"
17460 > for the server.
</P
17464 >ssl require servercert = no
</B
17470 NAME=
"SSLSERVERCERT"
17472 >ssl server cert (G)
</DT
17475 >This variable is part of SSL-enabled Samba. This
17476 is only available if the SSL libraries have been compiled on your
17477 system and the configure option
<B
17481 given at configure time.
</P
17483 >This is the file containing the server's certificate.
17486 > have a certificate. The
17487 file may also contain the server's private key. See later for
17488 how certificates and private keys are created.
</P
17492 >ssl server cert =
<empty string
>
17498 NAME=
"SSLSERVERKEY"
17500 >ssl server key (G)
</DT
17503 >This variable is part of SSL-enabled Samba. This
17504 is only available if the SSL libraries have been compiled on your
17505 system and the configure option
<B
17509 given at configure time.
</P
17511 >This file contains the private key of the server. If
17512 this variable is not defined, the key is looked up in the
17513 certificate file (it may be appended to the certificate).
17516 > have a private key
17517 and the certificate
<EM
17520 match this private key.
</P
17524 >ssl server key =
<empty string
>
17532 >ssl version (G)
</DT
17535 >This variable is part of SSL-enabled Samba. This
17536 is only available if the SSL libraries have been compiled on your
17537 system and the configure option
<B
17541 given at configure time.
</P
17543 >This enumeration variable defines the versions of the
17544 SSL protocol that will be used.
<TT
17548 dynamic negotiation of SSL v2 or v3,
<TT
17555 > results in SSL v3 and
17559 > results in TLS v1. TLS (Transport Layer
17560 Security) is the new standard for SSL.
</P
17564 >ssl version =
"ssl2or3"</B
17571 >stat cache (G)
</DT
17574 >This parameter determines if
<A
17578 > will use a cache in order to
17579 speed up case insensitive name mappings. You should never need
17580 to change this parameter.
</P
17584 >stat cache = yes
</B
17589 NAME=
"STATCACHESIZE"
17591 >stat cache size (G)
</DT
17594 >This parameter determines the number of
17601 never need to change this parameter.
</P
17605 >stat cache size =
50</B
17615 >This enables or disables logging of connections
17616 to a status file that
<A
17617 HREF=
"smbstatus.1.html"
17623 >With this disabled
<B
17627 to tell you what connections are active. You should never need to
17628 change this parameter.
</P
17637 NAME=
"STRICTALLOCATE"
17639 >strict allocate (S)
</DT
17642 >This is a boolean that controls the handling of
17643 disk space allocation in the server. When this is set to
<TT
17647 the server will change from UNIX behaviour of not committing real
17648 disk storage blocks when a file is extended to the Windows behaviour
17649 of actually forcing the disk system to allocate real storage blocks
17650 when a file is created or extended to be a given size. In UNIX
17651 terminology this means that Samba will stop creating sparse files.
17652 This can be slow on some systems.
</P
17654 >When strict allocate is
<TT
17657 > the server does sparse
17658 disk block allocation when a file is extended.
</P
17660 >Setting this to
<TT
17663 > can help Samba return
17664 out of quota messages on systems that are restricting the disk quota
17669 >strict allocate = no
</B
17674 NAME=
"STRICTLOCKING"
17676 >strict locking (S)
</DT
17679 >This is a boolean that controls the handling of
17680 file locking in the server. When this is set to
<TT
17684 the server will check every read and write access for file locks, and
17685 deny access if locks exist. This can be slow on some systems.
</P
17687 >When strict locking is
<TT
17690 > the server does file
17691 lock checks only when the client explicitly asks for them.
</P
17693 >Well-behaved clients always ask for lock checks when it
17694 is important, so in the vast majority of cases
<B
17698 > is preferable.
</P
17702 >strict locking = no
</B
17709 >strict sync (S)
</DT
17712 >Many Windows applications (including the Windows
17713 98 explorer shell) seem to confuse flushing buffer contents to
17714 disk with doing a sync to disk. Under UNIX, a sync call forces
17715 the process to be suspended until the kernel has ensured that
17716 all outstanding data in kernel disk buffers has been safely stored
17717 onto stable storage. This is very slow and should only be done
17718 rarely. Setting this parameter to
<TT
17722 default) means that
<A
17726 > ignores the Windows applications requests for
17727 a sync call. There is only a possibility of losing data if the
17728 operating system itself that Samba is running on crashes, so there is
17729 little danger in this default setting. In addition, this fixes many
17730 performance problems that people have reported with the new Windows98
17731 explorer shell file copies.
</P
17746 >strict sync = no
</B
17756 >This parameter is now unused in Samba (
2.2.5 and above).
17757 It used strip trailing dots off UNIX filenames but was not correctly implmented.
17758 In Samba
2.2.5 and above UNIX filenames ending in a dot are invalid Windows long
17759 filenames (as they are in Windows NT and above) and are mangled to
8.3 before
17760 being returned to a client.
</P
17771 >sync always (S)
</DT
17774 >This is a boolean parameter that controls
17775 whether writes will always be written to stable storage before
17776 the write call returns. If this is
<TT
17779 > then the server will be
17780 guided by the client's request in each write call (clients can
17781 set a bit indicating that a particular write should be synchronous).
17785 > then every write will be followed by a
<B
17789 > call to ensure the data is written to disk. Note that
17795 > parameter must be set to
17799 > in order for this parameter to have
17815 >sync always = no
</B
17825 >This parameter maps how Samba debug messages
17826 are logged onto the system syslog logging levels. Samba debug
17827 level zero maps onto syslog
<TT
17831 level one maps onto
<TT
17838 >, debug level three
17839 maps onto LOG_INFO. All higher levels are mapped to
<TT
17844 >This parameter sets the threshold for sending messages
17845 to syslog. Only messages with debug level less than this value
17846 will be sent to syslog.
</P
17857 >syslog only (G)
</DT
17860 >If this parameter is set then Samba debug
17861 messages are logged into the system syslog only, and not to
17862 the debug log files.
</P
17866 >syslog only = no
</B
17871 NAME=
"TEMPLATEHOMEDIR"
17873 >template homedir (G)
</DT
17876 >When filling out the user information for a Windows NT
17878 HREF=
"winbindd.8.html"
17882 uses this parameter to fill in the home directory for that user.
17888 > is present it is substituted
17889 with the user's Windows NT domain name. If the string
<TT
17895 > is present it is substituted with the user's Windows
17900 >template homedir = /home/%D/%U
</B
17905 NAME=
"TEMPLATESHELL"
17907 >template shell (G)
</DT
17910 >When filling out the user information for a Windows NT
17912 HREF=
"winbindd.8.html"
17916 uses this parameter to fill in the login shell for that user.
</P
17920 >template shell = /bin/false
</B
17927 >time offset (G)
</DT
17930 >This parameter is a setting in minutes to add
17931 to the normal GMT to local time conversion. This is useful if
17932 you are serving a lot of PCs that have incorrect daylight
17933 saving time handling.
</P
17937 >time offset =
0</B
17942 >time offset =
60</B
17949 >time server (G)
</DT
17952 >This parameter determines if
<A
17957 > advertises itself as a time server to Windows
17962 >time server = no
</B
17967 NAME=
"TIMESTAMPLOGS"
17969 >timestamp logs (G)
</DT
17973 HREF=
"#DEBUGTIMESTAMP"
17977 > debug timestamp
</I
17984 NAME=
"TOTALPRINTJOBS"
17986 >total print jobs (G)
</DT
17989 >This parameter accepts an integer value which defines
17990 a limit on the maximum number of print jobs that will be accepted
17991 system wide at any given time. If a print job is submitted
17992 by a client which will exceed this number, then
<A
17997 error indicating that no space is available on the server. The
17998 default value of
0 means that no such limit exists. This parameter
17999 can be used to prevent a server from exceeding its capacity and is
18000 designed as a printing throttle. See also
18002 HREF=
"#MAXPRINTJOBS"
18014 >total print jobs =
0</B
18019 >total print jobs =
5000</B
18024 NAME=
"UNIXEXTENSIONS"
18026 >unix extensions(G)
</DT
18029 >This boolean parameter controls whether Samba
18030 implments the CIFS UNIX extensions, as defined by HP.
18031 These extensions enable Samba to better serve UNIX CIFS clients
18032 by supporting features such as symbolic links, hard links, etc...
18033 These extensions require a similarly enabled client, and are of
18034 no current use to Windows clients.
</P
18038 >unix extensions = no
</B
18043 NAME=
"UNIXPASSWORDSYNC"
18045 >unix password sync (G)
</DT
18048 >This boolean parameter controls whether Samba
18049 attempts to synchronize the UNIX password with the SMB password
18050 when the encrypted SMB password in the smbpasswd file is changed.
18051 If this is set to
<TT
18054 > the program specified in the
<TT
18060 >parameter is called
<EM
18063 to allow the new UNIX password to be set without access to the
18064 old UNIX password (as the SMB password change code has no
18065 access to the old password cleartext, only the new).
</P
18068 HREF=
"#PASSWDPROGRAM"
18088 >unix password sync = no
</B
18093 NAME=
"UPDATEENCRYPTED"
18095 >update encrypted (G)
</DT
18098 >This boolean parameter allows a user logging
18099 on with a plaintext password to have their encrypted (hashed)
18100 password in the smbpasswd file to be updated automatically as
18101 they log on. This option allows a site to migrate from plaintext
18102 password authentication (users authenticate with plaintext
18103 password over the wire, and are checked against a UNIX account
18104 database) to encrypted password authentication (the SMB
18105 challenge/response authentication mechanism) without forcing
18106 all users to re-enter their passwords via smbpasswd at the time the
18107 change is made. This is a convenience option to allow the change over
18108 to encrypted passwords to be made over a longer period. Once all users
18109 have encrypted representations of their passwords in the smbpasswd
18110 file this parameter should be set to
<TT
18115 >In order for this parameter to work correctly the
<A
18116 HREF=
"#ENCRYPTPASSWORDS"
18120 >encrypt passwords
</I
18124 > parameter must be set to
<TT
18128 this parameter is set to
<TT
18133 >Note that even when this parameter is set a user
18134 authenticating to
<B
18137 > must still enter a valid
18138 password in order to connect correctly, and to update their hashed
18139 (smbpasswd) passwords.
</P
18143 >update encrypted = no
</B
18148 NAME=
"USECLIENTDRIVER"
18150 >use client driver (S)
</DT
18153 >This parameter applies only to Windows NT/
2000
18154 clients. It has no affect on Windows
95/
98/ME clients. When
18155 serving a printer to Windows NT/
2000 clients without first installing
18156 a valid printer driver on the Samba host, the client will be required
18157 to install a local printer driver. From this point on, the client
18158 will treat the print as a local printer and not a network printer
18159 connection. This is much the same behavior that will occur
18162 >disable spoolss = yes
</B
18165 >The differentiating
18166 factor is that under normal circumstances, the NT/
2000 client will
18167 attempt to open the network printer using MS-RPC. The problem is that
18168 because the client considers the printer to be local, it will attempt
18169 to issue the OpenPrinterEx() call requesting access rights associated
18170 with the logged on user. If the user possesses local administator rights
18171 but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
18172 call will fail. The result is that the client will now display an
"Access
18173 Denied; Unable to connect" message in the printer queue window (even though
18174 jobs may successfully be printed).
</P
18176 >If this parameter is enabled for a printer, then any attempt
18177 to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
18178 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
18179 call to succeed.
<EM
18180 >This parameter MUST not be able enabled
18181 on a print share which has valid print driver installed on the Samba
18186 HREF=
"#DISABLESPOOLSS"
18187 >disable spoolss
</A
18193 >use client driver = no
</B
18203 >This global parameter determines if the tdb internals of Samba can
18204 depend on mmap working correctly on the running system. Samba requires a coherent
18205 mmap/read-write system memory cache. Currently only HPUX does not have such a
18206 coherent cache, and so this parameter is set to
<TT
18210 default on HPUX. On all other systems this parameter should be left alone. This
18211 parameter is provided to help the Samba developers track down problems with
18212 the tdb internal code.
18224 >use rhosts (G)
</DT
18227 >If this global parameter is
<TT
18231 that the UNIX user's
<TT
18234 > file in their home directory
18235 will be read to find the names of hosts and users who will be allowed
18236 access without specifying a password.
</P
18246 > can be a major security hole. This is because you are
18247 trusting the PC to supply the correct username. It is very easy to
18248 get a PC to supply a false username. I recommend that the
<TT
18253 > option be only used if you really know what
18258 >use rhosts = no
</B
18265 >use sendfile (S)
</DT
18268 >If this parameter is
<TT
18272 was built with the --with-sendfile-support option, and the underlying operating
18273 system supports sendfile system call, then some SMB read calls (mainly ReadAndX
18274 and ReadRaw) will use the more efficient sendfile system call for files that
18275 are exclusively oplocked. This may make more efficient use of the system CPU's
18276 and cause Samba to be faster. This is off by default as it's effects are unknown
18282 >use sendfile = no
</B
18326 >Multiple users may be specified in a comma-delimited
18327 list, in which case the supplied password will be tested against
18328 each username in turn (left to right).
</P
18335 > line is needed only when
18336 the PC is unable to supply its own username. This is the case
18337 for the COREPLUS protocol or where your users have different WfWg
18338 usernames to UNIX usernames. In both these cases you may also be
18339 better using the \\server\share%user syntax instead.
</P
18346 > line is not a great
18347 solution in many cases as it means Samba will try to validate
18348 the supplied password against each of the usernames in the
18354 > line in turn. This is slow and
18355 a bad idea for lots of users in case of duplicate passwords.
18356 You may get timeouts or security breaches using this parameter
18359 >Samba relies on the underlying UNIX security. This
18360 parameter does not restrict who can login, it just offers hints
18361 to the Samba server as to what usernames might correspond to the
18362 supplied password. Users can login as whoever they please and
18363 they will be able to do no more damage than if they started a
18364 telnet session. The daemon runs as the user that they log in as,
18365 so they cannot do anything that user cannot do.
</P
18367 >To restrict a service to a particular set of users you
18379 >If any of the usernames begin with a '@' then the name
18380 will be looked up first in the NIS netgroups list (if Samba
18381 is compiled with netgroup support), followed by a lookup in
18382 the UNIX groups database and will expand to a list of all users
18383 in the group of that name.
</P
18385 >If any of the usernames begin with a '+' then the name
18386 will be looked up only in the UNIX groups database and will
18387 expand to a list of all users in the group of that name.
</P
18389 >If any of the usernames begin with a '
&'then the name
18390 will be looked up only in the NIS netgroups database (if Samba
18391 is compiled with netgroup support) and will expand to a list
18392 of all users in the netgroup group of that name.
</P
18394 >Note that searching though a groups database can take
18395 quite some time, and some clients may time out during the
18398 >See the section
<A
18401 USERNAME/PASSWORD VALIDATION
</A
18402 > for more information on how
18403 this parameter determines access to the services.
</P
18407 >The guest account if a guest service,
18408 else
<empty string
>.
</B
18413 >username = fred, mary, jack, jane,
18414 @users, @pcgroup
</B
18419 NAME=
"USERNAMELEVEL"
18421 >username level (G)
</DT
18424 >This option helps Samba to try and 'guess' at
18425 the real UNIX username, as many DOS clients send an all-uppercase
18426 username. By default Samba tries all lowercase, followed by the
18427 username with the first letter capitalized, and fails if the
18428 username is not found on the UNIX machine.
</P
18430 >If this parameter is set to non-zero the behavior changes.
18431 This parameter is a number that specifies the number of uppercase
18432 combinations to try while trying to determine the UNIX user name. The
18433 higher the number the more combinations will be tried, but the slower
18434 the discovery of usernames will be. Use this parameter when you have
18435 strange usernames on your UNIX machine, such as
<TT
18443 >username level =
0</B
18448 >username level =
5</B
18455 >username map (G)
</DT
18458 >This option allows you to specify a file containing
18459 a mapping of usernames from the clients to the server. This can be
18460 used for several purposes. The most common is to map usernames
18461 that users use on DOS or Windows machines to those that the UNIX
18462 box uses. The other is to map multiple users to a single username
18463 so that they can more easily share files.
</P
18465 >The map file is parsed line by line. Each line should
18466 contain a single UNIX username on the left then a '=' followed
18467 by a list of usernames on the right. The list of usernames on the
18468 right may contain names of the form @group in which case they
18469 will match any UNIX username in that group. The special client
18470 name '*' is a wildcard and matches any name. Each line of the
18471 map file may be up to
1023 characters long.
</P
18473 >The file is processed on each line by taking the
18474 supplied username and comparing it with each username on the right
18475 hand side of the '=' signs. If the supplied name matches any of
18476 the names on the right hand side then it is replaced with the name
18477 on the left. Processing then continues with the next line.
</P
18479 >If any line begins with a '#' or a ';' then it is
18482 >If any line begins with an '!' then the processing
18483 will stop after that line if a mapping was done by the line.
18484 Otherwise mapping continues with every line being processed.
18485 Using '!' is most useful when you have a wildcard mapping line
18486 later in the file.
</P
18488 >For example to map from the name
<TT
18495 > to the UNIX name
<TT
18498 > you would use:
</P
18502 >root = admin administrator
</B
18505 >Or to map anyone in the UNIX group
<TT
18509 to the UNIX name
<TT
18512 > you would use:
</P
18519 >You can have as many mappings as you like in a username
18522 >If your system supports the NIS NETGROUP option then
18523 the netgroup database is checked before the
<TT
18527 > database for matching groups.
</P
18529 >You can map Windows usernames that have spaces in them
18530 by using double quotes around the name. For example:
</P
18534 >tridge =
"Andrew Tridgell"</B
18537 >would map the windows username
"Andrew Tridgell" to the
18538 unix username
"tridge".
</P
18540 >The following example would map mary and fred to the
18541 unix user sys, and map the rest to guest. Note the use of the
18542 '!' to tell Samba to stop processing if it gets a match on
18552 CLASS=
"PROGRAMLISTING"
18561 >Note that the remapping is applied to all occurrences
18562 of usernames. Thus if you connect to \\server\fred and
<TT
18565 > is remapped to
<TT
18569 will actually be connecting to \\server\mary and will need to
18570 supply a password suitable for
<TT
18577 >. The only exception to this is the
18578 username passed to the
<A
18579 HREF=
"#PASSWORDSERVER"
18583 > password server
</I
18586 > (if you have one). The password
18587 server will receive whatever username the client supplies without
18590 >Also note that no reverse mapping is done. The main effect
18591 this has is with printing. Users who have been mapped may have
18592 trouble deleting print jobs as PrintManager under WfWg will think
18593 they don't own the print job.
</P
18596 >no username map
</EM
18601 >username map = /usr/local/samba/lib/users.map
18612 >This boolean parameter is only available if
18613 Samba has been configured and compiled with the option
<B
18619 > then Samba will attempt
18620 to add utmp or utmpx records (depending on the UNIX system) whenever a
18621 connection is made to a Samba server. Sites may use this to record the
18622 user connecting to a Samba share.
</P
18625 HREF=
"#UTMPDIRECTORY"
18629 > utmp directory
</I
18641 NAME=
"UTMPDIRECTORY"
18643 >utmp directory(G)
</DT
18646 >This parameter is only available if Samba has
18647 been configured and compiled with the option
<B
18650 >. It specifies a directory pathname that is
18651 used to store the utmp or utmpx files (depending on the UNIX system) that
18652 record user connections to a Samba server. See also the
<A
18660 > parameter. By default this is
18661 not set, meaning the system will use whatever utmp file the
18662 native system is set to use (usually
18669 >no utmp directory
</EM
18676 >valid chars (G)
</DT
18679 >The option allows you to specify additional
18680 characters that should be considered valid by the server in
18681 filenames. This is particularly useful for national character
18682 sets, such as adding u-umlaut or a-ring.
</P
18684 >The option takes a list of characters in either integer
18685 or character form with spaces between them. If you give two
18686 characters with a colon between them then it will be taken as
18687 an lowercase:uppercase pair.
</P
18689 >If you have an editor capable of entering the characters
18690 into the config file then it is probably easiest to use this
18691 method. Otherwise you can specify the characters in octal,
18692 decimal or hexadecimal form using the usual C notation.
</P
18694 >For example to add the single character 'Z' to the charset
18695 (which is a pointless thing to do as it's already there) you could
18696 do one of the following
</P
18705 CLASS=
"PROGRAMLISTING"
18708 valid chars =
0132:
0172
18715 >The last two examples above actually add two characters,
18716 and alter the uppercase and lowercase mappings appropriately.
</P
18720 > specify this parameter
18724 >client code page
</I
18727 have both set. If
<TT
18730 >client code page
</I
18738 > parameter the
<TT
18744 > settings will be overwritten.
</P
18747 HREF=
"#CLIENTCODEPAGE"
18758 >Samba defaults to using a reasonable set
18759 of valid characters for English systems
</EM
18764 >valid chars =
0345:
0305 0366:
0326 0344:
0304
18768 >The above example allows filenames to have the Swedish
18769 characters in them.
</P
18773 > It is actually quite difficult to
18774 correctly produce a
<TT
18780 a particular system. To automate the process
<A
18781 HREF=
"mailto:tino@augsburg.net"
18783 >tino@augsburg.net
</A
18785 a package called
<B
18788 > which will automatically
18789 produce a complete
<TT
18795 a given client system. Look in the
<TT
18797 >examples/validchars/
18799 > subdirectory of your Samba source code distribution
18800 for this package.
</P
18806 >valid users (S)
</DT
18809 >This is a list of users that should be allowed
18810 to login to this service. Names starting with '@', '+' and '
&'
18811 are interpreted using the same rules as described in the
18819 >If this is empty (the default) then any user can login.
18820 If a username is in both this list and the
<TT
18826 > list then access is denied for that user.
</P
18828 >The current servicename is substituted for
<TT
18834 >. This is useful in the [homes] section.
</P
18837 HREF=
"#INVALIDUSERS"
18848 >No valid users list (anyone can login)
18854 >valid users = greg, @pcusers
</B
18864 >This is a list of files and directories that
18865 are neither visible nor accessible. Each entry in the list must
18866 be separated by a '/', which allows spaces to be included
18867 in the entry. '*' and '?' can be used to specify multiple files
18868 or directories as in DOS wildcards.
</P
18870 >Each entry must be a unix path, not a DOS path and
18873 > include the unix directory
18882 is applicable in vetoing files.
</P
18884 >One feature of the veto files parameter that it
18885 is important to be aware of is Samba's behaviour when
18886 trying to delete a directory. If a directory that is
18887 to be deleted contains nothing but veto files this
18890 > unless you also set
18894 >delete veto files
</I
18904 >Setting this parameter will affect the performance
18905 of Samba, as it will be forced to check all files and directories
18906 for a match as they are scanned.
</P
18918 HREF=
"#CASESENSITIVE"
18922 > case sensitive
</I
18928 >No files or directories are vetoed.
18939 CLASS=
"PROGRAMLISTING"
18940 >; Veto any files containing the word Security,
18941 ; any ending in .tmp, and any directory containing the
18943 veto files = /*Security*/*.tmp/*root*/
18945 ; Veto the Apple specific files that a NetAtalk server
18947 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
</PRE
18955 NAME=
"VETOOPLOCKFILES"
18957 >veto oplock files (S)
</DT
18960 >This parameter is only valid when the
<A
18969 parameter is turned on for a share. It allows the Samba administrator
18970 to selectively turn off the granting of oplocks on selected files that
18971 match a wildcarded list, similar to the wildcarded list used in the
18984 >No files are vetoed for oplock
18988 >You might want to do this on files that you know will
18989 be heavily contended for by clients. A good example of this
18990 is in the NetBench SMB benchmark program, which causes heavy
18991 client contention for files ending in
<TT
18995 To cause Samba not to grant oplocks on these files you would use
18996 the line (either in the [global] section or in the section for
18997 the particular NetBench share :
</P
19001 >veto oplock files = /*.SEM/
19009 >vfs object (S)
</DT
19012 >This parameter specifies a shared object file that
19013 is used for Samba VFS I/O operations. By default, normal
19014 disk I/O operations are used but these can be overloaded
19015 with a VFS object. The Samba VFS layer is new to Samba
2.2 and
19016 must be enabled at compile time with --with-vfs.
</P
19026 >vfs options (S)
</DT
19029 >This parameter allows parameters to be passed
19030 to the vfs layer at initialization time. The Samba VFS layer
19031 is new to Samba
2.2 and must be enabled at compile time
19032 with --with-vfs. See also
<A
19053 > This allows you to override the volume label
19054 returned for a share. Useful for CDROMs with installation programs
19055 that insist on a particular volume label.
</P
19058 >the name of the share
</EM
19065 >wide links (S)
</DT
19068 >This parameter controls whether or not links
19069 in the UNIX file system may be followed by the server. Links
19070 that point to areas within the directory tree exported by the
19071 server are always allowed; this parameter controls access only
19072 to areas that are outside the directory tree being exported.
</P
19074 >Note that setting this parameter can have a negative
19075 effect on your server performance due to the extra system calls
19076 that Samba has to do in order to perform the link checks.
</P
19080 >wide links = yes
</B
19085 NAME=
"WINBINDCACHETIME"
19087 >winbind cache time (G)
</DT
19090 >This parameter specifies the number of seconds the
19092 HREF=
"winbindd.8.html"
19095 > daemon will cache
19096 user and group information before querying a Windows NT server
19101 >winbind cache type =
15</B
19106 NAME=
"WINBINDENUMUSERS"
19108 >winbind enum users (G)
</DT
19111 >On large installations using
19113 HREF=
"winbindd.8.html"
19117 necessary to suppress the enumeration of users through the
19129 > group of system calls. If
19133 >winbind enum users
</I
19143 will not return any data.
</P
19148 enumeration may cause some programs to behave oddly. For
19149 example, the finger program relies on having access to the
19150 full user list when searching for matching
19155 >winbind enum users = yes
</B
19160 NAME=
"WINBINDENUMGROUPS"
19162 >winbind enum groups (G)
</DT
19165 >On large installations using
19167 HREF=
"winbindd.8.html"
19171 necessary to suppress the enumeration of groups through the
19183 > group of system calls. If
19187 >winbind enum groups
</I
19197 call will not return any data.
</P
19201 > Turning off group
19202 enumeration may cause some programs to behave oddly.
19207 >winbind enum groups = yes
</B
19215 >winbind gid (G)
</DT
19218 >The winbind gid parameter specifies the range of group
19219 ids that are allocated by the
<A
19220 HREF=
"winbindd.8.html"
19223 > daemon. This range of group ids should have no
19224 existing local or NIS groups within it as strange conflicts can
19225 occur otherwise.
</P
19229 >winbind gid =
<empty string
>
19235 >winbind gid =
10000-
20000</B
19240 NAME=
"WINBINDSEPARATOR"
19242 >winbind separator (G)
</DT
19245 >This parameter allows an admin to define the character
19246 used when listing a username of the form of
<TT
19247 CLASS=
"REPLACEABLE"
19253 CLASS=
"REPLACEABLE"
19258 is only applicable when using the
<TT
19260 >pam_winbind.so
</TT
19264 >nss_winbind.so
</TT
19265 > modules for UNIX services.
19268 >Please note that setting this parameter to + causes problems
19269 with group membership at least on glibc systems, as the character +
19270 is used as a special character for NIS in /etc/group.
</P
19274 >winbind separator = '\'
</B
19279 >winbind separator = +
</B
19286 >winbind uid (G)
</DT
19289 >The winbind gid parameter specifies the range of group
19290 ids that are allocated by the
<A
19291 HREF=
"winbindd.8.html"
19294 > daemon. This range of ids should have no
19295 existing local or NIS users within it as strange conflicts can
19296 occur otherwise.
</P
19300 >winbind uid =
<empty string
>
19306 >winbind uid =
10000-
20000</B
19310 >winbind use default domain,
<A
19311 NAME=
"WINBINDUSEDEFAULTDOMAIN"
19313 >winbind use default domain
</DT
19316 >This parameter specifies whether the
<A
19317 HREF=
"winbindd.8.html"
19321 daemon should operate on users without domain component in their username.
19322 Users without a domain component are treated as is part of the winbindd server's
19323 own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail
19324 function in a way much closer to the way they would in a native unix system.
</P
19328 >winbind use default domain =
<no
>
19334 >winbind use default domain = yes
</B
19344 >When Samba is running as a WINS server this
19345 allows you to call an external program for all changes to the
19346 WINS database. The primary use for this option is to allow the
19347 dynamic update of external name resolution databases such as
19350 >The wins hook parameter specifies the name of a script
19351 or executable that will be called as follows:
</P
19355 >wins_hook operation name nametype ttl IP_list
19363 >The first argument is the operation and is one
19364 of
"add",
"delete", or
"refresh". In most cases the operation can
19365 be ignored as the rest of the parameters provide sufficient
19366 information. Note that
"refresh" may sometimes be called when the
19367 name has not previously been added, in that case it should be treated
19372 >The second argument is the NetBIOS name. If the
19373 name is not a legal name then the wins hook is not called.
19374 Legal names contain only letters, digits, hyphens, underscores
19379 >The third argument is the NetBIOS name
19380 type as a
2 digit hexadecimal number.
</P
19384 >The fourth argument is the TTL (time to live)
19385 for the name in seconds.
</P
19389 >The fifth and subsequent arguments are the IP
19390 addresses currently registered for that name. If this list is
19391 empty then the name should be deleted.
</P
19395 >An example script that calls the BIND dynamic DNS update
19399 > is provided in the examples
19400 directory of the Samba source code.
</P
19406 >wins proxy (G)
</DT
19409 >This is a boolean that controls if
<A
19413 > will respond to broadcast name
19414 queries on behalf of other hosts. You may need to set this
19418 > for some older clients.
</P
19422 >wins proxy = no
</B
19429 >wins server (G)
</DT
19432 >This specifies the IP address (or DNS name: IP
19433 address for preference) of the WINS server that
<A
19437 > should register with. If you have a WINS server on
19438 your network then you should set this to the WINS server's IP.
</P
19440 >You should point this at your WINS server if you have a
19441 multi-subnetted network.
</P
19445 >. You need to set up Samba to point
19446 to a WINS server if you have multiple subnets and wish cross-subnet
19447 browsing to work correctly.
</P
19449 >See the documentation file
<TT
19453 in the docs/ directory of your Samba source distribution.
</P
19461 >wins server =
192.9.200.1</B
19468 >wins support (G)
</DT
19471 >This boolean controls if the
<A
19476 > process in Samba will act as a WINS server. You should
19477 not set this to
<TT
19480 > unless you have a multi-subnetted network and
19481 you wish a particular
<B
19484 > to be your WINS server.
19485 Note that you should
<EM
19491 on more than one machine in your network.
</P
19495 >wins support = no
</B
19505 >This controls what workgroup your server will
19506 appear to be in when queried by clients. Note that this parameter
19507 also controls the Domain name used with the
<A
19508 HREF=
"#SECURITYEQUALSDOMAIN"
19511 >security = domain
</B
19517 >set at compile time to WORKGROUP
</EM
19522 >workgroup = MYGROUP
</B
19540 > for people who can't spell :-).
</P
19544 NAME=
"WRITECACHESIZE"
19546 >write cache size (S)
</DT
19549 >If this integer parameter is set to non-zero value,
19550 Samba will create an in-memory cache for each oplocked file
19554 non-oplocked files). All writes that the client does not request
19555 to be flushed directly to disk will be stored in this cache if possible.
19556 The cache is flushed onto disk when a write comes in whose offset
19557 would not fit into the cache or when the file is closed by the client.
19558 Reads for the file are also served from this cache if the data is stored
19561 >This cache allows Samba to batch client writes into a more
19562 efficient write size for RAID disks (i.e. writes may be tuned to
19563 be the RAID stripe size) and can improve performance on systems
19564 where the disk subsystem is a bottleneck but there is free
19565 memory for userspace programs.
</P
19567 >The integer parameter specifies the size of this cache
19568 (per oplocked file) in bytes.
</P
19572 >write cache size =
0</B
19577 >write cache size =
262144</B
19580 >for a
256k cache size per file.
</P
19586 >write list (S)
</DT
19589 >This is a list of users that are given read-write
19590 access to a service. If the connecting user is in this list then
19591 they will be given write access, no matter what the
<A
19600 option is set to. The list can include group names using the
19603 >Note that if a user is in both the read list and the
19604 write list then they will be given write access.
</P
19619 >write list =
<empty string
>
19625 >write list = admin, root, @staff
19636 >Inverted synonym for
<A
19653 >This parameter controls whether or not the server
19654 will support raw write SMB's when transferring data from clients.
19655 You should never need to change this parameter.
</P
19659 >write raw = yes
</B
19669 >Inverted synonym for
<A
19690 >Although the configuration file permits service names
19691 to contain spaces, your client software may not. Spaces will
19692 be ignored in comparisons anyway, so it shouldn't be a
19693 problem - but be aware of the possibility.
</P
19695 >On a similar note, many clients - especially DOS clients -
19696 limit service names to eight characters.
<A
19701 > has no such limitation, but attempts to connect from such
19702 clients will fail if they truncate the service names. For this reason
19703 you should probably keep your service names down to eight characters
19706 >Use of the [homes] and [printers] special sections make life
19707 for an administrator easy, but the various combinations of default
19708 attributes can be tricky. Take extreme care when designing these
19709 sections. In particular, ensure that the permissions on spool
19710 directories are correct.
</P
19720 >This man page is correct for version
2.2 of
19721 the Samba suite.
</P
19732 HREF=
"samba.7.html"
19737 HREF=
"smbpasswd.8.html"
19769 HREF=
"smbclient.1.html"
19777 HREF=
"nmblookup.1.html"
19785 HREF=
"testparm.1.html"
19793 HREF=
"testprns.1.html"
19810 >The original Samba software and related utilities
19811 were created by Andrew Tridgell. Samba is now developed
19812 by the Samba Team as an Open Source project similar
19813 to the way the Linux kernel is developed.
</P
19815 >The original Samba man pages were written by Karl Auer.
19816 The man page sources were converted to YODL format (another
19817 excellent piece of Open Source software, available at
19819 HREF=
"ftp://ftp.icce.rug.nl/pub/unix/"
19821 > ftp://ftp.icce.rug.nl/pub/unix/
</A
19822 >) and updated for the Samba
2.0
19823 release by Jeremy Allison. The conversion to DocBook for
19824 Samba
2.2 was done by Gerald Carter
</P