7 CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD
27 >smb.conf -- The configuration file for the Samba suite</DIV
39 > file is a configuration
40 file for the Samba suite. <TT
44 runtime configuration information for the Samba programs. The
48 > file is designed to be configured and
49 administered by the <A
57 > program. The complete description of the file format and
58 possible parameters held within are here for reference purposes.</P
68 >The file consists of sections and parameters. A section
69 begins with the name of the section in square brackets and continues
70 until the next section begins. Sections contain parameters of the
86 >The file is line-based - that is, each newline-terminated
87 line represents either a comment, a section name or a parameter.</P
89 >Section and parameter names are not case sensitive.</P
91 >Only the first equals sign in a parameter is significant.
92 Whitespace before or after the first equals sign is discarded.
93 Leading, trailing and internal whitespace in section and parameter
94 names is irrelevant. Leading and trailing whitespace in a parameter
95 value is discarded. Internal whitespace within a parameter value
96 is retained verbatim.</P
98 >Any line beginning with a semicolon (';') or a hash ('#')
99 character is ignored, as are lines containing only whitespace.</P
101 >Any line ending in a '\' is continued
102 on the next line in the customary UNIX fashion.</P
104 >The values following the equals sign in parameters are all
105 either a string (no quotes needed) or a boolean, which may be given
106 as yes/no, 0/1 or true/false. Case is not significant in boolean
107 values, but is preserved in string values. Some items such as
108 create modes are numeric.</P
116 >SECTION DESCRIPTIONS</H2
118 >Each section in the configuration file (except for the
119 [global] section) describes a shared resource (known
120 as a "share"). The section name is the name of the
121 shared resource and the parameters within the section define
122 the shares attributes.</P
124 >There are three special sections, [global],
125 [homes] and [printers], which are
127 >special sections</EM
129 following notes apply to ordinary section descriptions.</P
131 >A share consists of a directory to which access is being
132 given plus a description of the access rights which are granted
133 to the user of the service. Some housekeeping options are
136 >Sections are either file share services (used by the
137 client as an extension of their native file systems) or
138 printable services (used by the client to access print services
139 on the host running the server).</P
141 >Sections may be designated <EM
144 in which case no password is required to access them. A specified
147 > is used to define access
148 privileges in this case.</P
150 >Sections other than guest services will require a password
151 to access them. The client provides the username. As older clients
152 only provide passwords and not usernames, you may specify a list
153 of usernames to check against the password using the "user ="
154 option in the share definition. For modern clients such as
155 Windows 95/98/ME/NT/2000, this should not be necessary.</P
157 >Note that the access rights granted by the server are
158 masked by the access rights granted to the specified or guest
159 UNIX user by the host system. The server does not grant more
160 access than the host system grants.</P
162 >The following sample section defines a file space share.
163 The user has write access to the path <TT
167 The share is accessed via the share name "foo":</P
177 CLASS="COMPUTEROUTPUT"
188 >The following sample section defines a printable share.
189 The share is readonly, but printable. That is, the only write
190 access permitted is via calls to open, write to and close a
194 access will be permitted as the default guest user (specified
205 CLASS="COMPUTEROUTPUT"
207 path = /usr/spool/public
224 >SPECIAL SECTIONS</H2
231 >The [global] section</H3
233 >parameters in this section apply to the server
234 as a whole, or are defaults for sections which do not
235 specifically define certain items. See the notes
236 under PARAMETERS for more information.</P
244 >The [homes] section</H3
246 >If a section called homes is included in the
247 configuration file, services connecting clients to their
248 home directories can be created on the fly by the server.</P
250 >When the connection request is made, the existing
251 sections are scanned. If a match is found, it is used. If no
252 match is found, the requested section name is treated as a
253 user name and looked up in the local password file. If the
254 name exists and the correct password has been given, a share is
255 created by cloning the [homes] section.</P
257 >Some modifications are then made to the newly
264 >The share name is changed from homes to
265 the located username.</P
269 >If no path was given, the path is set to
270 the user's home directory.</P
274 >If you decide to use a <EM
277 in your [homes] section then you may find it useful
278 to use the %S macro. For example :</P
283 >path = /data/pchome/%S</B
287 >would be useful if you have different home directories
288 for your PCs than for UNIX access.</P
290 >This is a fast and simple way to give a large number
291 of clients access to their home directories with a minimum
294 >A similar process occurs if the requested section
295 name is "homes", except that the share name is not
296 changed to that of the requesting user. This method of using
297 the [homes] section works well if different users share
300 >The [homes] section can specify all the parameters
301 a normal service section can specify, though some make more sense
302 than others. The following is a typical and suitable [homes]
313 CLASS="COMPUTEROUTPUT"
323 >An important point is that if guest access is specified
324 in the [homes] section, all home directories will be
325 visible to all clients <EM
326 >without a password</EM
328 In the very unlikely event that this is actually desirable, it
329 would be wise to also specify <EM
337 auto home directories will be inherited from the global browseable
338 flag, not the [homes] browseable flag. This is useful as
342 the [homes] section will hide the [homes] share but make
343 any auto home directories visible.</P
351 >The [printers] section</H3
353 >This section works like [homes],
356 >If a [printers] section occurs in the
357 configuration file, users are able to connect to any printer
358 specified in the local host's printcap file.</P
360 >When a connection request is made, the existing sections
361 are scanned. If a match is found, it is used. If no match is found,
362 but a [homes] section exists, it is used as described
363 above. Otherwise, the requested section name is treated as a
364 printer name and the appropriate printcap file is scanned to see
365 if the requested section name is a valid printer share name. If
366 a match is found, a new printer share is created by cloning
367 the [printers] section.</P
369 >A few modifications are then made to the newly created
376 >The share name is set to the located printer
381 >If no printer name was given, the printer name
382 is set to the located printer name</P
386 >If the share does not permit guest access and
387 no username was given, the username is set to the located
392 >Note that the [printers] service MUST be
393 printable - if you specify otherwise, the server will refuse
394 to load the configuration file.</P
396 >Typically the path specified would be that of a
397 world-writeable spool directory with the sticky bit set on
398 it. A typical [printers] entry would look like
409 CLASS="COMPUTEROUTPUT"
411 path = /usr/spool/public
420 >All aliases given for a printer in the printcap file
421 are legitimate printer names as far as the server is concerned.
422 If your printing subsystem doesn't work like that, you will have
423 to set up a pseudo-printcap. This is a file consisting of one or
424 more lines like this:</P
434 CLASS="COMPUTEROUTPUT"
435 > alias|alias|alias|alias...
443 >Each alias should be an acceptable printer name for
444 your printing subsystem. In the [global] section, specify
445 the new file as your printcap. The server will then only recognize
446 names found in your pseudo-printcap, which of course can contain
447 whatever aliases you like. The same technique could be used
448 simply to limit access to a subset of your local printers.</P
450 >An alias, by the way, is defined as any component of the
451 first entry of a printcap record. Records are separated by newlines,
452 components (if there are more than one) are separated by vertical
453 bar symbols ('|').</P
455 >NOTE: On SYSV systems which use lpstat to determine what
456 printers are defined on the system you may be able to use
457 "printcap name = lpstat" to automatically obtain a list
458 of printers. See the "printcap name" option
470 >parameters define the specific attributes of sections.</P
472 >Some parameters are specific to the [global] section
475 >). Some parameters are usable
476 in all sections (e.g., <EM
479 are permissible only in normal sections. For the purposes of the
480 following descriptions the [homes] and [printers]
481 sections will be considered normal. The letter <EM
484 in parentheses indicates that a parameter is specific to the
485 [global] section. The letter <EM
488 indicates that a parameter can be specified in a service specific
489 section. Note that all <EM
491 > parameters can also be specified in
492 the [global] section - in which case they will define
493 the default behavior for all services.</P
495 >parameters are arranged here in alphabetical order - this may
496 not create best bedfellows, but at least you can find them! Where
497 there are synonyms, the preferred synonym is described, others refer
498 to the preferred synonym.</P
506 >VARIABLE SUBSTITUTIONS</H2
508 >Many of the strings that are settable in the config file
509 can take substitutions. For example the option "path =
510 /tmp/%u" would be interpreted as "path =
511 /tmp/john" if the user connected with the username john.</P
513 >These substitutions are mostly noted in the descriptions below,
514 but there are some general substitutions which apply whenever they
515 might be relevant. These are:</P
525 >the name of the current service, if any.</P
531 >the root directory of the current service,
538 >user name of the current service, if any.</P
544 >primary group name of %u.</P
550 >session user name (the user name that the client
551 wanted, not necessarily the same as the one they got).</P
557 >primary group name of %U.</P
563 >the home directory of the user given
570 >the Samba version.</P
576 >the Internet hostname that Samba is running
583 >the NetBIOS name of the client machine
590 >the NetBIOS name of the server. This allows you
591 to change your config based on what the client calls you. Your
592 server can have a "dual personality".</P
594 >Note that this paramater is not available when Samba listens
595 on port 445, as clients no longer send this information </P
601 >the Internet name of the client machine.
608 >the name of your NIS home directory server.
609 This is obtained from your NIS auto.map entry. If you have
610 not compiled Samba with the <EM
611 >--with-automount</EM
613 option then this value will be the same as %L.</P
619 >the path of the service's home directory,
620 obtained from your NIS auto.map entry. The NIS auto.map entry
621 is split up as "%N:%p".</P
627 >the selected protocol level after
628 protocol negotiation. It can be one of CORE, COREPLUS,
629 LANMAN1, LANMAN2 or NT1.</P
635 >The process id of the current server
642 >the architecture of the remote
643 machine. Only some are recognized, and those may not be
644 100% reliable. It currently recognizes Samba, WfWg, Win95,
645 WinNT and Win2k. Anything else will be known as
646 "UNKNOWN". If it gets it wrong then sending a level
648 HREF="mailto:samba@samba.org"
652 > should allow it to be fixed.</P
658 >The IP address of the client machine.</P
664 >the current date and time.</P
675 >The value of the environment variable
686 >There are some quite creative things that can be done
687 with these substitutions and other smb.conf options.</P
697 >Samba supports "name mangling" so that DOS and
698 Windows clients can use files that don't conform to the 8.3 format.
699 It can also be set to adjust the case of 8.3 format filenames.</P
701 >There are several options that control the way mangling is
702 performed, and they are grouped here rather than listed separately.
703 For the defaults look at the output of the testparm program. </P
705 >All of these options can be set separately for each service
706 (or globally, of course). </P
708 >The options are: </P
715 >mangle case = yes/no</DT
718 > controls if names that have characters that
719 aren't of the "default" case are mangled. For example,
720 if this is yes then a name like "Mail" would be mangled.
726 >case sensitive = yes/no</DT
729 >controls whether filenames are case sensitive. If
730 they aren't then Samba must do a filename search and match on passed
736 >default case = upper/lower</DT
739 >controls what the default case is for new
740 filenames. Default <EM
745 >preserve case = yes/no</DT
748 >controls if new files are created with the
749 case that the client passes, or if they are forced to be the
750 "default" case. Default <EM
756 >short preserve case = yes/no</DT
759 >controls if new files which conform to 8.3 syntax,
760 that is all in upper case and of suitable length, are created
761 upper case, or if they are forced to be the "default"
762 case. This option can be use with "preserve case = yes"
763 to permit long filenames to retain their case, while short names
764 are lowercased. Default <EM
771 >By default, Samba 2.2 has the same semantics as a Windows
772 NT server, in that it is case insensitive but case preserving.</P
780 >NOTE ABOUT USERNAME/PASSWORD VALIDATION</H2
782 >There are a number of ways in which a user can connect
783 to a service. The server uses the following steps in determining
784 if it will allow a connection to a specified service. If all the
785 steps fail, then the connection request is rejected. However, if one of the
786 steps succeeds, then the following steps are not checked.</P
788 >If the service is marked "guest only = yes" and the
789 server is running with share-level security ("security = share")
790 then steps 1 to 5 are skipped.</P
797 >If the client has passed a username/password
798 pair and that username/password pair is validated by the UNIX
799 system's password programs then the connection is made as that
800 username. Note that this includes the
811 >If the client has previously registered a username
812 with the system and now supplies a correct password for that
813 username then the connection is allowed.</P
817 >The client's NetBIOS name and any previously
818 used user names are checked against the supplied password, if
819 they match then the connection is allowed as the corresponding
824 >If the client has previously validated a
825 username/password pair with the server and the client has passed
826 the validation token then that username is used. </P
830 >If a "user = " field is given in the
834 > file for the service and the client
835 has supplied a password, and that password matches (according to
836 the UNIX system's password checking) with one of the usernames
837 from the "user =" field then the connection is made as
838 the username in the "user =" line. If one
839 of the username in the "user =" list begins with a
840 '@' then that name expands to a list of names in
841 the group of the same name.</P
845 >If the service is a guest service then a
846 connection is made as the username given in the "guest
847 account =" for the service, irrespective of the
848 supplied password.</P
858 >COMPLETE LIST OF GLOBAL PARAMETERS</H2
860 >Here is a list of all global parameters. See the section of
861 each parameter for details. Note that some are synonyms.</P
868 HREF="#ABORTSHUTDOWNSCRIPT"
872 >abort shutdown script</I
880 HREF="#ADDPRINTERCOMMAND"
884 >add printer command</I
892 HREF="#ADDSHARECOMMAND"
896 >add share command</I
904 HREF="#ADDUSERSCRIPT"
916 HREF="#ADDMACHINESCRIPT"
920 >add machine script</I
928 HREF="#ALGORITHMICRIDBASE"
932 >algorithmic rid base</I
940 HREF="#ALLOWTRUSTEDDOMAINS"
944 >allow trusted domains</I
964 HREF="#ANNOUNCEVERSION"
1000 HREF="#BINDINTERFACESONLY"
1004 >bind interfaces only</I
1024 HREF="#CHANGENOTIFYTIMEOUT"
1028 >change notify timeout</I
1036 HREF="#CHANGESHARECOMMAND"
1040 >change share command</I
1072 HREF="#DEBUGHIRESTIMESTAMP"
1076 >debug hires timestamp</I
1096 HREF="#DEBUGTIMESTAMP"
1144 HREF="#DEFAULTSERVICE"
1156 HREF="#DELETEPRINTERCOMMAND"
1160 >delete printer command</I
1168 HREF="#DELETESHARECOMMAND"
1172 >delete share command</I
1180 HREF="#DELETEUSERSCRIPT"
1184 >delete user script</I
1192 HREF="#DFREECOMMAND"
1204 HREF="#DISABLESPOOLSS"
1228 HREF="#DOMAINADMINGROUP"
1232 >domain admin group</I
1240 HREF="#DOMAINGUESTGROUP"
1244 >domain guest group</I
1252 HREF="#DOMAINLOGONS"
1264 HREF="#DOMAINMASTER"
1276 HREF="#ENCRYPTPASSWORDS"
1280 >encrypt passwords</I
1288 HREF="#ENHANCEDBROWSING"
1292 >enhanced browsing</I
1300 HREF="#ENUMPORTSCOMMAND"
1304 >enumports command</I
1324 HREF="#HIDELOCALUSERS"
1328 >hide local users</I
1336 HREF="#HIDEUNREADABLE"
1408 HREF="#KERNELOPLOCKS"
1432 HREF="#LARGEREADWRITE"
1492 HREF="#LDAPUSERSUFFIX"
1504 HREF="#LDAPMACHINESUFFIX"
1540 HREF="#LOADPRINTERS"
1576 HREF="#LOCKDIRECTORY"
1588 HREF="#LOCKSPINCOUNT"
1600 HREF="#LOCKSPINTIME"
1612 HREF="#PIDDIRECTORY"
1696 HREF="#LPQCACHETIME"
1708 HREF="#MACHINEPASSWORDTIMEOUT"
1712 >machine password timeout</I
1720 HREF="#MANGLEDSTACK"
1780 HREF="#MAXOPENFILES"
1804 HREF="#MAXSMBDPROCESSES"
1808 >max smbd processes</I
1852 HREF="#MESSAGECOMMAND"
1864 HREF="#MINPASSWDLENGTH"
1868 >min passwd length</I
1876 HREF="#MINPASSWORDLENGTH"
1880 >min password length</I
1912 HREF="#NAMERESOLVEORDER"
1916 >name resolve order</I
1924 HREF="#NETBIOSALIASES"
1948 HREF="#NETBIOSSCOPE"
1972 HREF="#NONUNIXACCOUNTRANGE"
1976 >non unix account range</I
1984 HREF="#NTPIPESUPPORT"
1996 HREF="#NTSTATUSSUPPORT"
2000 >nt status support</I
2008 HREF="#NULLPASSWORDS"
2020 HREF="#OBEYPAMRESTRICTIONS"
2024 >obey pam restrictions</I
2032 HREF="#OPLOCKBREAKWAITTIME"
2036 >oplock break wait time</I
2056 HREF="#OS2DRIVERMAP"
2068 HREF="#PAMPASSWORDCHANGE"
2072 >pam password change</I
2092 HREF="#PASSDBBACKEND"
2116 HREF="#PASSWDCHATDEBUG"
2120 >passwd chat debug</I
2128 HREF="#PASSWDPROGRAM"
2140 HREF="#PASSWORDLEVEL"
2152 HREF="#PASSWORDSERVER"
2164 HREF="#PREFEREDMASTER"
2176 HREF="#PREFERREDMASTER"
2180 >preferred master</I
2212 HREF="#PRINTCAPNAME"
2224 HREF="#PRINTERDRIVERFILE"
2228 >printer driver file</I
2296 HREF="#REMOTEANNOUNCE"
2308 HREF="#REMOTEBROWSESYNC"
2312 >remote browse sync</I
2320 HREF="#RESTRICTANONYMOUS"
2324 >restrict anonymous</I
2356 HREF="#ROOTDIRECTORY"
2380 HREF="#SERVERSTRING"
2392 HREF="#SHOWADDPRINTERWIZARD"
2396 >show add printer wizard</I
2404 HREF="#SHUTDOWNSCRIPT"
2416 HREF="#SMBPASSWDFILE"
2428 HREF="#SOCKETADDRESS"
2440 HREF="#SOCKETOPTIONS"
2452 HREF="#SOURCEENVIRONMENT"
2456 >source environment</I
2488 HREF="#STATCACHESIZE"
2536 HREF="#TEMPLATEHOMEDIR"
2540 >template homedir</I
2548 HREF="#TEMPLATESHELL"
2584 HREF="#TIMESTAMPLOGS"
2596 HREF="#TOTALPRINTJOBS"
2600 >total print jobs</I
2608 HREF="#UNIXEXTENSIONS"
2620 HREF="#UNIXPASSWORDSYNC"
2624 >unix password sync</I
2632 HREF="#UPDATEENCRYPTED"
2636 >update encrypted</I
2668 HREF="#USERNAMELEVEL"
2704 HREF="#UTMPDIRECTORY"
2716 HREF="#WINBINDCACHETIME"
2720 >winbind cache time</I
2728 HREF="#WINBINDENUMUSERS"
2732 >winbind enum users</I
2740 HREF="#WINBINDENUMGROUPS"
2744 >winbind enum groups</I
2764 HREF="#WINBINDSEPARATOR"
2768 >winbind separator</I
2788 HREF="#WINBINDUSEDEFAULTDOMAIN"
2792 >winbind use default domain</I
2877 >COMPLETE LIST OF SERVICE PARAMETERS</H2
2879 >Here is a list of all service parameters. See the section on
2880 each parameter for details. Note that some are synonyms.</P
2923 HREF="#BLOCKINGLOCKS"
2959 HREF="#CASESENSITIVE"
2971 HREF="#CASESIGNAMES"
3055 HREF="#DEFAULTDEVMODE"
3067 HREF="#DELETEREADONLY"
3079 HREF="#DELETEVETOFILES"
3083 >delete veto files</I
3115 HREF="#DIRECTORYMASK"
3127 HREF="#DIRECTORYMODE"
3139 HREF="#DIRECTORYSECURITYMASK"
3143 >directory security mask</I
3175 HREF="#DOSFILETIMERESOLUTION"
3179 >dos filetime resolution</I
3187 HREF="#DOSFILETIMES"
3211 HREF="#FAKEDIRECTORYCREATETIMES"
3215 >fake directory create times</I
3235 HREF="#FOLLOWSYMLINKS"
3247 HREF="#FORCECREATEMODE"
3251 >force create mode</I
3259 HREF="#FORCEDIRECTORYMODE"
3263 >force directory mode</I
3271 HREF="#FORCEDIRECTORYSECURITYMODE"
3275 >force directory security mode</I
3295 HREF="#FORCESECURITYMODE"
3299 >force security mode</I
3343 HREF="#GUESTACCOUNT"
3379 HREF="#HIDEDOTFILES"
3451 HREF="#INHERITPERMISSIONS"
3455 >inherit permissions</I
3463 HREF="#INVALIDUSERS"
3475 HREF="#LEVEL2OPLOCKS"
3499 HREF="#LPPAUSECOMMAND"
3523 HREF="#LPRESUMECOMMAND"
3527 >lpresume command</I
3595 HREF="#MANGLEDNAMES"
3607 HREF="#MANGLINGCHAR"
3655 HREF="#MAXCONNECTIONS"
3667 HREF="#MAXPRINTJOBS"
3679 HREF="#MINPRINTSPACE"
3703 HREF="#NTACLSUPPORT"
3739 HREF="#OPLOCKCONTENTIONLIMIT"
3743 >oplock contention limit</I
3775 HREF="#POSIXLOCKING"
3823 HREF="#PREEXECCLOSE"
3835 HREF="#PRESERVECASE"
3847 HREF="#PRINTCOMMAND"
3895 HREF="#PRINTERADMIN"
3907 HREF="#PRINTERDRIVER"
3919 HREF="#PRINTERDRIVERLOCATION"
3923 >printer driver location</I
3967 HREF="#QUEUEPAUSECOMMAND"
3971 >queuepause command</I
3979 HREF="#QUEUERESUMECOMMAND"
3983 >queueresume command</I
4015 HREF="#ROOTPOSTEXEC"
4039 HREF="#ROOTPREEXECCLOSE"
4043 >root preexec close</I
4051 HREF="#SECURITYMASK"
4063 HREF="#SETDIRECTORY"
4087 HREF="#SHORTPRESERVECASE"
4091 >short preserve case</I
4111 HREF="#STRICTALLOCATE"
4123 HREF="#STRICTLOCKING"
4159 HREF="#USECLIENTDRIVER"
4163 >use client driver</I
4231 HREF="#VETOOPLOCKFILES"
4235 >veto oplock files</I
4303 HREF="#WRITECACHESIZE"
4307 >write cache size</I
4356 >EXPLANATION OF EACH PARAMETER</H2
4360 CLASS="VARIABLELIST"
4364 NAME="ABORTSHUTDOWNSCRIPT"
4366 >abort shutdown script (G)</DT
4370 >This parameter only exists in the HEAD cvs branch</EM
4372 This a full path name to a script called by
4381 should stop a shutdown procedure issued by the <A
4382 HREF="#SHUTDOWNSCRIPT"
4391 >This command will be run as user.</P
4399 >abort shutdown script = /sbin/shutdown -c</B
4404 NAME="ADDPRINTERCOMMAND"
4406 >add printer command (G)</DT
4409 >With the introduction of MS-RPC based printing
4410 support for Windows NT/2000 clients in Samba 2.2, The MS Add
4411 Printer Wizard (APW) icon is now also available in the
4412 "Printers..." folder displayed a share listing. The APW
4413 allows for printers to be add remotely to a Samba or Windows
4414 NT/2000 print server.</P
4416 >For a Samba host this means that the printer must be
4417 physically added to the underlying printing system. The <TT
4423 > defines a script to be run which
4424 will perform the necessary operations for adding the printer
4425 to the print system and to add the appropriate service definition
4429 > file in order that it can be
4443 >add printer command</I
4446 automatically invoked with the following parameter (in
4501 >Windows 9x driver location</I
4508 >All parameters are filled in from the PRINTER_INFO_2 structure sent
4509 by the Windows NT/2000 client with one exception. The "Windows 9x
4510 driver location" parameter is included for backwards compatibility
4511 only. The remaining fields in the structure are generated from answers
4512 to the APW questions.</P
4517 >add printer command</I
4523 > will reparse the <TT
4526 > to determine if the share defined by the APW
4527 exists. If the sharename is still invalid, then <B
4531 > will return an ACCESS_DENIED error to the client.</P
4534 HREF="#DELETEPRINTERCOMMAND"
4538 > delete printer command</I
4551 HREF="#SHOWADDPRINTERWIZARD"
4567 >addprinter command = /usr/bin/addprinter
4573 NAME="ADDSHARECOMMAND"
4575 >add share command (G)</DT
4578 >Samba 2.2.0 introduced the ability to dynamically
4579 add and delete shares via the Windows NT 4.0 Server Manager. The
4583 >add share command</I
4585 > is used to define an
4586 external program or script which will add a new service definition
4590 >. In order to successfully
4594 >add share command</I
4600 requires that the administrator be connected using a root account (i.e.
4607 > will automatically invoke the
4611 >add share command</I
4613 > with four parameters.
4639 > - the name of the new
4650 > - path to an **existing**
4661 > - comment string to associate
4667 > This parameter is only used for add file shares. To add printer shares,
4669 HREF="#ADDPRINTERCOMMAND"
4681 HREF="#CHANGESHARECOMMAND"
4690 HREF="#DELETESHARECOMMAND"
4707 >add share command = /usr/local/bin/addshare</B
4712 NAME="ADDMACHINESCRIPT"
4714 >add machine script (G)</DT
4717 >This is the full pathname to a script that will
4722 > when a machine is added
4723 to it's domain using the administrator username and password method. </P
4725 >This option is only required when using sam back-ends tied to the
4726 Unix uid method of RID calculation such as smbpasswd. This option is only
4727 available in Samba 3.0.</P
4731 >add machine script = <empty string>
4737 >add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u
4743 NAME="ADDUSERSCRIPT"
4745 >add user script (G)</DT
4748 >This is the full pathname to a script that will
4756 > under special circumstances described below.</P
4758 >Normally, a Samba server requires that UNIX users are
4759 created for all users accessing files on this server. For sites
4760 that use Windows NT account databases as their primary user database
4761 creating these users and keeping the user list in sync with the
4762 Windows NT PDC is an onerous task. This option allows <A
4766 > to create the required UNIX users
4769 > when a user accesses the Samba server.</P
4771 >In order to use this option, <A
4781 >security = share</I
4790 must be set to a full pathname for a script that will create a UNIX
4791 user given one argument of <TT
4796 >, which expands into
4797 the UNIX user name to create.</P
4799 >When the Windows user attempts to access the Samba server,
4800 at login (session setup in the SMB protocol) time, <A
4810 attempts to authenticate the given user with the given password. If the
4811 authentication succeeds then <B
4815 attempts to find a UNIX user in the UNIX password database to map the
4816 Windows user into. If this lookup fails, and <TT
4826 call the specified script <EM
4834 > argument to be the user name to create.</P
4836 >If this script successfully creates the user then <B
4840 > will continue on as though the UNIX user
4841 already existed. In this way, UNIX users are dynamically created to
4842 match existing Windows NT accounts.</P
4853 HREF="#PASSWORDSERVER"
4862 HREF="#DELETEUSERSCRIPT"
4874 >add user script = <empty string>
4880 >add user script = /usr/local/samba/bin/add_user
4886 NAME="ADDGROUPSCRIPT"
4888 >add group script (G)</DT
4891 >This is the full pathname to a script that will
4897 >smbd(8) when a new group is requested. It will expand any <TT
4902 > to the group name passed. This script is only useful for installations using the Windows NT domain administration tools.
4910 >admin users (S)</DT
4913 >This is a list of users who will be granted
4914 administrative privileges on the share. This means that they
4915 will do all file operations as the super-user (root).</P
4917 >You should use this option very carefully, as any user in
4918 this list will be able to do anything they like on the share,
4919 irrespective of file permissions.</P
4927 >admin users = jason</B
4934 >allow hosts (S)</DT
4949 NAME="ALGORITHMICRIDBASE"
4951 >algorithmic rid base (G)</DT
4954 >This determines how Samba will use its
4955 algorithmic mapping from uids/gid to the RIDs needed to construct
4956 NT Security Identifiers.</P
4958 >Setting this option to a larger value could be useful to sites
4959 transitioning from WinNT and Win2k, as existing user and
4960 group rids would otherwise clash with sytem users etc.
4963 >All UIDs and GIDs must be able to be resolved into SIDs for
4964 the correct operation of ACLs on the server. As such the algorithmic
4965 mapping can't be 'turned off', but pushing it 'out of the way' should
4966 resolve the issues. Users and groups can then be assigned 'low' RIDs
4967 in arbitary-rid supporting backends. </P
4971 >algorithmic rid base = 1000</B
4976 >algorithmic rid base = 100000</B
4981 NAME="ALLOWTRUSTEDDOMAINS"
4983 >allow trusted domains (G)</DT
4986 >This option only takes effect when the <A
5002 If it is set to no, then attempts to connect to a resource from
5003 a domain or workgroup other than the one which <A
5008 in will fail, even if that domain is trusted by the remote server
5009 doing the authentication.</P
5011 >This is useful if you only want your Samba server to
5012 serve resources to users in the domain it is a member of. As
5013 an example, suppose that there are two domains DOMA and DOMB. DOMB
5014 is trusted by DOMA, which contains the Samba server. Under normal
5015 circumstances, a user with an account in DOMB can then access the
5016 resources of a UNIX account with the same account name on the
5017 Samba server even if they do not have an account in DOMA. This
5018 can make implementing a security boundary difficult.</P
5022 >allow trusted domains = yes</B
5029 >announce as (G)</DT
5032 >This specifies what type of server
5041 will announce itself as, to a network neighborhood browse
5042 list. By default this is set to Windows NT. The valid options
5043 are : "NT Server" (which can also be written as "NT"),
5044 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
5045 Windows NT Workstation, Windows 95 and Windows for Workgroups
5046 respectively. Do not change this parameter unless you have a
5047 specific need to stop Samba appearing as an NT server as this
5048 may prevent Samba servers from participating as browser servers
5053 >announce as = NT Server</B
5058 >announce as = Win95</B
5063 NAME="ANNOUNCEVERSION"
5065 >announce version (G)</DT
5068 >This specifies the major and minor version numbers
5069 that nmbd will use when announcing itself as a server. The default
5070 is 4.2. Do not change this parameter unless you have a specific
5071 need to set a Samba server to be a downlevel server.</P
5075 >announce version = 4.5</B
5080 >announce version = 2.0</B
5087 >auto services (G)</DT
5090 >This is a synonym for the <A
5104 >auth methods (G)</DT
5107 >This option allows the administrator to chose what
5108 authentication methods <B
5111 > will use when authenticating
5112 a user. This option defaults to sensible values based on <A
5122 Each entry in the list attempts to authenticate the user in turn, until
5123 the user authenticates. In practice only one method will ever actually
5124 be able to complete the authentication.
5129 >auth methods = <empty string></B
5134 >auth methods = guest sam ntdomain</B
5144 >This parameter lets you "turn off" a service. If
5153 attempts to connect to the service will fail. Such failures are
5163 NAME="BINDINTERFACESONLY"
5165 >bind interfaces only (G)</DT
5168 >This global parameter allows the Samba admin
5169 to limit what interfaces on a machine will serve SMB requests. If
5170 affects file service <A
5182 >For name service it causes <B
5186 to ports 137 and 138 on the interfaces listed in the <A
5193 > also binds to the "all addresses" interface (0.0.0.0)
5194 on ports 137 and 138 for the purposes of reading broadcast messages.
5195 If this option is not set then <B
5199 name requests on all of these sockets. If <TT
5209 source address of any packets coming in on the broadcast sockets
5210 and discard any that don't match the broadcast addresses of the
5211 interfaces in the <TT
5217 As unicast packets are received on the other sockets it allows
5221 > to refuse to serve names to machines that
5222 send packets that arrive through any interfaces not listed in the
5228 > list. IP Source address spoofing
5229 does defeat this simple check, however so it must not be used
5230 seriously as a security feature for <B
5235 >For file service it causes <A
5240 to bind only to the interface list given in the <A
5243 > parameter. This restricts the networks that
5247 > will serve to packets coming in those
5248 interfaces. Note that you should not use this parameter for machines
5249 that are serving PPP or other intermittent or non-broadcast network
5250 interfaces as it will not cope with non-permanent interfaces.</P
5255 >bind interfaces only</I
5258 unless the network address <EM
5267 HREF="smbpasswd.8.html"
5282 not work as expected due to the reasons covered below.</P
5284 >To change a users SMB password, the <B
5288 by default connects to the <EM
5289 >localhost - 127.0.0.1</EM
5291 address as an SMB client to issue the password change request. If
5295 >bind interfaces only</I
5297 > is set then unless the
5306 > parameter list then <B
5309 > will fail to connect in it's default mode.
5313 > can be forced to use the primary IP interface
5314 of the local host by using its <A
5315 HREF="smbpasswd.8.html#minusr"
5329 > parameter, with <TT
5335 to the IP name of the primary interface of the local host.</P
5340 > status page tries to connect with
5350 > to determine if they are running.
5360 "not running" even if they really are. This can prevent <B
5363 > from starting/stopping/restarting <B
5374 >bind interfaces only = no</B
5379 NAME="BLOCKINGLOCKS"
5381 >blocking locks (S)</DT
5384 >This parameter controls the behavior of <A
5388 > when given a request by a client
5389 to obtain a byte range lock on a region of an open file, and the
5390 request has a time limit associated with it.</P
5392 >If this parameter is set and the lock range requested
5393 cannot be immediately satisfied, Samba 2.2 will internally
5394 queue the lock request, and periodically attempt to obtain
5395 the lock until the timeout period expires.</P
5397 >If this parameter is set to <TT
5401 Samba 2.2 will behave as previous versions of Samba would and
5402 will fail the lock request immediately if the lock range
5403 cannot be obtained.</P
5407 >blocking locks = yes</B
5431 >browse list (G)</DT
5434 >This controls whether <A
5441 > will serve a browse list to
5449 >. You should never need to change
5454 >browse list = yes</B
5464 >This controls whether this share is seen in
5465 the list of available shares in a net view and in the browse list.</P
5469 >browseable = yes</B
5474 NAME="CASESENSITIVE"
5476 >case sensitive (S)</DT
5479 >See the discussion in the section <A
5486 >case sensitive = no</B
5493 >casesignames (S)</DT
5497 HREF="#CASESENSITIVE"
5504 NAME="CHANGENOTIFYTIMEOUT"
5506 >change notify timeout (G)</DT
5509 >This SMB allows a client to tell a server to
5510 "watch" a particular directory for any changes and only reply to
5511 the SMB request when a change has occurred. Such constant scanning of
5512 a directory is expensive under UNIX, hence an <A
5519 > daemon only performs such a scan
5520 on each requested directory once every <TT
5530 >change notify timeout = 60</B
5535 >change notify timeout = 300</B
5538 >Would change the scan time to every 5 minutes.</P
5542 NAME="CHANGESHARECOMMAND"
5544 >change share command (G)</DT
5547 >Samba 2.2.0 introduced the ability to dynamically
5548 add and delete shares via the Windows NT 4.0 Server Manager. The
5552 >change share command</I
5554 > is used to define an
5555 external program or script which will modify an existing service definition
5559 >. In order to successfully
5563 >change share command</I
5569 requires that the administrator be connected using a root account (i.e.
5576 > will automatically invoke the
5580 >change share command</I
5582 > with four parameters.
5608 > - the name of the new
5619 > - path to an **existing**
5630 > - comment string to associate
5636 > This parameter is only used modify existing file shares definitions. To modify
5637 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
5641 HREF="#ADDSHARECOMMAND"
5650 HREF="#DELETESHARECOMMAND"
5667 >change share command = /usr/local/bin/addshare</B
5677 >This is a text field that is seen next to a share
5678 when a client does a queries the server, either via the network
5679 neighborhood or via <B
5682 > to list what shares
5685 >If you want to set the string that is displayed next to the
5686 machine name then see the <A
5687 HREF="#SERVERSTRING"
5697 >No comment string</EM
5702 >comment = Fred's Files</B
5709 >config file (G)</DT
5712 >This allows you to override the config file
5713 to use, instead of the default (usually <TT
5717 There is a chicken and egg problem here as this option is set
5718 in the config file!</P
5720 >For this reason, if the name of the config file has changed
5721 when the parameters are loaded then it will reload them from
5722 the new config file.</P
5724 >This option takes the usual substitutions, which can
5727 >If the config file doesn't exist then it won't be loaded
5728 (allowing you to special case the config files of just a few
5733 >config file = /usr/local/samba/lib/smb.conf.%m
5744 >This parameter allows you to "clone" service
5745 entries. The specified service is simply duplicated under the
5746 current service's name. Any parameters specified in the current
5747 section will override those in the section being copied.</P
5749 >This feature lets you set up a 'template' service and
5750 create similar services easily. Note that the service being
5751 copied must occur earlier in the configuration file than the
5752 service doing the copying.</P
5760 >copy = otherservice</B
5767 >create mask (S)</DT
5770 >A synonym for this parameter is
5782 >When a file is created, the necessary permissions are
5783 calculated according to the mapping from DOS modes to UNIX
5784 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
5785 with this parameter. This parameter may be thought of as a bit-wise
5786 MASK for the UNIX modes of a file. Any bit <EM
5789 set here will be removed from the modes set on a file when it is
5792 >The default value of this parameter removes the
5793 'group' and 'other' write and execute bits from the UNIX modes.</P
5795 >Following this Samba will bit-wise 'OR' the UNIX mode created
5796 from this parameter with the value of the <A
5797 HREF="#FORCECREATEMODE"
5801 >force create mode</I
5805 parameter which is set to 000 by default.</P
5807 >This parameter does not affect directory modes. See the
5809 HREF="#DIRECTORYMODE"
5820 HREF="#FORCECREATEMODE"
5828 > parameter for forcing particular mode
5829 bits to be set on created files. See also the <A
5830 HREF="#DIRECTORYMODE"
5837 > parameter for masking
5838 mode bits on created directories. See also the <A
5839 HREF="#INHERITPERMISSIONS"
5843 >inherit permissions</I
5848 >Note that this parameter does not apply to permissions
5849 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
5850 a mask on access control lists also, they need to set the <A
5851 HREF="#SECURITYMASK"
5862 >create mask = 0744</B
5867 >create mask = 0775</B
5874 >create mode (S)</DT
5877 >This is a synonym for <A
5894 >This stands for <EM
5895 >client-side caching
5897 >, and specifies how clients capable of offline
5898 caching will cache the files in the share. The valid values
5899 are: manual, documents, programs, disable.</P
5901 >These values correspond to those used on Windows
5904 >For example, shares containing roaming profiles can have
5905 offline caching disabled using <B
5907 >csc policy = disable
5913 >csc policy = manual</B
5918 >csc policy = programs</B
5928 >The value of the parameter (a decimal integer)
5929 represents the number of minutes of inactivity before a connection
5930 is considered dead, and it is disconnected. The deadtime only takes
5931 effect if the number of open files is zero.</P
5933 >This is useful to stop a server's resources being
5934 exhausted by a large number of inactive connections.</P
5936 >Most clients have an auto-reconnect feature when a
5937 connection is broken so in most cases this parameter should be
5938 transparent to users.</P
5940 >Using this parameter with a timeout of a few minutes
5941 is recommended for most systems.</P
5943 >A deadtime of zero indicates that no auto-disconnection
5944 should be performed.</P
5958 NAME="DEBUGHIRESTIMESTAMP"
5960 >debug hires timestamp (G)</DT
5963 >Sometimes the timestamps in the log messages
5964 are needed with a resolution of higher that seconds, this
5965 boolean parameter adds microsecond resolution to the timestamp
5966 message header when turned on.</P
5968 >Note that the parameter <A
5969 HREF="#DEBUGTIMESTAMP"
5973 > debug timestamp</I
5976 > must be on for this to have an
5981 >debug hires timestamp = no</B
5991 >When using only one log file for more then one
5996 >-process there may be hard to follow which process
5997 outputs which message. This boolean parameter is adds the process-id
5998 to the timestamp message headers in the logfile when turned on.</P
6000 >Note that the parameter <A
6001 HREF="#DEBUGTIMESTAMP"
6005 > debug timestamp</I
6008 > must be on for this to have an
6018 NAME="DEBUGTIMESTAMP"
6020 >debug timestamp (G)</DT
6023 >Samba 2.2 debug log messages are timestamped
6024 by default. If you are running at a high <A
6033 can be distracting. This boolean parameter allows timestamping
6034 to be turned off.</P
6038 >debug timestamp = yes</B
6048 >Samba is sometimes run as root and sometime
6049 run as the connected user, this boolean parameter inserts the
6050 current euid, egid, uid and gid to the timestamp message headers
6051 in the log file if turned on.</P
6053 >Note that the parameter <A
6054 HREF="#DEBUGTIMESTAMP"
6058 > debug timestamp</I
6061 > must be on for this to have an
6094 HREF="#DEFAULTSERVICE"
6098 > default service</I
6107 >default case (S)</DT
6110 >See the section on <A
6114 HREF="#SHORTPRESERVECASE"
6118 >short preserve case</I
6125 >default case = lower</B
6130 NAME="DEFAULTDEVMODE"
6132 >default devmode (S)</DT
6135 >This parameter is only applicable to <A
6138 > services. When smbd is serving
6139 Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba
6140 server has a Device Mode which defines things such as paper size and
6141 orientation and duplex settings. The device mode can only correctly be
6142 generated by the printer driver itself (which can only be executed on a
6143 Win32 platform). Because smbd is unable to execute the driver code
6144 to generate the device mode, the default behavior is to set this field
6148 >Most problems with serving printer drivers to Windows NT/2k/XP clients
6149 can be traced to a problem with the generated device mode. Certain drivers
6150 will do things such as crashing the client's Explorer.exe with a NULL devmode.
6151 However, other printer drivers can cause the client's spooler service
6152 (spoolsv.exe) to die if the devmode was not created by the driver itself
6153 (i.e. smbd generates a default devmode).
6156 >This parameter should be used with care and tested with the printer
6157 driver in question. It is better to leave the device mode to NULL
6158 and let the Windows client set the correct values. Because drivers do not
6159 do this all the time, setting <B
6161 >default devmode = yes</B
6163 will instruct smbd to generate a default one.
6166 >For more information on Windows NT/2k printing and Device Modes,
6168 HREF="http://msdn.microsoft.com/"
6170 >MSDN documentation</A
6176 >default devmode = no</B
6181 NAME="DEFAULTSERVICE"
6183 >default service (G)</DT
6186 >This parameter specifies the name of a service
6187 which will be connected to if the service actually requested cannot
6188 be found. Note that the square brackets are <EM
6191 given in the parameter value (see example below).</P
6193 >There is no default value for this parameter. If this
6194 parameter is not given, attempting to connect to a nonexistent
6195 service results in an error.</P
6197 >Typically the default service would be a <A
6215 >Also note that the apparent service name will be changed
6216 to equal that of the requested service, this is very useful as it
6217 allows you to use macros like <TT
6223 a wildcard service.</P
6225 >Note also that any "_" characters in the name of the service
6226 used in the default service will get mapped to a "/". This allows for
6227 interesting things.</P
6238 CLASS="PROGRAMLISTING"
6240 default service = pub
6252 NAME="DELETEPRINTERCOMMAND"
6254 >delete printer command (G)</DT
6257 >With the introduction of MS-RPC based printer
6258 support for Windows NT/2000 clients in Samba 2.2, it is now
6259 possible to delete printer at run time by issuing the
6260 DeletePrinter() RPC call.</P
6262 >For a Samba host this means that the printer must be
6263 physically deleted from underlying printing system. The <TT
6266 > deleteprinter command</I
6268 > defines a script to be run which
6269 will perform the necessary operations for removing the printer
6270 from the print system and from <TT
6279 >delete printer command</I
6282 automatically called with only one parameter: <TT
6292 >delete printer command</I
6298 > will reparse the <TT
6301 > to associated printer no longer exists.
6302 If the sharename is still valid, then <B
6306 > will return an ACCESS_DENIED error to the client.</P
6309 HREF="#ADDPRINTERCOMMAND"
6313 > add printer command</I
6326 HREF="#SHOWADDPRINTERWIZARD"
6342 >deleteprinter command = /usr/bin/removeprinter
6348 NAME="DELETEREADONLY"
6350 >delete readonly (S)</DT
6353 >This parameter allows readonly files to be deleted.
6354 This is not normal DOS semantics, but is allowed by UNIX.</P
6356 >This option may be useful for running applications such
6357 as rcs, where UNIX file ownership prevents changing file
6358 permissions, and DOS semantics prevent deletion of a read only file.</P
6362 >delete readonly = no</B
6367 NAME="DELETESHARECOMMAND"
6369 >delete share command (G)</DT
6372 >Samba 2.2.0 introduced the ability to dynamically
6373 add and delete shares via the Windows NT 4.0 Server Manager. The
6377 >delete share command</I
6379 > is used to define an
6380 external program or script which will remove an existing service
6384 >. In order to successfully
6388 >delete share command</I
6394 requires that the administrator be connected using a root account (i.e.
6401 > will automatically invoke the
6405 >delete share command</I
6407 > with two parameters.
6434 the existing service.
6439 > This parameter is only used to remove file shares. To delete printer shares,
6441 HREF="#DELETEPRINTERCOMMAND"
6453 HREF="#ADDSHARECOMMAND"
6462 HREF="#CHANGESHARECOMMAND"
6479 >delete share command = /usr/local/bin/delshare</B
6484 NAME="DELETEUSERSCRIPT"
6486 >delete user script (G)</DT
6489 >This is the full pathname to a script that will
6498 when managing user's with remote RPC (NT) tools.
6501 >This script is called when a remote client removes a user
6502 from the server, normally using 'User Manager for Domains' or
6509 >This script should delete the given UNIX username.
6514 >delete user script = <empty string>
6520 >delete user script = /usr/local/samba/bin/del_user
6526 NAME="DELETEVETOFILES"
6528 >delete veto files (S)</DT
6531 >This option is used when Samba is attempting to
6532 delete a directory that contains one or more vetoed directories
6542 option). If this option is set to <TT
6545 > (the default) then if a vetoed
6546 directory contains any non-vetoed files or directories then the
6547 directory delete will fail. This is usually what you want.</P
6549 >If this option is set to <TT
6553 will attempt to recursively delete any files and directories within
6554 the vetoed directory. This can be useful for integration with file
6555 serving systems such as NetAtalk which create meta-files within
6556 directories you might normally veto DOS/Windows users from seeing
6564 >delete veto files = yes</B
6566 directories to be transparently deleted when the parent directory
6567 is deleted (so long as the user has permissions to do so).</P
6582 >delete veto files = no</B
6607 >dfree command (G)</DT
6616 only be used on systems where a problem occurs with the internal
6617 disk space calculations. This has been known to happen with Ultrix,
6618 but may occur with other operating systems. The symptom that was
6619 seen was an error of "Abort Retry Ignore" at the end of each
6620 directory listing.</P
6622 >This setting allows the replacement of the internal routines to
6623 calculate the total disk space and amount available with an external
6624 routine. The example below gives a possible script that might fulfill
6627 >The external program will be passed a single parameter indicating
6628 a directory in the filesystem being queried. This will typically consist
6632 >. The script should return two
6633 integers in ASCII. The first should be the total disk space in blocks,
6634 and the second should be the number of available blocks. An optional
6635 third return value can give the block size in bytes. The default
6636 blocksize is 1024 bytes.</P
6638 >Note: Your script should <EM
6641 setgid and should be owned by (and writeable only by) root!</P
6644 >By default internal routines for
6645 determining the disk capacity and remaining space will be used.
6651 >dfree command = /usr/local/samba/bin/dfree
6655 >Where the script dfree (which must be made executable) could be:</P
6664 CLASS="PROGRAMLISTING"
6667 df $1 | tail -1 | awk '{print $2" "$4}'
6674 >or perhaps (on Sys V based systems):</P
6683 CLASS="PROGRAMLISTING"
6686 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
6693 >Note that you may have to replace the command names
6694 with full path names on some systems.</P
6716 NAME="DIRECTORYMASK"
6718 >directory mask (S)</DT
6721 >This parameter is the octal modes which are
6722 used when converting DOS modes to UNIX modes when creating UNIX
6725 >When a directory is created, the necessary permissions are
6726 calculated according to the mapping from DOS modes to UNIX permissions,
6727 and the resulting UNIX mode is then bit-wise 'AND'ed with this
6728 parameter. This parameter may be thought of as a bit-wise MASK for
6729 the UNIX modes of a directory. Any bit <EM
6732 here will be removed from the modes set on a directory when it is
6735 >The default value of this parameter removes the 'group'
6736 and 'other' write bits from the UNIX mode, allowing only the
6737 user who owns the directory to modify it.</P
6739 >Following this Samba will bit-wise 'OR' the UNIX mode
6740 created from this parameter with the value of the <A
6741 HREF="#FORCEDIRECTORYMODE"
6745 >force directory mode
6749 > parameter. This parameter is set to 000 by
6750 default (i.e. no extra mode bits are added).</P
6752 >Note that this parameter does not apply to permissions
6753 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
6754 a mask on access control lists also, they need to set the <A
6755 HREF="#DIRECTORYSECURITYMASK"
6759 >directory security mask</I
6765 HREF="#FORCEDIRECTORYMODE"
6773 > parameter to cause particular mode
6774 bits to always be set on created directories.</P
6785 > parameter for masking mode bits on created files,
6787 HREF="#DIRECTORYSECURITYMASK"
6797 >Also refer to the <A
6798 HREF="#INHERITPERMISSIONS"
6802 > inherit permissions</I
6809 >directory mask = 0755</B
6814 >directory mask = 0775</B
6819 NAME="DIRECTORYMODE"
6821 >directory mode (S)</DT
6825 HREF="#DIRECTORYMASK"
6836 NAME="DIRECTORYSECURITYMASK"
6838 >directory security mask (S)</DT
6841 >This parameter controls what UNIX permission bits
6842 can be modified when a Windows NT client is manipulating the UNIX
6843 permission on a directory using the native NT security dialog
6846 >This parameter is applied as a mask (AND'ed with) to
6847 the changed permission bits, thus preventing any bits not in
6848 this mask from being modified. Essentially, zero bits in this
6849 mask may be treated as a set of bits the user is not allowed
6852 >If not set explicitly this parameter is set to 0777
6853 meaning a user is allowed to modify all the user/group/world
6854 permissions on a directory.</P
6858 > that users who can access the
6859 Samba server through other means can easily bypass this restriction,
6860 so it is primarily useful for standalone "appliance" systems.
6861 Administrators of most normal systems will probably want to leave
6862 it as the default of <TT
6868 HREF="#FORCEDIRECTORYSECURITYMODE"
6872 > force directory security mode</I
6876 HREF="#SECURITYMASK"
6885 HREF="#FORCESECURITYMODE"
6889 >force security mode
6897 >directory security mask = 0777</B
6902 >directory security mask = 0700</B
6907 NAME="DISABLESPOOLSS"
6909 >disable spoolss (G)</DT
6912 >Enabling this parameter will disables Samba's support
6913 for the SPOOLSS set of MS-RPC's and will yield identical behavior
6914 as Samba 2.0.x. Windows NT/2000 clients will downgrade to using
6915 Lanman style printing commands. Windows 9x/ME will be uneffected by
6916 the parameter. However, this will also disable the ability to upload
6917 printer drivers to a Samba server via the Windows NT Add Printer
6918 Wizard or by using the NT printer properties dialog window. It will
6919 also disable the capability of Windows NT/2000 clients to download
6920 print drivers from the Samba host upon demand.
6922 >Be very careful about enabling this parameter.</EM
6927 HREF="#USECLIENTDRIVER"
6928 >use client driver</A
6934 >disable spoolss = no</B
6949 when acting as a WINS server and finding that a NetBIOS name has not
6950 been registered, should treat the NetBIOS name word-for-word as a DNS
6951 name and do a lookup with the DNS server for that name on behalf of
6952 the name-querying client.</P
6954 >Note that the maximum length for a NetBIOS name is 15
6955 characters, so the DNS name (or DNS alias) can likewise only be
6956 15 characters, maximum.</P
6961 > spawns a second copy of itself to do the
6962 DNS name lookup requests, as doing a name lookup is a blocking
6965 >See also the parameter <A
6982 NAME="DOMAINADMINGROUP"
6984 >domain admin group (G)</DT
6987 >This parameter is intended as a temporary solution
6988 to enable users to be a member of the "Domain Admins" group when
6989 a Samba host is acting as a PDC. A complete solution will be provided
6990 by a system for mapping Windows NT/2000 groups onto UNIX groups.
6991 Please note that this parameter has a somewhat confusing name. It
6992 accepts a list of usernames and of group names in standard
7000 HREF="#DOMAINGUESTGROUP"
7009 HREF="#DOMAINLOGONS"
7021 >no domain administrators</EM
7026 >domain admin group = root @wheel</B
7031 NAME="DOMAINGUESTGROUP"
7033 >domain guest group (G)</DT
7036 >This parameter is intended as a temporary solution
7037 to enable users to be a member of the "Domain Guests" group when
7038 a Samba host is acting as a PDC. A complete solution will be provided
7039 by a system for mapping Windows NT/2000 groups onto UNIX groups.
7040 Please note that this parameter has a somewhat confusing name. It
7041 accepts a list of usernames and of group names in standard
7049 HREF="#DOMAINADMINGROUP"
7058 HREF="#DOMAINLOGONS"
7070 >no domain guests</EM
7075 >domain guest group = nobody @guest</B
7082 >domain logons (G)</DT
7088 >, the Samba server will serve
7089 Windows 95/98 Domain logons for the <A
7097 > it is in. Samba 2.2 also
7098 has limited capability to act as a domain controller for Windows
7099 NT 4 Domains. For more details on setting up this feature see
7100 the Samba-PDC-HOWTO included in the <TT
7104 directory shipped with the source code.</P
7108 >domain logons = no</B
7115 >domain master (G)</DT
7125 > to enable WAN-wide browse list
7126 collation. Setting this option causes <B
7130 claim a special domain specific NetBIOS name that identifies
7131 it as a domain master browser for its given <A
7139 >. Local master browsers
7145 > on broadcast-isolated
7146 subnets will give this <B
7149 > their local browse lists,
7158 for a complete copy of the browse list for the whole wide area
7159 network. Browser clients will then contact their local master browser,
7160 and will receive the domain-wide browse list, instead of just the list
7161 for their broadcast-isolated subnet.</P
7163 >Note that Windows NT Primary Domain Controllers expect to be
7164 able to claim this <TT
7170 NetBIOS name that identifies them as domain master browsers for
7176 > by default (i.e. there is no
7177 way to prevent a Windows NT PDC from attempting to do this). This
7178 means that if this parameter is set and <B
7182 the special name for a <TT
7188 NT PDC is able to do so then cross subnet browsing will behave
7189 strangely and may fail.</P
7192 HREF="#DOMAINLOGONS"
7195 >domain logons = yes</B
7198 >, then the default behavior is to enable the <TT
7210 not enabled (the default setting), then neither will <TT
7216 > be enabled by default.</P
7220 >domain master = auto</B
7227 >dont descend (S)</DT
7230 >There are certain directories on some systems
7234 > tree under Linux) that are either not
7235 of interest to clients or are infinitely deep (recursive). This
7236 parameter allows you to specify a comma-delimited list of directories
7237 that the server should always show as empty.</P
7239 >Note that Samba can be very fussy about the exact format
7240 of the "dont descend" entries. For example you may need <TT
7243 > instead of just <TT
7247 Experimentation is the best policy :-) </P
7250 >none (i.e., all directories are OK
7256 >dont descend = /proc,/dev</B
7263 >dos filemode (S)</DT
7266 > The default behavior in Samba is to provide
7267 UNIX-like behavior where only the owner of a file/directory is
7268 able to change the permissions on it. However, this behavior
7269 is often confusing to DOS/Windows users. Enabling this parameter
7270 allows a user who has write access to the file (by whatever
7271 means) to modify the permissions on it. Note that a user
7272 belonging to the group owning the file will not be allowed to
7273 change permissions if the group is only granted read access.
7274 Ownership of the file/directory is not changed, only the permissions
7279 >dos filemode = no</B
7284 NAME="DOSFILETIMERESOLUTION"
7286 >dos filetime resolution (S)</DT
7289 >Under the DOS and Windows FAT filesystem, the finest
7290 granularity on time resolution is two seconds. Setting this parameter
7291 for a share causes Samba to round the reported time down to the
7292 nearest two second boundary when a query call that requires one second
7293 resolution is made to <A
7303 >This option is mainly used as a compatibility option for Visual
7304 C++ when used against Samba shares. If oplocks are enabled on a
7305 share, Visual C++ uses two different time reading calls to check if a
7306 file has changed since it was last read. One of these calls uses a
7307 one-second granularity, the other uses a two second granularity. As
7308 the two second call rounds any odd second down, then if the file has a
7309 timestamp of an odd number of seconds then the two timestamps will not
7310 match and Visual C++ will keep reporting the file has changed. Setting
7311 this option causes the two timestamps to match, and Visual C++ is
7316 >dos filetime resolution = no</B
7323 >dos filetimes (S)</DT
7326 >Under DOS and Windows, if a user can write to a
7327 file they can change the timestamp on it. Under POSIX semantics,
7328 only the owner of the file or root may change the timestamp. By
7329 default, Samba runs with POSIX semantics and refuses to change the
7330 timestamp on a file if the user <B
7334 on behalf of is not the file owner. Setting this option to <TT
7337 > allows DOS semantics and <A
7341 > will change the file
7342 timestamp as DOS requires.</P
7346 >dos filetimes = no</B
7351 NAME="ENCRYPTPASSWORDS"
7353 >encrypt passwords (G)</DT
7356 >This boolean controls whether encrypted passwords
7357 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
7358 above and also Windows 98 will by default expect encrypted passwords
7359 unless a registry entry is changed. To use encrypted passwords in
7360 Samba see the file ENCRYPTION.txt in the Samba documentation
7364 > shipped with the source code.</P
7366 >In order for encrypted passwords to work correctly
7375 have access to a local <A
7376 HREF="smbpasswd.5.html"
7384 HREF="smbpasswd.8.html"
7390 > program for information on how to set up
7391 and maintain this file), or set the <A
7393 >security = [server|domain|ads]</A
7398 > to authenticate against another
7403 >encrypt passwords = yes</B
7408 NAME="ENHANCEDBROWSING"
7410 >enhanced browsing (G)</DT
7413 >This option enables a couple of enhancements to
7414 cross-subnet browse propagation that have been added in Samba
7415 but which are not standard in Microsoft implementations.
7418 >The first enhancement to browse propagation consists of a regular
7419 wildcard query to a Samba WINS server for all Domain Master Browsers,
7420 followed by a browse synchronization with each of the returned
7421 DMBs. The second enhancement consists of a regular randomised browse
7422 synchronization with all currently known DMBs.</P
7424 >You may wish to disable this option if you have a problem with empty
7425 workgroups not disappearing from browse lists. Due to the restrictions
7426 of the browse protocols these enhancements can cause a empty workgroup
7427 to stay around forever which can be annoying.</P
7429 >In general you should leave this option enabled as it makes
7430 cross-subnet browse propagation much more reliable.</P
7434 >enhanced browsing = yes</B
7439 NAME="ENUMPORTSCOMMAND"
7441 >enumports command (G)</DT
7444 >The concept of a "port" is fairly foreign
7445 to UNIX hosts. Under Windows NT/2000 print servers, a port
7446 is associated with a port monitor and generally takes the form of
7447 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
7448 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
7451 >"Samba Printer Port"</TT
7453 Windows NT/2000, all printers must have a valid port name.
7454 If you wish to have a list of ports displayed (<B
7458 > does not use a port name for anything) other than
7461 >"Samba Printer Port"</TT
7466 >enumports command</I
7469 a program which should generate a list of ports, one per line,
7470 to standard output. This listing will then be used in response
7471 to the level 1 and 2 EnumPorts() RPC.</P
7474 >no enumports command</EM
7479 >enumports command = /usr/bin/listports
7490 >This is a synonym for <A
7502 NAME="FAKEDIRECTORYCREATETIMES"
7504 >fake directory create times (S)</DT
7507 >NTFS and Windows VFAT file systems keep a create
7508 time for all files and directories. This is not the same as the
7509 ctime - status change time - that Unix keeps, so Samba by default
7510 reports the earliest of the various times Unix does keep. Setting
7511 this parameter for a share causes Samba to always report midnight
7512 1-1-1980 as the create time for directories.</P
7514 >This option is mainly used as a compatibility option for
7515 Visual C++ when used against Samba shares. Visual C++ generated
7516 makefiles have the object directory as a dependency for each object
7517 file, and a make rule to create the directory. Also, when NMAKE
7518 compares timestamps it uses the creation time when examining a
7519 directory. Thus the object directory will be created if it does not
7520 exist, but once it does exist it will always have an earlier
7521 timestamp than the object files it contains.</P
7523 >However, Unix time semantics mean that the create time
7524 reported by Samba will be updated whenever a file is created or
7525 or deleted in the directory. NMAKE finds all object files in
7526 the object directory. The timestamp of the last one built is then
7527 compared to the timestamp of the object directory. If the
7528 directory's timestamp if newer, then all object files
7529 will be rebuilt. Enabling this option
7530 ensures directories always predate their contents and an NMAKE build
7531 will proceed as expected.</P
7535 >fake directory create times = no</B
7542 >fake oplocks (S)</DT
7545 >Oplocks are the way that SMB clients get permission
7546 from a server to locally cache file operations. If a server grants
7547 an oplock (opportunistic lock) then the client is free to assume
7548 that it is the only one accessing the file and it will aggressively
7549 cache file data. With some oplock types the client may even cache
7550 file open/close operations. This can give enormous performance benefits.
7555 >fake oplocks = yes</B
7564 always grant oplock requests no matter how many clients are using
7567 >It is generally much better to use the real <A
7576 than this parameter.</P
7578 >If you enable this option on all read-only shares or
7579 shares that you know will only be accessed from one client at a
7580 time such as physically read-only media like CDROMs, you will see
7581 a big performance improvement on many operations. If you enable
7582 this option on shares where multiple clients may be accessing the
7583 files read-write at the same time you can get data corruption. Use
7584 this option carefully!</P
7588 >fake oplocks = no</B
7593 NAME="FOLLOWSYMLINKS"
7595 >follow symlinks (S)</DT
7598 >This parameter allows the Samba administrator
7607 from following symbolic links in a particular share. Setting this
7611 > prevents any file or directory
7612 that is a symbolic link from being followed (the user will get an
7613 error). This option is very useful to stop users from adding a
7614 symbolic link to <TT
7618 directory for instance. However it will slow filename lookups
7621 >This option is enabled (i.e. <B
7625 follow symbolic links) by default.</P
7629 >follow symlinks = yes</B
7634 NAME="FORCECREATEMODE"
7636 >force create mode (S)</DT
7639 >This parameter specifies a set of UNIX mode bit
7640 permissions that will <EM
7643 file created by Samba. This is done by bitwise 'OR'ing these bits onto
7644 the mode bits of a file that is being created or having its
7645 permissions changed. The default for this parameter is (in octal)
7646 000. The modes in this parameter are bitwise 'OR'ed onto the file
7647 mode after the mask set in the <TT
7653 parameter is applied.</P
7655 >See also the parameter <A
7664 > for details on masking mode bits on files.</P
7667 HREF="#INHERITPERMISSIONS"
7679 >force create mode = 000</B
7684 >force create mode = 0755</B
7687 >would force all created files to have read and execute
7688 permissions set for 'group' and 'other' as well as the
7689 read/write/execute bits set for the 'user'.</P
7693 NAME="FORCEDIRECTORYMODE"
7695 >force directory mode (S)</DT
7698 >This parameter specifies a set of UNIX mode bit
7699 permissions that will <EM
7701 > be set on a directory
7702 created by Samba. This is done by bitwise 'OR'ing these bits onto the
7703 mode bits of a directory that is being created. The default for this
7704 parameter is (in octal) 0000 which will not add any extra permission
7705 bits to a created directory. This operation is done after the mode
7706 mask in the parameter <TT
7714 >See also the parameter <A
7715 HREF="#DIRECTORYMASK"
7722 > for details on masking mode bits
7723 on created directories.</P
7726 HREF="#INHERITPERMISSIONS"
7730 > inherit permissions</I
7737 >force directory mode = 000</B
7742 >force directory mode = 0755</B
7745 >would force all created directories to have read and execute
7746 permissions set for 'group' and 'other' as well as the
7747 read/write/execute bits set for the 'user'.</P
7751 NAME="FORCEDIRECTORYSECURITYMODE"
7754 security mode (S)</DT
7757 >This parameter controls what UNIX permission bits
7758 can be modified when a Windows NT client is manipulating the UNIX
7759 permission on a directory using the native NT security dialog box.</P
7761 >This parameter is applied as a mask (OR'ed with) to the
7762 changed permission bits, thus forcing any bits in this mask that
7763 the user may have modified to be on. Essentially, one bits in this
7764 mask may be treated as a set of bits that, when modifying security
7765 on a directory, the user has always set to be 'on'.</P
7767 >If not set explicitly this parameter is 000, which
7768 allows a user to modify all the user/group/world permissions on a
7769 directory without restrictions.</P
7773 > that users who can access the
7774 Samba server through other means can easily bypass this restriction,
7775 so it is primarily useful for standalone "appliance" systems.
7776 Administrators of most normal systems will probably want to leave
7780 HREF="#DIRECTORYSECURITYMASK"
7784 > directory security mask</I
7788 HREF="#SECURITYMASK"
7797 HREF="#FORCESECURITYMODE"
7801 >force security mode
7809 >force directory security mode = 0</B
7814 >force directory security mode = 700</B
7821 >force group (S)</DT
7824 >This specifies a UNIX group name that will be
7825 assigned as the default primary group for all users connecting
7826 to this service. This is useful for sharing files by ensuring
7827 that all access to files on service will use the named group for
7828 their permissions checking. Thus, by assigning permissions for this
7829 group to the files and directories within this service the Samba
7830 administrator can restrict or allow sharing of these files.</P
7832 >In Samba 2.0.5 and above this parameter has extended
7833 functionality in the following way. If the group name listed here
7834 has a '+' character prepended to it then the current user accessing
7835 the share only has the primary group default assigned to this group
7836 if they are already assigned as a member of that group. This allows
7837 an administrator to decide that only users who are already in a
7838 particular group will create files with group ownership set to that
7839 group. This gives a finer granularity of ownership assignment. For
7840 example, the setting <TT
7842 >force group = +sys</TT
7844 that only users who are already in group sys will have their default
7845 primary group assigned to sys when accessing this Samba share. All
7846 other users will retain their ordinary primary group.</P
7857 > parameter is also set the group specified in
7863 > will override the primary group
7883 >no forced group</EM
7888 >force group = agroup</B
7893 NAME="FORCESECURITYMODE"
7895 >force security mode (S)</DT
7898 >This parameter controls what UNIX permission
7899 bits can be modified when a Windows NT client is manipulating
7900 the UNIX permission on a file using the native NT security dialog
7903 >This parameter is applied as a mask (OR'ed with) to the
7904 changed permission bits, thus forcing any bits in this mask that
7905 the user may have modified to be on. Essentially, one bits in this
7906 mask may be treated as a set of bits that, when modifying security
7907 on a file, the user has always set to be 'on'.</P
7909 >If not set explicitly this parameter is set to 0,
7910 and allows a user to modify all the user/group/world permissions on a file,
7911 with no restrictions.</P
7915 > that users who can access
7916 the Samba server through other means can easily bypass this restriction,
7917 so it is primarily useful for standalone "appliance" systems.
7918 Administrators of most normal systems will probably want to leave
7919 this set to 0000.</P
7922 HREF="#FORCEDIRECTORYSECURITYMODE"
7926 > force directory security mode</I
7931 HREF="#DIRECTORYSECURITYMASK"
7940 HREF="#SECURITYMASK"
7951 >force security mode = 0</B
7956 >force security mode = 700</B
7966 >This specifies a UNIX user name that will be
7967 assigned as the default user for all users connecting to this service.
7968 This is useful for sharing files. You should also use it carefully
7969 as using it incorrectly can cause security problems.</P
7971 >This user name only gets used once a connection is established.
7972 Thus clients still need to connect as a valid user and supply a
7973 valid password. Once connected, all file operations will be performed
7974 as the "forced user", no matter what username the client connected
7975 as. This can be very useful.</P
7977 >In Samba 2.0.5 and above this parameter also causes the
7978 primary group of the forced user to be used as the primary group
7979 for all file activity. Prior to 2.0.5 the primary group was left
7980 as the primary group of the connecting user (this was a bug).</P
7999 >force user = auser</B
8009 >This parameter allows the administrator to
8010 configure the string that specifies the type of filesystem a share
8011 is using that is reported by <A
8019 > when a client queries the filesystem type
8020 for a share. The default type is <TT
8024 compatibility with Windows NT but this can be changed to other
8048 >getwd cache (G)</DT
8051 >This is a tuning option. When this is enabled a
8052 caching algorithm will be used to reduce the time taken for getwd()
8053 calls. This can have a significant impact on performance, especially
8063 >parameter is set to <TT
8070 >getwd cache = yes</B
8095 >guest account (S)</DT
8098 >This is a username which will be used for access
8099 to services which are specified as <A
8107 > (see below). Whatever privileges this
8108 user has will be available to any client connecting to the guest service.
8109 Typically this user will exist in the password file, but will not
8110 have a valid login. The user account "ftp" is often a good choice
8111 for this parameter. If a username is specified in a given service,
8112 the specified username overrides this one.</P
8114 >One some systems the default guest account "nobody" may not
8115 be able to print. Use another account in this case. You should test
8116 this by trying to log in as your guest user (perhaps by using the
8120 > command) and trying to print using the
8121 system print command such as <B
8130 >specified at compile time, usually
8136 >guest account = ftp</B
8146 >If this parameter is <TT
8150 a service, then no password is required to connect to the service.
8151 Privileges will be those of the <A
8152 HREF="#GUESTACCOUNT"
8161 >See the section below on <A
8169 > for more information about this option.
8184 >If this parameter is <TT
8188 a service, then only guest connections to the service are permitted.
8189 This parameter will have no effect if <A
8197 > is not set for the service.</P
8199 >See the section below on <A
8207 > for more information about this option.
8219 >hide dot files (S)</DT
8222 >This is a boolean parameter that controls whether
8223 files starting with a dot appear as hidden files.</P
8227 >hide dot files = yes</B
8237 >This is a list of files or directories that are not
8238 visible but are accessible. The DOS 'hidden' attribute is applied
8239 to any files or directories that match.</P
8241 >Each entry in the list must be separated by a '/',
8242 which allows spaces to be included in the entry. '*'
8243 and '?' can be used to specify multiple files or directories
8244 as in DOS wildcards.</P
8246 >Each entry must be a Unix path, not a DOS path and must
8247 not include the Unix directory separator '/'.</P
8249 >Note that the case sensitivity option is applicable
8252 >Setting this parameter will affect the performance of Samba,
8253 as it will be forced to check all files and directories for a match
8254 as they are scanned.</P
8257 HREF="#HIDEDOTFILES"
8274 HREF="#CASESENSITIVE"
8284 >no file are hidden</EM
8290 /.*/DesktopFolderDB/TrashFor%m/resource.frk/</B
8293 >The above example is based on files that the Macintosh
8294 SMB client (DAVE) available from <A
8295 HREF="http://www.thursby.com"
8299 > creates for internal use, and also still hides
8300 all files beginning with a dot.</P
8304 NAME="HIDELOCALUSERS"
8306 >hide local users(G)</DT
8309 >This parameter toggles the hiding of local UNIX
8310 users (root, wheel, floppy, etc) from remote clients.</P
8314 >hide local users = no</B
8319 NAME="HIDEUNREADABLE"
8321 >hide unreadable (S)</DT
8324 >This parameter prevents clients from seeing the
8325 existance of files that cannot be read. Defaults to off.</P
8329 >hide unreadable = no</B
8336 >homedir map (G)</DT
8364 > then this parameter
8365 specifies the NIS (or YP) map from which the server for the user's
8366 home directory should be extracted. At present, only the Sun
8367 auto.home map format is understood. The form of the map is:</P
8371 >username server:/some/file/system</B
8374 >and the program will extract the servername from before
8375 the first ':'. There should probably be a better parsing system
8376 that copes with different map formats and also Amd (another
8377 automounter) maps.</P
8381 >A working NIS client is required on
8382 the system for this option to work.</P
8394 HREF="#DOMAINLOGONS"
8406 >homedir map = <empty string></B
8411 >homedir map = amd.homedir</B
8421 >This boolean parameter is only available
8422 if Samba has been configured and compiled with the <B
8425 > option. If set to <TT
8429 Samba will act as a Dfs server, and allow Dfs-aware clients
8430 to browse Dfs trees hosted on the server.</P
8440 > share level parameter. For
8441 more information on setting up a Dfs tree on Samba,
8443 HREF="msdfs_setup.html"
8445 >msdfs_setup.html</A
8458 >hosts allow (S)</DT
8461 >A synonym for this parameter is <TT
8469 >This parameter is a comma, space, or tab delimited
8470 set of hosts which are permitted to access a service.</P
8472 >If specified in the [global] section then it will
8473 apply to all services, regardless of whether the individual
8474 service has a different setting.</P
8476 >You can specify the hosts by name or IP number. For
8477 example, you could restrict access to only the hosts on a
8478 Class C subnet with something like <B
8480 >allow hosts = 150.203.5.
8482 >. The full syntax of the list is described in the man
8485 >hosts_access(5)</TT
8486 >. Note that this man
8487 page may not be present on your system, so a brief description will
8488 be given here also.</P
8490 >Note that the localhost address 127.0.0.1 will always
8491 be allowed access unless specifically denied by a <A
8501 >You can also specify hosts by network/netmask pairs and
8502 by netgroup names if your system supports netgroups. The
8505 > keyword can also be used to limit a
8506 wildcard list. The following examples may provide some help:</P
8508 >Example 1: allow all IPs in 150.203.*.*; except one</P
8512 >hosts allow = 150.203. EXCEPT 150.203.6.66</B
8515 >Example 2: allow hosts that match the given network/netmask</P
8519 >hosts allow = 150.203.15.0/255.255.255.0</B
8522 >Example 3: allow a couple of hosts</P
8526 >hosts allow = lapland, arvidsjaur</B
8529 >Example 4: allow only hosts in NIS netgroup "foonet", but
8530 deny access from one particular host</P
8534 >hosts allow = @foonet</B
8539 >hosts deny = pirate</B
8542 >Note that access still requires suitable user-level passwords.</P
8545 HREF="testparm.1.html"
8552 > for a way of testing your host access to see if it does
8556 >none (i.e., all hosts permitted access)
8562 >allow hosts = 150.203.5. myhost.mynet.edu.au
8573 >The opposite of <TT
8579 - hosts listed here are <EM
8581 > permitted access to
8582 services unless the specific services have their own lists to override
8583 this one. Where the lists conflict, the <TT
8589 list takes precedence.</P
8592 >none (i.e., no hosts specifically excluded)
8598 >hosts deny = 150.203.4. badhost.mynet.edu.au
8606 >hosts equiv (G)</DT
8609 >If this global parameter is a non-null string,
8610 it specifies the name of a file to read for the names of hosts
8611 and users who will be allowed access without specifying a password.
8614 >This is not be confused with <A
8622 > which is about hosts
8623 access to services and is more useful for guest services. <TT
8628 > may be useful for NT clients which will
8629 not supply passwords to Samba.</P
8639 > can be a major security hole. This is because you are
8640 trusting the PC to supply the correct username. It is very easy to
8641 get a PC to supply a false username. I recommend that the
8647 > option be only used if you really
8648 know what you are doing, or perhaps on a home network where you trust
8649 your spouse and kids. And only if you <EM
8655 >no host equivalences</EM
8660 >hosts equiv = /etc/hosts.equiv</B
8670 >This allows you to include one config file
8671 inside another. The file is included literally, as though typed
8674 >It takes the standard substitutions, except <TT
8694 >no file included</EM
8699 >include = /usr/local/samba/lib/admin_smb.conf
8707 >inherit acls (S)</DT
8710 >This parameter can be used to ensure
8711 that if default acls exist on parent directories,
8712 they are always honored when creating a subdirectory.
8713 The default behavior is to use the mode specified
8714 when creating the directory. Enabling this option
8715 sets the mode to 0777, thus guaranteeing that
8716 default directory acls are propagated.
8721 >inherit acls = no</B
8727 NAME="INHERITPERMISSIONS"
8729 >inherit permissions (S)</DT
8732 >The permissions on new files and directories
8733 are normally governed by <A
8742 HREF="#DIRECTORYMASK"
8750 HREF="#FORCECREATEMODE"
8754 >force create mode</I
8759 HREF="#FORCEDIRECTORYMODE"
8767 > but the boolean inherit
8768 permissions parameter overrides this.</P
8770 >New directories inherit the mode of the parent directory,
8771 including bits such as setgid.</P
8773 >New files inherit their read/write bits from the parent
8774 directory. Their execute bits continue to be determined by
8804 >Note that the setuid bit is <EM
8807 inheritance (the code explicitly prohibits this).</P
8809 >This can be particularly useful on large systems with
8810 many users, perhaps several thousand, to allow a single [homes]
8811 share to be used flexibly by each user.</P
8823 HREF="#DIRECTORYMASK"
8831 HREF="#FORCECREATEMODE"
8835 >force create mode</I
8839 HREF="#FORCEDIRECTORYMODE"
8843 >force directory mode</I
8851 >inherit permissions = no</B
8861 >This option allows you to override the default
8862 network interfaces list that Samba will use for browsing, name
8863 registration and other NBT traffic. By default Samba will query
8864 the kernel for the list of all active interfaces and use any
8865 interfaces except 127.0.0.1 that are broadcast capable.</P
8867 >The option takes a list of interface strings. Each string
8868 can be in any of the following forms:</P
8874 >a network interface name (such as eth0).
8875 This may include shell-like wildcards so eth* will match
8876 any interface starting with the substring "eth"</P
8880 >an IP address. In this case the netmask is
8881 determined from the list of interfaces obtained from the
8886 >an IP/mask pair. </P
8890 >a broadcast/mask pair.</P
8894 >The "mask" parameters can either be a bit length (such
8895 as 24 for a C class network) or a full netmask in dotted
8898 >The "IP" parameters above can either be a full dotted
8899 decimal IP address or a hostname which will be looked up via
8900 the OS's normal hostname resolution mechanisms.</P
8902 >For example, the following line:</P
8906 >interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
8910 >would configure three network interfaces corresponding
8911 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
8912 The netmasks of the latter two interfaces would be set to 255.255.255.0.</P
8915 HREF="#BINDINTERFACESONLY"
8926 >all active interfaces except 127.0.0.1
8927 that are broadcast capable</EM
8934 >invalid users (S)</DT
8937 >This is a list of users that should not be allowed
8938 to login to this service. This is really a <EM
8941 check to absolutely ensure an improper setting does not breach
8944 >A name starting with a '@' is interpreted as an NIS
8945 netgroup first (if your system supports NIS), and then as a UNIX
8946 group if the name was not found in the NIS netgroup database.</P
8948 >A name starting with '+' is interpreted only
8949 by looking in the UNIX group database. A name starting with
8950 '&' is interpreted only by looking in the NIS netgroup database
8951 (this requires NIS to be working on your system). The characters
8952 '+' and '&' may be used at the start of the name in either order
8959 UNIX group database, followed by the NIS netgroup database, and
8965 > means check the NIS
8966 netgroup database, followed by the UNIX group database (the
8967 same as the '@' prefix).</P
8969 >The current servicename is substituted for <TT
8975 This is useful in the [homes] section.</P
8989 >no invalid users</EM
8994 >invalid users = root fred admin @wheel
9005 >The value of the parameter (an integer) represents
9006 the number of seconds between <TT
9012 packets. If this parameter is zero, no keepalive packets will be
9013 sent. Keepalive packets, if sent, allow the server to tell whether
9014 a client is still present and responding.</P
9016 >Keepalives should, in general, not be needed if the socket
9017 being used has the SO_KEEPALIVE attribute set on it (see <A
9018 HREF="#SOCKETOPTIONS"
9026 Basically you should only use this option if you strike difficulties.</P
9040 NAME="KERNELOPLOCKS"
9042 >kernel oplocks (G)</DT
9045 >For UNIXes that support kernel based <A
9054 (currently only IRIX and the Linux 2.4 kernel), this parameter
9055 allows the use of them to be turned on or off.</P
9057 >Kernel oplocks support allows Samba <TT
9063 > to be broken whenever a local UNIX process or NFS operation
9064 accesses a file that <A
9072 > has oplocked. This allows complete data consistency between
9073 SMB/CIFS, NFS and local file access (and is a <EM
9076 cool feature :-).</P
9078 >This parameter defaults to <TT
9081 >, but is translated
9082 to a no-op on systems that no not have the necessary kernel support.
9083 You should never need to touch this parameter.</P
9095 HREF="#LEVEL2OPLOCKS"
9107 >kernel oplocks = yes</B
9114 >lanman auth (G)</DT
9117 >This parameter determines whether or not <A
9122 attempt to authenticate users using the LANMAN password hash.
9123 If disabled, only clients which support NT password hashes (e.g. Windows
9124 NT/2000 clients, smbclient, etc... but not Windows 95/98 or the MS DOS
9125 network client) will be able to connect to the Samba host.</P
9129 >lanman auth = yes</B
9134 NAME="LARGEREADWRITE"
9136 >large readwrite (G)</DT
9139 >This parameter determines whether or not <A
9144 supports the new 64k streaming read and write varient SMB requests introduced
9145 with Windows 2000. Note that due to Windows 2000 client redirector bugs
9146 this requires Samba to be running on a 64-bit capable operating system such
9147 as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with
9148 Windows 2000 clients. Defaults to on. Not as tested as some other Samba
9154 >large readwrite = yes</B
9161 >ldap admin dn (G)</DT
9169 > defines the Distinguished
9170 Name (DN) name used by Samba to contact the ldap server when retreiving
9171 user account information. The <TT
9177 > is used in conjunction with the admin dn password
9180 >private/secrets.tdb</TT
9183 HREF="smbpasswd.8.html"
9190 page for more information on how to accmplish this.
9201 >ldap filter (G)</DT
9204 >This parameter specifies the RFC 2254 compliant LDAP search filter.
9205 The default is to match the login name with the <TT
9209 attribute for all entries matching the <TT
9213 objectclass. Note that this filter should only return one entry.
9218 >ldap filter = (&(uid=%u)(objectclass=sambaAccount))</B
9228 >This option is used to define whether or not Samba should
9229 use SSL when connecting to the ldap server
9233 Samba's previous SSL support which was enabled by specifying the
9249 > can be set to one of three values:
9253 > - Always use SSL when contacting the
9263 Never use SSL when querying the directory, or (c) <TT
9267 - Use the LDAPv3 StartTLS extended operation
9268 (RFC2830) for communicating with the directory server.
9280 >ldap suffix (G)</DT
9289 NAME="LDAPUSERSUFFIX"
9291 >ldap user suffix (G)</DT
9294 >It specifies where users are added to the tree.
9303 NAME="LDAPMACHINESUFFIX"
9305 >ldap machine suffix (G)</DT
9308 >It specifies where machines should be
9309 added to the ldap tree.
9318 NAME="LEVEL2OPLOCKS"
9320 >level2 oplocks (S)</DT
9323 >This parameter controls whether Samba supports
9324 level2 (read-only) oplocks on a share.</P
9326 >Level2, or read-only oplocks allow Windows NT clients
9327 that have an oplock on a file to downgrade from a read-write oplock
9328 to a read-only oplock once a second client opens the file (instead
9329 of releasing all oplocks on a second open, as in traditional,
9330 exclusive oplocks). This allows all openers of the file that
9331 support level2 oplocks to cache the file for read-ahead only (ie.
9332 they may not cache writes or lock requests) and increases performance
9333 for many accesses of files that are not commonly written (such as
9334 application .EXE files).</P
9336 >Once one of the clients which have a read-only oplock
9337 writes to the file all clients are notified (no reply is needed
9338 or waited for) and told to break their oplocks to "none" and
9339 delete any read-ahead caches.</P
9341 >It is recommended that this parameter be turned on
9342 to speed access to shared executables.</P
9344 >For more discussions on level2 oplocks see the CIFS spec.</P
9347 HREF="#KERNELOPLOCKS"
9355 > are supported then level2 oplocks are
9356 not granted (even if this parameter is set to <TT
9369 > parameter must be set to <TT
9372 > on this share in order for
9373 this parameter to have any effect.</P
9397 >level2 oplocks = yes</B
9404 >lm announce (G)</DT
9407 >This parameter determines if <A
9414 > will produce Lanman announce
9415 broadcasts that are needed by OS/2 clients in order for them to see
9416 the Samba server in their browse list. This parameter can have three
9427 >. The default is <TT
9434 > Samba will never produce these
9435 broadcasts. If set to <TT
9438 > Samba will produce
9439 Lanman announce broadcasts at a frequency set by the parameter
9449 Samba will not send Lanman announce broadcasts by default but will
9450 listen for them. If it hears such a broadcast on the wire it will
9451 then start sending them at a frequency set by the parameter
9472 >lm announce = auto</B
9477 >lm announce = yes</B
9484 >lm interval (G)</DT
9487 >If Samba is set to produce Lanman announce
9488 broadcasts needed by OS/2 clients (see the <A
9496 > parameter) then this
9497 parameter defines the frequency in seconds with which they will be
9498 made. If this is set to zero then no Lanman announcements will be
9499 made despite the setting of the <TT
9520 >lm interval = 60</B
9525 >lm interval = 120</B
9532 >load printers (G)</DT
9535 >A boolean variable that controls whether all
9536 printers in the printcap will be loaded for browsing by default.
9545 >load printers = yes</B
9552 >local master (G)</DT
9555 >This option allows <A
9562 > to try and become a local master browser
9563 on a subnet. If set to <TT
9569 > will not attempt to become a local master browser
9570 on a subnet and will also lose in all browsing elections. By
9571 default this value is set to <TT
9574 >. Setting this value to <TT
9578 mean that Samba will <EM
9581 browser on a subnet, just that <B
9586 > in elections for local master browser.</P
9588 >Setting this value to <TT
9597 > to become a local master browser.</P
9601 >local master = yes</B
9612 HREF="#LOCKDIRECTORY"
9623 NAME="LOCKDIRECTORY"
9625 >lock directory (G)</DT
9628 >This option specifies the directory where lock
9629 files will be placed. The lock files are used to implement the
9631 HREF="#MAXCONNECTIONS"
9643 >lock directory = ${prefix}/var/locks</B
9648 >lock directory = /var/run/samba/locks</B
9654 NAME="LOCKSPINCOUNT"
9656 >lock spin count (G)</DT
9659 >This parameter controls the number of times
9660 that smbd should attempt to gain a byte range lock on the
9661 behalf of a client request. Experiments have shown that
9662 Windows 2k servers do not reply with a failure if the lock
9663 could not be immediately granted, but try a few more times
9664 in case the lock could later be aquired. This behavior
9665 is used to support PC database formats such as MS Access
9671 >lock spin count = 2</B
9679 >lock spin time (G)</DT
9682 >The time in microseconds that smbd should
9683 pause before attempting to gain a failed lock. See
9685 HREF="#LOCKSPINCOUNT"
9698 >lock spin time = 10</B
9709 >This controls whether or not locking will be
9710 performed by the server in response to lock requests from the
9716 >, all lock and unlock
9717 requests will appear to succeed and all lock queries will report
9718 that the file in question is available for locking.</P
9723 >, real locking will be performed
9728 > be useful for read-only
9729 filesystems which <EM
9731 > not need locking (such as
9732 CDROM drives), although setting this parameter of <TT
9736 is not really recommended even in this case.</P
9738 >Be careful about disabling locking either globally or in a
9739 specific service, as lack of locking may result in data corruption.
9740 You should never need to set this parameter.</P
9754 >This option allows you to override the name
9755 of the Samba log file (also known as the debug file).</P
9757 >This option takes the standard substitutions, allowing
9758 you to have separate log files for each user or machine.</P
9762 >log file = /usr/local/samba/var/log.%m
9773 >The value of the parameter (a astring) allows
9774 the debug level (logging level) to be specified in the
9778 > file. This parameter has been
9779 extended since 2.2.x series, now it allow to specify the debug
9780 level for multiple debug classes. This is to give greater
9781 flexibility in the configuration of the system.</P
9783 >The default will be the log level specified on
9784 the command line or level zero if none was specified.</P
9788 >log level = 3 passdb:5 auth:10 winbind:2
9796 >logon drive (G)</DT
9799 >This parameter specifies the local path to
9800 which the home directory will be connected (see <A
9809 and is only used by NT Workstations. </P
9811 >Note that this option is only useful if Samba is set up as a
9816 >logon drive = z:</B
9821 >logon drive = h:</B
9831 >This parameter specifies the home directory
9832 location when a Win95/98 or NT Workstation logs into a Samba PDC.
9833 It allows you to do </P
9841 >NET USE H: /HOME</B
9846 >from a command prompt, for example.</P
9848 >This option takes the standard substitutions, allowing
9849 you to have separate logon scripts for each user or machine.</P
9851 >This parameter can be used with Win9X workstations to ensure
9852 that roaming profiles are stored in a subdirectory of the user's
9853 home directory. This is done in the following way:</P
9857 >logon home = \\%N\%U\profile</B
9860 >This tells Samba to return the above string, with
9861 substitutions made when a client requests the info, generally
9862 in a NetUserGetInfo request. Win9X clients truncate the info to
9863 \\server\share when a user does <B
9867 but use the whole string when dealing with profiles.</P
9869 >Note that in prior versions of Samba, the <A
9877 > was returned rather than
9887 > but allowed profiles outside the home directory.
9888 The current implementation is correct, and can be used for
9889 profiles if you use the above trick.</P
9891 >This option is only useful if Samba is set up as a logon
9896 >logon home = "\\%N\%U"</B
9901 >logon home = "\\remote_smb_server\%U"</B
9912 >This parameter specifies the home directory
9913 where roaming profiles (NTuser.dat etc files for Windows NT) are
9914 stored. Contrary to previous versions of these manual pages, it has
9915 nothing to do with Win 9X roaming profiles. To find out how to
9916 handle roaming profiles for Win 9X system, see the <A
9926 >This option takes the standard substitutions, allowing you
9927 to have separate logon scripts for each user or machine. It also
9928 specifies the directory from which the "Application Data",
9938 >network neighborhood</TT
9943 and other folders, and their contents, are loaded and displayed on
9944 your Windows NT client.</P
9946 >The share and the path must be readable by the user for
9947 the preferences and directories to be loaded onto the Windows NT
9948 client. The share must be writeable when the user logs in for the first
9949 time, in order that the Windows NT client can create the NTuser.dat
9950 and other directories.</P
9952 >Thereafter, the directories and any of the contents can,
9953 if required, be made read-only. It is not advisable that the
9954 NTuser.dat file be made read-only - rename it to NTuser.man to
9955 achieve the desired effect (a <EM
9960 >Windows clients can sometimes maintain a connection to
9961 the [homes] share, even though there is no user logged in.
9962 Therefore, it is vital that the logon path does not include a
9963 reference to the homes share (i.e. setting this parameter to
9964 \%N\%U\profile_path will cause problems).</P
9966 >This option takes the standard substitutions, allowing
9967 you to have separate logon scripts for each user or machine.</P
9969 >Note that this option is only useful if Samba is set up
9970 as a logon server.</P
9974 >logon path = \\%N\%U\profile</B
9979 >logon path = \\PROFILESERVER\PROFILE\%U</B
9986 >logon script (G)</DT
9989 >This parameter specifies the batch file (.bat) or
9990 NT command file (.cmd) to be downloaded and run on a machine when
9991 a user successfully logs in. The file must contain the DOS
9992 style CR/LF line endings. Using a DOS-style editor to create the
9993 file is recommended.</P
9995 >The script must be a relative path to the [netlogon]
9996 service. If the [netlogon] service specifies a <A
10006 >/usr/local/samba/netlogon
10010 >logon script = STARTUP.BAT</B
10012 the file that will be downloaded is:</P
10016 >/usr/local/samba/netlogon/STARTUP.BAT</TT
10019 >The contents of the batch file are entirely your choice. A
10020 suggested command would be to add <B
10022 >NET TIME \\SERVER /SET
10024 >, to force every machine to synchronize clocks with
10025 the same time server. Another use would be to add <B
10028 U: \\SERVER\UTILS</B
10029 > for commonly used utilities, or <B
10031 > NET USE Q: \\SERVER\ISO9001_QA</B
10034 >Note that it is particularly important not to allow write
10035 access to the [netlogon] share, or to grant users write permission
10036 on the batch files in a secure environment, as this would allow
10037 the batch files to be arbitrarily modified and security to be
10040 >This option takes the standard substitutions, allowing you
10041 to have separate logon scripts for each user or machine.</P
10043 >This option is only useful if Samba is set up as a logon
10047 >no logon script defined</EM
10052 >logon script = scripts\%U.bat</B
10057 NAME="LPPAUSECOMMAND"
10059 >lppause command (S)</DT
10062 >This parameter specifies the command to be
10063 executed on the server host in order to stop printing or spooling
10064 a specific print job.</P
10066 >This command should be a program or script which takes
10067 a printer name and job number to pause the print job. One way
10068 of implementing this is by using job priorities, where jobs
10069 having a too low priority won't be sent to the printer.</P
10076 > is given then the printer name
10077 is put in its place. A <TT
10083 the job number (an integer). On HPUX (see <TT
10095 to the lpq command, the job will show up with the correct status, i.e.
10096 if the job priority is lower than the set fence priority it will
10097 have the PAUSED status, whereas if the priority is equal or higher it
10098 will have the SPOOLED or PRINTING status.</P
10100 >Note that it is good practice to include the absolute path
10101 in the lppause command as the PATH may not be available to the server.</P
10114 >Default: Currently no default value is given to
10115 this string, unless the value of the <TT
10124 >, in which case the default is :</P
10128 >lp -i %p-%j -H hold</B
10131 >or if the value of the <TT
10140 >, then the default is:</P
10144 >qstat -s -j%j -h</B
10147 >Example for HPUX: <B
10149 >lppause command = /usr/bin/lpalt
10155 NAME="LPQCACHETIME"
10157 >lpq cache time (G)</DT
10160 >This controls how long lpq info will be cached
10161 for to prevent the <B
10164 > command being called too
10165 often. A separate cache is kept for each variation of the <B
10168 > command used by the system, so if you use different
10172 > commands for different users then they won't
10173 share cache information.</P
10175 >The cache files are stored in <TT
10179 where xxxx is a hash of the <B
10182 > command in use.</P
10184 >The default is 10 seconds, meaning that the cached results
10185 of a previous identical <B
10188 > command will be used
10189 if the cached data is less than 10 seconds old. A large value may
10190 be advisable if your <B
10193 > command is very slow.</P
10195 >A value of 0 will disable caching completely.</P
10210 >lpq cache time = 10</B
10215 >lpq cache time = 30</B
10222 >lpq command (S)</DT
10225 >This parameter specifies the command to be
10226 executed on the server host in order to obtain <B
10230 >-style printer status information.</P
10232 >This command should be a program or script which
10233 takes a printer name as its only parameter and outputs printer
10234 status information.</P
10236 >Currently nine styles of printer status information
10237 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ.
10238 This covers most UNIX systems. You control which type is expected
10246 >Some clients (notably Windows for Workgroups) may not
10247 correctly send the connection number for the printer they are
10248 requesting status information about. To get around this, the
10249 server reports on the first printer service connected to by the
10250 client. This only happens if the connection number sent is invalid.</P
10257 > is given then the printer name
10258 is put in its place. Otherwise it is placed at the end of the
10261 >Note that it is good practice to include the absolute path
10271 > may not be available to the server. When compiled with
10272 the CUPS libraries, no <TT
10278 needed because smbd will make a library call to obtain the
10279 print queue listing.</P
10293 >depends on the setting of <TT
10303 >lpq command = /usr/bin/lpq -P%p</B
10308 NAME="LPRESUMECOMMAND"
10310 >lpresume command (S)</DT
10313 >This parameter specifies the command to be
10314 executed on the server host in order to restart or continue
10315 printing or spooling a specific print job.</P
10317 >This command should be a program or script which takes
10318 a printer name and job number to resume the print job. See
10320 HREF="#LPPAUSECOMMAND"
10335 > is given then the printer name
10336 is put in its place. A <TT
10342 the job number (an integer).</P
10344 >Note that it is good practice to include the absolute path
10348 >lpresume command</I
10350 > as the PATH may not
10351 be available to the server.</P
10364 >Default: Currently no default value is given
10365 to this string, unless the value of the <TT
10374 >, in which case the default is :</P
10378 >lp -i %p-%j -H resume</B
10381 >or if the value of the <TT
10390 >, then the default is:</P
10394 >qstat -s -j%j -r</B
10397 >Example for HPUX: <B
10399 >lpresume command = /usr/bin/lpalt
10407 >lprm command (S)</DT
10410 >This parameter specifies the command to be
10411 executed on the server host in order to delete a print job.</P
10413 >This command should be a program or script which takes
10414 a printer name and job number, and deletes the print job.</P
10421 > is given then the printer name
10422 is put in its place. A <TT
10428 the job number (an integer).</P
10430 >Note that it is good practice to include the absolute
10436 > as the PATH may not be
10437 available to the server.</P
10451 >depends on the setting of <TT
10462 >lprm command = /usr/bin/lprm -P%p %j
10468 >lprm command = /usr/bin/cancel %p-%j
10474 NAME="MACHINEPASSWORDTIMEOUT"
10476 >machine password timeout (G)</DT
10479 >If a Samba server is a member of a Windows
10480 NT Domain (see the <A
10481 HREF="#SECURITYEQUALSDOMAIN"
10482 >security = domain</A
10484 parameter) then periodically a running <A
10488 > process will try and change the MACHINE ACCOUNT
10489 PASSWORD stored in the TDB called <TT
10491 >private/secrets.tdb
10493 >. This parameter specifies how often this password
10494 will be changed, in seconds. The default is one week (expressed in
10495 seconds), the same as a Windows NT Domain member server.</P
10498 HREF="smbpasswd.8.html"
10506 HREF="#SECURITYEQUALSDOMAIN"
10507 > security = domain</A
10512 >machine password timeout = 604800</B
10519 >magic output (S)</DT
10522 >This parameter specifies the name of a file
10523 which will contain output created by a magic script (see the
10525 HREF="#MAGICSCRIPT"
10533 parameter below).</P
10535 >Warning: If two clients use the same <TT
10541 > in the same directory the output file content
10546 >magic output = <magic script name>.out
10552 >magic output = myfile.txt</B
10559 >magic script (S)</DT
10562 >This parameter specifies the name of a file which,
10563 if opened, will be executed by the server when the file is closed.
10564 This allows a UNIX script to be sent to the Samba host and
10565 executed on behalf of the connected user.</P
10567 >Scripts executed in this way will be deleted upon
10568 completion assuming that the user has the appropriate level
10569 of privilege and the file permissions allow the deletion.</P
10571 >If the script generates output, output will be sent to
10572 the file specified by the <A
10573 HREF="#MAGICOUTPUT"
10580 > parameter (see above).</P
10582 >Note that some shells are unable to interpret scripts
10583 containing CR/LF instead of CR as
10584 the end-of-line marker. Magic scripts must be executable
10587 > on the host, which for some hosts and
10588 some shells will require filtering at the DOS end.</P
10590 >Magic scripts are <EM
10595 > be relied upon.</P
10598 >None. Magic scripts disabled.</EM
10603 >magic script = user.csh</B
10610 >mangle case (S)</DT
10613 >See the section on <A
10620 >mangle case = no</B
10627 >mangled map (S)</DT
10630 >This is for those who want to directly map UNIX
10631 file names which cannot be represented on Windows/DOS. The mangling
10632 of names is not always what is needed. In particular you may have
10633 documents with file extensions that differ between DOS and UNIX.
10634 For example, under UNIX it is common to use <TT
10638 for HTML files, whereas under Windows/DOS <TT
10642 is more commonly used.</P
10655 >mangled map = (*.html *.htm)</B
10658 >One very useful case is to remove the annoying <TT
10662 > off the ends of filenames on some CDROMs (only visible
10663 under some UNIXes). To do this use a map of (*;1 *;).</P
10666 >no mangled map</EM
10671 >mangled map = (*;1 *;)</B
10676 NAME="MANGLEDNAMES"
10678 >mangled names (S)</DT
10681 >This controls whether non-DOS names under UNIX
10682 should be mapped to DOS-compatible names ("mangled") and made visible,
10683 or whether non-DOS names should simply be ignored.</P
10685 >See the section on <A
10688 > for details on how to control the mangling process.</P
10690 >If mangling is used then the mangling algorithm is as follows:</P
10696 >The first (up to) five alphanumeric characters
10697 before the rightmost dot of the filename are preserved, forced
10698 to upper case, and appear as the first (up to) five characters
10699 of the mangled name.</P
10703 >A tilde "~" is appended to the first part of the mangled
10704 name, followed by a two-character unique sequence, based on the
10705 original root name (i.e., the original filename minus its final
10706 extension). The final extension is included in the hash calculation
10707 only if it contains any upper case characters or is longer than three
10710 >Note that the character to use may be specified using
10712 HREF="#MANGLINGCHAR"
10720 > option, if you don't like '~'.</P
10724 >The first three alphanumeric characters of the final
10725 extension are preserved, forced to upper case and appear as the
10726 extension of the mangled name. The final extension is defined as that
10727 part of the original filename after the rightmost dot. If there are no
10728 dots in the filename, the mangled name will have no extension (except
10729 in the case of "hidden files" - see below).</P
10733 >Files whose UNIX name begins with a dot will be
10734 presented as DOS hidden files. The mangled name will be created as
10735 for other filenames, but with the leading dot removed and "___" as
10736 its extension regardless of actual original extension (that's three
10741 >The two-digit hash value consists of upper case
10742 alphanumeric characters.</P
10744 >This algorithm can cause name collisions only if files
10745 in a directory share the same first five alphanumeric characters.
10746 The probability of such a clash is 1/1300.</P
10748 >The name mangling (if enabled) allows a file to be
10749 copied between UNIX directories from Windows/DOS while retaining
10750 the long UNIX filename. UNIX files can be renamed to a new extension
10751 from Windows/DOS and will retain the same basename. Mangled names
10752 do not change between sessions.</P
10756 >mangled names = yes</B
10761 NAME="MANGLEDSTACK"
10763 >mangled stack (G)</DT
10766 >This parameter controls the number of mangled names
10767 that should be cached in the Samba server <A
10773 >This stack is a list of recently mangled base names
10774 (extensions are only maintained if they are longer than 3 characters
10775 or contains upper case characters).</P
10777 >The larger this value, the more likely it is that mangled
10778 names can be successfully converted to correct long UNIX names.
10779 However, large stack sizes will slow most directory accesses. Smaller
10780 stacks save memory in the server (each stack element costs 256 bytes).
10783 >It is not possible to absolutely guarantee correct long
10784 filenames, so be prepared for some surprises!</P
10788 >mangled stack = 50</B
10793 >mangled stack = 100</B
10798 NAME="MANGLINGCHAR"
10800 >mangling char (S)</DT
10803 >This controls what character is used as
10809 >. The default is a '~'
10810 but this may interfere with some software. Use this option to set
10811 it to whatever you prefer.</P
10815 >mangling char = ~</B
10820 >mangling char = ^</B
10827 >map archive (S)</DT
10830 >This controls whether the DOS archive attribute
10831 should be mapped to the UNIX owner execute bit. The DOS archive bit
10832 is set when a file has been modified since its last backup. One
10833 motivation for this option it to keep Samba/your PC from making
10834 any file it touches from becoming executable under UNIX. This can
10835 be quite annoying for shared source code, documents, etc...</P
10837 >Note that this requires the <TT
10843 parameter to be set such that owner execute bit is not masked out
10844 (i.e. it must include 100). See the parameter <A
10856 >map archive = yes</B
10863 >map hidden (S)</DT
10866 >This controls whether DOS style hidden files
10867 should be mapped to the UNIX world execute bit.</P
10869 >Note that this requires the <TT
10875 to be set such that the world execute bit is not masked out (i.e.
10876 it must include 001). See the parameter <A
10888 >map hidden = no</B
10895 >map system (S)</DT
10898 >This controls whether DOS style system files
10899 should be mapped to the UNIX group execute bit.</P
10901 >Note that this requires the <TT
10907 to be set such that the group execute bit is not masked out (i.e.
10908 it must include 010). See the parameter <A
10920 >map system = no</B
10927 >map to guest (G)</DT
10930 >This parameter is only useful in <A
10933 > modes other than <TT
10936 >security = share</I
10951 >This parameter can take three different values, which tell
10956 > what to do with user
10957 login requests that don't match a valid UNIX user in some way.</P
10959 >The three settings are :</P
10968 > - Means user login
10969 requests with an invalid password are rejected. This is the
10978 logins with an invalid password are rejected, unless the username
10979 does not exist, in which case it is treated as a guest login and
10981 HREF="#GUESTACCOUNT"
10995 > - Means user logins
10996 with an invalid password are treated as a guest login and mapped
10998 HREF="#GUESTACCOUNT"
11001 this can cause problems as it means that any user incorrectly typing
11002 their password will be silently logged on as "guest" - and
11003 will not know the reason they cannot access files they think
11004 they should - there will have been no message given to them
11005 that they got their password wrong. Helpdesk services will
11008 > you if you set the <TT
11014 > parameter this way :-).</P
11018 >Note that this parameter is needed to set up "Guest"
11019 share services when using <TT
11025 share. This is because in these modes the name of the resource being
11028 > sent to the server until after
11029 the server has successfully authenticated the client so the server
11030 cannot make authentication decisions at the correct time (connection
11031 to the share) for "Guest" shares.</P
11033 >For people familiar with the older Samba releases, this
11034 parameter maps to the old compile-time setting of the <TT
11036 > GUEST_SESSSETUP</TT
11037 > value in local.h.</P
11041 >map to guest = Never</B
11046 >map to guest = Bad User</B
11051 NAME="MAXCONNECTIONS"
11053 >max connections (S)</DT
11056 >This option allows the number of simultaneous
11057 connections to a service to be limited. If <TT
11063 > is greater than 0 then connections will be refused if
11064 this number of connections to the service are already open. A value
11065 of zero mean an unlimited number of connections may be made.</P
11067 >Record lock files are used to implement this feature. The
11068 lock files will be stored in the directory specified by the <A
11069 HREF="#LOCKDIRECTORY"
11081 >max connections = 0</B
11086 >max connections = 10</B
11093 >max disk size (G)</DT
11096 >This option allows you to put an upper limit
11097 on the apparent size of disks. If you set this option to 100
11098 then all shares will appear to be not larger than 100 MB in
11101 >Note that this option does not limit the amount of
11102 data you can put on the disk. In the above case you could still
11103 store much more than 100 MB on the disk, but if a client ever asks
11104 for the amount of free disk space or the total disk size then the
11105 result will be bounded by the amount specified in <TT
11113 >This option is primarily useful to work around bugs
11114 in some pieces of software that can't handle very large disks,
11115 particularly disks over 1GB in size.</P
11122 > of 0 means no limit.</P
11126 >max disk size = 0</B
11131 >max disk size = 1000</B
11138 >max log size (G)</DT
11141 >This option (an integer in kilobytes) specifies
11142 the max size the log file should grow to. Samba periodically checks
11143 the size and if it is exceeded it will rename the file, adding
11149 >A size of 0 means no limit.</P
11153 >max log size = 5000</B
11158 >max log size = 1000</B
11168 >This option controls the maximum number of
11169 outstanding simultaneous SMB operations that Samba tells the client
11170 it will allow. You should never need to set this parameter.</P
11179 NAME="MAXOPENFILES"
11181 >max open files (G)</DT
11184 >This parameter limits the maximum number of
11185 open files that one <A
11190 serving process may have open for a client at any one time. The
11191 default for this parameter is set very high (10,000) as Samba uses
11192 only one bit per unopened file.</P
11194 >The limit of the number of open files is usually set
11195 by the UNIX per-process file descriptor limit rather than
11196 this parameter so you should never need to touch this parameter.</P
11200 >max open files = 10000</B
11205 NAME="MAXPRINTJOBS"
11207 >max print jobs (S)</DT
11210 >This parameter limits the maximum number of
11211 jobs allowable in a Samba printer queue at any given moment.
11212 If this number is exceeded, <A
11219 > will remote "Out of Space" to the client.
11221 HREF="#TOTALPRINTJOBS"
11234 >max print jobs = 1000</B
11239 >max print jobs = 5000</B
11246 >max protocol (G)</DT
11249 >The value of the parameter (a string) is the highest
11250 protocol level that will be supported by the server.</P
11252 >Possible values are :</P
11261 >: Earliest version. No
11262 concept of user names.</P
11269 >: Slight improvements on
11270 CORE for efficiency.</P
11279 > version of the protocol. Long filename
11287 >: Updates to Lanman1 protocol.
11295 >: Current up to date version of
11296 the protocol. Used by Windows NT. Known as CIFS.</P
11300 >Normally this option should not be set as the automatic
11301 negotiation phase in the SMB protocol takes care of choosing
11302 the appropriate protocol.</P
11305 HREF="#MINPROTOCOL"
11317 >max protocol = NT1</B
11322 >max protocol = LANMAN1</B
11327 NAME="MAXSMBDPROCESSES"
11329 >max smbd processes (G)</DT
11332 >This parameter limits the maximum number of
11341 processes concurrently running on a system and is intended
11342 as a stopgap to prevent degrading service to clients in the event
11343 that the server has insufficient resources to handle more than this
11344 number of connections. Remember that under normal operating
11345 conditions, each user will have an <A
11349 > associated with him or her
11350 to handle connections to all shares from a given host.
11355 >max smbd processes = 0</B
11360 >max smbd processes = 1000</B
11370 >This option tells <A
11375 what the default 'time to live' of NetBIOS names should be (in seconds)
11379 > is requesting a name using either a
11380 broadcast packet or from a WINS server. You should never need to
11381 change this parameter. The default is 3 days.</P
11385 >max ttl = 259200</B
11392 >max wins ttl (G)</DT
11395 >This option tells <A
11400 > when acting as a WINS server (<A
11401 HREF="#WINSSUPPORT"
11405 >wins support = yes</I
11408 >) what the maximum
11409 'time to live' of NetBIOS names that <B
11413 will grant will be (in seconds). You should never need to change this
11414 parameter. The default is 6 days (518400 seconds).</P
11429 >max wins ttl = 518400</B
11439 >This option controls the maximum packet size
11440 that will be negotiated by Samba. The default is 65535, which
11441 is the maximum. In some cases you may find you get better performance
11442 with a smaller value. A value below 2048 is likely to cause problems.
11447 >max xmit = 65535</B
11452 >max xmit = 8192</B
11457 NAME="MESSAGECOMMAND"
11459 >message command (G)</DT
11462 >This specifies what command to run when the
11463 server receives a WinPopup style message.</P
11465 >This would normally be a command that would
11466 deliver the message somehow. How this is to be done is
11467 up to your imagination.</P
11473 >message command = csh -c 'xedit %s;rm %s' &</B
11477 >This delivers the message using <B
11481 removes it afterwards. <EM
11482 >NOTE THAT IT IS VERY IMPORTANT
11483 THAT THIS COMMAND RETURN IMMEDIATELY</EM
11485 have the '&' on the end. If it doesn't return immediately then
11486 your PCs may freeze when sending messages (they should recover
11487 after 30 seconds, hopefully).</P
11489 >All messages are delivered as the global guest user.
11490 The command takes the standard substitutions, although <TT
11503 >Apart from the standard substitutions, some additional
11504 ones apply. In particular:</P
11515 > = the filename containing
11525 > = the destination that
11526 the message was sent to (probably the server name).</P
11535 > = who the message
11540 >You could make this command send mail, or whatever else
11541 takes your fancy. Please let us know of any really interesting
11544 >Here's a way of sending the messages as mail to root:</P
11548 >message command = /bin/mail -s 'message from %f on
11549 %m' root < %s; rm %s</B
11552 >If you don't have a message command then the message
11553 won't be delivered and Samba will tell the sender there was
11554 an error. Unfortunately WfWg totally ignores the error code
11555 and carries on regardless, saying that the message was delivered.
11558 >If you want to silently delete it then try:</P
11562 >message command = rm %s</B
11566 >no message command</EM
11571 >message command = csh -c 'xedit %s;
11577 NAME="MINPASSWDLENGTH"
11579 >min passwd length (G)</DT
11583 HREF="#MINPASSWORDLENGTH"
11587 >min password length</I
11594 NAME="MINPASSWORDLENGTH"
11596 >min password length (G)</DT
11599 >This option sets the minimum length in characters
11600 of a plaintext password that <B
11603 > will accept when performing
11604 UNIX password changing.</P
11607 HREF="#UNIXPASSWORDSYNC"
11616 HREF="#PASSWDPROGRAM"
11624 HREF="#PASSWDCHATDEBUG"
11628 >passwd chat debug</I
11636 >min password length = 5</B
11641 NAME="MINPRINTSPACE"
11643 >min print space (S)</DT
11646 >This sets the minimum amount of free disk
11647 space that must be available before a user will be able to spool
11648 a print job. It is specified in kilobytes. The default is 0, which
11649 means a user can always spool a print job.</P
11664 >min print space = 0</B
11669 >min print space = 2000</B
11676 >min protocol (G)</DT
11679 >The value of the parameter (a string) is the
11680 lowest SMB protocol dialect than Samba will support. Please refer
11682 HREF="#MAXPROTOCOL"
11690 parameter for a list of valid protocol names and a brief description
11691 of each. You may also wish to refer to the C source code in
11694 >source/smbd/negprot.c</TT
11695 > for a listing of known protocol
11696 dialects supported by clients.</P
11698 >If you are viewing this parameter as a security measure, you should
11699 also refer to the <A
11708 > parameter. Otherwise, you should never need
11709 to change this parameter.</P
11713 >min protocol = CORE</B
11718 >min protocol = NT1</B
11726 >min wins ttl (G)</DT
11729 >This option tells <A
11734 when acting as a WINS server (<A
11735 HREF="#WINSSUPPORT"
11739 > wins support = yes</I
11742 >) what the minimum 'time to live'
11743 of NetBIOS names that <B
11746 > will grant will be (in
11747 seconds). You should never need to change this parameter. The default
11748 is 6 hours (21600 seconds).</P
11752 >min wins ttl = 21600</B
11759 >msdfs root (S)</DT
11762 >This boolean parameter is only available if
11763 Samba is configured and compiled with the <B
11766 > option. If set to <TT
11770 Samba treats the share as a Dfs root and allows clients to browse
11771 the distributed file system tree rooted at the share directory.
11772 Dfs links are specified in the share directory by symbolic
11773 links of the form <TT
11775 >msdfs:serverA\shareA,serverB\shareB
11777 > and so on. For more information on setting up a Dfs tree
11778 on Samba, refer to <A
11779 HREF="msdfs_setup.html"
11798 >msdfs root = no</B
11803 NAME="NAMERESOLVEORDER"
11805 >name resolve order (G)</DT
11808 >This option is used by the programs in the Samba
11809 suite to determine what naming services to use and in what order
11810 to resolve host names to IP addresses. The option takes a space
11811 separated string of name resolution options.</P
11813 >The options are :"lmhosts", "host", "wins" and "bcast". They
11814 cause names to be resolved as follows :</P
11824 address in the Samba lmhosts file. If the line in lmhosts has
11825 no name type attached to the NetBIOS name (see the <A
11826 HREF="lmhosts.5.html"
11829 > for details) then
11830 any name type matches for lookup.</P
11837 > : Do a standard host
11838 name to IP address resolution, using the system <TT
11842 >, NIS, or DNS lookups. This method of name resolution
11843 is operating system depended for instance on IRIX or Solaris this
11844 may be controlled by the <TT
11846 >/etc/nsswitch.conf</TT
11848 file. Note that this method is only used if the NetBIOS name
11849 type being queried is the 0x20 (server) name type, otherwise
11857 > : Query a name with
11858 the IP address listed in the <A
11866 > parameter. If no WINS server has
11867 been specified this method will be ignored.</P
11874 > : Do a broadcast on
11875 each of the known local interfaces listed in the <A
11884 parameter. This is the least reliable of the name resolution
11885 methods as it depends on the target host being on a locally
11886 connected subnet.</P
11892 >name resolve order = lmhosts host wins bcast
11898 >name resolve order = lmhosts bcast host
11902 >This will cause the local lmhosts file to be examined
11903 first, followed by a broadcast attempt, followed by a normal
11904 system hostname lookup.</P
11908 NAME="NETBIOSALIASES"
11910 >netbios aliases (G)</DT
11913 >This is a list of NetBIOS names that <A
11917 > will advertise as additional
11918 names by which the Samba server is known. This allows one machine
11919 to appear in browse lists under multiple names. If a machine is
11920 acting as a browse server or logon server none
11921 of these names will be advertised as either browse server or logon
11922 servers, only the primary name of the machine will be advertised
11923 with these capabilities.</P
11926 HREF="#NETBIOSNAME"
11937 >empty string (no additional names)</EM
11942 >netbios aliases = TEST TEST1 TEST2</B
11949 >netbios name (G)</DT
11952 >This sets the NetBIOS name by which a Samba
11953 server is known. By default it is the same as the first component
11954 of the host's DNS name. If a machine is a browse server or
11955 logon server this name (or the first component
11956 of the hosts DNS name) will be the name that these services are
11957 advertised under.</P
11960 HREF="#NETBIOSALIASES"
11971 >machine DNS name</EM
11976 >netbios name = MYNAME</B
11981 NAME="NETBIOSSCOPE"
11983 >netbios scope (G)</DT
11986 >This sets the NetBIOS scope that Samba will
11987 operate under. This should not be set unless every machine
11988 on your LAN also sets this value.</P
11994 >nis homedir (G)</DT
11997 >Get the home share server from a NIS map. For
11998 UNIX systems that use an automounter, the user's home directory
11999 will often be mounted on a workstation on demand from a remote
12002 >When the Samba logon server is not the actual home directory
12003 server, but is mounting the home directories via NFS then two
12004 network hops would be required to access the users home directory
12005 if the logon server told the client to use itself as the SMB server
12006 for home directories (one over SMB and one over NFS). This can
12009 >This option allows Samba to return the home share as
12010 being on a different server to the logon server and as
12011 long as a Samba daemon is running on the home directory server,
12012 it will be mounted on the Samba client directly from the directory
12013 server. When Samba is returning the home share to the client, it
12014 will consult the NIS map specified in <A
12022 > and return the server
12025 >Note that for this option to work there must be a working
12026 NIS system and the Samba server with this option must also
12027 be a logon server.</P
12031 >nis homedir = no</B
12036 NAME="NONUNIXACCOUNTRANGE"
12038 >non unix account range (G)</DT
12041 >The non unix account range parameter specifies
12042 the range of 'user ids' that are allocated by the various 'non unix
12043 account' passdb backends. These backends allow
12044 the storage of passwords for users who don't exist in /etc/passwd.
12045 This is most often used for machine account creation.
12046 This range of ids should have no existing local or NIS users within
12047 it as strange conflicts can occur otherwise.</P
12049 >NOTE: These userids never appear on the system and Samba will never
12050 'become' these users. They are used only to ensure that the algorithmic
12051 RID mapping does not conflict with normal users.
12056 >non unix account range = <empty string>
12062 >non unix account range = 10000-20000</B
12067 NAME="NTACLSUPPORT"
12069 >nt acl support (S)</DT
12072 >This boolean parameter controls whether
12077 > will attempt to map
12078 UNIX permissions into Windows NT access control lists.
12079 This parameter was formally a global parameter in releases
12084 >nt acl support = yes</B
12089 NAME="NTPIPESUPPORT"
12091 >nt pipe support (G)</DT
12094 >This boolean parameter controls whether
12099 > will allow Windows NT
12100 clients to connect to the NT SMB specific <TT
12104 pipes. This is a developer debugging option and can be left
12109 >nt pipe support = yes</B
12114 NAME="NTSTATUSSUPPORT"
12116 >nt status support (G)</DT
12119 >This boolean parameter controls whether <A
12123 > will negotiate NT specific status
12124 support with Windows NT/2k/XP clients. This is a developer
12125 debugging option and should be left alone.
12126 If this option is set to <TT
12129 > then Samba offers
12130 exactly the same DOS error codes that versions prior to Samba 2.2.3
12133 >You should not need to ever disable this parameter.</P
12137 >nt status support = yes</B
12142 NAME="NULLPASSWORDS"
12144 >null passwords (G)</DT
12147 >Allow or disallow client access to accounts
12148 that have null passwords. </P
12151 HREF="smbpasswd.5.html"
12158 >null passwords = no</B
12163 NAME="OBEYPAMRESTRICTIONS"
12165 >obey pam restrictions (G)</DT
12168 >When Samba 2.2 is configured to enable PAM support
12169 (i.e. --with-pam), this parameter will control whether or not Samba
12170 should obey PAM's account and session management directives. The
12171 default behavior is to use PAM for clear text authentication only
12172 and to ignore any account or session management. Note that Samba
12173 always ignores PAM for authentication in the case of <A
12174 HREF="#ENCRYPTPASSWORDS"
12178 >encrypt passwords = yes</I
12182 >. The reason is that PAM modules cannot support the challenge/response
12183 authentication mechanism needed in the presence of SMB password encryption.
12188 >obey pam restrictions = no</B
12198 >This is a boolean option that controls whether
12199 connections with usernames not in the <TT
12205 list will be allowed. By default this option is disabled so that a
12206 client can supply a username to be used by the server. Enabling
12207 this parameter will force the server to only user the login
12213 > list and is only really
12215 HREF="#SECURITYEQUALSSHARE"
12220 >Note that this also means Samba won't try to deduce
12221 usernames from the service name. This can be annoying for
12222 the [homes] section. To get around this you could use <B
12226 > which means your <TT
12232 will be just the service name, which for home directories is the
12233 name of the user.</P
12255 >only guest (S)</DT
12270 NAME="OPLOCKBREAKWAITTIME"
12272 >oplock break wait time (G)</DT
12275 >This is a tuning parameter added due to bugs in
12276 both Windows 9x and WinNT. If Samba responds to a client too
12277 quickly when that client issues an SMB that can cause an oplock
12278 break request, then the network client can fail and not respond
12279 to the break request. This tuning parameter (which is set in milliseconds)
12280 is the amount of time Samba will wait before sending an oplock break
12281 request to such (broken) clients.</P
12284 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
12285 AND UNDERSTOOD THE SAMBA OPLOCK CODE</EM
12290 >oplock break wait time = 0</B
12295 NAME="OPLOCKCONTENTIONLIMIT"
12297 >oplock contention limit (S)</DT
12308 improve the efficiency of the granting of oplocks under multiple
12309 client contention for the same file.</P
12311 >In brief it specifies a number, which causes <A
12316 grant an oplock even when requested if the approximate number of
12317 clients contending for an oplock on the same file goes over this
12318 limit. This causes <B
12321 > to behave in a similar
12322 way to Windows NT.</P
12325 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
12326 AND UNDERSTOOD THE SAMBA OPLOCK CODE</EM
12331 >oplock contention limit = 2</B
12341 >This boolean option tells <B
12345 issue oplocks (opportunistic locks) to file open requests on this
12346 share. The oplock code can dramatically (approx. 30% or more) improve
12347 the speed of access to files on Samba servers. It allows the clients
12348 to aggressively cache files locally and you may want to disable this
12349 option for unreliable network environments (it is turned on by
12350 default in Windows NT Servers). For more information see the file
12360 >Oplocks may be selectively turned off on certain files with a
12362 HREF="#VETOOPLOCKFILES"
12366 > veto oplock files</I
12369 > parameter. On some systems
12370 oplocks are recognized by the underlying operating system. This
12371 allows data synchronization between all access to oplocked files,
12372 whether it be via Samba or NFS or a local UNIX process. See the
12378 > parameter for details.</P
12381 HREF="#KERNELOPLOCKS"
12390 HREF="#LEVEL2OPLOCKS"
12394 > level2 oplocks</I
12411 >This integer value controls what level Samba
12412 advertises itself as for browse elections. The value of this
12413 parameter determines whether <A
12418 has a chance of becoming a local master browser for the <TT
12423 > in the local broadcast area.</P
12427 >By default, Samba will win
12428 a local master browsing election over all Microsoft operating
12429 systems except a Windows NT 4.0/2000 Domain Controller. This
12430 means that a misconfigured Samba host can effectively isolate
12431 a subnet for browsing purposes. See <TT
12453 NAME="OS2DRIVERMAP"
12455 >os2 driver map (G)</DT
12458 >The parameter is used to define the absolute
12459 path to a file containing a mapping of Windows NT printer driver
12460 names to OS/2 printer driver names. The format is:</P
12462 ><nt driver name> = <os2 driver
12463 name>.<device name></P
12465 >For example, a valid entry using the HP LaserJet 5
12466 printer driver would appear as <B
12468 >HP LaserJet 5L = LASERJET.HP
12472 >The need for the file is due to the printer driver namespace
12473 problem described in the <A
12474 HREF="printer_driver2.html"
12478 >. For more details on OS/2 clients, please
12480 HREF="OS2-Client-HOWTO.html"
12484 > containing in the Samba documentation.</P
12488 >os2 driver map = <empty string>
12494 NAME="PAMPASSWORDCHANGE"
12496 >pam password change (G)</DT
12499 >With the addition of better PAM support in Samba 2.2,
12500 this parameter, it is possible to use PAM's password change control
12501 flag for Samba. If enabled, then PAM will be used for password
12502 changes when requested by an SMB client instead of the program listed in
12504 HREF="#PASSWDPROGRAM"
12512 It should be possible to enable this without changing your
12522 parameter for most setups.
12527 >pam password change = no</B
12534 >panic action (G)</DT
12537 >This is a Samba developer option that allows a
12538 system command to be called when either <A
12547 crashes. This is usually used to draw attention to the fact that
12548 a problem occurred.</P
12552 >panic action = <empty string></B
12557 >panic action = "/bin/sleep 90000"</B
12562 NAME="PASSDBBACKEND"
12564 >passdb backend (G)</DT
12567 >This option allows the administrator to chose which backends to retrieve and store passwords with. This allows (for example) both
12568 smbpasswd and tdbsam to be used without a recompile.
12569 Multiple backends can be specified, seperated by spaces. The backends will be searched in the order they are specified. New users are always added to the first backend specified.
12570 Experimental backends must still be selected
12571 (eg --with-tdbsam) at configure time.
12574 >This paramater is in two parts, the backend's name, and a 'location'
12575 string that has meaning only to that particular backed. These are separated
12576 by a : character.</P
12578 >Available backends can include:
12587 > - The default smbpasswd
12588 backend. Takes a path to the smbpasswd file as an optional argument.</P
12596 backend, but with support for 'not unix accounts'.
12597 Takes a path to the smbpasswd file as an optional argument.</P
12600 HREF="#NONUNIXACCOUNTRANGE"
12604 >non unix account range</I
12614 > - The TDB based password storage
12615 backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
12631 > - The TDB based password storage
12632 backend, with non unix account support. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
12644 HREF="#NONUNIXACCOUNTRANGE"
12648 >non unix account range</I
12658 > - The LDAP based passdb
12659 backend. Takes an LDAP URL as an optional argument (defaults to
12662 >ldap://localhost</B
12670 > - The LDAP based passdb
12671 backend, with non unix account support. Takes an LDAP URL as an optional argument (defaults to
12674 >ldap://localhost</B
12678 HREF="#NONUNIXACCOUNTRANGE"
12682 >non unix account range</I
12692 > - Allows Samba to load an
12693 arbitary passdb backend from the .so specified as a compulsary argument.
12696 >Any characters after the (optional) second : are passed to the plugin
12697 for its own processing</P
12704 > - Allows samba to map all (other) available unix users</P
12706 >This backend uses the standard unix database for retrieving users. Users included
12707 in this pdb are NOT listed in samba user listings and users included in this pdb won't be
12708 able to login. The use of this backend is to always be able to display the owner of a file
12709 on the samba server - even when the user doesn't have a 'real' samba account in one of the
12710 other passdb backends.
12713 >This backend should always be the last backend listed, since it contains all users in
12714 the unix passdb and might 'override' mappings if specified earlier. It's meant to only return
12715 accounts for users that aren't covered by the previous backends.</P
12723 >passdb backend = smbpasswd unixsam</B
12728 >passdb backend = tdbsam:/etc/samba/private/passdb.tdb smbpasswd:/etc/samba/smbpasswd unixsam</B
12733 >passdb backend = ldapsam_nua:ldaps://ldap.example.com unixsam</B
12738 >passdb backend = plugin:/usr/local/samba/lib/my_passdb.so:my_plugin_args tdbsam:/etc/samba/private/passdb.tdb</B
12745 >passwd chat (G)</DT
12748 >This string controls the <EM
12751 conversation that takes places between <A
12755 > and the local password changing
12756 program to change the user's password. The string describes a
12757 sequence of response-receive pairs that <A
12761 > uses to determine what to send to the
12763 HREF="#PASSWDPROGRAM"
12771 > and what to expect back. If the expected output is not
12772 received then the password is not changed.</P
12774 >This chat sequence is often quite site specific, depending
12775 on what local methods are used for password control (such as NIS
12778 >Note that this parameter only is only used if the <A
12779 HREF="#UNIXPASSWORDSYNC"
12787 > parameter is set to <TT
12791 sequence is then called <EM
12793 > when the SMB password
12794 in the smbpasswd file is being changed, without access to the old
12795 password cleartext. This means that root must be able to reset the user's password
12796 without knowing the text of the previous password. In the presence of NIS/YP,
12797 this means that the <A
12798 HREF="#PASSWDPROGRAM"
12801 executed on the NIS master.
12804 >The string can contain the macro <TT
12809 > which is substituted
12810 for the new password. The chat sequence can also contain the standard
12823 > to give line-feed,
12824 carriage-return, tab and space. The chat sequence string can also contain
12825 a '*' which matches any sequence of characters.
12826 Double quotes can be used to collect strings with spaces
12827 in them into a single string.</P
12829 >If the send string in any part of the chat sequence
12830 is a full stop ".", then no string is sent. Similarly,
12831 if the expect string is a full stop then no string is expected.</P
12834 HREF="#PAMPASSWORDCHANGE"
12842 > parameter is set to true, the chat pairs
12843 may be matched in any order, and success is determined by the PAM result,
12844 not any particular output. The \n macro is ignored for PAM conversions.
12848 HREF="#UNIXPASSWORDSYNC"
12857 HREF="#PASSWDPROGRAM"
12861 > passwd program</I
12865 HREF="#PASSWDCHATDEBUG"
12869 >passwd chat debug</I
12873 HREF="#PAMPASSWORDCHANGE"
12877 >pam password change</I
12884 >passwd chat = *new*password* %n\n
12885 *new*password* %n\n *changed*</B
12890 >passwd chat = "*Enter OLD password*" %o\n
12891 "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password
12897 NAME="PASSWDCHATDEBUG"
12899 >passwd chat debug (G)</DT
12902 >This boolean specifies if the passwd chat script
12903 parameter is run in <EM
12905 > mode. In this mode the
12906 strings passed to and received from the passwd chat are printed
12921 of 100. This is a dangerous option as it will allow plaintext passwords
12922 to be seen in the <B
12925 > log. It is available to help
12926 Samba admins debug their <TT
12932 when calling the <TT
12938 be turned off after this has been done. This option has no effect if the
12940 HREF="#PAMPASSWORDCHANGE"
12944 >pam password change</I
12948 paramter is set. This parameter is off by default.</P
12960 HREF="#PAMPASSWORDCHANGE"
12964 >pam password change</I
12969 HREF="#PASSWDPROGRAM"
12981 >passwd chat debug = no</B
12986 NAME="PASSWDPROGRAM"
12988 >passwd program (G)</DT
12991 >The name of a program that can be used to set
12992 UNIX user passwords. Any occurrences of <TT
12998 will be replaced with the user name. The user name is checked for
12999 existence before calling the password changing program.</P
13001 >Also note that many passwd programs insist in <EM
13004 > passwords, such as a minimum length, or the inclusion
13005 of mixed case chars and digits. This can pose a problem as some clients
13006 (such as Windows for Workgroups) uppercase the password before sending
13017 > parameter is set to <TT
13021 > then this program is called <EM
13024 before the SMB password in the <A
13025 HREF="smbpasswd.5.html"
13029 > file is changed. If this UNIX password change fails, then
13033 > will fail to change the SMB password also
13034 (this is by design).</P
13039 >unix password sync</I
13042 is set this parameter <EM
13043 >MUST USE ABSOLUTE PATHS</EM
13047 > programs called, and must be examined
13048 for security implications. Note that by default <TT
13060 HREF="#UNIXPASSWORDSYNC"
13072 >passwd program = /bin/passwd</B
13077 >passwd program = /sbin/npasswd %u</B
13083 NAME="PASSWORDLEVEL"
13085 >password level (G)</DT
13088 >Some client/server combinations have difficulty
13089 with mixed-case passwords. One offending client is Windows for
13090 Workgroups, which for some reason forces passwords to upper
13091 case when using the LANMAN1 protocol, but leaves them alone when
13092 using COREPLUS! Another problem child is the Windows 95/98
13093 family of operating systems. These clients upper case clear
13094 text passwords even when NT LM 0.12 selected by the protocol
13095 negotiation request/response.</P
13097 >This parameter defines the maximum number of characters
13098 that may be upper case in passwords.</P
13100 >For example, say the password given was "FRED". If <TT
13103 > password level</I
13105 > is set to 1, the following combinations
13106 would be tried if "FRED" failed:</P
13108 >"Fred", "fred", "fRed", "frEd","freD"</P
13116 the following combinations would also be tried: </P
13118 >"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..</P
13122 >The higher value this parameter is set to the more likely
13123 it is that a mixed case password will be matched against a single
13124 case password. However, you should be aware that use of this
13125 parameter reduces security and increases the time taken to
13126 process a new connection.</P
13128 >A value of zero will cause only two attempts to be
13129 made - the password as is and the password in all-lower case.</P
13133 >password level = 0</B
13138 >password level = 4</B
13143 NAME="PASSWORDSERVER"
13145 >password server (G)</DT
13148 >By specifying the name of another SMB server (such
13149 as a WinNT box) with this option, and using <B
13155 >security = server</B
13156 > you can get Samba
13157 to do all its username/password validation via a remote server.</P
13159 >This option sets the name of the password server to use.
13160 It must be a NetBIOS name, so if the machine's NetBIOS name is
13161 different from its Internet name then you may have to add its NetBIOS
13162 name to the lmhosts file which is stored in the same directory
13168 >The name of the password server is looked up using the
13170 HREF="#NAMERESOLVEORDER"
13178 > and so may resolved
13179 by any method and order described in that parameter.</P
13181 >The password server much be a machine capable of using
13182 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
13183 user level security mode.</P
13187 > Using a password server
13188 means your UNIX box (running Samba) is only as secure as your
13189 password server. <EM
13190 >DO NOT CHOOSE A PASSWORD SERVER THAT
13191 YOU DON'T COMPLETELY TRUST</EM
13194 >Never point a Samba server at itself for password
13195 serving. This will cause a loop and could lock up your Samba
13198 >The name of the password server takes the standard
13199 substitutions, but probably the only useful one is <TT
13205 >, which means the Samba server will use the incoming
13206 client as the password server. If you use this then you better
13207 trust your clients, and you had better restrict them with hosts allow!</P
13214 > parameter is set to
13218 >, then the list of machines in this
13219 option must be a list of Primary or Backup Domain controllers for the
13220 Domain or the character '*', as the Samba server is effectively
13221 in that domain, and will use cryptographically authenticated RPC calls
13222 to authenticate the user logging on. The advantage of using <B
13224 > security = domain</B
13225 > is that if you list several hosts in the
13229 >password server</I
13235 > will try each in turn till it finds one that responds. This
13236 is useful in case your primary server goes down.</P
13241 >password server</I
13244 to the character '*', then Samba will attempt to auto-locate the
13245 Primary or Backup Domain controllers to authenticate against by
13246 doing a query for the name <TT
13248 >WORKGROUP<1C></TT
13250 and then contacting each server returned in the list of IP
13251 addresses from the name resolution source. </P
13262 >, then there are different
13263 restrictions that <B
13265 >security = domain</B
13273 >You may list several password servers in
13277 >password server</I
13279 > parameter, however if an
13283 > makes a connection to a password server,
13284 and then the password server fails, no more users will be able
13285 to be authenticated from this <B
13289 restriction of the SMB/CIFS protocol when in <B
13293 > mode and cannot be fixed in Samba.</P
13297 >If you are using a Windows NT server as your
13298 password server then you will have to ensure that your users
13299 are able to login from the Samba server, as when in <B
13301 > security = server</B
13302 > mode the network logon will appear to
13303 come from there rather than from the users workstation.</P
13320 >password server = <empty string></B
13326 >password server = NT-PDC, NT-BDC1, NT-BDC2
13332 >password server = *</B
13342 >This parameter specifies a directory to which
13343 the user of the service is to be given access. In the case of
13344 printable services, this is where print data will spool prior to
13345 being submitted to the host for printing.</P
13347 >For a printable service offering guest access, the service
13348 should be readonly and the path should be world-writeable and
13349 have the sticky bit set. This is not mandatory of course, but
13350 you probably won't get the results you expect if you do
13353 >Any occurrences of <TT
13359 will be replaced with the UNIX username that the client is using
13360 on this connection. Any occurrences of <TT
13366 will be replaced by the NetBIOS name of the machine they are
13367 connecting from. These replacements are very useful for setting
13368 up pseudo home directories for users.</P
13370 >Note that this path will be based on <A
13378 > if one was specified.</P
13386 >path = /home/fred</B
13391 NAME="PIDDIRECTORY"
13393 >pid directory (G)</DT
13396 >This option specifies the directory where pid
13397 files will be placed. </P
13401 >pid directory = ${prefix}/var/locks</B
13406 >pid directory = /var/run/</B
13412 NAME="POSIXLOCKING"
13414 >posix locking (S)</DT
13425 daemon maintains an database of file locks obtained by SMB clients.
13426 The default behavior is to map this internal database to POSIX
13427 locks. This means that file locks obtained by SMB clients are
13428 consistent with those seen by POSIX compliant applications accessing
13429 the files via a non-SMB method (e.g. NFS or local file access).
13430 You should never need to disable this parameter.</P
13434 >posix locking = yes</B
13444 >This option specifies a command to be run
13445 whenever the service is disconnected. It takes the usual
13446 substitutions. The command may be run as the root on some
13449 >An interesting example may be to unmount server
13454 >postexec = /etc/umount /cdrom</B
13469 >none (no command executed)</EM
13475 >postexec = echo \"%u disconnected from %S
13476 from %m (%I)\" >> /tmp/log</B
13483 >postscript (S)</DT
13486 >This parameter forces a printer to interpret
13487 the print files as PostScript. This is done by adding a <TT
13491 > to the start of print output.</P
13493 >This is most useful when you have lots of PCs that persist
13494 in putting a control-D at the start of print jobs, which then
13495 confuses your printer.</P
13499 >postscript = no</B
13509 >This option specifies a command to be run whenever
13510 the service is connected to. It takes the usual substitutions.</P
13512 >An interesting example is to send the users a welcome
13513 message every time they log in. Maybe a message of the day? Here
13518 >preexec = csh -c 'echo \"Welcome to %S!\" |
13519 /usr/local/samba/bin/smbclient -M %m -I %I' & </B
13522 >Of course, this could get annoying after a while :-)</P
13525 HREF="#PREEXECCLOSE"
13545 >none (no command executed)</EM
13550 >preexec = echo \"%u connected to %S from %m
13551 (%I)\" >> /tmp/log</B
13556 NAME="PREEXECCLOSE"
13558 >preexec close (S)</DT
13561 >This boolean option controls whether a non-zero
13562 return code from <A
13571 > should close the service being connected to.</P
13575 >preexec close = no</B
13580 NAME="PREFERREDMASTER"
13582 >preferred master (G)</DT
13585 >This boolean parameter controls if <A
13589 > is a preferred master browser
13590 for its workgroup.</P
13592 >If this is set to <TT
13599 will force an election, and it will have a slight advantage in
13600 winning the election. It is recommended that this parameter is
13601 used in conjunction with <B
13604 HREF="#DOMAINMASTER"
13615 > can guarantee becoming a domain master.</P
13617 >Use this option with caution, because if there are several
13618 hosts (whether Samba servers, Windows 95 or NT) that are preferred
13619 master browsers on the same subnet, they will each periodically
13620 and continuously attempt to become the local master browser.
13621 This will result in unnecessary broadcast traffic and reduced browsing
13637 >preferred master = auto</B
13642 NAME="PREFEREDMASTER"
13644 >prefered master (G)</DT
13648 HREF="#PREFERREDMASTER"
13652 > preferred master</I
13655 > for people who cannot spell :-).</P
13664 >This is a list of services that you want to be
13665 automatically added to the browse lists. This is most useful
13666 for homes and printers services that would otherwise not be
13669 >Note that if you just want all printers in your
13670 printcap file loaded then the <A
13671 HREF="#LOADPRINTERS"
13678 > option is easier.</P
13681 >no preloaded services</EM
13686 >preload = fred lp colorlp</B
13691 NAME="PRESERVECASE"
13693 >preserve case (S)</DT
13696 > This controls if new filenames are created
13697 with the case that the client passes, or if they are forced to
13699 HREF="#DEFAULTCASE"
13711 >preserve case = yes</B
13714 >See the section on <A
13718 > for a fuller discussion.</P
13722 NAME="PRINTCOMMAND"
13724 >print command (S)</DT
13727 >After a print job has finished spooling to
13728 a service, this command will be used via a <B
13732 call to process the spool file. Typically the command specified will
13733 submit the spool file to the host's printing subsystem, but there
13734 is no requirement that this be the case. The server will not remove
13735 the spool file, so whatever command you specify should remove the
13736 spool file when it has been processed, otherwise you will need to
13737 manually remove old spool files.</P
13739 >The print command is simply a text string. It will be used
13740 verbatim after macro substitutions have been made:</P
13742 >s, %p - the path to the spool
13745 >%p - the appropriate printer
13749 name as transmitted by the client.</P
13751 >%c - The number of printed pages
13752 of the spooled job (if known).</P
13754 >%z - the size of the spooled
13755 print job (in bytes)</P
13757 >The print command <EM
13760 one occurrence of <TT
13776 > is optional. At the time
13777 a job is submitted, if no printer name is supplied the <TT
13783 > will be silently removed from the printer command.</P
13785 >If specified in the [global] section, the print command given
13786 will be used for any printable service that does not have its own
13787 print command specified.</P
13789 >If there is neither a specified print command for a
13790 printable service nor a global print command, spool files will
13791 be created but not processed and (most importantly) not removed.</P
13793 >Note that printing may fail on some UNIXes from the
13797 > account. If this happens then create
13798 an alternative guest account that can print and set the <A
13799 HREF="#GUESTACCOUNT"
13807 in the [global] section.</P
13809 >You can form quite complex print commands by realizing
13810 that they are just passed to a shell. For example the following
13811 will log a print job, print the file, then remove it. Note that
13812 ';' is the usual separator for command in shell scripts.</P
13816 >print command = echo Printing %s >>
13817 /tmp/print.log; lpr -P %p %s; rm %s</B
13820 >You may have to vary this command considerably depending
13821 on how you normally print files on your system. The default for
13822 the parameter varies depending on the setting of the <A
13834 >printing = BSD, AIX, QNX, LPRNG
13840 >print command = lpr -r -P%p %s</B
13845 >printing = SYSV or HPUX :</B
13850 >print command = lp -c -d%p %s; rm %s</B
13855 >printing = SOFTQ :</B
13860 >print command = lp -d%p -s %s; rm %s</B
13863 >For printing = CUPS : If SAMBA is compiled against
13866 >printcap = cups</A
13868 uses the CUPS API to
13869 submit jobs, etc. Otherwise it maps to the System V
13870 commands with the -oraw option for printing, i.e. it
13873 >lp -c -d%p -oraw; rm %s</B
13877 >printing = cups</B
13879 and if SAMBA is compiled against libcups, any manually
13880 set print command will be ignored.</P
13884 >print command = /usr/local/samba/bin/myprintscript
13912 >If this parameter is <TT
13916 clients may open, write to and submit spool files on the directory
13917 specified for the service. </P
13919 >Note that a printable service will ALWAYS allow writing
13920 to the service path (user privileges permitting) via the spooling
13921 of print data. The <A
13930 > parameter controls only non-printing access to
13946 HREF="#PRINTCAPNAME"
13957 NAME="PRINTCAPNAME"
13959 >printcap name (G)</DT
13962 >This parameter may be used to override the
13963 compiled-in default printcap name used by the server (usually <TT
13965 > /etc/printcap</TT
13966 >). See the discussion of the <A
13969 > section above for reasons
13970 why you might want to do this.</P
13972 >To use the CUPS printing interface set <B
13974 >printcap name = cups
13976 >. This should be supplemented by an addtional setting
13979 >printing = cups</A
13983 >printcap name = cups</B
13985 "dummy" printcap created by CUPS, as specified in your CUPS
13986 configuration file.
13989 >On System V systems that use <B
13993 list available printers you can use <B
13995 >printcap name = lpstat
13997 > to automatically obtain lists of available printers. This
13998 is the default for systems that define SYSV at configure time in
13999 Samba (this includes most System V based systems). If <TT
14008 these systems then Samba will launch <B
14012 attempt to parse the output to obtain a printer list.</P
14014 >A minimal printcap file would look something like this:</P
14023 CLASS="PROGRAMLISTING"
14024 > print1|My Printer 1
14025 print2|My Printer 2
14026 print3|My Printer 3
14027 print4|My Printer 4
14028 print5|My Printer 5
14035 >where the '|' separates aliases of a printer. The fact
14036 that the second alias has a space in it gives a hint to Samba
14037 that it's a comment.</P
14041 >: Under AIX the default printcap
14045 >. Samba will assume the
14049 > format if the string
14053 > appears in the printcap filename.</P
14057 >printcap name = /etc/printcap</B
14062 >printcap name = /etc/myprintcap</B
14067 NAME="PRINTERADMIN"
14069 >printer admin (S)</DT
14072 >This is a list of users that can do anything to
14073 printers via the remote administration interfaces offered by MS-RPC
14074 (usually using a NT workstation). Note that the root user always
14075 has admin rights.</P
14079 >printer admin = <empty string></B
14085 >printer admin = admin, @staff</B
14090 NAME="PRINTERDRIVER"
14092 >printer driver (S)</DT
14097 >This is a deprecated
14098 parameter and will be removed in the next major release
14099 following version 2.2. Please see the instructions in
14101 HREF="printer_driver2.html"
14103 >Samba 2.2. Printing
14105 > for more information
14106 on the new method of loading printer drivers onto a Samba server.
14109 >This option allows you to control the string
14110 that clients receive when they ask the server for the printer driver
14111 associated with a printer. If you are using Windows95 or Windows NT
14112 then you can use this to automate the setup of printers on your
14115 >You need to set this parameter to the exact string (case
14116 sensitive) that describes the appropriate printer driver for your
14117 system. If you don't know the exact string to use then you should
14118 first try with no <A
14119 HREF="#PRINTERDRIVER"
14123 > printer driver</I
14126 > option set and the client will
14127 give you a list of printer drivers. The appropriate strings are
14128 shown in a scroll box after you have chosen the printer manufacturer.</P
14131 HREF="#PRINTERDRIVERFILE"
14143 >printer driver = HP LaserJet 4L</B
14148 NAME="PRINTERDRIVERFILE"
14150 >printer driver file (G)</DT
14155 >This is a deprecated
14156 parameter and will be removed in the next major release
14157 following version 2.2. Please see the instructions in
14159 HREF="printer_driver2.html"
14161 >Samba 2.2. Printing
14163 > for more information
14164 on the new method of loading printer drivers onto a Samba server.
14167 >This parameter tells Samba where the printer driver
14168 definition file, used when serving drivers to Windows 95 clients, is
14169 to be found. If this is not set, the default is :</P
14174 CLASS="REPLACEABLE"
14176 >SAMBA_INSTALL_DIRECTORY</I
14179 /lib/printers.def</TT
14182 >This file is created from Windows 95 <TT
14186 > files found on the Windows 95 client system. For more
14187 details on setting up serving of printer drivers to Windows 95
14188 clients, see the outdated documentation file in the <TT
14194 >PRINTER_DRIVER.txt</TT
14198 HREF="#PRINTERDRIVERLOCATION"
14202 > printer driver location</I
14208 >None (set in compile).</EM
14213 >printer driver file =
14214 /usr/local/samba/printers/drivers.def</B
14219 NAME="PRINTERDRIVERLOCATION"
14221 >printer driver location (S)</DT
14226 >This is a deprecated
14227 parameter and will be removed in the next major release
14228 following version 2.2. Please see the instructions in
14230 HREF="printer_driver2.html"
14232 >Samba 2.2. Printing
14234 > for more information
14235 on the new method of loading printer drivers onto a Samba server.
14238 >This parameter tells clients of a particular printer
14239 share where to find the printer driver files for the automatic
14240 installation of drivers for Windows 95 machines. If Samba is set up
14241 to serve printer drivers to Windows 95 machines, this should be set to</P
14245 >\\MACHINE\PRINTER$</B
14248 >Where MACHINE is the NetBIOS name of your Samba server,
14249 and PRINTER$ is a share you set up for serving printer driver
14250 files. For more details on setting this up see the outdated documentation
14256 > PRINTER_DRIVER.txt</TT
14260 HREF="#PRINTERDRIVERFILE"
14264 > printer driver file</I
14276 >printer driver location = \\MACHINE\PRINTER$
14284 >printer name (S)</DT
14287 >This parameter specifies the name of the printer
14288 to which print jobs spooled through a printable service will be sent.</P
14290 >If specified in the [global] section, the printer
14291 name given will be used for any printable service that does
14292 not have its own printer name specified.</P
14295 >none (but may be <TT
14299 on many systems)</EM
14304 >printer name = laserwriter</B
14315 HREF="#PRINTERNAME"
14331 >This parameters controls how printer status
14332 information is interpreted on your system. It also affects the
14333 default values for the <TT
14353 >lpresume command</I
14361 > if specified in the
14362 [global] section.</P
14364 >Currently nine printing styles are supported. They are
14398 >To see what the defaults are for the other print
14399 commands when using the various options use the <A
14400 HREF="testparm.1.html"
14405 >This option can be set on a per printer basis</P
14407 >See also the discussion in the <A
14416 >private dir (G)</DT
14419 >This parameters defines the directory
14420 smbd will use for storing such files as <TT
14432 >private dir = ${prefix}/private</B
14443 HREF="#MAXPROTOCOL"
14472 NAME="QUEUEPAUSECOMMAND"
14474 >queuepause command (S)</DT
14477 >This parameter specifies the command to be
14478 executed on the server host in order to pause the printer queue.</P
14480 >This command should be a program or script which takes
14481 a printer name as its only parameter and stops the printer queue,
14482 such that no longer jobs are submitted to the printer.</P
14484 >This command is not supported by Windows for Workgroups,
14485 but can be issued from the Printers window under Windows 95
14493 > is given then the printer name
14494 is put in its place. Otherwise it is placed at the end of the command.
14497 >Note that it is good practice to include the absolute
14498 path in the command as the PATH may not be available to the
14502 >depends on the setting of <TT
14513 >queuepause command = disable %p</B
14518 NAME="QUEUERESUMECOMMAND"
14520 >queueresume command (S)</DT
14523 >This parameter specifies the command to be
14524 executed on the server host in order to resume the printer queue. It
14525 is the command to undo the behavior that is caused by the
14526 previous parameter (<A
14527 HREF="#QUEUEPAUSECOMMAND"
14531 > queuepause command</I
14536 >This command should be a program or script which takes
14537 a printer name as its only parameter and resumes the printer queue,
14538 such that queued jobs are resubmitted to the printer.</P
14540 >This command is not supported by Windows for Workgroups,
14541 but can be issued from the Printers window under Windows 95
14549 > is given then the printer name
14550 is put in its place. Otherwise it is placed at the end of the
14553 >Note that it is good practice to include the absolute
14554 path in the command as the PATH may not be available to the
14558 >depends on the setting of <A
14572 >queuepause command = enable %p
14583 >This boolean parameter controls whether <A
14587 > will support the "Read
14588 Block Multiplex" SMB. This is now rarely used and defaults to
14592 >. You should never need to set this
14607 >This is a list of users that are given read-only
14608 access to a service. If the connecting user is in this list then
14609 they will not be given write access, no matter what the <A
14618 option is set to. The list can include group names using the
14619 syntax described in the <A
14620 HREF="#INVALIDUSERS"
14637 > parameter and the <A
14638 HREF="#INVALIDUSERS"
14650 >read list = <empty string></B
14655 >read list = mary, @students</B
14665 >Note that this is an inverted synonym for <A
14682 >This parameter controls whether or not the server
14683 will support the raw read SMB requests when transferring data
14686 >If enabled, raw reads allow reads of 65535 bytes in
14687 one packet. This typically provides a major performance benefit.
14690 >However, some clients either negotiate the allowable
14691 block size incorrectly or are incapable of supporting larger block
14692 sizes, and for these clients you may need to disable raw reads.</P
14694 >In general this parameter should be viewed as a system tuning
14695 tool and left severely alone. See also <A
14723 affects the overlap of disk reads/writes with network reads/writes.
14724 If the amount of data being transferred in several of the SMB
14725 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
14726 than this value then the server begins writing the data before it
14727 has received the whole packet from the network, or in the case of
14728 SMBreadbraw, it begins writing to the network before all the data
14729 has been read from disk.</P
14731 >This overlapping works best when the speeds of disk and
14732 network access are similar, having very little effect when the
14733 speed of one is much greater than the other.</P
14735 >The default value is 16384, but very little experimentation
14736 has been done yet to determine the optimal value, and it is likely
14737 that the best value will vary greatly between systems anyway.
14738 A value over 65536 is pointless and will cause you to allocate
14739 memory unnecessarily.</P
14743 >read size = 16384</B
14748 >read size = 8192</B
14753 NAME="REMOTEANNOUNCE"
14755 >remote announce (G)</DT
14758 >This option allows you to setup <A
14762 > to periodically announce itself
14763 to arbitrary IP addresses with an arbitrary workgroup name.</P
14765 >This is useful if you want your Samba server to appear
14766 in a remote workgroup for which the normal browse propagation
14767 rules don't work. The remote workgroup can be anywhere that you
14768 can send IP packets to.</P
14774 >remote announce = 192.168.2.255/SERVERS
14775 192.168.4.255/STAFF</B
14778 >the above line would cause <B
14781 > to announce itself
14782 to the two given IP addresses using the given workgroup names.
14783 If you leave out the workgroup name then the one given in
14793 parameter is used instead.</P
14795 >The IP addresses you choose would normally be the broadcast
14796 addresses of the remote networks, but can also be the IP addresses
14797 of known browse masters if your network config is that stable.</P
14799 >See the documentation file <TT
14810 >remote announce = <empty string>
14816 NAME="REMOTEBROWSESYNC"
14818 >remote browse sync (G)</DT
14821 >This option allows you to setup <A
14825 > to periodically request
14826 synchronization of browse lists with the master browser of a Samba
14827 server that is on a remote segment. This option will allow you to
14828 gain browse lists for multiple workgroups across routed networks. This
14829 is done in a manner that does not work with any non-Samba servers.</P
14831 >This is useful if you want your Samba server and all local
14832 clients to appear in a remote workgroup for which the normal browse
14833 propagation rules don't work. The remote workgroup can be anywhere
14834 that you can send IP packets to.</P
14840 >remote browse sync = 192.168.2.255 192.168.4.255
14844 >the above line would cause <B
14848 the master browser on the specified subnets or addresses to
14849 synchronize their browse lists with the local server.</P
14851 >The IP addresses you choose would normally be the broadcast
14852 addresses of the remote networks, but can also be the IP addresses
14853 of known browse masters if your network config is that stable. If
14854 a machine IP address is given Samba makes NO attempt to validate
14855 that the remote machine is available, is listening, nor that it
14856 is in fact the browse master on its segment.</P
14860 >remote browse sync = <empty string>
14866 NAME="RESTRICTANONYMOUS"
14868 >restrict anonymous (G)</DT
14871 >This is a boolean parameter. If it is <TT
14875 anonymous access to the server will be restricted, namely in the
14876 case where the server is expecting the client to send a username,
14877 but it doesn't. Setting it to <TT
14880 > will force these anonymous
14881 connections to be denied, and the client will be required to always
14882 supply a username and password when connecting. Use of this parameter
14883 is only recommended for homogeneous NT client environments.</P
14885 >This parameter makes the use of macro expansions that rely
14886 on the username (%U, %G, etc) consistent. NT 4.0
14887 likes to use anonymous connections when refreshing the share list,
14888 and this is a way to work around that.</P
14890 >When restrict anonymous is <TT
14893 >, all anonymous connections
14894 are denied no matter what they are for. This can effect the ability
14895 of a machine to access the Samba Primary Domain Controller to revalidate
14896 its machine account after someone else has logged on the client
14897 interactively. The NT client will display a message saying that
14898 the machine's account in the domain doesn't exist or the password is
14899 bad. The best way to deal with this is to reboot NT client machines
14900 between interactive logons, using "Shutdown and Restart", rather
14901 than "Close all programs and logon as a different user".</P
14905 >restrict anonymous = no</B
14916 HREF="#ROOTDIRECTORY"
14920 >root directory"</I
14933 HREF="#ROOTDIRECTORY"
14937 >root directory"</I
14944 NAME="ROOTDIRECTORY"
14946 >root directory (G)</DT
14949 >The server will <B
14953 Change its root directory) to this directory on startup. This is
14954 not strictly necessary for secure operation. Even without it the
14955 server will deny access to files not in one of the service entries.
14956 It may also check for, and deny access to, soft links to other
14957 parts of the filesystem, or attempts to use ".." in file names
14958 to access other directories (depending on the setting of the <A
14975 than "/" adds an extra level of security, but at a price. It
14976 absolutely ensures that no access is given to files not in the
14977 sub-tree specified in the <TT
14985 > some files needed for
14986 complete operation of the server. To maintain full operability
14987 of the server you will need to mirror some system files
14993 > tree. In particular
14994 you will need to mirror <TT
14998 subset of it), and any binaries or configuration files needed for
14999 printing (if required). The set of files that must be mirrored is
15000 operating system dependent.</P
15004 >root directory = /</B
15009 >root directory = /homes/smb</B
15014 NAME="ROOTPOSTEXEC"
15016 >root postexec (S)</DT
15019 >This is the same as the <TT
15025 parameter except that the command is run as root. This
15026 is useful for unmounting filesystems
15027 (such as CDROMs) after a connection is closed.</P
15041 >root postexec = <empty string>
15049 >root preexec (S)</DT
15052 >This is the same as the <TT
15058 parameter except that the command is run as root. This
15059 is useful for mounting filesystems (such as CDROMs) when a
15060 connection is opened.</P
15071 HREF="#PREEXECCLOSE"
15082 >root preexec = <empty string>
15088 NAME="ROOTPREEXECCLOSE"
15090 >root preexec close (S)</DT
15093 >This is the same as the <TT
15099 > parameter except that the command is run as root.</P
15110 HREF="#PREEXECCLOSE"
15121 >root preexec close = no</B
15131 >This option affects how clients respond to
15132 Samba and is one of the most important settings in the <TT
15137 >The option sets the "security mode bit" in replies to
15138 protocol negotiations with <A
15143 > to turn share level security on or off. Clients decide
15144 based on this bit whether (and how) to transfer user and password
15145 information to the server.</P
15149 >security = user</B
15151 the most common setting needed when talking to Windows 98 and
15154 >The alternatives are <B
15156 >security = share</B
15160 >security = server</B
15167 >In versions of Samba prior to 2.0.0, the default was
15170 >security = share</B
15171 > mainly because that was
15172 the only option at one stage.</P
15174 >There is a bug in WfWg that has relevance to this
15175 setting. When in user or server level security a WfWg client
15176 will totally ignore the password you type in the "connect
15177 drive" dialog box. This makes it very difficult (if not impossible)
15178 to connect to a Samba service as anyone except the user that
15179 you are logged into WfWg as.</P
15181 >If your PCs use usernames that are the same as their
15182 usernames on the UNIX machine then you will want to use
15185 >security = user</B
15186 >. If you mostly use usernames
15187 that don't exist on the UNIX box then use <B
15193 >You should also use <B
15195 >security = share</B
15197 want to mainly setup shares without a password (guest shares). This
15198 is commonly used for a shared printer server. It is more difficult
15199 to setup guest shares with <B
15201 >security = user</B
15212 >parameter for details.</P
15214 >It is possible to use <B
15219 > where it is offers both user and share
15220 level security under different <A
15221 HREF="#NETBIOSALIASES"
15225 >NetBIOS aliases</I
15230 >The different settings will now be explained.</P
15233 NAME="SECURITYEQUALSSHARE"
15240 >When clients connect to a share level security server they
15241 need not log onto the server with a valid username and password before
15242 attempting to connect to a shared resource (although modern clients
15243 such as Windows 95/98 and Windows NT will send a logon request with
15244 a username but no password when talking to a <B
15248 > server). Instead, the clients send authentication information
15249 (passwords) on a per-share basis, at the time they attempt to connect
15258 uses a valid UNIX user to act on behalf of the client, even in
15261 >security = share</B
15262 > level security.</P
15264 >As clients are not required to send a username to the server
15265 in share level security, <B
15269 techniques to determine the correct UNIX user to use on behalf
15272 >A list of possible UNIX usernames to match with the given
15273 client password is constructed using the following methods :</P
15288 > parameter is set, then all the other
15289 stages are missed and only the <A
15290 HREF="#GUESTACCOUNT"
15297 > username is checked.
15302 >Is a username is sent with the share connection
15303 request, then this username (after mapping - see <A
15304 HREF="#USERNAMEMAP"
15312 is added as a potential username.</P
15316 >If the client did a previous <EM
15319 > request (the SessionSetup SMB call) then the
15320 username sent in this SMB will be added as a potential username.
15325 >The name of the service the client requested is
15326 added as a potential username.</P
15330 >The NetBIOS name of the client is added to
15331 the list as a potential username.</P
15335 >Any users on the <A
15343 > list are added as potential usernames.
15354 not set, then this list is then tried with the supplied password.
15355 The first user for whom the password matches will be used as the
15364 set, or no username can be determined then if the share is marked
15365 as available to the <TT
15371 guest user will be used, otherwise access is denied.</P
15373 >Note that it can be <EM
15376 in share-level security as to which UNIX username will eventually
15377 be used in granting access.</P
15379 >See also the section <A
15381 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15385 NAME="SECURITYEQUALSUSER"
15392 >This is the default security setting in Samba 2.2.
15393 With user-level security a client must first "log-on" with a
15394 valid username and password (which can be mapped using the <A
15395 HREF="#USERNAMEMAP"
15403 parameter). Encrypted passwords (see the <A
15404 HREF="#ENCRYPTPASSWORDS"
15408 >encrypted passwords</I
15411 > parameter) can also
15412 be used in this security mode. Parameters such as <A
15428 > if set are then applied and
15429 may change the UNIX user to use on this connection, but only after
15430 the user has been successfully authenticated.</P
15434 > that the name of the resource being
15437 > sent to the server until after
15438 the server has successfully authenticated the client. This is why
15439 guest shares don't work in user level security without allowing
15440 the server to automatically map unknown users into the <A
15441 HREF="#GUESTACCOUNT"
15458 > parameter for details on doing this.</P
15460 >See also the section <A
15462 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15466 NAME="SECURITYEQUALSSERVER"
15473 >In this mode Samba will try to validate the username/password
15474 by passing it to another SMB server, such as an NT box. If this
15475 fails it will revert to <B
15477 >security = user</B
15479 that if encrypted passwords have been negotiated then Samba cannot
15480 revert back to checking the UNIX password file, it must have a valid
15484 > file to check users against. See the
15485 documentation file in the <TT
15491 >ENCRYPTION.txt</TT
15492 > for details on how to set this
15497 > that from the client's point of
15500 >security = server</B
15501 > is the same as <B
15503 > security = user</B
15504 >. It only affects how the server deals
15505 with the authentication, it does not in any way affect what the
15510 > that the name of the resource being
15513 > sent to the server until after
15514 the server has successfully authenticated the client. This is why
15515 guest shares don't work in user level security without allowing
15516 the server to automatically map unknown users into the <A
15517 HREF="#GUESTACCOUNT"
15534 > parameter for details on doing this.</P
15536 >See also the section <A
15538 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15542 HREF="#PASSWORDSERVER"
15550 > parameter and the <A
15551 HREF="#ENCRYPTPASSWORDS"
15555 >encrypted passwords</I
15562 NAME="SECURITYEQUALSDOMAIN"
15569 >This mode will only work correctly if <A
15570 HREF="smbpasswd.8.html"
15573 > has been used to add this
15574 machine into a Windows NT Domain. It expects the <A
15575 HREF="#ENCRYPTPASSWORDS"
15579 >encrypted passwords</I
15583 > parameter to be set to <TT
15587 mode Samba will try to validate the username/password by passing
15588 it to a Windows NT Primary or Backup Domain Controller, in exactly
15589 the same way that a Windows NT Server would do.</P
15593 > that a valid UNIX user must still
15594 exist as well as the account on the Domain Controller to allow
15595 Samba to have a valid UNIX account to map file access to.</P
15599 > that from the client's point
15602 >security = domain</B
15603 > is the same as <B
15607 >. It only affects how the server deals with the authentication,
15608 it does not in any way affect what the client sees.</P
15612 > that the name of the resource being
15615 > sent to the server until after
15616 the server has successfully authenticated the client. This is why
15617 guest shares don't work in user level security without allowing
15618 the server to automatically map unknown users into the <A
15619 HREF="#GUESTACCOUNT"
15636 > parameter for details on doing this.</P
15640 > There is currently a bug in the
15641 implementation of <B
15643 >security = domain</B
15645 to multi-byte character set usernames. The communication with a
15646 Domain Controller must be done in UNICODE and Samba currently
15647 does not widen multi-byte user names to UNICODE correctly, thus
15648 a multi-byte username will not be recognized correctly at the
15649 Domain Controller. This issue will be addressed in a future release.</P
15651 >See also the section <A
15653 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15657 HREF="#PASSWORDSERVER"
15665 > parameter and the <A
15666 HREF="#ENCRYPTPASSWORDS"
15670 >encrypted passwords</I
15678 >security = USER</B
15683 >security = DOMAIN</B
15688 NAME="SECURITYMASK"
15690 >security mask (S)</DT
15693 >This parameter controls what UNIX permission
15694 bits can be modified when a Windows NT client is manipulating
15695 the UNIX permission on a file using the native NT security
15698 >This parameter is applied as a mask (AND'ed with) to
15699 the changed permission bits, thus preventing any bits not in
15700 this mask from being modified. Essentially, zero bits in this
15701 mask may be treated as a set of bits the user is not allowed
15704 >If not set explicitly this parameter is 0777, allowing
15705 a user to modify all the user/group/world permissions on a file.
15710 > that users who can access the
15711 Samba server through other means can easily bypass this
15712 restriction, so it is primarily useful for standalone
15713 "appliance" systems. Administrators of most normal systems will
15714 probably want to leave it set to <TT
15720 HREF="#FORCEDIRECTORYSECURITYMODE"
15724 >force directory security mode</I
15729 HREF="#DIRECTORYSECURITYMASK"
15738 HREF="#FORCESECURITYMODE"
15742 >force security mode</I
15749 >security mask = 0777</B
15754 >security mask = 0770</B
15759 NAME="SERVERSTRING"
15761 >server string (G)</DT
15764 >This controls what string will show up in the
15765 printer comment box in print manager and next to the IPC connection
15769 >. It can be any string that you wish
15770 to show to your users.</P
15772 >It also sets what will appear in browse lists next
15773 to the machine name.</P
15780 > will be replaced with the Samba
15788 > will be replaced with the
15793 >server string = Samba %v</B
15798 >server string = University of GNUs Samba
15804 NAME="SETDIRECTORY"
15806 >set directory (S)</DT
15811 >set directory = no</B
15813 users of the service may not use the setdir command to change
15819 > command is only implemented
15820 in the Digital Pathworks client. See the Pathworks documentation
15825 >set directory = no</B
15832 >share modes (S)</DT
15835 >This enables or disables the honoring of
15841 > during a file open. These
15842 modes are used by clients to gain exclusive read or write access
15845 >These open modes are not directly supported by UNIX, so
15846 they are simulated using shared memory, or lock files if your
15847 UNIX doesn't support shared memory (almost all do).</P
15849 >The share modes that are enabled by this option are
15873 >This option gives full share compatibility and enabled
15878 > turn this parameter
15879 off as many Windows applications will break if you do so.</P
15883 >share modes = yes</B
15888 NAME="SHORTPRESERVECASE"
15890 >short preserve case (S)</DT
15893 >This boolean parameter controls if new files
15894 which conform to 8.3 syntax, that is all in upper case and of
15895 suitable length, are created upper case, or if they are forced
15897 HREF="#DEFAULTCASE"
15905 >. This option can be use with <A
15906 HREF="#PRESERVECASE"
15909 >preserve case = yes</B
15912 > to permit long filenames to retain their case, while short
15913 names are lowered. </P
15915 >See the section on <A
15922 >short preserve case = yes</B
15927 NAME="SHOWADDPRINTERWIZARD"
15929 >show add printer wizard (G)</DT
15932 >With the introduction of MS-RPC based printing support
15933 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
15934 appear on Samba hosts in the share listing. Normally this folder will
15935 contain an icon for the MS Add Printer Wizard (APW). However, it is
15936 possible to disable this feature regardless of the level of privilege
15937 of the connected user.</P
15939 >Under normal circumstances, the Windows NT/2000 client will
15940 open a handle on the printer server with OpenPrinterEx() asking for
15941 Administrator privileges. If the user does not have administrative
15942 access on the print server (i.e is not root or a member of the
15948 > group), the OpenPrinterEx()
15949 call fails and the client makes another open call with a request for
15950 a lower privilege level. This should succeed, however the APW
15951 icon will not be displayed.</P
15956 >show add printer wizard</I
15959 parameter will always cause the OpenPrinterEx() on the server
15960 to fail. Thus the APW icon will never be displayed. <EM
15962 >This does not prevent the same user from having
15963 administrative privilege on an individual printer.</P
15966 HREF="#ADDPRINTERCOMMAND"
15975 HREF="#DELETEPRINTERCOMMAND"
15979 >deleteprinter command</I
15983 HREF="#PRINTERADMIN"
15994 >show add printer wizard = yes</B
15999 NAME="SHUTDOWNSCRIPT"
16001 >shutdown script (G)</DT
16005 >This parameter only exists in the HEAD cvs branch</EM
16007 This a full path name to a script called by
16016 should start a shutdown procedure.</P
16018 >This command will be run as the user connected to the
16021 >%m %t %r %f parameters are expanded</P
16028 > will be substituted with the
16029 shutdown message sent to the server.</P
16036 > will be substituted with the
16037 number of seconds to wait before effectively starting the
16038 shutdown procedure.</P
16045 > will be substituted with the
16048 >. It means reboot after shutdown
16057 > will be substituted with the
16060 >. It means force the shutdown
16061 even if applications do not respond for NT.</P
16069 >abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f</B
16072 >Shutdown script example:
16080 CLASS="PROGRAMLISTING"
16087 /sbin/shutdown $3 $4 +$time $1 &
16093 Shutdown does not return so we need to launch it in background.
16097 HREF="#ABORTSHUTDOWNSCRIPT"
16101 >abort shutdown script</I
16108 NAME="SMBPASSWDFILE"
16110 >smb passwd file (G)</DT
16113 >This option sets the path to the encrypted
16114 smbpasswd file. By default the path to the smbpasswd file
16115 is compiled into Samba.</P
16119 >smb passwd file = ${prefix}/private/smbpasswd
16125 >smb passwd file = /etc/samba/smbpasswd
16131 NAME="SOCKETADDRESS"
16133 >socket address (G)</DT
16136 >This option allows you to control what
16137 address Samba will listen for connections on. This is used to
16138 support multiple virtual interfaces on the one server, each
16139 with a different configuration.</P
16141 >By default Samba will accept connections on any
16146 >socket address = 192.168.2.20</B
16152 NAME="SOCKETOPTIONS"
16154 >socket options (G)</DT
16157 >This option allows you to set socket options
16158 to be used when talking with the client.</P
16160 >Socket options are controls on the networking layer
16161 of the operating systems which allow the connection to be
16164 >This option will typically be used to tune your Samba
16165 server for optimal performance for your local network. There is
16166 no way that Samba can know what the optimal parameters are for
16167 your net, so you must experiment and choose them yourself. We
16168 strongly suggest you read the appropriate documentation for your
16169 operating system first (perhaps <B
16175 >You may find that on some systems Samba will say
16176 "Unknown socket option" when you supply an option. This means you
16177 either incorrectly typed it or you need to add an include file
16178 to includes.h for your OS. If the latter is the case please
16179 send the patch to <A
16180 HREF="mailto:samba@samba.org"
16182 > samba@samba.org</A
16185 >Any of the supported socket options may be combined
16186 in any way you like, as long as your OS allows it.</P
16188 >This is the list of socket options currently settable
16189 using this option:</P
16215 >IPTOS_THROUGHPUT</P
16235 >Those marked with a <EM
16238 argument. The others can optionally take a 1 or 0 argument to enable
16239 or disable the option, by default they will be enabled if you
16240 don't specify 1 or 0.</P
16242 >To specify an argument use the syntax SOME_OPTION = VALUE
16245 >SO_SNDBUF = 8192</B
16246 >. Note that you must
16247 not have any spaces before or after the = sign.</P
16249 >If you are on a local network then a sensible option
16254 >socket options = IPTOS_LOWDELAY</B
16257 >If you have a local network then you could try:</P
16261 >socket options = IPTOS_LOWDELAY TCP_NODELAY</B
16264 >If you are on a wide area network then perhaps try
16265 setting IPTOS_THROUGHPUT. </P
16267 >Note that several of the options may cause your Samba
16268 server to fail completely. Use these options with caution!</P
16272 >socket options = TCP_NODELAY</B
16277 >socket options = IPTOS_LOWDELAY</B
16282 NAME="SOURCEENVIRONMENT"
16284 >source environment (G)</DT
16287 >This parameter causes Samba to set environment
16288 variables as per the content of the file named.</P
16290 >If the value of this parameter starts with a "|" character
16291 then Samba will treat that value as a pipe command to open and
16292 will set the environment variables from the output of the pipe.</P
16294 >The contents of the file or the output of the pipe should
16295 be formatted as the output of the standard Unix <B
16299 > command. This is of the form :</P
16301 >Example environment entry:</P
16305 >SAMBA_NETBIOS_NAME = myhostname</B
16309 >No default value</EM
16314 >source environment = |/etc/smb.conf.sh
16320 >source environment =
16321 /usr/local/smb_env_vars</B
16328 >use spnego (G)</DT
16331 > This variable controls controls whether samba will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism. As of samba 3.0alpha it must be set to "no" for these clients to join a samba domain controller. It can be set to "yes" to allow samba to participate in an AD domain controlled by a Windows2000 domain controller.</P
16334 >use spnego = yes</EM
16341 >stat cache (G)</DT
16344 >This parameter determines if <A
16348 > will use a cache in order to
16349 speed up case insensitive name mappings. You should never need
16350 to change this parameter.</P
16354 >stat cache = yes</B
16359 NAME="STATCACHESIZE"
16361 >stat cache size (G)</DT
16364 >This parameter determines the number of
16371 never need to change this parameter.</P
16375 >stat cache size = 50</B
16385 >This enables or disables logging of connections
16386 to a status file that <A
16387 HREF="smbstatus.1.html"
16393 >With this disabled <B
16397 to tell you what connections are active. You should never need to
16398 change this parameter.</P
16407 NAME="STRICTALLOCATE"
16409 >strict allocate (S)</DT
16412 >This is a boolean that controls the handling of
16413 disk space allocation in the server. When this is set to <TT
16417 the server will change from UNIX behaviour of not committing real
16418 disk storage blocks when a file is extended to the Windows behaviour
16419 of actually forcing the disk system to allocate real storage blocks
16420 when a file is created or extended to be a given size. In UNIX
16421 terminology this means that Samba will stop creating sparse files.
16422 This can be slow on some systems.</P
16424 >When strict allocate is <TT
16427 > the server does sparse
16428 disk block allocation when a file is extended.</P
16430 >Setting this to <TT
16433 > can help Samba return
16434 out of quota messages on systems that are restricting the disk quota
16439 >strict allocate = no</B
16444 NAME="STRICTLOCKING"
16446 >strict locking (S)</DT
16449 >This is a boolean that controls the handling of
16450 file locking in the server. When this is set to <TT
16454 the server will check every read and write access for file locks, and
16455 deny access if locks exist. This can be slow on some systems.</P
16457 >When strict locking is <TT
16460 > the server does file
16461 lock checks only when the client explicitly asks for them.</P
16463 >Well-behaved clients always ask for lock checks when it
16464 is important, so in the vast majority of cases <B
16468 > is preferable.</P
16472 >strict locking = no</B
16479 >strict sync (S)</DT
16482 >Many Windows applications (including the Windows
16483 98 explorer shell) seem to confuse flushing buffer contents to
16484 disk with doing a sync to disk. Under UNIX, a sync call forces
16485 the process to be suspended until the kernel has ensured that
16486 all outstanding data in kernel disk buffers has been safely stored
16487 onto stable storage. This is very slow and should only be done
16488 rarely. Setting this parameter to <TT
16492 default) means that <A
16496 > ignores the Windows applications requests for
16497 a sync call. There is only a possibility of losing data if the
16498 operating system itself that Samba is running on crashes, so there is
16499 little danger in this default setting. In addition, this fixes many
16500 performance problems that people have reported with the new Windows98
16501 explorer shell file copies.</P
16516 >strict sync = no</B
16526 >This is a boolean that controls whether to
16527 strip trailing dots off UNIX filenames. This helps with some
16528 CDROMs that have filenames ending in a single dot.</P
16539 >sync always (S)</DT
16542 >This is a boolean parameter that controls
16543 whether writes will always be written to stable storage before
16544 the write call returns. If this is <TT
16547 > then the server will be
16548 guided by the client's request in each write call (clients can
16549 set a bit indicating that a particular write should be synchronous).
16553 > then every write will be followed by a <B
16557 > call to ensure the data is written to disk. Note that
16563 > parameter must be set to
16567 > in order for this parameter to have
16583 >sync always = no</B
16593 >This parameter maps how Samba debug messages
16594 are logged onto the system syslog logging levels. Samba debug
16595 level zero maps onto syslog <TT
16599 level one maps onto <TT
16606 >, debug level three
16607 maps onto LOG_INFO. All higher levels are mapped to <TT
16612 >This parameter sets the threshold for sending messages
16613 to syslog. Only messages with debug level less than this value
16614 will be sent to syslog.</P
16625 >syslog only (G)</DT
16628 >If this parameter is set then Samba debug
16629 messages are logged into the system syslog only, and not to
16630 the debug log files.</P
16634 >syslog only = no</B
16639 NAME="TEMPLATEHOMEDIR"
16641 >template homedir (G)</DT
16644 >When filling out the user information for a Windows NT
16646 HREF="winbindd.8.html"
16650 uses this parameter to fill in the home directory for that user.
16656 > is present it is substituted
16657 with the user's Windows NT domain name. If the string <TT
16663 > is present it is substituted with the user's Windows
16668 >template homedir = /home/%D/%U</B
16673 NAME="TEMPLATESHELL"
16675 >template shell (G)</DT
16678 >When filling out the user information for a Windows NT
16680 HREF="winbindd.8.html"
16684 uses this parameter to fill in the login shell for that user.</P
16688 >template shell = /bin/false</B
16695 >time offset (G)</DT
16698 >This parameter is a setting in minutes to add
16699 to the normal GMT to local time conversion. This is useful if
16700 you are serving a lot of PCs that have incorrect daylight
16701 saving time handling.</P
16705 >time offset = 0</B
16710 >time offset = 60</B
16717 >time server (G)</DT
16720 >This parameter determines if <A
16725 > advertises itself as a time server to Windows
16730 >time server = no</B
16735 NAME="TIMESTAMPLOGS"
16737 >timestamp logs (G)</DT
16741 HREF="#DEBUGTIMESTAMP"
16745 > debug timestamp</I
16752 NAME="TOTALPRINTJOBS"
16754 >total print jobs (G)</DT
16757 >This parameter accepts an integer value which defines
16758 a limit on the maximum number of print jobs that will be accepted
16759 system wide at any given time. If a print job is submitted
16760 by a client which will exceed this number, then <A
16765 error indicating that no space is available on the server. The
16766 default value of 0 means that no such limit exists. This parameter
16767 can be used to prevent a server from exceeding its capacity and is
16768 designed as a printing throttle. See also
16770 HREF="#MAXPRINTJOBS"
16782 >total print jobs = 0</B
16787 >total print jobs = 5000</B
16792 NAME="UNIXEXTENSIONS"
16794 >unix extensions(G)</DT
16797 >This boolean parameter controls whether Samba
16798 implments the CIFS UNIX extensions, as defined by HP.
16799 These extensions enable Samba to better serve UNIX CIFS clients
16800 by supporting features such as symbolic links, hard links, etc...
16801 These extensions require a similarly enabled client, and are of
16802 no current use to Windows clients.</P
16806 >unix extensions = no</B
16811 NAME="UNIXPASSWORDSYNC"
16813 >unix password sync (G)</DT
16816 >This boolean parameter controls whether Samba
16817 attempts to synchronize the UNIX password with the SMB password
16818 when the encrypted SMB password in the smbpasswd file is changed.
16819 If this is set to <TT
16822 > the program specified in the <TT
16828 >parameter is called <EM
16831 to allow the new UNIX password to be set without access to the
16832 old UNIX password (as the SMB password change code has no
16833 access to the old password cleartext, only the new).</P
16836 HREF="#PASSWDPROGRAM"
16856 >unix password sync = no</B
16861 NAME="UPDATEENCRYPTED"
16863 >update encrypted (G)</DT
16866 >This boolean parameter allows a user logging
16867 on with a plaintext password to have their encrypted (hashed)
16868 password in the smbpasswd file to be updated automatically as
16869 they log on. This option allows a site to migrate from plaintext
16870 password authentication (users authenticate with plaintext
16871 password over the wire, and are checked against a UNIX account
16872 database) to encrypted password authentication (the SMB
16873 challenge/response authentication mechanism) without forcing
16874 all users to re-enter their passwords via smbpasswd at the time the
16875 change is made. This is a convenience option to allow the change over
16876 to encrypted passwords to be made over a longer period. Once all users
16877 have encrypted representations of their passwords in the smbpasswd
16878 file this parameter should be set to <TT
16883 >In order for this parameter to work correctly the <A
16884 HREF="#ENCRYPTPASSWORDS"
16888 >encrypt passwords</I
16892 > parameter must be set to <TT
16896 this parameter is set to <TT
16901 >Note that even when this parameter is set a user
16902 authenticating to <B
16905 > must still enter a valid
16906 password in order to connect correctly, and to update their hashed
16907 (smbpasswd) passwords.</P
16911 >update encrypted = no</B
16916 NAME="USECLIENTDRIVER"
16918 >use client driver (S)</DT
16921 >This parameter applies only to Windows NT/2000
16922 clients. It has no affect on Windows 95/98/ME clients. When
16923 serving a printer to Windows NT/2000 clients without first installing
16924 a valid printer driver on the Samba host, the client will be required
16925 to install a local printer driver. From this point on, the client
16926 will treat the print as a local printer and not a network printer
16927 connection. This is much the same behavior that will occur
16930 >disable spoolss = yes</B
16933 >The differentiating
16934 factor is that under normal circumstances, the NT/2000 client will
16935 attempt to open the network printer using MS-RPC. The problem is that
16936 because the client considers the printer to be local, it will attempt
16937 to issue the OpenPrinterEx() call requesting access rights associated
16938 with the logged on user. If the user possesses local administator rights
16939 but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
16940 call will fail. The result is that the client will now display an "Access
16941 Denied; Unable to connect" message in the printer queue window (even though
16942 jobs may successfully be printed). </P
16944 >If this parameter is enabled for a printer, then any attempt
16945 to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
16946 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
16947 call to succeed. <EM
16948 >This parameter MUST not be able enabled
16949 on a print share which has valid print driver installed on the Samba
16954 HREF="#DISABLESPOOLSS"
16955 >disable spoolss</A
16961 >use client driver = no</B
16971 >This global parameter determines if the tdb internals of Samba can
16972 depend on mmap working correctly on the running system. Samba requires a coherent
16973 mmap/read-write system memory cache. Currently only HPUX does not have such a
16974 coherent cache, and so this parameter is set to <TT
16978 default on HPUX. On all other systems this parameter should be left alone. This
16979 parameter is provided to help the Samba developers track down problems with
16980 the tdb internal code.
16992 >use rhosts (G)</DT
16995 >If this global parameter is <TT
16999 that the UNIX user's <TT
17002 > file in their home directory
17003 will be read to find the names of hosts and users who will be allowed
17004 access without specifying a password.</P
17014 > can be a major security hole. This is because you are
17015 trusting the PC to supply the correct username. It is very easy to
17016 get a PC to supply a false username. I recommend that the <TT
17021 > option be only used if you really know what
17026 >use rhosts = no</B
17070 >Multiple users may be specified in a comma-delimited
17071 list, in which case the supplied password will be tested against
17072 each username in turn (left to right).</P
17079 > line is needed only when
17080 the PC is unable to supply its own username. This is the case
17081 for the COREPLUS protocol or where your users have different WfWg
17082 usernames to UNIX usernames. In both these cases you may also be
17083 better using the \\server\share%user syntax instead.</P
17090 > line is not a great
17091 solution in many cases as it means Samba will try to validate
17092 the supplied password against each of the usernames in the
17098 > line in turn. This is slow and
17099 a bad idea for lots of users in case of duplicate passwords.
17100 You may get timeouts or security breaches using this parameter
17103 >Samba relies on the underlying UNIX security. This
17104 parameter does not restrict who can login, it just offers hints
17105 to the Samba server as to what usernames might correspond to the
17106 supplied password. Users can login as whoever they please and
17107 they will be able to do no more damage than if they started a
17108 telnet session. The daemon runs as the user that they log in as,
17109 so they cannot do anything that user cannot do.</P
17111 >To restrict a service to a particular set of users you
17123 >If any of the usernames begin with a '@' then the name
17124 will be looked up first in the NIS netgroups list (if Samba
17125 is compiled with netgroup support), followed by a lookup in
17126 the UNIX groups database and will expand to a list of all users
17127 in the group of that name.</P
17129 >If any of the usernames begin with a '+' then the name
17130 will be looked up only in the UNIX groups database and will
17131 expand to a list of all users in the group of that name.</P
17133 >If any of the usernames begin with a '&'then the name
17134 will be looked up only in the NIS netgroups database (if Samba
17135 is compiled with netgroup support) and will expand to a list
17136 of all users in the netgroup group of that name.</P
17138 >Note that searching though a groups database can take
17139 quite some time, and some clients may time out during the
17142 >See the section <A
17145 USERNAME/PASSWORD VALIDATION</A
17146 > for more information on how
17147 this parameter determines access to the services.</P
17151 >The guest account if a guest service,
17152 else <empty string>.</B
17157 >username = fred, mary, jack, jane,
17158 @users, @pcgroup</B
17163 NAME="USERNAMELEVEL"
17165 >username level (G)</DT
17168 >This option helps Samba to try and 'guess' at
17169 the real UNIX username, as many DOS clients send an all-uppercase
17170 username. By default Samba tries all lowercase, followed by the
17171 username with the first letter capitalized, and fails if the
17172 username is not found on the UNIX machine.</P
17174 >If this parameter is set to non-zero the behavior changes.
17175 This parameter is a number that specifies the number of uppercase
17176 combinations to try while trying to determine the UNIX user name. The
17177 higher the number the more combinations will be tried, but the slower
17178 the discovery of usernames will be. Use this parameter when you have
17179 strange usernames on your UNIX machine, such as <TT
17187 >username level = 0</B
17192 >username level = 5</B
17199 >username map (G)</DT
17202 >This option allows you to specify a file containing
17203 a mapping of usernames from the clients to the server. This can be
17204 used for several purposes. The most common is to map usernames
17205 that users use on DOS or Windows machines to those that the UNIX
17206 box uses. The other is to map multiple users to a single username
17207 so that they can more easily share files.</P
17209 >The map file is parsed line by line. Each line should
17210 contain a single UNIX username on the left then a '=' followed
17211 by a list of usernames on the right. The list of usernames on the
17212 right may contain names of the form @group in which case they
17213 will match any UNIX username in that group. The special client
17214 name '*' is a wildcard and matches any name. Each line of the
17215 map file may be up to 1023 characters long.</P
17217 >The file is processed on each line by taking the
17218 supplied username and comparing it with each username on the right
17219 hand side of the '=' signs. If the supplied name matches any of
17220 the names on the right hand side then it is replaced with the name
17221 on the left. Processing then continues with the next line.</P
17223 >If any line begins with a '#' or a ';' then it is
17226 >If any line begins with an '!' then the processing
17227 will stop after that line if a mapping was done by the line.
17228 Otherwise mapping continues with every line being processed.
17229 Using '!' is most useful when you have a wildcard mapping line
17230 later in the file.</P
17232 >For example to map from the name <TT
17239 > to the UNIX name <TT
17242 > you would use:</P
17246 >root = admin administrator</B
17249 >Or to map anyone in the UNIX group <TT
17253 to the UNIX name <TT
17256 > you would use:</P
17263 >You can have as many mappings as you like in a username
17266 >If your system supports the NIS NETGROUP option then
17267 the netgroup database is checked before the <TT
17271 > database for matching groups.</P
17273 >You can map Windows usernames that have spaces in them
17274 by using double quotes around the name. For example:</P
17278 >tridge = "Andrew Tridgell"</B
17281 >would map the windows username "Andrew Tridgell" to the
17282 unix username "tridge".</P
17284 >The following example would map mary and fred to the
17285 unix user sys, and map the rest to guest. Note the use of the
17286 '!' to tell Samba to stop processing if it gets a match on
17296 CLASS="PROGRAMLISTING"
17305 >Note that the remapping is applied to all occurrences
17306 of usernames. Thus if you connect to \\server\fred and <TT
17309 > is remapped to <TT
17313 will actually be connecting to \\server\mary and will need to
17314 supply a password suitable for <TT
17321 >. The only exception to this is the
17322 username passed to the <A
17323 HREF="#PASSWORDSERVER"
17327 > password server</I
17330 > (if you have one). The password
17331 server will receive whatever username the client supplies without
17334 >Also note that no reverse mapping is done. The main effect
17335 this has is with printing. Users who have been mapped may have
17336 trouble deleting print jobs as PrintManager under WfWg will think
17337 they don't own the print job.</P
17340 >no username map</EM
17345 >username map = /usr/local/samba/lib/users.map
17356 >This boolean parameter is only available if
17357 Samba has been configured and compiled with the option <B
17363 > then Samba will attempt
17364 to add utmp or utmpx records (depending on the UNIX system) whenever a
17365 connection is made to a Samba server. Sites may use this to record the
17366 user connecting to a Samba share.</P
17368 >Due to the requirements of the utmp record, we
17369 are required to create a unique identifier for the
17370 incoming user. Enabling this option creates an n^2
17371 algorithm to find this number. This may impede
17372 performance on large installations. </P
17375 HREF="#UTMPDIRECTORY"
17379 > utmp directory</I
17391 NAME="UTMPDIRECTORY"
17393 >utmp directory(G)</DT
17396 >This parameter is only available if Samba has
17397 been configured and compiled with the option <B
17400 >. It specifies a directory pathname that is
17401 used to store the utmp or utmpx files (depending on the UNIX system) that
17402 record user connections to a Samba server. See also the <A
17410 > parameter. By default this is
17411 not set, meaning the system will use whatever utmp file the
17412 native system is set to use (usually
17419 >no utmp directory</EM
17426 >valid users (S)</DT
17429 >This is a list of users that should be allowed
17430 to login to this service. Names starting with '@', '+' and '&'
17431 are interpreted using the same rules as described in the
17439 >If this is empty (the default) then any user can login.
17440 If a username is in both this list and the <TT
17446 > list then access is denied for that user.</P
17448 >The current servicename is substituted for <TT
17454 >. This is useful in the [homes] section.</P
17457 HREF="#INVALIDUSERS"
17468 >No valid users list (anyone can login)
17474 >valid users = greg, @pcusers</B
17484 >This is a list of files and directories that
17485 are neither visible nor accessible. Each entry in the list must
17486 be separated by a '/', which allows spaces to be included
17487 in the entry. '*' and '?' can be used to specify multiple files
17488 or directories as in DOS wildcards.</P
17490 >Each entry must be a unix path, not a DOS path and
17493 > include the unix directory
17502 is applicable in vetoing files.</P
17504 >One feature of the veto files parameter that it
17505 is important to be aware of is Samba's behaviour when
17506 trying to delete a directory. If a directory that is
17507 to be deleted contains nothing but veto files this
17510 > unless you also set
17514 >delete veto files</I
17524 >Setting this parameter will affect the performance
17525 of Samba, as it will be forced to check all files and directories
17526 for a match as they are scanned.</P
17538 HREF="#CASESENSITIVE"
17542 > case sensitive</I
17548 >No files or directories are vetoed.
17559 CLASS="PROGRAMLISTING"
17560 >; Veto any files containing the word Security,
17561 ; any ending in .tmp, and any directory containing the
17563 veto files = /*Security*/*.tmp/*root*/
17565 ; Veto the Apple specific files that a NetAtalk server
17567 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/</PRE
17575 NAME="VETOOPLOCKFILES"
17577 >veto oplock files (S)</DT
17580 >This parameter is only valid when the <A
17589 parameter is turned on for a share. It allows the Samba administrator
17590 to selectively turn off the granting of oplocks on selected files that
17591 match a wildcarded list, similar to the wildcarded list used in the
17604 >No files are vetoed for oplock
17608 >You might want to do this on files that you know will
17609 be heavily contended for by clients. A good example of this
17610 is in the NetBench SMB benchmark program, which causes heavy
17611 client contention for files ending in <TT
17615 To cause Samba not to grant oplocks on these files you would use
17616 the line (either in the [global] section or in the section for
17617 the particular NetBench share :</P
17621 >veto oplock files = /*.SEM/
17629 >vfs object (S)</DT
17632 >This parameter specifies a shared object file that
17633 is used for Samba VFS I/O operations. By default, normal
17634 disk I/O operations are used but these can be overloaded
17635 with a VFS object. The Samba VFS layer is new to Samba 2.2 and
17636 must be enabled at compile time with --with-vfs.</P
17646 >vfs options (S)</DT
17649 >This parameter allows parameters to be passed
17650 to the vfs layer at initialization time. The Samba VFS layer
17651 is new to Samba 2.2 and must be enabled at compile time
17652 with --with-vfs. See also <A
17673 > This allows you to override the volume label
17674 returned for a share. Useful for CDROMs with installation programs
17675 that insist on a particular volume label.</P
17678 >the name of the share</EM
17685 >wide links (S)</DT
17688 >This parameter controls whether or not links
17689 in the UNIX file system may be followed by the server. Links
17690 that point to areas within the directory tree exported by the
17691 server are always allowed; this parameter controls access only
17692 to areas that are outside the directory tree being exported.</P
17694 >Note that setting this parameter can have a negative
17695 effect on your server performance due to the extra system calls
17696 that Samba has to do in order to perform the link checks.</P
17700 >wide links = yes</B
17705 NAME="WINBINDCACHETIME"
17707 >winbind cache time (G)</DT
17710 >This parameter specifies the number of seconds the
17712 HREF="winbindd.8.html"
17715 > daemon will cache
17716 user and group information before querying a Windows NT server
17721 >winbind cache type = 15</B
17726 NAME="WINBINDENUMUSERS"
17728 >winbind enum users (G)</DT
17731 >On large installations using
17733 HREF="winbindd.8.html"
17737 necessary to suppress the enumeration of users through the
17749 > group of system calls. If
17753 >winbind enum users</I
17756 false, calls to the <B
17760 will not return any data. </P
17765 enumeration may cause some programs to behave oddly. For
17766 example, the finger program relies on having access to the
17767 full user list when searching for matching
17772 >winbind enum users = yes </B
17777 NAME="WINBINDENUMGROUPS"
17779 >winbind enum groups (G)</DT
17782 >On large installations using
17784 HREF="winbindd.8.html"
17788 necessary to suppress the enumeration of groups through the
17800 > group of system calls. If
17804 >winbind enum groups</I
17807 false, calls to the <B
17811 call will not return any data. </P
17815 > Turning off group
17816 enumeration may cause some programs to behave oddly.
17821 >winbind enum groups = yes </B
17829 >winbind gid (G)</DT
17832 >The winbind gid parameter specifies the range of group
17833 ids that are allocated by the <A
17834 HREF="winbindd.8.html"
17837 > daemon. This range of group ids should have no
17838 existing local or NIS groups within it as strange conflicts can
17839 occur otherwise.</P
17843 >winbind gid = <empty string>
17849 >winbind gid = 10000-20000</B
17854 NAME="WINBINDSEPARATOR"
17856 >winbind separator (G)</DT
17859 >This parameter allows an admin to define the character
17860 used when listing a username of the form of <TT
17861 CLASS="REPLACEABLE"
17867 CLASS="REPLACEABLE"
17872 is only applicable when using the <TT
17874 >pam_winbind.so</TT
17878 >nss_winbind.so</TT
17879 > modules for UNIX services.
17882 >Please note that setting this parameter to + causes problems
17883 with group membership at least on glibc systems, as the character +
17884 is used as a special character for NIS in /etc/group.</P
17888 >winbind separator = '\'</B
17893 >winbind separator = +</B
17900 >winbind uid (G)</DT
17903 >The winbind gid parameter specifies the range of group
17904 ids that are allocated by the <A
17905 HREF="winbindd.8.html"
17908 > daemon. This range of ids should have no
17909 existing local or NIS users within it as strange conflicts can
17910 occur otherwise.</P
17914 >winbind uid = <empty string>
17920 >winbind uid = 10000-20000</B
17924 >winbind use default domain, <A
17925 NAME="WINBINDUSEDEFAULTDOMAIN"
17927 >winbind use default domain</DT
17930 >This parameter specifies whether the <A
17931 HREF="winbindd.8.html"
17935 daemon should operate on users without domain component in their username.
17936 Users without a domain component are treated as is part of the winbindd server's
17937 own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail
17938 function in a way much closer to the way they would in a native unix system.</P
17942 >winbind use default domain = <falseg>
17948 >winbind use default domain = true</B
17958 >When Samba is running as a WINS server this
17959 allows you to call an external program for all changes to the
17960 WINS database. The primary use for this option is to allow the
17961 dynamic update of external name resolution databases such as
17964 >The wins hook parameter specifies the name of a script
17965 or executable that will be called as follows:</P
17969 >wins_hook operation name nametype ttl IP_list
17977 >The first argument is the operation and is one
17978 of "add", "delete", or "refresh". In most cases the operation can
17979 be ignored as the rest of the parameters provide sufficient
17980 information. Note that "refresh" may sometimes be called when the
17981 name has not previously been added, in that case it should be treated
17986 >The second argument is the NetBIOS name. If the
17987 name is not a legal name then the wins hook is not called.
17988 Legal names contain only letters, digits, hyphens, underscores
17993 >The third argument is the NetBIOS name
17994 type as a 2 digit hexadecimal number. </P
17998 >The fourth argument is the TTL (time to live)
17999 for the name in seconds.</P
18003 >The fifth and subsequent arguments are the IP
18004 addresses currently registered for that name. If this list is
18005 empty then the name should be deleted.</P
18009 >An example script that calls the BIND dynamic DNS update
18013 > is provided in the examples
18014 directory of the Samba source code. </P
18020 >wins proxy (G)</DT
18023 >This is a boolean that controls if <A
18027 > will respond to broadcast name
18028 queries on behalf of other hosts. You may need to set this
18032 > for some older clients.</P
18036 >wins proxy = no</B
18043 >wins server (G)</DT
18046 >This specifies the IP address (or DNS name: IP
18047 address for preference) of the WINS server that <A
18051 > should register with. If you have a WINS server on
18052 your network then you should set this to the WINS server's IP.</P
18054 >You should point this at your WINS server if you have a
18055 multi-subnetted network.</P
18059 >. You need to set up Samba to point
18060 to a WINS server if you have multiple subnets and wish cross-subnet
18061 browsing to work correctly.</P
18063 >See the documentation file <TT
18067 in the docs/ directory of your Samba source distribution.</P
18075 >wins server = 192.9.200.1</B
18082 >wins support (G)</DT
18085 >This boolean controls if the <A
18090 > process in Samba will act as a WINS server. You should
18091 not set this to <TT
18094 > unless you have a multi-subnetted network and
18095 you wish a particular <B
18098 > to be your WINS server.
18099 Note that you should <EM
18105 on more than one machine in your network.</P
18109 >wins support = no</B
18119 >This controls what workgroup your server will
18120 appear to be in when queried by clients. Note that this parameter
18121 also controls the Domain name used with the <A
18122 HREF="#SECURITYEQUALSDOMAIN"
18125 >security = domain</B
18131 >set at compile time to WORKGROUP</EM
18136 >workgroup = MYGROUP</B
18154 > for people who can't spell :-).</P
18158 NAME="WRITECACHESIZE"
18160 >write cache size (S)</DT
18163 >If this integer parameter is set to non-zero value,
18164 Samba will create an in-memory cache for each oplocked file
18168 non-oplocked files). All writes that the client does not request
18169 to be flushed directly to disk will be stored in this cache if possible.
18170 The cache is flushed onto disk when a write comes in whose offset
18171 would not fit into the cache or when the file is closed by the client.
18172 Reads for the file are also served from this cache if the data is stored
18175 >This cache allows Samba to batch client writes into a more
18176 efficient write size for RAID disks (i.e. writes may be tuned to
18177 be the RAID stripe size) and can improve performance on systems
18178 where the disk subsystem is a bottleneck but there is free
18179 memory for userspace programs.</P
18181 >The integer parameter specifies the size of this cache
18182 (per oplocked file) in bytes.</P
18186 >write cache size = 0</B
18191 >write cache size = 262144</B
18194 >for a 256k cache size per file.</P
18200 >write list (S)</DT
18203 >This is a list of users that are given read-write
18204 access to a service. If the connecting user is in this list then
18205 they will be given write access, no matter what the <A
18214 option is set to. The list can include group names using the
18217 >Note that if a user is in both the read list and the
18218 write list then they will be given write access.</P
18233 >write list = <empty string>
18239 >write list = admin, root, @staff
18267 >This parameter controls whether or not the server
18268 will support raw write SMB's when transferring data from clients.
18269 You should never need to change this parameter.</P
18273 >write raw = yes</B
18283 >An inverted synonym is <A
18293 >If this parameter is <TT
18297 of a service may not create or modify files in the service's
18300 >Note that a printable service (<B
18302 >printable = yes</B
18306 > allow writing to the directory
18307 (user privileges permitting), but only via spooling operations.</P
18325 >Although the configuration file permits service names
18326 to contain spaces, your client software may not. Spaces will
18327 be ignored in comparisons anyway, so it shouldn't be a
18328 problem - but be aware of the possibility.</P
18330 >On a similar note, many clients - especially DOS clients -
18331 limit service names to eight characters. <A
18336 > has no such limitation, but attempts to connect from such
18337 clients will fail if they truncate the service names. For this reason
18338 you should probably keep your service names down to eight characters
18341 >Use of the [homes] and [printers] special sections make life
18342 for an administrator easy, but the various combinations of default
18343 attributes can be tricky. Take extreme care when designing these
18344 sections. In particular, ensure that the permissions on spool
18345 directories are correct.</P
18355 >This man page is correct for version 2.2 of
18356 the Samba suite.</P
18367 HREF="samba.7.html"
18372 HREF="smbpasswd.8.html"
18404 HREF="smbclient.1.html"
18412 HREF="nmblookup.1.html"
18420 HREF="testparm.1.html"
18428 HREF="testprns.1.html"
18445 >The original Samba software and related utilities
18446 were created by Andrew Tridgell. Samba is now developed
18447 by the Samba Team as an Open Source project similar
18448 to the way the Linux kernel is developed.</P
18450 >The original Samba man pages were written by Karl Auer.
18451 The man page sources were converted to YODL format (another
18452 excellent piece of Open Source software, available at
18454 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
18456 > ftp://ftp.icce.rug.nl/pub/unix/</A
18457 >) and updated for the Samba 2.0
18458 release by Jeremy Allison. The conversion to DocBook for
18459 Samba 2.2 was done by Gerald Carter</P
git.samba.org / samba.git / blob