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
2853 HREF=
"#USERNAMELEVEL"
2889 HREF=
"#UTMPDIRECTORY"
2913 HREF=
"#WINBINDCACHETIME"
2917 >winbind cache time
</I
2925 HREF=
"#WINBINDENUMUSERS"
2929 >winbind enum users
</I
2937 HREF=
"#WINBINDENUMGROUPS"
2941 >winbind enum groups
</I
2961 HREF=
"#WINBINDSEPARATOR"
2965 >winbind separator
</I
2985 HREF=
"#WINBINDUSEDEFAULTDOMAIN"
2989 >winbind use default domain
</I
3074 >COMPLETE LIST OF SERVICE PARAMETERS
</H2
3076 >Here is a list of all service parameters. See the section on
3077 each parameter for details. Note that some are synonyms.
</P
3120 HREF=
"#BLOCKINGLOCKS"
3168 HREF=
"#CASESENSITIVE"
3180 HREF=
"#CASESIGNAMES"
3264 HREF=
"#DEFAULTDEVMODE"
3276 HREF=
"#DELETEREADONLY"
3288 HREF=
"#DELETEVETOFILES"
3292 >delete veto files
</I
3324 HREF=
"#DIRECTORYMASK"
3336 HREF=
"#DIRECTORYMODE"
3348 HREF=
"#DIRECTORYSECURITYMASK"
3352 >directory security mask
</I
3384 HREF=
"#DOSFILETIMERESOLUTION"
3388 >dos filetime resolution
</I
3396 HREF=
"#DOSFILETIMES"
3420 HREF=
"#FAKEDIRECTORYCREATETIMES"
3424 >fake directory create times
</I
3444 HREF=
"#FOLLOWSYMLINKS"
3456 HREF=
"#FORCECREATEMODE"
3460 >force create mode
</I
3468 HREF=
"#FORCEDIRECTORYMODE"
3472 >force directory mode
</I
3480 HREF=
"#FORCEDIRECTORYSECURITYMODE"
3484 >force directory security mode
</I
3504 HREF=
"#FORCESECURITYMODE"
3508 >force security mode
</I
3516 HREF=
"#FORCEUNKNOWNACLUSER"
3520 >force unknown acl user
</I
3564 HREF=
"#GUESTACCOUNT"
3600 HREF=
"#HIDEDOTFILES"
3672 HREF=
"#INHERITPERMISSIONS"
3676 >inherit permissions
</I
3684 HREF=
"#INVALIDUSERS"
3696 HREF=
"#LEVEL2OPLOCKS"
3720 HREF=
"#LPPAUSECOMMAND"
3744 HREF=
"#LPRESUMECOMMAND"
3748 >lpresume command
</I
3816 HREF=
"#MANGLEDNAMES"
3828 HREF=
"#MANGLINGCHAR"
3876 HREF=
"#MAXCONNECTIONS"
3888 HREF=
"#MAXPRINTJOBS"
3900 HREF=
"#MINPRINTSPACE"
3924 HREF=
"#NTACLSUPPORT"
3960 HREF=
"#OPLOCKCONTENTIONLIMIT"
3964 >oplock contention limit
</I
3996 HREF=
"#POSIXLOCKING"
4044 HREF=
"#PREEXECCLOSE"
4056 HREF=
"#PRESERVECASE"
4068 HREF=
"#PRINTCOMMAND"
4116 HREF=
"#PRINTERADMIN"
4128 HREF=
"#PRINTERDRIVER"
4140 HREF=
"#PRINTERDRIVERLOCATION"
4144 >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
4476 HREF=
"#VETOOPLOCKFILES"
4480 >veto oplock files
</I
4548 HREF=
"#WRITECACHESIZE"
4552 >write cache size
</I
4601 >EXPLANATION OF EACH PARAMETER
</H2
4605 CLASS=
"VARIABLELIST"
4609 NAME=
"ADDPRINTERCOMMAND"
4611 >add printer command (G)
</DT
4614 >With the introduction of MS-RPC based printing
4615 support for Windows NT/
2000 clients in Samba
2.2, The MS Add
4616 Printer Wizard (APW) icon is now also available in the
4617 "Printers..." folder displayed a share listing. The APW
4618 allows for printers to be add remotely to a Samba or Windows
4619 NT/
2000 print server.
</P
4621 >For a Samba host this means that the printer must be
4622 physically added to the underlying printing system. The
<TT
4628 > defines a script to be run which
4629 will perform the necessary operations for adding the printer
4630 to the print system and to add the appropriate service definition
4634 > file in order that it can be
4648 >add printer command
</I
4651 automatically invoked with the following parameter (in
4706 >Windows
9x driver location
</I
4713 >All parameters are filled in from the PRINTER_INFO_2 structure sent
4714 by the Windows NT/
2000 client with one exception. The
"Windows 9x
4715 driver location" parameter is included for backwards compatibility
4716 only. The remaining fields in the structure are generated from answers
4717 to the APW questions.
</P
4722 >add printer command
</I
4728 > will reparse the
<TT
4731 > to determine if the share defined by the APW
4732 exists. If the sharename is still invalid, then
<B
4736 > will return an ACCESS_DENIED error to the client.
</P
4739 HREF=
"#DELETEPRINTERCOMMAND"
4743 > delete printer command
</I
4756 HREF=
"#SHOWADDPRINTERWIZARD"
4772 >addprinter command = /usr/bin/addprinter
4778 NAME=
"ADDSHARECOMMAND"
4780 >add share command (G)
</DT
4783 >Samba
2.2.0 introduced the ability to dynamically
4784 add and delete shares via the Windows NT
4.0 Server Manager. The
4788 >add share command
</I
4790 > is used to define an
4791 external program or script which will add a new service definition
4795 >. In order to successfully
4799 >add share command
</I
4805 requires that the administrator be connected using a root account (i.e.
4812 > will automatically invoke the
4816 >add share command
</I
4818 > with four parameters.
4844 > - the name of the new
4855 > - path to an **existing**
4866 > - comment string to associate
4872 > This parameter is only used for add file shares. To add printer shares,
4874 HREF=
"#ADDPRINTERCOMMAND"
4886 HREF=
"#CHANGESHARECOMMAND"
4895 HREF=
"#DELETESHARECOMMAND"
4912 >add share command = /usr/local/bin/addshare
</B
4917 NAME=
"ADDUSERSCRIPT"
4919 >add user script (G)
</DT
4922 >This is the full pathname to a script that will
4930 > under special circumstances described below.
</P
4932 >Normally, a Samba server requires that UNIX users are
4933 created for all users accessing files on this server. For sites
4934 that use Windows NT account databases as their primary user database
4935 creating these users and keeping the user list in sync with the
4936 Windows NT PDC is an onerous task. This option allows
<A
4940 > to create the required UNIX users
4943 > when a user accesses the Samba server.
</P
4945 >In order to use this option,
<A
4955 >security = share
</I
4964 must be set to a full pathname for a script that will create a UNIX
4965 user given one argument of
<TT
4970 >, which expands into
4971 the UNIX user name to create.
</P
4973 >When the Windows user attempts to access the Samba server,
4974 at login (session setup in the SMB protocol) time,
<A
4984 attempts to authenticate the given user with the given password. If the
4985 authentication succeeds then
<B
4989 attempts to find a UNIX user in the UNIX password database to map the
4990 Windows user into. If this lookup fails, and
<TT
5000 call the specified script
<EM
5008 > argument to be the user name to create.
</P
5010 >If this script successfully creates the user then
<B
5014 > will continue on as though the UNIX user
5015 already existed. In this way, UNIX users are dynamically created to
5016 match existing Windows NT accounts.
</P
5027 HREF=
"#PASSWORDSERVER"
5036 HREF=
"#DELETEUSERSCRIPT"
5048 >add user script =
<empty string
>
5054 >add user script = /usr/local/samba/bin/add_user
5062 >admin users (S)
</DT
5065 >This is a list of users who will be granted
5066 administrative privileges on the share. This means that they
5067 will do all file operations as the super-user (root).
</P
5069 >You should use this option very carefully, as any user in
5070 this list will be able to do anything they like on the share,
5071 irrespective of file permissions.
</P
5079 >admin users = jason
</B
5086 >allow hosts (S)
</DT
5101 NAME=
"ALLOWTRUSTEDDOMAINS"
5103 >allow trusted domains (G)
</DT
5106 >This option only takes effect when the
<A
5122 If it is set to no, then attempts to connect to a resource from
5123 a domain or workgroup other than the one which
<A
5128 in will fail, even if that domain is trusted by the remote server
5129 doing the authentication.
</P
5131 >This is useful if you only want your Samba server to
5132 serve resources to users in the domain it is a member of. As
5133 an example, suppose that there are two domains DOMA and DOMB. DOMB
5134 is trusted by DOMA, which contains the Samba server. Under normal
5135 circumstances, a user with an account in DOMB can then access the
5136 resources of a UNIX account with the same account name on the
5137 Samba server even if they do not have an account in DOMA. This
5138 can make implementing a security boundary difficult.
</P
5142 >allow trusted domains = yes
</B
5149 >announce as (G)
</DT
5152 >This specifies what type of server
5161 will announce itself as, to a network neighborhood browse
5162 list. By default this is set to Windows NT. The valid options
5163 are :
"NT Server" (which can also be written as
"NT"),
5164 "NT Workstation",
"Win95" or
"WfW" meaning Windows NT Server,
5165 Windows NT Workstation, Windows
95 and Windows for Workgroups
5166 respectively. Do not change this parameter unless you have a
5167 specific need to stop Samba appearing as an NT server as this
5168 may prevent Samba servers from participating as browser servers
5173 >announce as = NT Server
</B
5178 >announce as = Win95
</B
5183 NAME=
"ANNOUNCEVERSION"
5185 >announce version (G)
</DT
5188 >This specifies the major and minor version numbers
5189 that nmbd will use when announcing itself as a server. The default
5190 is
4.9. Do not change this parameter unless you have a specific
5191 need to set a Samba server to be a downlevel server.
</P
5195 >announce version =
4.9</B
5200 >announce version =
2.0</B
5207 >auto services (G)
</DT
5210 >This is a synonym for the
<A
5227 >This parameter lets you
"turn off" a service. If
5236 attempts to connect to the service will fail. Such failures are
5246 NAME=
"BINDINTERFACESONLY"
5248 >bind interfaces only (G)
</DT
5251 >This global parameter allows the Samba admin
5252 to limit what interfaces on a machine will serve SMB requests. If
5253 affects file service
<A
5265 >For name service it causes
<B
5269 to ports
137 and
138 on the interfaces listed in the
<A
5276 > also binds to the
"all addresses" interface (
0.0.0.0)
5277 on ports
137 and
138 for the purposes of reading broadcast messages.
5278 If this option is not set then
<B
5282 name requests on all of these sockets. If
<TT
5292 source address of any packets coming in on the broadcast sockets
5293 and discard any that don't match the broadcast addresses of the
5294 interfaces in the
<TT
5300 As unicast packets are received on the other sockets it allows
5304 > to refuse to serve names to machines that
5305 send packets that arrive through any interfaces not listed in the
5311 > list. IP Source address spoofing
5312 does defeat this simple check, however so it must not be used
5313 seriously as a security feature for
<B
5318 >For file service it causes
<A
5323 to bind only to the interface list given in the
<A
5326 > parameter. This restricts the networks that
5330 > will serve to packets coming in those
5331 interfaces. Note that you should not use this parameter for machines
5332 that are serving PPP or other intermittent or non-broadcast network
5333 interfaces as it will not cope with non-permanent interfaces.
</P
5338 >bind interfaces only
</I
5341 unless the network address
<EM
5350 HREF=
"smbpasswd.8.html"
5365 not work as expected due to the reasons covered below.
</P
5367 >To change a users SMB password, the
<B
5371 by default connects to the
<EM
5372 >localhost -
127.0.0.1</EM
5374 address as an SMB client to issue the password change request. If
5378 >bind interfaces only
</I
5380 > is set then unless the
5389 > parameter list then
<B
5392 > will fail to connect in it's default mode.
5396 > can be forced to use the primary IP interface
5397 of the local host by using its
<A
5398 HREF=
"smbpasswd.8.html#minusr"
5412 > parameter, with
<TT
5418 to the IP name of the primary interface of the local host.
</P
5423 > status page tries to connect with
5433 > to determine if they are running.
5443 "not running" even if they really are. This can prevent
<B
5446 > from starting/stopping/restarting
<B
5457 >bind interfaces only = no
</B
5467 >This parameter controls the behavior of
<A
5471 > when reporting disk free sizes.
5472 By default, this reports a disk block size of
1024 bytes.
</P
5474 >Changing this parameter may have some effect on the
5475 efficiency of client writes, this is not yet confirmed. This
5476 parameter was added to allow advanced administrators to change
5477 it (usually to a higher value) and test the effect it has on
5478 client write performance without re-compiling the code. As this
5479 is an experimental option it may be removed in a future release.
5482 >Changing this option does not change the disk free reporting
5483 size, just the block size unit reported to the client.
</P
5487 >block size =
1024</B
5492 >block size =
65536</B
5497 NAME=
"BLOCKINGLOCKS"
5499 >blocking locks (S)
</DT
5502 >This parameter controls the behavior of
<A
5506 > when given a request by a client
5507 to obtain a byte range lock on a region of an open file, and the
5508 request has a time limit associated with it.
</P
5510 >If this parameter is set and the lock range requested
5511 cannot be immediately satisfied, Samba
2.2 will internally
5512 queue the lock request, and periodically attempt to obtain
5513 the lock until the timeout period expires.
</P
5515 >If this parameter is set to
<TT
5519 Samba
2.2 will behave as previous versions of Samba would and
5520 will fail the lock request immediately if the lock range
5521 cannot be obtained.
</P
5525 >blocking locks = yes
</B
5549 >browse list (G)
</DT
5552 >This controls whether
<A
5559 > will serve a browse list to
5567 >. You should never need to change
5572 >browse list = yes
</B
5582 >This controls whether this share is seen in
5583 the list of available shares in a net view and in the browse list.
</P
5587 >browseable = yes
</B
5592 NAME=
"CASESENSITIVE"
5594 >case sensitive (S)
</DT
5597 >See the discussion in the section
<A
5604 >case sensitive = no
</B
5611 >casesignames (S)
</DT
5615 HREF=
"#CASESENSITIVE"
5622 NAME=
"CHANGENOTIFYTIMEOUT"
5624 >change notify timeout (G)
</DT
5627 >This SMB allows a client to tell a server to
5628 "watch" a particular directory for any changes and only reply to
5629 the SMB request when a change has occurred. Such constant scanning of
5630 a directory is expensive under UNIX, hence an
<A
5637 > daemon only performs such a scan
5638 on each requested directory once every
<TT
5648 >change notify timeout =
60</B
5653 >change notify timeout =
300</B
5656 >Would change the scan time to every
5 minutes.
</P
5660 NAME=
"CHANGESHARECOMMAND"
5662 >change share command (G)
</DT
5665 >Samba
2.2.0 introduced the ability to dynamically
5666 add and delete shares via the Windows NT
4.0 Server Manager. The
5670 >change share command
</I
5672 > is used to define an
5673 external program or script which will modify an existing service definition
5677 >. In order to successfully
5681 >change share command
</I
5687 requires that the administrator be connected using a root account (i.e.
5694 > will automatically invoke the
5698 >change share command
</I
5700 > with four parameters.
5726 > - the name of the new
5737 > - path to an **existing**
5748 > - comment string to associate
5754 > This parameter is only used modify existing file shares definitions. To modify
5755 printer shares, use the
"Printers..." folder as seen when browsing the Samba host.
5759 HREF=
"#ADDSHARECOMMAND"
5768 HREF=
"#DELETESHARECOMMAND"
5785 >change share command = /usr/local/bin/addshare
</B
5792 >character set (G)
</DT
5799 > to map incoming filenames
5800 from a DOS Code page (see the
<A
5801 HREF=
"#CLIENTCODEPAGE"
5804 > parameter) to several built in UNIX character sets.
5805 The built in code page translations are:
</P
5814 > : Western European
5815 UNIX character set. The parameter
<TT
5818 >client code page
</I
5823 > be set to code page
850 if the
5829 > parameter is set to
5833 > in order for the conversion to the
5834 UNIX character set to be done correctly.
</P
5841 > : Eastern European
5842 UNIX character set. The parameter
<TT
5850 > be set to code page
852 if
5860 > in order for the conversion
5861 to the UNIX character set to be done correctly.
</P
5868 > : Russian Cyrillic
5869 UNIX character set. The parameter
<TT
5877 > be set to code page
5887 > in order for the conversion
5888 to the UNIX character set to be done correctly.
</P
5896 character set. The parameter
<TT
5904 > be set to code page
5914 > in order for the conversion
5915 to the UNIX character set to be done correctly.
</P
5922 > : Alternate mapping
5923 for Russian Cyrillic UNIX character set. The parameter
5927 >client code page
</I
5932 be set to code page
866 if the
<TT
5938 parameter is set to
<TT
5942 conversion to the UNIX character set to be done correctly.
</P
5948 >. These MSDOS code page to UNIX character
5949 set mappings should be dynamic, like the loading of MS DOS code pages,
5952 >Normally this parameter is not set, meaning no filename
5953 translation is done.
</P
5957 >character set =
<empty string
></B
5962 >character set = ISO8859-
1</B
5967 NAME=
"CLIENTCODEPAGE"
5969 >client code page (G)
</DT
5972 >This parameter specifies the DOS code page
5973 that the clients accessing Samba are using. To determine what code
5974 page a Windows or DOS client is using, open a DOS command prompt
5975 and type the command
<B
5979 the code page. The default for USA MS-DOS, Windows
95, and
5980 Windows NT releases is code page
437. The default for western
5981 European releases of the above operating systems is code page
850.
</P
5983 >This parameter tells
<A
5997 > files to dynamically load on startup. These files,
5998 described more fully in the manual page
<A
5999 HREF=
"make_smbcodepage.1.html"
6003 >make_smbcodepage(
1)
</B
6008 > how to map lower to upper case characters to provide
6009 the case insensitivity of filenames that Windows clients expect.
</P
6011 >Samba currently ships with the following code page files :
</P
6017 >Code Page
437 - MS-DOS Latin US
</P
6021 >Code Page
737 - Windows '
95 Greek
</P
6025 >Code Page
850 - MS-DOS Latin
1</P
6029 >Code Page
852 - MS-DOS Latin
2</P
6033 >Code Page
861 - MS-DOS Icelandic
</P
6037 >Code Page
866 - MS-DOS Cyrillic
</P
6041 >Code Page
932 - MS-DOS Japanese SJIS
</P
6045 >Code Page
936 - MS-DOS Simplified Chinese
</P
6049 >Code Page
949 - MS-DOS Korean Hangul
</P
6053 >Code Page
950 - MS-DOS Traditional Chinese
</P
6057 >Thus this parameter may have any of the values
437,
737,
850,
852,
6058 861,
932,
936,
949, or
950. If you don't find the codepage you need,
6059 read the comments in one of the other codepage files and the
6062 >make_smbcodepage(
1)
</B
6063 > man page and write one. Please
6064 remember to donate it back to the Samba user community.
</P
6066 >This parameter co-operates with the
<TT
6072 > parameter in determining what characters are
6073 valid in filenames and how capitalization is done. If you set both
6074 this parameter and the
<TT
6083 >client code page
</I
6088 > be set before the
<TT
6094 > parameter in the
<TT
6104 augment the character settings in the
<TT
6107 >client code page
</I
6115 >client code page
</I
6130 HREF=
"#CODEPAGEDIRECTORY"
6134 >code page directory
</I
6141 >client code page =
850</B
6146 >client code page =
936</B
6151 NAME=
"CODEPAGEDIRECTORY"
6153 >code page directory (G)
</DT
6156 >Define the location of the various client code page
6160 HREF=
"#CLIENTCODEPAGE"
6172 >code page directory = ${prefix}/lib/codepages
6178 >code page directory = /usr/share/samba/codepages
6186 >coding system (G)
</DT
6189 >This parameter is used to determine how incoming
6190 Shift-JIS Japanese characters are mapped from the incoming
<A
6191 HREF=
"#CLIENTCODEPAGE"
6195 >client code page
</I
6199 > used by the client, into file names in the UNIX filesystem.
6203 >client code page
</I
6206 932 (Japanese Shift-JIS). The options are :
</P
6215 > - Shift-JIS. Does no
6216 conversion of the incoming filename.
</P
6222 >JIS8, J8BB, J8BH, J8@B,
6224 > - Convert from incoming Shift-JIS to eight
6225 bit JIS code with different shift-in, shift out codes.
</P
6231 >JIS7, J7BB, J7BH, J7@B, J7@J,
6233 > - Convert from incoming Shift-JIS to seven bit
6234 JIS code with different shift-in, shift out codes.
</P
6240 >JUNET, JUBB, JUBH, JU@B, JU@J, JU@H
</TT
6242 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
6250 > - Convert an incoming
6251 Shift-JIS character to EUC code.
</P
6258 > - Convert an incoming
6259 Shift-JIS character to a
3 byte hex representation, i.e.
6270 > - Convert an incoming
6271 Shift-JIS character to the
3 byte hex representation used by
6272 the Columbia AppleTalk Program (CAP), i.e.
<TT
6276 This is used for compatibility between Samba and CAP.
</P
6282 >coding system =
<empty value
></B
6293 >This is a text field that is seen next to a share
6294 when a client does a queries the server, either via the network
6295 neighborhood or via
<B
6298 > to list what shares
6301 >If you want to set the string that is displayed next to the
6302 machine name then see the
<A
6303 HREF=
"#SERVERSTRING"
6313 >No comment string
</EM
6318 >comment = Fred's Files
</B
6325 >config file (G)
</DT
6328 >This allows you to override the config file
6329 to use, instead of the default (usually
<TT
6333 There is a chicken and egg problem here as this option is set
6334 in the config file!
</P
6336 >For this reason, if the name of the config file has changed
6337 when the parameters are loaded then it will reload them from
6338 the new config file.
</P
6340 >This option takes the usual substitutions, which can
6343 >If the config file doesn't exist then it won't be loaded
6344 (allowing you to special case the config files of just a few
6349 >config file = /usr/local/samba/lib/smb.conf.%m
6360 >This parameter allows you to
"clone" service
6361 entries. The specified service is simply duplicated under the
6362 current service's name. Any parameters specified in the current
6363 section will override those in the section being copied.
</P
6365 >This feature lets you set up a 'template' service and
6366 create similar services easily. Note that the service being
6367 copied must occur earlier in the configuration file than the
6368 service doing the copying.
</P
6376 >copy = otherservice
</B
6383 >create mask (S)
</DT
6386 >A synonym for this parameter is
6398 >When a file is created, the necessary permissions are
6399 calculated according to the mapping from DOS modes to UNIX
6400 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
6401 with this parameter. This parameter may be thought of as a bit-wise
6402 MASK for the UNIX modes of a file. Any bit
<EM
6405 set here will be removed from the modes set on a file when it is
6408 >The default value of this parameter removes the
6409 'group' and 'other' write and execute bits from the UNIX modes.
</P
6411 >Following this Samba will bit-wise 'OR' the UNIX mode created
6412 from this parameter with the value of the
<A
6413 HREF=
"#FORCECREATEMODE"
6417 >force create mode
</I
6421 parameter which is set to
000 by default.
</P
6423 >This parameter does not affect directory modes. See the
6425 HREF=
"#DIRECTORYMODE"
6436 HREF=
"#FORCECREATEMODE"
6444 > parameter for forcing particular mode
6445 bits to be set on created files. See also the
<A
6446 HREF=
"#DIRECTORYMODE"
6453 > parameter for masking
6454 mode bits on created directories. See also the
<A
6455 HREF=
"#INHERITPERMISSIONS"
6459 >inherit permissions
</I
6464 >Note that this parameter does not apply to permissions
6465 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
6466 a mask on access control lists also, they need to set the
<A
6467 HREF=
"#SECURITYMASK"
6478 >create mask =
0744</B
6483 >create mask =
0775</B
6490 >create mode (S)
</DT
6493 >This is a synonym for
<A
6510 >This stands for
<EM
6511 >client-side caching
6513 >, and specifies how clients capable of offline
6514 caching will cache the files in the share. The valid values
6515 are: manual, documents, programs, disable.
</P
6517 >These values correspond to those used on Windows
6520 >For example, shares containing roaming profiles can have
6521 offline caching disabled using
<B
6523 >csc policy = disable
6529 >csc policy = manual
</B
6534 >csc policy = programs
</B
6544 >The value of the parameter (a decimal integer)
6545 represents the number of minutes of inactivity before a connection
6546 is considered dead, and it is disconnected. The deadtime only takes
6547 effect if the number of open files is zero.
</P
6549 >This is useful to stop a server's resources being
6550 exhausted by a large number of inactive connections.
</P
6552 >Most clients have an auto-reconnect feature when a
6553 connection is broken so in most cases this parameter should be
6554 transparent to users.
</P
6556 >Using this parameter with a timeout of a few minutes
6557 is recommended for most systems.
</P
6559 >A deadtime of zero indicates that no auto-disconnection
6560 should be performed.
</P
6574 NAME=
"DEBUGHIRESTIMESTAMP"
6576 >debug hires timestamp (G)
</DT
6579 >Sometimes the timestamps in the log messages
6580 are needed with a resolution of higher that seconds, this
6581 boolean parameter adds microsecond resolution to the timestamp
6582 message header when turned on.
</P
6584 >Note that the parameter
<A
6585 HREF=
"#DEBUGTIMESTAMP"
6589 > debug timestamp
</I
6592 > must be on for this to have an
6597 >debug hires timestamp = no
</B
6607 >When using only one log file for more then one
6612 >-process there may be hard to follow which process
6613 outputs which message. This boolean parameter is adds the process-id
6614 to the timestamp message headers in the logfile when turned on.
</P
6616 >Note that the parameter
<A
6617 HREF=
"#DEBUGTIMESTAMP"
6621 > debug timestamp
</I
6624 > must be on for this to have an
6634 NAME=
"DEBUGTIMESTAMP"
6636 >debug timestamp (G)
</DT
6639 >Samba
2.2 debug log messages are timestamped
6640 by default. If you are running at a high
<A
6649 can be distracting. This boolean parameter allows timestamping
6650 to be turned off.
</P
6654 >debug timestamp = yes
</B
6664 >Samba is sometimes run as root and sometime
6665 run as the connected user, this boolean parameter inserts the
6666 current euid, egid, uid and gid to the timestamp message headers
6667 in the log file if turned on.
</P
6669 >Note that the parameter
<A
6670 HREF=
"#DEBUGTIMESTAMP"
6674 > debug timestamp
</I
6677 > must be on for this to have an
6710 HREF=
"#DEFAULTSERVICE"
6714 > default service
</I
6723 >default case (S)
</DT
6726 >See the section on
<A
6730 HREF=
"#SHORTPRESERVECASE"
6734 >short preserve case
</I
6741 >default case = lower
</B
6746 NAME=
"DEFAULTDEVMODE"
6748 >default devmode (S)
</DT
6751 >This parameter is only applicable to
<A
6754 > services. When smbd is serving
6755 Printer Drivers to Windows NT/
2k/XP clients, each printer on the Samba
6756 server has a Device Mode which defines things such as paper size and
6757 orientation and duplex settings. The device mode can only correctly be
6758 generated by the printer driver itself (which can only be executed on a
6759 Win32 platform). Because smbd is unable to execute the driver code
6760 to generate the device mode, the default behavior is to set this field
6764 >Most problems with serving printer drivers to Windows NT/
2k/XP clients
6765 can be traced to a problem with the generated device mode. Certain drivers
6766 will do things such as crashing the client's Explorer.exe with a NULL devmode.
6767 However, other printer drivers can cause the client's spooler service
6768 (spoolsv.exe) to die if the devmode was not created by the driver itself
6769 (i.e. smbd generates a default devmode).
6772 >This parameter should be used with care and tested with the printer
6773 driver in question. It is better to leave the device mode to NULL
6774 and let the Windows client set the correct values. Because drivers do not
6775 do this all the time, setting
<B
6777 >default devmode = yes
</B
6779 will instruct smbd to generate a default one.
6782 >For more information on Windows NT/
2k printing and Device Modes,
6784 HREF=
"http://msdn.microsoft.com/"
6786 >MSDN documentation
</A
6792 >default devmode = no
</B
6797 NAME=
"DEFAULTSERVICE"
6799 >default service (G)
</DT
6802 >This parameter specifies the name of a service
6803 which will be connected to if the service actually requested cannot
6804 be found. Note that the square brackets are
<EM
6807 given in the parameter value (see example below).
</P
6809 >There is no default value for this parameter. If this
6810 parameter is not given, attempting to connect to a nonexistent
6811 service results in an error.
</P
6813 >Typically the default service would be a
<A
6831 >Also note that the apparent service name will be changed
6832 to equal that of the requested service, this is very useful as it
6833 allows you to use macros like
<TT
6839 a wildcard service.
</P
6841 >Note also that any
"_" characters in the name of the service
6842 used in the default service will get mapped to a
"/". This allows for
6843 interesting things.
</P
6854 CLASS=
"PROGRAMLISTING"
6856 default service = pub
6868 NAME=
"DELETEPRINTERCOMMAND"
6870 >delete printer command (G)
</DT
6873 >With the introduction of MS-RPC based printer
6874 support for Windows NT/
2000 clients in Samba
2.2, it is now
6875 possible to delete printer at run time by issuing the
6876 DeletePrinter() RPC call.
</P
6878 >For a Samba host this means that the printer must be
6879 physically deleted from underlying printing system. The
<TT
6882 > deleteprinter command
</I
6884 > defines a script to be run which
6885 will perform the necessary operations for removing the printer
6886 from the print system and from
<TT
6895 >delete printer command
</I
6898 automatically called with only one parameter:
<TT
6908 >delete printer command
</I
6914 > will reparse the
<TT
6917 > to associated printer no longer exists.
6918 If the sharename is still valid, then
<B
6922 > will return an ACCESS_DENIED error to the client.
</P
6925 HREF=
"#ADDPRINTERCOMMAND"
6929 > add printer command
</I
6942 HREF=
"#SHOWADDPRINTERWIZARD"
6958 >deleteprinter command = /usr/bin/removeprinter
6964 NAME=
"DELETEREADONLY"
6966 >delete readonly (S)
</DT
6969 >This parameter allows readonly files to be deleted.
6970 This is not normal DOS semantics, but is allowed by UNIX.
</P
6972 >This option may be useful for running applications such
6973 as rcs, where UNIX file ownership prevents changing file
6974 permissions, and DOS semantics prevent deletion of a read only file.
</P
6978 >delete readonly = no
</B
6983 NAME=
"DELETESHARECOMMAND"
6985 >delete share command (G)
</DT
6988 >Samba
2.2.0 introduced the ability to dynamically
6989 add and delete shares via the Windows NT
4.0 Server Manager. The
6993 >delete share command
</I
6995 > is used to define an
6996 external program or script which will remove an existing service
7000 >. In order to successfully
7004 >delete share command
</I
7010 requires that the administrator be connected using a root account (i.e.
7017 > will automatically invoke the
7021 >delete share command
</I
7023 > with two parameters.
7050 the existing service.
7055 > This parameter is only used to remove file shares. To delete printer shares,
7057 HREF=
"#DELETEPRINTERCOMMAND"
7069 HREF=
"#ADDSHARECOMMAND"
7078 HREF=
"#CHANGESHARECOMMAND"
7095 >delete share command = /usr/local/bin/delshare
</B
7100 NAME=
"DELETEUSERSCRIPT"
7102 >delete user script (G)
</DT
7105 >This is the full pathname to a script that will
7115 > under special circumstances
7118 >Normally, a Samba server requires that UNIX users are
7119 created for all users accessing files on this server. For sites
7120 that use Windows NT account databases as their primary user database
7121 creating these users and keeping the user list in sync with the
7122 Windows NT PDC is an onerous task. This option allows
<B
7125 > to delete the required UNIX users
<EM
7128 > when a user accesses the Samba server and the
7129 Windows NT user no longer exists.
</P
7131 >In order to use this option,
<B
7138 >security = domain
</I
7149 >delete user script
</I
7152 must be set to a full pathname for a script
7153 that will delete a UNIX user given one argument of
<TT
7159 which expands into the UNIX user name to delete.
</P
7161 >When the Windows user attempts to access the Samba server,
7164 > (session setup in the SMB protocol)
7169 HREF=
"#PASSWORDSERVER"
7176 > and attempts to authenticate
7177 the given user with the given password. If the authentication fails
7178 with the specific Domain error code meaning that the user no longer
7182 > attempts to find a UNIX user in
7183 the UNIX password database that matches the Windows user account. If
7184 this lookup succeeds, and
<TT
7187 >delete user script
</I
7193 > will all the specified script
7196 >, expanding any
<TT
7202 argument to be the user name to delete.
</P
7204 >This script should delete the given UNIX username. In this way,
7205 UNIX users are dynamically deleted to match existing Windows NT
7209 HREF=
"#SECURITYEQUALSDOMAIN"
7210 >security = domain
</A
7213 HREF=
"#PASSWORDSERVER"
7222 HREF=
"#ADDUSERSCRIPT"
7234 >delete user script =
<empty string
>
7240 >delete user script = /usr/local/samba/bin/del_user
7246 NAME=
"DELETEVETOFILES"
7248 >delete veto files (S)
</DT
7251 >This option is used when Samba is attempting to
7252 delete a directory that contains one or more vetoed directories
7262 option). If this option is set to
<TT
7265 > (the default) then if a vetoed
7266 directory contains any non-vetoed files or directories then the
7267 directory delete will fail. This is usually what you want.
</P
7269 >If this option is set to
<TT
7273 will attempt to recursively delete any files and directories within
7274 the vetoed directory. This can be useful for integration with file
7275 serving systems such as NetAtalk which create meta-files within
7276 directories you might normally veto DOS/Windows users from seeing
7284 >delete veto files = yes
</B
7286 directories to be transparently deleted when the parent directory
7287 is deleted (so long as the user has permissions to do so).
</P
7302 >delete veto files = no
</B
7327 >dfree command (G)
</DT
7336 only be used on systems where a problem occurs with the internal
7337 disk space calculations. This has been known to happen with Ultrix,
7338 but may occur with other operating systems. The symptom that was
7339 seen was an error of
"Abort Retry Ignore" at the end of each
7340 directory listing.
</P
7342 >This setting allows the replacement of the internal routines to
7343 calculate the total disk space and amount available with an external
7344 routine. The example below gives a possible script that might fulfill
7347 >The external program will be passed a single parameter indicating
7348 a directory in the filesystem being queried. This will typically consist
7352 >. The script should return two
7353 integers in ASCII. The first should be the total disk space in blocks,
7354 and the second should be the number of available blocks. An optional
7355 third return value can give the block size in bytes. The default
7356 blocksize is
1024 bytes.
</P
7358 >Note: Your script should
<EM
7361 setgid and should be owned by (and writeable only by) root!
</P
7364 >By default internal routines for
7365 determining the disk capacity and remaining space will be used.
7371 >dfree command = /usr/local/samba/bin/dfree
7375 >Where the script dfree (which must be made executable) could be:
</P
7384 CLASS=
"PROGRAMLISTING"
7387 df $
1 | tail -
1 | awk '{print $
2" "$
4}'
7394 >or perhaps (on Sys V based systems):
</P
7403 CLASS=
"PROGRAMLISTING"
7406 /usr/bin/df -k $
1 | tail -
1 | awk '{print $
3" "$
5}'
7413 >Note that you may have to replace the command names
7414 with full path names on some systems.
</P
7436 NAME=
"DIRECTORYMASK"
7438 >directory mask (S)
</DT
7441 >This parameter is the octal modes which are
7442 used when converting DOS modes to UNIX modes when creating UNIX
7445 >When a directory is created, the necessary permissions are
7446 calculated according to the mapping from DOS modes to UNIX permissions,
7447 and the resulting UNIX mode is then bit-wise 'AND'ed with this
7448 parameter. This parameter may be thought of as a bit-wise MASK for
7449 the UNIX modes of a directory. Any bit
<EM
7452 here will be removed from the modes set on a directory when it is
7455 >The default value of this parameter removes the 'group'
7456 and 'other' write bits from the UNIX mode, allowing only the
7457 user who owns the directory to modify it.
</P
7459 >Following this Samba will bit-wise 'OR' the UNIX mode
7460 created from this parameter with the value of the
<A
7461 HREF=
"#FORCEDIRECTORYMODE"
7465 >force directory mode
7469 > parameter. This parameter is set to
000 by
7470 default (i.e. no extra mode bits are added).
</P
7472 >Note that this parameter does not apply to permissions
7473 set by Windows NT/
2000 ACL editors. If the administrator wishes to enforce
7474 a mask on access control lists also, they need to set the
<A
7475 HREF=
"#DIRECTORYSECURITYMASK"
7479 >directory security mask
</I
7485 HREF=
"#FORCEDIRECTORYMODE"
7493 > parameter to cause particular mode
7494 bits to always be set on created directories.
</P
7505 > parameter for masking mode bits on created files,
7507 HREF=
"#DIRECTORYSECURITYMASK"
7517 >Also refer to the
<A
7518 HREF=
"#INHERITPERMISSIONS"
7522 > inherit permissions
</I
7529 >directory mask =
0755</B
7534 >directory mask =
0775</B
7539 NAME=
"DIRECTORYMODE"
7541 >directory mode (S)
</DT
7545 HREF=
"#DIRECTORYMASK"
7556 NAME=
"DIRECTORYSECURITYMASK"
7558 >directory security mask (S)
</DT
7561 >This parameter controls what UNIX permission bits
7562 can be modified when a Windows NT client is manipulating the UNIX
7563 permission on a directory using the native NT security dialog
7566 >This parameter is applied as a mask (AND'ed with) to
7567 the changed permission bits, thus preventing any bits not in
7568 this mask from being modified. Essentially, zero bits in this
7569 mask may be treated as a set of bits the user is not allowed
7572 >If not set explicitly this parameter is set to
0777
7573 meaning a user is allowed to modify all the user/group/world
7574 permissions on a directory.
</P
7578 > that users who can access the
7579 Samba server through other means can easily bypass this restriction,
7580 so it is primarily useful for standalone
"appliance" systems.
7581 Administrators of most normal systems will probably want to leave
7582 it as the default of
<TT
7588 HREF=
"#FORCEDIRECTORYSECURITYMODE"
7592 > force directory security mode
</I
7596 HREF=
"#SECURITYMASK"
7605 HREF=
"#FORCESECURITYMODE"
7609 >force security mode
7617 >directory security mask =
0777</B
7622 >directory security mask =
0700</B
7627 NAME=
"DISABLESPOOLSS"
7629 >disable spoolss (G)
</DT
7632 >Enabling this parameter will disables Samba's support
7633 for the SPOOLSS set of MS-RPC's and will yield identical behavior
7634 as Samba
2.0.x. Windows NT/
2000 clients will downgrade to using
7635 Lanman style printing commands. Windows
9x/ME will be uneffected by
7636 the parameter. However, this will also disable the ability to upload
7637 printer drivers to a Samba server via the Windows NT Add Printer
7638 Wizard or by using the NT printer properties dialog window. It will
7639 also disable the capability of Windows NT/
2000 clients to download
7640 print drivers from the Samba host upon demand.
7642 >Be very careful about enabling this parameter.
</EM
7647 HREF=
"#USECLIENTDRIVER"
7648 >use client driver
</A
7654 >disable spoolss = no
</B
7669 when acting as a WINS server and finding that a NetBIOS name has not
7670 been registered, should treat the NetBIOS name word-for-word as a DNS
7671 name and do a lookup with the DNS server for that name on behalf of
7672 the name-querying client.
</P
7674 >Note that the maximum length for a NetBIOS name is
15
7675 characters, so the DNS name (or DNS alias) can likewise only be
7676 15 characters, maximum.
</P
7681 > spawns a second copy of itself to do the
7682 DNS name lookup requests, as doing a name lookup is a blocking
7685 >See also the parameter
<A
7702 NAME=
"DOMAINADMINGROUP"
7704 >domain admin group (G)
</DT
7707 >This parameter is intended as a temporary solution
7708 to enable users to be a member of the
"Domain Admins" group when
7709 a Samba host is acting as a PDC. A complete solution will be provided
7710 by a system for mapping Windows NT/
2000 groups onto UNIX groups.
7711 Please note that this parameter has a somewhat confusing name. It
7712 accepts a list of usernames and of group names in standard
7720 HREF=
"#DOMAINGUESTGROUP"
7729 HREF=
"#DOMAINLOGONS"
7741 >no domain administrators
</EM
7746 >domain admin group = root @wheel
</B
7751 NAME=
"DOMAINGUESTGROUP"
7753 >domain guest group (G)
</DT
7756 >This parameter is intended as a temporary solution
7757 to enable users to be a member of the
"Domain Guests" group when
7758 a Samba host is acting as a PDC. A complete solution will be provided
7759 by a system for mapping Windows NT/
2000 groups onto UNIX groups.
7760 Please note that this parameter has a somewhat confusing name. It
7761 accepts a list of usernames and of group names in standard
7769 HREF=
"#DOMAINADMINGROUP"
7778 HREF=
"#DOMAINLOGONS"
7790 >no domain guests
</EM
7795 >domain guest group = nobody @guest
</B
7802 >domain logons (G)
</DT
7808 >, the Samba server will serve
7809 Windows
95/
98 Domain logons for the
<A
7817 > it is in. Samba
2.2 also
7818 has limited capability to act as a domain controller for Windows
7819 NT
4 Domains. For more details on setting up this feature see
7820 the Samba-PDC-HOWTO included in the
<TT
7824 directory shipped with the source code.
</P
7828 >domain logons = no
</B
7835 >domain master (G)
</DT
7845 > to enable WAN-wide browse list
7846 collation. Setting this option causes
<B
7850 claim a special domain specific NetBIOS name that identifies
7851 it as a domain master browser for its given
<A
7859 >. Local master browsers
7865 > on broadcast-isolated
7866 subnets will give this
<B
7869 > their local browse lists,
7878 for a complete copy of the browse list for the whole wide area
7879 network. Browser clients will then contact their local master browser,
7880 and will receive the domain-wide browse list, instead of just the list
7881 for their broadcast-isolated subnet.
</P
7883 >Note that Windows NT Primary Domain Controllers expect to be
7884 able to claim this
<TT
7890 NetBIOS name that identifies them as domain master browsers for
7896 > by default (i.e. there is no
7897 way to prevent a Windows NT PDC from attempting to do this). This
7898 means that if this parameter is set and
<B
7902 the special name for a
<TT
7908 NT PDC is able to do so then cross subnet browsing will behave
7909 strangely and may fail.
</P
7912 HREF=
"#DOMAINLOGONS"
7915 >domain logons = yes
</B
7918 >, then the default behavior is to enable the
<TT
7930 not enabled (the default setting), then neither will
<TT
7936 > be enabled by default.
</P
7940 >domain master = auto
</B
7947 >dont descend (S)
</DT
7950 >There are certain directories on some systems
7954 > tree under Linux) that are either not
7955 of interest to clients or are infinitely deep (recursive). This
7956 parameter allows you to specify a comma-delimited list of directories
7957 that the server should always show as empty.
</P
7959 >Note that Samba can be very fussy about the exact format
7960 of the
"dont descend" entries. For example you may need
<TT
7963 > instead of just
<TT
7967 Experimentation is the best policy :-)
</P
7970 >none (i.e., all directories are OK
7976 >dont descend = /proc,/dev
</B
7983 >dos filemode (S)
</DT
7986 > The default behavior in Samba is to provide
7987 UNIX-like behavior where only the owner of a file/directory is
7988 able to change the permissions on it. However, this behavior
7989 is often confusing to DOS/Windows users. Enabling this parameter
7990 allows a user who has write access to the file (by whatever
7991 means) to modify the permissions on it. Note that a user
7992 belonging to the group owning the file will not be allowed to
7993 change permissions if the group is only granted read access.
7994 Ownership of the file/directory is not changed, only the permissions
7999 >dos filemode = no
</B
8004 NAME=
"DOSFILETIMERESOLUTION"
8006 >dos filetime resolution (S)
</DT
8009 >Under the DOS and Windows FAT filesystem, the finest
8010 granularity on time resolution is two seconds. Setting this parameter
8011 for a share causes Samba to round the reported time down to the
8012 nearest two second boundary when a query call that requires one second
8013 resolution is made to
<A
8023 >This option is mainly used as a compatibility option for Visual
8024 C++ when used against Samba shares. If oplocks are enabled on a
8025 share, Visual C++ uses two different time reading calls to check if a
8026 file has changed since it was last read. One of these calls uses a
8027 one-second granularity, the other uses a two second granularity. As
8028 the two second call rounds any odd second down, then if the file has a
8029 timestamp of an odd number of seconds then the two timestamps will not
8030 match and Visual C++ will keep reporting the file has changed. Setting
8031 this option causes the two timestamps to match, and Visual C++ is
8036 >dos filetime resolution = no
</B
8043 >dos filetimes (S)
</DT
8046 >Under DOS and Windows, if a user can write to a
8047 file they can change the timestamp on it. Under POSIX semantics,
8048 only the owner of the file or root may change the timestamp. By
8049 default, Samba runs with POSIX semantics and refuses to change the
8050 timestamp on a file if the user
<B
8054 on behalf of is not the file owner. Setting this option to
<TT
8057 > allows DOS semantics and
<A
8061 > will change the file
8062 timestamp as DOS requires.
</P
8066 >dos filetimes = no
</B
8071 NAME=
"ENCRYPTPASSWORDS"
8073 >encrypt passwords (G)
</DT
8076 >This boolean controls whether encrypted passwords
8077 will be negotiated with the client. Note that Windows NT
4.0 SP3 and
8078 above and also Windows
98 will by default expect encrypted passwords
8079 unless a registry entry is changed. To use encrypted passwords in
8080 Samba see the file ENCRYPTION.txt in the Samba documentation
8084 > shipped with the source code.
</P
8086 >In order for encrypted passwords to work correctly
8095 have access to a local
<A
8096 HREF=
"smbpasswd.5.html"
8104 HREF=
"smbpasswd.8.html"
8110 > program for information on how to set up
8111 and maintain this file), or set the
<A
8113 >security = [server|domain]
</A
8118 > to authenticate against another
8123 >encrypt passwords = no
</B
8128 NAME=
"ENHANCEDBROWSING"
8130 >enhanced browsing (G)
</DT
8133 >This option enables a couple of enhancements to
8134 cross-subnet browse propagation that have been added in Samba
8135 but which are not standard in Microsoft implementations.
8138 >The first enhancement to browse propagation consists of a regular
8139 wildcard query to a Samba WINS server for all Domain Master Browsers,
8140 followed by a browse synchronization with each of the returned
8141 DMBs. The second enhancement consists of a regular randomised browse
8142 synchronization with all currently known DMBs.
</P
8144 >You may wish to disable this option if you have a problem with empty
8145 workgroups not disappearing from browse lists. Due to the restrictions
8146 of the browse protocols these enhancements can cause a empty workgroup
8147 to stay around forever which can be annoying.
</P
8149 >In general you should leave this option enabled as it makes
8150 cross-subnet browse propagation much more reliable.
</P
8154 >enhanced browsing = yes
</B
8159 NAME=
"ENUMPORTSCOMMAND"
8161 >enumports command (G)
</DT
8164 >The concept of a
"port" is fairly foreign
8165 to UNIX hosts. Under Windows NT/
2000 print servers, a port
8166 is associated with a port monitor and generally takes the form of
8167 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
8168 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
8171 >"Samba Printer Port"</TT
8173 Windows NT/
2000, all printers must have a valid port name.
8174 If you wish to have a list of ports displayed (
<B
8178 > does not use a port name for anything) other than
8181 >"Samba Printer Port"</TT
8186 >enumports command
</I
8189 a program which should generate a list of ports, one per line,
8190 to standard output. This listing will then be used in response
8191 to the level
1 and
2 EnumPorts() RPC.
</P
8194 >no enumports command
</EM
8199 >enumports command = /usr/bin/listports
8210 >This is a synonym for
<A
8222 NAME=
"FAKEDIRECTORYCREATETIMES"
8224 >fake directory create times (S)
</DT
8227 >NTFS and Windows VFAT file systems keep a create
8228 time for all files and directories. This is not the same as the
8229 ctime - status change time - that Unix keeps, so Samba by default
8230 reports the earliest of the various times Unix does keep. Setting
8231 this parameter for a share causes Samba to always report midnight
8232 1-
1-
1980 as the create time for directories.
</P
8234 >This option is mainly used as a compatibility option for
8235 Visual C++ when used against Samba shares. Visual C++ generated
8236 makefiles have the object directory as a dependency for each object
8237 file, and a make rule to create the directory. Also, when NMAKE
8238 compares timestamps it uses the creation time when examining a
8239 directory. Thus the object directory will be created if it does not
8240 exist, but once it does exist it will always have an earlier
8241 timestamp than the object files it contains.
</P
8243 >However, Unix time semantics mean that the create time
8244 reported by Samba will be updated whenever a file is created or
8245 or deleted in the directory. NMAKE finds all object files in
8246 the object directory. The timestamp of the last one built is then
8247 compared to the timestamp of the object directory. If the
8248 directory's timestamp if newer, then all object files
8249 will be rebuilt. Enabling this option
8250 ensures directories always predate their contents and an NMAKE build
8251 will proceed as expected.
</P
8255 >fake directory create times = no
</B
8262 >fake oplocks (S)
</DT
8265 >Oplocks are the way that SMB clients get permission
8266 from a server to locally cache file operations. If a server grants
8267 an oplock (opportunistic lock) then the client is free to assume
8268 that it is the only one accessing the file and it will aggressively
8269 cache file data. With some oplock types the client may even cache
8270 file open/close operations. This can give enormous performance benefits.
8275 >fake oplocks = yes
</B
8284 always grant oplock requests no matter how many clients are using
8287 >It is generally much better to use the real
<A
8296 than this parameter.
</P
8298 >If you enable this option on all read-only shares or
8299 shares that you know will only be accessed from one client at a
8300 time such as physically read-only media like CDROMs, you will see
8301 a big performance improvement on many operations. If you enable
8302 this option on shares where multiple clients may be accessing the
8303 files read-write at the same time you can get data corruption. Use
8304 this option carefully!
</P
8308 >fake oplocks = no
</B
8313 NAME=
"FOLLOWSYMLINKS"
8315 >follow symlinks (S)
</DT
8318 >This parameter allows the Samba administrator
8327 from following symbolic links in a particular share. Setting this
8331 > prevents any file or directory
8332 that is a symbolic link from being followed (the user will get an
8333 error). This option is very useful to stop users from adding a
8334 symbolic link to
<TT
8338 directory for instance. However it will slow filename lookups
8341 >This option is enabled (i.e.
<B
8345 follow symbolic links) by default.
</P
8349 >follow symlinks = yes
</B
8354 NAME=
"FORCECREATEMODE"
8356 >force create mode (S)
</DT
8359 >This parameter specifies a set of UNIX mode bit
8360 permissions that will
<EM
8363 file created by Samba. This is done by bitwise 'OR'ing these bits onto
8364 the mode bits of a file that is being created or having its
8365 permissions changed. The default for this parameter is (in octal)
8366 000. The modes in this parameter are bitwise 'OR'ed onto the file
8367 mode after the mask set in the
<TT
8373 parameter is applied.
</P
8375 >See also the parameter
<A
8384 > for details on masking mode bits on files.
</P
8387 HREF=
"#INHERITPERMISSIONS"
8399 >force create mode =
000</B
8404 >force create mode =
0755</B
8407 >would force all created files to have read and execute
8408 permissions set for 'group' and 'other' as well as the
8409 read/write/execute bits set for the 'user'.
</P
8413 NAME=
"FORCEDIRECTORYMODE"
8415 >force directory mode (S)
</DT
8418 >This parameter specifies a set of UNIX mode bit
8419 permissions that will
<EM
8421 > be set on a directory
8422 created by Samba. This is done by bitwise 'OR'ing these bits onto the
8423 mode bits of a directory that is being created. The default for this
8424 parameter is (in octal)
0000 which will not add any extra permission
8425 bits to a created directory. This operation is done after the mode
8426 mask in the parameter
<TT
8434 >See also the parameter
<A
8435 HREF=
"#DIRECTORYMASK"
8442 > for details on masking mode bits
8443 on created directories.
</P
8446 HREF=
"#INHERITPERMISSIONS"
8450 > inherit permissions
</I
8457 >force directory mode =
000</B
8462 >force directory mode =
0755</B
8465 >would force all created directories to have read and execute
8466 permissions set for 'group' and 'other' as well as the
8467 read/write/execute bits set for the 'user'.
</P
8471 NAME=
"FORCEDIRECTORYSECURITYMODE"
8474 security mode (S)
</DT
8477 >This parameter controls what UNIX permission bits
8478 can be modified when a Windows NT client is manipulating the UNIX
8479 permission on a directory using the native NT security dialog box.
</P
8481 >This parameter is applied as a mask (OR'ed with) to the
8482 changed permission bits, thus forcing any bits in this mask that
8483 the user may have modified to be on. Essentially, one bits in this
8484 mask may be treated as a set of bits that, when modifying security
8485 on a directory, the user has always set to be 'on'.
</P
8487 >If not set explicitly this parameter is
000, which
8488 allows a user to modify all the user/group/world permissions on a
8489 directory without restrictions.
</P
8493 > that users who can access the
8494 Samba server through other means can easily bypass this restriction,
8495 so it is primarily useful for standalone
"appliance" systems.
8496 Administrators of most normal systems will probably want to leave
8500 HREF=
"#DIRECTORYSECURITYMASK"
8504 > directory security mask
</I
8508 HREF=
"#SECURITYMASK"
8517 HREF=
"#FORCESECURITYMODE"
8521 >force security mode
8529 >force directory security mode =
0</B
8534 >force directory security mode =
700</B
8541 >force group (S)
</DT
8544 >This specifies a UNIX group name that will be
8545 assigned as the default primary group for all users connecting
8546 to this service. This is useful for sharing files by ensuring
8547 that all access to files on service will use the named group for
8548 their permissions checking. Thus, by assigning permissions for this
8549 group to the files and directories within this service the Samba
8550 administrator can restrict or allow sharing of these files.
</P
8552 >In Samba
2.0.5 and above this parameter has extended
8553 functionality in the following way. If the group name listed here
8554 has a '+' character prepended to it then the current user accessing
8555 the share only has the primary group default assigned to this group
8556 if they are already assigned as a member of that group. This allows
8557 an administrator to decide that only users who are already in a
8558 particular group will create files with group ownership set to that
8559 group. This gives a finer granularity of ownership assignment. For
8560 example, the setting
<TT
8562 >force group = +sys
</TT
8564 that only users who are already in group sys will have their default
8565 primary group assigned to sys when accessing this Samba share. All
8566 other users will retain their ordinary primary group.
</P
8577 > parameter is also set the group specified in
8583 > will override the primary group
8603 >no forced group
</EM
8608 >force group = agroup
</B
8613 NAME=
"FORCESECURITYMODE"
8615 >force security mode (S)
</DT
8618 >This parameter controls what UNIX permission
8619 bits can be modified when a Windows NT client is manipulating
8620 the UNIX permission on a file using the native NT security dialog
8623 >This parameter is applied as a mask (OR'ed with) to the
8624 changed permission bits, thus forcing any bits in this mask that
8625 the user may have modified to be on. Essentially, one bits in this
8626 mask may be treated as a set of bits that, when modifying security
8627 on a file, the user has always set to be 'on'.
</P
8629 >If not set explicitly this parameter is set to
0,
8630 and allows a user to modify all the user/group/world permissions on a file,
8631 with no restrictions.
</P
8635 > that users who can access
8636 the Samba server through other means can easily bypass this restriction,
8637 so it is primarily useful for standalone
"appliance" systems.
8638 Administrators of most normal systems will probably want to leave
8639 this set to
0000.
</P
8642 HREF=
"#FORCEDIRECTORYSECURITYMODE"
8646 > force directory security mode
</I
8651 HREF=
"#DIRECTORYSECURITYMASK"
8660 HREF=
"#SECURITYMASK"
8671 >force security mode =
0</B
8676 >force security mode =
700</B
8681 NAME=
"FORCEUNKNOWNACLUSER"
8683 >force unknown acl user (S)
</DT
8686 >If this parameter is set, a Windows NT ACL that contains
8687 an unknown SID (security descriptor, or representation of a user or group id)
8688 as the owner or group owner of the file will be silently mapped into the
8689 current UNIX uid or gid of the currently connected user.
</P
8691 >This is designed to allow Windows NT clients to copy files and
8692 folders containing ACLs that were created locally on the client machine
8693 and contain users local to that machine only (no domain users) to be
8694 copied to a Samba server (usually with XCOPY /O) and have the unknown
8695 userid and groupid of the file owner map to the current connected user.
8696 This can only be fixed correctly when winbindd allows arbitrary mapping
8697 from any Windows NT SID to a UNIX uid or gid.
</P
8699 >Try using this parameter when XCOPY /O gives an ACCESS_DENIED error.
8719 >force unknown acl user = yes
</B
8729 >This specifies a UNIX user name that will be
8730 assigned as the default user for all users connecting to this service.
8731 This is useful for sharing files. You should also use it carefully
8732 as using it incorrectly can cause security problems.
</P
8734 >This user name only gets used once a connection is established.
8735 Thus clients still need to connect as a valid user and supply a
8736 valid password. Once connected, all file operations will be performed
8737 as the
"forced user", no matter what username the client connected
8738 as. This can be very useful.
</P
8740 >In Samba
2.0.5 and above this parameter also causes the
8741 primary group of the forced user to be used as the primary group
8742 for all file activity. Prior to
2.0.5 the primary group was left
8743 as the primary group of the connecting user (this was a bug).
</P
8762 >force user = auser
</B
8772 >This parameter allows the administrator to
8773 configure the string that specifies the type of filesystem a share
8774 is using that is reported by
<A
8782 > when a client queries the filesystem type
8783 for a share. The default type is
<TT
8787 compatibility with Windows NT but this can be changed to other
8811 >getwd cache (G)
</DT
8814 >This is a tuning option. When this is enabled a
8815 caching algorithm will be used to reduce the time taken for getwd()
8816 calls. This can have a significant impact on performance, especially
8826 >parameter is set to
<TT
8833 >getwd cache = yes
</B
8858 >guest account (S)
</DT
8861 >This is a username which will be used for access
8862 to services which are specified as
<A
8870 > (see below). Whatever privileges this
8871 user has will be available to any client connecting to the guest service.
8872 Typically this user will exist in the password file, but will not
8873 have a valid login. The user account
"ftp" is often a good choice
8874 for this parameter. If a username is specified in a given service,
8875 the specified username overrides this one.
</P
8877 >One some systems the default guest account
"nobody" may not
8878 be able to print. Use another account in this case. You should test
8879 this by trying to log in as your guest user (perhaps by using the
8883 > command) and trying to print using the
8884 system print command such as
<B
8893 >specified at compile time, usually
8899 >guest account = ftp
</B
8909 >If this parameter is
<TT
8913 a service, then no password is required to connect to the service.
8914 Privileges will be those of the
<A
8915 HREF=
"#GUESTACCOUNT"
8924 >See the section below on
<A
8932 > for more information about this option.
8947 >If this parameter is
<TT
8951 a service, then only guest connections to the service are permitted.
8952 This parameter will have no effect if
<A
8960 > is not set for the service.
</P
8962 >See the section below on
<A
8970 > for more information about this option.
8982 >hide dot files (S)
</DT
8985 >This is a boolean parameter that controls whether
8986 files starting with a dot appear as hidden files.
</P
8990 >hide dot files = yes
</B
9000 >This is a list of files or directories that are not
9001 visible but are accessible. The DOS 'hidden' attribute is applied
9002 to any files or directories that match.
</P
9004 >Each entry in the list must be separated by a '/',
9005 which allows spaces to be included in the entry. '*'
9006 and '?' can be used to specify multiple files or directories
9007 as in DOS wildcards.
</P
9009 >Each entry must be a Unix path, not a DOS path and must
9010 not include the Unix directory separator '/'.
</P
9012 >Note that the case sensitivity option is applicable
9015 >Setting this parameter will affect the performance of Samba,
9016 as it will be forced to check all files and directories for a match
9017 as they are scanned.
</P
9020 HREF=
"#HIDEDOTFILES"
9037 HREF=
"#CASESENSITIVE"
9047 >no file are hidden
</EM
9053 /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</B
9056 >The above example is based on files that the Macintosh
9057 SMB client (DAVE) available from
<A
9058 HREF=
"http://www.thursby.com"
9062 > creates for internal use, and also still hides
9063 all files beginning with a dot.
</P
9067 NAME=
"HIDELOCALUSERS"
9069 >hide local users(G)
</DT
9072 >This parameter toggles the hiding of local UNIX
9073 users (root, wheel, floppy, etc) from remote clients.
</P
9077 >hide local users = no
</B
9082 NAME=
"HIDEUNREADABLE"
9084 >hide unreadable (S)
</DT
9087 >This parameter prevents clients from seeing the
9088 existance of files that cannot be read. Defaults to off.
</P
9092 >hide unreadable = no
</B
9099 >homedir map (G)
</DT
9127 > then this parameter
9128 specifies the NIS (or YP) map from which the server for the user's
9129 home directory should be extracted. At present, only the Sun
9130 auto.home map format is understood. The form of the map is:
</P
9134 >username server:/some/file/system
</B
9137 >and the program will extract the servername from before
9138 the first ':'. There should probably be a better parsing system
9139 that copes with different map formats and also Amd (another
9140 automounter) maps.
</P
9144 >A working NIS client is required on
9145 the system for this option to work.
</P
9157 HREF=
"#DOMAINLOGONS"
9169 >homedir map =
<empty string
></B
9174 >homedir map = amd.homedir
</B
9184 >This boolean parameter is only available
9185 if Samba has been configured and compiled with the
<B
9188 > option. If set to
<TT
9192 Samba will act as a Dfs server, and allow Dfs-aware clients
9193 to browse Dfs trees hosted on the server.
</P
9203 > share level parameter. For
9204 more information on setting up a Dfs tree on Samba,
9206 HREF=
"msdfs_setup.html"
9208 >msdfs_setup.html
</A
9221 >hosts allow (S)
</DT
9224 >A synonym for this parameter is
<TT
9232 >This parameter is a comma, space, or tab delimited
9233 set of hosts which are permitted to access a service.
</P
9235 >If specified in the [global] section then it will
9236 apply to all services, regardless of whether the individual
9237 service has a different setting.
</P
9239 >You can specify the hosts by name or IP number. For
9240 example, you could restrict access to only the hosts on a
9241 Class C subnet with something like
<B
9243 >allow hosts =
150.203.5.
9245 >. The full syntax of the list is described in the man
9248 >hosts_access(
5)
</TT
9249 >. Note that this man
9250 page may not be present on your system, so a brief description will
9251 be given here also.
</P
9253 >Note that the localhost address
127.0.0.1 will always
9254 be allowed access unless specifically denied by a
<A
9264 >You can also specify hosts by network/netmask pairs and
9265 by netgroup names if your system supports netgroups. The
9268 > keyword can also be used to limit a
9269 wildcard list. The following examples may provide some help:
</P
9271 >Example
1: allow all IPs in
150.203.*.*; except one
</P
9275 >hosts allow =
150.203. EXCEPT
150.203.6.66</B
9278 >Example
2: allow hosts that match the given network/netmask
</P
9282 >hosts allow =
150.203.15.0/
255.255.255.0</B
9285 >Example
3: allow a couple of hosts
</P
9289 >hosts allow = lapland, arvidsjaur
</B
9292 >Example
4: allow only hosts in NIS netgroup
"foonet", but
9293 deny access from one particular host
</P
9297 >hosts allow = @foonet
</B
9302 >hosts deny = pirate
</B
9305 >Note that access still requires suitable user-level passwords.
</P
9308 HREF=
"testparm.1.html"
9315 > for a way of testing your host access to see if it does
9319 >none (i.e., all hosts permitted access)
9325 >allow hosts =
150.203.5. myhost.mynet.edu.au
9336 >The opposite of
<TT
9342 - hosts listed here are
<EM
9344 > permitted access to
9345 services unless the specific services have their own lists to override
9346 this one. Where the lists conflict, the
<TT
9352 list takes precedence.
</P
9355 >none (i.e., no hosts specifically excluded)
9361 >hosts deny =
150.203.4. badhost.mynet.edu.au
9369 >hosts equiv (G)
</DT
9372 >If this global parameter is a non-null string,
9373 it specifies the name of a file to read for the names of hosts
9374 and users who will be allowed access without specifying a password.
9377 >This is not be confused with
<A
9385 > which is about hosts
9386 access to services and is more useful for guest services.
<TT
9391 > may be useful for NT clients which will
9392 not supply passwords to Samba.
</P
9402 > can be a major security hole. This is because you are
9403 trusting the PC to supply the correct username. It is very easy to
9404 get a PC to supply a false username. I recommend that the
9410 > option be only used if you really
9411 know what you are doing, or perhaps on a home network where you trust
9412 your spouse and kids. And only if you
<EM
9418 >no host equivalences
</EM
9423 >hosts equiv = /etc/hosts.equiv
</B
9433 >This allows you to include one config file
9434 inside another. The file is included literally, as though typed
9437 >It takes the standard substitutions, except
<TT
9457 >no file included
</EM
9462 >include = /usr/local/samba/lib/admin_smb.conf
9470 >inherit acls (S)
</DT
9473 >This parameter can be used to ensure
9474 that if default acls exist on parent directories,
9475 they are always honored when creating a subdirectory.
9476 The default behavior is to use the mode specified
9477 when creating the directory. Enabling this option
9478 sets the mode to
0777, thus guaranteeing that
9479 default directory acls are propagated.
9484 >inherit acls = no
</B
9490 NAME=
"INHERITPERMISSIONS"
9492 >inherit permissions (S)
</DT
9495 >The permissions on new files and directories
9496 are normally governed by
<A
9505 HREF=
"#DIRECTORYMASK"
9513 HREF=
"#FORCECREATEMODE"
9517 >force create mode
</I
9522 HREF=
"#FORCEDIRECTORYMODE"
9530 > but the boolean inherit
9531 permissions parameter overrides this.
</P
9533 >New directories inherit the mode of the parent directory,
9534 including bits such as setgid.
</P
9536 >New files inherit their read/write bits from the parent
9537 directory. Their execute bits continue to be determined by
9567 >Note that the setuid bit is
<EM
9570 inheritance (the code explicitly prohibits this).
</P
9572 >This can be particularly useful on large systems with
9573 many users, perhaps several thousand, to allow a single [homes]
9574 share to be used flexibly by each user.
</P
9586 HREF=
"#DIRECTORYMASK"
9594 HREF=
"#FORCECREATEMODE"
9598 >force create mode
</I
9602 HREF=
"#FORCEDIRECTORYMODE"
9606 >force directory mode
</I
9614 >inherit permissions = no
</B
9624 >This option allows you to override the default
9625 network interfaces list that Samba will use for browsing, name
9626 registration and other NBT traffic. By default Samba will query
9627 the kernel for the list of all active interfaces and use any
9628 interfaces except
127.0.0.1 that are broadcast capable.
</P
9630 >The option takes a list of interface strings. Each string
9631 can be in any of the following forms:
</P
9637 >a network interface name (such as eth0).
9638 This may include shell-like wildcards so eth* will match
9639 any interface starting with the substring
"eth"</P
9643 >an IP address. In this case the netmask is
9644 determined from the list of interfaces obtained from the
9649 >an IP/mask pair.
</P
9653 >a broadcast/mask pair.
</P
9657 >The
"mask" parameters can either be a bit length (such
9658 as
24 for a C class network) or a full netmask in dotted
9661 >The
"IP" parameters above can either be a full dotted
9662 decimal IP address or a hostname which will be looked up via
9663 the OS's normal hostname resolution mechanisms.
</P
9665 >For example, the following line:
</P
9669 >interfaces = eth0
192.168.2.10/
24 192.168.3.10/
255.255.255.0
9673 >would configure three network interfaces corresponding
9674 to the eth0 device and IP addresses
192.168.2.10 and
192.168.3.10.
9675 The netmasks of the latter two interfaces would be set to
255.255.255.0.
</P
9678 HREF=
"#BINDINTERFACESONLY"
9689 >all active interfaces except
127.0.0.1
9690 that are broadcast capable
</EM
9697 >invalid users (S)
</DT
9700 >This is a list of users that should not be allowed
9701 to login to this service. This is really a
<EM
9704 check to absolutely ensure an improper setting does not breach
9707 >A name starting with a '@' is interpreted as an NIS
9708 netgroup first (if your system supports NIS), and then as a UNIX
9709 group if the name was not found in the NIS netgroup database.
</P
9711 >A name starting with '+' is interpreted only
9712 by looking in the UNIX group database. A name starting with
9713 '
&' is interpreted only by looking in the NIS netgroup database
9714 (this requires NIS to be working on your system). The characters
9715 '+' and '
&' may be used at the start of the name in either order
9722 UNIX group database, followed by the NIS netgroup database, and
9728 > means check the NIS
9729 netgroup database, followed by the UNIX group database (the
9730 same as the '@' prefix).
</P
9732 >The current servicename is substituted for
<TT
9738 This is useful in the [homes] section.
</P
9752 >no invalid users
</EM
9757 >invalid users = root fred admin @wheel
9768 >The value of the parameter (an integer) represents
9769 the number of seconds between
<TT
9775 packets. If this parameter is zero, no keepalive packets will be
9776 sent. Keepalive packets, if sent, allow the server to tell whether
9777 a client is still present and responding.
</P
9779 >Keepalives should, in general, not be needed if the socket
9780 being used has the SO_KEEPALIVE attribute set on it (see
<A
9781 HREF=
"#SOCKETOPTIONS"
9789 Basically you should only use this option if you strike difficulties.
</P
9803 NAME=
"KERNELOPLOCKS"
9805 >kernel oplocks (G)
</DT
9808 >For UNIXes that support kernel based
<A
9817 (currently only IRIX and the Linux
2.4 kernel), this parameter
9818 allows the use of them to be turned on or off.
</P
9820 >Kernel oplocks support allows Samba
<TT
9826 > to be broken whenever a local UNIX process or NFS operation
9827 accesses a file that
<A
9835 > has oplocked. This allows complete data consistency between
9836 SMB/CIFS, NFS and local file access (and is a
<EM
9839 cool feature :-).
</P
9841 >This parameter defaults to
<TT
9844 >, but is translated
9845 to a no-op on systems that no not have the necessary kernel support.
9846 You should never need to touch this parameter.
</P
9858 HREF=
"#LEVEL2OPLOCKS"
9870 >kernel oplocks = yes
</B
9877 >lanman auth (G)
</DT
9880 >This parameter determines whether or not
<A
9885 attempt to authenticate users using the LANMAN password hash.
9886 If disabled, only clients which support NT password hashes (e.g. Windows
9887 NT/
2000 clients, smbclient, etc... but not Windows
95/
98 or the MS DOS
9888 network client) will be able to connect to the Samba host.
</P
9892 >lanman auth = yes
</B
9897 NAME=
"LARGEREADWRITE"
9899 >large readwrite (G)
</DT
9902 >This parameter determines whether or not
<A
9907 supports the new
64k streaming read and write varient SMB requests introduced
9908 with Windows
2000. Note that due to Windows
2000 client redirector bugs
9909 this requires Samba to be running on a
64-bit capable operating system such
9910 as IRIX, Solaris or a Linux
2.4 kernel. Can improve performance by
10% with
9911 Windows
2000 clients. Defaults to on. Windows NT
4.0 only supports
9912 read version of this call, and ignores the write version.
9917 >large readwrite = yes
</B
9924 >ldap admin dn (G)
</DT
9927 >This parameter is only available if Samba has been
9928 configure to include the
<B
9932 at compile time. This option should be considered experimental and
9933 under active development.
9941 > defines the Distinguished
9942 Name (DN) name used by Samba to contact the
<A
9946 > when retreiving user account information. The
<TT
9952 > is used in conjunction with the admin dn password
9955 >private/secrets.tdb
</TT
9958 HREF=
"smbpasswd.8.html"
9965 page for more information on how to accmplish this.
9976 >ldap filter (G)
</DT
9979 >This parameter is only available if Samba has been
9980 configure to include the
<B
9984 at compile time. This option should be considered experimental and
9985 under active development.
9988 > This parameter specifies the RFC
2254 compliant LDAP search filter.
9989 The default is to match the login name with the
<TT
9993 attribute for all entries matching the
<TT
9997 objectclass. Note that this filter should only return one entry.
10002 >ldap filter = (
&(uid=%u)(objectclass=sambaAccount))
</B
10012 >This parameter is only available if Samba has been
10013 configure to include the
<B
10017 at compile time. This option should be considered experimental and
10018 under active development.
10021 > This option is used to control the tcp port number used to contact
10031 The default is to use the stand LDAPS port
636.
10042 >ldap port =
636 ; if ldap ssl = on
</B
10047 >ldap port =
389 ; if ldap ssl = off
</B
10054 >ldap server (G)
</DT
10057 >This parameter is only available if Samba has been
10058 configure to include the
<B
10062 at compile time. This option should be considered experimental and
10063 under active development.
10066 > This parameter should contains the FQDN of the ldap directory
10067 server which should be queried to locate user account information.
10072 >ldap server = localhost
</B
10082 >This parameter is only available if Samba has been
10083 configure to include the
<B
10087 at compile time. This option should be considered experimental and
10088 under active development.
10091 > This option is used to define whether or not Samba should
10092 use SSL when connecting to the
<A
10104 Samba SSL support which is enabled by specifying the
10108 > option to the
<TT
10128 > can be set to one of three values:
10132 > - Always use SSL when contacting the
10142 Never use SSL when querying the directory, or (c)
<TT
10146 - Use the LDAPv3 StartTLS extended operation
10147 (RFC2830) for communicating with the directory server.
10159 >ldap suffix (G)
</DT
10162 >This parameter is only available if Samba has been
10163 configure to include the
<B
10167 at compile time. This option should be considered experimental and
10168 under active development.
10177 NAME=
"LEVEL2OPLOCKS"
10179 >level2 oplocks (S)
</DT
10182 >This parameter controls whether Samba supports
10183 level2 (read-only) oplocks on a share.
</P
10185 >Level2, or read-only oplocks allow Windows NT clients
10186 that have an oplock on a file to downgrade from a read-write oplock
10187 to a read-only oplock once a second client opens the file (instead
10188 of releasing all oplocks on a second open, as in traditional,
10189 exclusive oplocks). This allows all openers of the file that
10190 support level2 oplocks to cache the file for read-ahead only (ie.
10191 they may not cache writes or lock requests) and increases performance
10192 for many accesses of files that are not commonly written (such as
10193 application .EXE files).
</P
10195 >Once one of the clients which have a read-only oplock
10196 writes to the file all clients are notified (no reply is needed
10197 or waited for) and told to break their oplocks to
"none" and
10198 delete any read-ahead caches.
</P
10200 >It is recommended that this parameter be turned on
10201 to speed access to shared executables.
</P
10203 >For more discussions on level2 oplocks see the CIFS spec.
</P
10206 HREF=
"#KERNELOPLOCKS"
10214 > are supported then level2 oplocks are
10215 not granted (even if this parameter is set to
<TT
10228 > parameter must be set to
<TT
10231 > on this share in order for
10232 this parameter to have any effect.
</P
10256 >level2 oplocks = yes
</B
10263 >lm announce (G)
</DT
10266 >This parameter determines if
<A
10273 > will produce Lanman announce
10274 broadcasts that are needed by OS/
2 clients in order for them to see
10275 the Samba server in their browse list. This parameter can have three
10286 >. The default is
<TT
10293 > Samba will never produce these
10294 broadcasts. If set to
<TT
10297 > Samba will produce
10298 Lanman announce broadcasts at a frequency set by the parameter
10308 Samba will not send Lanman announce broadcasts by default but will
10309 listen for them. If it hears such a broadcast on the wire it will
10310 then start sending them at a frequency set by the parameter
10331 >lm announce = auto
</B
10336 >lm announce = yes
</B
10343 >lm interval (G)
</DT
10346 >If Samba is set to produce Lanman announce
10347 broadcasts needed by OS/
2 clients (see the
<A
10355 > parameter) then this
10356 parameter defines the frequency in seconds with which they will be
10357 made. If this is set to zero then no Lanman announcements will be
10358 made despite the setting of the
<TT
10379 >lm interval =
60</B
10384 >lm interval =
120</B
10389 NAME=
"LOADPRINTERS"
10391 >load printers (G)
</DT
10394 >A boolean variable that controls whether all
10395 printers in the printcap will be loaded for browsing by default.
10404 >load printers = yes
</B
10411 >local master (G)
</DT
10414 >This option allows
<A
10421 > to try and become a local master browser
10422 on a subnet. If set to
<TT
10428 > will not attempt to become a local master browser
10429 on a subnet and will also lose in all browsing elections. By
10430 default this value is set to
<TT
10433 >. Setting this value to
<TT
10437 mean that Samba will
<EM
10440 browser on a subnet, just that
<B
10445 > in elections for local master browser.
</P
10447 >Setting this value to
<TT
10456 > to become a local master browser.
</P
10460 >local master = yes
</B
10471 HREF=
"#LOCKDIRECTORY"
10475 > lock directory
</I
10482 NAME=
"LOCKDIRECTORY"
10484 >lock directory (G)
</DT
10487 >This option specifies the directory where lock
10488 files will be placed. The lock files are used to implement the
10490 HREF=
"#MAXCONNECTIONS"
10494 >max connections
</I
10502 >lock directory = ${prefix}/var/locks
</B
10507 >lock directory = /var/run/samba/locks
</B
10513 NAME=
"LOCKSPINCOUNT"
10515 >lock spin count (G)
</DT
10518 >This parameter controls the number of times
10519 that smbd should attempt to gain a byte range lock on the
10520 behalf of a client request. Experiments have shown that
10521 Windows
2k servers do not reply with a failure if the lock
10522 could not be immediately granted, but try a few more times
10523 in case the lock could later be aquired. This behavior
10524 is used to support PC database formats such as MS Access
10530 >lock spin count =
2</B
10536 NAME=
"LOCKSPINTIME"
10538 >lock spin time (G)
</DT
10541 >The time in microseconds that smbd should
10542 pause before attempting to gain a failed lock. See
10544 HREF=
"#LOCKSPINCOUNT"
10552 > for more details.
10557 >lock spin time =
10</B
10568 >This controls whether or not locking will be
10569 performed by the server in response to lock requests from the
10575 >, all lock and unlock
10576 requests will appear to succeed and all lock queries will report
10577 that the file in question is available for locking.
</P
10582 >, real locking will be performed
10587 > be useful for read-only
10588 filesystems which
<EM
10590 > not need locking (such as
10591 CDROM drives), although setting this parameter of
<TT
10595 is not really recommended even in this case.
</P
10597 >Be careful about disabling locking either globally or in a
10598 specific service, as lack of locking may result in data corruption.
10599 You should never need to set this parameter.
</P
10613 >This option allows you to override the name
10614 of the Samba log file (also known as the debug file).
</P
10616 >This option takes the standard substitutions, allowing
10617 you to have separate log files for each user or machine.
</P
10621 >log file = /usr/local/samba/var/log.%m
10632 >The value of the parameter (an integer) allows
10633 the debug level (logging level) to be specified in the
10637 > file. This is to give greater
10638 flexibility in the configuration of the system.
</P
10640 >The default will be the log level specified on
10641 the command line or level zero if none was specified.
</P
10652 >logon drive (G)
</DT
10655 >This parameter specifies the local path to
10656 which the home directory will be connected (see
<A
10665 and is only used by NT Workstations.
</P
10667 >Note that this option is only useful if Samba is set up as a
10672 >logon drive = z:
</B
10677 >logon drive = h:
</B
10684 >logon home (G)
</DT
10687 >This parameter specifies the home directory
10688 location when a Win95/
98 or NT Workstation logs into a Samba PDC.
10689 It allows you to do
</P
10697 >NET USE H: /HOME
</B
10702 >from a command prompt, for example.
</P
10704 >This option takes the standard substitutions, allowing
10705 you to have separate logon scripts for each user or machine.
</P
10707 >This parameter can be used with Win9X workstations to ensure
10708 that roaming profiles are stored in a subdirectory of the user's
10709 home directory. This is done in the following way:
</P
10713 >logon home = \\%N\%U\profile
</B
10716 >This tells Samba to return the above string, with
10717 substitutions made when a client requests the info, generally
10718 in a NetUserGetInfo request. Win9X clients truncate the info to
10719 \\server\share when a user does
<B
10723 but use the whole string when dealing with profiles.
</P
10725 >Note that in prior versions of Samba, the
<A
10733 > was returned rather than
10743 > but allowed profiles outside the home directory.
10744 The current implementation is correct, and can be used for
10745 profiles if you use the above trick.
</P
10747 >This option is only useful if Samba is set up as a logon
10752 >logon home =
"\\%N\%U"</B
10757 >logon home =
"\\remote_smb_server\%U"</B
10765 >logon path (G)
</DT
10768 >This parameter specifies the home directory
10769 where roaming profiles (NTuser.dat etc files for Windows NT) are
10770 stored. Contrary to previous versions of these manual pages, it has
10771 nothing to do with Win
9X roaming profiles. To find out how to
10772 handle roaming profiles for Win
9X system, see the
<A
10782 >This option takes the standard substitutions, allowing you
10783 to have separate logon scripts for each user or machine. It also
10784 specifies the directory from which the
"Application Data",
10794 >network neighborhood
</TT
10799 and other folders, and their contents, are loaded and displayed on
10800 your Windows NT client.
</P
10802 >The share and the path must be readable by the user for
10803 the preferences and directories to be loaded onto the Windows NT
10804 client. The share must be writeable when the user logs in for the first
10805 time, in order that the Windows NT client can create the NTuser.dat
10806 and other directories.
</P
10808 >Thereafter, the directories and any of the contents can,
10809 if required, be made read-only. It is not advisable that the
10810 NTuser.dat file be made read-only - rename it to NTuser.man to
10811 achieve the desired effect (a
<EM
10816 >Windows clients can sometimes maintain a connection to
10817 the [homes] share, even though there is no user logged in.
10818 Therefore, it is vital that the logon path does not include a
10819 reference to the homes share (i.e. setting this parameter to
10820 \%N\%U\profile_path will cause problems).
</P
10822 >This option takes the standard substitutions, allowing
10823 you to have separate logon scripts for each user or machine.
</P
10825 >Note that this option is only useful if Samba is set up
10826 as a logon server.
</P
10830 >logon path = \\%N\%U\profile
</B
10835 >logon path = \\PROFILESERVER\PROFILE\%U
</B
10842 >logon script (G)
</DT
10845 >This parameter specifies the batch file (.bat) or
10846 NT command file (.cmd) to be downloaded and run on a machine when
10847 a user successfully logs in. The file must contain the DOS
10848 style CR/LF line endings. Using a DOS-style editor to create the
10849 file is recommended.
</P
10851 >The script must be a relative path to the [netlogon]
10852 service. If the [netlogon] service specifies a
<A
10862 >/usr/local/samba/netlogon
10866 >logon script = STARTUP.BAT
</B
10868 the file that will be downloaded is:
</P
10872 >/usr/local/samba/netlogon/STARTUP.BAT
</TT
10875 >The contents of the batch file are entirely your choice. A
10876 suggested command would be to add
<B
10878 >NET TIME \\SERVER /SET
10880 >, to force every machine to synchronize clocks with
10881 the same time server. Another use would be to add
<B
10884 U: \\SERVER\UTILS
</B
10885 > for commonly used utilities, or
<B
10887 > NET USE Q: \\SERVER\ISO9001_QA
</B
10890 >Note that it is particularly important not to allow write
10891 access to the [netlogon] share, or to grant users write permission
10892 on the batch files in a secure environment, as this would allow
10893 the batch files to be arbitrarily modified and security to be
10896 >This option takes the standard substitutions, allowing you
10897 to have separate logon scripts for each user or machine.
</P
10899 >This option is only useful if Samba is set up as a logon
10903 >no logon script defined
</EM
10908 >logon script = scripts\%U.bat
</B
10913 NAME=
"LPPAUSECOMMAND"
10915 >lppause command (S)
</DT
10918 >This parameter specifies the command to be
10919 executed on the server host in order to stop printing or spooling
10920 a specific print job.
</P
10922 >This command should be a program or script which takes
10923 a printer name and job number to pause the print job. One way
10924 of implementing this is by using job priorities, where jobs
10925 having a too low priority won't be sent to the printer.
</P
10932 > is given then the printer name
10933 is put in its place. A
<TT
10939 the job number (an integer). On HPUX (see
<TT
10951 to the lpq command, the job will show up with the correct status, i.e.
10952 if the job priority is lower than the set fence priority it will
10953 have the PAUSED status, whereas if the priority is equal or higher it
10954 will have the SPOOLED or PRINTING status.
</P
10956 >Note that it is good practice to include the absolute path
10957 in the lppause command as the PATH may not be available to the server.
</P
10970 >Default: Currently no default value is given to
10971 this string, unless the value of the
<TT
10980 >, in which case the default is :
</P
10984 >lp -i %p-%j -H hold
</B
10987 >or if the value of the
<TT
10996 >, then the default is:
</P
11000 >qstat -s -j%j -h
</B
11003 >Example for HPUX:
<B
11005 >lppause command = /usr/bin/lpalt
11011 NAME=
"LPQCACHETIME"
11013 >lpq cache time (G)
</DT
11016 >This controls how long lpq info will be cached
11017 for to prevent the
<B
11020 > command being called too
11021 often. A separate cache is kept for each variation of the
<B
11024 > command used by the system, so if you use different
11028 > commands for different users then they won't
11029 share cache information.
</P
11031 >The cache files are stored in
<TT
11035 where xxxx is a hash of the
<B
11038 > command in use.
</P
11040 >The default is
10 seconds, meaning that the cached results
11041 of a previous identical
<B
11044 > command will be used
11045 if the cached data is less than
10 seconds old. A large value may
11046 be advisable if your
<B
11049 > command is very slow.
</P
11051 >A value of
0 will disable caching completely.
</P
11066 >lpq cache time =
10</B
11071 >lpq cache time =
30</B
11078 >lpq command (S)
</DT
11081 >This parameter specifies the command to be
11082 executed on the server host in order to obtain
<B
11086 >-style printer status information.
</P
11088 >This command should be a program or script which
11089 takes a printer name as its only parameter and outputs printer
11090 status information.
</P
11092 >Currently nine styles of printer status information
11093 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ.
11094 This covers most UNIX systems. You control which type is expected
11102 >Some clients (notably Windows for Workgroups) may not
11103 correctly send the connection number for the printer they are
11104 requesting status information about. To get around this, the
11105 server reports on the first printer service connected to by the
11106 client. This only happens if the connection number sent is invalid.
</P
11113 > is given then the printer name
11114 is put in its place. Otherwise it is placed at the end of the
11117 >Note that it is good practice to include the absolute path
11127 > may not be available to the server. When compiled with
11128 the CUPS libraries, no
<TT
11134 needed because smbd will make a library call to obtain the
11135 print queue listing.
</P
11149 >depends on the setting of
<TT
11159 >lpq command = /usr/bin/lpq -P%p
</B
11164 NAME=
"LPRESUMECOMMAND"
11166 >lpresume command (S)
</DT
11169 >This parameter specifies the command to be
11170 executed on the server host in order to restart or continue
11171 printing or spooling a specific print job.
</P
11173 >This command should be a program or script which takes
11174 a printer name and job number to resume the print job. See
11176 HREF=
"#LPPAUSECOMMAND"
11191 > is given then the printer name
11192 is put in its place. A
<TT
11198 the job number (an integer).
</P
11200 >Note that it is good practice to include the absolute path
11204 >lpresume command
</I
11206 > as the PATH may not
11207 be available to the server.
</P
11220 >Default: Currently no default value is given
11221 to this string, unless the value of the
<TT
11230 >, in which case the default is :
</P
11234 >lp -i %p-%j -H resume
</B
11237 >or if the value of the
<TT
11246 >, then the default is:
</P
11250 >qstat -s -j%j -r
</B
11253 >Example for HPUX:
<B
11255 >lpresume command = /usr/bin/lpalt
11263 >lprm command (S)
</DT
11266 >This parameter specifies the command to be
11267 executed on the server host in order to delete a print job.
</P
11269 >This command should be a program or script which takes
11270 a printer name and job number, and deletes the print job.
</P
11277 > is given then the printer name
11278 is put in its place. A
<TT
11284 the job number (an integer).
</P
11286 >Note that it is good practice to include the absolute
11292 > as the PATH may not be
11293 available to the server.
</P
11307 >depends on the setting of
<TT
11318 >lprm command = /usr/bin/lprm -P%p %j
11324 >lprm command = /usr/bin/cancel %p-%j
11330 NAME=
"MACHINEPASSWORDTIMEOUT"
11332 >machine password timeout (G)
</DT
11335 >If a Samba server is a member of a Windows
11336 NT Domain (see the
<A
11337 HREF=
"#SECURITYEQUALSDOMAIN"
11338 >security = domain
</A
11340 parameter) then periodically a running
<A
11344 > process will try and change the MACHINE ACCOUNT
11345 PASSWORD stored in the TDB called
<TT
11347 >private/secrets.tdb
11349 >. This parameter specifies how often this password
11350 will be changed, in seconds. The default is one week (expressed in
11351 seconds), the same as a Windows NT Domain member server.
</P
11354 HREF=
"smbpasswd.8.html"
11362 HREF=
"#SECURITYEQUALSDOMAIN"
11363 > security = domain
</A
11368 >machine password timeout =
604800</B
11375 >magic output (S)
</DT
11378 >This parameter specifies the name of a file
11379 which will contain output created by a magic script (see the
11381 HREF=
"#MAGICSCRIPT"
11389 parameter below).
</P
11391 >Warning: If two clients use the same
<TT
11397 > in the same directory the output file content
11402 >magic output =
<magic script name
>.out
11408 >magic output = myfile.txt
</B
11415 >magic script (S)
</DT
11418 >This parameter specifies the name of a file which,
11419 if opened, will be executed by the server when the file is closed.
11420 This allows a UNIX script to be sent to the Samba host and
11421 executed on behalf of the connected user.
</P
11423 >Scripts executed in this way will be deleted upon
11424 completion assuming that the user has the appropriate level
11425 of privilege and the file permissions allow the deletion.
</P
11427 >If the script generates output, output will be sent to
11428 the file specified by the
<A
11429 HREF=
"#MAGICOUTPUT"
11436 > parameter (see above).
</P
11438 >Note that some shells are unable to interpret scripts
11439 containing CR/LF instead of CR as
11440 the end-of-line marker. Magic scripts must be executable
11443 > on the host, which for some hosts and
11444 some shells will require filtering at the DOS end.
</P
11446 >Magic scripts are
<EM
11451 > be relied upon.
</P
11454 >None. Magic scripts disabled.
</EM
11459 >magic script = user.csh
</B
11466 >mangle case (S)
</DT
11469 >See the section on
<A
11476 >mangle case = no
</B
11483 >mangled map (S)
</DT
11486 >This is for those who want to directly map UNIX
11487 file names which cannot be represented on Windows/DOS. The mangling
11488 of names is not always what is needed. In particular you may have
11489 documents with file extensions that differ between DOS and UNIX.
11490 For example, under UNIX it is common to use
<TT
11494 for HTML files, whereas under Windows/DOS
<TT
11498 is more commonly used.
</P
11511 >mangled map = (*.html *.htm)
</B
11514 >One very useful case is to remove the annoying
<TT
11518 > off the ends of filenames on some CDROMs (only visible
11519 under some UNIXes). To do this use a map of (*;
1 *;).
</P
11522 >no mangled map
</EM
11527 >mangled map = (*;
1 *;)
</B
11532 NAME=
"MANGLEDNAMES"
11534 >mangled names (S)
</DT
11537 >This controls whether non-DOS names under UNIX
11538 should be mapped to DOS-compatible names (
"mangled") and made visible,
11539 or whether non-DOS names should simply be ignored.
</P
11541 >See the section on
<A
11544 > for details on how to control the mangling process.
</P
11546 >If mangling algorithm
"hash" is used then the mangling algorithm is as follows:
</P
11552 >The first (up to) five alphanumeric characters
11553 before the rightmost dot of the filename are preserved, forced
11554 to upper case, and appear as the first (up to) five characters
11555 of the mangled name.
</P
11559 >A tilde
"~" is appended to the first part of the mangled
11560 name, followed by a two-character unique sequence, based on the
11561 original root name (i.e., the original filename minus its final
11562 extension). The final extension is included in the hash calculation
11563 only if it contains any upper case characters or is longer than three
11566 >Note that the character to use may be specified using
11568 HREF=
"#MANGLINGCHAR"
11576 > option, if you don't like '~'.
</P
11580 >The first three alphanumeric characters of the final
11581 extension are preserved, forced to upper case and appear as the
11582 extension of the mangled name. The final extension is defined as that
11583 part of the original filename after the rightmost dot. If there are no
11584 dots in the filename, the mangled name will have no extension (except
11585 in the case of
"hidden files" - see below).
</P
11589 >Files whose UNIX name begins with a dot will be
11590 presented as DOS hidden files. The mangled name will be created as
11591 for other filenames, but with the leading dot removed and
"___" as
11592 its extension regardless of actual original extension (that's three
11597 >The two-digit hash value consists of upper case
11598 alphanumeric characters.
</P
11600 >This algorithm can cause name collisions only if files
11601 in a directory share the same first five alphanumeric characters.
11602 The probability of such a clash is
1/
1300.
</P
11604 >If mangling algorithm
"hash2" is used then the mangling algorithm is as follows:
</P
11610 >The first alphanumeric character
11611 before the rightmost dot of the filename is preserved, forced
11612 to upper case, and appears as the first character of the mangled name.
11617 >A base63 hash of
5 characters is generated and the
11618 first
4 characters of that hash are appended to the first character.
11623 >A tilde
"~" is appended to the first part of the mangled
11624 name, followed by the final character of the base36 hash of the name.
11627 >Note that the character to use may be specified using
11629 HREF=
"#MANGLINGCHAR"
11637 > option, if you don't like '~'.
</P
11641 >The first three alphanumeric characters of the final
11642 extension are preserved, forced to upper case and appear as the
11643 extension of the mangled name. The final extension is defined as that
11644 part of the original filename after the rightmost dot. If there are no
11645 dots in the filename, the mangled name will have no extension (except
11646 in the case of
"hidden files" - see below).
</P
11650 >Files whose UNIX name begins with a dot will be
11651 presented as DOS hidden files. The mangled name will be created as
11652 for other filenames, but with the leading dot removed and
"___" as
11653 its extension regardless of actual original extension (that's three
11658 >The name mangling (if enabled) allows a file to be
11659 copied between UNIX directories from Windows/DOS while retaining
11660 the long UNIX filename. UNIX files can be renamed to a new extension
11661 from Windows/DOS and will retain the same basename. Mangled names
11662 do not change between sessions.
</P
11666 >mangled names = yes
</B
11671 NAME=
"MANGLEDSTACK"
11673 >mangled stack (G)
</DT
11676 >This parameter controls the number of mangled names
11677 that should be cached in the Samba server
<A
11683 >This stack is a list of recently mangled base names
11684 (extensions are only maintained if they are longer than
3 characters
11685 or contains upper case characters).
</P
11687 >The larger this value, the more likely it is that mangled
11688 names can be successfully converted to correct long UNIX names.
11689 However, large stack sizes will slow most directory accesses. Smaller
11690 stacks save memory in the server (each stack element costs
256 bytes).
11693 >It is not possible to absolutely guarantee correct long
11694 filenames, so be prepared for some surprises!
</P
11698 >mangled stack =
50</B
11703 >mangled stack =
100</B
11708 NAME=
"MANGLINGCHAR"
11710 >mangling char (S)
</DT
11713 >This controls what character is used as
11719 >. The default is a '~'
11720 but this may interfere with some software. Use this option to set
11721 it to whatever you prefer.
</P
11725 >mangling char = ~
</B
11730 >mangling char = ^
</B
11735 NAME=
"MANGLINGMETHOD"
11737 >mangling mathod(G)
</DT
11740 > controls the algorithm used for the generating
11741 the mangled names. Can take two different values,
"hash" and
11742 "hash2".
"hash" is the default and is the algorithm that has been
11743 used in Samba for many years.
"hash2" is a newer and considered
11744 a better algorithm (generates less collisions) in the names.
11745 However, many Win32 applications store the mangled names and so
11746 changing to the new algorithm must not be done
11747 lightly as these applications may break unless reinstalled.
11748 New installations of Samba may set the default to hash2.
</P
11752 >mangling method = hash
</B
11757 >mangling method = hash2
</B
11764 >map archive (S)
</DT
11767 >This controls whether the DOS archive attribute
11768 should be mapped to the UNIX owner execute bit. The DOS archive bit
11769 is set when a file has been modified since its last backup. One
11770 motivation for this option it to keep Samba/your PC from making
11771 any file it touches from becoming executable under UNIX. This can
11772 be quite annoying for shared source code, documents, etc...
</P
11774 >Note that this requires the
<TT
11780 parameter to be set such that owner execute bit is not masked out
11781 (i.e. it must include
100). See the parameter
<A
11793 >map archive = yes
</B
11800 >map hidden (S)
</DT
11803 >This controls whether DOS style hidden files
11804 should be mapped to the UNIX world execute bit.
</P
11806 >Note that this requires the
<TT
11812 to be set such that the world execute bit is not masked out (i.e.
11813 it must include
001). See the parameter
<A
11825 >map hidden = no
</B
11832 >map system (S)
</DT
11835 >This controls whether DOS style system files
11836 should be mapped to the UNIX group execute bit.
</P
11838 >Note that this requires the
<TT
11844 to be set such that the group execute bit is not masked out (i.e.
11845 it must include
010). See the parameter
<A
11857 >map system = no
</B
11864 >map to guest (G)
</DT
11867 >This parameter is only useful in
<A
11870 > modes other than
<TT
11873 >security = share
</I
11888 >This parameter can take three different values, which tell
11893 > what to do with user
11894 login requests that don't match a valid UNIX user in some way.
</P
11896 >The three settings are :
</P
11905 > - Means user login
11906 requests with an invalid password are rejected. This is the
11915 logins with an invalid password are rejected, unless the username
11916 does not exist, in which case it is treated as a guest login and
11918 HREF=
"#GUESTACCOUNT"
11932 > - Means user logins
11933 with an invalid password are treated as a guest login and mapped
11935 HREF=
"#GUESTACCOUNT"
11938 this can cause problems as it means that any user incorrectly typing
11939 their password will be silently logged on as
"guest" - and
11940 will not know the reason they cannot access files they think
11941 they should - there will have been no message given to them
11942 that they got their password wrong. Helpdesk services will
11945 > you if you set the
<TT
11951 > parameter this way :-).
</P
11955 >Note that this parameter is needed to set up
"Guest"
11956 share services when using
<TT
11962 share. This is because in these modes the name of the resource being
11965 > sent to the server until after
11966 the server has successfully authenticated the client so the server
11967 cannot make authentication decisions at the correct time (connection
11968 to the share) for
"Guest" shares.
</P
11970 >For people familiar with the older Samba releases, this
11971 parameter maps to the old compile-time setting of the
<TT
11973 > GUEST_SESSSETUP
</TT
11974 > value in local.h.
</P
11978 >map to guest = Never
</B
11983 >map to guest = Bad User
</B
11988 NAME=
"MAXCONNECTIONS"
11990 >max connections (S)
</DT
11993 >This option allows the number of simultaneous
11994 connections to a service to be limited. If
<TT
12000 > is greater than
0 then connections will be refused if
12001 this number of connections to the service are already open. A value
12002 of zero mean an unlimited number of connections may be made.
</P
12004 >Record lock files are used to implement this feature. The
12005 lock files will be stored in the directory specified by the
<A
12006 HREF=
"#LOCKDIRECTORY"
12018 >max connections =
0</B
12023 >max connections =
10</B
12030 >max disk size (G)
</DT
12033 >This option allows you to put an upper limit
12034 on the apparent size of disks. If you set this option to
100
12035 then all shares will appear to be not larger than
100 MB in
12038 >Note that this option does not limit the amount of
12039 data you can put on the disk. In the above case you could still
12040 store much more than
100 MB on the disk, but if a client ever asks
12041 for the amount of free disk space or the total disk size then the
12042 result will be bounded by the amount specified in
<TT
12050 >This option is primarily useful to work around bugs
12051 in some pieces of software that can't handle very large disks,
12052 particularly disks over
1GB in size.
</P
12059 > of
0 means no limit.
</P
12063 >max disk size =
0</B
12068 >max disk size =
1000</B
12075 >max log size (G)
</DT
12078 >This option (an integer in kilobytes) specifies
12079 the max size the log file should grow to. Samba periodically checks
12080 the size and if it is exceeded it will rename the file, adding
12086 >A size of
0 means no limit.
</P
12090 >max log size =
5000</B
12095 >max log size =
1000</B
12105 >This option controls the maximum number of
12106 outstanding simultaneous SMB operations that Samba tells the client
12107 it will allow. You should never need to set this parameter.
</P
12116 NAME=
"MAXOPENFILES"
12118 >max open files (G)
</DT
12121 >This parameter limits the maximum number of
12122 open files that one
<A
12127 serving process may have open for a client at any one time. The
12128 default for this parameter is set very high (
10,
000) as Samba uses
12129 only one bit per unopened file.
</P
12131 >The limit of the number of open files is usually set
12132 by the UNIX per-process file descriptor limit rather than
12133 this parameter so you should never need to touch this parameter.
</P
12137 >max open files =
10000</B
12142 NAME=
"MAXPRINTJOBS"
12144 >max print jobs (S)
</DT
12147 >This parameter limits the maximum number of
12148 jobs allowable in a Samba printer queue at any given moment.
12149 If this number is exceeded,
<A
12156 > will remote
"Out of Space" to the client.
12158 HREF=
"#TOTALPRINTJOBS"
12171 >max print jobs =
1000</B
12176 >max print jobs =
5000</B
12183 >max protocol (G)
</DT
12186 >The value of the parameter (a string) is the highest
12187 protocol level that will be supported by the server.
</P
12189 >Possible values are :
</P
12198 >: Earliest version. No
12199 concept of user names.
</P
12206 >: Slight improvements on
12207 CORE for efficiency.
</P
12216 > version of the protocol. Long filename
12224 >: Updates to Lanman1 protocol.
12232 >: Current up to date version of
12233 the protocol. Used by Windows NT. Known as CIFS.
</P
12237 >Normally this option should not be set as the automatic
12238 negotiation phase in the SMB protocol takes care of choosing
12239 the appropriate protocol.
</P
12242 HREF=
"#MINPROTOCOL"
12254 >max protocol = NT1
</B
12259 >max protocol = LANMAN1
</B
12264 NAME=
"MAXSMBDPROCESSES"
12266 >max smbd processes (G)
</DT
12269 >This parameter limits the maximum number of
12278 processes concurrently running on a system and is intended
12279 as a stopgap to prevent degrading service to clients in the event
12280 that the server has insufficient resources to handle more than this
12281 number of connections. Remember that under normal operating
12282 conditions, each user will have an
<A
12286 > associated with him or her
12287 to handle connections to all shares from a given host.
12292 >max smbd processes =
0</B
12297 >max smbd processes =
1000</B
12307 >This option tells
<A
12312 what the default 'time to live' of NetBIOS names should be (in seconds)
12316 > is requesting a name using either a
12317 broadcast packet or from a WINS server. You should never need to
12318 change this parameter. The default is
3 days.
</P
12322 >max ttl =
259200</B
12329 >max wins ttl (G)
</DT
12332 >This option tells
<A
12337 > when acting as a WINS server (
<A
12338 HREF=
"#WINSSUPPORT"
12342 >wins support = yes
</I
12345 >) what the maximum
12346 'time to live' of NetBIOS names that
<B
12350 will grant will be (in seconds). You should never need to change this
12351 parameter. The default is
6 days (
518400 seconds).
</P
12366 >max wins ttl =
518400</B
12376 >This option controls the maximum packet size
12377 that will be negotiated by Samba. The default in Samba
2.2.6 is
12378 now
16644 (changed from
65535 in earlier releases) which matches
12379 Windows
2000. This allows better performance with Windows NT clients.
12380 The maximum is
65535. In some cases you may find you get better performance
12381 with a smaller value. A value below
2048 is likely to cause problems.
12386 >max xmit =
16644</B
12391 >max xmit =
8192</B
12396 NAME=
"MESSAGECOMMAND"
12398 >message command (G)
</DT
12401 >This specifies what command to run when the
12402 server receives a WinPopup style message.
</P
12404 >This would normally be a command that would
12405 deliver the message somehow. How this is to be done is
12406 up to your imagination.
</P
12412 >message command = csh -c 'xedit %s;rm %s'
&</B
12416 >This delivers the message using
<B
12420 removes it afterwards.
<EM
12421 >NOTE THAT IT IS VERY IMPORTANT
12422 THAT THIS COMMAND RETURN IMMEDIATELY
</EM
12424 have the '
&' on the end. If it doesn't return immediately then
12425 your PCs may freeze when sending messages (they should recover
12426 after
30 seconds, hopefully).
</P
12428 >All messages are delivered as the global guest user.
12429 The command takes the standard substitutions, although
<TT
12442 >Apart from the standard substitutions, some additional
12443 ones apply. In particular:
</P
12454 > = the filename containing
12464 > = the destination that
12465 the message was sent to (probably the server name).
</P
12474 > = who the message
12479 >You could make this command send mail, or whatever else
12480 takes your fancy. Please let us know of any really interesting
12483 >Here's a way of sending the messages as mail to root:
</P
12487 >message command = /bin/mail -s 'message from %f on
12488 %m' root
< %s; rm %s
</B
12491 >If you don't have a message command then the message
12492 won't be delivered and Samba will tell the sender there was
12493 an error. Unfortunately WfWg totally ignores the error code
12494 and carries on regardless, saying that the message was delivered.
12497 >If you want to silently delete it then try:
</P
12501 >message command = rm %s
</B
12505 >no message command
</EM
12510 >message command = csh -c 'xedit %s;
12516 NAME=
"MINPASSWDLENGTH"
12518 >min passwd length (G)
</DT
12522 HREF=
"#MINPASSWORDLENGTH"
12526 >min password length
</I
12533 NAME=
"MINPASSWORDLENGTH"
12535 >min password length (G)
</DT
12538 >This option sets the minimum length in characters
12539 of a plaintext password that
<B
12542 > will accept when performing
12543 UNIX password changing.
</P
12546 HREF=
"#UNIXPASSWORDSYNC"
12555 HREF=
"#PASSWDPROGRAM"
12563 HREF=
"#PASSWDCHATDEBUG"
12567 >passwd chat debug
</I
12575 >min password length =
5</B
12580 NAME=
"MINPRINTSPACE"
12582 >min print space (S)
</DT
12585 >This sets the minimum amount of free disk
12586 space that must be available before a user will be able to spool
12587 a print job. It is specified in kilobytes. The default is
0, which
12588 means a user can always spool a print job.
</P
12603 >min print space =
0</B
12608 >min print space =
2000</B
12615 >min protocol (G)
</DT
12618 >The value of the parameter (a string) is the
12619 lowest SMB protocol dialect than Samba will support. Please refer
12621 HREF=
"#MAXPROTOCOL"
12629 parameter for a list of valid protocol names and a brief description
12630 of each. You may also wish to refer to the C source code in
12633 >source/smbd/negprot.c
</TT
12634 > for a listing of known protocol
12635 dialects supported by clients.
</P
12637 >If you are viewing this parameter as a security measure, you should
12638 also refer to the
<A
12647 > parameter. Otherwise, you should never need
12648 to change this parameter.
</P
12652 >min protocol = CORE
</B
12657 >min protocol = NT1
</B
12665 >min wins ttl (G)
</DT
12668 >This option tells
<A
12673 when acting as a WINS server (
<A
12674 HREF=
"#WINSSUPPORT"
12678 > wins support = yes
</I
12681 >) what the minimum 'time to live'
12682 of NetBIOS names that
<B
12685 > will grant will be (in
12686 seconds). You should never need to change this parameter. The default
12687 is
6 hours (
21600 seconds).
</P
12691 >min wins ttl =
21600</B
12698 >msdfs root (S)
</DT
12701 >This boolean parameter is only available if
12702 Samba is configured and compiled with the
<B
12705 > option. If set to
<TT
12709 Samba treats the share as a Dfs root and allows clients to browse
12710 the distributed file system tree rooted at the share directory.
12711 Dfs links are specified in the share directory by symbolic
12712 links of the form
<TT
12714 >msdfs:serverA\shareA,serverB\shareB
12716 > and so on. For more information on setting up a Dfs tree
12717 on Samba, refer to
<A
12718 HREF=
"msdfs_setup.html"
12737 >msdfs root = no
</B
12742 NAME=
"NAMERESOLVEORDER"
12744 >name resolve order (G)
</DT
12747 >This option is used by the programs in the Samba
12748 suite to determine what naming services to use and in what order
12749 to resolve host names to IP addresses. The option takes a space
12750 separated string of name resolution options.
</P
12752 >The options are :
"lmhosts",
"host",
"wins" and
"bcast". They
12753 cause names to be resolved as follows :
</P
12763 address in the Samba lmhosts file. If the line in lmhosts has
12764 no name type attached to the NetBIOS name (see the
<A
12765 HREF=
"lmhosts.5.html"
12768 > for details) then
12769 any name type matches for lookup.
</P
12776 > : Do a standard host
12777 name to IP address resolution, using the system
<TT
12781 >, NIS, or DNS lookups. This method of name resolution
12782 is operating system depended for instance on IRIX or Solaris this
12783 may be controlled by the
<TT
12785 >/etc/nsswitch.conf
</TT
12787 file. Note that this method is only used if the NetBIOS name
12788 type being queried is the
0x20 (server) name type, otherwise
12796 > : Query a name with
12797 the IP address listed in the
<A
12805 > parameter. If no WINS server has
12806 been specified this method will be ignored.
</P
12813 > : Do a broadcast on
12814 each of the known local interfaces listed in the
<A
12823 parameter. This is the least reliable of the name resolution
12824 methods as it depends on the target host being on a locally
12825 connected subnet.
</P
12831 >name resolve order = lmhosts host wins bcast
12837 >name resolve order = lmhosts bcast host
12841 >This will cause the local lmhosts file to be examined
12842 first, followed by a broadcast attempt, followed by a normal
12843 system hostname lookup.
</P
12847 NAME=
"NETBIOSALIASES"
12849 >netbios aliases (G)
</DT
12852 >This is a list of NetBIOS names that
<A
12856 > will advertise as additional
12857 names by which the Samba server is known. This allows one machine
12858 to appear in browse lists under multiple names. If a machine is
12859 acting as a browse server or logon server none
12860 of these names will be advertised as either browse server or logon
12861 servers, only the primary name of the machine will be advertised
12862 with these capabilities.
</P
12865 HREF=
"#NETBIOSNAME"
12876 >empty string (no additional names)
</EM
12881 >netbios aliases = TEST TEST1 TEST2
</B
12888 >netbios name (G)
</DT
12891 >This sets the NetBIOS name by which a Samba
12892 server is known. By default it is the same as the first component
12893 of the host's DNS name. If a machine is a browse server or
12894 logon server this name (or the first component
12895 of the hosts DNS name) will be the name that these services are
12896 advertised under.
</P
12899 HREF=
"#NETBIOSALIASES"
12910 >machine DNS name
</EM
12915 >netbios name = MYNAME
</B
12920 NAME=
"NETBIOSSCOPE"
12922 >netbios scope (G)
</DT
12925 >This sets the NetBIOS scope that Samba will
12926 operate under. This should not be set unless every machine
12927 on your LAN also sets this value.
</P
12933 >nis homedir (G)
</DT
12936 >Get the home share server from a NIS map. For
12937 UNIX systems that use an automounter, the user's home directory
12938 will often be mounted on a workstation on demand from a remote
12941 >When the Samba logon server is not the actual home directory
12942 server, but is mounting the home directories via NFS then two
12943 network hops would be required to access the users home directory
12944 if the logon server told the client to use itself as the SMB server
12945 for home directories (one over SMB and one over NFS). This can
12948 >This option allows Samba to return the home share as
12949 being on a different server to the logon server and as
12950 long as a Samba daemon is running on the home directory server,
12951 it will be mounted on the Samba client directly from the directory
12952 server. When Samba is returning the home share to the client, it
12953 will consult the NIS map specified in
<A
12961 > and return the server
12964 >Note that for this option to work there must be a working
12965 NIS system and the Samba server with this option must also
12966 be a logon server.
</P
12970 >nis homedir = no
</B
12975 NAME=
"NTACLSUPPORT"
12977 >nt acl support (S)
</DT
12980 >This boolean parameter controls whether
12985 > will attempt to map
12986 UNIX permissions into Windows NT access control lists.
12987 This parameter was formally a global parameter in releases
12992 >nt acl support = yes
</B
12997 NAME=
"NTPIPESUPPORT"
12999 >nt pipe support (G)
</DT
13002 >This boolean parameter controls whether
13007 > will allow Windows NT
13008 clients to connect to the NT SMB specific
<TT
13012 pipes. This is a developer debugging option and can be left
13017 >nt pipe support = yes
</B
13022 NAME=
"NTSMBSUPPORT"
13024 >nt smb support (G)
</DT
13027 >This boolean parameter controls whether
<A
13031 > will negotiate NT specific SMB
13032 support with Windows NT/
2k/XP clients. Although this is a developer
13033 debugging option and should be left alone, benchmarking has discovered
13034 that Windows NT clients give faster performance with this option
13038 >. This is still being investigated.
13039 If this option is set to
<TT
13042 > then Samba offers
13043 exactly the same SMB calls that versions prior to Samba
2.0 offered.
13044 This information may be of use if any users are having problems
13045 with NT SMB support.
</P
13047 >You should not need to ever disable this parameter.
</P
13051 >nt smb support = yes
</B
13056 NAME=
"NTSTATUSSUPPORT"
13058 >nt status support (G)
</DT
13061 >This boolean parameter controls whether
<A
13065 > will negotiate NT specific status
13066 support with Windows NT/
2k/XP clients. This is a developer
13067 debugging option and should be left alone.
13068 If this option is set to
<TT
13071 > then Samba offers
13072 exactly the same DOS error codes that versions prior to Samba
2.2.3
13075 >You should not need to ever disable this parameter.
</P
13079 >nt status support = yes
</B
13084 NAME=
"NULLPASSWORDS"
13086 >null passwords (G)
</DT
13089 >Allow or disallow client access to accounts
13090 that have null passwords.
</P
13093 HREF=
"smbpasswd.5.html"
13100 >null passwords = no
</B
13105 NAME=
"OBEYPAMRESTRICTIONS"
13107 >obey pam restrictions (G)
</DT
13110 >When Samba
2.2 is configured to enable PAM support
13111 (i.e. --with-pam), this parameter will control whether or not Samba
13112 should obey PAM's account and session management directives. The
13113 default behavior is to use PAM for clear text authentication only
13114 and to ignore any account or session management. Note that Samba
13115 always ignores PAM for authentication in the case of
<A
13116 HREF=
"#ENCRYPTPASSWORDS"
13120 >encrypt passwords = yes
</I
13124 >. The reason is that PAM modules cannot support the challenge/response
13125 authentication mechanism needed in the presence of SMB password encryption.
13130 >obey pam restrictions = no
</B
13140 >This is a boolean option that controls whether
13141 connections with usernames not in the
<TT
13147 list will be allowed. By default this option is disabled so that a
13148 client can supply a username to be used by the server. Enabling
13149 this parameter will force the server to only user the login
13155 > list and is only really
13157 HREF=
"#SECURITYEQUALSSHARE"
13162 >Note that this also means Samba won't try to deduce
13163 usernames from the service name. This can be annoying for
13164 the [homes] section. To get around this you could use
<B
13168 > which means your
<TT
13174 will be just the service name, which for home directories is the
13175 name of the user.
</P
13197 >only guest (S)
</DT
13212 NAME=
"OPLOCKBREAKWAITTIME"
13214 >oplock break wait time (G)
</DT
13217 >This is a tuning parameter added due to bugs in
13218 both Windows
9x and WinNT. If Samba responds to a client too
13219 quickly when that client issues an SMB that can cause an oplock
13220 break request, then the network client can fail and not respond
13221 to the break request. This tuning parameter (which is set in milliseconds)
13222 is the amount of time Samba will wait before sending an oplock break
13223 request to such (broken) clients.
</P
13226 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
13227 AND UNDERSTOOD THE SAMBA OPLOCK CODE
</EM
13232 >oplock break wait time =
0</B
13237 NAME=
"OPLOCKCONTENTIONLIMIT"
13239 >oplock contention limit (S)
</DT
13250 improve the efficiency of the granting of oplocks under multiple
13251 client contention for the same file.
</P
13253 >In brief it specifies a number, which causes
<A
13258 grant an oplock even when requested if the approximate number of
13259 clients contending for an oplock on the same file goes over this
13260 limit. This causes
<B
13263 > to behave in a similar
13264 way to Windows NT.
</P
13267 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
13268 AND UNDERSTOOD THE SAMBA OPLOCK CODE
</EM
13273 >oplock contention limit =
2</B
13283 >This boolean option tells
<B
13287 issue oplocks (opportunistic locks) to file open requests on this
13288 share. The oplock code can dramatically (approx.
30% or more) improve
13289 the speed of access to files on Samba servers. It allows the clients
13290 to aggressively cache files locally and you may want to disable this
13291 option for unreliable network environments (it is turned on by
13292 default in Windows NT Servers). For more information see the file
13302 >Oplocks may be selectively turned off on certain files with a
13304 HREF=
"#VETOOPLOCKFILES"
13308 > veto oplock files
</I
13311 > parameter. On some systems
13312 oplocks are recognized by the underlying operating system. This
13313 allows data synchronization between all access to oplocked files,
13314 whether it be via Samba or NFS or a local UNIX process. See the
13320 > parameter for details.
</P
13323 HREF=
"#KERNELOPLOCKS"
13332 HREF=
"#LEVEL2OPLOCKS"
13336 > level2 oplocks
</I
13353 >This integer value controls what level Samba
13354 advertises itself as for browse elections. The value of this
13355 parameter determines whether
<A
13360 has a chance of becoming a local master browser for the
<TT
13365 > in the local broadcast area.
</P
13369 >By default, Samba will win
13370 a local master browsing election over all Microsoft operating
13371 systems except a Windows NT
4.0/
2000 Domain Controller. This
13372 means that a misconfigured Samba host can effectively isolate
13373 a subnet for browsing purposes. See
<TT
13395 NAME=
"OS2DRIVERMAP"
13397 >os2 driver map (G)
</DT
13400 >The parameter is used to define the absolute
13401 path to a file containing a mapping of Windows NT printer driver
13402 names to OS/
2 printer driver names. The format is:
</P
13404 ><nt driver name
> =
<os2 driver
13405 name
>.
<device name
></P
13407 >For example, a valid entry using the HP LaserJet
5
13408 printer driver would appear as
<B
13410 >HP LaserJet
5L = LASERJET.HP
13414 >The need for the file is due to the printer driver namespace
13415 problem described in the
<A
13416 HREF=
"printer_driver2.html"
13420 >. For more details on OS/
2 clients, please
13422 HREF=
"OS2-Client-HOWTO.html"
13426 > containing in the Samba documentation.
</P
13430 >os2 driver map =
<empty string
>
13436 NAME=
"PAMPASSWORDCHANGE"
13438 >pam password change (G)
</DT
13441 >With the addition of better PAM support in Samba
2.2,
13442 this parameter, it is possible to use PAM's password change control
13443 flag for Samba. If enabled, then PAM will be used for password
13444 changes when requested by an SMB client instead of the program listed in
13446 HREF=
"#PASSWDPROGRAM"
13454 It should be possible to enable this without changing your
13464 parameter for most setups.
13469 >pam password change = no
</B
13476 >panic action (G)
</DT
13479 >This is a Samba developer option that allows a
13480 system command to be called when either
<A
13489 crashes. This is usually used to draw attention to the fact that
13490 a problem occurred.
</P
13494 >panic action =
<empty string
></B
13499 >panic action =
"/bin/sleep 90000"</B
13506 >passwd chat (G)
</DT
13509 >This string controls the
<EM
13512 conversation that takes places between
<A
13516 > and the local password changing
13517 program to change the user's password. The string describes a
13518 sequence of response-receive pairs that
<A
13522 > uses to determine what to send to the
13524 HREF=
"#PASSWDPROGRAM"
13532 > and what to expect back. If the expected output is not
13533 received then the password is not changed.
</P
13535 >This chat sequence is often quite site specific, depending
13536 on what local methods are used for password control (such as NIS
13539 >Note that this parameter only is only used if the
<A
13540 HREF=
"#UNIXPASSWORDSYNC"
13548 > parameter is set to
<TT
13552 sequence is then called
<EM
13554 > when the SMB password
13555 in the smbpasswd file is being changed, without access to the old
13556 password cleartext. This means that root must be able to reset the user's password
13557 without knowing the text of the previous password. In the presence of NIS/YP,
13558 this means that the
<A
13559 HREF=
"#PASSWDPROGRAM"
13562 executed on the NIS master.
13565 >The string can contain the macro
<TT
13570 > which is substituted
13571 for the new password. The chat sequence can also contain the standard
13584 > to give line-feed,
13585 carriage-return, tab and space. The chat sequence string can also contain
13586 a '*' which matches any sequence of characters.
13587 Double quotes can be used to collect strings with spaces
13588 in them into a single string.
</P
13590 >If the send string in any part of the chat sequence
13591 is a full stop
".", then no string is sent. Similarly,
13592 if the expect string is a full stop then no string is expected.
</P
13595 HREF=
"#PAMPASSWORDCHANGE"
13603 > parameter is set to
<TT
13607 may be matched in any order, and success is determined by the PAM result,
13608 not any particular output. The \n macro is ignored for PAM conversions.
13612 HREF=
"#UNIXPASSWORDSYNC"
13621 HREF=
"#PASSWDPROGRAM"
13625 > passwd program
</I
13629 HREF=
"#PASSWDCHATDEBUG"
13633 >passwd chat debug
</I
13637 HREF=
"#PAMPASSWORDCHANGE"
13641 >pam password change
</I
13648 >passwd chat = *new*password* %n\n
13649 *new*password* %n\n *changed*
</B
13654 >passwd chat =
"*Enter OLD password*" %o\n
13655 "*Enter NEW password*" %n\n
"*Reenter NEW password*" %n\n
"*Password
13661 NAME=
"PASSWDCHATDEBUG"
13663 >passwd chat debug (G)
</DT
13666 >This boolean specifies if the passwd chat script
13667 parameter is run in
<EM
13669 > mode. In this mode the
13670 strings passed to and received from the passwd chat are printed
13685 of
100. This is a dangerous option as it will allow plaintext passwords
13686 to be seen in the
<B
13689 > log. It is available to help
13690 Samba admins debug their
<TT
13696 when calling the
<TT
13702 be turned off after this has been done. This option has no effect if the
13704 HREF=
"#PAMPASSWORDCHANGE"
13708 >pam password change
</I
13712 paramter is set. This parameter is off by default.
</P
13724 HREF=
"#PAMPASSWORDCHANGE"
13728 >pam password change
</I
13733 HREF=
"#PASSWDPROGRAM"
13745 >passwd chat debug = no
</B
13750 NAME=
"PASSWDPROGRAM"
13752 >passwd program (G)
</DT
13755 >The name of a program that can be used to set
13756 UNIX user passwords. Any occurrences of
<TT
13762 will be replaced with the user name. The user name is checked for
13763 existence before calling the password changing program.
</P
13765 >Also note that many passwd programs insist in
<EM
13768 > passwords, such as a minimum length, or the inclusion
13769 of mixed case chars and digits. This can pose a problem as some clients
13770 (such as Windows for Workgroups) uppercase the password before sending
13781 > parameter is set to
<TT
13785 > then this program is called
<EM
13788 before the SMB password in the
<A
13789 HREF=
"smbpasswd.5.html"
13793 > file is changed. If this UNIX password change fails, then
13797 > will fail to change the SMB password also
13798 (this is by design).
</P
13803 >unix password sync
</I
13806 is set this parameter
<EM
13807 >MUST USE ABSOLUTE PATHS
</EM
13811 > programs called, and must be examined
13812 for security implications. Note that by default
<TT
13824 HREF=
"#UNIXPASSWORDSYNC"
13836 >passwd program = /bin/passwd
</B
13841 >passwd program = /sbin/npasswd %u
</B
13847 NAME=
"PASSWORDLEVEL"
13849 >password level (G)
</DT
13852 >Some client/server combinations have difficulty
13853 with mixed-case passwords. One offending client is Windows for
13854 Workgroups, which for some reason forces passwords to upper
13855 case when using the LANMAN1 protocol, but leaves them alone when
13856 using COREPLUS! Another problem child is the Windows
95/
98
13857 family of operating systems. These clients upper case clear
13858 text passwords even when NT LM
0.12 selected by the protocol
13859 negotiation request/response.
</P
13861 >This parameter defines the maximum number of characters
13862 that may be upper case in passwords.
</P
13864 >For example, say the password given was
"FRED". If
<TT
13867 > password level
</I
13869 > is set to
1, the following combinations
13870 would be tried if
"FRED" failed:
</P
13872 >"Fred",
"fred",
"fRed",
"frEd",
"freD"</P
13880 the following combinations would also be tried:
</P
13882 >"FRed",
"FrEd",
"FreD",
"fREd",
"fReD",
"frED", ..
</P
13886 >The higher value this parameter is set to the more likely
13887 it is that a mixed case password will be matched against a single
13888 case password. However, you should be aware that use of this
13889 parameter reduces security and increases the time taken to
13890 process a new connection.
</P
13892 >A value of zero will cause only two attempts to be
13893 made - the password as is and the password in all-lower case.
</P
13897 >password level =
0</B
13902 >password level =
4</B
13907 NAME=
"PASSWORDSERVER"
13909 >password server (G)
</DT
13912 >By specifying the name of another SMB server (such
13913 as a WinNT box) with this option, and using
<B
13919 >security = server
</B
13920 > you can get Samba
13921 to do all its username/password validation via a remote server.
</P
13923 >This option sets the name of the password server to use.
13924 It must be a NetBIOS name, so if the machine's NetBIOS name is
13925 different from its Internet name then you may have to add its NetBIOS
13926 name to the lmhosts file which is stored in the same directory
13932 >The name of the password server is looked up using the
13934 HREF=
"#NAMERESOLVEORDER"
13942 > and so may resolved
13943 by any method and order described in that parameter.
</P
13945 >The password server much be a machine capable of using
13946 the
"LM1.2X002" or the
"NT LM 0.12" protocol, and it must be in
13947 user level security mode.
</P
13951 > Using a password server
13952 means your UNIX box (running Samba) is only as secure as your
13953 password server.
<EM
13954 >DO NOT CHOOSE A PASSWORD SERVER THAT
13955 YOU DON'T COMPLETELY TRUST
</EM
13958 >Never point a Samba server at itself for password
13959 serving. This will cause a loop and could lock up your Samba
13962 >The name of the password server takes the standard
13963 substitutions, but probably the only useful one is
<TT
13969 >, which means the Samba server will use the incoming
13970 client as the password server. If you use this then you better
13971 trust your clients, and you had better restrict them with hosts allow!
</P
13978 > parameter is set to
13982 >, then the list of machines in this
13983 option must be a list of Primary or Backup Domain controllers for the
13984 Domain or the character '*', as the Samba server is effectively
13985 in that domain, and will use cryptographically authenticated RPC calls
13986 to authenticate the user logging on. The advantage of using
<B
13988 > security = domain
</B
13989 > is that if you list several hosts in the
13993 >password server
</I
13999 > will try each in turn till it finds one that responds. This
14000 is useful in case your primary server goes down.
</P
14005 >password server
</I
14008 to the character '*', then Samba will attempt to auto-locate the
14009 Primary or Backup Domain controllers to authenticate against by
14010 doing a query for the name
<TT
14012 >WORKGROUP
<1C
></TT
14014 and then contacting each server returned in the list of IP
14015 addresses from the name resolution source.
</P
14026 >, then there are different
14027 restrictions that
<B
14029 >security = domain
</B
14037 >You may list several password servers in
14041 >password server
</I
14043 > parameter, however if an
14047 > makes a connection to a password server,
14048 and then the password server fails, no more users will be able
14049 to be authenticated from this
<B
14053 restriction of the SMB/CIFS protocol when in
<B
14057 > mode and cannot be fixed in Samba.
</P
14061 >If you are using a Windows NT server as your
14062 password server then you will have to ensure that your users
14063 are able to login from the Samba server, as when in
<B
14065 > security = server
</B
14066 > mode the network logon will appear to
14067 come from there rather than from the users workstation.
</P
14084 >password server =
<empty string
></B
14090 >password server = NT-PDC, NT-BDC1, NT-BDC2
14096 >password server = *
</B
14106 >This parameter specifies a directory to which
14107 the user of the service is to be given access. In the case of
14108 printable services, this is where print data will spool prior to
14109 being submitted to the host for printing.
</P
14111 >For a printable service offering guest access, the service
14112 should be readonly and the path should be world-writeable and
14113 have the sticky bit set. This is not mandatory of course, but
14114 you probably won't get the results you expect if you do
14117 >Any occurrences of
<TT
14123 will be replaced with the UNIX username that the client is using
14124 on this connection. Any occurrences of
<TT
14130 will be replaced by the NetBIOS name of the machine they are
14131 connecting from. These replacements are very useful for setting
14132 up pseudo home directories for users.
</P
14134 >Note that this path will be based on
<A
14142 > if one was specified.
</P
14150 >path = /home/fred
</B
14155 NAME=
"PIDDIRECTORY"
14157 >pid directory (G)
</DT
14160 >This option specifies the directory where pid
14161 files will be placed.
</P
14165 >pid directory = ${prefix}/var/locks
</B
14170 >pid directory = /var/run/
</B
14176 NAME=
"POSIXLOCKING"
14178 >posix locking (S)
</DT
14189 daemon maintains an database of file locks obtained by SMB clients.
14190 The default behavior is to map this internal database to POSIX
14191 locks. This means that file locks obtained by SMB clients are
14192 consistent with those seen by POSIX compliant applications accessing
14193 the files via a non-SMB method (e.g. NFS or local file access).
14194 You should never need to disable this parameter.
</P
14198 >posix locking = yes
</B
14208 >This option specifies a command to be run
14209 whenever the service is disconnected. It takes the usual
14210 substitutions. The command may be run as the root on some
14213 >An interesting example may be to unmount server
14218 >postexec = /etc/umount /cdrom
</B
14233 >none (no command executed)
</EM
14239 >postexec = echo \
"%u disconnected from %S
14240 from %m (%I)\" >> /tmp/log
</B
14247 >postscript (S)
</DT
14250 >This parameter forces a printer to interpret
14251 the print files as PostScript. This is done by adding a
<TT
14255 > to the start of print output.
</P
14257 >This is most useful when you have lots of PCs that persist
14258 in putting a control-D at the start of print jobs, which then
14259 confuses your printer.
</P
14263 >postscript = no
</B
14273 >This option specifies a command to be run whenever
14274 the service is connected to. It takes the usual substitutions.
</P
14276 >An interesting example is to send the users a welcome
14277 message every time they log in. Maybe a message of the day? Here
14282 >preexec = csh -c 'echo \
"Welcome to %S!\" |
14283 /usr/local/samba/bin/smbclient -M %m -I %I'
& </B
14286 >Of course, this could get annoying after a while :-)
</P
14289 HREF=
"#PREEXECCLOSE"
14309 >none (no command executed)
</EM
14314 >preexec = echo \
"%u connected to %S from %m
14315 (%I)\" >> /tmp/log
</B
14320 NAME=
"PREEXECCLOSE"
14322 >preexec close (S)
</DT
14325 >This boolean option controls whether a non-zero
14326 return code from
<A
14335 > should close the service being connected to.
</P
14339 >preexec close = no
</B
14344 NAME=
"PREFERREDMASTER"
14346 >preferred master (G)
</DT
14349 >This boolean parameter controls if
<A
14353 > is a preferred master browser
14354 for its workgroup.
</P
14356 >If this is set to
<TT
14363 will force an election, and it will have a slight advantage in
14364 winning the election. It is recommended that this parameter is
14365 used in conjunction with
<B
14368 HREF=
"#DOMAINMASTER"
14379 > can guarantee becoming a domain master.
</P
14381 >Use this option with caution, because if there are several
14382 hosts (whether Samba servers, Windows
95 or NT) that are preferred
14383 master browsers on the same subnet, they will each periodically
14384 and continuously attempt to become the local master browser.
14385 This will result in unnecessary broadcast traffic and reduced browsing
14401 >preferred master = auto
</B
14406 NAME=
"PREFEREDMASTER"
14408 >prefered master (G)
</DT
14412 HREF=
"#PREFERREDMASTER"
14416 > preferred master
</I
14419 > for people who cannot spell :-).
</P
14428 >This is a list of services that you want to be
14429 automatically added to the browse lists. This is most useful
14430 for homes and printers services that would otherwise not be
14433 >Note that if you just want all printers in your
14434 printcap file loaded then the
<A
14435 HREF=
"#LOADPRINTERS"
14442 > option is easier.
</P
14445 >no preloaded services
</EM
14450 >preload = fred lp colorlp
</B
14455 NAME=
"PRESERVECASE"
14457 >preserve case (S)
</DT
14460 > This controls if new filenames are created
14461 with the case that the client passes, or if they are forced to
14463 HREF=
"#DEFAULTCASE"
14475 >preserve case = yes
</B
14478 >See the section on
<A
14482 > for a fuller discussion.
</P
14486 NAME=
"PRINTCOMMAND"
14488 >print command (S)
</DT
14491 >After a print job has finished spooling to
14492 a service, this command will be used via a
<B
14496 call to process the spool file. Typically the command specified will
14497 submit the spool file to the host's printing subsystem, but there
14498 is no requirement that this be the case. The server will not remove
14499 the spool file, so whatever command you specify should remove the
14500 spool file when it has been processed, otherwise you will need to
14501 manually remove old spool files.
</P
14503 >The print command is simply a text string. It will be used
14504 verbatim after macro substitutions have been made:
</P
14506 >s, %p - the path to the spool
14509 >%p - the appropriate printer
14513 name as transmitted by the client.
</P
14515 >%c - The number of printed pages
14516 of the spooled job (if known).
</P
14518 >%z - the size of the spooled
14519 print job (in bytes)
</P
14521 >The print command
<EM
14524 one occurrence of
<TT
14540 > is optional. At the time
14541 a job is submitted, if no printer name is supplied the
<TT
14547 > will be silently removed from the printer command.
</P
14549 >If specified in the [global] section, the print command given
14550 will be used for any printable service that does not have its own
14551 print command specified.
</P
14553 >If there is neither a specified print command for a
14554 printable service nor a global print command, spool files will
14555 be created but not processed and (most importantly) not removed.
</P
14557 >Note that printing may fail on some UNIXes from the
14561 > account. If this happens then create
14562 an alternative guest account that can print and set the
<A
14563 HREF=
"#GUESTACCOUNT"
14571 in the [global] section.
</P
14573 >You can form quite complex print commands by realizing
14574 that they are just passed to a shell. For example the following
14575 will log a print job, print the file, then remove it. Note that
14576 ';' is the usual separator for command in shell scripts.
</P
14580 >print command = echo Printing %s
>>
14581 /tmp/print.log; lpr -P %p %s; rm %s
</B
14584 >You may have to vary this command considerably depending
14585 on how you normally print files on your system. The default for
14586 the parameter varies depending on the setting of the
<A
14598 >printing = BSD, AIX, QNX, LPRNG
14604 >print command = lpr -r -P%p %s
</B
14609 >printing = SYSV or HPUX :
</B
14614 >print command = lp -c -d%p %s; rm %s
</B
14619 >printing = SOFTQ :
</B
14624 >print command = lp -d%p -s %s; rm %s
</B
14627 >For printing = CUPS : If SAMBA is compiled against
14630 >printcap = cups
</A
14632 uses the CUPS API to
14633 submit jobs, etc. Otherwise it maps to the System V
14634 commands with the -oraw option for printing, i.e. it
14637 >lp -c -d%p -oraw; rm %s
</B
14641 >printing = cups
</B
14643 and if SAMBA is compiled against libcups, any manually
14644 set print command will be ignored.
</P
14648 >print command = /usr/local/samba/bin/myprintscript
14676 >If this parameter is
<TT
14680 clients may open, write to and submit spool files on the directory
14681 specified for the service.
</P
14683 >Note that a printable service will ALWAYS allow writing
14684 to the service path (user privileges permitting) via the spooling
14685 of print data. The
<A
14694 > parameter controls only non-printing access to
14710 HREF=
"#PRINTCAPNAME"
14721 NAME=
"PRINTCAPNAME"
14723 >printcap name (G)
</DT
14726 >This parameter may be used to override the
14727 compiled-in default printcap name used by the server (usually
<TT
14729 > /etc/printcap
</TT
14730 >). See the discussion of the
<A
14733 > section above for reasons
14734 why you might want to do this.
</P
14736 >To use the CUPS printing interface set
<B
14738 >printcap name = cups
14740 >. This should be supplemented by an addtional setting
14743 >printing = cups
</A
14747 >printcap name = cups
</B
14749 "dummy" printcap created by CUPS, as specified in your CUPS
14750 configuration file.
14753 >On System V systems that use
<B
14757 list available printers you can use
<B
14759 >printcap name = lpstat
14761 > to automatically obtain lists of available printers. This
14762 is the default for systems that define SYSV at configure time in
14763 Samba (this includes most System V based systems). If
<TT
14772 these systems then Samba will launch
<B
14776 attempt to parse the output to obtain a printer list.
</P
14778 >A minimal printcap file would look something like this:
</P
14787 CLASS=
"PROGRAMLISTING"
14788 > print1|My Printer
1
14789 print2|My Printer
2
14790 print3|My Printer
3
14791 print4|My Printer
4
14792 print5|My Printer
5
14799 >where the '|' separates aliases of a printer. The fact
14800 that the second alias has a space in it gives a hint to Samba
14801 that it's a comment.
</P
14805 >: Under AIX the default printcap
14809 >. Samba will assume the
14813 > format if the string
14817 > appears in the printcap filename.
</P
14821 >printcap name = /etc/printcap
</B
14826 >printcap name = /etc/myprintcap
</B
14831 NAME=
"PRINTERADMIN"
14833 >printer admin (S)
</DT
14836 >This is a list of users that can do anything to
14837 printers via the remote administration interfaces offered by MS-RPC
14838 (usually using a NT workstation). Note that the root user always
14839 has admin rights.
</P
14843 >printer admin =
<empty string
></B
14849 >printer admin = admin, @staff
</B
14854 NAME=
"PRINTERDRIVER"
14856 >printer driver (S)
</DT
14861 >This is a deprecated
14862 parameter and will be removed in the next major release
14863 following version
2.2. Please see the instructions in
14865 HREF=
"printer_driver2.html"
14867 >Samba
2.2. Printing
14869 > for more information
14870 on the new method of loading printer drivers onto a Samba server.
14873 >This option allows you to control the string
14874 that clients receive when they ask the server for the printer driver
14875 associated with a printer. If you are using Windows95 or Windows NT
14876 then you can use this to automate the setup of printers on your
14879 >You need to set this parameter to the exact string (case
14880 sensitive) that describes the appropriate printer driver for your
14881 system. If you don't know the exact string to use then you should
14882 first try with no
<A
14883 HREF=
"#PRINTERDRIVER"
14887 > printer driver
</I
14890 > option set and the client will
14891 give you a list of printer drivers. The appropriate strings are
14892 shown in a scroll box after you have chosen the printer manufacturer.
</P
14895 HREF=
"#PRINTERDRIVERFILE"
14907 >printer driver = HP LaserJet
4L</B
14912 NAME=
"PRINTERDRIVERFILE"
14914 >printer driver file (G)
</DT
14919 >This is a deprecated
14920 parameter and will be removed in the next major release
14921 following version
2.2. Please see the instructions in
14923 HREF=
"printer_driver2.html"
14925 >Samba
2.2. Printing
14927 > for more information
14928 on the new method of loading printer drivers onto a Samba server.
14931 >This parameter tells Samba where the printer driver
14932 definition file, used when serving drivers to Windows
95 clients, is
14933 to be found. If this is not set, the default is :
</P
14938 CLASS=
"REPLACEABLE"
14940 >SAMBA_INSTALL_DIRECTORY
</I
14943 /lib/printers.def
</TT
14946 >This file is created from Windows
95 <TT
14950 > files found on the Windows
95 client system. For more
14951 details on setting up serving of printer drivers to Windows
95
14952 clients, see the outdated documentation file in the
<TT
14958 >PRINTER_DRIVER.txt
</TT
14962 HREF=
"#PRINTERDRIVERLOCATION"
14966 > printer driver location
</I
14972 >None (set in compile).
</EM
14977 >printer driver file =
14978 /usr/local/samba/printers/drivers.def
</B
14983 NAME=
"PRINTERDRIVERLOCATION"
14985 >printer driver location (S)
</DT
14990 >This is a deprecated
14991 parameter and will be removed in the next major release
14992 following version
2.2. Please see the instructions in
14994 HREF=
"printer_driver2.html"
14996 >Samba
2.2. Printing
14998 > for more information
14999 on the new method of loading printer drivers onto a Samba server.
15002 >This parameter tells clients of a particular printer
15003 share where to find the printer driver files for the automatic
15004 installation of drivers for Windows
95 machines. If Samba is set up
15005 to serve printer drivers to Windows
95 machines, this should be set to
</P
15009 >\\MACHINE\PRINTER$
</B
15012 >Where MACHINE is the NetBIOS name of your Samba server,
15013 and PRINTER$ is a share you set up for serving printer driver
15014 files. For more details on setting this up see the outdated documentation
15020 > PRINTER_DRIVER.txt
</TT
15024 HREF=
"#PRINTERDRIVERFILE"
15028 > printer driver file
</I
15040 >printer driver location = \\MACHINE\PRINTER$
15048 >printer name (S)
</DT
15051 >This parameter specifies the name of the printer
15052 to which print jobs spooled through a printable service will be sent.
</P
15054 >If specified in the [global] section, the printer
15055 name given will be used for any printable service that does
15056 not have its own printer name specified.
</P
15059 >none (but may be
<TT
15063 on many systems)
</EM
15068 >printer name = laserwriter
</B
15079 HREF=
"#PRINTERNAME"
15095 >This parameters controls how printer status
15096 information is interpreted on your system. It also affects the
15097 default values for the
<TT
15117 >lpresume command
</I
15125 > if specified in the
15126 [global] section.
</P
15128 >Currently nine printing styles are supported. They are
15162 >To see what the defaults are for the other print
15163 commands when using the various options use the
<A
15164 HREF=
"testparm.1.html"
15169 >This option can be set on a per printer basis
</P
15171 >See also the discussion in the
<A
15180 >profile acls (S)
</DT
15183 > This boolean parameter was added to fix the problems that people have been
15184 having with storing user profiles on Samba shares from Windows
2000 or
15185 Windows XP clients. New versions of Windows
2000 or Windows XP service
15186 packs do security ACL checking on the owner and ability to write of the
15187 profile directory stored on a local workstation when copied from a Samba
15188 share. When not in domain mode with winbindd then the security info copied
15189 onto the local workstation has no meaning to the logged in user (SID) on
15190 that workstation so the profile storing fails. Adding this parameter
15191 onto a share used for profile storage changes two things about the
15192 returned Windows ACL. Firstly it changes the owner and group owner
15193 of all reported files and directories to be BUILTIN\Administrators,
15194 BUILTIN\Users respectively (SIDs S-
1-
5-
32-
544, S-
1-
5-
32-
545). Secondly
15195 it adds an ACE entry of
"Full Control" to the SID BUILTIN\Users to
15196 every returned ACL. This will allow any Windows
2000 or XP workstation
15197 user to access the profile. Note that if you have multiple users logging
15198 on to a workstation then in order to prevent them from being able to access
15199 each others profiles you must remove the
"Bypass traverse checking" advanced
15200 user right. This will prevent access to other users profile directories as
15201 the top level profile directory (named after the user) is created by the
15202 workstation profile code and has an ACL restricting entry to the directory
15203 tree to the owning user.
</P
15205 >If you didn't understand the above text, you probably should not set
15206 this parameter :-).
</P
15210 >profile acls = no
</B
15221 HREF=
"#MAXPROTOCOL"
15250 NAME=
"QUEUEPAUSECOMMAND"
15252 >queuepause command (S)
</DT
15255 >This parameter specifies the command to be
15256 executed on the server host in order to pause the printer queue.
</P
15258 >This command should be a program or script which takes
15259 a printer name as its only parameter and stops the printer queue,
15260 such that no longer jobs are submitted to the printer.
</P
15262 >This command is not supported by Windows for Workgroups,
15263 but can be issued from the Printers window under Windows
95
15271 > is given then the printer name
15272 is put in its place. Otherwise it is placed at the end of the command.
15275 >Note that it is good practice to include the absolute
15276 path in the command as the PATH may not be available to the
15280 >depends on the setting of
<TT
15291 >queuepause command = disable %p
</B
15296 NAME=
"QUEUERESUMECOMMAND"
15298 >queueresume command (S)
</DT
15301 >This parameter specifies the command to be
15302 executed on the server host in order to resume the printer queue. It
15303 is the command to undo the behavior that is caused by the
15304 previous parameter (
<A
15305 HREF=
"#QUEUEPAUSECOMMAND"
15309 > queuepause command
</I
15314 >This command should be a program or script which takes
15315 a printer name as its only parameter and resumes the printer queue,
15316 such that queued jobs are resubmitted to the printer.
</P
15318 >This command is not supported by Windows for Workgroups,
15319 but can be issued from the Printers window under Windows
95
15327 > is given then the printer name
15328 is put in its place. Otherwise it is placed at the end of the
15331 >Note that it is good practice to include the absolute
15332 path in the command as the PATH may not be available to the
15336 >depends on the setting of
<A
15350 >queuepause command = enable %p
15361 >This boolean parameter controls whether
<A
15365 > will support the
"Read
15366 Block Multiplex" SMB. This is now rarely used and defaults to
15370 >. You should never need to set this
15385 >This is a list of users that are given read-only
15386 access to a service. If the connecting user is in this list then
15387 they will not be given write access, no matter what the
<A
15396 option is set to. The list can include group names using the
15397 syntax described in the
<A
15398 HREF=
"#INVALIDUSERS"
15415 > parameter and the
<A
15416 HREF=
"#INVALIDUSERS"
15428 >read list =
<empty string
></B
15433 >read list = mary, @students
</B
15443 >An inverted synonym is
<A
15453 >If this parameter is
<TT
15457 of a service may not create or modify files in the service's
15460 >Note that a printable service (
<B
15462 >printable = yes
</B
15466 > allow writing to the directory
15467 (user privileges permitting), but only via spooling operations.
</P
15471 >read only = yes
</B
15481 >This parameter controls whether or not the server
15482 will support the raw read SMB requests when transferring data
15485 >If enabled, raw reads allow reads of
65535 bytes in
15486 one packet. This typically provides a major performance benefit.
15489 >However, some clients either negotiate the allowable
15490 block size incorrectly or are incapable of supporting larger block
15491 sizes, and for these clients you may need to disable raw reads.
</P
15493 >In general this parameter should be viewed as a system tuning
15494 tool and left severely alone. See also
<A
15522 affects the overlap of disk reads/writes with network reads/writes.
15523 If the amount of data being transferred in several of the SMB
15524 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
15525 than this value then the server begins writing the data before it
15526 has received the whole packet from the network, or in the case of
15527 SMBreadbraw, it begins writing to the network before all the data
15528 has been read from disk.
</P
15530 >This overlapping works best when the speeds of disk and
15531 network access are similar, having very little effect when the
15532 speed of one is much greater than the other.
</P
15534 >The default value is
16384, but very little experimentation
15535 has been done yet to determine the optimal value, and it is likely
15536 that the best value will vary greatly between systems anyway.
15537 A value over
65536 is pointless and will cause you to allocate
15538 memory unnecessarily.
</P
15542 >read size =
16384</B
15547 >read size =
8192</B
15552 NAME=
"REMOTEANNOUNCE"
15554 >remote announce (G)
</DT
15557 >This option allows you to setup
<A
15561 > to periodically announce itself
15562 to arbitrary IP addresses with an arbitrary workgroup name.
</P
15564 >This is useful if you want your Samba server to appear
15565 in a remote workgroup for which the normal browse propagation
15566 rules don't work. The remote workgroup can be anywhere that you
15567 can send IP packets to.
</P
15573 >remote announce =
192.168.2.255/SERVERS
15574 192.168.4.255/STAFF
</B
15577 >the above line would cause
<B
15580 > to announce itself
15581 to the two given IP addresses using the given workgroup names.
15582 If you leave out the workgroup name then the one given in
15592 parameter is used instead.
</P
15594 >The IP addresses you choose would normally be the broadcast
15595 addresses of the remote networks, but can also be the IP addresses
15596 of known browse masters if your network config is that stable.
</P
15598 >See the documentation file
<TT
15609 >remote announce =
<empty string
>
15615 NAME=
"REMOTEBROWSESYNC"
15617 >remote browse sync (G)
</DT
15620 >This option allows you to setup
<A
15624 > to periodically request
15625 synchronization of browse lists with the master browser of a Samba
15626 server that is on a remote segment. This option will allow you to
15627 gain browse lists for multiple workgroups across routed networks. This
15628 is done in a manner that does not work with any non-Samba servers.
</P
15630 >This is useful if you want your Samba server and all local
15631 clients to appear in a remote workgroup for which the normal browse
15632 propagation rules don't work. The remote workgroup can be anywhere
15633 that you can send IP packets to.
</P
15639 >remote browse sync =
192.168.2.255 192.168.4.255
15643 >the above line would cause
<B
15647 the master browser on the specified subnets or addresses to
15648 synchronize their browse lists with the local server.
</P
15650 >The IP addresses you choose would normally be the broadcast
15651 addresses of the remote networks, but can also be the IP addresses
15652 of known browse masters if your network config is that stable. If
15653 a machine IP address is given Samba makes NO attempt to validate
15654 that the remote machine is available, is listening, nor that it
15655 is in fact the browse master on its segment.
</P
15659 >remote browse sync =
<empty string
>
15665 NAME=
"RESTRICTANONYMOUS"
15667 >restrict anonymous (G)
</DT
15670 >This is a boolean parameter. If it is
<TT
15674 anonymous access to the server will be restricted, namely in the
15675 case where the server is expecting the client to send a username,
15676 but it doesn't. Setting it to
<TT
15679 > will force these anonymous
15680 connections to be denied, and the client will be required to always
15681 supply a username and password when connecting. Use of this parameter
15682 is only recommended for homogeneous NT client environments.
</P
15684 >This parameter makes the use of macro expansions that rely
15685 on the username (%U, %G, etc) consistent. NT
4.0
15686 likes to use anonymous connections when refreshing the share list,
15687 and this is a way to work around that.
</P
15689 >When restrict anonymous is
<TT
15692 >, all anonymous connections
15693 are denied no matter what they are for. This can effect the ability
15694 of a machine to access the Samba Primary Domain Controller to revalidate
15695 its machine account after someone else has logged on the client
15696 interactively. The NT client will display a message saying that
15697 the machine's account in the domain doesn't exist or the password is
15698 bad. The best way to deal with this is to reboot NT client machines
15699 between interactive logons, using
"Shutdown and Restart", rather
15700 than
"Close all programs and logon as a different user".
</P
15704 >restrict anonymous = no
</B
15715 HREF=
"#ROOTDIRECTORY"
15719 >root directory
"</I
15732 HREF="#ROOTDIRECTORY
"
15736 >root directory"</I
15743 NAME=
"ROOTDIRECTORY"
15745 >root directory (G)
</DT
15748 >The server will
<B
15752 Change its root directory) to this directory on startup. This is
15753 not strictly necessary for secure operation. Even without it the
15754 server will deny access to files not in one of the service entries.
15755 It may also check for, and deny access to, soft links to other
15756 parts of the filesystem, or attempts to use
".." in file names
15757 to access other directories (depending on the setting of the
<A
15774 than
"/" adds an extra level of security, but at a price. It
15775 absolutely ensures that no access is given to files not in the
15776 sub-tree specified in the
<TT
15784 > some files needed for
15785 complete operation of the server. To maintain full operability
15786 of the server you will need to mirror some system files
15792 > tree. In particular
15793 you will need to mirror
<TT
15797 subset of it), and any binaries or configuration files needed for
15798 printing (if required). The set of files that must be mirrored is
15799 operating system dependent.
</P
15803 >root directory = /
</B
15808 >root directory = /homes/smb
</B
15813 NAME=
"ROOTPOSTEXEC"
15815 >root postexec (S)
</DT
15818 >This is the same as the
<TT
15824 parameter except that the command is run as root. This
15825 is useful for unmounting filesystems
15826 (such as CDROMs) after a connection is closed.
</P
15840 >root postexec =
<empty string
>
15848 >root preexec (S)
</DT
15851 >This is the same as the
<TT
15857 parameter except that the command is run as root. This
15858 is useful for mounting filesystems (such as CDROMs) when a
15859 connection is opened.
</P
15870 HREF=
"#PREEXECCLOSE"
15881 >root preexec =
<empty string
>
15887 NAME=
"ROOTPREEXECCLOSE"
15889 >root preexec close (S)
</DT
15892 >This is the same as the
<TT
15898 > parameter except that the command is run as root.
</P
15909 HREF=
"#PREEXECCLOSE"
15920 >root preexec close = no
</B
15930 >This option affects how clients respond to
15931 Samba and is one of the most important settings in the
<TT
15936 >The option sets the
"security mode bit" in replies to
15937 protocol negotiations with
<A
15942 > to turn share level security on or off. Clients decide
15943 based on this bit whether (and how) to transfer user and password
15944 information to the server.
</P
15948 >security = user
</B
15950 the most common setting needed when talking to Windows
98 and
15953 >The alternatives are
<B
15955 >security = share
</B
15959 >security = server
</B
15966 >In versions of Samba prior to
2.0.0, the default was
15969 >security = share
</B
15970 > mainly because that was
15971 the only option at one stage.
</P
15973 >There is a bug in WfWg that has relevance to this
15974 setting. When in user or server level security a WfWg client
15975 will totally ignore the password you type in the
"connect
15976 drive" dialog box. This makes it very difficult (if not impossible)
15977 to connect to a Samba service as anyone except the user that
15978 you are logged into WfWg as.
</P
15980 >If your PCs use usernames that are the same as their
15981 usernames on the UNIX machine then you will want to use
15984 >security = user
</B
15985 >. If you mostly use usernames
15986 that don't exist on the UNIX box then use
<B
15992 >You should also use
<B
15994 >security = share
</B
15996 want to mainly setup shares without a password (guest shares). This
15997 is commonly used for a shared printer server. It is more difficult
15998 to setup guest shares with
<B
16000 >security = user
</B
16011 >parameter for details.
</P
16013 >It is possible to use
<B
16018 > where it is offers both user and share
16019 level security under different
<A
16020 HREF=
"#NETBIOSALIASES"
16024 >NetBIOS aliases
</I
16029 >The different settings will now be explained.
</P
16032 NAME=
"SECURITYEQUALSSHARE"
16039 >When clients connect to a share level security server they
16040 need not log onto the server with a valid username and password before
16041 attempting to connect to a shared resource (although modern clients
16042 such as Windows
95/
98 and Windows NT will send a logon request with
16043 a username but no password when talking to a
<B
16047 > server). Instead, the clients send authentication information
16048 (passwords) on a per-share basis, at the time they attempt to connect
16057 uses a valid UNIX user to act on behalf of the client, even in
16060 >security = share
</B
16061 > level security.
</P
16063 >As clients are not required to send a username to the server
16064 in share level security,
<B
16068 techniques to determine the correct UNIX user to use on behalf
16071 >A list of possible UNIX usernames to match with the given
16072 client password is constructed using the following methods :
</P
16087 > parameter is set, then all the other
16088 stages are missed and only the
<A
16089 HREF=
"#GUESTACCOUNT"
16096 > username is checked.
16101 >Is a username is sent with the share connection
16102 request, then this username (after mapping - see
<A
16103 HREF=
"#USERNAMEMAP"
16111 is added as a potential username.
</P
16115 >If the client did a previous
<EM
16118 > request (the SessionSetup SMB call) then the
16119 username sent in this SMB will be added as a potential username.
16124 >The name of the service the client requested is
16125 added as a potential username.
</P
16129 >The NetBIOS name of the client is added to
16130 the list as a potential username.
</P
16134 >Any users on the
<A
16142 > list are added as potential usernames.
16153 not set, then this list is then tried with the supplied password.
16154 The first user for whom the password matches will be used as the
16163 set, or no username can be determined then if the share is marked
16164 as available to the
<TT
16170 guest user will be used, otherwise access is denied.
</P
16172 >Note that it can be
<EM
16175 in share-level security as to which UNIX username will eventually
16176 be used in granting access.
</P
16178 >See also the section
<A
16180 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
16184 NAME=
"SECURITYEQUALSUSER"
16191 >This is the default security setting in Samba
2.2.
16192 With user-level security a client must first
"log-on" with a
16193 valid username and password (which can be mapped using the
<A
16194 HREF=
"#USERNAMEMAP"
16202 parameter). Encrypted passwords (see the
<A
16203 HREF=
"#ENCRYPTPASSWORDS"
16207 >encrypted passwords
</I
16210 > parameter) can also
16211 be used in this security mode. Parameters such as
<A
16227 > if set are then applied and
16228 may change the UNIX user to use on this connection, but only after
16229 the user has been successfully authenticated.
</P
16233 > that the name of the resource being
16236 > sent to the server until after
16237 the server has successfully authenticated the client. This is why
16238 guest shares don't work in user level security without allowing
16239 the server to automatically map unknown users into the
<A
16240 HREF=
"#GUESTACCOUNT"
16257 > parameter for details on doing this.
</P
16259 >See also the section
<A
16261 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
16265 NAME=
"SECURITYEQUALSSERVER"
16272 >In this mode Samba will try to validate the username/password
16273 by passing it to another SMB server, such as an NT box. If this
16274 fails it will revert to
<B
16276 >security = user
</B
16278 that if encrypted passwords have been negotiated then Samba cannot
16279 revert back to checking the UNIX password file, it must have a valid
16283 > file to check users against. See the
16284 documentation file in the
<TT
16290 >ENCRYPTION.txt
</TT
16291 > for details on how to set this
16296 > that from the client's point of
16299 >security = server
</B
16300 > is the same as
<B
16302 > security = user
</B
16303 >. It only affects how the server deals
16304 with the authentication, it does not in any way affect what the
16309 > that the name of the resource being
16312 > sent to the server until after
16313 the server has successfully authenticated the client. This is why
16314 guest shares don't work in user level security without allowing
16315 the server to automatically map unknown users into the
<A
16316 HREF=
"#GUESTACCOUNT"
16333 > parameter for details on doing this.
</P
16335 >See also the section
<A
16337 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
16341 HREF=
"#PASSWORDSERVER"
16349 > parameter and the
<A
16350 HREF=
"#ENCRYPTPASSWORDS"
16354 >encrypted passwords
</I
16361 NAME=
"SECURITYEQUALSDOMAIN"
16368 >This mode will only work correctly if
<A
16369 HREF=
"smbpasswd.8.html"
16372 > has been used to add this
16373 machine into a Windows NT Domain. It expects the
<A
16374 HREF=
"#ENCRYPTPASSWORDS"
16378 >encrypted passwords
</I
16382 > parameter to be set to
<TT
16386 mode Samba will try to validate the username/password by passing
16387 it to a Windows NT Primary or Backup Domain Controller, in exactly
16388 the same way that a Windows NT Server would do.
</P
16392 > that a valid UNIX user must still
16393 exist as well as the account on the Domain Controller to allow
16394 Samba to have a valid UNIX account to map file access to.
</P
16398 > that from the client's point
16401 >security = domain
</B
16402 > is the same as
<B
16406 >. It only affects how the server deals with the authentication,
16407 it does not in any way affect what the client sees.
</P
16411 > that the name of the resource being
16414 > sent to the server until after
16415 the server has successfully authenticated the client. This is why
16416 guest shares don't work in user level security without allowing
16417 the server to automatically map unknown users into the
<A
16418 HREF=
"#GUESTACCOUNT"
16435 > parameter for details on doing this.
</P
16439 > There is currently a bug in the
16440 implementation of
<B
16442 >security = domain
</B
16444 to multi-byte character set usernames. The communication with a
16445 Domain Controller must be done in UNICODE and Samba currently
16446 does not widen multi-byte user names to UNICODE correctly, thus
16447 a multi-byte username will not be recognized correctly at the
16448 Domain Controller. This issue will be addressed in a future release.
</P
16450 >See also the section
<A
16452 > NOTE ABOUT USERNAME/PASSWORD VALIDATION
</A
16456 HREF=
"#PASSWORDSERVER"
16464 > parameter and the
<A
16465 HREF=
"#ENCRYPTPASSWORDS"
16469 >encrypted passwords
</I
16477 >security = USER
</B
16482 >security = DOMAIN
</B
16487 NAME=
"SECURITYMASK"
16489 >security mask (S)
</DT
16492 >This parameter controls what UNIX permission
16493 bits can be modified when a Windows NT client is manipulating
16494 the UNIX permission on a file using the native NT security
16497 >This parameter is applied as a mask (AND'ed with) to
16498 the changed permission bits, thus preventing any bits not in
16499 this mask from being modified. Essentially, zero bits in this
16500 mask may be treated as a set of bits the user is not allowed
16503 >If not set explicitly this parameter is
0777, allowing
16504 a user to modify all the user/group/world permissions on a file.
16509 > that users who can access the
16510 Samba server through other means can easily bypass this
16511 restriction, so it is primarily useful for standalone
16512 "appliance" systems. Administrators of most normal systems will
16513 probably want to leave it set to
<TT
16519 HREF=
"#FORCEDIRECTORYSECURITYMODE"
16523 >force directory security mode
</I
16528 HREF=
"#DIRECTORYSECURITYMASK"
16537 HREF=
"#FORCESECURITYMODE"
16541 >force security mode
</I
16548 >security mask =
0777</B
16553 >security mask =
0770</B
16558 NAME=
"SERVERSTRING"
16560 >server string (G)
</DT
16563 >This controls what string will show up in the
16564 printer comment box in print manager and next to the IPC connection
16568 >. It can be any string that you wish
16569 to show to your users.
</P
16571 >It also sets what will appear in browse lists next
16572 to the machine name.
</P
16579 > will be replaced with the Samba
16587 > will be replaced with the
16592 >server string = Samba %v
</B
16597 >server string = University of GNUs Samba
16603 NAME=
"SETDIRECTORY"
16605 >set directory (S)
</DT
16610 >set directory = no
</B
16612 users of the service may not use the setdir command to change
16618 > command is only implemented
16619 in the Digital Pathworks client. See the Pathworks documentation
16624 >set directory = no
</B
16631 >share modes (S)
</DT
16634 >This enables or disables the honoring of
16640 > during a file open. These
16641 modes are used by clients to gain exclusive read or write access
16644 >These open modes are not directly supported by UNIX, so
16645 they are simulated using shared memory, or lock files if your
16646 UNIX doesn't support shared memory (almost all do).
</P
16648 >The share modes that are enabled by this option are
16672 >This option gives full share compatibility and enabled
16677 > turn this parameter
16678 off as many Windows applications will break if you do so.
</P
16682 >share modes = yes
</B
16687 NAME=
"SHORTPRESERVECASE"
16689 >short preserve case (S)
</DT
16692 >This boolean parameter controls if new files
16693 which conform to
8.3 syntax, that is all in upper case and of
16694 suitable length, are created upper case, or if they are forced
16696 HREF=
"#DEFAULTCASE"
16704 >. This option can be use with
<A
16705 HREF=
"#PRESERVECASE"
16708 >preserve case = yes
</B
16711 > to permit long filenames to retain their case, while short
16712 names are lowered.
</P
16714 >See the section on
<A
16721 >short preserve case = yes
</B
16726 NAME=
"SHOWADDPRINTERWIZARD"
16728 >show add printer wizard (G)
</DT
16731 >With the introduction of MS-RPC based printing support
16732 for Windows NT/
2000 client in Samba
2.2, a
"Printers..." folder will
16733 appear on Samba hosts in the share listing. Normally this folder will
16734 contain an icon for the MS Add Printer Wizard (APW). However, it is
16735 possible to disable this feature regardless of the level of privilege
16736 of the connected user.
</P
16738 >Under normal circumstances, the Windows NT/
2000 client will
16739 open a handle on the printer server with OpenPrinterEx() asking for
16740 Administrator privileges. If the user does not have administrative
16741 access on the print server (i.e is not root or a member of the
16747 > group), the OpenPrinterEx()
16748 call fails and the client makes another open call with a request for
16749 a lower privilege level. This should succeed, however the APW
16750 icon will not be displayed.
</P
16755 >show add printer wizard
</I
16758 parameter will always cause the OpenPrinterEx() on the server
16759 to fail. Thus the APW icon will never be displayed.
<EM
16761 >This does not prevent the same user from having
16762 administrative privilege on an individual printer.
</P
16765 HREF=
"#ADDPRINTERCOMMAND"
16774 HREF=
"#DELETEPRINTERCOMMAND"
16778 >deleteprinter command
</I
16782 HREF=
"#PRINTERADMIN"
16793 >show add printer wizard = yes
</B
16798 NAME=
"SMBPASSWDFILE"
16800 >smb passwd file (G)
</DT
16803 >This option sets the path to the encrypted
16804 smbpasswd file. By default the path to the smbpasswd file
16805 is compiled into Samba.
</P
16809 >smb passwd file = ${prefix}/private/smbpasswd
16815 >smb passwd file = /etc/samba/smbpasswd
16821 NAME=
"SOCKETADDRESS"
16823 >socket address (G)
</DT
16826 >This option allows you to control what
16827 address Samba will listen for connections on. This is used to
16828 support multiple virtual interfaces on the one server, each
16829 with a different configuration.
</P
16831 >By default Samba will accept connections on any
16836 >socket address =
192.168.2.20</B
16842 NAME=
"SOCKETOPTIONS"
16844 >socket options (G)
</DT
16847 >This option allows you to set socket options
16848 to be used when talking with the client.
</P
16850 >Socket options are controls on the networking layer
16851 of the operating systems which allow the connection to be
16854 >This option will typically be used to tune your Samba
16855 server for optimal performance for your local network. There is
16856 no way that Samba can know what the optimal parameters are for
16857 your net, so you must experiment and choose them yourself. We
16858 strongly suggest you read the appropriate documentation for your
16859 operating system first (perhaps
<B
16865 >You may find that on some systems Samba will say
16866 "Unknown socket option" when you supply an option. This means you
16867 either incorrectly typed it or you need to add an include file
16868 to includes.h for your OS. If the latter is the case please
16869 send the patch to
<A
16870 HREF=
"mailto:samba@samba.org"
16872 > samba@samba.org
</A
16875 >Any of the supported socket options may be combined
16876 in any way you like, as long as your OS allows it.
</P
16878 >This is the list of socket options currently settable
16879 using this option:
</P
16905 >IPTOS_THROUGHPUT
</P
16925 >Those marked with a
<EM
16928 argument. The others can optionally take a
1 or
0 argument to enable
16929 or disable the option, by default they will be enabled if you
16930 don't specify
1 or
0.
</P
16932 >To specify an argument use the syntax SOME_OPTION = VALUE
16935 >SO_SNDBUF =
8192</B
16936 >. Note that you must
16937 not have any spaces before or after the = sign.
</P
16939 >If you are on a local network then a sensible option
16944 >socket options = IPTOS_LOWDELAY
</B
16947 >If you have a local network then you could try:
</P
16951 >socket options = IPTOS_LOWDELAY TCP_NODELAY
</B
16954 >If you are on a wide area network then perhaps try
16955 setting IPTOS_THROUGHPUT.
</P
16957 >Note that several of the options may cause your Samba
16958 server to fail completely. Use these options with caution!
</P
16962 >socket options = TCP_NODELAY
</B
16967 >socket options = IPTOS_LOWDELAY
</B
16972 NAME=
"SOURCEENVIRONMENT"
16974 >source environment (G)
</DT
16977 >This parameter causes Samba to set environment
16978 variables as per the content of the file named.
</P
16980 >If the value of this parameter starts with a
"|" character
16981 then Samba will treat that value as a pipe command to open and
16982 will set the environment variables from the output of the pipe.
</P
16984 >The contents of the file or the output of the pipe should
16985 be formatted as the output of the standard Unix
<B
16989 > command. This is of the form :
</P
16991 >Example environment entry:
</P
16995 >SAMBA_NETBIOS_NAME = myhostname
</B
16999 >No default value
</EM
17004 >source environment = |/etc/smb.conf.sh
17010 >source environment =
17011 /usr/local/smb_env_vars
</B
17021 >This variable is part of SSL-enabled Samba. This
17022 is only available if the SSL libraries have been compiled on your
17023 system and the configure option
<B
17027 given at configure time.
</P
17029 >This variable enables or disables the entire SSL mode. If
17033 >, the SSL-enabled Samba behaves
17034 exactly like the non-SSL Samba. If set to
<TT
17038 it depends on the variables
<A
17047 HREF=
"#SSLHOSTSRESIGN"
17051 >ssl hosts resign
</I
17055 connection will be required.
</P
17064 NAME=
"SSLCACERTDIR"
17066 >ssl CA certDir (G)
</DT
17069 >This variable is part of SSL-enabled Samba. This
17070 is only available if the SSL libraries have been compiled on your
17071 system and the configure option
<B
17075 given at configure time.
</P
17077 >This variable defines where to look up the Certification
17078 Authorities. The given directory should contain one file for
17079 each CA that Samba will trust. The file name must be the hash
17080 value over the
"Distinguished Name" of the CA. How this directory
17081 is set up is explained later in this document. All files within the
17082 directory that don't fit into this naming scheme are ignored. You
17083 don't need this variable if you don't verify client certificates.
</P
17087 >ssl CA certDir = /usr/local/ssl/certs
17093 NAME=
"SSLCACERTFILE"
17095 >ssl CA certFile (G)
</DT
17098 >This variable is part of SSL-enabled Samba. This
17099 is only available if the SSL libraries have been compiled on your
17100 system and the configure option
<B
17104 given at configure time.
</P
17106 >This variable is a second way to define the trusted CAs.
17107 The certificates of the trusted CAs are collected in one big
17108 file and this variable points to the file. You will probably
17109 only use one of the two ways to define your CAs. The first choice is
17110 preferable if you have many CAs or want to be flexible, the second
17111 is preferable if you only have one CA and want to keep things
17112 simple (you won't need to create the hashed file names). You
17113 don't need this variable if you don't verify client certificates.
</P
17117 >ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
17125 >ssl ciphers (G)
</DT
17128 >This variable is part of SSL-enabled Samba. This
17129 is only available if the SSL libraries have been compiled on your
17130 system and the configure option
<B
17134 given at configure time.
</P
17136 >This variable defines the ciphers that should be offered
17137 during SSL negotiation. You should not set this variable unless
17138 you know what you are doing.
</P
17142 NAME=
"SSLCLIENTCERT"
17144 >ssl client cert (G)
</DT
17147 >This variable is part of SSL-enabled Samba. This
17148 is only available if the SSL libraries have been compiled on your
17149 system and the configure option
<B
17153 given at configure time.
</P
17155 >The certificate in this file is used by
<A
17156 HREF=
"smbclient.1.html"
17162 > if it exists. It's needed
17163 if the server requires a client certificate.
</P
17167 >ssl client cert = /usr/local/ssl/certs/smbclient.pem
17173 NAME=
"SSLCLIENTKEY"
17175 >ssl client key (G)
</DT
17178 >This variable is part of SSL-enabled Samba. This
17179 is only available if the SSL libraries have been compiled on your
17180 system and the configure option
<B
17184 given at configure time.
</P
17186 >This is the private key for
<A
17187 HREF=
"smbclient.1.html"
17193 >. It's only needed if the
17194 client should have a certificate.
</P
17198 >ssl client key = /usr/local/ssl/private/smbclient.pem
17204 NAME=
"SSLCOMPATIBILITY"
17206 >ssl compatibility (G)
</DT
17209 >This variable is part of SSL-enabled Samba. This
17210 is only available if the SSL libraries have been compiled on your
17211 system and the configure option
<B
17215 given at configure time.
</P
17217 >This variable defines whether OpenSSL should be configured
17218 for bug compatibility with other SSL implementations. This is
17219 probably not desirable because currently no clients with SSL
17220 implementations other than OpenSSL exist.
</P
17224 >ssl compatibility = no
</B
17229 NAME=
"SSLEGDSOCKET"
17231 >ssl egd socket (G)
</DT
17234 >This variable is part of SSL-enabled Samba. This
17235 is only available if the SSL libraries have been compiled on your
17236 system and the configure option
<B
17240 given at configure time.
</P
17242 > This option is used to define the location of the communiation socket of
17243 an EGD or PRNGD daemon, from which entropy can be retrieved. This option
17244 can be used instead of or together with the
<A
17245 HREF=
"#SSLENTROPYFILE"
17249 >ssl entropy file
</I
17253 directive.
255 bytes of entropy will be retrieved from the daemon.
17262 NAME=
"SSLENTROPYBYTES"
17264 >ssl entropy bytes (G)
</DT
17267 >This variable is part of SSL-enabled Samba. This
17268 is only available if the SSL libraries have been compiled on your
17269 system and the configure option
<B
17273 given at configure time.
</P
17275 > This parameter is used to define the number of bytes which should
17276 be read from the
<A
17277 HREF=
"#SSLENTROPYFILE"
17285 > If a -
1 is specified, the entire file will
17291 >ssl entropy bytes =
255</B
17296 NAME=
"SSLENTROPYFILE"
17298 >ssl entropy file (G)
</DT
17301 >This variable is part of SSL-enabled Samba. This
17302 is only available if the SSL libraries have been compiled on your
17303 system and the configure option
<B
17307 given at configure time.
</P
17309 > This parameter is used to specify a file from which processes will
17310 read
"random bytes" on startup. In order to seed the internal pseudo
17311 random number generator, entropy must be provided. On system with a
17315 > device file, the processes
17316 will retrieve its entropy from the kernel. On systems without kernel
17317 entropy support, a file can be supplied that will be read on startup
17318 and that will be used to seed the PRNG.
17333 HREF=
"#SSLHOSTSRESIGN"
17337 > ssl hosts resign
</I
17344 NAME=
"SSLHOSTSRESIGN"
17346 >ssl hosts resign (G)
</DT
17349 >This variable is part of SSL-enabled Samba. This
17350 is only available if the SSL libraries have been compiled on your
17351 system and the configure option
<B
17355 given at configure time.
</P
17357 >These two variables define whether Samba will go
17358 into SSL mode or not. If none of them is defined, Samba will
17359 allow only SSL connections. If the
<A
17368 hosts (by IP-address, IP-address range, net group or name),
17369 only these hosts will be forced into SSL mode. If the
<TT
17372 > ssl hosts resign
</I
17374 > variable lists hosts, only these
17377 > be forced into SSL mode. The syntax for these two
17378 variables is the same as for the
<A
17394 > pair of variables, only
17395 that the subject of the decision is different: It's not the access
17396 right but whether SSL is used or not.
</P
17398 >The example below requires SSL connections from all hosts
17399 outside the local net (which is
192.168.*.*).
</P
17403 >ssl hosts =
<empty string
></B
17408 >ssl hosts resign =
<empty string
></B
17413 >ssl hosts resign =
192.168.
</B
17418 NAME=
"SSLREQUIRECLIENTCERT"
17420 >ssl require clientcert (G)
</DT
17423 >This variable is part of SSL-enabled Samba. This
17424 is only available if the SSL libraries have been compiled on your
17425 system and the configure option
<B
17429 given at configure time.
</P
17431 >If this variable is set to
<TT
17435 server will not tolerate connections from clients that don't
17436 have a valid certificate. The directory/file given in
<A
17437 HREF=
"#SSLCACERTDIR"
17446 HREF=
"#SSLCACERTFILE"
17454 > will be used to look up the CAs that issued
17455 the client's certificate. If the certificate can't be verified
17456 positively, the connection will be terminated. If this variable
17460 >, clients don't need certificates.
17461 Contrary to web applications you really
<EM
17464 require client certificates. In the web environment the client's
17465 data is sensitive (credit card numbers) and the server must prove
17466 to be trustworthy. In a file server environment the server's data
17467 will be sensitive and the clients must prove to be trustworthy.
</P
17471 >ssl require clientcert = no
</B
17476 NAME=
"SSLREQUIRESERVERCERT"
17478 >ssl require servercert (G)
</DT
17481 >This variable is part of SSL-enabled Samba. This
17482 is only available if the SSL libraries have been compiled on your
17483 system and the configure option
<B
17487 given at configure time.
</P
17489 >If this variable is set to
<TT
17494 HREF=
"smbclient.1.html"
17501 > will request a certificate from the server. Same as
17503 HREF=
"#SSLREQUIRECLIENTCERT"
17511 > for the server.
</P
17515 >ssl require servercert = no
</B
17521 NAME=
"SSLSERVERCERT"
17523 >ssl server cert (G)
</DT
17526 >This variable is part of SSL-enabled Samba. This
17527 is only available if the SSL libraries have been compiled on your
17528 system and the configure option
<B
17532 given at configure time.
</P
17534 >This is the file containing the server's certificate.
17537 > have a certificate. The
17538 file may also contain the server's private key. See later for
17539 how certificates and private keys are created.
</P
17543 >ssl server cert =
<empty string
>
17549 NAME=
"SSLSERVERKEY"
17551 >ssl server key (G)
</DT
17554 >This variable is part of SSL-enabled Samba. This
17555 is only available if the SSL libraries have been compiled on your
17556 system and the configure option
<B
17560 given at configure time.
</P
17562 >This file contains the private key of the server. If
17563 this variable is not defined, the key is looked up in the
17564 certificate file (it may be appended to the certificate).
17567 > have a private key
17568 and the certificate
<EM
17571 match this private key.
</P
17575 >ssl server key =
<empty string
>
17583 >ssl version (G)
</DT
17586 >This variable is part of SSL-enabled Samba. This
17587 is only available if the SSL libraries have been compiled on your
17588 system and the configure option
<B
17592 given at configure time.
</P
17594 >This enumeration variable defines the versions of the
17595 SSL protocol that will be used.
<TT
17599 dynamic negotiation of SSL v2 or v3,
<TT
17606 > results in SSL v3 and
17610 > results in TLS v1. TLS (Transport Layer
17611 Security) is the new standard for SSL.
</P
17615 >ssl version =
"ssl2or3"</B
17622 >stat cache (G)
</DT
17625 >This parameter determines if
<A
17629 > will use a cache in order to
17630 speed up case insensitive name mappings. You should never need
17631 to change this parameter.
</P
17635 >stat cache = yes
</B
17640 NAME=
"STATCACHESIZE"
17642 >stat cache size (G)
</DT
17645 >This parameter determines the number of
17652 never need to change this parameter.
</P
17656 >stat cache size =
50</B
17666 >This enables or disables logging of connections
17667 to a status file that
<A
17668 HREF=
"smbstatus.1.html"
17674 >With this disabled
<B
17678 to tell you what connections are active. You should never need to
17679 change this parameter.
</P
17688 NAME=
"STRICTALLOCATE"
17690 >strict allocate (S)
</DT
17693 >This is a boolean that controls the handling of
17694 disk space allocation in the server. When this is set to
<TT
17698 the server will change from UNIX behaviour of not committing real
17699 disk storage blocks when a file is extended to the Windows behaviour
17700 of actually forcing the disk system to allocate real storage blocks
17701 when a file is created or extended to be a given size. In UNIX
17702 terminology this means that Samba will stop creating sparse files.
17703 This can be slow on some systems.
</P
17705 >When strict allocate is
<TT
17708 > the server does sparse
17709 disk block allocation when a file is extended.
</P
17711 >Setting this to
<TT
17714 > can help Samba return
17715 out of quota messages on systems that are restricting the disk quota
17720 >strict allocate = no
</B
17725 NAME=
"STRICTLOCKING"
17727 >strict locking (S)
</DT
17730 >This is a boolean that controls the handling of
17731 file locking in the server. When this is set to
<TT
17735 the server will check every read and write access for file locks, and
17736 deny access if locks exist. This can be slow on some systems.
</P
17738 >When strict locking is
<TT
17741 > the server does file
17742 lock checks only when the client explicitly asks for them.
</P
17744 >Well-behaved clients always ask for lock checks when it
17745 is important, so in the vast majority of cases
<B
17749 > is preferable.
</P
17753 >strict locking = no
</B
17760 >strict sync (S)
</DT
17763 >Many Windows applications (including the Windows
17764 98 explorer shell) seem to confuse flushing buffer contents to
17765 disk with doing a sync to disk. Under UNIX, a sync call forces
17766 the process to be suspended until the kernel has ensured that
17767 all outstanding data in kernel disk buffers has been safely stored
17768 onto stable storage. This is very slow and should only be done
17769 rarely. Setting this parameter to
<TT
17773 default) means that
<A
17777 > ignores the Windows applications requests for
17778 a sync call. There is only a possibility of losing data if the
17779 operating system itself that Samba is running on crashes, so there is
17780 little danger in this default setting. In addition, this fixes many
17781 performance problems that people have reported with the new Windows98
17782 explorer shell file copies.
</P
17797 >strict sync = no
</B
17807 >This parameter is now unused in Samba (
2.2.5 and above).
17808 It used strip trailing dots off UNIX filenames but was not correctly implmented.
17809 In Samba
2.2.5 and above UNIX filenames ending in a dot are invalid Windows long
17810 filenames (as they are in Windows NT and above) and are mangled to
8.3 before
17811 being returned to a client.
</P
17822 >sync always (S)
</DT
17825 >This is a boolean parameter that controls
17826 whether writes will always be written to stable storage before
17827 the write call returns. If this is
<TT
17830 > then the server will be
17831 guided by the client's request in each write call (clients can
17832 set a bit indicating that a particular write should be synchronous).
17836 > then every write will be followed by a
<B
17840 > call to ensure the data is written to disk. Note that
17846 > parameter must be set to
17850 > in order for this parameter to have
17866 >sync always = no
</B
17876 >This parameter maps how Samba debug messages
17877 are logged onto the system syslog logging levels. Samba debug
17878 level zero maps onto syslog
<TT
17882 level one maps onto
<TT
17889 >, debug level three
17890 maps onto LOG_INFO. All higher levels are mapped to
<TT
17895 >This parameter sets the threshold for sending messages
17896 to syslog. Only messages with debug level less than this value
17897 will be sent to syslog.
</P
17908 >syslog only (G)
</DT
17911 >If this parameter is set then Samba debug
17912 messages are logged into the system syslog only, and not to
17913 the debug log files.
</P
17917 >syslog only = no
</B
17922 NAME=
"TEMPLATEHOMEDIR"
17924 >template homedir (G)
</DT
17927 >When filling out the user information for a Windows NT
17929 HREF=
"winbindd.8.html"
17933 uses this parameter to fill in the home directory for that user.
17939 > is present it is substituted
17940 with the user's Windows NT domain name. If the string
<TT
17946 > is present it is substituted with the user's Windows
17951 >template homedir = /home/%D/%U
</B
17956 NAME=
"TEMPLATESHELL"
17958 >template shell (G)
</DT
17961 >When filling out the user information for a Windows NT
17963 HREF=
"winbindd.8.html"
17967 uses this parameter to fill in the login shell for that user.
</P
17971 >template shell = /bin/false
</B
17978 >time offset (G)
</DT
17981 >This parameter is a setting in minutes to add
17982 to the normal GMT to local time conversion. This is useful if
17983 you are serving a lot of PCs that have incorrect daylight
17984 saving time handling.
</P
17988 >time offset =
0</B
17993 >time offset =
60</B
18000 >time server (G)
</DT
18003 >This parameter determines if
<A
18008 > advertises itself as a time server to Windows
18013 >time server = no
</B
18018 NAME=
"TIMESTAMPLOGS"
18020 >timestamp logs (G)
</DT
18024 HREF=
"#DEBUGTIMESTAMP"
18028 > debug timestamp
</I
18035 NAME=
"TOTALPRINTJOBS"
18037 >total print jobs (G)
</DT
18040 >This parameter accepts an integer value which defines
18041 a limit on the maximum number of print jobs that will be accepted
18042 system wide at any given time. If a print job is submitted
18043 by a client which will exceed this number, then
<A
18048 error indicating that no space is available on the server. The
18049 default value of
0 means that no such limit exists. This parameter
18050 can be used to prevent a server from exceeding its capacity and is
18051 designed as a printing throttle. See also
18053 HREF=
"#MAXPRINTJOBS"
18065 >total print jobs =
0</B
18070 >total print jobs =
5000</B
18075 NAME=
"UNIXEXTENSIONS"
18077 >unix extensions(G)
</DT
18080 >This boolean parameter controls whether Samba
18081 implments the CIFS UNIX extensions, as defined by HP.
18082 These extensions enable Samba to better serve UNIX CIFS clients
18083 by supporting features such as symbolic links, hard links, etc...
18084 These extensions require a similarly enabled client, and are of
18085 no current use to Windows clients.
</P
18089 >unix extensions = no
</B
18094 NAME=
"UNIXPASSWORDSYNC"
18096 >unix password sync (G)
</DT
18099 >This boolean parameter controls whether Samba
18100 attempts to synchronize the UNIX password with the SMB password
18101 when the encrypted SMB password in the smbpasswd file is changed.
18102 If this is set to
<TT
18105 > the program specified in the
<TT
18111 >parameter is called
<EM
18114 to allow the new UNIX password to be set without access to the
18115 old UNIX password (as the SMB password change code has no
18116 access to the old password cleartext, only the new).
</P
18119 HREF=
"#PASSWDPROGRAM"
18139 >unix password sync = no
</B
18144 NAME=
"UPDATEENCRYPTED"
18146 >update encrypted (G)
</DT
18149 >This boolean parameter allows a user logging
18150 on with a plaintext password to have their encrypted (hashed)
18151 password in the smbpasswd file to be updated automatically as
18152 they log on. This option allows a site to migrate from plaintext
18153 password authentication (users authenticate with plaintext
18154 password over the wire, and are checked against a UNIX account
18155 database) to encrypted password authentication (the SMB
18156 challenge/response authentication mechanism) without forcing
18157 all users to re-enter their passwords via smbpasswd at the time the
18158 change is made. This is a convenience option to allow the change over
18159 to encrypted passwords to be made over a longer period. Once all users
18160 have encrypted representations of their passwords in the smbpasswd
18161 file this parameter should be set to
<TT
18166 >In order for this parameter to work correctly the
<A
18167 HREF=
"#ENCRYPTPASSWORDS"
18171 >encrypt passwords
</I
18175 > parameter must be set to
<TT
18179 this parameter is set to
<TT
18184 >Note that even when this parameter is set a user
18185 authenticating to
<B
18188 > must still enter a valid
18189 password in order to connect correctly, and to update their hashed
18190 (smbpasswd) passwords.
</P
18194 >update encrypted = no
</B
18199 NAME=
"USECLIENTDRIVER"
18201 >use client driver (S)
</DT
18204 >This parameter applies only to Windows NT/
2000
18205 clients. It has no affect on Windows
95/
98/ME clients. When
18206 serving a printer to Windows NT/
2000 clients without first installing
18207 a valid printer driver on the Samba host, the client will be required
18208 to install a local printer driver. From this point on, the client
18209 will treat the print as a local printer and not a network printer
18210 connection. This is much the same behavior that will occur
18213 >disable spoolss = yes
</B
18216 >The differentiating
18217 factor is that under normal circumstances, the NT/
2000 client will
18218 attempt to open the network printer using MS-RPC. The problem is that
18219 because the client considers the printer to be local, it will attempt
18220 to issue the OpenPrinterEx() call requesting access rights associated
18221 with the logged on user. If the user possesses local administator rights
18222 but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
18223 call will fail. The result is that the client will now display an
"Access
18224 Denied; Unable to connect" message in the printer queue window (even though
18225 jobs may successfully be printed).
</P
18227 >If this parameter is enabled for a printer, then any attempt
18228 to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
18229 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
18230 call to succeed.
<EM
18231 >This parameter MUST not be able enabled
18232 on a print share which has valid print driver installed on the Samba
18237 HREF=
"#DISABLESPOOLSS"
18238 >disable spoolss
</A
18244 >use client driver = no
</B
18254 >This global parameter determines if the tdb internals of Samba can
18255 depend on mmap working correctly on the running system. Samba requires a coherent
18256 mmap/read-write system memory cache. Currently only HPUX does not have such a
18257 coherent cache, and so this parameter is set to
<TT
18261 default on HPUX. On all other systems this parameter should be left alone. This
18262 parameter is provided to help the Samba developers track down problems with
18263 the tdb internal code.
18275 >use rhosts (G)
</DT
18278 >If this global parameter is
<TT
18282 that the UNIX user's
<TT
18285 > file in their home directory
18286 will be read to find the names of hosts and users who will be allowed
18287 access without specifying a password.
</P
18297 > can be a major security hole. This is because you are
18298 trusting the PC to supply the correct username. It is very easy to
18299 get a PC to supply a false username. I recommend that the
<TT
18304 > option be only used if you really know what
18309 >use rhosts = no
</B
18353 >Multiple users may be specified in a comma-delimited
18354 list, in which case the supplied password will be tested against
18355 each username in turn (left to right).
</P
18362 > line is needed only when
18363 the PC is unable to supply its own username. This is the case
18364 for the COREPLUS protocol or where your users have different WfWg
18365 usernames to UNIX usernames. In both these cases you may also be
18366 better using the \\server\share%user syntax instead.
</P
18373 > line is not a great
18374 solution in many cases as it means Samba will try to validate
18375 the supplied password against each of the usernames in the
18381 > line in turn. This is slow and
18382 a bad idea for lots of users in case of duplicate passwords.
18383 You may get timeouts or security breaches using this parameter
18386 >Samba relies on the underlying UNIX security. This
18387 parameter does not restrict who can login, it just offers hints
18388 to the Samba server as to what usernames might correspond to the
18389 supplied password. Users can login as whoever they please and
18390 they will be able to do no more damage than if they started a
18391 telnet session. The daemon runs as the user that they log in as,
18392 so they cannot do anything that user cannot do.
</P
18394 >To restrict a service to a particular set of users you
18406 >If any of the usernames begin with a '@' then the name
18407 will be looked up first in the NIS netgroups list (if Samba
18408 is compiled with netgroup support), followed by a lookup in
18409 the UNIX groups database and will expand to a list of all users
18410 in the group of that name.
</P
18412 >If any of the usernames begin with a '+' then the name
18413 will be looked up only in the UNIX groups database and will
18414 expand to a list of all users in the group of that name.
</P
18416 >If any of the usernames begin with a '
&'then the name
18417 will be looked up only in the NIS netgroups database (if Samba
18418 is compiled with netgroup support) and will expand to a list
18419 of all users in the netgroup group of that name.
</P
18421 >Note that searching though a groups database can take
18422 quite some time, and some clients may time out during the
18425 >See the section
<A
18428 USERNAME/PASSWORD VALIDATION
</A
18429 > for more information on how
18430 this parameter determines access to the services.
</P
18434 >The guest account if a guest service,
18435 else
<empty string
>.
</B
18440 >username = fred, mary, jack, jane,
18441 @users, @pcgroup
</B
18446 NAME=
"USERNAMELEVEL"
18448 >username level (G)
</DT
18451 >This option helps Samba to try and 'guess' at
18452 the real UNIX username, as many DOS clients send an all-uppercase
18453 username. By default Samba tries all lowercase, followed by the
18454 username with the first letter capitalized, and fails if the
18455 username is not found on the UNIX machine.
</P
18457 >If this parameter is set to non-zero the behavior changes.
18458 This parameter is a number that specifies the number of uppercase
18459 combinations to try while trying to determine the UNIX user name. The
18460 higher the number the more combinations will be tried, but the slower
18461 the discovery of usernames will be. Use this parameter when you have
18462 strange usernames on your UNIX machine, such as
<TT
18470 >username level =
0</B
18475 >username level =
5</B
18482 >username map (G)
</DT
18485 >This option allows you to specify a file containing
18486 a mapping of usernames from the clients to the server. This can be
18487 used for several purposes. The most common is to map usernames
18488 that users use on DOS or Windows machines to those that the UNIX
18489 box uses. The other is to map multiple users to a single username
18490 so that they can more easily share files.
</P
18492 >The map file is parsed line by line. Each line should
18493 contain a single UNIX username on the left then a '=' followed
18494 by a list of usernames on the right. The list of usernames on the
18495 right may contain names of the form @group in which case they
18496 will match any UNIX username in that group. The special client
18497 name '*' is a wildcard and matches any name. Each line of the
18498 map file may be up to
1023 characters long.
</P
18500 >The file is processed on each line by taking the
18501 supplied username and comparing it with each username on the right
18502 hand side of the '=' signs. If the supplied name matches any of
18503 the names on the right hand side then it is replaced with the name
18504 on the left. Processing then continues with the next line.
</P
18506 >If any line begins with a '#' or a ';' then it is
18509 >If any line begins with an '!' then the processing
18510 will stop after that line if a mapping was done by the line.
18511 Otherwise mapping continues with every line being processed.
18512 Using '!' is most useful when you have a wildcard mapping line
18513 later in the file.
</P
18515 >For example to map from the name
<TT
18522 > to the UNIX name
<TT
18525 > you would use:
</P
18529 >root = admin administrator
</B
18532 >Or to map anyone in the UNIX group
<TT
18536 to the UNIX name
<TT
18539 > you would use:
</P
18546 >You can have as many mappings as you like in a username
18549 >If your system supports the NIS NETGROUP option then
18550 the netgroup database is checked before the
<TT
18554 > database for matching groups.
</P
18556 >You can map Windows usernames that have spaces in them
18557 by using double quotes around the name. For example:
</P
18561 >tridge =
"Andrew Tridgell"</B
18564 >would map the windows username
"Andrew Tridgell" to the
18565 unix username
"tridge".
</P
18567 >The following example would map mary and fred to the
18568 unix user sys, and map the rest to guest. Note the use of the
18569 '!' to tell Samba to stop processing if it gets a match on
18579 CLASS=
"PROGRAMLISTING"
18588 >Note that the remapping is applied to all occurrences
18589 of usernames. Thus if you connect to \\server\fred and
<TT
18592 > is remapped to
<TT
18596 will actually be connecting to \\server\mary and will need to
18597 supply a password suitable for
<TT
18604 >. The only exception to this is the
18605 username passed to the
<A
18606 HREF=
"#PASSWORDSERVER"
18610 > password server
</I
18613 > (if you have one). The password
18614 server will receive whatever username the client supplies without
18617 >Also note that no reverse mapping is done. The main effect
18618 this has is with printing. Users who have been mapped may have
18619 trouble deleting print jobs as PrintManager under WfWg will think
18620 they don't own the print job.
</P
18623 >no username map
</EM
18628 >username map = /usr/local/samba/lib/users.map
18636 >use sendfile (S)
</DT
18639 >If this parameter is
<TT
18643 was built with the --with-sendfile-support option, and the underlying operating
18644 system supports sendfile system call, then some SMB read calls (mainly ReadAndX
18645 and ReadRaw) will use the more efficient sendfile system call for files that
18646 are exclusively oplocked. This may make more efficient use of the system CPU's
18647 and cause Samba to be faster. This is off by default as it's effects are unknown
18653 >use sendfile = no
</B
18663 >This boolean parameter is only available if
18664 Samba has been configured and compiled with the option
<B
18670 > then Samba will attempt
18671 to add utmp or utmpx records (depending on the UNIX system) whenever a
18672 connection is made to a Samba server. Sites may use this to record the
18673 user connecting to a Samba share.
</P
18676 HREF=
"#UTMPDIRECTORY"
18680 > utmp directory
</I
18692 NAME=
"UTMPDIRECTORY"
18694 >utmp directory(G)
</DT
18697 >This parameter is only available if Samba has
18698 been configured and compiled with the option
<B
18701 >. It specifies a directory pathname that is
18702 used to store the utmp or utmpx files (depending on the UNIX system) that
18703 record user connections to a Samba server. See also the
<A
18711 > parameter. By default this is
18712 not set, meaning the system will use whatever utmp file the
18713 native system is set to use (usually
18720 >no utmp directory
</EM
18727 >valid chars (G)
</DT
18730 >The option allows you to specify additional
18731 characters that should be considered valid by the server in
18732 filenames. This is particularly useful for national character
18733 sets, such as adding u-umlaut or a-ring.
</P
18735 >The option takes a list of characters in either integer
18736 or character form with spaces between them. If you give two
18737 characters with a colon between them then it will be taken as
18738 an lowercase:uppercase pair.
</P
18740 >If you have an editor capable of entering the characters
18741 into the config file then it is probably easiest to use this
18742 method. Otherwise you can specify the characters in octal,
18743 decimal or hexadecimal form using the usual C notation.
</P
18745 >For example to add the single character 'Z' to the charset
18746 (which is a pointless thing to do as it's already there) you could
18747 do one of the following
</P
18756 CLASS=
"PROGRAMLISTING"
18759 valid chars =
0132:
0172
18766 >The last two examples above actually add two characters,
18767 and alter the uppercase and lowercase mappings appropriately.
</P
18771 > specify this parameter
18775 >client code page
</I
18778 have both set. If
<TT
18781 >client code page
</I
18789 > parameter the
<TT
18795 > settings will be overwritten.
</P
18798 HREF=
"#CLIENTCODEPAGE"
18809 >Samba defaults to using a reasonable set
18810 of valid characters for English systems
</EM
18815 >valid chars =
0345:
0305 0366:
0326 0344:
0304
18819 >The above example allows filenames to have the Swedish
18820 characters in them.
</P
18824 > It is actually quite difficult to
18825 correctly produce a
<TT
18831 a particular system. To automate the process
<A
18832 HREF=
"mailto:tino@augsburg.net"
18834 >tino@augsburg.net
</A
18836 a package called
<B
18839 > which will automatically
18840 produce a complete
<TT
18846 a given client system. Look in the
<TT
18848 >examples/validchars/
18850 > subdirectory of your Samba source code distribution
18851 for this package.
</P
18857 >valid users (S)
</DT
18860 >This is a list of users that should be allowed
18861 to login to this service. Names starting with '@', '+' and '
&'
18862 are interpreted using the same rules as described in the
18870 >If this is empty (the default) then any user can login.
18871 If a username is in both this list and the
<TT
18877 > list then access is denied for that user.
</P
18879 >The current servicename is substituted for
<TT
18885 >. This is useful in the [homes] section.
</P
18888 HREF=
"#INVALIDUSERS"
18899 >No valid users list (anyone can login)
18905 >valid users = greg, @pcusers
</B
18915 >This is a list of files and directories that
18916 are neither visible nor accessible. Each entry in the list must
18917 be separated by a '/', which allows spaces to be included
18918 in the entry. '*' and '?' can be used to specify multiple files
18919 or directories as in DOS wildcards.
</P
18921 >Each entry must be a unix path, not a DOS path and
18924 > include the unix directory
18933 is applicable in vetoing files.
</P
18935 >One feature of the veto files parameter that it
18936 is important to be aware of is Samba's behaviour when
18937 trying to delete a directory. If a directory that is
18938 to be deleted contains nothing but veto files this
18941 > unless you also set
18945 >delete veto files
</I
18955 >Setting this parameter will affect the performance
18956 of Samba, as it will be forced to check all files and directories
18957 for a match as they are scanned.
</P
18969 HREF=
"#CASESENSITIVE"
18973 > case sensitive
</I
18979 >No files or directories are vetoed.
18990 CLASS=
"PROGRAMLISTING"
18991 >; Veto any files containing the word Security,
18992 ; any ending in .tmp, and any directory containing the
18994 veto files = /*Security*/*.tmp/*root*/
18996 ; Veto the Apple specific files that a NetAtalk server
18998 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
</PRE
19006 NAME=
"VETOOPLOCKFILES"
19008 >veto oplock files (S)
</DT
19011 >This parameter is only valid when the
<A
19020 parameter is turned on for a share. It allows the Samba administrator
19021 to selectively turn off the granting of oplocks on selected files that
19022 match a wildcarded list, similar to the wildcarded list used in the
19035 >No files are vetoed for oplock
19039 >You might want to do this on files that you know will
19040 be heavily contended for by clients. A good example of this
19041 is in the NetBench SMB benchmark program, which causes heavy
19042 client contention for files ending in
<TT
19046 To cause Samba not to grant oplocks on these files you would use
19047 the line (either in the [global] section or in the section for
19048 the particular NetBench share :
</P
19052 >veto oplock files = /*.SEM/
19060 >vfs object (S)
</DT
19063 >This parameter specifies a shared object file that
19064 is used for Samba VFS I/O operations. By default, normal
19065 disk I/O operations are used but these can be overloaded
19066 with a VFS object. The Samba VFS layer is new to Samba
2.2 and
19067 must be enabled at compile time with --with-vfs.
</P
19077 >vfs options (S)
</DT
19080 >This parameter allows parameters to be passed
19081 to the vfs layer at initialization time. The Samba VFS layer
19082 is new to Samba
2.2 and must be enabled at compile time
19083 with --with-vfs. See also
<A
19104 > This allows you to override the volume label
19105 returned for a share. Useful for CDROMs with installation programs
19106 that insist on a particular volume label.
</P
19109 >the name of the share
</EM
19116 >wide links (S)
</DT
19119 >This parameter controls whether or not links
19120 in the UNIX file system may be followed by the server. Links
19121 that point to areas within the directory tree exported by the
19122 server are always allowed; this parameter controls access only
19123 to areas that are outside the directory tree being exported.
</P
19125 >Note that setting this parameter can have a negative
19126 effect on your server performance due to the extra system calls
19127 that Samba has to do in order to perform the link checks.
</P
19131 >wide links = yes
</B
19136 NAME=
"WINBINDCACHETIME"
19138 >winbind cache time (G)
</DT
19141 >This parameter specifies the number of seconds the
19143 HREF=
"winbindd.8.html"
19146 > daemon will cache
19147 user and group information before querying a Windows NT server
19152 >winbind cache type =
15</B
19157 NAME=
"WINBINDENUMUSERS"
19159 >winbind enum users (G)
</DT
19162 >On large installations using
19164 HREF=
"winbindd.8.html"
19168 necessary to suppress the enumeration of users through the
19180 > group of system calls. If
19184 >winbind enum users
</I
19194 will not return any data.
</P
19199 enumeration may cause some programs to behave oddly. For
19200 example, the finger program relies on having access to the
19201 full user list when searching for matching
19206 >winbind enum users = yes
</B
19211 NAME=
"WINBINDENUMGROUPS"
19213 >winbind enum groups (G)
</DT
19216 >On large installations using
19218 HREF=
"winbindd.8.html"
19222 necessary to suppress the enumeration of groups through the
19234 > group of system calls. If
19238 >winbind enum groups
</I
19248 call will not return any data.
</P
19252 > Turning off group
19253 enumeration may cause some programs to behave oddly.
19258 >winbind enum groups = yes
</B
19266 >winbind gid (G)
</DT
19269 >The winbind gid parameter specifies the range of group
19270 ids that are allocated by the
<A
19271 HREF=
"winbindd.8.html"
19274 > daemon. This range of group ids should have no
19275 existing local or NIS groups within it as strange conflicts can
19276 occur otherwise.
</P
19280 >winbind gid =
<empty string
>
19286 >winbind gid =
10000-
20000</B
19291 NAME=
"WINBINDSEPARATOR"
19293 >winbind separator (G)
</DT
19296 >This parameter allows an admin to define the character
19297 used when listing a username of the form of
<TT
19298 CLASS=
"REPLACEABLE"
19304 CLASS=
"REPLACEABLE"
19309 is only applicable when using the
<TT
19311 >pam_winbind.so
</TT
19315 >nss_winbind.so
</TT
19316 > modules for UNIX services.
19319 >Please note that setting this parameter to + causes problems
19320 with group membership at least on glibc systems, as the character +
19321 is used as a special character for NIS in /etc/group.
</P
19325 >winbind separator = '\'
</B
19330 >winbind separator = +
</B
19337 >winbind uid (G)
</DT
19340 >The winbind gid parameter specifies the range of group
19341 ids that are allocated by the
<A
19342 HREF=
"winbindd.8.html"
19345 > daemon. This range of ids should have no
19346 existing local or NIS users within it as strange conflicts can
19347 occur otherwise.
</P
19351 >winbind uid =
<empty string
>
19357 >winbind uid =
10000-
20000</B
19361 >winbind use default domain,
<A
19362 NAME=
"WINBINDUSEDEFAULTDOMAIN"
19364 >winbind use default domain
</DT
19367 >This parameter specifies whether the
<A
19368 HREF=
"winbindd.8.html"
19372 daemon should operate on users without domain component in their username.
19373 Users without a domain component are treated as is part of the winbindd server's
19374 own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail
19375 function in a way much closer to the way they would in a native unix system.
</P
19379 >winbind use default domain =
<no
>
19385 >winbind use default domain = yes
</B
19395 >When Samba is running as a WINS server this
19396 allows you to call an external program for all changes to the
19397 WINS database. The primary use for this option is to allow the
19398 dynamic update of external name resolution databases such as
19401 >The wins hook parameter specifies the name of a script
19402 or executable that will be called as follows:
</P
19406 >wins_hook operation name nametype ttl IP_list
19414 >The first argument is the operation and is one
19415 of
"add",
"delete", or
"refresh". In most cases the operation can
19416 be ignored as the rest of the parameters provide sufficient
19417 information. Note that
"refresh" may sometimes be called when the
19418 name has not previously been added, in that case it should be treated
19423 >The second argument is the NetBIOS name. If the
19424 name is not a legal name then the wins hook is not called.
19425 Legal names contain only letters, digits, hyphens, underscores
19430 >The third argument is the NetBIOS name
19431 type as a
2 digit hexadecimal number.
</P
19435 >The fourth argument is the TTL (time to live)
19436 for the name in seconds.
</P
19440 >The fifth and subsequent arguments are the IP
19441 addresses currently registered for that name. If this list is
19442 empty then the name should be deleted.
</P
19446 >An example script that calls the BIND dynamic DNS update
19450 > is provided in the examples
19451 directory of the Samba source code.
</P
19457 >wins proxy (G)
</DT
19460 >This is a boolean that controls if
<A
19464 > will respond to broadcast name
19465 queries on behalf of other hosts. You may need to set this
19469 > for some older clients.
</P
19473 >wins proxy = no
</B
19480 >wins server (G)
</DT
19483 >This specifies the IP address (or DNS name: IP
19484 address for preference) of the WINS server that
<A
19488 > should register with. If you have a WINS server on
19489 your network then you should set this to the WINS server's IP.
</P
19491 >You should point this at your WINS server if you have a
19492 multi-subnetted network.
</P
19496 >. You need to set up Samba to point
19497 to a WINS server if you have multiple subnets and wish cross-subnet
19498 browsing to work correctly.
</P
19500 >See the documentation file
<TT
19504 in the docs/ directory of your Samba source distribution.
</P
19512 >wins server =
192.9.200.1</B
19519 >wins support (G)
</DT
19522 >This boolean controls if the
<A
19527 > process in Samba will act as a WINS server. You should
19528 not set this to
<TT
19531 > unless you have a multi-subnetted network and
19532 you wish a particular
<B
19535 > to be your WINS server.
19536 Note that you should
<EM
19542 on more than one machine in your network.
</P
19546 >wins support = no
</B
19556 >This controls what workgroup your server will
19557 appear to be in when queried by clients. Note that this parameter
19558 also controls the Domain name used with the
<A
19559 HREF=
"#SECURITYEQUALSDOMAIN"
19562 >security = domain
</B
19568 >set at compile time to WORKGROUP
</EM
19573 >workgroup = MYGROUP
</B
19591 > for people who can't spell :-).
</P
19595 NAME=
"WRITECACHESIZE"
19597 >write cache size (S)
</DT
19600 >If this integer parameter is set to non-zero value,
19601 Samba will create an in-memory cache for each oplocked file
19605 non-oplocked files). All writes that the client does not request
19606 to be flushed directly to disk will be stored in this cache if possible.
19607 The cache is flushed onto disk when a write comes in whose offset
19608 would not fit into the cache or when the file is closed by the client.
19609 Reads for the file are also served from this cache if the data is stored
19612 >This cache allows Samba to batch client writes into a more
19613 efficient write size for RAID disks (i.e. writes may be tuned to
19614 be the RAID stripe size) and can improve performance on systems
19615 where the disk subsystem is a bottleneck but there is free
19616 memory for userspace programs.
</P
19618 >The integer parameter specifies the size of this cache
19619 (per oplocked file) in bytes.
</P
19623 >write cache size =
0</B
19628 >write cache size =
262144</B
19631 >for a
256k cache size per file.
</P
19637 >write list (S)
</DT
19640 >This is a list of users that are given read-write
19641 access to a service. If the connecting user is in this list then
19642 they will be given write access, no matter what the
<A
19651 option is set to. The list can include group names using the
19654 >Note that if a user is in both the read list and the
19655 write list then they will be given write access.
</P
19670 >write list =
<empty string
>
19676 >write list = admin, root, @staff
19687 >Inverted synonym for
<A
19704 >This parameter controls whether or not the server
19705 will support raw write SMB's when transferring data from clients.
19706 You should never need to change this parameter.
</P
19710 >write raw = yes
</B
19720 >Inverted synonym for
<A
19741 >Although the configuration file permits service names
19742 to contain spaces, your client software may not. Spaces will
19743 be ignored in comparisons anyway, so it shouldn't be a
19744 problem - but be aware of the possibility.
</P
19746 >On a similar note, many clients - especially DOS clients -
19747 limit service names to eight characters.
<A
19752 > has no such limitation, but attempts to connect from such
19753 clients will fail if they truncate the service names. For this reason
19754 you should probably keep your service names down to eight characters
19757 >Use of the [homes] and [printers] special sections make life
19758 for an administrator easy, but the various combinations of default
19759 attributes can be tricky. Take extreme care when designing these
19760 sections. In particular, ensure that the permissions on spool
19761 directories are correct.
</P
19771 >This man page is correct for version
2.2 of
19772 the Samba suite.
</P
19783 HREF=
"samba.7.html"
19788 HREF=
"smbpasswd.8.html"
19820 HREF=
"smbclient.1.html"
19828 HREF=
"nmblookup.1.html"
19836 HREF=
"testparm.1.html"
19844 HREF=
"testprns.1.html"
19861 >The original Samba software and related utilities
19862 were created by Andrew Tridgell. Samba is now developed
19863 by the Samba Team as an Open Source project similar
19864 to the way the Linux kernel is developed.
</P
19866 >The original Samba man pages were written by Karl Auer.
19867 The man page sources were converted to YODL format (another
19868 excellent piece of Open Source software, available at
19870 HREF=
"ftp://ftp.icce.rug.nl/pub/unix/"
19872 > ftp://ftp.icce.rug.nl/pub/unix/
</A
19873 >) and updated for the Samba
2.0
19874 release by Jeremy Allison. The conversion to DocBook for
19875 Samba
2.2 was done by Gerald Carter
</P