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
339 it means setting browseable=no in the [homes] section
340 will hide the [homes] share but make any auto home
341 directories visible.
</P
349 >The [printers] section
</H3
351 >This section works like [homes],
354 >If a [printers] section occurs in the
355 configuration file, users are able to connect to any printer
356 specified in the local host's printcap file.
</P
358 >When a connection request is made, the existing sections
359 are scanned. If a match is found, it is used. If no match is found,
360 but a [homes] section exists, it is used as described
361 above. Otherwise, the requested section name is treated as a
362 printer name and the appropriate printcap file is scanned to see
363 if the requested section name is a valid printer share name. If
364 a match is found, a new printer share is created by cloning
365 the [printers] section.
</P
367 >A few modifications are then made to the newly created
374 >The share name is set to the located printer
379 >If no printer name was given, the printer name
380 is set to the located printer name
</P
384 >If the share does not permit guest access and
385 no username was given, the username is set to the located
390 >Note that the [printers] service MUST be
391 printable - if you specify otherwise, the server will refuse
392 to load the configuration file.
</P
394 >Typically the path specified would be that of a
395 world-writeable spool directory with the sticky bit set on
396 it. A typical [printers] entry would look like
407 CLASS=
"COMPUTEROUTPUT"
409 path = /usr/spool/public
418 >All aliases given for a printer in the printcap file
419 are legitimate printer names as far as the server is concerned.
420 If your printing subsystem doesn't work like that, you will have
421 to set up a pseudo-printcap. This is a file consisting of one or
422 more lines like this:
</P
432 CLASS=
"COMPUTEROUTPUT"
433 > alias|alias|alias|alias...
441 >Each alias should be an acceptable printer name for
442 your printing subsystem. In the [global] section, specify
443 the new file as your printcap. The server will then only recognize
444 names found in your pseudo-printcap, which of course can contain
445 whatever aliases you like. The same technique could be used
446 simply to limit access to a subset of your local printers.
</P
448 >An alias, by the way, is defined as any component of the
449 first entry of a printcap record. Records are separated by newlines,
450 components (if there are more than one) are separated by vertical
451 bar symbols ('|').
</P
453 >NOTE: On SYSV systems which use lpstat to determine what
454 printers are defined on the system you may be able to use
455 "printcap name = lpstat" to automatically obtain a list
456 of printers. See the
"printcap name" option
468 >parameters define the specific attributes of sections.
</P
470 >Some parameters are specific to the [global] section
473 >). Some parameters are usable
474 in all sections (e.g.,
<EM
477 are permissible only in normal sections. For the purposes of the
478 following descriptions the [homes] and [printers]
479 sections will be considered normal. The letter
<EM
482 in parentheses indicates that a parameter is specific to the
483 [global] section. The letter
<EM
486 indicates that a parameter can be specified in a service specific
487 section. Note that all
<EM
489 > parameters can also be specified in
490 the [global] section - in which case they will define
491 the default behavior for all services.
</P
493 >parameters are arranged here in alphabetical order - this may
494 not create best bedfellows, but at least you can find them! Where
495 there are synonyms, the preferred synonym is described, others refer
496 to the preferred synonym.
</P
504 >VARIABLE SUBSTITUTIONS
</H2
506 >Many of the strings that are settable in the config file
507 can take substitutions. For example the option
"path =
508 /tmp/%u" would be interpreted as
"path =
509 /tmp/john" if the user connected with the username john.
</P
511 >These substitutions are mostly noted in the descriptions below,
512 but there are some general substitutions which apply whenever they
513 might be relevant. These are:
</P
523 >the name of the current service, if any.
</P
529 >the root directory of the current service,
536 >user name of the current service, if any.
</P
542 >primary group name of %u.
</P
548 >session user name (the user name that the client
549 wanted, not necessarily the same as the one they got).
</P
555 >primary group name of %U.
</P
561 >the home directory of the user given
568 >the Samba version.
</P
574 >the Internet hostname that Samba is running
581 >the NetBIOS name of the client machine
588 >the NetBIOS name of the server. This allows you
589 to change your config based on what the client calls you. Your
590 server can have a
"dual personality".
</P
596 >the Internet name of the client machine.
603 >the name of your NIS home directory server.
604 This is obtained from your NIS auto.map entry. If you have
605 not compiled Samba with the
<EM
606 >--with-automount
</EM
608 option then this value will be the same as %.
</P
614 >the path of the service's home directory,
615 obtained from your NIS auto.map entry. The NIS auto.map entry
616 is split up as
"%N:%p".
</P
622 >the selected protocol level after
623 protocol negotiation. It can be one of CORE, COREPLUS,
624 LANMAN1, LANMAN2 or NT1.
</P
630 >The process id of the current server
637 >the architecture of the remote
638 machine. Only some are recognized, and those may not be
639 100% reliable. It currently recognizes Samba, WfWg,
640 WinNT and Win95. Anything else will be known as
641 "UNKNOWN". If it gets it wrong then sending a level
643 HREF=
"mailto:samba@samba.org"
647 > should allow it to be fixed.
</P
653 >The IP address of the client machine.
</P
659 >the current date and time.
</P
670 >The value of the environment variable
681 >There are some quite creative things that can be done
682 with these substitutions and other smb.conf options.
</P
692 >Samba supports
"name mangling" so that DOS and
693 Windows clients can use files that don't conform to the
8.3 format.
694 It can also be set to adjust the case of
8.3 format filenames.
</P
696 >There are several options that control the way mangling is
697 performed, and they are grouped here rather than listed separately.
698 For the defaults look at the output of the testparm program.
</P
700 >All of these options can be set separately for each service
701 (or globally, of course).
</P
703 >The options are:
</P
710 >mangle case= yes/no
</DT
713 > controls if names that have characters that
714 aren't of the
"default" case are mangled. For example,
715 if this is yes then a name like
"Mail" would be mangled.
721 >case sensitive = yes/no
</DT
724 >controls whether filenames are case sensitive. If
725 they aren't then Samba must do a filename search and match on passed
731 >default case = upper/lower
</DT
734 >controls what the default case is for new
735 filenames. Default
<EM
740 >preserve case = yes/no
</DT
743 >controls if new files are created with the
744 case that the client passes, or if they are forced to be the
745 "default" case. Default
<EM
751 >short preserve case = yes/no
</DT
754 >controls if new files which conform to
8.3 syntax,
755 that is all in upper case and of suitable length, are created
756 upper case, or if they are forced to be the
"default"
757 case. This option can be use with
"preserve case = yes"
758 to permit long filenames to retain their case, while short names
759 are lowered. Default
<EM
766 >By default, Samba
2.2 has the same semantics as a Windows
767 NT server, in that it is case insensitive but case preserving.
</P
775 >NOTE ABOUT USERNAME/PASSWORD VALIDATION
</H2
777 >There are a number of ways in which a user can connect
778 to a service. The server uses the following steps in determining
779 if it will allow a connection to a specified service. If all the
780 steps fail, then the connection request is rejected. However, if one of the
781 steps succeeds, then the following steps are not checked.
</P
783 >If the service is marked
"guest only = yes" then
784 steps
1 to
5 are skipped.
</P
791 >If the client has passed a username/password
792 pair and that username/password pair is validated by the UNIX
793 system's password programs then the connection is made as that
794 username. Note that this includes the
805 >If the client has previously registered a username
806 with the system and now supplies a correct password for that
807 username then the connection is allowed.
</P
811 >The client's netbios name and any previously
812 used user names are checked against the supplied password, if
813 they match then the connection is allowed as the corresponding
818 >If the client has previously validated a
819 username/password pair with the server and the client has passed
820 the validation token then that username is used.
</P
824 >If a
"user = " field is given in the
828 > file for the service and the client
829 has supplied a password, and that password matches (according to
830 the UNIX system's password checking) with one of the usernames
831 from the
"user=" field then the connection is made as
832 the username in the
"user=" line. If one
833 of the username in the
"user=" list begins with a
834 '@' then that name expands to a list of names in
835 the group of the same name.
</P
839 >If the service is a guest service then a
840 connection is made as the username given in the
"guest
841 account =" for the service, irrespective of the
842 supplied password.
</P
852 >COMPLETE LIST OF GLOBAL PARAMETERS
</H2
854 >Here is a list of all global parameters. See the section of
855 each parameter for details. Note that some are synonyms.
</P
862 HREF=
"#ADDUSERSCRIPT"
874 HREF=
"#ADDPRINTERCOMMAND"
878 >addprinter command
</I
886 HREF=
"#ALLOWTRUSTEDDOMAINS"
890 >allow trusted domains
</I
910 HREF=
"#ANNOUNCEVERSION"
934 HREF=
"#BINDINTERFACESONLY"
938 >bind interfaces only
</I
958 HREF=
"#CHANGENOTIFYTIMEOUT"
962 >change notify timeout
</I
982 HREF=
"#CLIENTCODEPAGE"
994 HREF=
"#CODEPAGEDIRECTORY"
998 >code page directory
</I
1006 HREF=
"#CODINGSYSTEM"
1042 HREF=
"#DEBUGHIRESTIMESTAMP"
1046 >debug hires timestamp
</I
1066 HREF=
"#DEBUGTIMESTAMP"
1114 HREF=
"#DEFAULTSERVICE"
1126 HREF=
"#DELETEUSERSCRIPT"
1130 >delete user script
</I
1138 HREF=
"#DELETEPRINTERCOMMAND"
1142 >deleteprinter command
</I
1150 HREF=
"#DFREECOMMAND"
1174 HREF=
"#DOMAINADMINGROUP"
1178 >domain admin group
</I
1186 HREF=
"#DOMAINADMINUSERS"
1190 >domain admin users
</I
1198 HREF=
"#DOMAINGROUPS"
1210 HREF=
"#DOMAINGUESTGROUP"
1214 >domain guest group
</I
1222 HREF=
"#DOMAINGUESTUSERS"
1226 >domain guest users
</I
1234 HREF=
"#DOMAINLOGONS"
1246 HREF=
"#DOMAINMASTER"
1258 HREF=
"#ENCRYPTPASSWORDS"
1262 >encrypt passwords
</I
1270 HREF=
"#ENHANCEDBROWSING"
1274 >enhanced browsing
</I
1282 HREF=
"#ENUMPORTSCOMMAND"
1286 >enumports command
</I
1306 HREF=
"#HIDELOCALUSERS"
1310 >hide local users
</I
1378 HREF=
"#KERNELOPLOCKS"
1426 HREF=
"#LOADPRINTERS"
1462 HREF=
"#LOCKDIRECTORY"
1546 HREF=
"#LPQCACHETIME"
1558 HREF=
"#MACHINEPASSWORDTIMEOUT"
1562 >machine password timeout
</I
1570 HREF=
"#MANGLEDSTACK"
1630 HREF=
"#MAXOPENFILES"
1654 HREF=
"#MAXSMBDPROCESSES"
1658 >max smbd processes
</I
1702 HREF=
"#MESSAGECOMMAND"
1714 HREF=
"#MINPASSWDLENGTH"
1718 >min passwd length
</I
1726 HREF=
"#MINPASSWORDLENGTH"
1730 >min password length
</I
1762 HREF=
"#NAMERESOLVEORDER"
1766 >name resolve order
</I
1774 HREF=
"#NETBIOSALIASES"
1798 HREF=
"#NETBIOSSCOPE"
1822 HREF=
"#NTACLSUPPORT"
1834 HREF=
"#NTPIPESUPPORT"
1846 HREF=
"#NTSMBSUPPORT"
1858 HREF=
"#NULLPASSWORDS"
1870 HREF=
"#OPLOCKBREAKWAITTIME"
1874 >oplock break wait time
</I
1894 HREF=
"#OS2DRIVERMAP"
1930 HREF=
"#PASSWDCHATDEBUG"
1934 >passwd chat debug
</I
1942 HREF=
"#PASSWDPROGRAM"
1954 HREF=
"#PASSWORDLEVEL"
1966 HREF=
"#PASSWORDSERVER"
1978 HREF=
"#PREFEREDMASTER"
1990 HREF=
"#PREFERREDMASTER"
1994 >preferred master
</I
2026 HREF=
"#PRINTCAPNAME"
2038 HREF=
"#PRINTERDRIVERFILE"
2042 >printer driver file
</I
2098 HREF=
"#REMOTEANNOUNCE"
2110 HREF=
"#REMOTEBROWSESYNC"
2114 >remote browse sync
</I
2122 HREF=
"#RESTRICTANONYMOUS"
2126 >restrict anonymous
</I
2158 HREF=
"#ROOTDIRECTORY"
2182 HREF=
"#SERVERSTRING"
2194 HREF=
"#SHOWADDPRINTERWIZARD"
2198 >show add printer wizard
</I
2206 HREF=
"#SMBPASSWDFILE"
2218 HREF=
"#SOCKETADDRESS"
2230 HREF=
"#SOCKETOPTIONS"
2242 HREF=
"#SOURCEENVIRONMENT"
2246 >source environment
</I
2266 HREF=
"#SSLCACERTDIR"
2278 HREF=
"#SSLCACERTFILE"
2302 HREF=
"#SSLCLIENTCERT"
2314 HREF=
"#SSLCLIENTKEY"
2326 HREF=
"#SSLCOMPATIBILITY"
2330 >ssl compatibility
</I
2350 HREF=
"#SSLHOSTSRESIGN"
2354 >ssl hosts resign
</I
2362 HREF=
"#SSLREQUIRECLIENTCERT"
2366 >ssl require clientcert
</I
2374 HREF=
"#SSLREQUIRESERVERCERT"
2378 >ssl require servercert
</I
2386 HREF=
"#SSLSERVERCERT"
2398 HREF=
"#SSLSERVERKEY"
2434 HREF=
"#STATCACHESIZE"
2482 HREF=
"#TEMPLATEHOMEDIR"
2486 >template homedir
</I
2494 HREF=
"#TEMPLATESHELL"
2530 HREF=
"#TIMESTAMPLOGS"
2542 HREF=
"#TOTALPRINTJOBS"
2546 >total print jobs
</I
2554 HREF=
"#UNIXPASSWORDSYNC"
2558 >unix password sync
</I
2566 HREF=
"#UPDATEENCRYPTED"
2570 >update encrypted
</I
2590 HREF=
"#USERNAMELEVEL"
2614 HREF=
"#UTMPDIRECTORY"
2638 HREF=
"#WINBINDCACHETIME"
2642 >winbind cache time
</I
2662 HREF=
"#WINBINDSEPARATOR"
2666 >winbind separator
</I
2763 >COMPLETE LIST OF SERVICE PARAMETERS
</H2
2765 >Here is a list of all service parameters. See the section on
2766 each parameter for details. Note that some are synonyms.
</P
2809 HREF=
"#BLOCKINGLOCKS"
2845 HREF=
"#CASESENSITIVE"
2857 HREF=
"#CASESIGNAMES"
2929 HREF=
"#DELETEREADONLY"
2941 HREF=
"#DELETEVETOFILES"
2945 >delete veto files
</I
2977 HREF=
"#DIRECTORYMASK"
2989 HREF=
"#DIRECTORYMODE"
3001 HREF=
"#DIRECTORYSECURITYMASK"
3005 >directory security mask
</I
3037 HREF=
"#DOSFILETIMERESOLUTION"
3041 >dos filetime resolution
</I
3049 HREF=
"#DOSFILETIMES"
3073 HREF=
"#FAKEDIRECTORYCREATETIMES"
3077 >fake directory create times
</I
3097 HREF=
"#FOLLOWSYMLINKS"
3109 HREF=
"#FORCECREATEMODE"
3113 >force create mode
</I
3121 HREF=
"#FORCEDIRECTORYMODE"
3125 >force directory mode
</I
3133 HREF=
"#FORCEDIRECTORYSECURITYMODE"
3137 >force directory security mode
</I
3157 HREF=
"#FORCESECURITYMODE"
3161 >force security mode
</I
3205 HREF=
"#GUESTACCOUNT"
3241 HREF=
"#HIDEDOTFILES"
3301 HREF=
"#INHERITPERMISSIONS"
3305 >inherit permissions
</I
3313 HREF=
"#INVALIDUSERS"
3325 HREF=
"#LEVEL2OPLOCKS"
3349 HREF=
"#LPPAUSECOMMAND"
3373 HREF=
"#LPRESUMECOMMAND"
3377 >lpresume command
</I
3445 HREF=
"#MANGLEDNAMES"
3457 HREF=
"#MANGLINGCHAR"
3505 HREF=
"#MAXCONNECTIONS"
3517 HREF=
"#MAXPRINTJOBS"
3529 HREF=
"#MINPRINTSPACE"
3577 HREF=
"#OPLOCKCONTENTIONLIMIT"
3581 >oplock contention limit
</I
3613 HREF=
"#POSIXLOCKING"
3661 HREF=
"#PREEXECCLOSE"
3673 HREF=
"#PRESERVECASE"
3685 HREF=
"#PRINTCOMMAND"
3733 HREF=
"#PRINTERADMIN"
3745 HREF=
"#PRINTERDRIVER"
3757 HREF=
"#PRINTERDRIVERLOCATION"
3761 >printer driver location
</I
3805 HREF=
"#QUEUEPAUSECOMMAND"
3809 >queuepause command
</I
3817 HREF=
"#QUEUERESUMECOMMAND"
3821 >queueresume command
</I
3853 HREF=
"#ROOTPOSTEXEC"
3877 HREF=
"#ROOTPREEXECCLOSE"
3881 >root preexec close
</I
3889 HREF=
"#SECURITYMASK"
3901 HREF=
"#SETDIRECTORY"
3925 HREF=
"#SHORTPRESERVECASE"
3929 >short preserve case
</I
3949 HREF=
"#STRICTLOCKING"
4057 HREF=
"#VETOOPLOCKFILES"
4061 >veto oplock files
</I
4129 HREF=
"#WRITECACHESIZE"
4133 >write cache size
</I
4182 >EXPLANATION OF EACH PARAMETER
</H2
4186 CLASS=
"VARIABLELIST"
4190 NAME=
"ADDUSERSCRIPT"
4192 >add user script (G)
</DT
4195 >This is the full pathname to a script that will
4203 > under special circumstances described below.
</P
4205 >Normally, a Samba server requires that UNIX users are
4206 created for all users accessing files on this server. For sites
4207 that use Windows NT account databases as their primary user database
4208 creating these users and keeping the user list in sync with the
4209 Windows NT PDC is an onerous task. This option allows
<A
4213 > to create the required UNIX users
4216 > when a user accesses the Samba server.
</P
4218 >In order to use this option,
<A
4231 > security=domain
</I
4239 must be set to a full pathname for a script that will create a UNIX
4240 user given one argument of
<TT
4245 >, which expands into
4246 the UNIX user name to create.
</P
4248 >When the Windows user attempts to access the Samba server,
4249 at login (session setup in the SMB protocol) time,
<A
4259 attempts to authenticate the given user with the given password. If the
4260 authentication succeeds then
<B
4264 attempts to find a UNIX user in the UNIX password database to map the
4265 Windows user into. If this lookup fails, and
<TT
4275 call the specified script
<EM
4283 > argument to be the user name to create.
</P
4285 >If this script successfully creates the user then
<B
4289 > will continue on as though the UNIX user
4290 already existed. In this way, UNIX users are dynamically created to
4291 match existing Windows NT accounts.
</P
4302 HREF=
"#PASSWORDSERVER"
4311 HREF=
"#DELETEUSERSCRIPT"
4323 >add user script =
<empty string
>
4329 >add user script = /usr/local/samba/bin/add_user
4335 NAME=
"ADDPRINTERCOMMAND"
4337 >addprinter command (G)
</DT
4340 >With the introduction of MS-RPC based printing
4341 support for Windows NT/
2000 clients in Samba
2.2, The MS Add
4342 Printer Wizard (APW) icon is now also available in the
4343 "Printers..." folder displayed a share listing. The APW
4344 allows for printers to be add remotely to a Samba or Windows
4345 NT/
2000 print server.
</P
4347 >For a Samba host this means that the printer must be
4348 physically added to underlying printing system. The
<TT
4351 > addprinter command
</I
4353 > defines a script to be run which
4354 will perform the necessary operations for adding the printer
4355 to the print system and to add the appropriate service definition
4359 > file in order that it can be
4373 >addprinter command
</I
4376 automatically invoked with the following parameter (in
4431 >Windows
9x driver location
</I
4438 >All parameters are filled in from the PRINTER_INFO_2 structure sent
4439 by the Windows NT/
2000 client with one exception. The
"Windows 9x
4440 driver location" parameter is included for backwards compatibility
4441 only. The remaining fields in the structure are generated from answers
4442 to the APW questions.
</P
4447 >addprinter command
</I
4453 > will reparse the
<TT
4456 > to determine if the share defined by the APW
4457 exists. If the sharename is still invalid, then
<B
4461 > will return an ACCESS_DENIED error to the client.
</P
4464 HREF=
"#DELETEPRINTERCOMMAND"
4468 > deleteprinter command
</I
4481 HREF=
"#SHOWADDPRINTERWIZARD"
4497 >addprinter command = /usr/bin/addprinter
4505 >admin users (S)
</DT
4508 >This is a list of users who will be granted
4509 administrative privileges on the share. This means that they
4510 will do all file operations as the super-user (root).
</P
4512 >You should use this option very carefully, as any user in
4513 this list will be able to do anything they like on the share,
4514 irrespective of file permissions.
</P
4522 >admin users = jason
</B
4529 >allow hosts (S)
</DT
4544 NAME=
"ALLOWTRUSTEDDOMAINS"
4546 >allow trusted domains (G)
</DT
4549 >This option only takes effect when the
<A
4565 If it is set to no, then attempts to connect to a resource from
4566 a domain or workgroup other than the one which smbd is running
4567 in will fail, even if that domain is trusted by the remote server
4568 doing the authentication.
</P
4570 >This is useful if you only want your Samba server to
4571 serve resources to users in the domain it is a member of. As
4572 an example, suppose that there are two domains DOMA and DOMB. DOMB
4573 is trusted by DOMA, which contains the Samba server. Under normal
4574 circumstances, a user with an account in DOMB can then access the
4575 resources of a UNIX account with the same account name on the
4576 Samba server even if they do not have an account in DOMA. This
4577 can make implementing a security boundary difficult.
</P
4581 >allow trusted domains = yes
</B
4588 >announce as (G)
</DT
4591 >This specifies what type of server
4600 will announce itself as, to a network neighborhood browse
4601 list. By default this is set to Windows NT. The valid options
4602 are :
"NT Server" (which can also be written as
"NT"),
4603 "NT Workstation",
"Win95" or
"WfW" meaning Windows NT Server,
4604 Windows NT Workstation, Windows
95 and Windows for Workgroups
4605 respectively. Do not change this parameter unless you have a
4606 specific need to stop Samba appearing as an NT server as this
4607 may prevent Samba servers from participating as browser servers
4612 >announce as = NT Server
</B
4617 >announce as = Win95
</B
4622 NAME=
"ANNOUNCEVERSION"
4624 >annouce version (G)
</DT
4627 >This specifies the major and minor version numbers
4628 that nmbd will use when announcing itself as a server. The default
4629 is
4.2. Do not change this parameter unless you have a specific
4630 need to set a Samba server to be a downlevel server.
</P
4634 >announce version =
4.2</B
4639 >announce version =
2.0</B
4646 >auto services (G)
</DT
4649 >This is a synonym for the
<A
4666 >This parameter lets you
"turn off" a service. If
4675 attempts to connect to the service will fail. Such failures are
4685 NAME=
"BINDINTERFACESONLY"
4687 >bind interfaces only (G)
</DT
4690 >This global parameter allows the Samba admin
4691 to limit what interfaces on a machine will serve smb requests. If
4692 affects file service
<A
4704 >For name service it causes
<B
4708 to ports
137 and
138 on the interfaces listed in the
<A
4715 > also binds to the
"all addresses" interface (
0.0.0.0)
4716 on ports
137 and
138 for the purposes of reading broadcast messages.
4717 If this option is not set then
<B
4721 name requests on all of these sockets. If
<TT
4731 source address of any packets coming in on the broadcast sockets
4732 and discard any that don't match the broadcast addresses of the
4733 interfaces in the
<TT
4739 As unicast packets are received on the other sockets it allows
4743 > to refuse to serve names to machines that
4744 send packets that arrive through any interfaces not listed in the
4750 > list. IP Source address spoofing
4751 does defeat this simple check, however so it must not be used
4752 seriously as a security feature for
<B
4757 >For file service it causes
<A
4762 to bind only to the interface list given in the
<A
4765 > parameter. This restricts the networks that
4769 > will serve to packets coming in those
4770 interfaces. Note that you should not use this parameter for machines
4771 that are serving PPP or other intermittent or non-broadcast network
4772 interfaces as it will not cope with non-permanent interfaces.
</P
4777 >bind interfaces only
</I
4780 unless the network address
<EM
4789 HREF=
"smbpasswd.8.html"
4804 not work as expected due to the reasons covered below.
</P
4806 >To change a users SMB password, the
<B
4810 by default connects to the
<EM
4811 >localhost -
127.0.0.1</EM
4813 address as an SMB client to issue the password change request. If
4817 >bind interfaces only
</I
4819 > is set then unless the
4828 > parameter list then
<B
4831 > will fail to connect in it's default mode.
4835 > can be forced to use the primary IP interface
4836 of the local host by using its
<A
4837 HREF=
"smbpasswd.8.html#minusr"
4851 > parameter, with
<TT
4857 to the IP name of the primary interface of the local host.
</P
4862 > status page tries to connect with
4872 > to determine if they are running.
4882 "not running" even if they really are. This can prevent
<B
4885 > from starting/stopping/restarting
<B
4896 >bind interfaces only = no
</B
4901 NAME=
"BLOCKINGLOCKS"
4903 >blocking locks (S)
</DT
4906 >This parameter controls the behavior of
<A
4910 > when given a request by a client
4911 to obtain a byte range lock on a region of an open file, and the
4912 request has a time limit associated with it.
</P
4914 >If this parameter is set and the lock range requested
4915 cannot be immediately satisfied, Samba
2.2 will internally
4916 queue the lock request, and periodically attempt to obtain
4917 the lock until the timeout period expires.
</P
4919 >If this parameter is set to
<TT
4923 Samba
2.2 will behave as previous versions of Samba would and
4924 will fail the lock request immediately if the lock range
4925 cannot be obtained.
</P
4929 >blocking locks = yes
</B
4953 >browse list (G)
</DT
4956 >This controls whether
<A
4963 > will serve a browse list to
4971 >. You should never need to change
4976 >browse list = yes
</B
4986 >This controls whether this share is seen in
4987 the list of available shares in a net view and in the browse list.
</P
4991 >browseable = yes
</B
4996 NAME=
"CASESENSITIVE"
4998 >case sensitive (S)
</DT
5001 >See the discussion in the section
<A
5008 >case sensitive = no
</B
5015 >casesignames (S)
</DT
5019 HREF=
"#CASESENSITIVE"
5026 NAME=
"CHANGENOTIFYTIMEOUT"
5028 >change notify timeout (G)
</DT
5031 >This SMB allows a client to tell a server to
5032 "watch" a particular directory for any changes and only reply to
5033 the SMB request when a change has occurred. Such constant scanning of
5034 a directory is expensive under UNIX, hence an
<A
5041 > daemon only performs such a scan
5042 on each requested directory once every
<TT
5052 >change notify timeout =
60</B
5057 >change notify timeout =
300</B
5060 >Would change the scan time to every
5 minutes.
</P
5066 >character set (G)
</DT
5069 >This allows a smbd to map incoming filenames
5070 from a DOS Code page (see the
<A
5071 HREF=
"#CLIENTCODEPAGE"
5074 > parameter) to several built in UNIX character sets.
5075 The built in code page translations are:
</P
5084 > : Western European
5085 UNIX character set. The parameter
<TT
5088 >client code page
</I
5093 > be set to code page
850 if the
5099 > parameter is set to
5103 > in order for the conversion to the
5104 UNIX character set to be done correctly.
</P
5111 > : Eastern European
5112 UNIX character set. The parameter
<TT
5120 > be set to code page
852 if
5130 > in order for the conversion
5131 to the UNIX character set to be done correctly.
</P
5138 > : Russian Cyrillic
5139 UNIX character set. The parameter
<TT
5147 > be set to code page
5157 > in order for the conversion
5158 to the UNIX character set to be done correctly.
</P
5166 character set. The parameter
<TT
5174 > be set to code page
5184 > in order for the conversion
5185 to the UNIX character set to be done correctly.
</P
5192 > : Alternate mapping
5193 for Russian Cyrillic UNIX character set. The parameter
5197 >client code page
</I
5202 be set to code page
866 if the
<TT
5208 parameter is set to
<TT
5212 conversion to the UNIX character set to be done correctly.
</P
5218 >. These MSDOS code page to UNIX character
5219 set mappings should be dynamic, like the loading of MS DOS code pages,
5222 >Normally this parameter is not set, meaning no filename
5223 translation is done.
</P
5227 >character set =
<empty string
></B
5232 >character set = ISO8859-
1</B
5237 NAME=
"CLIENTCODEPAGE"
5239 >client code page (G)
</DT
5242 >This parameter specifies the DOS code page
5243 that the clients accessing Samba are using. To determine what code
5244 page a Windows or DOS client is using, open a DOS command prompt
5245 and type the command
<B
5249 the code page. The default for USA MS-DOS, Windows
95, and
5250 Windows NT releases is code page
437. The default for western
5251 European releases of the above operating systems is code page
850.
</P
5253 >This parameter tells
<A
5267 > files to dynamically load on startup. These files,
5268 described more fully in the manual page
<A
5269 HREF=
"make_smbcodepage.1.html"
5273 >make_smbcodepage(
1)
</B
5278 > how to map lower to upper case characters to provide
5279 the case insensitivity of filenames that Windows clients expect.
</P
5281 >Samba currently ships with the following code page files :
</P
5287 >Code Page
437 - MS-DOS Latin US
</P
5291 >Code Page
737 - Windows '
95 Greek
</P
5295 >Code Page
850 - MS-DOS Latin
1</P
5299 >Code Page
852 - MS-DOS Latin
2</P
5303 >Code Page
861 - MS-DOS Icelandic
</P
5307 >Code Page
866 - MS-DOS Cyrillic
</P
5311 >Code Page
932 - MS-DOS Japanese SJIS
</P
5315 >Code Page
936 - MS-DOS Simplified Chinese
</P
5319 >Code Page
949 - MS-DOS Korean Hangul
</P
5323 >Code Page
950 - MS-DOS Traditional Chinese
</P
5327 >Thus this parameter may have any of the values
437,
737,
850,
852,
5328 861,
932,
936,
949, or
950. If you don't find the codepage you need,
5329 read the comments in one of the other codepage files and the
5332 >make_smbcodepage(
1)
</B
5333 > man page and write one. Please
5334 remember to donate it back to the Samba user community.
</P
5336 >This parameter co-operates with the
<TT
5342 > parameter in determining what characters are
5343 valid in filenames and how capitalization is done. If you set both
5344 this parameter and the
<TT
5353 >client code page
</I
5358 > be set before the
<TT
5364 > parameter in the
<TT
5374 augment the character settings in the
<TT
5377 >client code page
</I
5385 >client code page
</I
5400 HREF=
"#CODEPAGEDIRECTORY"
5404 >code page directory
</I
5411 >client code page =
850</B
5416 >client code page =
936</B
5421 NAME=
"CODEPAGEDIRECTORY"
5423 >code page directory (G)
</DT
5426 >Define the location of the various client code page
5430 HREF=
"#CLIENTCODEPAGE"
5442 >code page directory = ${prefix}/lib/codepages
5448 >code page directory = /usr/share/samba/codepages
5456 >codingsystem (G)
</DT
5459 >This parameter is used to determine how incoming
5460 Shift-JIS Japanese characters are mapped from the incoming
<A
5461 HREF=
"#CLIENTCODEPAGE"
5465 >client code page
</I
5469 > used by the client, into file names in the UNIX filesystem.
5473 >client code page
</I
5476 932 (Japanese Shift-JIS). The options are :
</P
5485 > - Shift-JIS. Does no
5486 conversion of the incoming filename.
</P
5492 >JIS8, J8BB, J8BH, J8@B,
5494 > - Convert from incoming Shift-JIS to eight
5495 bit JIS code with different shift-in, shift out codes.
</P
5501 >JIS7, J7BB, J7BH, J7@B, J7@J,
5503 > - Convert from incoming Shift-JIS to seven bit
5504 JIS code with different shift-in, shift out codes.
</P
5510 >JUNET, JUBB, JUBH, JU@B, JU@J, JU@H
</TT
5512 - Convert from incoming Shift-JIS to JUNET code with different shift-in,
5520 > - Convert an incoming
5521 Shift-JIS character to EUC code.
</P
5528 > - Convert an incoming
5529 Shift-JIS character to a
3 byte hex representation, i.e.
5540 > - Convert an incoming
5541 Shift-JIS character to the
3 byte hex representation used by
5542 the Columbia AppleTalk Program (CAP), i.e.
<TT
5546 This is used for compatibility between Samba and CAP.
</P
5552 >coding system =
<empty value
></B
5563 >This is a text field that is seen next to a share
5564 when a client does a queries the server, either via the network
5565 neighborhood or via
<B
5568 > to list what shares
5571 >If you want to set the string that is displayed next to the
5572 machine name then see the
<A
5573 HREF=
"#SERVERSTRING"
5583 >No comment string
</EM
5588 >comment = Fred's Files
</B
5595 >config file (G)
</DT
5598 >This allows you to override the config file
5599 to use, instead of the default (usually
<TT
5603 There is a chicken and egg problem here as this option is set
5604 in the config file!
</P
5606 >For this reason, if the name of the config file has changed
5607 when the parameters are loaded then it will reload them from
5608 the new config file.
</P
5610 >This option takes the usual substitutions, which can
5613 >If the config file doesn't exist then it won't be loaded
5614 (allowing you to special case the config files of just a few
5619 >config file = /usr/local/samba/lib/smb.conf.%m
5630 >This parameter allows you to
"clone" service
5631 entries. The specified service is simply duplicated under the
5632 current service's name. Any parameters specified in the current
5633 section will override those in the section being copied.
</P
5635 >This feature lets you set up a 'template' service and
5636 create similar services easily. Note that the service being
5637 copied must occur earlier in the configuration file than the
5638 service doing the copying.
</P
5646 >copy = otherservice
</B
5653 >create mask (S)
</DT
5656 >A synonym for this parameter is
5668 >When a file is created, the necessary permissions are
5669 calculated according to the mapping from DOS modes to UNIX
5670 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
5671 with this parameter. This parameter may be thought of as a bit-wise
5672 MASK for the UNIX modes of a file. Any bit
<EM
5675 set here will be removed from the modes set on a file when it is
5678 >The default value of this parameter removes the
5679 'group' and 'other' write and execute bits from the UNIX modes.
</P
5681 >Following this Samba will bit-wise 'OR' the UNIX mode created
5682 from this parameter with the value of the
<A
5683 HREF=
"#FORCECREATEMODE"
5687 >force create mode
</I
5691 parameter which is set to
000 by default.
</P
5693 >This parameter does not affect directory modes. See the
5695 HREF=
"#DIRECTORYMODE"
5706 HREF=
"#FORCECREATEMODE"
5714 > parameter for forcing particular mode
5715 bits to be set on created files. See also the
<A
5716 HREF=
"#DIRECTORYMODE"
5723 > parameter for masking
5724 mode bits on created directories. See also the <A
5725 HREF="#INHERITPERMISSIONS
"
5729 >inherit permissions</I
5736 >create mask = 0744</B
5741 >create mask = 0775</B
5748 >create mode (S)</DT
5751 >This is a synonym for <A
5768 >The value of the parameter (a decimal integer)
5769 represents the number of minutes of inactivity before a connection
5770 is considered dead, and it is disconnected. The deadtime only takes
5771 effect if the number of open files is zero.</P
5773 >This is useful to stop a server's resources being
5774 exhausted by a large number of inactive connections.</P
5776 >Most clients have an auto-reconnect feature when a
5777 connection is broken so in most cases this parameter should be
5778 transparent to users.</P
5780 >Using this parameter with a timeout of a few minutes
5781 is recommended for most systems.</P
5783 >A deadtime of zero indicates that no auto-disconnection
5784 should be performed.</P
5798 NAME="DEBUGHIRESTIMESTAMP
"
5800 >debug hires timestamp (G)</DT
5803 >Sometimes the timestamps in the log messages
5804 are needed with a resolution of higher that seconds, this
5805 boolean parameter adds microsecond resolution to the timestamp
5806 message header when turned on.</P
5808 >Note that the parameter <A
5809 HREF="#DEBUGTIMESTAMP
"
5813 > debug timestamp</I
5816 > must be on for this to have an
5821 >debug hires timestamp = no</B
5831 >When using only one log file for more then one
5832 forked smbd-process there may be hard to follow which process
5833 outputs which message. This boolean parameter is adds the process-id
5834 to the timestamp message headers in the logfile when turned on.</P
5836 >Note that the parameter <A
5837 HREF="#DEBUGTIMESTAMP
"
5841 > debug timestamp</I
5844 > must be on for this to have an
5854 NAME="DEBUGTIMESTAMP
"
5856 >debug timestamp (G)</DT
5859 >Samba 2.2 debug log messages are timestamped
5860 by default. If you are running at a high <A
5869 can be distracting. This boolean parameter allows timestamping
5870 to be turned off.</P
5874 >debug timestamp = yes</B
5884 >Samba is sometimes run as root and sometime
5885 run as the connected user, this boolean parameter inserts the
5886 current euid, egid, uid and gid to the timestamp message headers
5887 in the log file if turned on.</P
5889 >Note that the parameter <A
5890 HREF="#DEBUGTIMESTAMP
"
5894 > debug timestamp</I
5897 > must be on for this to have an
5912 >The value of the parameter (an integer) allows
5913 the debug level (logging level) to be specified in the
5917 > file. This is to give greater
5918 flexibility in the configuration of the system.</P
5920 >The default will be the debug level specified on
5921 the command line or level zero if none was specified.</P
5936 HREF="#DEFAULTSERVICE
"
5940 > default service</I
5949 >default case (S)</DT
5952 >See the section on <A
5956 HREF="#SHORTPRESERVECASE
"
5960 >short preserve case"</I
5967 >default case = lower
</B
5972 NAME=
"DEFAULTSERVICE"
5974 >default service (G)
</DT
5977 >This parameter specifies the name of a service
5978 which will be connected to if the service actually requested cannot
5979 be found. Note that the square brackets are
<EM
5982 given in the parameter value (see example below).
</P
5984 >There is no default value for this parameter. If this
5985 parameter is not given, attempting to connect to a nonexistent
5986 service results in an error.
</P
5988 >Typically the default service would be a
<A
6006 >Also note that the apparent service name will be changed
6007 to equal that of the requested service, this is very useful as it
6008 allows you to use macros like
<TT
6014 a wildcard service.
</P
6016 >Note also that any
"_" characters in the name of the service
6017 used in the default service will get mapped to a
"/". This allows for
6018 interesting things.
</P
6029 CLASS=
"PROGRAMLISTING"
6031 default service = pub
6043 NAME=
"DELETEREADONLY"
6045 >delete readonly (S)
</DT
6048 >This parameter allows readonly files to be deleted.
6049 This is not normal DOS semantics, but is allowed by UNIX.
</P
6051 >This option may be useful for running applications such
6052 as rcs, where UNIX file ownership prevents changing file
6053 permissions, and DOS semantics prevent deletion of a read only file.
</P
6057 >delete readonly = no
</B
6062 NAME=
"DELETEUSERSCRIPT"
6064 >delete user script (G)
</DT
6067 >This is the full pathname to a script that will
6077 > under special circumstances
6080 >Normally, a Samba server requires that UNIX users are
6081 created for all users accessing files on this server. For sites
6082 that use Windows NT account databases as their primary user database
6083 creating these users and keeping the user list in sync with the
6084 Windows NT PDC is an onerous task. This option allows
<B
6087 > to delete the required UNIX users
<EM
6090 > when a user accesses the Samba server and the
6091 Windows NT user no longer exists.
</P
6093 >In order to use this option,
<B
6108 > must be set to a full pathname for a script
6109 that will delete a UNIX user given one argument of
<TT
6115 >, which expands into the UNIX user name to delete.
6118 > that this is different to the
<A
6119 HREF=
"#ADDUSERSCRIPT"
6127 which will work with the
<TT
6138 >. The reason for this
6139 is only when Samba is a domain member does it get the information
6140 on an attempted user logon that a user no longer exists. In the
6146 > mode a missing user
6147 is treated the same as an invalid password logon attempt. Deleting
6148 the user in this circumstance would not be a good idea.
</P
6150 >When the Windows user attempts to access the Samba server,
6153 > (session setup in the SMB protocol)
6158 HREF=
"#PASSWORDSERVER"
6165 > and attempts to authenticate
6166 the given user with the given password. If the authentication fails
6167 with the specific Domain error code meaning that the user no longer
6171 > attempts to find a UNIX user in
6172 the UNIX password database that matches the Windows user account. If
6173 this lookup succeeds, and
<TT
6176 >delete user script
</I
6182 > will all the specified script
6185 >, expanding any
<TT
6191 argument to be the user name to delete.
</P
6193 >This script should delete the given UNIX username. In this way,
6194 UNIX users are dynamically deleted to match existing Windows NT
6198 HREF=
"#SECURITYEQUALSDOMAIN"
6202 HREF=
"#PASSWORDSERVER"
6211 HREF=
"#ADDUSERSCRIPT"
6223 >delete user script =
<empty string
>
6229 >delete user script = /usr/local/samba/bin/del_user
6235 NAME=
"DELETEPRINTERCOMMAND"
6237 >deleteprinter command (G)
</DT
6240 >With the introduction of MS-RPC based printer
6241 support for Windows NT/
2000 clients in Samba
2.2, it is now
6242 possible to delete printer at run time by issuing the
6243 DeletePrinter() RPC call.
</P
6245 >For a Samba host this means that the printer must be
6246 physically deleted from underlying printing system. The
<TT
6249 > deleteprinter command
</I
6251 > defines a script to be run which
6252 will perform the necessary operations for removing the printer
6253 from the print system and from
<TT
6262 >deleteprinter command
</I
6265 automatically called with only one parameter:
<TT
6275 >deleteprinter command
</I
6281 > will reparse the
<TT
6284 > to associated printer no longer exists.
6285 If the sharename is still valid, then
<B
6289 > will return an ACCESS_DENIED error to the client.
</P
6292 HREF=
"#ADDPRINTERCOMMAND"
6296 > addprinter command
</I
6309 HREF=
"#SHOWADDPRINTERWIZARD"
6325 >deleteprinter command = /usr/bin/removeprinter
6331 NAME=
"DELETEVETOFILES"
6333 >delete veto files (S)
</DT
6336 >This option is used when Samba is attempting to
6337 delete a directory that contains one or more vetoed directories
6347 option). If this option is set to False (the default) then if a vetoed
6348 directory contains any non-vetoed files or directories then the
6349 directory delete will fail. This is usually what you want.
</P
6351 >If this option is set to
<TT
6355 will attempt to recursively delete any files and directories within
6356 the vetoed directory. This can be useful for integration with file
6357 serving systems such as NetAtalk which create meta-files within
6358 directories you might normally veto DOS/Windows users from seeing
6366 >delete veto files = yes
</B
6368 directories to be transparently deleted when the parent directory
6369 is deleted (so long as the user has permissions to do so).
</P
6384 >delete veto files = no
</B
6409 >dfree command (G)
</DT
6418 only be used on systems where a problem occurs with the internal
6419 disk space calculations. This has been known to happen with Ultrix,
6420 but may occur with other operating systems. The symptom that was
6421 seen was an error of
"Abort Retry Ignore" at the end of each
6422 directory listing.
</P
6424 >This setting allows the replacement of the internal routines to
6425 calculate the total disk space and amount available with an external
6426 routine. The example below gives a possible script that might fulfill
6429 >The external program will be passed a single parameter indicating
6430 a directory in the filesystem being queried. This will typically consist
6434 >. The script should return two
6435 integers in ASCII. The first should be the total disk space in blocks,
6436 and the second should be the number of available blocks. An optional
6437 third return value can give the block size in bytes. The default
6438 blocksize is
1024 bytes.
</P
6440 >Note: Your script should
<EM
6443 setgid and should be owned by (and writeable only by) root!
</P
6446 >By default internal routines for
6447 determining the disk capacity and remaining space will be used.
6453 >dfree command = /usr/local/samba/bin/dfree
6457 >Where the script dfree (which must be made executable) could be:
</P
6466 CLASS=
"PROGRAMLISTING"
6469 df $
1 | tail -
1 | awk '{print $
2" "$
4}'
6476 >or perhaps (on Sys V based systems):
</P
6485 CLASS=
"PROGRAMLISTING"
6488 /usr/bin/df -k $
1 | tail -
1 | awk '{print $
3" "$
5}'
6495 >Note that you may have to replace the command names
6496 with full path names on some systems.
</P
6518 NAME=
"DIRECTORYMASK"
6520 >directory mask (S)
</DT
6523 >This parameter is the octal modes which are
6524 used when converting DOS modes to UNIX modes when creating UNIX
6527 >When a directory is created, the necessary permissions are
6528 calculated according to the mapping from DOS modes to UNIX permissions,
6529 and the resulting UNIX mode is then bit-wise 'AND'ed with this
6530 parameter. This parameter may be thought of as a bit-wise MASK for
6531 the UNIX modes of a directory. Any bit
<EM
6534 here will be removed from the modes set on a directory when it is
6537 >The default value of this parameter removes the 'group'
6538 and 'other' write bits from the UNIX mode, allowing only the
6539 user who owns the directory to modify it.
</P
6541 >Following this Samba will bit-wise 'OR' the UNIX mode
6542 created from this parameter with the value of the
<A
6543 HREF=
"#FORCEDIRECTORYMODE"
6547 >force directory mode
6551 > parameter. This parameter is set to
000 by
6552 default (i.e. no extra mode bits are added).
</P
6555 HREF=
"#FORCEDIRECTORYMODE"
6563 > parameter to cause particular mode
6564 bits to always be set on created directories.
</P
6575 > parameter for masking mode bits on created files,
6577 HREF=
"#DIRECTORYSECURITYMASK"
6587 >Also refer to the
<A
6588 HREF=
"#INHERITPERMISSIONS"
6592 > inherit permissions
</I
6599 >directory mask =
0755</B
6604 >directory mask =
0775</B
6609 NAME=
"DIRECTORYMODE"
6611 >directory mode (S)
</DT
6615 HREF=
"#DIRECTORYMASK"
6626 NAME=
"DIRECTORYSECURITYMASK"
6628 >directory security mask (S)
</DT
6631 >This parameter controls what UNIX permission bits
6632 can be modified when a Windows NT client is manipulating the UNIX
6633 permission on a directory using the native NT security dialog
6636 >This parameter is applied as a mask (AND'ed with) to
6637 the changed permission bits, thus preventing any bits not in
6638 this mask from being modified. Essentially, zero bits in this
6639 mask may be treated as a set of bits the user is not allowed
6642 >If not set explicitly this parameter is set to the same
6644 HREF=
"#DIRECTORYMASK"
6652 > parameter. To allow a user to
6653 modify all the user/group/world permissions on a directory, set
6654 this parameter to
0777.
</P
6658 > that users who can access the
6659 Samba server through other means can easily bypass this restriction,
6660 so it is primarily useful for standalone
"appliance" systems.
6661 Administrators of most normal systems will probably want to set
6665 HREF=
"#FORCEDIRECTORYSECURITYMODE"
6669 > force directory security mode
</I
6673 HREF=
"#SECURITYMASK"
6682 HREF=
"#FORCESECURITYMODE"
6686 >force security mode
6694 >directory security mask =
<same as
6695 directory mask
></B
6700 >directory security mask =
0777</B
6715 when acting as a WINS server and finding that a NetBIOS name has not
6716 been registered, should treat the NetBIOS name word-for-word as a DNS
6717 name and do a lookup with the DNS server for that name on behalf of
6718 the name-querying client.
</P
6720 >Note that the maximum length for a NetBIOS name is
15
6721 characters, so the DNS name (or DNS alias) can likewise only be
6722 15 characters, maximum.
</P
6727 > spawns a second copy of itself to do the
6728 DNS name lookup requests, as doing a name lookup is a blocking
6731 >See also the parameter
<A
6748 NAME=
"DOMAINADMINGROUP"
6750 >domain admin group (G)
</DT
6756 that is part of the unfinished Samba NT Domain Controller Code. It may
6757 be removed in a later release. To work with the latest code builds
6758 that may have more support for Samba NT Domain Controller functionality
6759 please subscribe to the mailing list
<A
6760 HREF=
"mailto:samba-ntdom@samba.org"
6764 visiting the web page at
<A
6765 HREF=
"http://lists.samba.org/"
6767 > http://lists.samba.org/
</A
6772 NAME=
"DOMAINADMINUSERS"
6774 >domain admin users (G)
</DT
6780 that is part of the unfinished Samba NT Domain Controller Code. It may
6781 be removed in a later release. To work with the latest code builds
6782 that may have more support for Samba NT Domain Controller functionality
6783 please subscribe to the mailing list
<A
6784 HREF=
"mailto:samba-ntdom@samba.org"
6788 visiting the web page at
<A
6789 HREF=
"http://lists.samba.org/"
6791 > http://lists.samba.org/
</A
6798 >domain groups (G)
</DT
6804 that is part of the unfinished Samba NT Domain Controller Code. It may
6805 be removed in a later release. To work with the latest code builds
6806 that may have more support for Samba NT Domain Controller functionality
6807 please subscribe to the mailing list
<A
6808 HREF=
"mailto:samba-ntdom@samba.org"
6812 visiting the web page at
<A
6813 HREF=
"http://lists.samba.org/"
6815 > http://lists.samba.org/
</A
6820 NAME=
"DOMAINGUESTGROUP"
6822 >domain guest group (G)
</DT
6828 that is part of the unfinished Samba NT Domain Controller Code. It may
6829 be removed in a later release. To work with the latest code builds
6830 that may have more support for Samba NT Domain Controller functionality
6831 please subscribe to the mailing list
<A
6832 HREF=
"mailto:samba-ntdom@samba.org"
6836 visiting the web page at
<A
6837 HREF=
"http://lists.samba.org/"
6839 > http://lists.samba.org/
</A
6844 NAME=
"DOMAINGUESTUSERS"
6846 >domain guest users (G)
</DT
6852 that is part of the unfinished Samba NT Domain Controller Code. It may
6853 be removed in a later release. To work with the latest code builds
6854 that may have more support for Samba NT Domain Controller functionality
6855 please subscribe to the mailing list
<A
6856 HREF=
"mailto:samba-ntdom@samba.org"
6860 visiting the web page at
<A
6861 HREF=
"http://lists.samba.org/"
6863 > http://lists.samba.org/
</A
6870 >domain logons (G)
</DT
6873 >If set to true, the Samba server will serve
6874 Windows
95/
98 Domain logons for the
<A
6882 > it is in. Samba
2.2 also
6883 has limited capability to act as a domain controller for Windows
6884 NT
4 Domains. For more details on setting up this feature see
6885 the file DOMAINS.txt in the Samba documentation directory
<TT
6889 > shipped with the source code.
</P
6893 >domain logons = no
</B
6900 >domain master (G)
</DT
6910 > to enable WAN-wide browse list
6911 collation. Setting this option causes
<B
6915 claim a special domain specific NetBIOS name that identifies
6916 it as a domain master browser for its given
<A
6924 >. Local master browsers
6930 > on broadcast-isolated
6931 subnets will give this
<B
6934 > their local browse lists,
6943 for a complete copy of the browse list for the whole wide area
6944 network. Browser clients will then contact their local master browser,
6945 and will receive the domain-wide browse list, instead of just the list
6946 for their broadcast-isolated subnet.
</P
6948 >Note that Windows NT Primary Domain Controllers expect to be
6949 able to claim this
<TT
6955 NetBIOS name that identifies them as domain master browsers for
6961 > by default (i.e. there is no
6962 way to prevent a Windows NT PDC from attempting to do this). This
6963 means that if this parameter is set and
<B
6967 the special name for a
<TT
6973 NT PDC is able to do so then cross subnet browsing will behave
6974 strangely and may fail.
</P
6977 HREF=
"#DOMAINLOGONS"
6980 >domain logons = yes
</B
6983 >, then the default behavior is to enable the
<TT
6995 not enabled (the default setting), then neither will
<TT
7001 > be enabled by default.
</P
7005 >domain master = auto
</B
7012 >dont descend (S)
</DT
7015 >There are certain directories on some systems
7019 > tree under Linux) that are either not
7020 of interest to clients or are infinitely deep (recursive). This
7021 parameter allows you to specify a comma-delimited list of directories
7022 that the server should always show as empty.
</P
7024 >Note that Samba can be very fussy about the exact format
7025 of the
"dont descend" entries. For example you may need
<TT
7028 > instead of just
<TT
7032 Experimentation is the best policy :-)
</P
7035 >none (i.e., all directories are OK
7041 >dont descend = /proc,/dev
</B
7048 >dos filemode (S)
</DT
7051 > The default behavior in Samba is to provide
7052 UNIX-like behavor where only the owner of a file/directory is
7053 able to change the permissions on it. However, this behavior
7054 is often confusing to DOS/Windows users. Enabling this parameter
7055 allows a user who has write access to the file (by whatever
7056 means) to modify the permissions on it. Note that a user
7057 belonging to the group owning the file will not be allowed to
7058 change permissions if the group is only granted read access.
7059 Ownership of the file/directory is not changed, only the permissions
7064 >dos filemode = no
</B
7069 NAME=
"DOSFILETIMERESOLUTION"
7071 >dos filetime resolution (S)
</DT
7074 >Under the DOS and Windows FAT filesystem, the finest
7075 granularity on time resolution is two seconds. Setting this parameter
7076 for a share causes Samba to round the reported time down to the
7077 nearest two second boundary when a query call that requires one second
7078 resolution is made to
<A
7088 >This option is mainly used as a compatibility option for Visual
7089 C++ when used against Samba shares. If oplocks are enabled on a
7090 share, Visual C++ uses two different time reading calls to check if a
7091 file has changed since it was last read. One of these calls uses a
7092 one-second granularity, the other uses a two second granularity. As
7093 the two second call rounds any odd second down, then if the file has a
7094 timestamp of an odd number of seconds then the two timestamps will not
7095 match and Visual C++ will keep reporting the file has changed. Setting
7096 this option causes the two timestamps to match, and Visual C++ is
7101 >dos filetime resolution = no
</B
7108 >dos filetimes (S)
</DT
7111 >Under DOS and Windows, if a user can write to a
7112 file they can change the timestamp on it. Under POSIX semantics,
7113 only the owner of the file or root may change the timestamp. By
7114 default, Samba runs with POSIX semantics and refuses to change the
7115 timestamp on a file if the user
<B
7119 on behalf of is not the file owner. Setting this option to
<TT
7122 > allows DOS semantics and smbd will change the file
7123 timestamp as DOS requires.
</P
7127 >dos filetimes = no
</B
7132 NAME=
"ENCRYPTPASSWORDS"
7134 >encrypt passwords (G)
</DT
7137 >This boolean controls whether encrypted passwords
7138 will be negotiated with the client. Note that Windows NT
4.0 SP3 and
7139 above and also Windows
98 will by default expect encrypted passwords
7140 unless a registry entry is changed. To use encrypted passwords in
7141 Samba see the file ENCRYPTION.txt in the Samba documentation
7145 > shipped with the source code.
</P
7147 >In order for encrypted passwords to work correctly
7156 have access to a local
<A
7157 HREF=
"smbpasswd.5.html"
7165 HREF=
"smbpasswd.8.html"
7171 > program for information on how to set up
7172 and maintain this file), or set the
<A
7174 >security=[serve|domain]
</A
7179 > to authenticate against another
7184 >encrypt passwords = no
</B
7189 NAME=
"ENHANCEDBROWSING"
7191 >enhanced browsing (G)
</DT
7194 >This option enables a couple of enhancements to
7195 cross-subnet browse propogation that have been added in Samba
7196 but which are not standard in Microsoft implementations.
7198 >These enhancements are currently only available in
7199 the HEAD Samba CVS tree (not Samba
2.2.x).
</EM
7202 >The first enhancement to browse propogation consists of a regular
7203 wildcard query to a Samba WINS server for all Domain Master Browsers,
7204 followed by a browse synchronisation with each of the returned
7205 DMBs. The second enhancement consists of a regular randomised browse
7206 synchronisation with all currently known DMBs.
</P
7208 >You may wish to disable this option if you have a problem with empty
7209 workgroups not disappearing from browse lists. Due to the restrictions
7210 of the browse protocols these enhancements can cause a empty workgroup
7211 to stay around forever which can be annoying.
</P
7213 >In general you should leave this option enabled as it makes
7214 cross-subnet browse propogation much more reliable.
</P
7218 >enhanced browsing = yes
</B
7223 NAME=
"ENUMPORTSCOMMAND"
7225 >enumports command (G)
</DT
7228 >The concept of a
"port" is fairly foreign
7229 to UNIX hosts. Under Windows NT/
2000 print servers, a port
7230 is associated with a port monitor and generally takes the form of
7231 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
7232 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
7235 >"Samba Printer Port"</TT
7237 Windows NT/
2000, all printers must have a valid port name.
7238 If you wish to have a list of ports displayed (
<B
7242 > does not use a port name for anything) other than
7245 >"Samba Printer Port"</TT
7250 >enumports command
</I
7253 a program which should generate a list of ports, one per line,
7254 to standard output. This listing will then be used in response
7255 to the level
1 and
2 EnumPorts() RPC.
</P
7258 >no enumports command
</EM
7263 >enumports command = /usr/bin/listports
7274 >This is a synonym for
<A
7286 NAME=
"FAKEDIRECTORYCREATETIMES"
7288 >fake directory create times (S)
</DT
7291 >NTFS and Windows VFAT file systems keep a create
7292 time for all files and directories. This is not the same as the
7293 ctime - status change time - that Unix keeps, so Samba by default
7294 reports the earliest of the various times Unix does keep. Setting
7295 this parameter for a share causes Samba to always report midnight
7296 1-
1-
1980 as the create time for directories.
</P
7298 >This option is mainly used as a compatibility option for
7299 Visual C++ when used against Samba shares. Visual C++ generated
7300 makefiles have the object directory as a dependency for each object
7301 file, and a make rule to create the directory. Also, when NMAKE
7302 compares timestamps it uses the creation time when examining a
7303 directory. Thus the object directory will be created if it does not
7304 exist, but once it does exist it will always have an earlier
7305 timestamp than the object files it contains.
</P
7307 >However, Unix time semantics mean that the create time
7308 reported by Samba will be updated whenever a file is created or
7309 or deleted in the directory. NMAKE finds all object files in
7310 the object directory. The timestamp of the last one built is then
7311 compared to the timestamp of the object dircetory. If the
7312 directory's timestamp if newer, then all object files
7313 will be rebuilt. Enabling this option
7314 ensures directories always predate their contents and an NMAKE build
7315 will proceed as expected.
</P
7319 >fake directory create times = no
</B
7326 >fake oplocks (S)
</DT
7329 >Oplocks are the way that SMB clients get permission
7330 from a server to locally cache file operations. If a server grants
7331 an oplock (opportunistic lock) then the client is free to assume
7332 that it is the only one accessing the file and it will aggressively
7333 cache file data. With some oplock types the client may even cache
7334 file open/close operations. This can give enormous performance benefits.
7339 >fake oplocks = yes
</B
7348 always grant oplock requests no matter how many clients are using
7351 >It is generally much better to use the real
<A
7360 than this parameter.
</P
7362 >If you enable this option on all read-only shares or
7363 shares that you know will only be accessed from one client at a
7364 time such as physically read-only media like CDROMs, you will see
7365 a big performance improvement on many operations. If you enable
7366 this option on shares where multiple clients may be accessing the
7367 files read-write at the same time you can get data corruption. Use
7368 this option carefully!
</P
7372 >fake oplocks = no
</B
7377 NAME=
"FOLLOWSYMLINKS"
7379 >follow symlinks (S)
</DT
7382 >This parameter allows the Samba administrator
7391 from following symbolic links in a particular share. Setting this
7395 > prevents any file or directory
7396 that is a symbolic link from being followed (the user will get an
7397 error). This option is very useful to stop users from adding a
7398 symbolic link to
<TT
7402 directory for instance. However it will slow filename lookups
7405 >This option is enabled (i.e.
<B
7409 follow symbolic links) by default.
</P
7413 >follow symlinks = yes
</B
7418 NAME=
"FORCECREATEMODE"
7420 >force create mode (S)
</DT
7423 >This parameter specifies a set of UNIX mode bit
7424 permissions that will
<EM
7427 file created by Samba. This is done by bitwise 'OR'ing these bits onto
7428 the mode bits of a file that is being created or having its
7429 permissions changed. The default for this parameter is (in octal)
7430 000. The modes in this parameter are bitwise 'OR'ed onto the file
7431 mode after the mask set in the
<TT
7437 parameter is applied.
</P
7439 >See also the parameter
<A
7448 > for details on masking mode bits on files.
</P
7451 HREF=
"#INHERITPERMISSIONS"
7463 >force create mode =
000</B
7468 >force create mode =
0755</B
7471 >would force all created files to have read and execute
7472 permissions set for 'group' and 'other' as well as the
7473 read/write/execute bits set for the 'user'.
</P
7477 NAME=
"FORCEDIRECTORYMODE"
7479 >force directory mode (S)
</DT
7482 >This parameter specifies a set of UNIX mode bit
7483 permissions that will
<EM
7485 > be set on a directory
7486 created by Samba. This is done by bitwise 'OR'ing these bits onto the
7487 mode bits of a directory that is being created. The default for this
7488 parameter is (in octal)
0000 which will not add any extra permission
7489 bits to a created directory. This operation is done after the mode
7490 mask in the parameter
<TT
7498 >See also the parameter
<A
7499 HREF=
"#DIRECTORYMASK"
7506 > for details on masking mode bits
7507 on created directories.
</P
7510 HREF=
"#INHERITPERMISSIONS"
7514 > inherit permissions
</I
7521 >force directory mode =
000</B
7526 >force directory mode =
0755</B
7529 >would force all created directories to have read and execute
7530 permissions set for 'group' and 'other' as well as the
7531 read/write/execute bits set for the 'user'.
</P
7535 NAME=
"FORCEDIRECTORYSECURITYMODE"
7538 security mode (S)
</DT
7541 >This parameter controls what UNIX permission bits
7542 can be modified when a Windows NT client is manipulating the UNIX
7543 permission on a directory using the native NT security dialog box.
</P
7545 >This parameter is applied as a mask (OR'ed with) to the
7546 changed permission bits, thus forcing any bits in this mask that
7547 the user may have modified to be on. Essentially, one bits in this
7548 mask may be treated as a set of bits that, when modifying security
7549 on a directory, the user has always set to be 'on'.
</P
7551 >If not set explicitly this parameter is set to the same
7553 HREF=
"#FORCEDIRECTORYMODE"
7561 > parameter. To allow
7562 a user to modify all the user/group/world permissions on a
7563 directory without restrictions, set this parameter to
000.
</P
7567 > that users who can access the
7568 Samba server through other means can easily bypass this restriction,
7569 so it is primarily useful for standalone
"appliance" systems.
7570 Administrators of most normal systems will probably want to set
7574 HREF=
"#DIRECTORYSECURITYMASK"
7578 > directory security mask
</I
7582 HREF=
"#SECURITYMASK"
7591 HREF=
"#FORCESECURITYMODE"
7595 >force security mode
7603 >force directory security mode =
<same as
7604 force directory mode
></B
7609 >force directory security mode =
0</B
7616 >force group (S)
</DT
7619 >This specifies a UNIX group name that will be
7620 assigned as the default primary group for all users connecting
7621 to this service. This is useful for sharing files by ensuring
7622 that all access to files on service will use the named group for
7623 their permissions checking. Thus, by assigning permissions for this
7624 group to the files and directories within this service the Samba
7625 administrator can restrict or allow sharing of these files.
</P
7627 >In Samba
2.0.5 and above this parameter has extended
7628 functionality in the following way. If the group name listed here
7629 has a '+' character prepended to it then the current user accessing
7630 the share only has the primary group default assigned to this group
7631 if they are already assigned as a member of that group. This allows
7632 an administrator to decide that only users who are already in a
7633 particular group will create files with group ownership set to that
7634 group. This gives a finer granularity of ownership assignment. For
7635 example, the setting
<TT
7637 >force group = +sys
</TT
7639 that only users who are already in group sys will have their default
7640 primary group assigned to sys when accessing this Samba share. All
7641 other users will retain their ordinary primary group.
</P
7652 > parameter is also set the group specified in
7658 > will override the primary group
7678 >no forced group
</EM
7683 >force group = agroup
</B
7688 NAME=
"FORCESECURITYMODE"
7690 >force security mode (S)
</DT
7693 >This parameter controls what UNIX permission
7694 bits can be modified when a Windows NT client is manipulating
7695 the UNIX permission on a file using the native NT security dialog
7698 >This parameter is applied as a mask (OR'ed with) to the
7699 changed permission bits, thus forcing any bits in this mask that
7700 the user may have modified to be on. Essentially, one bits in this
7701 mask may be treated as a set of bits that, when modifying security
7702 on a file, the user has always set to be 'on'.
</P
7704 >If not set explicitly this parameter is set to the same
7706 HREF=
"#FORCECREATEMODE"
7714 > parameter. To allow a user to
7715 modify all the user/group/world permissions on a file, with no
7716 restrictions set this parameter to
000.
</P
7720 > that users who can access
7721 the Samba server through other means can easily bypass this restriction,
7722 so it is primarily useful for standalone
"appliance" systems.
7723 Administrators of most normal systems will probably want to set
7727 HREF=
"#FORCEDIRECTORYSECURITYMODE"
7731 > force directory security mode
</I
7736 HREF=
"#DIRECTORYSECURITYMASK"
7745 HREF=
"#SECURITYMASK"
7756 >force security mode =
<same as force
7762 >force security mode =
0</B
7772 >This specifies a UNIX user name that will be
7773 assigned as the default user for all users connecting to this service.
7774 This is useful for sharing files. You should also use it carefully
7775 as using it incorrectly can cause security problems.
</P
7777 >This user name only gets used once a connection is established.
7778 Thus clients still need to connect as a valid user and supply a
7779 valid password. Once connected, all file operations will be performed
7780 as the
"forced user", no matter what username the client connected
7781 as. This can be very useful.
</P
7783 >In Samba
2.0.5 and above this parameter also causes the
7784 primary group of the forced user to be used as the primary group
7785 for all file activity. Prior to
2.0.5 the primary group was left
7786 as the primary group of the connecting user (this was a bug).
</P
7805 >force user = auser
</B
7815 >This parameter allows the administrator to
7816 configure the string that specifies the type of filesystem a share
7817 is using that is reported by
<A
7825 > when a client queries the filesystem type
7826 for a share. The default type is
<TT
7830 compatibility with Windows NT but this can be changed to other
7854 >getwd cache (G)
</DT
7857 >This is a tuning option. When this is enabled a
7858 caching algorithm will be used to reduce the time taken for getwd()
7859 calls. This can have a significant impact on performance, especially
7869 >parameter is set to
<TT
7876 >getwd cache = yes
</B
7901 >guest account (S)
</DT
7904 >This is a username which will be used for access
7905 to services which are specified as
<A
7913 > (see below). Whatever privileges this
7914 user has will be available to any client connecting to the guest service.
7915 Typically this user will exist in the password file, but will not
7916 have a valid login. The user account
"ftp" is often a good choice
7917 for this parameter. If a username is specified in a given service,
7918 the specified username overrides this one.
</P
7920 >One some systems the default guest account
"nobody" may not
7921 be able to print. Use another account in this case. You should test
7922 this by trying to log in as your guest user (perhaps by using the
7926 > command) and trying to print using the
7927 system print command such as
<B
7936 >specified at compile time, usually
7942 >guest account = ftp
</B
7952 >If this parameter is
<TT
7956 a service, then no password is required to connect to the service.
7957 Privileges will be those of the
<A
7958 HREF=
"#GUESTACCOUNT"
7967 >See the section below on
<A
7975 > for more information about this option.
7990 >If this parameter is
<TT
7994 a service, then only guest connections to the service are permitted.
7995 This parameter will have no effect if
<A
8003 > is not set for the service.
</P
8005 >See the section below on
<A
8013 > for more information about this option.
8025 >hide dot files (S)
</DT
8028 >This is a boolean parameter that controls whether
8029 files starting with a dot appear as hidden files.
</P
8033 >hide dot files = yes
</B
8043 >This is a list of files or directories that are not
8044 visible but are accessible. The DOS 'hidden' attribute is applied
8045 to any files or directories that match.
</P
8047 >Each entry in the list must be separated by a '/',
8048 which allows spaces to be included in the entry. '*'
8049 and '?' can be used to specify multiple files or directories
8050 as in DOS wildcards.
</P
8052 >Each entry must be a Unix path, not a DOS path and must
8053 not include the Unix directory separator '/'.
</P
8055 >Note that the case sensitivity option is applicable
8058 >Setting this parameter will affect the performance of Samba,
8059 as it will be forced to check all files and directories for a match
8060 as they are scanned.
</P
8063 HREF=
"#HIDEDOTFILES"
8080 HREF=
"#CASESENSITIVE"
8090 >no file are hidden
</EM
8096 /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</B
8099 >The above example is based on files that the Macintosh
8100 SMB client (DAVE) available from
<A
8101 HREF=
"http://www.thursby.com"
8105 > creates for internal use, and also still hides
8106 all files beginning with a dot.
</P
8110 NAME=
"HIDELOCALUSERS"
8112 >hide local users(G)
</DT
8115 >This parameter toggles the hiding of local UNIX
8116 users (root, wheel, floppy, etc) from remote clients.
</P
8120 >hide local users = no
</B
8127 >homedir map (G)
</DT
8155 > then this parameter
8156 specifies the NIS (or YP) map from which the server for the user's
8157 home directory should be extracted. At present, only the Sun
8158 auto.home map format is understood. The form of the map is:
</P
8162 >username server:/some/file/system
</B
8165 >and the program will extract the servername from before
8166 the first ':'. There should probably be a better parsing system
8167 that copes with different map formats and also Amd (another
8168 automounter) maps.
</P
8172 >A working NIS client is required on
8173 the system for this option to work.
</P
8185 HREF=
"#DOMAINLOGONS"
8197 >homedir map =
<empty string
></B
8202 >homedir map = amd.homedir
</B
8212 >This boolean parameter is only available
8213 if Samba has been configured and compiled with the
<B
8216 > option. If set to
<TT
8220 Samba will act as a Dfs server, and allow Dfs-aware clients
8221 to browse Dfs trees hosted on the server.
</P
8231 > share level parameter. For
8232 more information on setting up a Dfs tree on Samba,
8234 HREF=
"msdfs_setup.html"
8236 >msdfs_setup.html
</A
8249 >hosts allow (S)
</DT
8252 >A synonym for this parameter is
<TT
8260 >This parameter is a comma, space, or tab delimited
8261 set of hosts which are permitted to access a service.
</P
8263 >If specified in the [global] section then it will
8264 apply to all services, regardless of whether the individual
8265 service has a different setting.
</P
8267 >You can specify the hosts by name or IP number. For
8268 example, you could restrict access to only the hosts on a
8269 Class C subnet with something like
<B
8271 >allow hosts =
150.203.5.
8273 >. The full syntax of the list is described in the man
8276 >hosts_access(
5)
</TT
8277 >. Note that this man
8278 page may not be present on your system, so a brief description will
8279 be given here also.
</P
8281 >Note that the localhost address
127.0.0.1 will always
8282 be allowed access unless specifically denied by a
<A
8292 >You can also specify hosts by network/netmask pairs and
8293 by netgroup names if your system supports netgroups. The
8296 > keyword can also be used to limit a
8297 wildcard list. The following examples may provide some help:
</P
8299 >Example
1: allow all IPs in
150.203.*.*; except one
</P
8303 >hosts allow =
150.203. EXCEPT
150.203.6.66</B
8306 >Example
2: allow hosts that match the given network/netmask
</P
8310 >hosts allow =
150.203.15.0/
255.255.255.0</B
8313 >Example
3: allow a couple of hosts
</P
8317 >hosts allow = lapland, arvidsjaur
</B
8320 >Example
4: allow only hosts in NIS netgroup
"foonet", but
8321 deny access from one particular host
</P
8325 >hosts allow = @foonet
</B
8330 >hosts deny = pirate
</B
8333 >Note that access still requires suitable user-level passwords.
</P
8336 HREF=
"testparm.1.html"
8343 > for a way of testing your host access to see if it does
8347 >none (i.e., all hosts permitted access)
8353 >allow hosts =
150.203.5. myhost.mynet.edu.au
8364 >The opposite of
<TT
8370 - hosts listed here are
<EM
8372 > permitted access to
8373 services unless the specific services have their own lists to override
8374 this one. Where the lists conflict, the
<TT
8380 list takes precedence.
</P
8383 >none (i.e., no hosts specifically excluded)
8389 >hosts deny =
150.203.4. badhost.mynet.edu.au
8397 >hosts equiv (G)
</DT
8400 >If this global parameter is a non-null string,
8401 it specifies the name of a file to read for the names of hosts
8402 and users who will be allowed access without specifying a password.
8405 >This is not be confused with
<A
8413 > which is about hosts
8414 access to services and is more useful for guest services.
<TT
8419 > may be useful for NT clients which will
8420 not supply passwords to samba.
</P
8430 > can be a major security hole. This is because you are
8431 trusting the PC to supply the correct username. It is very easy to
8432 get a PC to supply a false username. I recommend that the
8438 > option be only used if you really
8439 know what you are doing, or perhaps on a home network where you trust
8440 your spouse and kids. And only if you
<EM
8446 >no host equivalences
</EM
8451 >hosts equiv = /etc/hosts.equiv
</B
8461 >This allows you to include one config file
8462 inside another. The file is included literally, as though typed
8465 >It takes the standard substitutions, except
<TT
8485 >no file included
</EM
8490 >include = /usr/local/samba/lib/admin_smb.conf
8496 NAME=
"INHERITPERMISSIONS"
8498 >inherit permissions (S)
</DT
8501 >The permissions on new files and directories
8502 are normally governed by
<A
8511 HREF=
"#DIRECTORYMASK"
8519 HREF=
"#FORCECREATEMODE"
8523 >force create mode
</I
8528 HREF=
"#FORCEDIRECTORYMODE"
8536 > but the boolean inherit
8537 permissions parameter overrides this.
</P
8539 >New directories inherit the mode of the parent directory,
8540 including bits such as setgid.
</P
8542 >New files inherit their read/write bits from the parent
8543 directory. Their execute bits continue to be determined by
8573 >Note that the setuid bit is
<EM
8576 inheritance (the code explicitly prohibits this).
</P
8578 >This can be particularly useful on large systems with
8579 many users, perhaps several thousand,to allow a single [homes]
8580 share to be used flexibly by each user.
</P
8592 HREF=
"#DIRECTORYMASK"
8600 HREF=
"#FORCECREATEMODE"
8604 >force create mode
</I
8608 HREF=
"#FORCEDIRECTORYMODE"
8612 >force directory mode
</I
8620 >inherit permissions = no
</B
8630 >This option allows you to override the default
8631 network interfaces list that Samba will use for browsing, name
8632 registration and other NBT traffic. By default Samba will query
8633 the kernel for the list of all active interfaces and use any
8634 interfaces except
127.0.0.1 that are broadcast capable.
</P
8636 >The option takes a list of interface strings. Each string
8637 can be in any of the following forms:
</P
8643 >a network interface name (such as eth0).
8644 This may include shell-like wildcards so eth* will match
8645 any interface starting with the substring
"eth"</P
8649 >an IP address. In this case the netmask is
8650 determined from the list of interfaces obtained from the
8655 >an IP/mask pair.
</P
8659 >a broadcast/mask pair.
</P
8663 >The
"mask" parameters can either be a bit length (such
8664 as
24 for a C class network) or a full netmask in dotted
8667 >The
"IP" parameters above can either be a full dotted
8668 decimal IP address or a hostname which will be looked up via
8669 the OS's normal hostname resolution mechanisms.
</P
8671 >For example, the following line:
</P
8675 >interfaces = eth0
192.168.2.10/
24 192.168.3.10/
255.255.255.0
8679 >would configure three network interfaces corresponding
8680 to the eth0 device and IP addresses
192.168.2.10 and
192.168.3.10.
8681 The netmasks of the latter two interfaces would be set to
255.255.255.0.
</P
8684 HREF=
"#BINDINTERFACESONLY"
8695 >all active interfaces except
127.0.0.1
8696 that are broadcast capable
</EM
8703 >invalid users (S)
</DT
8706 >This is a list of users that should not be allowed
8707 to login to this service. This is really a
<EM
8710 check to absolutely ensure an improper setting does not breach
8713 >A name starting with a '@' is interpreted as an NIS
8714 netgroup first (if your system supports NIS), and then as a UNIX
8715 group if the name was not found in the NIS netgroup database.
</P
8717 >A name starting with '+' is interpreted only
8718 by looking in the UNIX group database. A name starting with
8719 '
&' is interpreted only by looking in the NIS netgroup database
8720 (this requires NIS to be working on your system). The characters
8721 '+' and '
&' may be used at the start of the name in either order
8728 UNIX group database, followed by the NIS netgroup database, and
8734 > means check the NIS
8735 netgroup database, followed by the UNIX group database (the
8736 same as the '@' prefix).</P
8738 >The current servicename is substituted for <TT
8744 This is useful in the [homes] section.</P
8758 >no invalid users</EM
8763 >invalid users = root fred admin @wheel
8774 >The value of the parameter (an integer) represents
8775 the number of seconds between <TT
8781 packets. If this parameter is zero, no keepalive packets will be
8782 sent. Keepalive packets, if sent, allow the server to tell whether
8783 a client is still present and responding.</P
8785 >Keepalives should, in general, not be needed if the socket
8786 being used has the SO_KEEPALIVE attribute set on it (see <A
8787 HREF="#SOCKETOPTIONS
"
8795 Basically you should only use this option if you strike difficulties.</P
8809 NAME="KERNELOPLOCKS
"
8811 >kernel oplocks (G)</DT
8814 >For UNIXes that support kernel based <A
8823 (currently only IRIX and the Linux 2.4 kernel), this parameter
8824 allows the use of them to be turned on or off.</P
8826 >Kernel oplocks support allows Samba <TT
8832 > to be broken whenever a local UNIX process or NFS operation
8833 accesses a file that <A
8841 > has oplocked. This allows complete data consistency between
8842 SMB/CIFS, NFS and local file access (and is a <EM
8845 cool feature :-).</P
8847 >This parameter defaults to <TT
8851 that have the support, and <TT
8855 don't. You should never need to touch this parameter.</P
8867 HREF="#LEVEL2OPLOCKS
"
8879 >kernel oplocks = yes</B
8886 >lanman auth (G)</DT
8889 >This parameter determines whether or not smbd will
8890 attempt to authentication users using the LANMAN password hash.
8891 If disabled, only clients which support NT password hashes (e.g. Windows
8892 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
8893 network client) will be able to connect to the Samba host.</P
8897 >lanman auth = yes</B
8902 NAME="LEVEL2OPLOCKS
"
8904 >level2 oplocks (S)</DT
8907 >This parameter controls whether Samba supports
8908 level2 (read-only) oplocks on a share.</P
8910 >Level2, or read-only oplocks allow Windows NT clients
8911 that have an oplock on a file to downgrade from a read-write oplock
8912 to a read-only oplock once a second client opens the file (instead
8913 of releasing all oplocks on a second open, as in traditional,
8914 exclusive oplocks). This allows all openers of the file that
8915 support level2 oplocks to cache the file for read-ahead only (ie.
8916 they may not cache writes or lock requests) and increases performance
8917 for many accesses of files that are not commonly written (such as
8918 application .EXE files).</P
8920 >Once one of the clients which have a read-only oplock
8921 writes to the file all clients are notified (no reply is needed
8922 or waited for) and told to break their oplocks to "none
" and
8923 delete any read-ahead caches.</P
8925 >It is recommended that this parameter be turned on
8926 to speed access to shared executables.</P
8928 >For more discussions on level2 oplocks see the CIFS spec.</P
8931 HREF="#KERNELOPLOCKS
"
8939 > are supported then level2 oplocks are
8940 not granted (even if this parameter is set to <TT
8953 > parameter must be set to "true
" on this share in order for
8954 this parameter to have any effect.</P
8978 >level2 oplocks = yes</B
8985 >lm announce (G)</DT
8988 >This parameter determines if <A
8995 > will produce Lanman announce
8996 broadcasts that are needed by OS/2 clients in order for them to see
8997 the Samba server in their browse list. This parameter can have three
9008 >. The default is <TT
9015 > Samba will never produce these
9016 broadcasts. If set to <TT
9019 > Samba will produce
9020 Lanman announce broadcasts at a frequency set by the parameter
9030 Samba will not send Lanman announce broadcasts by default but will
9031 listen for them. If it hears such a broadcast on the wire it will
9032 then start sending them at a frequency set by the parameter
9053 >lm announce = auto</B
9058 >lm announce = yes</B
9065 >lm interval (G)</DT
9068 >If Samba is set to produce Lanman announce
9069 broadcasts needed by OS/2 clients (see the <A
9077 > parameter) then this
9078 parameter defines the frequency in seconds with which they will be
9079 made. If this is set to zero then no Lanman announcements will be
9080 made despite the setting of the <TT
9101 >lm interval = 60</B
9106 >lm interval = 120</B
9113 >load printers (G)</DT
9116 >A boolean variable that controls whether all
9117 printers in the printcap will be loaded for browsing by default.
9126 >load printers = yes</B
9133 >local master (G)</DT
9136 >This option allows <A
9143 > to try and become a local master browser
9144 on a subnet. If set to <TT
9150 > will not attempt to become a local master browser
9151 on a subnet and will also lose in all browsing elections. By
9152 default this value is set to true. Setting this value to true doesn't
9153 mean that Samba will <EM
9156 browser on a subnet, just that <B
9161 > in elections for local master browser.</P
9163 >Setting this value to False will cause <B
9169 > to become a local master browser.</P
9173 >local master = yes</B
9184 HREF="#LOCKDIRECTORY
"
9195 NAME="LOCKDIRECTORY
"
9197 >lock directory (G)</DT
9200 >This option specifies the directory where lock
9201 files will be placed. The lock files are used to implement the
9203 HREF="#MAXCONNECTIONS
"
9215 >lock directory = ${prefix}/var/locks</B
9220 >lock directory = /var/run/samba/locks</B
9231 >This controls whether or not locking will be
9232 performed by the server in response to lock requests from the
9238 >, all lock and unlock
9239 requests will appear to succeed and all lock queries will report
9240 that the file in question is available for locking.</P
9245 >, real locking will be performed
9250 > be useful for read-only
9251 filesystems which <EM
9253 > not need locking (such as
9254 cdrom drives), although setting this parameter of <TT
9258 is not really recommended even in this case.</P
9260 >Be careful about disabling locking either globally or in a
9261 specific service, as lack of locking may result in data corruption.
9262 You should never need to set this parameter.</P
9276 >This option allows you to override the name
9277 of the Samba log file (also known as the debug file).</P
9279 >This option takes the standard substitutions, allowing
9280 you to have separate log files for each user or machine.</P
9284 >log file = /usr/local/samba/var/log.%m
9309 >logon drive (G)</DT
9312 >This parameter specifies the local path to
9313 which the home directory will be connected (see <A
9322 and is only used by NT Workstations. </P
9324 >Note that this option is only useful if Samba is set up as a
9329 >logon drive = z:</B
9334 >logon drive = h:</B
9344 >This parameter specifies the home directory
9345 location when a Win95/98 or NT Workstation logs into a Samba PDC.
9346 It allows you to do </P
9354 >NET USE H: /HOME</B
9359 >from a command prompt, for example.</P
9361 >This option takes the standard substitutions, allowing
9362 you to have separate logon scripts for each user or machine.</P
9364 >This parameter can be used with Win9X workstations to ensure
9365 that roaming profiles are stored in a subdirectory of the user's
9366 home directory. This is done in the following way:</P
9370 >logon home = \\%N\%U\profile</B
9373 >This tells Samba to return the above string, with
9374 substitutions made when a client requests the info, generally
9375 in a NetUserGetInfo request. Win9X clients truncate the info to
9376 \\server\share when a user does <B
9380 but use the whole string when dealing with profiles.
</P
9382 >Note that in prior versions of Samba, the
<A
9390 > was returned rather than
9400 > but allowed profiles outside the home directory.
9401 The current implementation is correct, and can be used for
9402 profiles if you use the above trick.
</P
9404 >This option is only useful if Samba is set up as a logon
9409 >logon home =
"\\%N\%U"</B
9414 >logon home =
"\\remote_smb_server\%U"</B
9425 >This parameter specifies the home directory
9426 where roaming profiles (NTuser.dat etc files for Windows NT) are
9427 stored. Contrary to previous versions of these manual pages, it has
9428 nothing to do with Win
9X roaming profiles. To find out how to
9429 handle roaming profiles for Win
9X system, see the
<A
9439 >This option takes the standard substitutions, allowing you
9440 to have separate logon scripts for each user or machine. It also
9441 specifies the directory from which the
"Application Data",
9451 >network neighborhood
</TT
9456 and other folders, and their contents, are loaded and displayed on
9457 your Windows NT client.
</P
9459 >The share and the path must be readable by the user for
9460 the preferences and directories to be loaded onto the Windows NT
9461 client. The share must be writeable when the logs in for the first
9462 time, in order that the Windows NT client can create the NTuser.dat
9463 and other directories.
</P
9465 >Thereafter, the directories and any of the contents can,
9466 if required, be made read-only. It is not advisable that the
9467 NTuser.dat file be made read-only - rename it to NTuser.man to
9468 achieve the desired effect (a
<EM
9473 >Windows clients can sometimes maintain a connection to
9474 the [homes] share, even though there is no user logged in.
9475 Therefore, it is vital that the logon path does not include a
9476 reference to the homes share (i.e. setting this parameter to
9477 \%N\%U\profile_path will cause problems).
</P
9479 >This option takes the standard substitutions, allowing
9480 you to have separate logon scripts for each user or machine.
</P
9482 >Note that this option is only useful if Samba is set up
9483 as a logon server.
</P
9487 >logon path = \\%N\%U\profile
</B
9492 >logon path = \\PROFILESERVER\PROFILE\%U
</B
9499 >logon script (G)
</DT
9502 >This parameter specifies the batch file (.bat) or
9503 NT command file (.cmd) to be downloaded and run on a machine when
9504 a user successfully logs in. The file must contain the DOS
9505 style cr/lf line endings. Using a DOS-style editor to create the
9506 file is recommended.
</P
9508 >The script must be a relative path to the [netlogon]
9509 service. If the [netlogon] service specifies a
<A
9519 >/usr/local/samba/netlogon
9523 >logon script = STARTUP.BAT
</B
9525 the file that will be downloaded is:
</P
9529 >/usr/local/samba/netlogon/STARTUP.BAT
</TT
9532 >The contents of the batch file is entirely your choice. A
9533 suggested command would be to add
<B
9535 >NET TIME \\SERVER /SET
9537 >, to force every machine to synchronize clocks with
9538 the same time server. Another use would be to add
<B
9541 U: \\SERVER\UTILS
</B
9542 > for commonly used utilities, or
<B
9544 > NET USE Q: \\SERVER\ISO9001_QA
</B
9547 >Note that it is particularly important not to allow write
9548 access to the [netlogon] share, or to grant users write permission
9549 on the batch files in a secure environment, as this would allow
9550 the batch files to be arbitrarily modified and security to be
9553 >This option takes the standard substitutions, allowing you
9554 to have separate logon scripts for each user or machine.
</P
9556 >This option is only useful if Samba is set up as a logon
9560 >no logon script defined
</EM
9565 >logon script = scripts\%U.bat
</B
9570 NAME=
"LPPAUSECOMMAND"
9572 >lppause command (S)
</DT
9575 >This parameter specifies the command to be
9576 executed on the server host in order to stop printing or spooling
9577 a specific print job.
</P
9579 >This command should be a program or script which takes
9580 a printer name and job number to pause the print job. One way
9581 of implementing this is by using job priorities, where jobs
9582 having a too low priority won't be sent to the printer.
</P
9589 > is given then the printername
9590 is put in its place. A
<TT
9596 the job number (an integer). On HPUX (see
<TT
9608 to the lpq command, the job will show up with the correct status, i.e.
9609 if the job priority is lower than the set fence priority it will
9610 have the PAUSED status, whereas if the priority is equal or higher it
9611 will have the SPOOLED or PRINTING status.
</P
9613 >Note that it is good practice to include the absolute path
9614 in the lppause command as the PATH may not be available to the server.
</P
9627 >Default: Currently no default value is given to
9628 this string, unless the value of the
<TT
9637 >, in which case the default is :
</P
9641 >lp -i %p-%j -H hold
</B
9644 >or if the value of the
<TT
9653 >, then the default is:
</P
9657 >qstat -s -j%j -h
</B
9660 >Example for HPUX:
<B
9662 >lppause command = /usr/bin/lpalt
9670 >lpq cache time (G)
</DT
9673 >This controls how long lpq info will be cached
9674 for to prevent the
<B
9677 > command being called too
9678 often. A separate cache is kept for each variation of the
<B
9681 > command used by the system, so if you use different
9685 > commands for different users then they won't
9686 share cache information.
</P
9688 >The cache files are stored in
<TT
9692 where xxxx is a hash of the
<B
9695 > command in use.
</P
9697 >The default is
10 seconds, meaning that the cached results
9698 of a previous identical
<B
9701 > command will be used
9702 if the cached data is less than
10 seconds old. A large value may
9703 be advisable if your
<B
9706 > command is very slow.
</P
9708 >A value of
0 will disable caching completely.
</P
9723 >lpq cache time =
10</B
9728 >lpq cache time =
30</B
9735 >lpq command (S)
</DT
9738 >This parameter specifies the command to be
9739 executed on the server host in order to obtain
<B
9743 >-style printer status information.
</P
9745 >This command should be a program or script which
9746 takes a printer name as its only parameter and outputs printer
9747 status information.
</P
9749 >Currently eight styles of printer status information
9750 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
9751 This covers most UNIX systems. You control which type is expected
9759 >Some clients (notably Windows for Workgroups) may not
9760 correctly send the connection number for the printer they are
9761 requesting status information about. To get around this, the
9762 server reports on the first printer service connected to by the
9763 client. This only happens if the connection number sent is invalid.
</P
9770 > is given then the printername
9771 is put in its place. Otherwise it is placed at the end of the
9774 >Note that it is good practice to include the absolute path
9784 > may not be available to the server.
</P
9798 >depends on the setting of
<TT
9808 >lpq command = /usr/bin/lpq -P%p
</B
9813 NAME=
"LPRESUMECOMMAND"
9815 >lpresume command (S)
</DT
9818 >This parameter specifies the command to be
9819 executed on the server host in order to restart or continue
9820 printing or spooling a specific print job.
</P
9822 >This command should be a program or script which takes
9823 a printer name and job number to resume the print job. See
9825 HREF=
"#LPPAUSECOMMAND"
9840 > is given then the printername
9841 is put in its place. A
<TT
9847 the job number (an integer).
</P
9849 >Note that it is good practice to include the absolute path
9853 >lpresume command
</I
9855 > as the PATH may not
9856 be available to the server.
</P
9869 >Default: Currently no default value is given
9870 to this string, unless the value of the
<TT
9879 >, in which case the default is :
</P
9883 >lp -i %p-%j -H resume
</B
9886 >or if the value of the
<TT
9895 >, then the default is:
</P
9899 >qstat -s -j%j -r
</B
9902 >Example for HPUX:
<B
9904 >lpresume command = /usr/bin/lpalt
9912 >lprm command (S)
</DT
9915 >This parameter specifies the command to be
9916 executed on the server host in order to delete a print job.
</P
9918 >This command should be a program or script which takes
9919 a printer name and job number, and deletes the print job.
</P
9926 > is given then the printername
9927 is put in its place. A
<TT
9933 the job number (an integer).
</P
9935 >Note that it is good practice to include the absolute
9941 > as the PATH may not be
9942 available to the server.
</P
9956 >depends on the setting of
<TT
9967 >lprm command = /usr/bin/lprm -P%p %j
9973 >lprm command = /usr/bin/cancel %p-%j
9979 NAME=
"MACHINEPASSWORDTIMEOUT"
9981 >machine password timeout (G)
</DT
9984 >If a Samba server is a member of an Windows
9985 NT Domain (see the
<A
9986 HREF=
"#SECURITYEQUALSDOMAIN"
9989 parameter) then periodically a running
<A
9993 > process will try and change the MACHINE ACCOUNT
9994 PASSWORD stored in the TDB called
<TT
9996 >private/secrets.tdb
9998 >. This parameter specifies how often this password
9999 will be changed, in seconds. The default is one week (expressed in
10000 seconds), the same as a Windows NT Domain member server.
</P
10003 HREF=
"smbpasswd.8.html"
10011 HREF=
"#SECURITYEQUALSDOMAIN"
10012 > security=domain
</A
10017 >machine password timeout =
604800</B
10024 >magic output (S)
</DT
10027 >This parameter specifies the name of a file
10028 which will contain output created by a magic script (see the
10030 HREF=
"#MAGICSCRIPT"
10038 parameter below).
</P
10040 >Warning: If two clients use the same
<TT
10046 > in the same directory the output file content
10051 >magic output =
<magic script name
>.out
10057 >magic output = myfile.txt
</B
10064 >magic script (S)
</DT
10067 >This parameter specifies the name of a file which,
10068 if opened, will be executed by the server when the file is closed.
10069 This allows a UNIX script to be sent to the Samba host and
10070 executed on behalf of the connected user.
</P
10072 >Scripts executed in this way will be deleted upon
10073 completion assuming that the user has the appripriate level
10074 of priviledge and the ile permissions allow the deletion.
</P
10076 >If the script generates output, output will be sent to
10077 the file specified by the
<A
10078 HREF=
"#MAGICOUTPUT"
10085 > parameter (see above).
</P
10087 >Note that some shells are unable to interpret scripts
10088 containing CR/LF instead of CR as
10089 the end-of-line marker. Magic scripts must be executable
10092 > on the host, which for some hosts and
10093 some shells will require filtering at the DOS end.
</P
10095 >Magic scripts are
<EM
10100 > be relied upon.
</P
10103 >None. Magic scripts disabled.
</EM
10108 >magic script = user.csh
</B
10115 >mangle case (S)
</DT
10118 >See the section on
<A
10125 >mangle case = no
</B
10132 >mangled map (S)
</DT
10135 >This is for those who want to directly map UNIX
10136 file names which can not be represented on Windows/DOS. The mangling
10137 of names is not always what is needed. In particular you may have
10138 documents with file extensions that differ between DOS and UNIX.
10139 For example, under UNIX it is common to use
<TT
10143 for HTML files, whereas under Windows/DOS
<TT
10147 is more commonly used.
</P
10160 >mangled map = (*.html *.htm)
</B
10163 >One very useful case is to remove the annoying
<TT
10167 > off the ends of filenames on some CDROMS (only visible
10168 under some UNIXes). To do this use a map of (*;
1 *;).
</P
10171 >no mangled map
</EM
10176 >mangled map = (*;
1 *;)
</B
10181 NAME=
"MANGLEDNAMES"
10183 >mangled names (S)
</DT
10186 >This controls whether non-DOS names under UNIX
10187 should be mapped to DOS-compatible names (
"mangled") and made visible,
10188 or whether non-DOS names should simply be ignored.
</P
10190 >See the section on
<A
10193 > for details on how to control the mangling process.
</P
10195 >If mangling is used then the mangling algorithm is as follows:
</P
10201 >The first (up to) five alphanumeric characters
10202 before the rightmost dot of the filename are preserved, forced
10203 to upper case, and appear as the first (up to) five characters
10204 of the mangled name.
</P
10208 >A tilde
"~" is appended to the first part of the mangled
10209 name, followed by a two-character unique sequence, based on the
10210 original root name (i.e., the original filename minus its final
10211 extension). The final extension is included in the hash calculation
10212 only if it contains any upper case characters or is longer than three
10215 >Note that the character to use may be specified using
10217 HREF=
"#MANGLINGCHAR"
10225 > option, if you don't like '~'.
</P
10229 >The first three alphanumeric characters of the final
10230 extension are preserved, forced to upper case and appear as the
10231 extension of the mangled name. The final extension is defined as that
10232 part of the original filename after the rightmost dot. If there are no
10233 dots in the filename, the mangled name will have no extension (except
10234 in the case of
"hidden files" - see below).
</P
10238 >Files whose UNIX name begins with a dot will be
10239 presented as DOS hidden files. The mangled name will be created as
10240 for other filenames, but with the leading dot removed and
"___" as
10241 its extension regardless of actual original extension (that's three
10246 >The two-digit hash value consists of upper case
10247 alphanumeric characters.
</P
10249 >This algorithm can cause name collisions only if files
10250 in a directory share the same first five alphanumeric characters.
10251 The probability of such a clash is
1/
1300.
</P
10253 >The name mangling (if enabled) allows a file to be
10254 copied between UNIX directories from Windows/DOS while retaining
10255 the long UNIX filename. UNIX files can be renamed to a new extension
10256 from Windows/DOS and will retain the same basename. Mangled names
10257 do not change between sessions.
</P
10261 >mangled names = yes
</B
10266 NAME=
"MANGLEDSTACK"
10268 >mangled stack (G)
</DT
10271 >This parameter controls the number of mangled names
10272 that should be cached in the Samba server
<A
10278 >This stack is a list of recently mangled base names
10279 (extensions are only maintained if they are longer than
3 characters
10280 or contains upper case characters).
</P
10282 >The larger this value, the more likely it is that mangled
10283 names can be successfully converted to correct long UNIX names.
10284 However, large stack sizes will slow most directory access. Smaller
10285 stacks save memory in the server (each stack element costs
256 bytes).
10288 >It is not possible to absolutely guarantee correct long
10289 file names, so be prepared for some surprises!
</P
10293 >mangled stack =
50</B
10298 >mangled stack =
100</B
10303 NAME=
"MANGLINGCHAR"
10305 >mangling char (S)
</DT
10308 >This controls what character is used as
10314 >. The default is a '~'
10315 but this may interfere with some software. Use this option to set
10316 it to whatever you prefer.
</P
10320 >mangling char = ~
</B
10325 >mangling char = ^
</B
10332 >map archive (S)
</DT
10335 >This controls whether the DOS archive attribute
10336 should be mapped to the UNIX owner execute bit. The DOS archive bit
10337 is set when a file has been modified since its last backup. One
10338 motivation for this option it to keep Samba/your PC from making
10339 any file it touches from becoming executable under UNIX. This can
10340 be quite annoying for shared source code, documents, etc...
</P
10342 >Note that this requires the
<TT
10348 parameter to be set such that owner execute bit is not masked out
10349 (i.e. it must include
100). See the parameter
<A
10361 >map archive = yes
</B
10368 >map hidden (S)
</DT
10371 >This controls whether DOS style hidden files
10372 should be mapped to the UNIX world execute bit.
</P
10374 >Note that this requires the
<TT
10380 to be set such that the world execute bit is not masked out (i.e.
10381 it must include
001). See the parameter
<A
10393 >map hidden = no
</B
10400 >map system (S)
</DT
10403 >This controls whether DOS style system files
10404 should be mapped to the UNIX group execute bit.
</P
10406 >Note that this requires the
<TT
10412 to be set such that the group execute bit is not masked out (i.e.
10413 it must include
010). See the parameter
<A
10425 >map system = no
</B
10432 >map to guest (G)
</DT
10435 >This parameter is only useful in
<A
10438 > modes other than
<TT
10456 >This parameter can take three different values, which tell
10461 > what to do with user
10462 login requests that don't match a valid UNIX user in some way.
</P
10464 >The three settings are :
</P
10473 > - Means user login
10474 requests with an invalid password are rejected. This is the
10483 logins with an invalid password are rejected, unless the username
10484 does not exist, in which case it is treated as a guest login and
10486 HREF=
"#GUESTACCOUNT"
10500 > - Means user logins
10501 with an invalid password are treated as a guest login and mapped
10503 HREF=
"#GUESTACCOUNT"
10506 this can cause problems as it means that any user incorrectly typing
10507 their password will be silently logged on as
"guest" - and
10508 will not know the reason they cannot access files they think
10509 they should - there will have been no message given to them
10510 that they got their password wrong. Helpdesk services will
10513 > you if you set the
<TT
10519 > parameter this way :-).
</P
10523 >Note that this parameter is needed to set up
"Guest"
10524 share services when using
<TT
10530 share. This is because in these modes the name of the resource being
10533 > sent to the server until after
10534 the server has successfully authenticated the client so the server
10535 cannot make authentication decisions at the correct time (connection
10536 to the share) for
"Guest" shares.
</P
10538 >For people familiar with the older Samba releases, this
10539 parameter maps to the old compile-time setting of the
<TT
10541 > GUEST_SESSSETUP
</TT
10542 > value in local.h.
</P
10546 >map to guest = Never
</B
10551 >map to guest = Bad User
</B
10556 NAME=
"MAXCONNECTIONS"
10558 >max connections (S)
</DT
10561 >This option allows the number of simultaneous
10562 connections to a service to be limited. If
<TT
10568 > is greater than
0 then connections will be refused if
10569 this number of connections to the service are already open. A value
10570 of zero mean an unlimited number of connections may be made.
</P
10572 >Record lock files are used to implement this feature. The
10573 lock files will be stored in the directory specified by the
<A
10574 HREF=
"#LOCKDIRECTORY"
10586 >max connections =
0</B
10591 >max connections =
10</B
10598 >max disk size (G)
</DT
10601 >This option allows you to put an upper limit
10602 on the apparent size of disks. If you set this option to
100
10603 then all shares will appear to be not larger than
100 MB in
10606 >Note that this option does not limit the amount of
10607 data you can put on the disk. In the above case you could still
10608 store much more than
100 MB on the disk, but if a client ever asks
10609 for the amount of free disk space or the total disk size then the
10610 result will be bounded by the amount specified in
<TT
10618 >This option is primarily useful to work around bugs
10619 in some pieces of software that can't handle very large disks,
10620 particularly disks over
1GB in size.
</P
10627 > of
0 means no limit.
</P
10631 >max disk size =
0</B
10636 >max disk size =
1000</B
10643 >max log size (G)
</DT
10646 >This option (an integer in kilobytes) specifies
10647 the max size the log file should grow to. Samba periodically checks
10648 the size and if it is exceeded it will rename the file, adding
10654 >A size of
0 means no limit.
</P
10658 >max log size =
5000</B
10663 >max log size =
1000</B
10673 >This option controls the maximum number of
10674 outstanding simultaneous SMB operations that samba tells the client
10675 it will allow. You should never need to set this parameter.
</P
10684 NAME=
"MAXOPENFILES"
10686 >max open files (G)
</DT
10689 >This parameter limits the maximum number of
10690 open files that one
<A
10695 serving process may have open for a client at any one time. The
10696 default for this parameter is set very high (
10,
000) as Samba uses
10697 only one bit per unopened file.
</P
10699 >The limit of the number of open files is usually set
10700 by the UNIX per-process file descriptor limit rather than
10701 this parameter so you should never need to touch this parameter.
</P
10705 >max open files =
10000</B
10710 NAME=
"MAXPRINTJOBS"
10712 >max print jobs (S)
</DT
10715 >This parameter limits the maximum number of
10716 jobs allowable in a Samba printer queue at any given moment.
10717 If this number is exceeded,
<A
10724 > will remote
"Out of Space" to the client.
10726 HREF=
"#TOTALPRINTJOBS"
10739 >max print jobs =
1000</B
10744 >max print jobs =
5000</B
10751 >max protocol (G)
</DT
10754 >The value of the parameter (a string) is the highest
10755 protocol level that will be supported by the server.
</P
10757 >Possible values are :
</P
10766 >: Earliest version. No
10767 concept of user names.
</P
10774 >: Slight improvements on
10775 CORE for efficiency.
</P
10784 > version of the protocol. Long filename
10792 >: Updates to Lanman1 protocol.
10800 >: Current up to date version of
10801 the protocol. Used by Windows NT. Known as CIFS.
</P
10805 >Normally this option should not be set as the automatic
10806 negotiation phase in the SMB protocol takes care of choosing
10807 the appropriate protocol.
</P
10810 HREF=
"#MINPROTOCOL"
10822 >max protocol = NT1
</B
10827 >max protocol = LANMAN1
</B
10832 NAME=
"MAXSMBDPROCESSES"
10834 >max smbd processes (G)
</DT
10837 >This parameter limits the maximum number of
10846 processes concurrently running on a system and is intended
10847 as a stop gap to prevent degrading service to clients in the event
10848 that the server has insufficient resources to handle more than this
10849 number of connections. Remember that under normal operating
10850 conditions, each user will have an smbd associated with him or her
10851 to handle connections to all shares from a given host.
10856 >max smbd processes =
0</B
10861 >max smbd processes =
1000</B
10871 >This option tells
<A
10876 what the default 'time to live' of NetBIOS names should be (in seconds)
10880 > is requesting a name using either a
10881 broadcast packet or from a WINS server. You should never need to
10882 change this parameter. The default is
3 days.
</P
10886 >max ttl =
259200</B
10893 >max wins ttl (G)
</DT
10896 >This option tells
<A
10901 > when acting as a WINS server (
<A
10902 HREF=
"#WINSSUPPORT"
10906 >wins support=yes
</I
10909 >) what the maximum
10910 'time to live' of NetBIOS names that
<B
10914 will grant will be (in seconds). You should never need to change this
10915 parameter. The default is
6 days (
518400 seconds).
</P
10930 >max wins ttl = 518400</B
10940 >This option controls the maximum packet size
10941 that will be negotiated by Samba. The default is 65535, which
10942 is the maximum. In some cases you may find you get better performance
10943 with a smaller value. A value below 2048 is likely to cause problems.
10948 >max xmit = 65535</B
10953 >max xmit = 8192</B
10958 NAME="MESSAGECOMMAND
"
10960 >message command (G)</DT
10963 >This specifies what command to run when the
10964 server receives a WinPopup style message.</P
10966 >This would normally be a command that would
10967 deliver the message somehow. How this is to be done is
10968 up to your imagination.</P
10974 >message command = csh -c 'xedit %s;rm %s' &</B
10978 >This delivers the message using <B
10982 removes it afterwards. <EM
10983 >NOTE THAT IT IS VERY IMPORTANT
10984 THAT THIS COMMAND RETURN IMMEDIATELY</EM
10986 have the '&' on the end. If it doesn't return immediately then
10987 your PCs may freeze when sending messages (they should recover
10988 after 30secs, hopefully).</P
10990 >All messages are delivered as the global guest user.
10991 The command takes the standard substitutions, although <TT
11004 >Apart from the standard substitutions, some additional
11005 ones apply. In particular:</P
11016 > = the filename containing
11026 > = the destination that
11027 the message was sent to (probably the server name).</P
11036 > = who the message
11041 >You could make this command send mail, or whatever else
11042 takes your fancy. Please let us know of any really interesting
11045 >Here's a way of sending the messages as mail to root:</P
11049 >message command = /bin/mail -s 'message from %f on
11050 %m' root < %s; rm %s</B
11053 >If you don't have a message command then the message
11054 won't be delivered and Samba will tell the sender there was
11055 an error. Unfortunately WfWg totally ignores the error code
11056 and carries on regardless, saying that the message was delivered.
11059 >If you want to silently delete it then try:</P
11063 >message command = rm %s</B
11067 >no message command</EM
11072 >message command = csh -c 'xedit %s;
11078 NAME="MINPASSWDLENGTH
"
11080 >min passwd length (G)</DT
11084 HREF="#MINPASSWORDLENGTH
"
11088 >min password length</I
11095 NAME="MINPASSWORDLENGTH
"
11097 >min password length (G)</DT
11100 >This option sets the minimum length in characters
11101 of a plaintext password that <B
11104 > will accept when performing
11105 UNIX password changing.</P
11108 HREF="#UNIXPASSWORDSYNC
"
11117 HREF="#PASSWDPROGRAM
"
11125 HREF="#PASSWDCHATDEBUG
"
11129 >passwd chat debug</I
11137 >min password length = 5</B
11142 NAME="MINPRINTSPACE
"
11144 >min print space (S)</DT
11147 >This sets the minimum amount of free disk
11148 space that must be available before a user will be able to spool
11149 a print job. It is specified in kilobytes. The default is 0, which
11150 means a user can always spool a print job.</P
11165 >min print space = 0</B
11170 >min print space = 2000</B
11177 >min protocol (G)</DT
11180 >The value of the parameter (a string) is the
11181 lowest SMB protocol dialect than Samba will support. Please refer
11183 HREF="#MAXPROTOCOL
"
11191 parameter for a list of valid protocol names and a brief description
11192 of each. You may also wish to refer to the C source code in
11195 >source/smbd/negprot.c</TT
11196 > for a listing of known protocol
11197 dialects supported by clients.</P
11199 >If you are viewing this parameter as a security measure, you should
11200 also refer to the <A
11209 > parameter. Otherwise, you should never need
11210 to change this parameter.</P
11214 >min protocol = CORE</B
11219 >min protocol = NT1</B
11227 >min wins ttl (G)</DT
11230 >This option tells <A
11235 when acting as a WINS server (<A
11236 HREF="#WINSSUPPORT
"
11240 > wins support = yes</I
11243 >) what the minimum 'time to live'
11244 of NetBIOS names that <B
11247 > will grant will be (in
11248 seconds). You should never need to change this parameter. The default
11249 is 6 hours (21600 seconds).</P
11253 >min wins ttl = 21600</B
11260 >msdfs root (S)</DT
11263 >This boolean parameter is only available if
11264 Samba is configured and compiled with the <B
11267 > option. If set to <TT
11271 Samba treats the share as a Dfs root and allows clients to browse
11272 the distributed file system tree rooted at the share directory.
11273 Dfs links are specified in the share directory by symbolic
11274 links of the form <TT
11276 >msdfs:serverA\shareA,serverB\shareB
11278 > and so on. For more information on setting up a Dfs tree
11279 on Samba, refer to <A
11280 HREF="msdfs_setup.html
"
11299 >msdfs root = no</B
11304 NAME="NAMERESOLVEORDER
"
11306 >name resolve order (G)</DT
11309 >This option is used by the programs in the Samba
11310 suite to determine what naming services to use and in what order
11311 to resolve host names to IP addresses. The option takes a space
11312 separated string of name resolution options.</P
11314 >The options are :"lmhosts
", "host
", "wins
" and "bcast
". They
11315 cause names to be resolved as follows :</P
11325 address in the Samba lmhosts file. If the line in lmhosts has
11326 no name type attached to the NetBIOS name (see the <A
11327 HREF="lmhosts
.5.html
"
11330 > for details) then
11331 any name type matches for lookup.</P
11338 > : Do a standard host
11339 name to IP address resolution, using the system <TT
11343 >, NIS, or DNS lookups. This method of name resolution
11344 is operating system depended for instance on IRIX or Solaris this
11345 may be controlled by the <TT
11347 >/etc/nsswitch.conf</TT
11349 file). Note that this method is only used if the NetBIOS name
11350 type being queried is the 0x20 (server) name type, otherwise
11358 > : Query a name with
11359 the IP address listed in the <A
11367 > parameter. If no WINS server has
11368 been specified this method will be ignored.</P
11375 > : Do a broadcast on
11376 each of the known local interfaces listed in the <A
11385 parameter. This is the least reliable of the name resolution
11386 methods as it depends on the target host being on a locally
11387 connected subnet.</P
11393 >name resolve order = lmhosts host wins bcast
11399 >name resolve order = lmhosts bcast host
11403 >This will cause the local lmhosts file to be examined
11404 first, followed by a broadcast attempt, followed by a normal
11405 system hostname lookup.</P
11409 NAME="NETBIOSALIASES
"
11411 >netbios aliases (G)</DT
11414 >This is a list of NetBIOS names that <A
11418 > will advertise as additional
11419 names by which the Samba server is known. This allows one machine
11420 to appear in browse lists under multiple names. If a machine is
11421 acting as a browse server or logon server none
11422 of these names will be advertised as either browse server or logon
11423 servers, only the primary name of the machine will be advertised
11424 with these capabilities.</P
11427 HREF="#NETBIOSNAME
"
11438 >empty string (no additional names)</EM
11443 >netbios aliases = TEST TEST1 TEST2</B
11450 >netbios name (G)</DT
11453 >This sets the NetBIOS name by which a Samba
11454 server is known. By default it is the same as the first component
11455 of the host's DNS name. If a machine is a browse server or
11456 logon server this name (or the first component
11457 of the hosts DNS name) will be the name that these services are
11458 advertised under.</P
11461 HREF="#NETBIOSALIASES
"
11472 >machine DNS name</EM
11477 >netbios name = MYNAME</B
11482 NAME="NETBIOSSCOPE
"
11484 >netbios scope (G)</DT
11487 >This sets the NetBIOS scope that Samba will
11488 operate under. This should not be set unless every machine
11489 on your LAN also sets this value.</P
11495 >nis homedir (G)</DT
11498 >Get the home share server from a NIS map. For
11499 UNIX systems that use an automounter, the user's home directory
11500 will often be mounted on a workstation on demand from a remote
11503 >When the Samba logon server is not the actual home directory
11504 server, but is mounting the home directories via NFS then two
11505 network hops would be required to access the users home directory
11506 if the logon server told the client to use itself as the SMB server
11507 for home directories (one over SMB and one over NFS). This can
11510 >This option allows Samba to return the home share as
11511 being on a different server to the logon server and as
11512 long as a Samba daemon is running on the home directory server,
11513 it will be mounted on the Samba client directly from the directory
11514 server. When Samba is returning the home share to the client, it
11515 will consult the NIS map specified in <A
11523 > and return the server
11526 >Note that for this option to work there must be a working
11527 NIS system and the Samba server with this option must also
11528 be a logon server.</P
11532 >nis homedir = no</B
11537 NAME="NTACLSUPPORT
"
11539 >nt acl support (G)</DT
11542 >This boolean parameter controls whether
11547 > will attempt to map
11548 UNIX permissions into Windows NT access control lists.</P
11552 >nt acl support = yes</B
11557 NAME="NTPIPESUPPORT
"
11559 >nt pipe support (G)</DT
11562 >This boolean parameter controls whether
11567 > will allow Windows NT
11568 clients to connect to the NT SMB specific <TT
11572 pipes. This is a developer debugging option and can be left
11577 >nt pipe support = yes</B
11582 NAME="NTSMBSUPPORT
"
11584 >nt smb support (G)</DT
11587 >This boolean parameter controls whether <A
11591 > will negotiate NT specific SMB
11592 support with Windows NT clients. Although this is a developer
11593 debugging option and should be left alone, benchmarking has discovered
11594 that Windows NT clients give faster performance with this option
11598 >. This is still being investigated.
11599 If this option is set to <TT
11602 > then Samba offers
11603 exactly the same SMB calls that versions prior to Samba 2.0 offered.
11604 This information may be of use if any users are having problems
11605 with NT SMB support.</P
11607 >You should not need to ever disable this parameter.</P
11611 >nt smb support = yes</B
11616 NAME="NULLPASSWORDS
"
11618 >null passwords (G)</DT
11621 >Allow or disallow client access to accounts
11622 that have null passwords. </P
11625 HREF="smbpasswd
.5.html
"
11632 >null passwords = no</B
11642 >This is a boolean option that controls whether
11643 connections with usernames not in the <TT
11649 list will be allowed. By default this option is disabled so that a
11650 client can supply a username to be used by the server. Enabling
11651 this parameter will force the server to only user the login
11657 > list and is only really
11659 HREF="#SECURITYEQUALSSHARE
"
11664 >Note that this also means Samba won't try to deduce
11665 usernames from the service name. This can be annoying for
11666 the [homes] section. To get around this you could use <B
11670 > which means your <TT
11676 will be just the service name, which for home directories is the
11677 name of the user.</P
11697 NAME="OLELOCKINGCOMPATIBILITY
"
11699 >ole locking compatibility (G)</DT
11702 >This parameter allows an administrator to turn
11703 off the byte range lock manipulation that is done within Samba to
11704 give compatibility for OLE applications. Windows OLE applications
11705 use byte range locking as a form of inter-process communication, by
11706 locking ranges of bytes around the 2^32 region of a file range. This
11707 can cause certain UNIX lock managers to crash or otherwise cause
11708 problems. Setting this parameter to <TT
11712 trust your UNIX lock manager to handle such cases correctly.</P
11716 >ole locking compatibility = yes</B
11723 >only guest (S)</DT
11738 NAME="OPLOCKBREAKWAITTIME
"
11740 >oplock break wait time (G)</DT
11743 >This is a tuning parameter added due to bugs in
11744 both Windows 9x and WinNT. If Samba responds to a client too
11745 quickly when that client issues an SMB that can cause an oplock
11746 break request, then the network client can fail and not respond
11747 to the break request. This tuning parameter (which is set in milliseconds)
11748 is the amount of time Samba will wait before sending an oplock break
11749 request to such (broken) clients.</P
11752 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
11753 AND UNDERSTOOD THE SAMBA OPLOCK CODE</EM
11758 >oplock break wait time = 0</B
11763 NAME="OPLOCKCONTENTIONLIMIT
"
11765 >oplock contention limit (S)</DT
11776 improve the efficiency of the granting of oplocks under multiple
11777 client contention for the same file.</P
11779 >In brief it specifies a number, which causes smbd not to
11780 grant an oplock even when requested if the approximate number of
11781 clients contending for an oplock on the same file goes over this
11782 limit. This causes <B
11785 > to behave in a similar
11786 way to Windows NT.</P
11789 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
11790 AND UNDERSTOOD THE SAMBA OPLOCK CODE</EM
11795 >oplock contention limit = 2</B
11805 >This boolean option tells smbd whether to
11806 issue oplocks (opportunistic locks) to file open requests on this
11807 share. The oplock code can dramatically (approx. 30% or more) improve
11808 the speed of access to files on Samba servers. It allows the clients
11809 to aggressively cache files locally and you may want to disable this
11810 option for unreliable network environments (it is turned on by
11811 default in Windows NT Servers). For more information see the file
11821 >Oplocks may be selectively turned off on certain files with a
11823 HREF="#VETOOPLOCKFILES
"
11827 > veto oplock files</I
11830 > parameter. On some systems
11831 oplocks are recognized by the underlying operating system. This
11832 allows data synchronization between all access to oplocked files,
11833 whether it be via Samba or NFS or a local UNIX process. See the
11839 > parameter for details.</P
11842 HREF="#KERNELOPLOCKS
"
11851 HREF="#LEVEL2OPLOCKS
"
11855 > level2 oplocks</I
11872 >This integer value controls what level Samba
11873 advertises itself as for browse elections. The value of this
11874 parameter determines whether <A
11879 has a chance of becoming a local master browser for the <TT
11884 > in the local broadcast area.</P
11888 >By default, Samba will win
11889 a local master browsing election over all Microsoft operating
11890 systems except a Windows NT 4.0/2000 Domain Controller. This
11891 means that a misconfigured Samba host can effectively isolate
11892 a subnet for browsing purposes. See <TT
11914 NAME="OS2DRIVERMAP
"
11916 >os2 driver map (G)</DT
11919 >The parameter is used to define the absolute
11920 path to a file containing a mapping of Windows NT printer driver
11921 names to OS/2 printer driver names. The format is:</P
11923 ><nt driver name> = <os2 driver
11924 name>.<device name></P
11926 >For example, a valid entry using the HP LaserJet 5
11927 printer driver woudl appear as <B
11929 >HP LaserJet 5L = LASERJET.HP
11933 >The need for the file is due to the printer driver namespace
11934 problem described in the <A
11935 HREF="printer_driver2.html
"
11939 >. For more details on OS/2 clients, please
11941 HREF="OS2-Client-HOWTO.html
"
11945 > containing in the Samba documentation.</P
11949 >os2 driver map = <empty string>
11957 >panic action (G)</DT
11960 >This is a Samba developer option that allows a
11961 system command to be called when either <A
11970 crashes. This is usually used to draw attention to the fact that
11971 a problem occurred.</P
11975 >panic action = <empty string></B
11980 >panic action = "/bin/sleep
90000"</B
11987 >passwd chat (G)</DT
11990 >This string controls the <EM
11993 conversation that takes places between <A
11997 > and the local password changing
11998 program to change the users password. The string describes a
11999 sequence of response-receive pairs that <A
12003 > uses to determine what to send to the
12005 HREF="#PASSWDPROGRAM
"
12013 > and what to expect back. If the expected output is not
12014 received then the password is not changed.</P
12016 >This chat sequence is often quite site specific, depending
12017 on what local methods are used for password control (such as NIS
12020 >The string can contain the macros <TT
12031 > which are substituted for the old
12032 and new passwords respectively. It can also contain the standard
12045 > to give line-feed,
12046 carriage-return, tab and space.</P
12048 >The string can also contain a '*' which matches
12049 any sequence of characters.</P
12051 >Double quotes can be used to collect strings with spaces
12052 in them into a single string.</P
12054 >If the send string in any part of the chat sequence
12055 is a fullstop ".
", then no string is sent. Similarly,
12056 if the expect string is a fullstop then no string is expected.</P
12058 >Note that if the <A
12059 HREF="#UNIXPASSWORDSYNC
"
12067 > parameter is set to true, then this
12068 sequence is called <EM
12070 > when the SMB password
12071 in the smbpasswd file is being changed, without access to the old
12072 password cleartext. In this case the old password cleartext is set
12073 to "" (the empty string).</P
12076 HREF="#UNIXPASSWORDSYNC
"
12085 HREF="#PASSWDPROGRAM
"
12089 > passwd program</I
12093 HREF="#PASSWDCHATDEBUG
"
12097 >passwd chat debug</I
12104 >passwd chat = *new*password* %n\n
12105 *new*password* %n\n *changed*</B
12110 >passwd chat = "*Enter OLD password*
" %o\n
12111 "*Enter NEW password*
" %n\n "*Reenter NEW password*
" %n\n "*Password
12117 NAME="PASSWDCHATDEBUG
"
12119 >passwd chat debug (G)</DT
12122 >This boolean specifies if the passwd chat script
12123 parameter is run in <EM
12125 > mode. In this mode the
12126 strings passed to and received from the passwd chat are printed
12141 of 100. This is a dangerous option as it will allow plaintext passwords
12142 to be seen in the <B
12145 > log. It is available to help
12146 Samba admins debug their <TT
12152 when calling the <TT
12158 be turned off after this has been done. This parameter is off by
12171 HREF="#PASSWDPROGRAM
"
12183 >passwd chat debug = no</B
12188 NAME="PASSWDPROGRAM
"
12190 >passwd program (G)</DT
12193 >The name of a program that can be used to set
12194 UNIX user passwords. Any occurrences of <TT
12200 will be replaced with the user name. The user name is checked for
12201 existence before calling the password changing program.</P
12203 >Also note that many passwd programs insist in <EM
12206 > passwords, such as a minimum length, or the inclusion
12207 of mixed case chars and digits. This can pose a problem as some clients
12208 (such as Windows for Workgroups) uppercase the password before sending
12219 > parameter is set to <TT
12223 > then this program is called <EM
12226 before the SMB password in the <A
12227 HREF="smbpasswd
.5.html
"
12231 > file is changed. If this UNIX password change fails, then
12235 > will fail to change the SMB password also
12236 (this is by design).</P
12241 >unix password sync</I
12244 is set this parameter <EM
12245 >MUST USE ABSOLUTE PATHS</EM
12249 > programs called, and must be examined
12250 for security implications. Note that by default <TT
12262 HREF="#UNIXPASSWORDSYNC
"
12274 >passwd program = /bin/passwd</B
12279 >passwd program = /sbin/npasswd %u</B
12285 NAME="PASSWORDLEVEL
"
12287 >password level (G)</DT
12290 >Some client/server combinations have difficulty
12291 with mixed-case passwords. One offending client is Windows for
12292 Workgroups, which for some reason forces passwords to upper
12293 case when using the LANMAN1 protocol, but leaves them alone when
12294 using COREPLUS! Another problem child is the Windows 95/98
12295 family of operating systems. These clients upper case clear
12296 text passwords even when NT LM 0.12 selected by the protocol
12297 negotiation request/response.</P
12299 >This parameter defines the maximum number of characters
12300 that may be upper case in passwords.</P
12302 >For example, say the password given was "FRED
". If <TT
12305 > password level</I
12307 > is set to 1, the following combinations
12308 would be tried if "FRED
" failed:</P
12310 >"Fred
", "fred
", "fRed
", "frEd
","freD
"</P
12318 the following combinations would also be tried: </P
12320 >"FRed
", "FrEd
", "FreD
", "fREd
", "fReD
", "frED
", ..</P
12324 >The higher value this parameter is set to the more likely
12325 it is that a mixed case password will be matched against a single
12326 case password. However, you should be aware that use of this
12327 parameter reduces security and increases the time taken to
12328 process a new connection.</P
12330 >A value of zero will cause only two attempts to be
12331 made - the password as is and the password in all-lower case.</P
12335 >password level = 0</B
12340 >password level = 4</B
12345 NAME="PASSWORDSERVER
"
12347 >password server (G)</DT
12350 >By specifying the name of another SMB server (such
12351 as a WinNT box) with this option, and using <B
12357 >security = server</B
12358 > you can get Samba
12359 to do all its username/password validation via a remote server.</P
12361 >This option sets the name of the password server to use.
12362 It must be a NetBIOS name, so if the machine's NetBIOS name is
12363 different from its Internet name then you may have to add its NetBIOS
12364 name to the lmhosts file which is stored in the same directory
12370 >The name of the password server is looked up using the
12372 HREF="#NAMERESOLVEORDER
"
12380 > and so may resolved
12381 by any method and order described in that parameter.</P
12383 >The password server much be a machine capable of using
12384 the "LM1.2X002
" or the "NT LM
0.12" protocol, and it must be in
12385 user level security mode.</P
12389 > Using a password server
12390 means your UNIX box (running Samba) is only as secure as your
12391 password server. <EM
12392 >DO NOT CHOOSE A PASSWORD SERVER THAT
12393 YOU DON'T COMPLETELY TRUST</EM
12396 >Never point a Samba server at itself for password
12397 serving. This will cause a loop and could lock up your Samba
12400 >The name of the password server takes the standard
12401 substitutions, but probably the only useful one is <TT
12407 >, which means the Samba server will use the incoming
12408 client as the password server. If you use this then you better
12409 trust your clients, and you had better restrict them with hosts allow!</P
12416 > parameter is set to
12420 >, then the list of machines in this
12421 option must be a list of Primary or Backup Domain controllers for the
12422 Domain or the character '*', as the Samba server is effectively
12423 in that domain, and will use cryptographically authenticated RPC calls
12424 to authenticate the user logging on. The advantage of using <B
12426 > security = domain</B
12427 > is that if you list several hosts in the
12431 >password server</I
12437 > will try each in turn till it finds one that responds. This
12438 is useful in case your primary server goes down.</P
12443 >password server</I
12446 to the character '*', then Samba will attempt to auto-locate the
12447 Primary or Backup Domain controllers to authenticate against by
12448 doing a query for the name <TT
12450 >WORKGROUP<1C></TT
12452 and then contacting each server returned in the list of IP
12453 addresses from the name resolution source. </P
12464 >, then there are different
12465 restrictions that <B
12467 >security = domain</B
12475 >You may list several password servers in
12479 >password server</I
12481 > parameter, however if an
12485 > makes a connection to a password server,
12486 and then the password server fails, no more users will be able
12487 to be authenticated from this <B
12491 restriction of the SMB/CIFS protocol when in <B
12495 > mode and cannot be fixed in Samba.</P
12499 >If you are using a Windows NT server as your
12500 password server then you will have to ensure that your users
12501 are able to login from the Samba server, as when in <B
12503 > security=server</B
12504 > mode the network logon will appear to
12505 come from there rather than from the users workstation.</P
12522 >password server = <empty string></B
12528 >password server = NT-PDC, NT-BDC1, NT-BDC2
12534 >password server = *</B
12544 >This parameter specifies a directory to which
12545 the user of the service is to be given access. In the case of
12546 printable services, this is where print data will spool prior to
12547 being submitted to the host for printing.</P
12549 >For a printable service offering guest access, the service
12550 should be readonly and the path should be world-writeable and
12551 have the sticky bit set. This is not mandatory of course, but
12552 you probably won't get the results you expect if you do
12555 >Any occurrences of <TT
12561 will be replaced with the UNIX username that the client is using
12562 on this connection. Any occurrences of <TT
12568 will be replaced by the NetBIOS name of the machine they are
12569 connecting from. These replacements are very useful for setting
12570 up pseudo home directories for users.</P
12572 >Note that this path will be based on <A
12580 > if one was specified.</P
12588 >path = /home/fred</B
12593 NAME="POSIXLOCKING
"
12595 >posix locking (S)</DT
12606 daemon maintains an database of file locks obtained by SMB clients.
12607 The default behavior is to map this internal database to POSIX
12608 locks. This means that file locks obtained by SMB clients are
12609 consistent with those seen by POSIX compliant applications accessing
12610 the files via a non-SMB method (e.g. NFS or local file access).
12611 You should never need to disable this parameter.</P
12615 >posix locking = yes</B
12625 >This option specifies a command to be run
12626 whenever the service is disconnected. It takes the usual
12627 substitutions. The command may be run as the root on some
12630 >An interesting example may be do unmount server
12635 >postexec = /etc/umount /cdrom</B
12650 >none (no command executed)</EM
12656 >postexec = echo \"%u disconnected from %S
12657 from %m (%I)\
" >> /tmp/log</B
12664 >postscript (S)</DT
12667 >This parameter forces a printer to interpret
12668 the print files as postscript. This is done by adding a <TT
12672 > to the start of print output.</P
12674 >This is most useful when you have lots of PCs that persist
12675 in putting a control-D at the start of print jobs, which then
12676 confuses your printer.</P
12680 >postscript = no</B
12690 >This option specifies a command to be run whenever
12691 the service is connected to. It takes the usual substitutions.</P
12693 >An interesting example is to send the users a welcome
12694 message every time they log in. Maybe a message of the day? Here
12699 >preexec = csh -c 'echo \"Welcome to %S!\
" |
12700 /usr/local/samba/bin/smbclient -M %m -I %I' & </B
12703 >Of course, this could get annoying after a while :-)</P
12706 HREF="#PREEXECCLOSE
"
12726 >none (no command executed)</EM
12731 >preexec = echo \"%u connected to %S from %m
12732 (%I)\
" >> /tmp/log</B
12737 NAME="PREEXECCLOSE
"
12739 >preexec close (S)</DT
12742 >This boolean option controls whether a non-zero
12743 return code from <A
12752 > should close the service being connected to.</P
12756 >preexec close = no</B
12761 NAME="PREFERREDMASTER
"
12763 >preferred master (G)</DT
12766 >This boolean parameter controls if <A
12770 > is a preferred master browser
12771 for its workgroup.</P
12773 >If this is set to true, on startup, <B
12777 will force an election, and it will have a slight advantage in
12778 winning the election. It is recommended that this parameter is
12779 used in conjunction with <B
12782 HREF="#DOMAINMASTER
"
12793 > can guarantee becoming a domain master.</P
12795 >Use this option with caution, because if there are several
12796 hosts (whether Samba servers, Windows 95 or NT) that are preferred
12797 master browsers on the same subnet, they will each periodically
12798 and continuously attempt to become the local master browser.
12799 This will result in unnecessary broadcast traffic and reduced browsing
12815 >preferred master = auto</B
12820 NAME="PREFEREDMASTER
"
12822 >prefered master (G)</DT
12826 HREF="#PREFERREDMASTER
"
12830 > preferred master</I
12833 > for people who cannot spell :-).</P
12842 >This is a list of services that you want to be
12843 automatically added to the browse lists. This is most useful
12844 for homes and printers services that would otherwise not be
12847 >Note that if you just want all printers in your
12848 printcap file loaded then the <A
12849 HREF="#LOADPRINTERS
"
12856 > option is easier.</P
12859 >no preloaded services</EM
12864 >preload = fred lp colorlp</B
12869 NAME="PRESERVECASE
"
12871 >preserve case (S)</DT
12874 > This controls if new filenames are created
12875 with the case that the client passes, or if they are forced to
12877 HREF="#DEFAULTCASE
"
12889 >preserve case = yes</B
12892 >See the section on <A
12896 > for a fuller discussion.</P
12900 NAME="PRINTCOMMAND
"
12902 >print command (S)</DT
12905 >After a print job has finished spooling to
12906 a service, this command will be used via a <B
12910 call to process the spool file. Typically the command specified will
12911 submit the spool file to the host's printing subsystem, but there
12912 is no requirement that this be the case. The server will not remove
12913 the spool file, so whatever command you specify should remove the
12914 spool file when it has been processed, otherwise you will need to
12915 manually remove old spool files.</P
12917 >The print command is simply a text string. It will be used
12918 verbatim, with two exceptions: All occurrences of <TT
12929 > will be replaced by the
12930 appropriate spool file name, and all occurrences of <TT
12936 > will be replaced by the appropriate printer name. The
12937 spool file name is generated automatically by the server, the printer
12938 name is discussed below.</P
12940 >The print command <EM
12943 one occurrence of <TT
12959 > is optional. At the time
12960 a job is submitted, if no printer name is supplied the <TT
12966 > will be silently removed from the printer command.</P
12968 >If specified in the [global] section, the print command given
12969 will be used for any printable service that does not have its own
12970 print command specified.</P
12972 >If there is neither a specified print command for a
12973 printable service nor a global print command, spool files will
12974 be created but not processed and (most importantly) not removed.</P
12976 >Note that printing may fail on some UNIXes from the
12980 > account. If this happens then create
12981 an alternative guest account that can print and set the <A
12982 HREF="#GUESTACCOUNT
"
12990 in the [global] section.</P
12992 >You can form quite complex print commands by realizing
12993 that they are just passed to a shell. For example the following
12994 will log a print job, print the file, then remove it. Note that
12995 ';' is the usual separator for command in shell scripts.</P
12999 >print command = echo Printing %s >>
13000 /tmp/print.log; lpr -P %p %s; rm %s</B
13003 >You may have to vary this command considerably depending
13004 on how you normally print files on your system. The default for
13005 the parameter varies depending on the setting of the <A
13017 >printing= BSD, AIX, QNX, LPRNG
13023 >print command = lpr -r -P%p %s</B
13028 >printing= SYS or HPUX :</B
13033 >print command = lp -c -d%p %s; rm %s</B
13038 >printing=SOFTQ :</B
13043 >print command = lp -d%p -s %s; rm %s</B
13048 >print command = /usr/local/samba/bin/myprintscript
13076 >If this parameter is <TT
13080 clients may open, write to and submit spool files on the directory
13081 specified for the service. </P
13083 >Note that a printable service will ALWAYS allow writing
13084 to the service path (user privileges permitting) via the spooling
13085 of print data. The <A
13094 > parameter controls only non-printing access to
13110 HREF="#PRINTCAPNAME
"
13121 NAME="PRINTCAPNAME
"
13123 >printcap name (G)</DT
13126 >This parameter may be used to override the
13127 compiled-in default printcap name used by the server (usually <TT
13129 > /etc/printcap</TT
13130 >). See the discussion of the <A
13133 > section above for reasons
13134 why you might want to do this.</P
13136 >On System V systems that use <B
13140 list available printers you can use <B
13142 >printcap name = lpstat
13144 > to automatically obtain lists of available printers. This
13145 is the default for systems that define SYSV at configure time in
13146 Samba (this includes most System V based systems). If <TT
13155 these systems then Samba will launch <B
13159 attempt to parse the output to obtain a printer list.</P
13161 >A minimal printcap file would look something like this:</P
13170 CLASS="PROGRAMLISTING
"
13171 > print1|My Printer 1
13172 print2|My Printer 2
13173 print3|My Printer 3
13174 print4|My Printer 4
13175 print5|My Printer 5
13182 >where the '|' separates aliases of a printer. The fact
13183 that the second alias has a space in it gives a hint to Samba
13184 that it's a comment.</P
13188 >: Under AIX the default printcap
13192 >. Samba will assume the
13196 > format if the string
13200 > appears in the printcap filename.</P
13204 >printcap name = /etc/printcap</B
13209 >printcap name = /etc/myprintcap</B
13214 NAME="PRINTERADMIN
"
13216 >printer admin (S)</DT
13219 >This is a list of users that can do anything to
13220 printers via the remote administration interfaces offered by MS-RPC
13221 (usually using a NT workstation). Note that the root user always
13222 has admin rights.</P
13226 >printer admin = <empty string></B
13232 >printer admin = admin, @staff</B
13237 NAME="PRINTERDRIVER
"
13239 >printer driver (S)</DT
13244 >This is a depreciated
13245 parameter and will be removed in the next major release
13246 following version 2.2. Please see the instructions in
13249 >PRINTER_DRIVER2.txt</TT
13254 > of the Samba distribution for more information
13255 on the new method of loading printer drivers onto a Samba server.
13258 >This option allows you to control the string
13259 that clients receive when they ask the server for the printer driver
13260 associated with a printer. If you are using Windows95 or Windows NT
13261 then you can use this to automate the setup of printers on your
13264 >You need to set this parameter to the exact string (case
13265 sensitive) that describes the appropriate printer driver for your
13266 system. If you don't know the exact string to use then you should
13267 first try with no <A
13268 HREF="#PRINTERDRIVER
"
13272 > printer driver</I
13275 > option set and the client will
13276 give you a list of printer drivers. The appropriate strings are
13277 shown in a scroll box after you have chosen the printer manufacturer.</P
13280 HREF="#PRINTERDRIVERFILE
"
13292 >printer driver = HP LaserJet 4L</B
13297 NAME="PRINTERDRIVERFILE
"
13299 >printer driver file (G)</DT
13304 >This is a depreciated
13305 parameter and will be removed in the next major release
13306 following version 2.2. Please see the instructions in
13309 >PRINTER_DRIVER2.txt</TT
13314 > of the Samba distribution for more information
13315 on the new method of loading printer drivers onto a Samba server.
13318 >This parameter tells Samba where the printer driver
13319 definition file, used when serving drivers to Windows 95 clients, is
13320 to be found. If this is not set, the default is :</P
13325 CLASS="REPLACEABLE
"
13327 >SAMBA_INSTALL_DIRECTORY</I
13330 /lib/printers.def</TT
13333 >This file is created from Windows 95 <TT
13337 > files found on the Windows 95 client system. For more
13338 details on setting up serving of printer drivers to Windows 95
13339 clients, see the documentation file in the <TT
13345 >PRINTER_DRIVER.txt</TT
13349 HREF="#PRINTERDRIVERLOCATION
"
13353 > printer driver location</I
13359 >None (set in compile).</EM
13364 >printer driver file =
13365 /usr/local/samba/printers/drivers.def</B
13370 NAME="PRINTERDRIVERLOCATION
"
13372 >printer driver location (S)</DT
13377 >This is a depreciated
13378 parameter and will be removed in the next major release
13379 following version 2.2. Please see the instructions in
13382 >PRINTER_DRIVER2.txt</TT
13387 > of the Samba distribution for more information
13388 on the new method of loading printer drivers onto a Samba server.
13391 >This parameter tells clients of a particular printer
13392 share where to find the printer driver files for the automatic
13393 installation of drivers for Windows 95 machines. If Samba is set up
13394 to serve printer drivers to Windows 95 machines, this should be set to</P
13398 >\\MACHINE\PRINTER$</B
13401 >Where MACHINE is the NetBIOS name of your Samba server,
13402 and PRINTER$ is a share you set up for serving printer driver
13403 files. For more details on setting this up see the documentation
13409 > PRINTER_DRIVER.txt</TT
13413 HREF="#PRINTERDRIVERFILE
"
13417 > printer driver file</I
13429 >printer driver location = \\MACHINE\PRINTER$
13437 >printer name (S)</DT
13440 >This parameter specifies the name of the printer
13441 to which print jobs spooled through a printable service will be sent.</P
13443 >If specified in the [global] section, the printer
13444 name given will be used for any printable service that does
13445 not have its own printer name specified.</P
13448 >none (but may be <TT
13452 on many systems)</EM
13457 >printer name = laserwriter</B
13468 HREF="#PRINTERNAME
"
13484 >This parameters controls how printer status
13485 information is interpreted on your system. It also affects the
13486 default values for the <TT
13506 >lpresume command</I
13514 > if specified in the
13515 [global]f> section.</P
13517 >Currently eight printing styles are supported. They are
13551 >To see what the defaults are for the other print
13552 commands when using the various options use the <A
13553 HREF="testparm
.1.html
"
13558 >This option can be set on a per printer basis</P
13560 >See also the discussion in the <A
13573 HREF="#MAXPROTOCOL
"
13602 NAME="QUEUEPAUSECOMMAND
"
13604 >queuepause command (S)</DT
13607 >This parameter specifies the command to be
13608 executed on the server host in order to pause the printerqueue.</P
13610 >This command should be a program or script which takes
13611 a printer name as its only parameter and stops the printerqueue,
13612 such that no longer jobs are submitted to the printer.</P
13614 >This command is not supported by Windows for Workgroups,
13615 but can be issued from the Printer's window under Windows 95
13623 > is given then the printername
13624 is put in its place. Otherwise it is placed at the end of the command.
13627 >Note that it is good practice to include the absolute
13628 path in the command as the PATH may not be available to the
13632 >depends on the setting of <TT
13643 >queuepause command = disable %p</B
13648 NAME="QUEUERESUMECOMMAND
"
13650 >queueresume command (S)</DT
13653 >This parameter specifies the command to be
13654 executed on the server host in order to resume the printerqueue. It
13655 is the command to undo the behavior that is caused by the
13656 previous parameter (<A
13657 HREF="#QUEUEPAUSECOMMAND
"
13661 > queuepause command</I
13666 >This command should be a program or script which takes
13667 a printer name as its only parameter and resumes the printerqueue,
13668 such that queued jobs are resubmitted to the printer.</P
13670 >This command is not supported by Windows for Workgroups,
13671 but can be issued from the Printer's window under Windows 95
13679 > is given then the printername
13680 is put in its place. Otherwise it is placed at the end of the
13683 >Note that it is good practice to include the absolute
13684 path in the command as the PATH may not be available to the
13688 >depends on the setting of <A
13702 >queuepause command = enable %p
13713 >This boolean parameter controls whether <A
13717 > will support the "Read
13718 Block Multiplex
" SMB. This is now rarely used and defaults to
13722 >. You should never need to set this
13737 >This is a list of users that are given read-only
13738 access to a service. If the connecting user is in this list then
13739 they will not be given write access, no matter what the <A
13748 option is set to. The list can include group names using the
13749 syntax described in the <A
13750 HREF="#INVALIDUSERS
"
13767 > parameter and the <A
13768 HREF="#INVALIDUSERS
"
13780 >read list = <empty string></B
13785 >read list = mary, @students</B
13795 >Note that this is an inverted synonym for <A
13812 >This parameter controls whether or not the server
13813 will support the raw read SMB requests when transferring data
13816 >If enabled, raw reads allow reads of 65535 bytes in
13817 one packet. This typically provides a major performance benefit.
13820 >However, some clients either negotiate the allowable
13821 block size incorrectly or are incapable of supporting larger block
13822 sizes, and for these clients you may need to disable raw reads.</P
13824 >In general this parameter should be viewed as a system tuning
13825 tool and left severely alone. See also <A
13853 affects the overlap of disk reads/writes with network reads/writes.
13854 If the amount of data being transferred in several of the SMB
13855 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
13856 than this value then the server begins writing the data before it
13857 has received the whole packet from the network, or in the case of
13858 SMBreadbraw, it begins writing to the network before all the data
13859 has been read from disk.</P
13861 >This overlapping works best when the speeds of disk and
13862 network access are similar, having very little effect when the
13863 speed of one is much greater than the other.</P
13865 >The default value is 16384, but very little experimentation
13866 has been done yet to determine the optimal value, and it is likely
13867 that the best value will vary greatly between systems anyway.
13868 A value over 65536 is pointless and will cause you to allocate
13869 memory unnecessarily.</P
13873 >read size = 16384</B
13878 >read size = 8192</B
13883 NAME="REMOTEANNOUNCE
"
13885 >remote announce (G)</DT
13888 >This option allows you to setup <A
13892 > to periodically announce itself
13893 to arbitrary IP addresses with an arbitrary workgroup name.</P
13895 >This is useful if you want your Samba server to appear
13896 in a remote workgroup for which the normal browse propagation
13897 rules don't work. The remote workgroup can be anywhere that you
13898 can send IP packets to.</P
13904 >remote announce = 192.168.2.255/SERVERS
13905 192.168.4.255/STAFF</B
13908 >the above line would cause nmbd to announce itself
13909 to the two given IP addresses using the given workgroup names.
13910 If you leave out the workgroup name then the one given in
13920 parameter is used instead.</P
13922 >The IP addresses you choose would normally be the broadcast
13923 addresses of the remote networks, but can also be the IP addresses
13924 of known browse masters if your network config is that stable.</P
13926 >See the documentation file <TT
13937 >remote announce = <empty string>
13943 NAME="REMOTEBROWSESYNC
"
13945 >remote browse sync (G)</DT
13948 >This option allows you to setup <A
13952 > to periodically request
13953 synchronization of browse lists with the master browser of a samba
13954 server that is on a remote segment. This option will allow you to
13955 gain browse lists for multiple workgroups across routed networks. This
13956 is done in a manner that does not work with any non-samba servers.</P
13958 >This is useful if you want your Samba server and all local
13959 clients to appear in a remote workgroup for which the normal browse
13960 propagation rules don't work. The remote workgroup can be anywhere
13961 that you can send IP packets to.</P
13967 >remote browse sync = 192.168.2.255 192.168.4.255
13971 >the above line would cause <B
13975 the master browser on the specified subnets or addresses to
13976 synchronize their browse lists with the local server.</P
13978 >The IP addresses you choose would normally be the broadcast
13979 addresses of the remote networks, but can also be the IP addresses
13980 of known browse masters if your network config is that stable. If
13981 a machine IP address is given Samba makes NO attempt to validate
13982 that the remote machine is available, is listening, nor that it
13983 is in fact the browse master on it's segment.</P
13987 >remote browse sync = <empty string>
13993 NAME="RESTRICTANONYMOUS
"
13995 >restrict anonymous (G)</DT
13998 >This is a boolean parameter. If it is true, then
13999 anonymous access to the server will be restricted, namely in the
14000 case where the server is expecting the client to send a username,
14001 but it doesn't. Setting it to true will force these anonymous
14002 connections to be denied, and the client will be required to always
14003 supply a username and password when connecting. Use of this parameter
14004 is only recommended for homogeneous NT client environments.</P
14006 >This parameter makes the use of macro expansions that rely
14007 on the username (%U, %G, etc) consistent. NT 4.0
14008 likes to use anonymous connections when refreshing the share list,
14009 and this is a way to work around that.</P
14011 >When restrict anonymous is true, all anonymous connections
14012 are denied no matter what they are for. This can effect the ability
14013 of a machine to access the samba Primary Domain Controller to revalidate
14014 it's machine account after someone else has logged on the client
14015 interactively. The NT client will display a message saying that
14016 the machine's account in the domain doesn't exist or the password is
14017 bad. The best way to deal with this is to reboot NT client machines
14018 between interactive logons, using "Shutdown and Restart
", rather
14019 than "Close all programs and logon as a different user
".</P
14023 >restrict anonymous = no</B
14034 HREF="#ROOTDIRECTORY
"
14038 >root directory"</I
14051 HREF=
"#ROOTDIRECTORY"
14055 >root directory
"</I
14062 NAME="ROOTDIRECTORY
"
14064 >root directory (G)</DT
14067 >The server will <B
14071 Change it's root directory) to this directory on startup. This is
14072 not strictly necessary for secure operation. Even without it the
14073 server will deny access to files not in one of the service entries.
14074 It may also check for, and deny access to, soft links to other
14075 parts of the filesystem, or attempts to use "..
" in file names
14076 to access other directories (depending on the setting of the <A
14093 than "/
" adds an extra level of security, but at a price. It
14094 absolutely ensures that no access is given to files not in the
14095 sub-tree specified in the <TT
14103 > some files needed for
14104 complete operation of the server. To maintain full operability
14105 of the server you will need to mirror some system files
14111 > tree. In particular
14112 you will need to mirror <TT
14116 subset of it), and any binaries or configuration files needed for
14117 printing (if required). The set of files that must be mirrored is
14118 operating system dependent.</P
14122 >root directory = /</B
14127 >root directory = /homes/smb</B
14132 NAME="ROOTPOSTEXEC
"
14134 >root postexec (S)</DT
14137 >This is the same as the <TT
14143 parameter except that the command is run as root. This
14144 is useful for unmounting filesystems
14145 (such as cdroms) after a connection is closed.</P
14159 >root postexec = <empty string>
14167 >root preexec (S)</DT
14170 >This is the same as the <TT
14176 parameter except that the command is run as root. This
14177 is useful for mounting filesystems (such as cdroms) after a
14178 connection is closed.</P
14189 HREF="#PREEXECCLOSE
"
14200 >root preexec = <empty string>
14206 NAME="ROOTPREEXECCLOSE
"
14208 >root preexec close (S)</DT
14211 >This is the same as the <TT
14217 > parameter except that the command is run as root.</P
14228 HREF="#PREEXECCLOSE
"
14239 >root preexec close = no</B
14249 >This option affects how clients respond to
14250 Samba and is one of the most important settings in the <TT
14255 >The option sets the "security mode bit
" in replies to
14256 protocol negotiations with <A
14261 > to turn share level security on or off. Clients decide
14262 based on this bit whether (and how) to transfer user and password
14263 information to the server.</P
14267 >security = user</B
14269 the most common setting needed when talking to Windows 98 and
14272 >The alternatives are <B
14274 >security = share</B
14278 >security = server</B
14285 >In versions of Samba prior to 2..0, the default was
14288 >security = share</B
14289 > mainly because that was
14290 the only option at one stage.</P
14292 >There is a bug in WfWg that has relevance to this
14293 setting. When in user or server level security a WfWg client
14294 will totally ignore the password you type in the "connect
14295 drive
" dialog box. This makes it very difficult (if not impossible)
14296 to connect to a Samba service as anyone except the user that
14297 you are logged into WfWg as.</P
14299 >If your PCs use usernames that are the same as their
14300 usernames on the UNIX machine then you will want to use
14303 >security = user</B
14304 >. If you mostly use usernames
14305 that don't exist on the UNIX box then use <B
14311 >You should also use <B
14313 >security = share</B
14315 want to mainly setup shares without a password (guest shares). This
14316 is commonly used for a shared printer server. It is more difficult
14317 to setup guest shares with <B
14319 >security = user</B
14330 >parameter for details.</P
14332 >It is possible to use <B
14337 > where it is offers both user and share
14338 level security under different <A
14339 HREF="#NETBIOSALIASES
"
14343 >NetBIOS aliases</I
14348 >The different settings will now be explained.</P
14351 NAME="SECURITYEQUALSSHARE
"
14358 >When clients connect to a share level security server then
14359 need not log onto the server with a valid username and password before
14360 attempting to connect to a shared resource (although modern clients
14361 such as Windows 95/98 and Windows NT will send a logon request with
14362 a username but no password when talking to a <B
14366 > server). Instead, the clients send authentication information
14367 (passwords) on a per-share basis, at the time they attempt to connect
14376 uses a valid UNIX user to act on behalf of the client, even in
14379 >security = share</B
14380 > level security.</P
14382 >As clients are not required to send a username to the server
14383 in share level security, <B
14387 techniques to determine the correct UNIX user to use on behalf
14390 >A list of possible UNIX usernames to match with the given
14391 client password is constructed using the following methods :</P
14406 > parameter is set, then all the other
14407 stages are missed and only the <A
14408 HREF="#GUESTACCOUNT
"
14415 > username is checked.
14420 >Is a username is sent with the share connection
14421 request, then this username (after mapping - see <A
14422 HREF="#USERNAMEMAP
"
14430 is added as a potential username.</P
14434 >If the client did a previous <EM
14437 > request (the SessionSetup SMB call) then the
14438 username sent in this SMB will be added as a potential username.
14443 >The name of the service the client requested is
14444 added as a potential username.</P
14448 >The NetBIOS name of the client is added to
14449 the list as a potential username.</P
14453 >Any users on the <A
14461 > list are added as potential usernames.
14472 not set, then this list is then tried with the supplied password.
14473 The first user for whom the password matches will be used as the
14482 set, or no username can be determined then if the share is marked
14483 as available to the <TT
14489 guest user will be used, otherwise access is denied.</P
14491 >Note that it can be <EM
14494 in share-level security as to which UNIX username will eventually
14495 be used in granting access.</P
14497 >See also the section <A
14499 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
14503 NAME="SECURITYEQUALSUSER
"
14510 >This is the default security setting in Samba 2.2.
14511 With user-level security a client must first "log=on
" with a
14512 valid username and password (which can be mapped using the <A
14513 HREF="#USERNAMEMAP
"
14521 parameter). Encrypted passwords (see the <A
14522 HREF="#ENCRYPTPASSWORDS
"
14526 >encrypted passwords</I
14529 > parameter) can also
14530 be used in this security mode. Parameters such as <A
14546 > if set are then applied and
14547 may change the UNIX user to use on this connection, but only after
14548 the user has been successfully authenticated.</P
14552 > that the name of the resource being
14555 > sent to the server until after
14556 the server has successfully authenticated the client. This is why
14557 guest shares don't work in user level security without allowing
14558 the server to automatically map unknown users into the <A
14559 HREF="#GUESTACCOUNT
"
14576 > parameter for details on doing this.</P
14578 >See also the section <A
14580 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
14584 NAME="SECURITYEQUALSSERVER
"
14591 >In this mode Samba will try to validate the username/password
14592 by passing it to another SMB server, such as an NT box. If this
14593 fails it will revert to <B
14595 >security = user</B
14597 that if encrypted passwords have been negotiated then Samba cannot
14598 revert back to checking the UNIX password file, it must have a valid
14602 > file to check users against. See the
14603 documentation file in the <TT
14609 >ENCRYPTION.txt</TT
14610 > for details on how to set this
14615 > that from the clients point of
14618 >security = server</B
14619 > is the same as <B
14621 > security = user</B
14622 >. It only affects how the server deals
14623 with the authentication, it does not in any way affect what the
14628 > that the name of the resource being
14631 > sent to the server until after
14632 the server has successfully authenticated the client. This is why
14633 guest shares don't work in user level security without allowing
14634 the server to automatically map unknown users into the <A
14635 HREF="#GUESTACCOUNT
"
14652 > parameter for details on doing this.</P
14654 >See also the section <A
14656 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
14660 HREF="#PASSWORDSERVER
"
14668 > parameter and the <A
14669 HREF="#ENCRYPTPASSWORDS
"
14673 >encrypted passwords</I
14680 NAME="SECURITYEQUALSDOMAIN
"
14687 >This mode will only work correctly if <A
14688 HREF="smbpasswd
.8.html
"
14691 > has been used to add this
14692 machine into a Windows NT Domain. It expects the <A
14693 HREF="#ENCRYPTPASSWORDS
"
14697 >encrypted passwords</I
14701 > parameter to be set to <TT
14705 mode Samba will try to validate the username/password by passing
14706 it to a Windows NT Primary or Backup Domain Controller, in exactly
14707 the same way that a Windows NT Server would do.</P
14711 > that a valid UNIX user must still
14712 exist as well as the account on the Domain Controller to allow
14713 Samba to have a valid UNIX account to map file access to.</P
14717 > that from the clients point
14720 >security = domain</B
14721 > is the same as <B
14725 >. It only affects how the server deals with the authentication,
14726 it does not in any way affect what the client sees.</P
14730 > that the name of the resource being
14733 > sent to the server until after
14734 the server has successfully authenticated the client. This is why
14735 guest shares don't work in user level security without allowing
14736 the server to automatically map unknown users into the <A
14737 HREF="#GUESTACCOUNT
"
14754 > parameter for details on doing this.</P
14758 > There is currently a bug in the
14759 implementation of <B
14761 >security = domain</B
14763 to multi-byte character set usernames. The communication with a
14764 Domain Controller must be done in UNICODE and Samba currently
14765 does not widen multi-byte user names to UNICODE correctly, thus
14766 a multi-byte username will not be recognized correctly at the
14767 Domain Controller. This issue will be addressed in a future release.</P
14769 >See also the section <A
14771 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
14775 HREF="#PASSWORDSERVER
"
14783 > parameter and the <A
14784 HREF="#ENCRYPTPASSWORDS
"
14788 >encrypted passwords</I
14796 >security = USER</B
14801 >security = DOMAIN</B
14806 NAME="SECURITYMASK
"
14808 >security mask (S)</DT
14811 >This parameter controls what UNIX permission
14812 bits can be modified when a Windows NT client is manipulating
14813 the UNIX permission on a file using the native NT security
14816 >This parameter is applied as a mask (AND'ed with) to
14817 the changed permission bits, thus preventing any bits not in
14818 this mask from being modified. Essentially, zero bits in this
14819 mask may be treated as a set of bits the user is not allowed
14822 >If not set explicitly this parameter is set to the same
14832 > parameter. To allow a user to modify all the
14833 user/group/world permissions on a file, set this parameter to
14838 > that users who can access the
14839 Samba server through other means can easily bypass this
14840 restriction, so it is primarily useful for standalone
14841 "appliance
" systems. Administrators of most normal systems will
14842 probably want to set it to 0777.</P
14845 HREF="#FORCEDIRECTORYSECURITYMODE
"
14849 >force directory security mode</I
14854 HREF="#DIRECTORYSECURITYMASK
"
14863 HREF="#FORCESECURITYMODE
"
14867 >force security mode</I
14874 >security mask = <same as create mask>
14880 >security mask = 0777</B
14885 NAME="SERVERSTRING
"
14887 >server string (G)</DT
14890 >This controls what string will show up in the
14891 printer comment box in print manager and next to the IPC connection
14895 >. It can be any string that you wish
14896 to show to your users.
</P
14898 >It also sets what will appear in browse lists next
14899 to the machine name.
</P
14906 > will be replaced with the Samba
14914 > will be replaced with the
14919 >server string = Samba %v
</B
14924 >server string = University of GNUs Samba
14930 NAME=
"SETDIRECTORY"
14932 >set directory (S)
</DT
14937 >set directory = no
</B
14939 users of the service may not use the setdir command to change
14945 > command is only implemented
14946 in the Digital Pathworks client. See the Pathworks documentation
14951 >set directory = no
</B
14958 >share modes (S)
</DT
14961 >This enables or disables the honoring of
14967 > during a file open. These
14968 modes are used by clients to gain exclusive read or write access
14971 >These open modes are not directly supported by UNIX, so
14972 they are simulated using shared memory, or lock files if your
14973 UNIX doesn't support shared memory (almost all do).
</P
14975 >The share modes that are enabled by this option are
14999 >This option gives full share compatibility and enabled
15004 > turn this parameter
15005 off as many Windows applications will break if you do so.
</P
15009 >share modes = yes
</B
15014 NAME=
"SHORTPRESERVECASE"
15016 >short preserve case (S)
</DT
15019 >This boolean parameter controls if new files
15020 which conform to
8.3 syntax, that is all in upper case and of
15021 suitable length, are created upper case, or if they are forced
15023 HREF=
"#DEFAULTCASE"
15031 >. This option can be use with
<A
15032 HREF=
"#PRESERVECASE"
15035 >preserve case = yes
</B
15038 > to permit long filenames to retain their case, while short
15039 names are lowered.
</P
15041 >See the section on
<A
15048 >short preserve case = yes
</B
15053 NAME=
"SHOWADDPRINTERWIZARD"
15055 >show add printer wizard (G)
</DT
15058 >With the introduction of MS-RPC based printing support
15059 for Windows NT/
2000 client in Samba
2.2, a
"Printers..." folder will
15060 appear on Samba hosts in the share listing. Normally this folder will
15061 contain an icon for the MS Add Printer Wizard (APW). However, it is
15062 possible to disable this feature regardless of the level of privilege
15063 of the connected user.
</P
15065 >Under normal circumstances, the Windows NT/
2000 client will
15066 open a handle on the printer server with OpenPrinterEx() asking for
15067 Administrator privileges. If the user does not have administrative
15068 access on the print server (i.e is not root or a member of the
15074 > group), the OpenPrinterEx()
15075 call fails and the clients another open call with a request for
15076 a lower privilege level. This should succeed, however the APW
15077 icon will not be displayed.
</P
15082 >show add printer wizard
</I
15085 parameter will always cause the OpenPrinterEx() on the server
15086 to fail. Thus the APW icon will never be displayed.
<EM
15088 >This does not prevent the same user from having
15089 administrative privilege on an individual printer.
</P
15092 HREF=
"#ADDPRINTERCOMMAND"
15101 HREF=
"#DELETEPRINTERCOMMAND"
15105 >deleteprinter command
</I
15109 HREF=
"#PRINTERADMIN"
15120 >show add printer wizard = yes
</B
15125 NAME=
"SMBPASSWDFILE"
15127 >smb passwd file (G)
</DT
15130 >This option sets the path to the encrypted
15131 smbpasswd file. By default the path to the smbpasswd file
15132 is compiled into Samba.
</P
15136 >smb passwd file = ${prefix}/private/smbpasswd
15142 >smb passwd file = /etc/samba/smbpasswd
15148 NAME=
"SOCKETADDRESS"
15150 >socket address (G)
</DT
15153 >This option allows you to control what
15154 address Samba will listen for connections on. This is used to
15155 support multiple virtual interfaces on the one server, each
15156 with a different configuration.
</P
15158 >By default samba will accept connections on any
15163 >socket address =
192.168.2.20</B
15169 NAME=
"SOCKETOPTIONS"
15171 >socket options (G)
</DT
15174 >This option allows you to set socket options
15175 to be used when talking with the client.
</P
15177 >Socket options are controls on the networking layer
15178 of the operating systems which allow the connection to be
15181 >This option will typically be used to tune your Samba
15182 server for optimal performance for your local network. There is
15183 no way that Samba can know what the optimal parameters are for
15184 your net, so you must experiment and choose them yourself. We
15185 strongly suggest you read the appropriate documentation for your
15186 operating system first (perhaps
<B
15192 >You may find that on some systems Samba will say
15193 "Unknown socket option" when you supply an option. This means you
15194 either incorrectly typed it or you need to add an include file
15195 to includes.h for your OS. If the latter is the case please
15196 send the patch to
<A
15197 HREF=
"mailto:samba@samba.org"
15199 > samba@samba.org
</A
15202 >Any of the supported socket options may be combined
15203 in any way you like, as long as your OS allows it.
</P
15205 >This is the list of socket options currently settable
15206 using this option:
</P
15232 >IPTOS_THROUGHPUT
</P
15252 >Those marked with a
<EM
15255 argument. The others can optionally take a
1 or
0 argument to enable
15256 or disable the option, by default they will be enabled if you
15257 don't specify
1 or
0.
</P
15259 >To specify an argument use the syntax SOME_OPTION=VALUE
15263 >. Note that you must
15264 not have any spaces before or after the = sign.
</P
15266 >If you are on a local network then a sensible option
15271 >socket options = IPTOS_LOWDELAY
</B
15274 >If you have a local network then you could try:
</P
15278 >socket options = IPTOS_LOWDELAY TCP_NODELAY
</B
15281 >If you are on a wide area network then perhaps try
15282 setting IPTOS_THROUGHPUT.
</P
15284 >Note that several of the options may cause your Samba
15285 server to fail completely. Use these options with caution!
</P
15289 >socket options = TCP_NODELAY
</B
15294 >socket options = IPTOS_LOWDELAY
</B
15299 NAME=
"SOURCEENVIRONMENT"
15301 >source environment (G)
</DT
15304 >This parameter causes Samba to set environment
15305 variables as per the content of the file named.
</P
15307 >If the value of this parameter starts with a
"|" character
15308 then Samba will treat that value as a pipe command to open and
15309 will set the environment variables from the output of the pipe.
</P
15311 >The contents of the file or the output of the pipe should
15312 be formatted as the output of the standard Unix
<B
15316 > command. This is of the form :
</P
15318 >Example environment entry:
</P
15322 >SAMBA_NETBIOS_NAME=myhostname
</B
15326 >No default value
</EM
15331 >source environment = |/etc/smb.conf.sh
15337 >source environment =
15338 /usr/local/smb_env_vars
</B
15348 >This variable is part of SSL-enabled Samba. This
15349 is only available if the SSL libraries have been compiled on your
15350 system and the configure option
<B
15354 given at configure time.
</P
15358 > that for export control reasons
15361 > enabled by default in any
15362 current binary version of Samba.
</P
15364 >This variable enables or disables the entire SSL mode. If
15368 >, the SSL enabled samba behaves
15369 exactly like the non-SSL samba. If set to
<TT
15373 it depends on the variables
<A
15382 HREF=
"#SSLHOSTSRESIGN"
15386 >ssl hosts resign
</I
15390 connection will be required.
</P
15399 NAME=
"SSLCACERTDIR"
15401 >ssl CA certDir (G)
</DT
15404 >This variable is part of SSL-enabled Samba. This
15405 is only available if the SSL libraries have been compiled on your
15406 system and the configure option
<B
15410 given at configure time.
</P
15414 > that for export control reasons
15417 > enabled by default in any
15418 current binary version of Samba.
</P
15420 >This variable defines where to look up the Certification
15421 Authorities. The given directory should contain one file for
15422 each CA that samba will trust. The file name must be the hash
15423 value over the
"Distinguished Name" of the CA. How this directory
15424 is set up is explained later in this document. All files within the
15425 directory that don't fit into this naming scheme are ignored. You
15426 don't need this variable if you don't verify client certificates.
</P
15430 >ssl CA certDir = /usr/local/ssl/certs
15436 NAME=
"SSLCACERTFILE"
15438 >ssl CA certFile (G)
</DT
15441 >This variable is part of SSL-enabled Samba. This
15442 is only available if the SSL libraries have been compiled on your
15443 system and the configure option
<B
15447 given at configure time.
</P
15451 > that for export control reasons
15454 > enabled by default in any
15455 current binary version of Samba.
</P
15457 >This variable is a second way to define the trusted CAs.
15458 The certificates of the trusted CAs are collected in one big
15459 file and this variable points to the file. You will probably
15460 only use one of the two ways to define your CAs. The first choice is
15461 preferable if you have many CAs or want to be flexible, the second
15462 is preferable if you only have one CA and want to keep things
15463 simple (you won't need to create the hashed file names). You
15464 don't need this variable if you don't verify client certificates.
</P
15468 >ssl CA certFile = /usr/local/ssl/certs/trustedCAs.pem
15476 >ssl ciphers (G)
</DT
15479 >This variable is part of SSL-enabled Samba. This
15480 is only available if the SSL libraries have been compiled on your
15481 system and the configure option
<B
15485 given at configure time.
</P
15489 > that for export control reasons
15492 > enabled by default in any
15493 current binary version of Samba.
</P
15495 >This variable defines the ciphers that should be offered
15496 during SSL negotiation. You should not set this variable unless
15497 you know what you are doing.
</P
15501 NAME=
"SSLCLIENTCERT"
15503 >ssl client cert (G)
</DT
15506 >This variable is part of SSL-enabled Samba. This
15507 is only available if the SSL libraries have been compiled on your
15508 system and the configure option
<B
15512 given at configure time.
</P
15516 > that for export control reasons
15519 > enabled by default in any
15520 current binary version of Samba.
</P
15522 >The certificate in this file is used by
<A
15523 HREF=
"smbclient.1.html"
15529 > if it exists. It's needed
15530 if the server requires a client certificate.
</P
15534 >ssl client cert = /usr/local/ssl/certs/smbclient.pem
15540 NAME=
"SSLCLIENTKEY"
15542 >ssl client key (G)
</DT
15545 >This variable is part of SSL-enabled Samba. This
15546 is only available if the SSL libraries have been compiled on your
15547 system and the configure option
<B
15551 given at configure time.
</P
15555 > that for export control reasons
15558 > enabled by default in any
15559 current binary version of Samba.
</P
15561 >This is the private key for
<A
15562 HREF=
"smbclient.1.html"
15568 >. It's only needed if the
15569 client should have a certificate.
</P
15573 >ssl client key = /usr/local/ssl/private/smbclient.pem
15579 NAME=
"SSLCOMPATIBILITY"
15581 >ssl compatibility (G)
</DT
15584 >This variable is part of SSL-enabled Samba. This
15585 is only available if the SSL libraries have been compiled on your
15586 system and the configure option
<B
15590 given at configure time.
</P
15594 > that for export control reasons
15597 > enabled by default in any
15598 current binary version of Samba.
</P
15600 >This variable defines whether SSLeay should be configured
15601 for bug compatibility with other SSL implementations. This is
15602 probably not desirable because currently no clients with SSL
15603 implementations other than SSLeay exist.
</P
15607 >ssl compatibility = no
</B
15618 HREF=
"#SSLHOSTSRESIGN"
15622 > ssl hosts resign
</I
15629 NAME=
"SSLHOSTSRESIGN"
15631 >ssl hosts resign (G)
</DT
15634 >This variable is part of SSL-enabled Samba. This
15635 is only available if the SSL libraries have been compiled on your
15636 system and the configure option
<B
15640 given at configure time.
</P
15644 > that for export control reasons
15647 > enabled by default in any
15648 current binary version of Samba.
</P
15650 >These two variables define whether samba will go
15651 into SSL mode or not. If none of them is defined, samba will
15652 allow only SSL connections. If the
<A
15661 hosts (by IP-address, IP-address range, net group or name),
15662 only these hosts will be forced into SSL mode. If the
<TT
15665 > ssl hosts resign
</I
15667 > variable lists hosts, only these
15668 hosts will NOT be forced into SSL mode. The syntax for these two
15669 variables is the same as for the
<A
15685 > pair of variables, only
15686 that the subject of the decision is different: It's not the access
15687 right but whether SSL is used or not.
</P
15689 >The example below requires SSL connections from all hosts
15690 outside the local net (which is
192.168.*.*).
</P
15694 >ssl hosts =
<empty string
></B
15699 >ssl hosts resign =
<empty string
></B
15704 >ssl hosts resign =
192.168.
</B
15709 NAME=
"SSLREQUIRECLIENTCERT"
15711 >ssl require clientcert (G)
</DT
15714 >This variable is part of SSL-enabled Samba. This
15715 is only available if the SSL libraries have been compiled on your
15716 system and the configure option
<B
15720 given at configure time.
</P
15724 > that for export control reasons
15727 > enabled by default in any
15728 current binary version of Samba.
</P
15730 >If this variable is set to
<TT
15734 server will not tolerate connections from clients that don't
15735 have a valid certificate. The directory/file given in
<A
15736 HREF=
"#SSLCACERTDIR"
15745 HREF=
"#SSLCACERTFILE"
15753 > will be used to look up the CAs that issued
15754 the client's certificate. If the certificate can't be verified
15755 positively, the connection will be terminated. If this variable
15759 >, clients don't need certificates.
15760 Contrary to web applications you really
<EM
15763 require client certificates. In the web environment the client's
15764 data is sensitive (credit card numbers) and the server must prove
15765 to be trustworthy. In a file server environment the server's data
15766 will be sensitive and the clients must prove to be trustworthy.
</P
15770 >ssl require clientcert = no
</B
15775 NAME=
"SSLREQUIRESERVERCERT"
15777 >ssl require servercert (G)
</DT
15780 >This variable is part of SSL-enabled Samba. This
15781 is only available if the SSL libraries have been compiled on your
15782 system and the configure option
<B
15786 given at configure time.
</P
15790 > that for export control reasons
15793 > enabled by default in any
15794 current binary version of Samba.
</P
15796 >If this variable is set to
<TT
15801 HREF=
"smbclient.1.html"
15808 > will request a certificate from the server. Same as
15810 HREF=
"#SSLREQUIRECLIENTCERT"
15818 > for the server.
</P
15822 >ssl require servercert = no
</B
15828 NAME=
"SSLSERVERCERT"
15830 >ssl server cert (G)
</DT
15833 >This variable is part of SSL-enabled Samba. This
15834 is only available if the SSL libraries have been compiled on your
15835 system and the configure option
<B
15839 given at configure time.
</P
15843 > that for export control reasons
15846 > enabled by default in any
15847 current binary version of Samba.
</P
15849 >This is the file containing the server's certificate.
15852 > have a certificate. The
15853 file may also contain the server's private key. See later for
15854 how certificates and private keys are created.
</P
15858 >ssl server cert =
<empty string
>
15864 NAME=
"SSLSERVERKEY"
15866 >ssl server key (G)
</DT
15869 >This variable is part of SSL-enabled Samba. This
15870 is only available if the SSL libraries have been compiled on your
15871 system and the configure option
<B
15875 given at configure time.
</P
15879 > that for export control reasons
15882 > enabled by default in any
15883 current binary version of Samba.
</P
15885 >This file contains the private key of the server. If
15886 this variable is not defined, the key is looked up in the
15887 certificate file (it may be appended to the certificate).
15890 > have a private key
15891 and the certificate
<EM
15894 match this private key.
</P
15898 >ssl server key =
<empty string
>
15906 >ssl version (G)
</DT
15909 >This variable is part of SSL-enabled Samba. This
15910 is only available if the SSL libraries have been compiled on your
15911 system and the configure option
<B
15915 given at configure time.
</P
15919 > that for export control reasons
15922 > enabled by default in any
15923 current binary version of Samba.
</P
15925 >This enumeration variable defines the versions of the
15926 SSL protocol that will be used.
<TT
15930 dynamic negotiation of SSL v2 or v3,
<TT
15937 > results in SSL v3 and
15941 > results in TLS v1. TLS (Transport Layer
15942 Security) is the new standard for SSL.
</P
15946 >ssl version =
"ssl2or3"</B
15953 >stat cache (G)
</DT
15956 >This parameter determines if
<A
15960 > will use a cache in order to
15961 speed up case insensitive name mappings. You should never need
15962 to change this parameter.
</P
15966 >stat cache = yes
</B
15971 NAME=
"STATCACHESIZE"
15973 >stat cache size (G)
</DT
15976 >This parameter determines the number of
15983 never need to change this parameter.
</P
15987 >stat cache size =
50</B
15997 >This enables or disables logging of connections
15998 to a status file that
<A
15999 HREF=
"smbstatus.1.html"
16005 >With this disabled
<B
16009 to tell you what connections are active. You should never need to
16010 change this parameter.
</P
16019 NAME=
"STRICTLOCKING"
16021 >strict locking (S)
</DT
16024 >This is a boolean that controls the handling of
16025 file locking in the server. When this is set to
<TT
16029 the server will check every read and write access for file locks, and
16030 deny access if locks exist. This can be slow on some systems.
</P
16032 >When strict locking is
<TT
16035 > the server does file
16036 lock checks only when the client explicitly asks for them.
</P
16038 >Well behaved clients always ask for lock checks when it
16039 is important, so in the vast majority of cases
<B
16043 > is preferable.
</P
16047 >strict locking = no
</B
16054 >strict sync (S)
</DT
16057 >Many Windows applications (including the Windows
16058 98 explorer shell) seem to confuse flushing buffer contents to
16059 disk with doing a sync to disk. Under UNIX, a sync call forces
16060 the process to be suspended until the kernel has ensured that
16061 all outstanding data in kernel disk buffers has been safely stored
16062 onto stable storage. This is very slow and should only be done
16063 rarely. Setting this parameter to
<TT
16067 default) means that smbd ignores the Windows applications requests for
16068 a sync call. There is only a possibility of losing data if the
16069 operating system itself that Samba is running on crashes, so there is
16070 little danger in this default setting. In addition, this fixes many
16071 performance problems that people have reported with the new Windows98
16072 explorer shell file copies.
</P
16087 >strict sync = no
</B
16097 >This is a boolean that controls whether to
16098 strip trailing dots off UNIX filenames. This helps with some
16099 CDROMs that have filenames ending in a single dot.
</P
16110 >sync always (S)
</DT
16113 >This is a boolean parameter that controls
16114 whether writes will always be written to stable storage before
16115 the write call returns. If this is false then the server will be
16116 guided by the client's request in each write call (clients can
16117 set a bit indicating that a particular write should be synchronous).
16118 If this is true then every write will be followed by a
<B
16122 > call to ensure the data is written to disk. Note that
16128 > parameter must be set to
16132 > in order for this parameter to have
16148 >sync always = no
</B
16158 >This parameter maps how Samba debug messages
16159 are logged onto the system syslog logging levels. Samba debug
16160 level zero maps onto syslog
<TT
16164 level one maps onto
<TT
16171 >, debug level three
16172 maps onto LOG_INFO. All higher levels are mapped to
<TT
16177 >This parameter sets the threshold for sending messages
16178 to syslog. Only messages with debug level less than this value
16179 will be sent to syslog.
</P
16190 >syslog only (G)
</DT
16193 >If this parameter is set then Samba debug
16194 messages are logged into the system syslog only, and not to
16195 the debug log files.
</P
16199 >syslog only = no
</B
16204 NAME=
"TEMPLATEHOMEDIR"
16206 >template homedir (G)
</DT
16211 > this parameter is
16212 only available in Samba
3.0.
</P
16214 >When filling out the user information for a Windows NT
16216 HREF=
"winbindd.8.html"
16220 uses this parameter to fill in the home directory for that user.
16226 > is present it is substituted
16227 with the user's Windows NT domain name. If the string
<TT
16233 > is present it is substituted with the user's Windows
16238 >template homedir = /home/%D/%U
</B
16243 NAME=
"TEMPLATESHELL"
16245 >template shell (G)
</DT
16250 > this parameter is
16251 only available in Samba
3.0.
</P
16253 >When filling out the user information for a Windows NT
16255 HREF=
"winbindd.8.html"
16259 uses this parameter to fill in the login shell for that user.
</P
16263 >template shell = /bin/false
</B
16270 >time offset (G)
</DT
16273 >This parameter is a setting in minutes to add
16274 to the normal GMT to local time conversion. This is useful if
16275 you are serving a lot of PCs that have incorrect daylight
16276 saving time handling.
</P
16280 >time offset =
0</B
16285 >time offset =
60</B
16292 >time server (G)
</DT
16295 >This parameter determines if
<A
16300 > advertises itself as a time server to Windows
16305 >time server = no
</B
16310 NAME=
"TIMESTAMPLOGS"
16312 >timestamp logs (G)
</DT
16316 HREF=
"#DEBUGTIMESTAMP"
16320 > debug timestamp
</I
16327 NAME=
"TOTALPRINTJOBS"
16329 >total print jobs (G)
</DT
16332 >This parameter accepts an integer value which defines
16333 a limit on the maximum number of print jobs that will be accepted
16334 system wide at any given time. If a print job is submitted
16335 by a client which will exceed this number, then smbd will return an
16336 error indicating that no space is available on the server. The
16337 default value of
0 means that no such limit exists. This parameter
16338 can be used to prevent a server from exceeding its capacity and is
16339 designed as a printing throttle. See also
16341 HREF=
"#MAXPRINTJOBS"
16353 >total print jobs =
0</B
16358 >total print jobs =
5000</B
16363 NAME=
"UNIXPASSWORDSYNC"
16365 >unix password sync (G)
</DT
16368 >This boolean parameter controls whether Samba
16369 attempts to synchronize the UNIX password with the SMB password
16370 when the encrypted SMB password in the smbpasswd file is changed.
16371 If this is set to true the program specified in the
<TT
16377 >parameter is called
<EM
16380 to allow the new UNIX password to be set without access to the
16381 old UNIX password (as the SMB password has change code has no
16382 access to the old password cleartext, only the new).
</P
16385 HREF=
"#PASSWDPROGRAM"
16405 >unix password sync = no
</B
16410 NAME=
"UPDATEENCRYPTED"
16412 >update encrypted (G)
</DT
16415 >This boolean parameter allows a user logging
16416 on with a plaintext password to have their encrypted (hashed)
16417 password in the smbpasswd file to be updated automatically as
16418 they log on. This option allows a site to migrate from plaintext
16419 password authentication (users authenticate with plaintext
16420 password over the wire, and are checked against a UNIX account
16421 database) to encrypted password authentication (the SMB
16422 challenge/response authentication mechanism) without forcing
16423 all users to re-enter their passwords via smbpasswd at the time the
16424 change is made. This is a convenience option to allow the change over
16425 to encrypted passwords to be made over a longer period. Once all users
16426 have encrypted representations of their passwords in the smbpasswd
16427 file this parameter should be set to
<TT
16432 >In order for this parameter to work correctly the
<A
16433 HREF=
"#ENCRYPTPASSWORDS"
16437 >encrypt passwords
</I
16441 > parameter must be set to
<TT
16445 this parameter is set to
<TT
16450 >Note that even when this parameter is set a user
16451 authenticating to
<B
16454 > must still enter a valid
16455 password in order to connect correctly, and to update their hashed
16456 (smbpasswd) passwords.
</P
16460 >update encrypted = no
</B
16467 >use rhosts (G)
</DT
16470 >If this global parameter is a true, it specifies
16471 that the UNIX users
<TT
16474 > file in their home directory
16475 will be read to find the names of hosts and users who will be allowed
16476 access without specifying a password.
</P
16486 > can be a major security hole. This is because you are
16487 trusting the PC to supply the correct username. It is very easy to
16488 get a PC to supply a false username. I recommend that the
<TT
16493 > option be only used if you really know what
16498 >use rhosts = no
</B
16542 >Multiple users may be specified in a comma-delimited
16543 list, in which case the supplied password will be tested against
16544 each username in turn (left to right).
</P
16551 > line is needed only when
16552 the PC is unable to supply its own username. This is the case
16553 for the COREPLUS protocol or where your users have different WfWg
16554 usernames to UNIX usernames. In both these cases you may also be
16555 better using the \\server\share%user syntax instead.
</P
16562 > line is not a great
16563 solution in many cases as it means Samba will try to validate
16564 the supplied password against each of the usernames in the
16570 > line in turn. This is slow and
16571 a bad idea for lots of users in case of duplicate passwords.
16572 You may get timeouts or security breaches using this parameter
16575 >Samba relies on the underlying UNIX security. This
16576 parameter does not restrict who can login, it just offers hints
16577 to the Samba server as to what usernames might correspond to the
16578 supplied password. Users can login as whoever they please and
16579 they will be able to do no more damage than if they started a
16580 telnet session. The daemon runs as the user that they log in as,
16581 so they cannot do anything that user cannot do.
</P
16583 >To restrict a service to a particular set of users you
16595 >If any of the usernames begin with a '@' then the name
16596 will be looked up first in the yp netgroups list (if Samba
16597 is compiled with netgroup support), followed by a lookup in
16598 the UNIX groups database and will expand to a list of all users
16599 in the group of that name.
</P
16601 >If any of the usernames begin with a '+' then the name
16602 will be looked up only in the UNIX groups database and will
16603 expand to a list of all users in the group of that name.
</P
16605 >If any of the usernames begin with a '
&'then the name
16606 will be looked up only in the yp netgroups database (if Samba
16607 is compiled with netgroup support) and will expand to a list
16608 of all users in the netgroup group of that name.
</P
16610 >Note that searching though a groups database can take
16611 quite some time, and some clients may time out during the
16614 >See the section
<A
16617 USERNAME/PASSWORD VALIDATION
</A
16618 > for more information on how
16619 this parameter determines access to the services.
</P
16623 >The guest account if a guest service,
16624 else
<empty string
>.
</B
16629 >username = fred, mary, jack, jane,
16630 @users, @pcgroup
</B
16635 NAME=
"USERNAMELEVEL"
16637 >username level (G)
</DT
16640 >This option helps Samba to try and 'guess' at
16641 the real UNIX username, as many DOS clients send an all-uppercase
16642 username. By default Samba tries all lowercase, followed by the
16643 username with the first letter capitalized, and fails if the
16644 username is not found on the UNIX machine.
</P
16646 >If this parameter is set to non-zero the behavior changes.
16647 This parameter is a number that specifies the number of uppercase
16648 combinations to try while trying to determine the UNIX user name. The
16649 higher the number the more combinations will be tried, but the slower
16650 the discovery of usernames will be. Use this parameter when you have
16651 strange usernames on your UNIX machine, such as
<TT
16659 >username level =
0</B
16664 >username level =
5</B
16671 >username map (G)
</DT
16674 >This option allows you to specify a file containing
16675 a mapping of usernames from the clients to the server. This can be
16676 used for several purposes. The most common is to map usernames
16677 that users use on DOS or Windows machines to those that the UNIX
16678 box uses. The other is to map multiple users to a single username
16679 so that they can more easily share files.
</P
16681 >The map file is parsed line by line. Each line should
16682 contain a single UNIX username on the left then a '=' followed
16683 by a list of usernames on the right. The list of usernames on the
16684 right may contain names of the form @group in which case they
16685 will match any UNIX username in that group. The special client
16686 name '*' is a wildcard and matches any name. Each line of the
16687 map file may be up to
1023 characters long.
</P
16689 >The file is processed on each line by taking the
16690 supplied username and comparing it with each username on the right
16691 hand side of the '=' signs. If the supplied name matches any of
16692 the names on the right hand side then it is replaced with the name
16693 on the left. Processing then continues with the next line.
</P
16695 >If any line begins with a '#' or a ';' then it is
16698 >If any line begins with an '!' then the processing
16699 will stop after that line if a mapping was done by the line.
16700 Otherwise mapping continues with every line being processed.
16701 Using '!' is most useful when you have a wildcard mapping line
16702 later in the file.
</P
16704 >For example to map from the name
<TT
16711 > to the UNIX name
<TT
16714 > you would use:
</P
16718 >root = admin administrator
</B
16721 >Or to map anyone in the UNIX group
<TT
16725 to the UNIX name
<TT
16728 > you would use:
</P
16735 >You can have as many mappings as you like in a username
16738 >If your system supports the NIS NETGROUP option then
16739 the netgroup database is checked before the
<TT
16743 > database for matching groups.
</P
16745 >You can map Windows usernames that have spaces in them
16746 by using double quotes around the name. For example:
</P
16750 >tridge =
"Andrew Tridgell"</B
16753 >would map the windows username
"Andrew Tridgell" to the
16754 unix username
"tridge".
</P
16756 >The following example would map mary and fred to the
16757 unix user sys, and map the rest to guest. Note the use of the
16758 '!' to tell Samba to stop processing if it gets a match on
16768 CLASS=
"PROGRAMLISTING"
16777 >Note that the remapping is applied to all occurrences
16778 of usernames. Thus if you connect to \\server\fred and
<TT
16781 > is remapped to
<TT
16785 will actually be connecting to \\server\mary and will need to
16786 supply a password suitable for
<TT
16793 >. The only exception to this is the
16794 username passed to the
<A
16795 HREF=
"#PASSWORDSERVER"
16799 > password server
</I
16802 > (if you have one). The password
16803 server will receive whatever username the client supplies without
16806 >Also note that no reverse mapping is done. The main effect
16807 this has is with printing. Users who have been mapped may have
16808 trouble deleting print jobs as PrintManager under WfWg will think
16809 they don't own the print job.
</P
16812 >no username map
</EM
16817 >username map = /usr/local/samba/lib/users.map
16828 >This boolean parameter is only available if
16829 Samba has been configured and compiled with the option
<B
16832 >. If set to True then Samba will attempt
16833 to add utmp or utmpx records (depending on the UNIX system) whenever a
16834 connection is made to a Samba server. Sites may use this to record the
16835 user connecting to a Samba share.
</P
16838 HREF=
"#UTMPDIRECTORY"
16842 > utmp directory
</I
16854 NAME=
"UTMPDIRECTORY"
16856 >utmp directory(G)
</DT
16859 >This parameter is only available if Samba has
16860 been configured and compiled with the option
<B
16863 >. It specifies a directory pathname that is
16864 used to store the utmp or utmpx files (depending on the UNIX system) that
16865 record user connections to a Samba server. See also the
<A
16873 > parameter. By default this is
16874 not set, meaning the system will use whatever utmp file the
16875 native system is set to use (usually
16882 >no utmp directory
</EM
16889 >valid chars (G)
</DT
16892 >The option allows you to specify additional
16893 characters that should be considered valid by the server in
16894 filenames. This is particularly useful for national character
16895 sets, such as adding u-umlaut or a-ring.
</P
16897 >The option takes a list of characters in either integer
16898 or character form with spaces between them. If you give two
16899 characters with a colon between them then it will be taken as
16900 an lowercase:uppercase pair.
</P
16902 >If you have an editor capable of entering the characters
16903 into the config file then it is probably easiest to use this
16904 method. Otherwise you can specify the characters in octal,
16905 decimal or hexadecimal form using the usual C notation.
</P
16907 >For example to add the single character 'Z' to the charset
16908 (which is a pointless thing to do as it's already there) you could
16909 do one of the following
</P
16918 CLASS=
"PROGRAMLISTING"
16921 valid chars =
0132:
0172
16928 >The last two examples above actually add two characters,
16929 and alter the uppercase and lowercase mappings appropriately.
</P
16933 > specify this parameter
16937 >client code page
</I
16940 have both set. If
<TT
16943 >client code page
</I
16951 > parameter the
<TT
16957 > settings will be overwritten.
</P
16960 HREF=
"#CLIENTCODEPAGE"
16971 >Samba defaults to using a reasonable set
16972 of valid characters for English systems
</EM
16977 >valid chars =
0345:
0305 0366:
0326 0344:
0304
16981 >The above example allows filenames to have the Swedish
16982 characters in them.
</P
16986 > It is actually quite difficult to
16987 correctly produce a
<TT
16993 a particular system. To automate the process
<A
16994 HREF=
"mailto:tino@augsburg.net"
16996 >tino@augsburg.net
</A
16998 a package called
<B
17001 > which will automatically
17002 produce a complete
<TT
17008 a given client system. Look in the
<TT
17010 >examples/validchars/
17012 > subdirectory of your Samba source code distribution
17013 for this package.
</P
17019 >valid users (S)
</DT
17022 >This is a list of users that should be allowed
17023 to login to this service. Names starting with '@', '+' and '
&'
17024 are interpreted using the same rules as described in the
17032 >If this is empty (the default) then any user can login.
17033 If a username is in both this list and the
<TT
17039 > list then access is denied for that user.
</P
17041 >The current servicename is substituted for
<TT
17047 >. This is useful in the [homes] section.
</P
17050 HREF=
"#INVALIDUSERS"
17061 >No valid users list (anyone can login)
17067 >valid users = greg, @pcusers
</B
17077 >This is a list of files and directories that
17078 are neither visible nor accessible. Each entry in the list must
17079 be separated by a '/', which allows spaces to be included
17080 in the entry. '*' and '?' can be used to specify multiple files
17081 or directories as in DOS wildcards.
</P
17083 >Each entry must be a unix path, not a DOS path and
17086 > include the unix directory
17095 is applicable in vetoing files.
</P
17097 >One feature of the veto files parameter that it is important
17098 to be aware of, is that if a directory contains nothing but files
17099 that match the veto files parameter (which means that Windows/DOS
17100 clients cannot ever see them) is deleted, the veto files within
17102 >are automatically deleted
</EM
17104 with it, if the user has UNIX permissions to do so.
</P
17106 >Setting this parameter will affect the performance
17107 of Samba, as it will be forced to check all files and directories
17108 for a match as they are scanned.
</P
17120 HREF=
"#CASESENSITIVE"
17124 > case sensitive
</I
17130 >No files or directories are vetoed.
17141 CLASS=
"PROGRAMLISTING"
17142 > ; Veto any files containing the word Security,
17143 ; any ending in .tmp, and any directory containing the
17145 veto files = /*Security*/*.tmp/*root*/
17147 ; Veto the Apple specific files that a NetAtalk server
17149 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
17158 NAME=
"VETOOPLOCKFILES"
17160 >veto oplock files (S)
</DT
17163 >This parameter is only valid when the
<A
17172 parameter is turned on for a share. It allows the Samba administrator
17173 to selectively turn off the granting of oplocks on selected files that
17174 match a wildcarded list, similar to the wildcarded list used in the
17187 >No files are vetoed for oplock
17191 >You might want to do this on files that you know will
17192 be heavily contended for by clients. A good example of this
17193 is in the NetBench SMB benchmark program, which causes heavy
17194 client contention for files ending in
<TT
17198 To cause Samba not to grant oplocks on these files you would use
17199 the line (either in the [global] section or in the section for
17200 the particular NetBench share :
</P
17204 >veto oplock files = /*;.SEM/
17212 >vfs object (S)
</DT
17215 >This parameter specifies a shared object file that
17216 is used for Samba VFS I/O operations. By default, normal
17217 disk I/O operations are used but these can be overloaded
17218 with a VFS object. The Samba VFS layer is new to Samba
2.2 and
17219 must be enabled at compile time with --with-vfs.
</P
17229 >vfs options (S)
</DT
17232 >This parameter allows parameters to be passed
17233 to the vfs layer at initialisation time. The Samba VFS layer
17234 is new to Samba
2.2 and must be enabled at compile time
17235 with --with-vfs. See also
<A
17256 > This allows you to override the volume label
17257 returned for a share. Useful for CDROMs with installation programs
17258 that insist on a particular volume label.
</P
17261 >the name of the share
</EM
17268 >wide links (S)
</DT
17271 >This parameter controls whether or not links
17272 in the UNIX file system may be followed by the server. Links
17273 that point to areas within the directory tree exported by the
17274 server are always allowed; this parameter controls access only
17275 to areas that are outside the directory tree being exported.
</P
17277 >Note that setting this parameter can have a negative
17278 effect on your server performance due to the extra system calls
17279 that Samba has to do in order to perform the link checks.
</P
17283 >wide links = yes
</B
17288 NAME=
"WINBINDCACHETIME"
17290 >winbind cache time
</DT
17295 > this parameter is only
17296 available in Samba
3.0.
</P
17298 >This parameter specifies the number of seconds the
17300 HREF=
"winbindd.8.html"
17303 > daemon will cache
17304 user and group information before querying a Windows NT server
17309 >winbind cache type =
15</B
17321 > this parameter is only
17322 available in Samba
3.0.
</P
17324 >The winbind gid parameter specifies the range of group
17325 ids that are allocated by the
<A
17326 HREF=
"winbindd.8.html"
17329 > daemon. This range of group ids should have no
17330 existing local or nis groups within it as strange conflicts can
17331 occur otherwise.
</P
17335 >winbind gid =
<empty string
>
17341 >winbind gid =
10000-
20000</B
17346 NAME=
"WINBINDSEPARATOR"
17348 >winbind separator
</DT
17353 > this parameter is only
17354 available in Samba
3.0.
</P
17356 >This parameter allows an admin to define the character
17357 used when listing a username of the form of
<TT
17358 CLASS=
"REPLACEABLE"
17364 CLASS=
"REPLACEABLE"
17369 is only applicable when using the
<TT
17371 >pam_winbind.so
</TT
17375 >nss_winbind.so
</TT
17376 > modules for UNIX services.
17381 >winbind separator = \
</B
17386 >winbind separator = +
</B
17398 > this parameter is only
17399 available in Samba
3.0.
</P
17401 >The winbind gid parameter specifies the range of group
17402 ids that are allocated by the
<A
17403 HREF=
"winbindd.8.html"
17406 > daemon. This range of ids should have no
17407 existing local or nis users within it as strange conflicts can
17408 occur otherwise.
</P
17412 >winbind uid =
<empty string
>
17418 >winbind uid =
10000-
20000</B
17428 >When Samba is running as a WINS server this
17429 allows you to call an external program for all changes to the
17430 WINS database. The primary use for this option is to allow the
17431 dynamic update of external name resolution databases such as
17434 >The wins hook parameter specifies the name of a script
17435 or executable that will be called as follows:
</P
17439 >wins_hook operation name nametype ttl IP_list
17447 >The first argument is the operation and is one
17448 of
"add",
"delete", or
"refresh". In most cases the operation can
17449 be ignored as the rest of the parameters provide sufficient
17450 information. Note that
"refresh" may sometimes be called when the
17451 name has not previously been added, in that case it should be treated
17456 >The second argument is the netbios name. If the
17457 name is not a legal name then the wins hook is not called.
17458 Legal names contain only letters, digits, hyphens, underscores
17463 >The third argument is the netbios name
17464 type as a
2 digit hexadecimal number.
</P
17468 >The fourth argument is the TTL (time to live)
17469 for the name in seconds.
</P
17473 >The fifth and subsequent arguments are the IP
17474 addresses currently registered for that name. If this list is
17475 empty then the name should be deleted.
</P
17479 >An example script that calls the BIND dynamic DNS update
17483 > is provided in the examples
17484 directory of the Samba source code.
</P
17490 >wins proxy (G)
</DT
17493 >This is a boolean that controls if
<A
17497 > will respond to broadcast name
17498 queries on behalf of other hosts. You may need to set this
17502 > for some older clients.
</P
17506 >wins proxy = no
</B
17513 >wins server (G)
</DT
17516 >This specifies the IP address (or DNS name: IP
17517 address for preference) of the WINS server that
<A
17521 > should register with. If you have a WINS server on
17522 your network then you should set this to the WINS server's IP.
</P
17524 >You should point this at your WINS server if you have a
17525 multi-subnetted network.
</P
17529 >. You need to set up Samba to point
17530 to a WINS server if you have multiple subnets and wish cross-subnet
17531 browsing to work correctly.
</P
17533 >See the documentation file
<TT
17537 in the docs/ directory of your Samba source distribution.
</P
17545 >wins server =
192.9.200.1</B
17552 >wins support (G)
</DT
17555 >This boolean controls if the
<A
17560 > process in Samba will act as a WINS server. You should
17561 not set this to true unless you have a multi-subnetted network and
17562 you wish a particular
<B
17565 > to be your WINS server.
17566 Note that you should
<EM
17569 on more than one machine in your network.
</P
17573 >wins support = no
</B
17583 >This controls what workgroup your server will
17584 appear to be in when queried by clients. Note that this parameter
17585 also controls the Domain name used with the
<A
17586 HREF=
"#SECURITYEQUALSDOMAIN"
17589 >security=domain
</B
17595 >set at compile time to WORKGROUP
</EM
17600 >workgroup = MYGROUP
</B
17618 > for people who can't spell :-).
</P
17622 NAME=
"WRITECACHESIZE"
17624 >write cache size (S)
</DT
17627 >If this integer parameter is set to non-zero value,
17628 Samba will create an in-memory cache for each oplocked file
17632 non-oplocked files). All writes that the client does not request
17633 to be flushed directly to disk will be stored in this cache if possible.
17634 The cache is flushed onto disk when a write comes in whose offset
17635 would not fit into the cache or when the file is closed by the client.
17636 Reads for the file are also served from this cache if the data is stored
17639 >This cache allows Samba to batch client writes into a more
17640 efficient write size for RAID disks (ie. writes may be tuned to
17641 be the RAID stripe size) and can improve performance on systems
17642 where the disk subsystem is a bottleneck but there is free
17643 memory for userspace programs.
</P
17645 >The integer parameter specifies the size of this cache
17646 (per oplocked file) in bytes.
</P
17650 >write cache size =
0</B
17655 >write cache size =
262144</B
17658 >for a
256k cache size per file.
</P
17664 >write list (S)
</DT
17667 >This is a list of users that are given read-write
17668 access to a service. If the connecting user is in this list then
17669 they will be given write access, no matter what the
<A
17678 option is set to. The list can include group names using the
17681 >Note that if a user is in both the read list and the
17682 write list then they will be given write access.
</P
17697 >write list =
<empty string
>
17703 >write list = admin, root, @staff
17731 >This parameter controls whether or not the server
17732 will support raw writes SMB's when transferring data from clients.
17733 You should never need to change this parameter.
</P
17737 >write raw = yes
</B
17747 >An inverted synonym is
<A
17757 >If this parameter is
<TT
17761 of a service may not create or modify files in the service's
17764 >Note that a printable service (
<B
17766 >printable = yes
</B
17770 > allow writing to the directory
17771 (user privileges permitting), but only via spooling operations.
</P
17789 >Although the configuration file permits service names
17790 to contain spaces, your client software may not. Spaces will
17791 be ignored in comparisons anyway, so it shouldn't be a
17792 problem - but be aware of the possibility.
</P
17794 >On a similar note, many clients - especially DOS clients -
17795 limit service names to eight characters.
<A
17800 > has no such limitation, but attempts to connect from such
17801 clients will fail if they truncate the service names. For this reason
17802 you should probably keep your service names down to eight characters
17805 >Use of the [homes] and [printers] special sections make life
17806 for an administrator easy, but the various combinations of default
17807 attributes can be tricky. Take extreme care when designing these
17808 sections. In particular, ensure that the permissions on spool
17809 directories are correct.
</P
17819 >This man page is correct for version
2.2 of
17820 the Samba suite.
</P
17831 HREF=
"samba.7.html"
17836 HREF=
"smbpasswd.8.html"
17868 HREF=
"smbclient.1.html"
17876 HREF=
"nmblookup.1.html"
17884 HREF=
"testparm.1.html"
17892 HREF=
"testprns.1.html"
17909 >The original Samba software and related utilities
17910 were created by Andrew Tridgell. Samba is now developed
17911 by the Samba Team as an Open Source project similar
17912 to the way the Linux kernel is developed.
</P
17914 >The original Samba man pages were written by Karl Auer.
17915 The man page sources were converted to YODL format (another
17916 excellent piece of Open Source software, available at
17918 HREF=
"ftp://ftp.icce.rug.nl/pub/unix/"
17920 > ftp://ftp.icce.rug.nl/pub/unix/
</A
17921 >) and updated for the Samba
2.0
17922 release by Jeremy Allison. The conversion to DocBook for
17923 Samba
2.2 was done by Gerald Carter
</P