1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
28 >smb.conf -- The configuration file for the Samba suite</DIV
40 > file is a configuration
41 file for the Samba suite. <TT
45 runtime configuration information for the Samba programs. The <TT
49 is designed to be configured and administered by the <SPAN
55 > program. The complete
56 description of the file format and possible parameters held within
57 are here for reference purposes.</P
67 >The file consists of sections and parameters. A section
68 begins with the name of the section in square brackets and continues
69 until the next section begins. Sections contain parameters of the
81 >The file is line-based - that is, each newline-terminated
82 line represents either a comment, a section name or a parameter.</P
84 >Section and parameter names are not case sensitive.</P
86 >Only the first equals sign in a parameter is significant.
87 Whitespace before or after the first equals sign is discarded.
88 Leading, trailing and internal whitespace in section and parameter
89 names is irrelevant. Leading and trailing whitespace in a parameter
90 value is discarded. Internal whitespace within a parameter value
91 is retained verbatim.</P
93 >Any line beginning with a semicolon (';') or a hash ('#')
94 character is ignored, as are lines containing only whitespace.</P
96 >Any line ending in a '\' is continued
97 on the next line in the customary UNIX fashion.</P
99 >The values following the equals sign in parameters are all
100 either a string (no quotes needed) or a boolean, which may be given
101 as yes/no, 0/1 or true/false. Case is not significant in boolean
102 values, but is preserved in string values. Some items such as
103 create modes are numeric.</P
111 >SECTION DESCRIPTIONS</H2
113 >Each section in the configuration file (except for the
114 [global] section) describes a shared resource (known
115 as a "share"). The section name is the name of the
116 shared resource and the parameters within the section define
117 the shares attributes.</P
119 >There are three special sections, [global],
120 [homes] and [printers], which are
121 described under <SPAN
128 following notes apply to ordinary section descriptions.</P
130 >A share consists of a directory to which access is being
131 given plus a description of the access rights which are granted
132 to the user of the service. Some housekeeping options are
135 >Sections are either file share services (used by the
136 client as an extension of their native file systems) or
137 printable services (used by the client to access print services
138 on the host running the server).</P
140 >Sections may be designated <SPAN
147 in which case no password is required to access them. A specified
154 > is used to define access
155 privileges in this case.</P
157 >Sections other than guest services will require a password
158 to access them. The client provides the username. As older clients
159 only provide passwords and not usernames, you may specify a list
160 of usernames to check against the password using the "user ="
161 option in the share definition. For modern clients such as
162 Windows 95/98/ME/NT/2000, this should not be necessary.</P
164 >Note that the access rights granted by the server are
165 masked by the access rights granted to the specified or guest
166 UNIX user by the host system. The server does not grant more
167 access than the host system grants.</P
169 >The following sample section defines a file space share.
170 The user has write access to the path <TT
174 The share is accessed via the share name "foo":</P
178 CLASS="COMPUTEROUTPUT"
184 >The following sample section defines a printable share.
185 The share is readonly, but printable. That is, the only write
186 access permitted is via calls to open, write to and close a
187 spool file. The <SPAN
194 access will be permitted as the default guest user (specified
199 CLASS="COMPUTEROUTPUT"
201 path = /usr/spool/public
213 >SPECIAL SECTIONS</H2
220 >The [global] section</H3
222 >parameters in this section apply to the server
223 as a whole, or are defaults for sections which do not
224 specifically define certain items. See the notes
225 under PARAMETERS for more information.</P
233 >The [homes] section</H3
235 >If a section called homes is included in the
236 configuration file, services connecting clients to their
237 home directories can be created on the fly by the server.</P
239 >When the connection request is made, the existing
240 sections are scanned. If a match is found, it is used. If no
241 match is found, the requested section name is treated as a
242 user name and looked up in the local password file. If the
243 name exists and the correct password has been given, a share is
244 created by cloning the [homes] section.</P
246 >Some modifications are then made to the newly
253 >The share name is changed from homes to
254 the located username.</P
258 >If no path was given, the path is set to
259 the user's home directory.</P
263 >If you decide to use a <SPAN
270 in your [homes] section then you may find it useful
271 to use the %S macro. For example :</P
275 >path = /data/pchome/%S</KBD
278 >would be useful if you have different home directories
279 for your PCs than for UNIX access.</P
281 >This is a fast and simple way to give a large number
282 of clients access to their home directories with a minimum
285 >A similar process occurs if the requested section
286 name is "homes", except that the share name is not
287 changed to that of the requesting user. This method of using
288 the [homes] section works well if different users share
291 >The [homes] section can specify all the parameters
292 a normal service section can specify, though some make more sense
293 than others. The following is a typical and suitable [homes]
298 CLASS="COMPUTEROUTPUT"
303 >An important point is that if guest access is specified
304 in the [homes] section, all home directories will be
305 visible to all clients <SPAN
309 >without a password</I
312 In the very unlikely event that this is actually desirable, it
313 would be wise to also specify <SPAN
329 auto home directories will be inherited from the global browseable
330 flag, not the [homes] browseable flag. This is useful as
331 it means setting <SPAN
338 the [homes] section will hide the [homes] share but make
339 any auto home directories visible.</P
347 >The [printers] section</H3
349 >This section works like [homes],
352 >If a [printers] section occurs in the
353 configuration file, users are able to connect to any printer
354 specified in the local host's printcap file.</P
356 >When a connection request is made, the existing sections
357 are scanned. If a match is found, it is used. If no match is found,
358 but a [homes] section exists, it is used as described
359 above. Otherwise, the requested section name is treated as a
360 printer name and the appropriate printcap file is scanned to see
361 if the requested section name is a valid printer share name. If
362 a match is found, a new printer share is created by cloning
363 the [printers] section.</P
365 >A few modifications are then made to the newly created
372 >The share name is set to the located printer
377 >If no printer name was given, the printer name
378 is set to the located printer name</P
382 >If the share does not permit guest access and
383 no username was given, the username is set to the located
388 >Note that the [printers] service MUST be
389 printable - if you specify otherwise, the server will refuse
390 to load the configuration file.</P
392 >Typically the path specified would be that of a
393 world-writeable spool directory with the sticky bit set on
394 it. A typical [printers] entry would look like
399 CLASS="COMPUTEROUTPUT"
401 path = /usr/spool/public
403 printable = yes </SAMP
406 >All aliases given for a printer in the printcap file
407 are legitimate printer names as far as the server is concerned.
408 If your printing subsystem doesn't work like that, you will have
409 to set up a pseudo-printcap. This is a file consisting of one or
410 more lines like this:</P
414 CLASS="COMPUTEROUTPUT"
415 >alias|alias|alias|alias... </SAMP
418 >Each alias should be an acceptable printer name for
419 your printing subsystem. In the [global] section, specify
420 the new file as your printcap. The server will then only recognize
421 names found in your pseudo-printcap, which of course can contain
422 whatever aliases you like. The same technique could be used
423 simply to limit access to a subset of your local printers.</P
425 >An alias, by the way, is defined as any component of the
426 first entry of a printcap record. Records are separated by newlines,
427 components (if there are more than one) are separated by vertical
428 bar symbols ('|').</P
430 >NOTE: On SYSV systems which use lpstat to determine what
431 printers are defined on the system you may be able to use
432 "printcap name = lpstat" to automatically obtain a list
433 of printers. See the "printcap name" option
445 >parameters define the specific attributes of sections.</P
447 >Some parameters are specific to the [global] section
454 >). Some parameters are usable
455 in all sections (e.g., <SPAN
462 are permissible only in normal sections. For the purposes of the
463 following descriptions the [homes] and [printers]
464 sections will be considered normal. The letter <SPAN
471 in parentheses indicates that a parameter is specific to the
472 [global] section. The letter <SPAN
479 indicates that a parameter can be specified in a service specific
480 section. Note that all <SPAN
486 > parameters can also be specified in
487 the [global] section - in which case they will define
488 the default behavior for all services.</P
490 >parameters are arranged here in alphabetical order - this may
491 not create best bedfellows, but at least you can find them! Where
492 there are synonyms, the preferred synonym is described, others refer
493 to the preferred synonym.</P
501 >VARIABLE SUBSTITUTIONS</H2
503 >Many of the strings that are settable in the config file
504 can take substitutions. For example the option "path =
505 /tmp/%u" would be interpreted as "path =
506 /tmp/john" if the user connected with the username john.</P
508 >These substitutions are mostly noted in the descriptions below,
509 but there are some general substitutions which apply whenever they
510 might be relevant. These are:</P
520 >session user name (the user name that the client
521 wanted, not necessarily the same as the one they got).</P
527 >primary group name of %U.</P
533 >the Internet hostname that Samba is running
540 >the NetBIOS name of the client machine
547 >the NetBIOS name of the server. This allows you
548 to change your config based on what the client calls you. Your
549 server can have a "dual personality".</P
551 >Note that this parameter is not available when Samba listens
552 on port 445, as clients no longer send this information </P
558 >the Internet name of the client machine.
565 >the selected protocol level after
566 protocol negotiation. It can be one of CORE, COREPLUS,
567 LANMAN1, LANMAN2 or NT1.</P
573 >The process id of the current server
580 >the architecture of the remote
581 machine. Only some are recognized, and those may not be
582 100% reliable. It currently recognizes Samba, WfWg, Win95,
583 WinNT and Win2k. Anything else will be known as
584 "UNKNOWN". If it gets it wrong then sending a level
586 HREF="mailto:samba@samba.org"
590 > should allow it to be fixed.</P
596 >The IP address of the client machine.</P
602 >the current date and time.</P
608 >Name of the domain or workgroup of the current user.</P
617 >The value of the environment variable
626 >The following substitutes apply only to some configuration options(only those
627 that are used when a connection has been established):</P
637 >the name of the current service, if any.</P
643 >the root directory of the current service,
650 >user name of the current service, if any.</P
656 >primary group name of %u.</P
662 >the home directory of the user given
669 >the name of your NIS home directory server.
670 This is obtained from your NIS auto.map entry. If you have
671 not compiled Samba with the <SPAN
678 option then this value will be the same as %L.</P
684 >the path of the service's home directory,
685 obtained from your NIS auto.map entry. The NIS auto.map entry
686 is split up as "%N:%p".</P
691 >There are some quite creative things that can be done
692 with these substitutions and other smb.conf options.</P
702 >Samba supports "name mangling" so that DOS and
703 Windows clients can use files that don't conform to the 8.3 format.
704 It can also be set to adjust the case of 8.3 format filenames.</P
706 >There are several options that control the way mangling is
707 performed, and they are grouped here rather than listed separately.
708 For the defaults look at the output of the testparm program. </P
710 >All of these options can be set separately for each service
711 (or globally, of course). </P
713 >The options are: </P
720 >mangle case = yes/no</DT
723 > controls if names that have characters that
724 aren't of the "default" case are mangled. For example,
725 if this is yes then a name like "Mail" would be mangled.
735 >case sensitive = yes/no</DT
738 >controls whether filenames are case sensitive. If
739 they aren't then Samba must do a filename search and match on passed
749 >default case = upper/lower</DT
752 >controls what the default case is for new
753 filenames. Default <SPAN
762 >preserve case = yes/no</DT
765 >controls if new files are created with the
766 case that the client passes, or if they are forced to be the
767 "default" case. Default <SPAN
777 >short preserve case = yes/no</DT
780 >controls if new files which conform to 8.3 syntax,
781 that is all in upper case and of suitable length, are created
782 upper case, or if they are forced to be the "default"
783 case. This option can be use with "preserve case = yes"
784 to permit long filenames to retain their case, while short names
785 are lowercased. Default <SPAN
796 >By default, Samba 3.0 has the same semantics as a Windows
797 NT server, in that it is case insensitive but case preserving.</P
805 >NOTE ABOUT USERNAME/PASSWORD VALIDATION</H2
807 >There are a number of ways in which a user can connect
808 to a service. The server uses the following steps in determining
809 if it will allow a connection to a specified service. If all the
810 steps fail, then the connection request is rejected. However, if one of the
811 steps succeeds, then the following steps are not checked.</P
813 >If the service is marked "guest only = yes" and the
814 server is running with share-level security ("security = share")
815 then steps 1 to 5 are skipped.</P
822 >If the client has passed a username/password
823 pair and that username/password pair is validated by the UNIX
824 system's password programs then the connection is made as that
825 username. Note that this includes the
826 \\server\service%<VAR
834 >If the client has previously registered a username
835 with the system and now supplies a correct password for that
836 username then the connection is allowed.</P
840 >The client's NetBIOS name and any previously
841 used user names are checked against the supplied password, if
842 they match then the connection is allowed as the corresponding
847 >If the client has previously validated a
848 username/password pair with the server and the client has passed
849 the validation token then that username is used. </P
853 >If a "user = " field is given in the
857 > file for the service and the client
858 has supplied a password, and that password matches (according to
859 the UNIX system's password checking) with one of the usernames
860 from the "user =" field then the connection is made as
861 the username in the "user =" line. If one
862 of the username in the "user =" list begins with a
863 '@' then that name expands to a list of names in
864 the group of the same name.</P
868 >If the service is a guest service then a
869 connection is made as the username given in the "guest
870 account =" for the service, irrespective of the
871 supplied password.</P
881 >COMPLETE LIST OF GLOBAL PARAMETERS</H2
883 >Here is a list of all global parameters. See the section of
884 each parameter for details. Note that some are synonyms.</P
891 HREF="#ABORTSHUTDOWNSCRIPT"
894 >abort shutdown script</VAR
901 HREF="#ADDGROUPSCRIPT"
904 >add group script</VAR
911 HREF="#ADDPRINTERCOMMAND"
914 >addprinter command</VAR
921 HREF="#ADDSHARECOMMAND"
924 >add share command</VAR
931 HREF="#ADDUSERSCRIPT"
934 >add user script</VAR
941 HREF="#ADDUSERTOGROUPSCRIPT"
944 >add user to group script</VAR
951 HREF="#ADDMACHINESCRIPT"
954 >add machine script</VAR
961 HREF="#DELETEGROUPSCRIPT"
964 >delete group script</VAR
981 HREF="#ALGORITHMICRIDBASE"
984 >algorithmic rid base</VAR
991 HREF="#ALLOWTRUSTEDDOMAINS"
994 >allow trusted domains</VAR
1011 HREF="#ANNOUNCEVERSION"
1014 >announce version</VAR
1031 HREF="#AUTOSERVICES"
1041 HREF="#BINDINTERFACESONLY"
1044 >bind interfaces only</VAR
1061 HREF="#CHANGENOTIFYTIMEOUT"
1064 >change notify timeout</VAR
1071 HREF="#CHANGESHARECOMMAND"
1074 >change share command</VAR
1101 HREF="#DEBUGHIRESTIMESTAMP"
1104 >debug hires timestamp</VAR
1121 HREF="#DEBUGTIMESTAMP"
1124 >debug timestamp</VAR
1161 HREF="#DEFAULTSERVICE"
1164 >default service</VAR
1171 HREF="#DELETEPRINTERCOMMAND"
1174 >deleteprinter command</VAR
1181 HREF="#DELETESHARECOMMAND"
1184 >delete share command</VAR
1191 HREF="#DELETEUSERSCRIPT"
1194 >delete user script</VAR
1201 HREF="#DELETEUSERFROMGROUPSCRIPT"
1204 >delete user from group script</VAR
1211 HREF="#DFREECOMMAND"
1221 HREF="#DISABLENETBIOS"
1224 >disable netbios</VAR
1231 HREF="#DISABLESPOOLSS"
1234 >disable spoolss</VAR
1241 HREF="#DISPLAYCHARSET"
1244 >display charset</VAR
1261 HREF="#DOMAINLOGONS"
1271 HREF="#DOMAINMASTER"
1291 HREF="#ENCRYPTPASSWORDS"
1294 >encrypt passwords</VAR
1301 HREF="#ENHANCEDBROWSING"
1304 >enhanced browsing</VAR
1311 HREF="#ENUMPORTSCOMMAND"
1314 >enumports command</VAR
1331 HREF="#HIDELOCALUSERS"
1334 >hide local users</VAR
1341 HREF="#HIDEUNREADABLE"
1344 >hide unreadable</VAR
1351 HREF="#HIDEUNWRITEABLEFILES"
1354 >hide unwriteable files</VAR
1361 HREF="#HIDESPECIALFILES"
1364 >hide special files</VAR
1391 HREF="#HOSTNAMELOOKUPS"
1394 >hostname lookups</VAR
1431 HREF="#KERNELOPLOCKS"
1434 >kernel oplocks</VAR
1451 HREF="#LARGEREADWRITE"
1454 >large readwrite</VAR
1521 HREF="#LDAPUSERSUFFIX"
1524 >ldap user suffix</VAR
1531 HREF="#LDAPMACHINESUFFIX"
1534 >ldap machine suffix</VAR
1541 HREF="#LDAPPASSWDSYNC"
1544 >ldap passwd sync</VAR
1551 HREF="#LDAPTRUSTIDS"
1554 >ldap trust ids</VAR
1581 HREF="#LOADPRINTERS"
1611 HREF="#LOCKDIRECTORY"
1614 >lock directory</VAR
1621 HREF="#LOCKSPINCOUNT"
1624 >lock spin count</VAR
1631 HREF="#LOCKSPINTIME"
1634 >lock spin time</VAR
1641 HREF="#PIDDIRECTORY"
1711 HREF="#LPQCACHETIME"
1714 >lpq cache time</VAR
1721 HREF="#MACHINEPASSWORDTIMEOUT"
1724 >machine password timeout</VAR
1731 HREF="#MANGLEPREFIX"
1741 HREF="#MANGLEDSTACK"
1791 HREF="#MAXOPENFILES"
1794 >max open files</VAR
1811 HREF="#MAXSMBDPROCESSES"
1814 >max smbd processes</VAR
1851 HREF="#MESSAGECOMMAND"
1854 >message command</VAR
1861 HREF="#MINPASSWDLENGTH"
1864 >min passwd length</VAR
1871 HREF="#MINPASSWORDLENGTH"
1874 >min password length</VAR
1901 HREF="#NAMECACHETIMEOUT"
1904 >name cache timeout</VAR
1911 HREF="#NAMERESOLVEORDER"
1914 >name resolve order</VAR
1921 HREF="#NETBIOSALIASES"
1924 >netbios aliases</VAR
1941 HREF="#NETBIOSSCOPE"
1971 HREF="#NONUNIXACCOUNTRANGE"
1974 >non unix account range</VAR
1981 HREF="#NTPIPESUPPORT"
1984 >nt pipe support</VAR
1991 HREF="#NTSTATUSSUPPORT"
1994 >nt status support</VAR
2001 HREF="#NULLPASSWORDS"
2004 >null passwords</VAR
2011 HREF="#OBEYPAMRESTRICTIONS"
2014 >obey pam restrictions</VAR
2021 HREF="#OPLOCKBREAKWAITTIME"
2024 >oplock break wait time</VAR
2041 HREF="#OS2DRIVERMAP"
2044 >os2 driver map</VAR
2051 HREF="#PAMPASSWORDCHANGE"
2054 >pam password change</VAR
2071 HREF="#PARANOIDSERVERSECURITY"
2074 >paranoid server security</VAR
2081 HREF="#PASSDBBACKEND"
2084 >passdb backend</VAR
2101 HREF="#PASSWDCHATDEBUG"
2104 >passwd chat debug</VAR
2111 HREF="#PASSWDPROGRAM"
2114 >passwd program</VAR
2121 HREF="#PASSWORDLEVEL"
2124 >password level</VAR
2131 HREF="#PASSWORDSERVER"
2134 >password server</VAR
2141 HREF="#PREFEREDMASTER"
2144 >prefered master</VAR
2151 HREF="#PREFERREDMASTER"
2154 >preferred master</VAR
2181 HREF="#PRINTCAPNAME"
2251 HREF="#REMOTEANNOUNCE"
2254 >remote announce</VAR
2261 HREF="#REMOTEBROWSESYNC"
2264 >remote browse sync</VAR
2271 HREF="#RESTRICTANONYMOUS"
2274 >restrict anonymous</VAR
2301 HREF="#ROOTDIRECTORY"
2304 >root directory</VAR
2321 HREF="#SERVERSTRING"
2331 HREF="#SHOWADDPRINTERWIZARD"
2334 >show add printer wizard</VAR
2341 HREF="#SHUTDOWNSCRIPT"
2344 >shutdown script</VAR
2351 HREF="#SMBPASSWDFILE"
2354 >smb passwd file</VAR
2371 HREF="#SOCKETADDRESS"
2374 >socket address</VAR
2381 HREF="#SOCKETOPTIONS"
2384 >socket options</VAR
2391 HREF="#SOURCEENVIRONMENT"
2394 >source environment</VAR
2421 HREF="#STATCACHESIZE"
2424 >stat cache size</VAR
2461 HREF="#TEMPLATEHOMEDIR"
2464 >template homedir</VAR
2471 HREF="#TEMPLATESHELL"
2474 >template shell</VAR
2501 HREF="#TIMESTAMPLOGS"
2504 >timestamp logs</VAR
2511 HREF="#TOTALPRINTJOBS"
2514 >total print jobs</VAR
2541 HREF="#UNIXEXTENSIONS"
2544 >unix extensions</VAR
2551 HREF="#UNIXPASSWORDSYNC"
2554 >unix password sync</VAR
2561 HREF="#UPDATEENCRYPTED"
2564 >update encrypted</VAR
2591 HREF="#USERNAMELEVEL"
2594 >username level</VAR
2621 HREF="#UTMPDIRECTORY"
2624 >utmp directory</VAR
2631 HREF="#WTMPDIRECTORY"
2634 >wtmp directory</VAR
2641 HREF="#WINBINDCACHETIME"
2644 >winbind cache time</VAR
2651 HREF="#WINBINDENUMUSERS"
2654 >winbind enum users</VAR
2661 HREF="#WINBINDENUMGROUPS"
2664 >winbind enum groups</VAR
2681 HREF="#WINBINDSEPARATOR"
2684 >winbind separator</VAR
2701 HREF="#WINBINDUSEDEFAULTDOMAIN"
2704 >winbind use default domain</VAR
2721 HREF="#WINSPARTNERS"
2786 >COMPLETE LIST OF SERVICE PARAMETERS</H2
2788 >Here is a list of all service parameters. See the section on
2789 each parameter for details. Note that some are synonyms.</P
2826 HREF="#BLOCKINGLOCKS"
2829 >blocking locks</VAR
2866 HREF="#CASESENSITIVE"
2869 >case sensitive</VAR
2876 HREF="#CASESIGNAMES"
2946 HREF="#DEFAULTDEVMODE"
2949 >default devmode</VAR
2956 HREF="#DELETEREADONLY"
2959 >delete readonly</VAR
2966 HREF="#DELETEVETOFILES"
2969 >delete veto files</VAR
2996 HREF="#DIRECTORYMASK"
2999 >directory mask</VAR
3006 HREF="#DIRECTORYMODE"
3009 >directory mode</VAR
3016 HREF="#DIRECTORYSECURITYMASK"
3019 >directory security mask</VAR
3046 HREF="#DOSFILETIMERESOLUTION"
3049 >dos filetime resolution</VAR
3056 HREF="#DOSFILETIMES"
3076 HREF="#FAKEDIRECTORYCREATETIMES"
3079 >fake directory create times</VAR
3096 HREF="#FOLLOWSYMLINKS"
3099 >follow symlinks</VAR
3106 HREF="#FORCECREATEMODE"
3109 >force create mode</VAR
3116 HREF="#FORCEDIRECTORYMODE"
3119 >force directory mode</VAR
3126 HREF="#FORCEDIRECTORYSECURITYMODE"
3129 >force directory security mode</VAR
3146 HREF="#FORCESECURITYMODE"
3149 >force security mode</VAR
3186 HREF="#GUESTACCOUNT"
3216 HREF="#HIDEDOTFILES"
3219 >hide dot files</VAR
3276 HREF="#INHERITPERMISSIONS"
3279 >inherit permissions</VAR
3286 HREF="#INVALIDUSERS"
3296 HREF="#LEVEL2OPLOCKS"
3299 >level2 oplocks</VAR
3316 HREF="#LPPAUSECOMMAND"
3319 >lppause command</VAR
3336 HREF="#LPRESUMECOMMAND"
3339 >lpresume command</VAR
3396 HREF="#MANGLEDNAMES"
3406 HREF="#MANGLINGCHAR"
3416 HREF="#MANGLINGMETHOD"
3419 >mangling method</VAR
3456 HREF="#MAXCONNECTIONS"
3459 >max connections</VAR
3466 HREF="#MAXPRINTJOBS"
3469 >max print jobs</VAR
3476 HREF="#MINPRINTSPACE"
3479 >min print space</VAR
3506 HREF="#NTACLSUPPORT"
3509 >nt acl support</VAR
3536 HREF="#OPLOCKCONTENTIONLIMIT"
3539 >oplock contention limit</VAR
3566 HREF="#POSIXLOCKING"
3596 HREF="#PREEXECCLOSE"
3606 HREF="#PRESERVECASE"
3616 HREF="#PRINTCOMMAND"
3656 HREF="#PRINTERADMIN"
3696 HREF="#QUEUEPAUSECOMMAND"
3699 >queuepause command</VAR
3706 HREF="#QUEUERESUMECOMMAND"
3709 >queueresume command</VAR
3736 HREF="#ROOTPOSTEXEC"
3756 HREF="#ROOTPREEXECCLOSE"
3759 >root preexec close</VAR
3766 HREF="#SECURITYMASK"
3776 HREF="#SETDIRECTORY"
3796 HREF="#SHORTPRESERVECASE"
3799 >short preserve case</VAR
3806 HREF="#STRICTALLOCATE"
3809 >strict allocate</VAR
3816 HREF="#STRICTLOCKING"
3819 >strict locking</VAR
3846 HREF="#USECLIENTDRIVER"
3849 >use client driver</VAR
3906 HREF="#VETOOPLOCKFILES"
3909 >veto oplock files</VAR
3976 HREF="#WRITECACHESIZE"
3979 >write cache size</VAR
4021 >EXPLANATION OF EACH PARAMETER</H2
4025 CLASS="VARIABLELIST"
4029 NAME="ABORTSHUTDOWNSCRIPT"
4031 >>abort shutdown script (G)</DT
4038 >This parameter only exists in the HEAD cvs branch</I
4041 This a full path name to a script called by <SPAN
4042 CLASS="CITEREFENTRY"
4044 CLASS="REFENTRYTITLE"
4048 should stop a shutdown procedure issued by the <A
4049 HREF="#SHUTDOWNSCRIPT"
4052 >shutdown script</VAR
4056 >This command will be run as user.</P
4068 >abort shutdown script = /sbin/shutdown -c</B
4073 NAME="ADDPRINTERCOMMAND"
4075 >>addprinter command (G)</DT
4078 >With the introduction of MS-RPC based printing
4079 support for Windows NT/2000 clients in Samba 2.2, The MS Add
4080 Printer Wizard (APW) icon is now also available in the
4081 "Printers..." folder displayed a share listing. The APW
4082 allows for printers to be add remotely to a Samba or Windows
4083 NT/2000 print server.</P
4085 >For a Samba host this means that the printer must be
4086 physically added to the underlying printing system. The <VAR
4089 printer command</VAR
4090 > defines a script to be run which
4091 will perform the necessary operations for adding the printer
4092 to the print system and to add the appropriate service definition
4096 > file in order that it can be
4098 CLASS="CITEREFENTRY"
4100 CLASS="REFENTRYTITLE"
4107 >addprinter command</VAR
4109 automatically invoked with the following parameter (in
4153 >Windows 9x driver location</VAR
4159 >All parameters are filled in from the PRINTER_INFO_2 structure sent
4160 by the Windows NT/2000 client with one exception. The "Windows 9x
4161 driver location" parameter is included for backwards compatibility
4162 only. The remaining fields in the structure are generated from answers
4163 to the APW questions.</P
4167 >addprinter command</VAR
4172 > will reparse the <TT
4175 > to determine if the share defined by the APW
4176 exists. If the sharename is still invalid, then <B
4180 > will return an ACCESS_DENIED error to the client.</P
4182 > The "add printer command" program can output a single line of text,
4183 which Samba will set as the port the new printer is connected to.
4184 If this line isn't output, Samba won't reload its printer shares.
4188 HREF="#DELETEPRINTERCOMMAND"
4191 > deleteprinter command</VAR
4201 HREF="#SHOWADDPRINTERWIZARD"
4219 >addprinter command = /usr/bin/addprinter
4225 NAME="ADDSHARECOMMAND"
4227 >>add share command (G)</DT
4230 >Samba 2.2.0 introduced the ability to dynamically
4231 add and delete shares via the Windows NT 4.0 Server Manager. The
4234 >add share command</VAR
4235 > is used to define an
4236 external program or script which will add a new service definition
4240 >. In order to successfully
4243 >add share command</VAR
4248 requires that the administrator be connected using a root account (i.e.
4255 > will automatically invoke the
4258 >add share command</VAR
4259 > with four parameters.
4281 > - the name of the new
4290 > - path to an **existing**
4299 > - comment string to associate
4305 > This parameter is only used for add file shares. To add printer shares,
4307 HREF="#ADDPRINTERCOMMAND"
4317 HREF="#CHANGESHARECOMMAND"
4324 HREF="#DELETESHARECOMMAND"
4343 >add share command = /usr/local/bin/addshare</B
4348 NAME="ADDMACHINESCRIPT"
4350 >>add machine script (G)</DT
4353 >This is the full pathname to a script that will
4355 CLASS="CITEREFENTRY"
4357 CLASS="REFENTRYTITLE"
4360 > when a machine is added
4361 to it's domain using the administrator username and password method. </P
4363 >This option is only required when using sam back-ends tied to the
4364 Unix uid method of RID calculation such as smbpasswd. This option is only
4365 available in Samba 3.0.</P
4369 >add machine script = <empty string>
4375 >add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u
4383 >>ads server (G)</DT
4386 >If this option is specified, samba does
4387 not try to figure out what ads server to use itself, but
4388 uses the specified ads server. Either one DNS name or IP
4389 address can be used.</P
4398 >ads server = 192.168.1.2</B
4403 NAME="ADDUSERSCRIPT"
4405 >>add user script (G)</DT
4408 >This is the full pathname to a script that will
4416 CLASS="CITEREFENTRY"
4418 CLASS="REFENTRYTITLE"
4421 > under special circumstances described below.</P
4423 >Normally, a Samba server requires that UNIX users are
4424 created for all users accessing files on this server. For sites
4425 that use Windows NT account databases as their primary user database
4426 creating these users and keeping the user list in sync with the
4427 Windows NT PDC is an onerous task. This option allows <A
4431 > to create the required UNIX users
4438 > when a user accesses the Samba server.</P
4440 >In order to use this option, <SPAN
4441 CLASS="CITEREFENTRY"
4443 CLASS="REFENTRYTITLE"
4454 >security = share</VAR
4458 >add user script</VAR
4460 must be set to a full pathname for a script that will create a UNIX
4461 user given one argument of <VAR
4464 >, which expands into
4465 the UNIX user name to create.</P
4467 >When the Windows user attempts to access the Samba server,
4468 at login (session setup in the SMB protocol) time, <SPAN
4469 CLASS="CITEREFENTRY"
4471 CLASS="REFENTRYTITLE"
4476 >password server</VAR
4478 attempts to authenticate the given user with the given password. If the
4479 authentication succeeds then <B
4483 attempts to find a UNIX user in the UNIX password database to map the
4484 Windows user into. If this lookup fails, and <VAR
4492 call the specified script <SPAN
4502 > argument to be the user name to create.</P
4504 >If this script successfully creates the user then <B
4508 > will continue on as though the UNIX user
4509 already existed. In this way, UNIX users are dynamically created to
4510 match existing Windows NT accounts.</P
4519 HREF="#PASSWORDSERVER"
4522 >password server</VAR
4526 HREF="#DELETEUSERSCRIPT"
4536 >add user script = <empty string>
4542 >add user script = /usr/local/samba/bin/add_user
4548 NAME="ADDGROUPSCRIPT"
4550 >>add group script (G)</DT
4553 >This is the full pathname to a script that will
4561 CLASS="CITEREFENTRY"
4563 CLASS="REFENTRYTITLE"
4566 > when a new group is
4567 requested. It will expand any
4571 > to the group name passed.
4572 This script is only useful for installations using the
4573 Windows NT domain administration tools. The script is
4574 free to create a group with an arbitrary name to
4575 circumvent unix group name restrictions. In that case
4576 the script must print the numeric gid of the created
4584 >>admin users (S)</DT
4587 >This is a list of users who will be granted
4588 administrative privileges on the share. This means that they
4589 will do all file operations as the super-user (root).</P
4591 >You should use this option very carefully, as any user in
4592 this list will be able to do anything they like on the share,
4593 irrespective of file permissions.</P
4605 >admin users = jason</B
4610 NAME="ADDUSERTOGROUPSCRIPT"
4612 >>add user to group script (G)</DT
4615 >Full path to the script that will be called when
4616 a user is added to a group using the Windows NT domain administration
4617 tools. It will be run by <SPAN
4618 CLASS="CITEREFENTRY"
4620 CLASS="REFENTRYTITLE"
4633 > will be replaced with the group name and
4637 > will be replaced with the user name.
4642 >add user to group script = </B
4647 >add user to group script = /usr/sbin/adduser %u %g</B
4654 >>allow hosts (S)</DT
4667 NAME="ALGORITHMICRIDBASE"
4669 >>algorithmic rid base (G)</DT
4672 >This determines how Samba will use its
4673 algorithmic mapping from uids/gid to the RIDs needed to construct
4674 NT Security Identifiers.</P
4676 >Setting this option to a larger value could be useful to sites
4677 transitioning from WinNT and Win2k, as existing user and
4678 group rids would otherwise clash with sytem users etc.
4681 >All UIDs and GIDs must be able to be resolved into SIDs for
4682 the correct operation of ACLs on the server. As such the algorithmic
4683 mapping can't be 'turned off', but pushing it 'out of the way' should
4684 resolve the issues. Users and groups can then be assigned 'low' RIDs
4685 in arbitary-rid supporting backends. </P
4689 >algorithmic rid base = 1000</B
4694 >algorithmic rid base = 100000</B
4699 NAME="ALLOWTRUSTEDDOMAINS"
4701 >>allow trusted domains (G)</DT
4704 >This option only takes effect when the <A
4718 If it is set to no, then attempts to connect to a resource from
4719 a domain or workgroup other than the one which <A
4724 in will fail, even if that domain is trusted by the remote server
4725 doing the authentication.</P
4727 >This is useful if you only want your Samba server to
4728 serve resources to users in the domain it is a member of. As
4729 an example, suppose that there are two domains DOMA and DOMB. DOMB
4730 is trusted by DOMA, which contains the Samba server. Under normal
4731 circumstances, a user with an account in DOMB can then access the
4732 resources of a UNIX account with the same account name on the
4733 Samba server even if they do not have an account in DOMA. This
4734 can make implementing a security boundary difficult.</P
4738 >allow trusted domains = yes</B
4745 >>announce as (G)</DT
4748 >This specifies what type of server <SPAN
4749 CLASS="CITEREFENTRY"
4751 CLASS="REFENTRYTITLE"
4754 > will announce itself as, to a network neighborhood browse
4755 list. By default this is set to Windows NT. The valid options
4756 are : "NT Server" (which can also be written as "NT"),
4757 "NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
4758 Windows NT Workstation, Windows 95 and Windows for Workgroups
4759 respectively. Do not change this parameter unless you have a
4760 specific need to stop Samba appearing as an NT server as this
4761 may prevent Samba servers from participating as browser servers
4766 >announce as = NT Server</B
4771 >announce as = Win95</B
4776 NAME="ANNOUNCEVERSION"
4778 >>announce version (G)</DT
4781 >This specifies the major and minor version numbers
4782 that nmbd will use when announcing itself as a server. The default
4783 is 4.9. Do not change this parameter unless you have a specific
4784 need to set a Samba server to be a downlevel server.</P
4788 >announce version = 4.9</B
4793 >announce version = 2.0</B
4800 >>auto services (G)</DT
4803 >This is a synonym for the <A
4815 >>auth methods (G)</DT
4818 >This option allows the administrator to chose what
4819 authentication methods <B
4822 > will use when authenticating
4823 a user. This option defaults to sensible values based on <A
4831 Each entry in the list attempts to authenticate the user in turn, until
4832 the user authenticates. In practice only one method will ever actually
4833 be able to complete the authentication.
4838 >auth methods = <empty string></B
4843 >auth methods = guest sam ntdomain</B
4850 >>available (S)</DT
4853 >This parameter lets you "turn off" a service. If
4856 >available = no</VAR
4864 attempts to connect to the service will fail. Such failures are
4874 NAME="BINDINTERFACESONLY"
4876 >>bind interfaces only (G)</DT
4879 >This global parameter allows the Samba admin
4880 to limit what interfaces on a machine will serve SMB requests. It
4881 affects file service <SPAN
4882 CLASS="CITEREFENTRY"
4884 CLASS="REFENTRYTITLE"
4887 > and name service <SPAN
4888 CLASS="CITEREFENTRY"
4890 CLASS="REFENTRYTITLE"
4893 > in a slightly different ways.</P
4895 >For name service it causes <B
4899 to ports 137 and 138 on the interfaces listed in the <A
4906 > also binds to the "all addresses" interface (0.0.0.0)
4907 on ports 137 and 138 for the purposes of reading broadcast messages.
4908 If this option is not set then <B
4912 name requests on all of these sockets. If <VAR
4920 source address of any packets coming in on the broadcast sockets
4921 and discard any that don't match the broadcast addresses of the
4922 interfaces in the <VAR
4926 As unicast packets are received on the other sockets it allows
4930 > to refuse to serve names to machines that
4931 send packets that arrive through any interfaces not listed in the
4935 > list. IP Source address spoofing
4936 does defeat this simple check, however, so it must not be used
4937 seriously as a security feature for <B
4942 >For file service it causes <SPAN
4943 CLASS="CITEREFENTRY"
4945 CLASS="REFENTRYTITLE"
4948 > to bind only to the interface list
4952 > parameter. This restricts the networks that
4956 > will serve to packets coming in those
4957 interfaces. Note that you should not use this parameter for machines
4958 that are serving PPP or other intermittent or non-broadcast network
4959 interfaces as it will not cope with non-permanent interfaces.</P
4963 >bind interfaces only</VAR
4965 unless the network address <SPAN
4975 > parameter list <SPAN
4976 CLASS="CITEREFENTRY"
4978 CLASS="REFENTRYTITLE"
4982 CLASS="CITEREFENTRY"
4984 CLASS="REFENTRYTITLE"
4987 > may not work as expected due to the reasons covered below.</P
4989 >To change a users SMB password, the <B
4993 by default connects to the <SPAN
4997 >localhost - 127.0.0.1</I
5000 address as an SMB client to issue the password change request. If
5003 >bind interfaces only</VAR
5004 > is set then unless the
5005 network address <SPAN
5015 > parameter list then <B
5018 > will fail to connect in it's default mode.
5022 > can be forced to use the primary IP interface
5023 of the local host by using its <SPAN
5024 CLASS="CITEREFENTRY"
5026 CLASS="REFENTRYTITLE"
5033 >remote machine</VAR
5036 parameter, with <VAR
5038 >remote machine</VAR
5040 to the IP name of the primary interface of the local host.</P
5045 > status page tries to connect with
5059 > to determine if they are running.
5073 "not running" even if they really are. This can prevent <B
5076 > from starting/stopping/restarting <B
5087 >bind interfaces only = no</B
5092 NAME="BLOCKINGLOCKS"
5094 >>blocking locks (S)</DT
5097 >This parameter controls the behavior
5099 CLASS="CITEREFENTRY"
5101 CLASS="REFENTRYTITLE"
5104 > when given a request by a client
5105 to obtain a byte range lock on a region of an open file, and the
5106 request has a time limit associated with it.</P
5108 >If this parameter is set and the lock range requested
5109 cannot be immediately satisfied, samba will internally
5110 queue the lock request, and periodically attempt to obtain
5111 the lock until the timeout period expires.</P
5113 >If this parameter is set to <CODE
5117 samba will behave as previous versions of Samba would and
5118 will fail the lock request immediately if the lock range
5119 cannot be obtained.</P
5123 >blocking locks = yes</B
5130 >>block size (S)</DT
5133 >This parameter controls the behavior of <SPAN
5134 CLASS="CITEREFENTRY"
5136 CLASS="REFENTRYTITLE"
5139 > when reporting disk free
5140 sizes. By default, this reports a disk block size of 1024 bytes.
5143 >Changing this parameter may have some effect on the
5144 efficiency of client writes, this is not yet confirmed. This
5145 parameter was added to allow advanced administrators to change
5146 it (usually to a higher value) and test the effect it has on
5147 client write performance without re-compiling the code. As this
5148 is an experimental option it may be removed in a future release.
5151 >Changing this option does not change the disk free reporting
5152 size, just the block size unit reported to the client.</P
5158 >>browsable (S)</DT
5173 >>browse list (G)</DT
5176 >This controls whether <SPAN
5177 CLASS="CITEREFENTRY"
5179 CLASS="REFENTRYTITLE"
5182 > will serve a browse list to
5190 >. You should never need to change
5195 >browse list = yes</B
5202 >>browseable (S)</DT
5205 >This controls whether this share is seen in
5206 the list of available shares in a net view and in the browse list.</P
5210 >browseable = yes</B
5215 NAME="CASESENSITIVE"
5217 >>case sensitive (S)</DT
5220 >See the discussion in the section <A
5227 >case sensitive = no</B
5234 >>casesignames (S)</DT
5238 HREF="#CASESENSITIVE"
5245 NAME="CHANGENOTIFYTIMEOUT"
5247 >>change notify timeout (G)</DT
5250 >This SMB allows a client to tell a server to
5251 "watch" a particular directory for any changes and only reply to
5252 the SMB request when a change has occurred. Such constant scanning of
5253 a directory is expensive under UNIX, hence an <SPAN
5254 CLASS="CITEREFENTRY"
5256 CLASS="REFENTRYTITLE"
5259 > daemon only performs such a scan
5260 on each requested directory once every <VAR
5268 >change notify timeout = 60</B
5273 >change notify timeout = 300</B
5276 >Would change the scan time to every 5 minutes.</P
5280 NAME="CHANGESHARECOMMAND"
5282 >>change share command (G)</DT
5285 >Samba 2.2.0 introduced the ability to dynamically
5286 add and delete shares via the Windows NT 4.0 Server Manager. The
5289 >change share command</VAR
5290 > is used to define an
5291 external program or script which will modify an existing service definition
5295 >. In order to successfully
5298 >change share command</VAR
5303 requires that the administrator be connected using a root account (i.e.
5310 > will automatically invoke the
5313 >change share command</VAR
5314 > with four parameters.
5336 > - the name of the new
5345 > - path to an **existing**
5354 > - comment string to associate
5360 > This parameter is only used modify existing file shares definitions. To modify
5361 printer shares, use the "Printers..." folder as seen when browsing the Samba host.
5365 HREF="#ADDSHARECOMMAND"
5372 HREF="#DELETESHARECOMMAND"
5391 >change share command = /usr/local/bin/addshare</B
5398 >>comment (S)</DT
5401 >This is a text field that is seen next to a share
5402 when a client does a queries the server, either via the network
5403 neighborhood or via <B
5406 > to list what shares
5409 >If you want to set the string that is displayed next to the
5410 machine name then see the <A
5411 HREF="#SERVERSTRING"
5414 > server string</VAR
5422 >No comment string</I
5428 >comment = Fred's Files</B
5435 >>config file (G)</DT
5438 >This allows you to override the config file
5439 to use, instead of the default (usually <TT
5443 There is a chicken and egg problem here as this option is set
5444 in the config file!</P
5446 >For this reason, if the name of the config file has changed
5447 when the parameters are loaded then it will reload them from
5448 the new config file.</P
5450 >This option takes the usual substitutions, which can
5453 >If the config file doesn't exist then it won't be loaded
5454 (allowing you to special case the config files of just a few
5459 >config file = /usr/local/samba/lib/smb.conf.%m
5470 >This parameter allows you to "clone" service
5471 entries. The specified service is simply duplicated under the
5472 current service's name. Any parameters specified in the current
5473 section will override those in the section being copied.</P
5475 >This feature lets you set up a 'template' service and
5476 create similar services easily. Note that the service being
5477 copied must occur earlier in the configuration file than the
5478 service doing the copying.</P
5490 >copy = otherservice</B
5497 >>create mask (S)</DT
5500 >A synonym for this parameter is
5510 >When a file is created, the necessary permissions are
5511 calculated according to the mapping from DOS modes to UNIX
5512 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
5513 with this parameter. This parameter may be thought of as a bit-wise
5514 MASK for the UNIX modes of a file. Any bit <SPAN
5521 set here will be removed from the modes set on a file when it is
5524 >The default value of this parameter removes the
5525 'group' and 'other' write and execute bits from the UNIX modes.</P
5527 >Following this Samba will bit-wise 'OR' the UNIX mode created
5528 from this parameter with the value of the <A
5529 HREF="#FORCECREATEMODE"
5532 >force create mode</VAR
5535 parameter which is set to 000 by default.</P
5537 >This parameter does not affect directory modes. See the
5539 HREF="#DIRECTORYMODE"
5548 HREF="#FORCECREATEMODE"
5554 > parameter for forcing particular mode
5555 bits to be set on created files. See also the <A
5556 HREF="#DIRECTORYMODE"
5559 >directory mode</VAR
5561 > parameter for masking
5562 mode bits on created directories. See also the <A
5563 HREF="#INHERITPERMISSIONS"
5566 >inherit permissions</VAR
5570 >Note that this parameter does not apply to permissions
5571 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
5572 a mask on access control lists also, they need to set the <A
5573 HREF="#SECURITYMASK"
5582 >create mask = 0744</B
5587 >create mask = 0775</B
5594 >>create mode (S)</DT
5597 >This is a synonym for <A
5609 >>csc policy (S)</DT
5612 >This stands for <SPAN
5616 >client-side caching
5619 >, and specifies how clients capable of offline
5620 caching will cache the files in the share. The valid values
5621 are: manual, documents, programs, disable.</P
5623 >These values correspond to those used on Windows
5626 >For example, shares containing roaming profiles can have
5627 offline caching disabled using <B
5629 >csc policy = disable
5635 >csc policy = manual</B
5640 >csc policy = programs</B
5647 >>deadtime (G)</DT
5650 >The value of the parameter (a decimal integer)
5651 represents the number of minutes of inactivity before a connection
5652 is considered dead, and it is disconnected. The deadtime only takes
5653 effect if the number of open files is zero.</P
5655 >This is useful to stop a server's resources being
5656 exhausted by a large number of inactive connections.</P
5658 >Most clients have an auto-reconnect feature when a
5659 connection is broken so in most cases this parameter should be
5660 transparent to users.</P
5662 >Using this parameter with a timeout of a few minutes
5663 is recommended for most systems.</P
5665 >A deadtime of zero indicates that no auto-disconnection
5666 should be performed.</P
5680 NAME="DEBUGHIRESTIMESTAMP"
5682 >>debug hires timestamp (G)</DT
5685 >Sometimes the timestamps in the log messages
5686 are needed with a resolution of higher that seconds, this
5687 boolean parameter adds microsecond resolution to the timestamp
5688 message header when turned on.</P
5690 >Note that the parameter <A
5691 HREF="#DEBUGTIMESTAMP"
5694 > debug timestamp</VAR
5696 > must be on for this to have an
5701 >debug hires timestamp = no</B
5708 >>debug pid (G)</DT
5711 >When using only one log file for more then one
5716 >-process there may be hard to follow which process
5717 outputs which message. This boolean parameter is adds the process-id
5718 to the timestamp message headers in the logfile when turned on.</P
5720 >Note that the parameter <A
5721 HREF="#DEBUGTIMESTAMP"
5724 > debug timestamp</VAR
5726 > must be on for this to have an
5736 NAME="DEBUGTIMESTAMP"
5738 >>debug timestamp (G)</DT
5741 >Samba debug log messages are timestamped
5742 by default. If you are running at a high <A
5749 can be distracting. This boolean parameter allows timestamping
5750 to be turned off.</P
5754 >debug timestamp = yes</B
5761 >>debug uid (G)</DT
5764 >Samba is sometimes run as root and sometime
5765 run as the connected user, this boolean parameter inserts the
5766 current euid, egid, uid and gid to the timestamp message headers
5767 in the log file if turned on.</P
5769 >Note that the parameter <A
5770 HREF="#DEBUGTIMESTAMP"
5773 > debug timestamp</VAR
5775 > must be on for this to have an
5787 >>debuglevel (G)</DT
5802 >>default (G)</DT
5806 HREF="#DEFAULTSERVICE"
5809 > default service</VAR
5817 >>default case (S)</DT
5820 >See the section on <A
5824 HREF="#SHORTPRESERVECASE"
5827 >short preserve case</VAR
5833 >default case = lower</B
5838 NAME="DEFAULTDEVMODE"
5840 >>default devmode (S)</DT
5843 >This parameter is only applicable to <A
5846 > services. When smbd is serving
5847 Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba
5848 server has a Device Mode which defines things such as paper size and
5849 orientation and duplex settings. The device mode can only correctly be
5850 generated by the printer driver itself (which can only be executed on a
5851 Win32 platform). Because smbd is unable to execute the driver code
5852 to generate the device mode, the default behavior is to set this field
5856 >Most problems with serving printer drivers to Windows NT/2k/XP clients
5857 can be traced to a problem with the generated device mode. Certain drivers
5858 will do things such as crashing the client's Explorer.exe with a NULL devmode.
5859 However, other printer drivers can cause the client's spooler service
5860 (spoolsv.exe) to die if the devmode was not created by the driver itself
5861 (i.e. smbd generates a default devmode).
5864 >This parameter should be used with care and tested with the printer
5865 driver in question. It is better to leave the device mode to NULL
5866 and let the Windows client set the correct values. Because drivers do not
5867 do this all the time, setting <B
5869 >default devmode = yes</B
5871 will instruct smbd to generate a default one.
5874 >For more information on Windows NT/2k printing and Device Modes,
5876 HREF="http://msdn.microsoft.com/"
5878 >MSDN documentation</A
5884 >default devmode = no</B
5889 NAME="DEFAULTSERVICE"
5891 >>default service (G)</DT
5894 >This parameter specifies the name of a service
5895 which will be connected to if the service actually requested cannot
5896 be found. Note that the square brackets are <SPAN
5903 given in the parameter value (see example below).</P
5905 >There is no default value for this parameter. If this
5906 parameter is not given, attempting to connect to a nonexistent
5907 service results in an error.</P
5909 >Typically the default service would be a <A
5923 >Also note that the apparent service name will be changed
5924 to equal that of the requested service, this is very useful as it
5925 allows you to use macros like <VAR
5929 a wildcard service.</P
5931 >Note also that any "_" characters in the name of the service
5932 used in the default service will get mapped to a "/". This allows for
5933 interesting things.</P
5938 CLASS="PROGRAMLISTING"
5940 default service = pub
5948 NAME="DELETEGROUPSCRIPT"
5950 >>delete group script (G)</DT
5953 >This is the full pathname to a script that will
5961 CLASS="CITEREFENTRY"
5963 CLASS="REFENTRYTITLE"
5966 > when a group is requested to be deleted.
5967 It will expand any <VAR
5970 > to the group name passed.
5971 This script is only useful for installations using the Windows NT domain administration tools.
5976 NAME="DELETEPRINTERCOMMAND"
5978 >>deleteprinter command (G)</DT
5981 >With the introduction of MS-RPC based printer
5982 support for Windows NT/2000 clients in Samba 2.2, it is now
5983 possible to delete printer at run time by issuing the
5984 DeletePrinter() RPC call.</P
5986 >For a Samba host this means that the printer must be
5987 physically deleted from underlying printing system. The <VAR
5989 > deleteprinter command</VAR
5990 > defines a script to be run which
5991 will perform the necessary operations for removing the printer
5992 from the print system and from <TT
6000 >deleteprinter command</VAR
6002 automatically called with only one parameter: <VAR
6004 > "printer name"</VAR
6009 >deleteprinter command</VAR
6014 > will reparse the <TT
6017 > to associated printer no longer exists.
6018 If the sharename is still valid, then <B
6022 > will return an ACCESS_DENIED error to the client.</P
6025 HREF="#ADDPRINTERCOMMAND"
6028 > addprinter command</VAR
6038 HREF="#SHOWADDPRINTERWIZARD"
6056 >deleteprinter command = /usr/bin/removeprinter
6062 NAME="DELETEREADONLY"
6064 >>delete readonly (S)</DT
6067 >This parameter allows readonly files to be deleted.
6068 This is not normal DOS semantics, but is allowed by UNIX.</P
6070 >This option may be useful for running applications such
6071 as rcs, where UNIX file ownership prevents changing file
6072 permissions, and DOS semantics prevent deletion of a read only file.</P
6076 >delete readonly = no</B
6081 NAME="DELETESHARECOMMAND"
6083 >>delete share command (G)</DT
6086 >Samba 2.2.0 introduced the ability to dynamically
6087 add and delete shares via the Windows NT 4.0 Server Manager. The
6090 >delete share command</VAR
6091 > is used to define an
6092 external program or script which will remove an existing service
6096 >. In order to successfully
6099 >delete share command</VAR
6104 requires that the administrator be connected using a root account (i.e.
6111 > will automatically invoke the
6114 >delete share command</VAR
6115 > with two parameters.
6138 the existing service.
6143 > This parameter is only used to remove file shares. To delete printer shares,
6145 HREF="#DELETEPRINTERCOMMAND"
6155 HREF="#ADDSHARECOMMAND"
6162 HREF="#CHANGESHARECOMMAND"
6181 >delete share command = /usr/local/bin/delshare</B
6186 NAME="DELETEUSERSCRIPT"
6188 >>delete user script (G)</DT
6191 >This is the full pathname to a script that will
6193 CLASS="CITEREFENTRY"
6195 CLASS="REFENTRYTITLE"
6198 > when managing users
6199 with remote RPC (NT) tools.
6202 >This script is called when a remote client removes a user
6203 from the server, normally using 'User Manager for Domains' or
6210 >This script should delete the given UNIX username.
6215 >delete user script = <empty string>
6221 >delete user script = /usr/local/samba/bin/del_user
6227 NAME="DELETEUSERFROMGROUPSCRIPT"
6229 >>delete user from group script (G)</DT
6232 >Full path to the script that will be called when
6233 a user is removed from a group using the Windows NT domain administration
6234 tools. It will be run by <SPAN
6235 CLASS="CITEREFENTRY"
6237 CLASS="REFENTRYTITLE"
6250 > will be replaced with the group name and
6254 > will be replaced with the user name.
6259 >delete user from group script = </B
6264 >delete user from group script = /usr/sbin/deluser %u %g</B
6269 NAME="DELETEVETOFILES"
6271 >>delete veto files (S)</DT
6274 >This option is used when Samba is attempting to
6275 delete a directory that contains one or more vetoed directories
6283 option). If this option is set to <CODE
6286 > (the default) then if a vetoed
6287 directory contains any non-vetoed files or directories then the
6288 directory delete will fail. This is usually what you want.</P
6290 >If this option is set to <CODE
6294 will attempt to recursively delete any files and directories within
6295 the vetoed directory. This can be useful for integration with file
6296 serving systems such as NetAtalk which create meta-files within
6297 directories you might normally veto DOS/Windows users from seeing
6305 >delete veto files = yes</B
6307 directories to be transparently deleted when the parent directory
6308 is deleted (so long as the user has permissions to do so).</P
6321 >delete veto files = no</B
6328 >>deny hosts (S)</DT
6344 >>dfree command (G)</DT
6351 only be used on systems where a problem occurs with the internal
6352 disk space calculations. This has been known to happen with Ultrix,
6353 but may occur with other operating systems. The symptom that was
6354 seen was an error of "Abort Retry Ignore" at the end of each
6355 directory listing.</P
6357 >This setting allows the replacement of the internal routines to
6358 calculate the total disk space and amount available with an external
6359 routine. The example below gives a possible script that might fulfill
6362 >The external program will be passed a single parameter indicating
6363 a directory in the filesystem being queried. This will typically consist
6367 >. The script should return two
6368 integers in ASCII. The first should be the total disk space in blocks,
6369 and the second should be the number of available blocks. An optional
6370 third return value can give the block size in bytes. The default
6371 blocksize is 1024 bytes.</P
6373 >Note: Your script should <SPAN
6380 setgid and should be owned by (and writeable only by) root!</P
6386 >By default internal routines for
6387 determining the disk capacity and remaining space will be used.
6394 >dfree command = /usr/local/samba/bin/dfree
6398 >Where the script dfree (which must be made executable) could be:</P
6401 CLASS="PROGRAMLISTING"
6404 df $1 | tail -1 | awk '{print $2" "$4}'</PRE
6407 >or perhaps (on Sys V based systems):</P
6410 CLASS="PROGRAMLISTING"
6413 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'</PRE
6416 >Note that you may have to replace the command names
6417 with full path names on some systems.</P
6423 >>directory (S)</DT
6437 NAME="DIRECTORYMASK"
6439 >>directory mask (S)</DT
6442 >This parameter is the octal modes which are
6443 used when converting DOS modes to UNIX modes when creating UNIX
6446 >When a directory is created, the necessary permissions are
6447 calculated according to the mapping from DOS modes to UNIX permissions,
6448 and the resulting UNIX mode is then bit-wise 'AND'ed with this
6449 parameter. This parameter may be thought of as a bit-wise MASK for
6450 the UNIX modes of a directory. Any bit <SPAN
6457 here will be removed from the modes set on a directory when it is
6460 >The default value of this parameter removes the 'group'
6461 and 'other' write bits from the UNIX mode, allowing only the
6462 user who owns the directory to modify it.</P
6464 >Following this Samba will bit-wise 'OR' the UNIX mode
6465 created from this parameter with the value of the <A
6466 HREF="#FORCEDIRECTORYMODE"
6469 >force directory mode
6472 > parameter. This parameter is set to 000 by
6473 default (i.e. no extra mode bits are added).</P
6475 >Note that this parameter does not apply to permissions
6476 set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
6477 a mask on access control lists also, they need to set the <A
6478 HREF="#DIRECTORYSECURITYMASK"
6481 >directory security mask</VAR
6486 HREF="#FORCEDIRECTORYMODE"
6492 > parameter to cause particular mode
6493 bits to always be set on created directories.</P
6502 > parameter for masking mode bits on created files,
6504 HREF="#DIRECTORYSECURITYMASK"
6512 >Also refer to the <A
6513 HREF="#INHERITPERMISSIONS"
6516 > inherit permissions</VAR
6522 >directory mask = 0755</B
6527 >directory mask = 0775</B
6532 NAME="DIRECTORYMODE"
6534 >>directory mode (S)</DT
6538 HREF="#DIRECTORYMASK"
6541 > directory mask</VAR
6547 NAME="DIRECTORYSECURITYMASK"
6549 >>directory security mask (S)</DT
6552 >This parameter controls what UNIX permission bits
6553 can be modified when a Windows NT client is manipulating the UNIX
6554 permission on a directory using the native NT security dialog
6557 >This parameter is applied as a mask (AND'ed with) to
6558 the changed permission bits, thus preventing any bits not in
6559 this mask from being modified. Essentially, zero bits in this
6560 mask may be treated as a set of bits the user is not allowed
6563 >If not set explicitly this parameter is set to 0777
6564 meaning a user is allowed to modify all the user/group/world
6565 permissions on a directory.</P
6573 > that users who can access the
6574 Samba server through other means can easily bypass this restriction,
6575 so it is primarily useful for standalone "appliance" systems.
6576 Administrators of most normal systems will probably want to leave
6577 it as the default of <CODE
6583 HREF="#FORCEDIRECTORYSECURITYMODE"
6586 > force directory security mode</VAR
6589 HREF="#SECURITYMASK"
6596 HREF="#FORCESECURITYMODE"
6599 >force security mode
6606 >directory security mask = 0777</B
6611 >directory security mask = 0700</B
6616 NAME="DISABLENETBIOS"
6618 >>disable netbios (G)</DT
6621 >Enabling this parameter will disable netbios support
6622 in Samba. Netbios is the only available form of browsing in
6623 all windows versions except for 2000 and XP. </P
6625 >Note that clients that only support netbios won't be able to
6626 see your samba server when netbios support is disabled.
6631 >disable netbios = no</B
6636 >disable netbios = yes</B
6641 NAME="DISABLESPOOLSS"
6643 >>disable spoolss (G)</DT
6646 >Enabling this parameter will disable Samba's support
6647 for the SPOOLSS set of MS-RPC's and will yield identical behavior
6648 as Samba 2.0.x. Windows NT/2000 clients will downgrade to using
6649 Lanman style printing commands. Windows 9x/ME will be uneffected by
6650 the parameter. However, this will also disable the ability to upload
6651 printer drivers to a Samba server via the Windows NT Add Printer
6652 Wizard or by using the NT printer properties dialog window. It will
6653 also disable the capability of Windows NT/2000 clients to download
6654 print drivers from the Samba host upon demand.
6659 >Be very careful about enabling this parameter.</I
6665 HREF="#USECLIENTDRIVER"
6666 >use client driver</A
6672 >disable spoolss = no</B
6677 NAME="DISPLAYCHARSET"
6679 >>display charset (G)</DT
6682 >Specifies the charset that samba will use
6683 to print messages to stdout and stderr and SWAT will use.
6684 Should generally be the same as the <B
6692 >display charset = ASCII</B
6697 >display charset = UTF8</B
6704 >>dns proxy (G)</DT
6707 >Specifies that <SPAN
6708 CLASS="CITEREFENTRY"
6710 CLASS="REFENTRYTITLE"
6713 > when acting as a WINS server and
6714 finding that a NetBIOS name has not been registered, should treat the
6715 NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server
6716 for that name on behalf of the name-querying client.</P
6718 >Note that the maximum length for a NetBIOS name is 15
6719 characters, so the DNS name (or DNS alias) can likewise only be
6720 15 characters, maximum.</P
6725 > spawns a second copy of itself to do the
6726 DNS name lookup requests, as doing a name lookup is a blocking
6729 >See also the parameter <A
6746 >>domain logons (G)</DT
6752 >, the Samba server will serve
6753 Windows 95/98 Domain logons for the <A
6759 > it is in. Samba 2.2
6760 has limited capability to act as a domain controller for Windows
6761 NT 4 Domains. For more details on setting up this feature see
6762 the Samba-PDC-HOWTO included in the <TT
6766 directory shipped with the source code.</P
6770 >domain logons = no</B
6777 >>domain master (G)</DT
6781 CLASS="CITEREFENTRY"
6783 CLASS="REFENTRYTITLE"
6786 > to enable WAN-wide browse list
6787 collation. Setting this option causes <B
6791 claim a special domain specific NetBIOS name that identifies
6792 it as a domain master browser for its given <A
6798 >. Local master browsers
6802 > on broadcast-isolated
6803 subnets will give this <B
6806 > their local browse lists,
6808 CLASS="CITEREFENTRY"
6810 CLASS="REFENTRYTITLE"
6813 > for a complete copy of the browse
6814 list for the whole wide area network. Browser clients will then contact
6815 their local master browser, and will receive the domain-wide browse list,
6816 instead of just the list for their broadcast-isolated subnet.</P
6818 >Note that Windows NT Primary Domain Controllers expect to be
6819 able to claim this <VAR
6823 NetBIOS name that identifies them as domain master browsers for
6827 > by default (i.e. there is no
6828 way to prevent a Windows NT PDC from attempting to do this). This
6829 means that if this parameter is set and <B
6833 the special name for a <VAR
6837 NT PDC is able to do so then cross subnet browsing will behave
6838 strangely and may fail.</P
6841 HREF="#DOMAINLOGONS"
6844 >domain logons = yes</B
6847 >, then the default behavior is to enable the <VAR
6851 > parameter. If <VAR
6855 not enabled (the default setting), then neither will <VAR
6859 > be enabled by default.</P
6863 >domain master = auto</B
6870 >>dont descend (S)</DT
6873 >There are certain directories on some systems
6877 > tree under Linux) that are either not
6878 of interest to clients or are infinitely deep (recursive). This
6879 parameter allows you to specify a comma-delimited list of directories
6880 that the server should always show as empty.</P
6882 >Note that Samba can be very fussy about the exact format
6883 of the "dont descend" entries. For example you may need <TT
6886 > instead of just <TT
6890 Experimentation is the best policy :-) </P
6896 >none (i.e., all directories are OK
6903 >dont descend = /proc,/dev</B
6910 >>dos charset (G)</DT
6913 >DOS SMB clients assume the server has
6914 the same charset as they do. This option specifies which
6915 charset Samba should talk to DOS clients.
6918 >The default depends on which charsets you have instaled.
6919 Samba tries to use charset 850 but falls back to ASCII in
6920 case it is not available. Run <SPAN
6921 CLASS="CITEREFENTRY"
6923 CLASS="REFENTRYTITLE"
6926 > to check the default on your system.
6933 >>dos filemode (S)</DT
6936 > The default behavior in Samba is to provide
6937 UNIX-like behavior where only the owner of a file/directory is
6938 able to change the permissions on it. However, this behavior
6939 is often confusing to DOS/Windows users. Enabling this parameter
6940 allows a user who has write access to the file (by whatever
6941 means) to modify the permissions on it. Note that a user
6942 belonging to the group owning the file will not be allowed to
6943 change permissions if the group is only granted read access.
6944 Ownership of the file/directory is not changed, only the permissions
6949 >dos filemode = no</B
6954 NAME="DOSFILETIMERESOLUTION"
6956 >>dos filetime resolution (S)</DT
6959 >Under the DOS and Windows FAT filesystem, the finest
6960 granularity on time resolution is two seconds. Setting this parameter
6961 for a share causes Samba to round the reported time down to the
6962 nearest two second boundary when a query call that requires one second
6963 resolution is made to <SPAN
6964 CLASS="CITEREFENTRY"
6966 CLASS="REFENTRYTITLE"
6971 >This option is mainly used as a compatibility option for Visual
6972 C++ when used against Samba shares. If oplocks are enabled on a
6973 share, Visual C++ uses two different time reading calls to check if a
6974 file has changed since it was last read. One of these calls uses a
6975 one-second granularity, the other uses a two second granularity. As
6976 the two second call rounds any odd second down, then if the file has a
6977 timestamp of an odd number of seconds then the two timestamps will not
6978 match and Visual C++ will keep reporting the file has changed. Setting
6979 this option causes the two timestamps to match, and Visual C++ is
6984 >dos filetime resolution = no</B
6991 >>dos filetimes (S)</DT
6994 >Under DOS and Windows, if a user can write to a
6995 file they can change the timestamp on it. Under POSIX semantics,
6996 only the owner of the file or root may change the timestamp. By
6997 default, Samba runs with POSIX semantics and refuses to change the
6998 timestamp on a file if the user <B
7002 on behalf of is not the file owner. Setting this option to <CODE
7005 > allows DOS semantics and <SPAN
7006 CLASS="CITEREFENTRY"
7008 CLASS="REFENTRYTITLE"
7011 > will change the file
7012 timestamp as DOS requires.</P
7016 >dos filetimes = no</B
7021 NAME="ENCRYPTPASSWORDS"
7023 >>encrypt passwords (G)</DT
7026 >This boolean controls whether encrypted passwords
7027 will be negotiated with the client. Note that Windows NT 4.0 SP3 and
7028 above and also Windows 98 will by default expect encrypted passwords
7029 unless a registry entry is changed. To use encrypted passwords in
7030 Samba see the file ENCRYPTION.txt in the Samba documentation
7034 > shipped with the source code.</P
7036 >In order for encrypted passwords to work correctly
7038 CLASS="CITEREFENTRY"
7040 CLASS="REFENTRYTITLE"
7044 have access to a local <SPAN
7045 CLASS="CITEREFENTRY"
7047 CLASS="REFENTRYTITLE"
7050 > file (see the <SPAN
7051 CLASS="CITEREFENTRY"
7053 CLASS="REFENTRYTITLE"
7056 > program for information on how to set up
7057 and maintain this file), or set the <A
7059 >security = [server|domain|ads]</A
7064 > to authenticate against another
7069 >encrypt passwords = yes</B
7074 NAME="ENHANCEDBROWSING"
7076 >>enhanced browsing (G)</DT
7079 >This option enables a couple of enhancements to
7080 cross-subnet browse propagation that have been added in Samba
7081 but which are not standard in Microsoft implementations.
7084 >The first enhancement to browse propagation consists of a regular
7085 wildcard query to a Samba WINS server for all Domain Master Browsers,
7086 followed by a browse synchronization with each of the returned
7087 DMBs. The second enhancement consists of a regular randomised browse
7088 synchronization with all currently known DMBs.</P
7090 >You may wish to disable this option if you have a problem with empty
7091 workgroups not disappearing from browse lists. Due to the restrictions
7092 of the browse protocols these enhancements can cause a empty workgroup
7093 to stay around forever which can be annoying.</P
7095 >In general you should leave this option enabled as it makes
7096 cross-subnet browse propagation much more reliable.</P
7100 >enhanced browsing = yes</B
7105 NAME="ENUMPORTSCOMMAND"
7107 >>enumports command (G)</DT
7110 >The concept of a "port" is fairly foreign
7111 to UNIX hosts. Under Windows NT/2000 print servers, a port
7112 is associated with a port monitor and generally takes the form of
7113 a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
7114 (i.e. LPD Port Monitor, etc...). By default, Samba has only one
7117 >"Samba Printer Port"</CODE
7119 Windows NT/2000, all printers must have a valid port name.
7120 If you wish to have a list of ports displayed (<B
7124 > does not use a port name for anything) other than
7127 >"Samba Printer Port"</CODE
7131 >enumports command</VAR
7133 a program which should generate a list of ports, one per line,
7134 to standard output. This listing will then be used in response
7135 to the level 1 and 2 EnumPorts() RPC.</P
7141 >no enumports command</I
7147 >enumports command = /usr/bin/listports
7158 >This is a synonym for <A
7168 NAME="FAKEDIRECTORYCREATETIMES"
7170 >>fake directory create times (S)</DT
7173 >NTFS and Windows VFAT file systems keep a create
7174 time for all files and directories. This is not the same as the
7175 ctime - status change time - that Unix keeps, so Samba by default
7176 reports the earliest of the various times Unix does keep. Setting
7177 this parameter for a share causes Samba to always report midnight
7178 1-1-1980 as the create time for directories.</P
7180 >This option is mainly used as a compatibility option for
7181 Visual C++ when used against Samba shares. Visual C++ generated
7182 makefiles have the object directory as a dependency for each object
7183 file, and a make rule to create the directory. Also, when NMAKE
7184 compares timestamps it uses the creation time when examining a
7185 directory. Thus the object directory will be created if it does not
7186 exist, but once it does exist it will always have an earlier
7187 timestamp than the object files it contains.</P
7189 >However, Unix time semantics mean that the create time
7190 reported by Samba will be updated whenever a file is created or
7191 or deleted in the directory. NMAKE finds all object files in
7192 the object directory. The timestamp of the last one built is then
7193 compared to the timestamp of the object directory. If the
7194 directory's timestamp if newer, then all object files
7195 will be rebuilt. Enabling this option
7196 ensures directories always predate their contents and an NMAKE build
7197 will proceed as expected.</P
7201 >fake directory create times = no</B
7208 >>fake oplocks (S)</DT
7211 >Oplocks are the way that SMB clients get permission
7212 from a server to locally cache file operations. If a server grants
7213 an oplock (opportunistic lock) then the client is free to assume
7214 that it is the only one accessing the file and it will aggressively
7215 cache file data. With some oplock types the client may even cache
7216 file open/close operations. This can give enormous performance benefits.
7221 >fake oplocks = yes</B
7230 always grant oplock requests no matter how many clients are using
7233 >It is generally much better to use the real <A
7240 than this parameter.</P
7242 >If you enable this option on all read-only shares or
7243 shares that you know will only be accessed from one client at a
7244 time such as physically read-only media like CDROMs, you will see
7245 a big performance improvement on many operations. If you enable
7246 this option on shares where multiple clients may be accessing the
7247 files read-write at the same time you can get data corruption. Use
7248 this option carefully!</P
7252 >fake oplocks = no</B
7257 NAME="FOLLOWSYMLINKS"
7259 >>follow symlinks (S)</DT
7262 >This parameter allows the Samba administrator
7264 CLASS="CITEREFENTRY"
7266 CLASS="REFENTRYTITLE"
7269 > from following symbolic
7270 links in a particular share. Setting this
7274 > prevents any file or directory
7275 that is a symbolic link from being followed (the user will get an
7276 error). This option is very useful to stop users from adding a
7277 symbolic link to <TT
7281 directory for instance. However it will slow filename lookups
7284 >This option is enabled (i.e. <B
7288 follow symbolic links) by default.</P
7292 >follow symlinks = yes</B
7297 NAME="FORCECREATEMODE"
7299 >>force create mode (S)</DT
7302 >This parameter specifies a set of UNIX mode bit
7303 permissions that will <SPAN
7310 file created by Samba. This is done by bitwise 'OR'ing these bits onto
7311 the mode bits of a file that is being created or having its
7312 permissions changed. The default for this parameter is (in octal)
7313 000. The modes in this parameter are bitwise 'OR'ed onto the file
7314 mode after the mask set in the <VAR
7318 parameter is applied.</P
7320 >See also the parameter <A
7327 > for details on masking mode bits on files.</P
7330 HREF="#INHERITPERMISSIONS"
7340 >force create mode = 000</B
7345 >force create mode = 0755</B
7348 >would force all created files to have read and execute
7349 permissions set for 'group' and 'other' as well as the
7350 read/write/execute bits set for the 'user'.</P
7354 NAME="FORCEDIRECTORYMODE"
7356 >>force directory mode (S)</DT
7359 >This parameter specifies a set of UNIX mode bit
7360 permissions that will <SPAN
7366 > be set on a directory
7367 created by Samba. This is done by bitwise 'OR'ing these bits onto the
7368 mode bits of a directory that is being created. The default for this
7369 parameter is (in octal) 0000 which will not add any extra permission
7370 bits to a created directory. This operation is done after the mode
7371 mask in the parameter <VAR
7373 >directory mask</VAR
7377 >See also the parameter <A
7378 HREF="#DIRECTORYMASK"
7381 > directory mask</VAR
7383 > for details on masking mode bits
7384 on created directories.</P
7387 HREF="#INHERITPERMISSIONS"
7390 > inherit permissions</VAR
7396 >force directory mode = 000</B
7401 >force directory mode = 0755</B
7404 >would force all created directories to have read and execute
7405 permissions set for 'group' and 'other' as well as the
7406 read/write/execute bits set for the 'user'.</P
7410 NAME="FORCEDIRECTORYSECURITYMODE"
7412 >>force directory security mode (S)</DT
7415 >This parameter controls what UNIX permission bits
7416 can be modified when a Windows NT client is manipulating the UNIX
7417 permission on a directory using the native NT security dialog box.</P
7419 >This parameter is applied as a mask (OR'ed with) to the
7420 changed permission bits, thus forcing any bits in this mask that
7421 the user may have modified to be on. Essentially, one bits in this
7422 mask may be treated as a set of bits that, when modifying security
7423 on a directory, the user has always set to be 'on'.</P
7425 >If not set explicitly this parameter is 000, which
7426 allows a user to modify all the user/group/world permissions on a
7427 directory without restrictions.</P
7435 > that users who can access the
7436 Samba server through other means can easily bypass this restriction,
7437 so it is primarily useful for standalone "appliance" systems.
7438 Administrators of most normal systems will probably want to leave
7442 HREF="#DIRECTORYSECURITYMASK"
7445 > directory security mask</VAR
7448 HREF="#SECURITYMASK"
7455 HREF="#FORCESECURITYMODE"
7458 >force security mode
7465 >force directory security mode = 0</B
7470 >force directory security mode = 700</B
7477 >>force group (S)</DT
7480 >This specifies a UNIX group name that will be
7481 assigned as the default primary group for all users connecting
7482 to this service. This is useful for sharing files by ensuring
7483 that all access to files on service will use the named group for
7484 their permissions checking. Thus, by assigning permissions for this
7485 group to the files and directories within this service the Samba
7486 administrator can restrict or allow sharing of these files.</P
7488 >In Samba 2.0.5 and above this parameter has extended
7489 functionality in the following way. If the group name listed here
7490 has a '+' character prepended to it then the current user accessing
7491 the share only has the primary group default assigned to this group
7492 if they are already assigned as a member of that group. This allows
7493 an administrator to decide that only users who are already in a
7494 particular group will create files with group ownership set to that
7495 group. This gives a finer granularity of ownership assignment. For
7496 example, the setting <TT
7498 >force group = +sys</TT
7500 that only users who are already in group sys will have their default
7501 primary group assigned to sys when accessing this Samba share. All
7502 other users will retain their ordinary primary group.</P
7511 > parameter is also set the group specified in
7515 > will override the primary group
7540 >force group = agroup</B
7545 NAME="FORCESECURITYMODE"
7547 >>force security mode (S)</DT
7550 >This parameter controls what UNIX permission
7551 bits can be modified when a Windows NT client is manipulating
7552 the UNIX permission on a file using the native NT security dialog
7555 >This parameter is applied as a mask (OR'ed with) to the
7556 changed permission bits, thus forcing any bits in this mask that
7557 the user may have modified to be on. Essentially, one bits in this
7558 mask may be treated as a set of bits that, when modifying security
7559 on a file, the user has always set to be 'on'.</P
7561 >If not set explicitly this parameter is set to 0,
7562 and allows a user to modify all the user/group/world permissions on a file,
7563 with no restrictions.</P
7571 > that users who can access
7572 the Samba server through other means can easily bypass this restriction,
7573 so it is primarily useful for standalone "appliance" systems.
7574 Administrators of most normal systems will probably want to leave
7575 this set to 0000.</P
7578 HREF="#FORCEDIRECTORYSECURITYMODE"
7581 > force directory security mode</VAR
7585 HREF="#DIRECTORYSECURITYMASK"
7592 HREF="#SECURITYMASK"
7595 > security mask</VAR
7601 >force security mode = 0</B
7606 >force security mode = 700</B
7613 >>force user (S)</DT
7616 >This specifies a UNIX user name that will be
7617 assigned as the default user for all users connecting to this service.
7618 This is useful for sharing files. You should also use it carefully
7619 as using it incorrectly can cause security problems.</P
7621 >This user name only gets used once a connection is established.
7622 Thus clients still need to connect as a valid user and supply a
7623 valid password. Once connected, all file operations will be performed
7624 as the "forced user", no matter what username the client connected
7625 as. This can be very useful.</P
7627 >In Samba 2.0.5 and above this parameter also causes the
7628 primary group of the forced user to be used as the primary group
7629 for all file activity. Prior to 2.0.5 the primary group was left
7630 as the primary group of the connecting user (this was a bug).</P
7651 >force user = auser</B
7658 >>fstype (S)</DT
7661 >This parameter allows the administrator to
7662 configure the string that specifies the type of filesystem a share
7663 is using that is reported by <SPAN
7664 CLASS="CITEREFENTRY"
7666 CLASS="REFENTRYTITLE"
7669 > when a client queries the filesystem type
7670 for a share. The default type is <CODE
7674 compatibility with Windows NT but this can be changed to other
7675 strings such as <CODE
7698 >>getwd cache (G)</DT
7701 >This is a tuning option. When this is enabled a
7702 caching algorithm will be used to reduce the time taken for getwd()
7703 calls. This can have a significant impact on performance, especially
7711 >parameter is set to <CODE
7718 >getwd cache = yes</B
7741 >>guest account (S)</DT
7744 >This is a username which will be used for access
7745 to services which are specified as <A
7751 > (see below). Whatever privileges this
7752 user has will be available to any client connecting to the guest service.
7753 Typically this user will exist in the password file, but will not
7754 have a valid login. The user account "ftp" is often a good choice
7755 for this parameter. If a username is specified in a given service,
7756 the specified username overrides this one.</P
7758 >One some systems the default guest account "nobody" may not
7759 be able to print. Use another account in this case. You should test
7760 this by trying to log in as your guest user (perhaps by using the
7764 > command) and trying to print using the
7765 system print command such as <B
7773 >This parameter does not accept % macros, because
7774 many parts of the system require this value to be
7775 constant for correct operation.</P
7781 >specified at compile time, usually
7788 >guest account = ftp</B
7795 >>guest ok (S)</DT
7798 >If this parameter is <CODE
7802 a service, then no password is required to connect to the service.
7803 Privileges will be those of the <A
7804 HREF="#GUESTACCOUNT"
7807 > guest account</VAR
7811 >This paramater nullifies the benifits of setting
7813 HREF="#RESTRICTANONYMOUS"
7821 >See the section below on <A
7827 > for more information about this option.
7839 >>guest only (S)</DT
7842 >If this parameter is <CODE
7846 a service, then only guest connections to the service are permitted.
7847 This parameter will have no effect if <A
7853 > is not set for the service.</P
7855 >See the section below on <A
7861 > for more information about this option.
7873 >>hide dot files (S)</DT
7876 >This is a boolean parameter that controls whether
7877 files starting with a dot appear as hidden files.</P
7881 >hide dot files = yes</B
7888 >>hide files(S)</DT
7891 >This is a list of files or directories that are not
7892 visible but are accessible. The DOS 'hidden' attribute is applied
7893 to any files or directories that match.</P
7895 >Each entry in the list must be separated by a '/',
7896 which allows spaces to be included in the entry. '*'
7897 and '?' can be used to specify multiple files or directories
7898 as in DOS wildcards.</P
7900 >Each entry must be a Unix path, not a DOS path and must
7901 not include the Unix directory separator '/'.</P
7903 >Note that the case sensitivity option is applicable
7906 >Setting this parameter will affect the performance of Samba,
7907 as it will be forced to check all files and directories for a match
7908 as they are scanned.</P
7911 HREF="#HIDEDOTFILES"
7924 HREF="#CASESENSITIVE"
7927 >case sensitive</VAR
7935 >no file are hidden</I
7942 /.*/DesktopFolderDB/TrashFor%m/resource.frk/</B
7945 >The above example is based on files that the Macintosh
7946 SMB client (DAVE) available from <A
7947 HREF="http://www.thursby.com"
7951 > creates for internal use, and also still hides
7952 all files beginning with a dot.</P
7956 NAME="HIDELOCALUSERS"
7958 >>hide local users(G)</DT
7961 >This parameter toggles the hiding of local UNIX
7962 users (root, wheel, floppy, etc) from remote clients.</P
7966 >hide local users = no</B
7971 NAME="HIDEUNREADABLE"
7973 >>hide unreadable (G)</DT
7976 >This parameter prevents clients from seeing the
7977 existance of files that cannot be read. Defaults to off.</P
7981 >hide unreadable = no</B
7986 NAME="HIDEUNWRITEABLEFILES"
7988 >>hide unwriteable files (G)</DT
7991 >This parameter prevents clients from seeing
7992 the existance of files that cannot be written to. Defaults to off.
7993 Note that unwriteable directories are shown as usual.
7998 >hide unwriteable = no</B
8003 NAME="HIDESPECIALFILES"
8005 >>hide special files (G)</DT
8008 >This parameter prevents clients from seeing
8009 special files such as sockets, devices and fifo's in directory
8015 >hide special files = no</B
8022 >>homedir map (G)</DT
8036 CLASS="CITEREFENTRY"
8038 CLASS="REFENTRYTITLE"
8045 > then this parameter
8046 specifies the NIS (or YP) map from which the server for the user's
8047 home directory should be extracted. At present, only the Sun
8048 auto.home map format is understood. The form of the map is:</P
8052 >username server:/some/file/system</B
8055 >and the program will extract the servername from before
8056 the first ':'. There should probably be a better parsing system
8057 that copes with different map formats and also Amd (another
8058 automounter) maps.</P
8066 >A working NIS client is required on
8067 the system for this option to work.</P
8077 HREF="#DOMAINLOGONS"
8087 >homedir map = <empty string></B
8092 >homedir map = amd.homedir</B
8099 >>host msdfs (G)</DT
8102 >This boolean parameter is only available
8103 if Samba has been configured and compiled with the <B
8106 > option. If set to <CODE
8110 Samba will act as a Dfs server, and allow Dfs-aware clients
8111 to browse Dfs trees hosted on the server.</P
8119 > share level parameter. For
8120 more information on setting up a Dfs tree on Samba,
8122 HREF="msdfs_setup.html"
8124 >msdfs_setup.html</A
8135 NAME="HOSTNAMELOOKUPS"
8137 >>hostname lookups (G)</DT
8140 >Specifies whether samba should use (expensive)
8141 hostname lookups or use the ip addresses instead. An example place
8142 where hostname lookups are currently used is when checking
8154 >hostname lookups = yes</B
8159 >hostname lookups = no</B
8166 >>hosts allow (S)</DT
8169 >A synonym for this parameter is <VAR
8175 >This parameter is a comma, space, or tab delimited
8176 set of hosts which are permitted to access a service.</P
8178 >If specified in the [global] section then it will
8179 apply to all services, regardless of whether the individual
8180 service has a different setting.</P
8182 >You can specify the hosts by name or IP number. For
8183 example, you could restrict access to only the hosts on a
8184 Class C subnet with something like <B
8186 >allow hosts = 150.203.5.
8188 >. The full syntax of the list is described in the man
8191 >hosts_access(5)</TT
8192 >. Note that this man
8193 page may not be present on your system, so a brief description will
8194 be given here also.</P
8196 >Note that the localhost address 127.0.0.1 will always
8197 be allowed access unless specifically denied by a <A
8205 >You can also specify hosts by network/netmask pairs and
8206 by netgroup names if your system supports netgroups. The
8213 > keyword can also be used to limit a
8214 wildcard list. The following examples may provide some help:</P
8216 >Example 1: allow all IPs in 150.203.*.*; except one</P
8220 >hosts allow = 150.203. EXCEPT 150.203.6.66</B
8223 >Example 2: allow hosts that match the given network/netmask</P
8227 >hosts allow = 150.203.15.0/255.255.255.0</B
8230 >Example 3: allow a couple of hosts</P
8234 >hosts allow = lapland, arvidsjaur</B
8237 >Example 4: allow only hosts in NIS netgroup "foonet", but
8238 deny access from one particular host</P
8242 >hosts allow = @foonet</B
8247 >hosts deny = pirate</B
8250 >Note that access still requires suitable user-level passwords.</P
8253 CLASS="CITEREFENTRY"
8255 CLASS="REFENTRYTITLE"
8258 > for a way of testing your host access
8259 to see if it does what you expect.</P
8265 >none (i.e., all hosts permitted access)
8272 >allow hosts = 150.203.5. myhost.mynet.edu.au
8280 >>hosts deny (S)</DT
8283 >The opposite of <VAR
8287 - hosts listed here are <SPAN
8293 > permitted access to
8294 services unless the specific services have their own lists to override
8295 this one. Where the lists conflict, the <VAR
8299 list takes precedence.</P
8305 >none (i.e., no hosts specifically excluded)
8312 >hosts deny = 150.203.4. badhost.mynet.edu.au
8320 >>hosts equiv (G)</DT
8323 >If this global parameter is a non-null string,
8324 it specifies the name of a file to read for the names of hosts
8325 and users who will be allowed access without specifying a password.
8328 >This is not be confused with <A
8334 > which is about hosts
8335 access to services and is more useful for guest services. <VAR
8338 > may be useful for NT clients which will
8339 not supply passwords to Samba.</P
8351 > can be a major security hole. This is because you are
8352 trusting the PC to supply the correct username. It is very easy to
8353 get a PC to supply a false username. I recommend that the
8357 > option be only used if you really
8358 know what you are doing, or perhaps on a home network where you trust
8359 your spouse and kids. And only if you <SPAN
8372 >no host equivalences</I
8378 >hosts equiv = /etc/hosts.equiv</B
8385 >>include (G)</DT
8388 >This allows you to include one config file
8389 inside another. The file is included literally, as though typed
8392 >It takes the standard substitutions, except <VAR
8409 >no file included</I
8415 >include = /usr/local/samba/lib/admin_smb.conf
8423 >>inherit acls (S)</DT
8426 >This parameter can be used to ensure
8427 that if default acls exist on parent directories,
8428 they are always honored when creating a subdirectory.
8429 The default behavior is to use the mode specified
8430 when creating the directory. Enabling this option
8431 sets the mode to 0777, thus guaranteeing that
8432 default directory acls are propagated.
8437 >inherit acls = no</B
8443 NAME="INHERITPERMISSIONS"
8445 >>inherit permissions (S)</DT
8448 >The permissions on new files and directories
8449 are normally governed by <A
8456 HREF="#DIRECTORYMASK"
8459 >directory mask</VAR
8462 HREF="#FORCECREATEMODE"
8465 >force create mode</VAR
8469 HREF="#FORCEDIRECTORYMODE"
8475 > but the boolean inherit
8476 permissions parameter overrides this.</P
8478 >New directories inherit the mode of the parent directory,
8479 including bits such as setgid.</P
8481 >New files inherit their read/write bits from the parent
8482 directory. Their execute bits continue to be determined by
8506 >Note that the setuid bit is <SPAN
8513 inheritance (the code explicitly prohibits this).</P
8515 >This can be particularly useful on large systems with
8516 many users, perhaps several thousand, to allow a single [homes]
8517 share to be used flexibly by each user.</P
8527 HREF="#DIRECTORYMASK"
8530 > directory mask</VAR
8533 HREF="#FORCECREATEMODE"
8536 >force create mode</VAR
8539 HREF="#FORCEDIRECTORYMODE"
8542 >force directory mode</VAR
8549 >inherit permissions = no</B
8556 >>interfaces (G)</DT
8559 >This option allows you to override the default
8560 network interfaces list that Samba will use for browsing, name
8561 registration and other NBT traffic. By default Samba will query
8562 the kernel for the list of all active interfaces and use any
8563 interfaces except 127.0.0.1 that are broadcast capable.</P
8565 >The option takes a list of interface strings. Each string
8566 can be in any of the following forms:</P
8572 >a network interface name (such as eth0).
8573 This may include shell-like wildcards so eth* will match
8574 any interface starting with the substring "eth"</P
8578 >an IP address. In this case the netmask is
8579 determined from the list of interfaces obtained from the
8584 >an IP/mask pair. </P
8588 >a broadcast/mask pair.</P
8592 >The "mask" parameters can either be a bit length (such
8593 as 24 for a C class network) or a full netmask in dotted
8596 >The "IP" parameters above can either be a full dotted
8597 decimal IP address or a hostname which will be looked up via
8598 the OS's normal hostname resolution mechanisms.</P
8600 >For example, the following line:</P
8604 >interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
8608 >would configure three network interfaces corresponding
8609 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
8610 The netmasks of the latter two interfaces would be set to 255.255.255.0.</P
8613 HREF="#BINDINTERFACESONLY"
8617 interfaces only</VAR
8625 >all active interfaces except 127.0.0.1
8626 that are broadcast capable</I
8634 >>invalid users (S)</DT
8637 >This is a list of users that should not be allowed
8638 to login to this service. This is really a <SPAN
8645 check to absolutely ensure an improper setting does not breach
8648 >A name starting with a '@' is interpreted as an NIS
8649 netgroup first (if your system supports NIS), and then as a UNIX
8650 group if the name was not found in the NIS netgroup database.</P
8652 >A name starting with '+' is interpreted only
8653 by looking in the UNIX group database. A name starting with
8654 '&' is interpreted only by looking in the NIS netgroup database
8655 (this requires NIS to be working on your system). The characters
8656 '+' and '&' may be used at the start of the name in either order
8661 UNIX group database, followed by the NIS netgroup database, and
8665 > means check the NIS
8666 netgroup database, followed by the UNIX group database (the
8667 same as the '@' prefix).</P
8669 >The current servicename is substituted for <VAR
8673 This is useful in the [homes] section.</P
8688 >no invalid users</I
8694 >invalid users = root fred admin @wheel
8702 >>keepalive (G)</DT
8705 >The value of the parameter (an integer) represents
8706 the number of seconds between <VAR
8710 packets. If this parameter is zero, no keepalive packets will be
8711 sent. Keepalive packets, if sent, allow the server to tell whether
8712 a client is still present and responding.</P
8714 >Keepalives should, in general, not be needed if the socket
8715 being used has the SO_KEEPALIVE attribute set on it (see <A
8716 HREF="#SOCKETOPTIONS"
8719 >socket options</VAR
8722 Basically you should only use this option if you strike difficulties.</P
8736 NAME="KERNELOPLOCKS"
8738 >>kernel oplocks (G)</DT
8741 >For UNIXes that support kernel based <A
8748 (currently only IRIX and the Linux 2.4 kernel), this parameter
8749 allows the use of them to be turned on or off.</P
8751 >Kernel oplocks support allows Samba <VAR
8755 > to be broken whenever a local UNIX process or NFS operation
8756 accesses a file that <SPAN
8757 CLASS="CITEREFENTRY"
8759 CLASS="REFENTRYTITLE"
8762 > has oplocked. This allows complete
8763 data consistency between SMB/CIFS, NFS and local file access (and is
8770 > cool feature :-).</P
8772 >This parameter defaults to <CODE
8775 >, but is translated
8776 to a no-op on systems that no not have the necessary kernel support.
8777 You should never need to touch this parameter.</P
8787 HREF="#LEVEL2OPLOCKS"
8797 >kernel oplocks = yes</B
8804 >>lanman auth (G)</DT
8807 >This parameter determines whether or not <SPAN
8808 CLASS="CITEREFENTRY"
8810 CLASS="REFENTRYTITLE"
8813 > will attempt to authenticate users
8814 using the LANMAN password hash. If disabled, only clients which support NT
8815 password hashes (e.g. Windows NT/2000 clients, smbclient, etc... but not
8816 Windows 95/98 or the MS DOS network client) will be able to connect to the Samba host.</P
8820 >lanman auth = yes</B
8825 NAME="LARGEREADWRITE"
8827 >>large readwrite (G)</DT
8830 >This parameter determines whether or not <SPAN
8831 CLASS="CITEREFENTRY"
8833 CLASS="REFENTRYTITLE"
8836 > supports the new 64k streaming
8837 read and write varient SMB requests introduced
8838 with Windows 2000. Note that due to Windows 2000 client redirector bugs
8839 this requires Samba to be running on a 64-bit capable operating system such
8840 as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with
8841 Windows 2000 clients. Defaults to on. Not as tested as some other Samba
8847 >large readwrite = yes</B
8854 >>ldap admin dn (G)</DT
8860 > defines the Distinguished
8861 Name (DN) name used by Samba to contact the ldap server when retreiving
8862 user account information. The <VAR
8866 > is used in conjunction with the admin dn password
8869 >private/secrets.tdb</TT
8872 CLASS="CITEREFENTRY"
8874 CLASS="REFENTRYTITLE"
8877 > man page for more information on how
8893 >>ldap filter (G)</DT
8896 >This parameter specifies the RFC 2254 compliant LDAP search filter.
8897 The default is to match the login name with the <CODE
8901 attribute for all entries matching the <CODE
8905 objectclass. Note that this filter should only return one entry.
8910 >ldap filter = (&(uid=%u)(objectclass=sambaAccount))</B
8917 >>ldap port (G)</DT
8920 >This parameter is only available if Samba has been
8921 configure to include the <B
8928 > This option is used to control the tcp port number used to contact
8936 The default is to use the stand LDAPS port 636.
8947 >ldap port = 636 ; if ldap ssl = on</B
8952 >ldap port = 389 ; if ldap ssl = off</B
8959 >>ldap server (G)</DT
8962 >This parameter is only available if Samba has been
8963 configure to include the <B
8970 > This parameter should contain the FQDN of the ldap directory
8971 server which should be queried to locate user account information.
8976 >ldap server = localhost</B
8983 >>ldap ssl (G)</DT
8986 >This option is used to define whether or not Samba should
8987 use SSL when connecting to the ldap server
8995 Samba's previous SSL support which was enabled by specifying the
9009 > can be set to one of three values:
9019 > = Never use SSL when querying the directory.</P
9026 > = Use the LDAPv3 StartTLS extended operation
9027 (RFC2830) for communicating with the directory server.</P
9035 Use SSL on the ldaps port when contacting the
9040 available when the backwards-compatiblity <B
9043 > option is specified
9044 to configure. See <A
9045 HREF="#PASSDBBACKEND"
9048 >passdb backend</VAR
9056 >ldap ssl = start_tls</B
9063 >>ldap suffix (G)</DT
9066 >Specifies where user and machine accounts are added to the tree. Can be overriden by <B
9068 >ldap user suffix</B
9071 >ldap machine suffix</B
9072 >. It also used as the base dn for all ldap searches. </P
9084 NAME="LDAPUSERSUFFIX"
9086 >>ldap user suffix (G)</DT
9089 >It specifies where users are added to the tree.
9102 NAME="LDAPMACHINESUFFIX"
9104 >>ldap machine suffix (G)</DT
9107 >It specifies where machines should be
9108 added to the ldap tree.
9121 NAME="LDAPPASSWDSYNC"
9123 >>ldap passwd sync (G)</DT
9126 >This option is used to define whether
9127 or not Samba should sync the LDAP password with the NT
9128 and LM hashes for normal accounts (NOT for
9129 workstation, server or domain trusts) on a password
9135 >ldap passwd sync</VAR
9136 > can be set to one of three values:
9146 > = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time.</P
9153 > = Update NT and LM passwords and update the pwdLastSet time.</P
9160 > = Only update the LDAP password and let the LDAP server do the rest.</P
9166 >ldap passwd sync = no</B
9173 >>ldap trust ids (G)</DT
9176 >Normally, Samba validates each entry
9177 in the LDAP server against getpwnam(). This allows
9178 LDAP to be used for Samba with the unix system using
9179 NIS (for example) and also ensures that Samba does not
9180 present accounts that do not otherwise exist. </P
9182 >This option is used to disable this functionality, and
9183 instead to rely on the presence of the appropriate
9184 attributes in LDAP directly, which can result in a
9185 significant performance boost in some situations.
9186 Setting this option to yes effectivly assumes
9187 that the local machine is running <B
9191 same LDAP server.</P
9195 >ldap trust ids = No</B
9200 NAME="LEVEL2OPLOCKS"
9202 >>level2 oplocks (S)</DT
9205 >This parameter controls whether Samba supports
9206 level2 (read-only) oplocks on a share.</P
9208 >Level2, or read-only oplocks allow Windows NT clients
9209 that have an oplock on a file to downgrade from a read-write oplock
9210 to a read-only oplock once a second client opens the file (instead
9211 of releasing all oplocks on a second open, as in traditional,
9212 exclusive oplocks). This allows all openers of the file that
9213 support level2 oplocks to cache the file for read-ahead only (ie.
9214 they may not cache writes or lock requests) and increases performance
9215 for many accesses of files that are not commonly written (such as
9216 application .EXE files).</P
9218 >Once one of the clients which have a read-only oplock
9219 writes to the file all clients are notified (no reply is needed
9220 or waited for) and told to break their oplocks to "none" and
9221 delete any read-ahead caches.</P
9223 >It is recommended that this parameter be turned on
9224 to speed access to shared executables.</P
9226 >For more discussions on level2 oplocks see the CIFS spec.</P
9229 HREF="#KERNELOPLOCKS"
9235 > are supported then level2 oplocks are
9236 not granted (even if this parameter is set to <CODE
9247 > parameter must be set to <CODE
9250 > on this share in order for
9251 this parameter to have any effect.</P
9264 >kernel oplocks</VAR
9271 >level2 oplocks = yes</B
9278 >>lm announce (G)</DT
9281 >This parameter determines if <SPAN
9282 CLASS="CITEREFENTRY"
9284 CLASS="REFENTRYTITLE"
9287 > will produce Lanman announce
9288 broadcasts that are needed by OS/2 clients in order for them to see
9289 the Samba server in their browse list. This parameter can have three
9300 >. The default is <CODE
9307 > Samba will never produce these
9308 broadcasts. If set to <CODE
9311 > Samba will produce
9312 Lanman announce broadcasts at a frequency set by the parameter
9320 Samba will not send Lanman announce broadcasts by default but will
9321 listen for them. If it hears such a broadcast on the wire it will
9322 then start sending them at a frequency set by the parameter
9339 >lm announce = auto</B
9344 >lm announce = yes</B
9351 >>lm interval (G)</DT
9354 >If Samba is set to produce Lanman announce
9355 broadcasts needed by OS/2 clients (see the <A
9361 > parameter) then this
9362 parameter defines the frequency in seconds with which they will be
9363 made. If this is set to zero then no Lanman announcements will be
9364 made despite the setting of the <VAR
9381 >lm interval = 60</B
9386 >lm interval = 120</B
9393 >>load printers (G)</DT
9396 >A boolean variable that controls whether all
9397 printers in the printcap will be loaded for browsing by default.
9406 >load printers = yes</B
9413 >>local master (G)</DT
9416 >This option allows <SPAN
9417 CLASS="CITEREFENTRY"
9419 CLASS="REFENTRYTITLE"
9422 > to try and become a local master browser
9423 on a subnet. If set to <CODE
9429 > will not attempt to become a local master browser
9430 on a subnet and will also lose in all browsing elections. By
9431 default this value is set to <CODE
9434 >. Setting this value to <CODE
9438 mean that Samba will <SPAN
9445 browser on a subnet, just that <B
9454 > in elections for local master browser.</P
9456 >Setting this value to <CODE
9469 > to become a local master browser.</P
9473 >local master = yes</B
9480 >>lock dir (G)</DT
9484 HREF="#LOCKDIRECTORY"
9487 > lock directory</VAR
9493 NAME="LOCKDIRECTORY"
9495 >>lock directory (G)</DT
9498 >This option specifies the directory where lock
9499 files will be placed. The lock files are used to implement the
9501 HREF="#MAXCONNECTIONS"
9504 >max connections</VAR
9511 >lock directory = ${prefix}/var/locks</B
9516 >lock directory = /var/run/samba/locks</B
9522 NAME="LOCKSPINCOUNT"
9524 >>lock spin count (G)</DT
9527 >This parameter controls the number of times
9528 that smbd should attempt to gain a byte range lock on the
9529 behalf of a client request. Experiments have shown that
9530 Windows 2k servers do not reply with a failure if the lock
9531 could not be immediately granted, but try a few more times
9532 in case the lock could later be aquired. This behavior
9533 is used to support PC database formats such as MS Access
9539 >lock spin count = 2</B
9547 >>lock spin time (G)</DT
9550 >The time in microseconds that smbd should
9551 pause before attempting to gain a failed lock. See
9553 HREF="#LOCKSPINCOUNT"
9564 >lock spin time = 10</B
9572 >>locking (S)</DT
9575 >This controls whether or not locking will be
9576 performed by the server in response to lock requests from the
9582 >, all lock and unlock
9583 requests will appear to succeed and all lock queries will report
9584 that the file in question is available for locking.</P
9589 >, real locking will be performed
9598 > be useful for read-only
9599 filesystems which <SPAN
9605 > not need locking (such as
9606 CDROM drives), although setting this parameter of <CODE
9610 is not really recommended even in this case.</P
9612 >Be careful about disabling locking either globally or in a
9613 specific service, as lack of locking may result in data corruption.
9614 You should never need to set this parameter.</P
9625 >>log file (G)</DT
9628 >This option allows you to override the name
9629 of the Samba log file (also known as the debug file).</P
9631 >This option takes the standard substitutions, allowing
9632 you to have separate log files for each user or machine.</P
9636 >log file = /usr/local/samba/var/log.%m
9644 >>log level (G)</DT
9647 >The value of the parameter (a astring) allows
9648 the debug level (logging level) to be specified in the
9652 > file. This parameter has been
9653 extended since the 2.2.x series, now it allow to specify the debug
9654 level for multiple debug classes. This is to give greater
9655 flexibility in the configuration of the system.</P
9657 >The default will be the log level specified on
9658 the command line or level zero if none was specified.</P
9662 >log level = 3 passdb:5 auth:10 winbind:2
9670 >>logon drive (G)</DT
9673 >This parameter specifies the local path to
9674 which the home directory will be connected (see <A
9681 and is only used by NT Workstations. </P
9683 >Note that this option is only useful if Samba is set up as a
9688 >logon drive = z:</B
9693 >logon drive = h:</B
9700 >>logon home (G)</DT
9703 >This parameter specifies the home directory
9704 location when a Win95/98 or NT Workstation logs into a Samba PDC.
9705 It allows you to do </P
9712 >NET USE H: /HOME</KBD
9716 >from a command prompt, for example.</P
9718 >This option takes the standard substitutions, allowing
9719 you to have separate logon scripts for each user or machine.</P
9721 >This parameter can be used with Win9X workstations to ensure
9722 that roaming profiles are stored in a subdirectory of the user's
9723 home directory. This is done in the following way:</P
9727 >logon home = \\%N\%U\profile</B
9730 >This tells Samba to return the above string, with
9731 substitutions made when a client requests the info, generally
9732 in a NetUserGetInfo request. Win9X clients truncate the info to
9733 \\server\share when a user does <B
9737 but use the whole string when dealing with profiles.</P
9739 >Note that in prior versions of Samba, the <A
9745 > was returned rather than
9753 > but allowed profiles outside the home directory.
9754 The current implementation is correct, and can be used for
9755 profiles if you use the above trick.</P
9757 >This option is only useful if Samba is set up as a logon
9762 >logon home = "\\%N\%U"</B
9767 >logon home = "\\remote_smb_server\%U"</B
9775 >>logon path (G)</DT
9778 >This parameter specifies the home directory
9779 where roaming profiles (NTuser.dat etc files for Windows NT) are
9780 stored. Contrary to previous versions of these manual pages, it has
9781 nothing to do with Win 9X roaming profiles. To find out how to
9782 handle roaming profiles for Win 9X system, see the <A
9790 >This option takes the standard substitutions, allowing you
9791 to have separate logon scripts for each user or machine. It also
9792 specifies the directory from which the "Application Data",
9802 >network neighborhood</TT
9807 and other folders, and their contents, are loaded and displayed on
9808 your Windows NT client.</P
9810 >The share and the path must be readable by the user for
9811 the preferences and directories to be loaded onto the Windows NT
9812 client. The share must be writeable when the user logs in for the first
9813 time, in order that the Windows NT client can create the NTuser.dat
9814 and other directories.</P
9816 >Thereafter, the directories and any of the contents can,
9817 if required, be made read-only. It is not advisable that the
9818 NTuser.dat file be made read-only - rename it to NTuser.man to
9819 achieve the desired effect (a <SPAN
9828 >Windows clients can sometimes maintain a connection to
9829 the [homes] share, even though there is no user logged in.
9830 Therefore, it is vital that the logon path does not include a
9831 reference to the homes share (i.e. setting this parameter to
9832 \%N\%U\profile_path will cause problems).</P
9834 >This option takes the standard substitutions, allowing
9835 you to have separate logon scripts for each user or machine.</P
9837 >Note that this option is only useful if Samba is set up
9838 as a logon server.</P
9842 >logon path = \\%N\%U\profile</B
9847 >logon path = \\PROFILESERVER\PROFILE\%U</B
9854 >>logon script (G)</DT
9857 >This parameter specifies the batch file (.bat) or
9858 NT command file (.cmd) to be downloaded and run on a machine when
9859 a user successfully logs in. The file must contain the DOS
9860 style CR/LF line endings. Using a DOS-style editor to create the
9861 file is recommended.</P
9863 >The script must be a relative path to the [netlogon]
9864 service. If the [netlogon] service specifies a <A
9872 >/usr/local/samba/netlogon
9876 >logon script = STARTUP.BAT</B
9878 the file that will be downloaded is:</P
9882 >/usr/local/samba/netlogon/STARTUP.BAT</TT
9885 >The contents of the batch file are entirely your choice. A
9886 suggested command would be to add <B
9888 >NET TIME \\SERVER /SET
9890 >, to force every machine to synchronize clocks with
9891 the same time server. Another use would be to add <B
9894 U: \\SERVER\UTILS</B
9895 > for commonly used utilities, or <B
9897 > NET USE Q: \\SERVER\ISO9001_QA</B
9900 >Note that it is particularly important not to allow write
9901 access to the [netlogon] share, or to grant users write permission
9902 on the batch files in a secure environment, as this would allow
9903 the batch files to be arbitrarily modified and security to be
9906 >This option takes the standard substitutions, allowing you
9907 to have separate logon scripts for each user or machine.</P
9909 >This option is only useful if Samba is set up as a logon
9916 >no logon script defined</I
9922 >logon script = scripts\%U.bat</B
9927 NAME="LPPAUSECOMMAND"
9929 >>lppause command (S)</DT
9932 >This parameter specifies the command to be
9933 executed on the server host in order to stop printing or spooling
9934 a specific print job.</P
9936 >This command should be a program or script which takes
9937 a printer name and job number to pause the print job. One way
9938 of implementing this is by using job priorities, where jobs
9939 having a too low priority won't be sent to the printer.</P
9944 > is given then the printer name
9945 is put in its place. A <VAR
9949 the job number (an integer). On HPUX (see <VAR
9957 to the lpq command, the job will show up with the correct status, i.e.
9958 if the job priority is lower than the set fence priority it will
9959 have the PAUSED status, whereas if the priority is equal or higher it
9960 will have the SPOOLED or PRINTING status.</P
9962 >Note that it is good practice to include the absolute path
9963 in the lppause command as the PATH may not be available to the server.</P
9974 >Default: Currently no default value is given to
9975 this string, unless the value of the <VAR
9982 >, in which case the default is :</P
9986 >lp -i %p-%j -H hold</B
9989 >or if the value of the <VAR
9996 >, then the default is:</P
10000 >qstat -s -j%j -h</B
10003 >Example for HPUX: <B
10005 >lppause command = /usr/bin/lpalt
10011 NAME="LPQCACHETIME"
10013 >>lpq cache time (G)</DT
10016 >This controls how long lpq info will be cached
10017 for to prevent the <B
10020 > command being called too
10021 often. A separate cache is kept for each variation of the <B
10024 > command used by the system, so if you use different
10028 > commands for different users then they won't
10029 share cache information.</P
10031 >The cache files are stored in <TT
10035 where xxxx is a hash of the <B
10038 > command in use.</P
10040 >The default is 10 seconds, meaning that the cached results
10041 of a previous identical <B
10044 > command will be used
10045 if the cached data is less than 10 seconds old. A large value may
10046 be advisable if your <B
10049 > command is very slow.</P
10051 >A value of 0 will disable caching completely.</P
10064 >lpq cache time = 10</B
10069 >lpq cache time = 30</B
10076 >>lpq command (S)</DT
10079 >This parameter specifies the command to be
10080 executed on the server host in order to obtain <B
10084 >-style printer status information.</P
10086 >This command should be a program or script which
10087 takes a printer name as its only parameter and outputs printer
10088 status information.</P
10090 >Currently nine styles of printer status information
10091 are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ.
10092 This covers most UNIX systems. You control which type is expected
10098 >Some clients (notably Windows for Workgroups) may not
10099 correctly send the connection number for the printer they are
10100 requesting status information about. To get around this, the
10101 server reports on the first printer service connected to by the
10102 client. This only happens if the connection number sent is invalid.</P
10107 > is given then the printer name
10108 is put in its place. Otherwise it is placed at the end of the
10111 >Note that it is good practice to include the absolute path
10119 > may not be available to the server. When compiled with
10120 the CUPS libraries, no <VAR
10124 needed because smbd will make a library call to obtain the
10125 print queue listing.</P
10140 >depends on the setting of <VAR
10149 >lpq command = /usr/bin/lpq -P%p</B
10154 NAME="LPRESUMECOMMAND"
10156 >>lpresume command (S)</DT
10159 >This parameter specifies the command to be
10160 executed on the server host in order to restart or continue
10161 printing or spooling a specific print job.</P
10163 >This command should be a program or script which takes
10164 a printer name and job number to resume the print job. See
10166 HREF="#LPPAUSECOMMAND"
10177 > is given then the printer name
10178 is put in its place. A <VAR
10182 the job number (an integer).</P
10184 >Note that it is good practice to include the absolute path
10187 >lpresume command</VAR
10188 > as the PATH may not
10189 be available to the server.</P
10200 >Default: Currently no default value is given
10201 to this string, unless the value of the <VAR
10208 >, in which case the default is :</P
10212 >lp -i %p-%j -H resume</B
10215 >or if the value of the <VAR
10222 >, then the default is:</P
10226 >qstat -s -j%j -r</B
10229 >Example for HPUX: <B
10231 >lpresume command = /usr/bin/lpalt
10239 >>lprm command (S)</DT
10242 >This parameter specifies the command to be
10243 executed on the server host in order to delete a print job.</P
10245 >This command should be a program or script which takes
10246 a printer name and job number, and deletes the print job.</P
10251 > is given then the printer name
10252 is put in its place. A <VAR
10256 the job number (an integer).</P
10258 >Note that it is good practice to include the absolute
10262 > as the PATH may not be
10263 available to the server.</P
10278 >depends on the setting of <VAR
10288 >lprm command = /usr/bin/lprm -P%p %j
10294 >lprm command = /usr/bin/cancel %p-%j
10300 NAME="MACHINEPASSWORDTIMEOUT"
10302 >>machine password timeout (G)</DT
10305 >If a Samba server is a member of a Windows
10306 NT Domain (see the <A
10307 HREF="#SECURITYEQUALSDOMAIN"
10308 >security = domain</A
10310 parameter) then periodically a running <A
10314 > process will try and change the MACHINE ACCOUNT
10315 PASSWORD stored in the TDB called <TT
10317 >private/secrets.tdb
10319 >. This parameter specifies how often this password
10320 will be changed, in seconds. The default is one week (expressed in
10321 seconds), the same as a Windows NT Domain member server.</P
10324 CLASS="CITEREFENTRY"
10326 CLASS="REFENTRYTITLE"
10330 HREF="#SECURITYEQUALSDOMAIN"
10331 > security = domain</A
10336 >machine password timeout = 604800</B
10343 >>magic output (S)</DT
10346 >This parameter specifies the name of a file
10347 which will contain output created by a magic script (see the
10349 HREF="#MAGICSCRIPT"
10355 parameter below).</P
10357 >Warning: If two clients use the same <VAR
10361 > in the same directory the output file content
10366 >magic output = <magic script name>.out
10372 >magic output = myfile.txt</B
10379 >>magic script (S)</DT
10382 >This parameter specifies the name of a file which,
10383 if opened, will be executed by the server when the file is closed.
10384 This allows a UNIX script to be sent to the Samba host and
10385 executed on behalf of the connected user.</P
10387 >Scripts executed in this way will be deleted upon
10388 completion assuming that the user has the appropriate level
10389 of privilege and the file permissions allow the deletion.</P
10391 >If the script generates output, output will be sent to
10392 the file specified by the <A
10393 HREF="#MAGICOUTPUT"
10396 > magic output</VAR
10398 > parameter (see above).</P
10400 >Note that some shells are unable to interpret scripts
10401 containing CR/LF instead of CR as
10402 the end-of-line marker. Magic scripts must be executable
10409 > on the host, which for some hosts and
10410 some shells will require filtering at the DOS end.</P
10412 >Magic scripts are <SPAN
10425 > be relied upon.</P
10431 >None. Magic scripts disabled.</I
10437 >magic script = user.csh</B
10444 >>mangle case (S)</DT
10447 >See the section on <A
10454 >mangle case = no</B
10461 >>mangled map (S)</DT
10464 >This is for those who want to directly map UNIX
10465 file names which cannot be represented on Windows/DOS. The mangling
10466 of names is not always what is needed. In particular you may have
10467 documents with file extensions that differ between DOS and UNIX.
10468 For example, under UNIX it is common to use <TT
10472 for HTML files, whereas under Windows/DOS <TT
10476 is more commonly used.</P
10489 >mangled map = (*.html *.htm)</B
10492 >One very useful case is to remove the annoying <TT
10496 > off the ends of filenames on some CDROMs (only visible
10497 under some UNIXes). To do this use a map of (*;1 *;).</P
10509 >mangled map = (*;1 *;)</B
10514 NAME="MANGLEDNAMES"
10516 >>mangled names (S)</DT
10519 >This controls whether non-DOS names under UNIX
10520 should be mapped to DOS-compatible names ("mangled") and made visible,
10521 or whether non-DOS names should simply be ignored.</P
10523 >See the section on <A
10526 > for details on how to control the mangling process.</P
10528 >If mangling is used then the mangling algorithm is as follows:</P
10534 >The first (up to) five alphanumeric characters
10535 before the rightmost dot of the filename are preserved, forced
10536 to upper case, and appear as the first (up to) five characters
10537 of the mangled name.</P
10541 >A tilde "~" is appended to the first part of the mangled
10542 name, followed by a two-character unique sequence, based on the
10543 original root name (i.e., the original filename minus its final
10544 extension). The final extension is included in the hash calculation
10545 only if it contains any upper case characters or is longer than three
10548 >Note that the character to use may be specified using
10550 HREF="#MANGLINGCHAR"
10553 >mangling char</VAR
10556 > option, if you don't like '~'.</P
10560 >The first three alphanumeric characters of the final
10561 extension are preserved, forced to upper case and appear as the
10562 extension of the mangled name. The final extension is defined as that
10563 part of the original filename after the rightmost dot. If there are no
10564 dots in the filename, the mangled name will have no extension (except
10565 in the case of "hidden files" - see below).</P
10569 >Files whose UNIX name begins with a dot will be
10570 presented as DOS hidden files. The mangled name will be created as
10571 for other filenames, but with the leading dot removed and "___" as
10572 its extension regardless of actual original extension (that's three
10577 >The two-digit hash value consists of upper case
10578 alphanumeric characters.</P
10580 >This algorithm can cause name collisions only if files
10581 in a directory share the same first five alphanumeric characters.
10582 The probability of such a clash is 1/1300.</P
10584 >The name mangling (if enabled) allows a file to be
10585 copied between UNIX directories from Windows/DOS while retaining
10586 the long UNIX filename. UNIX files can be renamed to a new extension
10587 from Windows/DOS and will retain the same basename. Mangled names
10588 do not change between sessions.</P
10592 >mangled names = yes</B
10597 NAME="MANGLINGMETHOD"
10599 >>mangling method (G)</DT
10602 > controls the algorithm used for the generating
10603 the mangled names. Can take two different values, "hash" and
10604 "hash2". "hash" is the default and is the algorithm that has been
10605 used in Samba for many years. "hash2" is a newer and considered
10606 a better algorithm (generates less collisions) in the names.
10607 However, many Win32 applications store the mangled names and so
10608 changing to the new algorithm must not be done
10609 lightly as these applications may break unless reinstalled.</P
10613 >mangling method = hash2</B
10618 >mangling method = hash</B
10623 NAME="MANGLEPREFIX"
10625 >>mangle prefix (G)</DT
10628 > controls the number of prefix
10629 characters from the original name used when generating
10630 the mangled names. A larger value will give a weaker
10631 hash and therefore more name collisions. The minimum
10632 value is 1 and the maximum value is 6.</P
10636 >mangle prefix = 1</B
10641 >mangle prefix = 4</B
10646 NAME="MANGLEDSTACK"
10648 >>mangled stack (G)</DT
10651 >This parameter controls the number of mangled names
10652 that should be cached in the Samba server <SPAN
10653 CLASS="CITEREFENTRY"
10655 CLASS="REFENTRYTITLE"
10660 >This stack is a list of recently mangled base names
10661 (extensions are only maintained if they are longer than 3 characters
10662 or contains upper case characters).</P
10664 >The larger this value, the more likely it is that mangled
10665 names can be successfully converted to correct long UNIX names.
10666 However, large stack sizes will slow most directory accesses. Smaller
10667 stacks save memory in the server (each stack element costs 256 bytes).
10670 >It is not possible to absolutely guarantee correct long
10671 filenames, so be prepared for some surprises!</P
10675 >mangled stack = 50</B
10680 >mangled stack = 100</B
10685 NAME="MANGLINGCHAR"
10687 >>mangling char (S)</DT
10690 >This controls what character is used as
10700 >. The default is a '~'
10701 but this may interfere with some software. Use this option to set
10702 it to whatever you prefer.</P
10706 >mangling char = ~</B
10711 >mangling char = ^</B
10718 >>map archive (S)</DT
10721 >This controls whether the DOS archive attribute
10722 should be mapped to the UNIX owner execute bit. The DOS archive bit
10723 is set when a file has been modified since its last backup. One
10724 motivation for this option it to keep Samba/your PC from making
10725 any file it touches from becoming executable under UNIX. This can
10726 be quite annoying for shared source code, documents, etc...</P
10728 >Note that this requires the <VAR
10732 parameter to be set such that owner execute bit is not masked out
10733 (i.e. it must include 100). See the parameter <A
10743 >map archive = yes</B
10750 >>map hidden (S)</DT
10753 >This controls whether DOS style hidden files
10754 should be mapped to the UNIX world execute bit.</P
10756 >Note that this requires the <VAR
10760 to be set such that the world execute bit is not masked out (i.e.
10761 it must include 001). See the parameter <A
10771 >map hidden = no</B
10778 >>map system (S)</DT
10781 >This controls whether DOS style system files
10782 should be mapped to the UNIX group execute bit.</P
10784 >Note that this requires the <VAR
10788 to be set such that the group execute bit is not masked out (i.e.
10789 it must include 010). See the parameter <A
10799 >map system = no</B
10806 >>map to guest (G)</DT
10809 >This parameter is only useful in <A
10812 > modes other than <VAR
10814 >security = share</VAR
10828 >This parameter can take three different values, which tell
10830 CLASS="CITEREFENTRY"
10832 CLASS="REFENTRYTITLE"
10835 > what to do with user
10836 login requests that don't match a valid UNIX user in some way.</P
10838 >The three settings are :</P
10847 > - Means user login
10848 requests with an invalid password are rejected. This is the
10857 logins with an invalid password are rejected, unless the username
10858 does not exist, in which case it is treated as a guest login and
10860 HREF="#GUESTACCOUNT"
10863 > guest account</VAR
10871 >Bad Password</CODE
10872 > - Means user logins
10873 with an invalid password are treated as a guest login and mapped
10875 HREF="#GUESTACCOUNT"
10878 this can cause problems as it means that any user incorrectly typing
10879 their password will be silently logged on as "guest" - and
10880 will not know the reason they cannot access files they think
10881 they should - there will have been no message given to them
10882 that they got their password wrong. Helpdesk services will
10889 > you if you set the <VAR
10893 > parameter this way :-).</P
10897 >Note that this parameter is needed to set up "Guest"
10898 share services when using <VAR
10902 share. This is because in these modes the name of the resource being
10909 > sent to the server until after
10910 the server has successfully authenticated the client so the server
10911 cannot make authentication decisions at the correct time (connection
10912 to the share) for "Guest" shares.</P
10914 >For people familiar with the older Samba releases, this
10915 parameter maps to the old compile-time setting of the <CODE
10917 > GUEST_SESSSETUP</CODE
10918 > value in local.h.</P
10922 >map to guest = Never</B
10927 >map to guest = Bad User</B
10932 NAME="MAXCONNECTIONS"
10934 >>max connections (S)</DT
10937 >This option allows the number of simultaneous
10938 connections to a service to be limited. If <VAR
10942 > is greater than 0 then connections will be refused if
10943 this number of connections to the service are already open. A value
10944 of zero mean an unlimited number of connections may be made.</P
10946 >Record lock files are used to implement this feature. The
10947 lock files will be stored in the directory specified by the <A
10948 HREF="#LOCKDIRECTORY"
10951 >lock directory</VAR
10958 >max connections = 0</B
10963 >max connections = 10</B
10970 >>max disk size (G)</DT
10973 >This option allows you to put an upper limit
10974 on the apparent size of disks. If you set this option to 100
10975 then all shares will appear to be not larger than 100 MB in
10978 >Note that this option does not limit the amount of
10979 data you can put on the disk. In the above case you could still
10980 store much more than 100 MB on the disk, but if a client ever asks
10981 for the amount of free disk space or the total disk size then the
10982 result will be bounded by the amount specified in <VAR
10988 >This option is primarily useful to work around bugs
10989 in some pieces of software that can't handle very large disks,
10990 particularly disks over 1GB in size.</P
10994 >max disk size</VAR
10995 > of 0 means no limit.</P
10999 >max disk size = 0</B
11004 >max disk size = 1000</B
11011 >>max log size (G)</DT
11014 >This option (an integer in kilobytes) specifies
11015 the max size the log file should grow to. Samba periodically checks
11016 the size and if it is exceeded it will rename the file, adding
11022 >A size of 0 means no limit.</P
11026 >max log size = 5000</B
11031 >max log size = 1000</B
11038 >>max mux (G)</DT
11041 >This option controls the maximum number of
11042 outstanding simultaneous SMB operations that Samba tells the client
11043 it will allow. You should never need to set this parameter.</P
11052 NAME="MAXOPENFILES"
11054 >>max open files (G)</DT
11057 >This parameter limits the maximum number of
11058 open files that one <SPAN
11059 CLASS="CITEREFENTRY"
11061 CLASS="REFENTRYTITLE"
11065 serving process may have open for a client at any one time. The
11066 default for this parameter is set very high (10,000) as Samba uses
11067 only one bit per unopened file.</P
11069 >The limit of the number of open files is usually set
11070 by the UNIX per-process file descriptor limit rather than
11071 this parameter so you should never need to touch this parameter.</P
11075 >max open files = 10000</B
11080 NAME="MAXPRINTJOBS"
11082 >>max print jobs (S)</DT
11085 >This parameter limits the maximum number of
11086 jobs allowable in a Samba printer queue at any given moment.
11087 If this number is exceeded, <SPAN
11088 CLASS="CITEREFENTRY"
11090 CLASS="REFENTRYTITLE"
11093 > will remote "Out of Space" to the client.
11095 HREF="#TOTALPRINTJOBS"
11106 >max print jobs = 1000</B
11111 >max print jobs = 5000</B
11118 >>max protocol (G)</DT
11121 >The value of the parameter (a string) is the highest
11122 protocol level that will be supported by the server.</P
11124 >Possible values are :</P
11133 >: Earliest version. No
11134 concept of user names.</P
11141 >: Slight improvements on
11142 CORE for efficiency.</P
11155 > version of the protocol. Long filename
11163 >: Updates to Lanman1 protocol.
11171 >: Current up to date version of
11172 the protocol. Used by Windows NT. Known as CIFS.</P
11176 >Normally this option should not be set as the automatic
11177 negotiation phase in the SMB protocol takes care of choosing
11178 the appropriate protocol.</P
11181 HREF="#MINPROTOCOL"
11191 >max protocol = NT1</B
11196 >max protocol = LANMAN1</B
11201 NAME="MAXSMBDPROCESSES"
11203 >>max smbd processes (G)</DT
11206 >This parameter limits the maximum number of
11215 processes concurrently running on a system and is intended
11216 as a stopgap to prevent degrading service to clients in the event
11217 that the server has insufficient resources to handle more than this
11218 number of connections. Remember that under normal operating
11219 conditions, each user will have an <SPAN
11220 CLASS="CITEREFENTRY"
11222 CLASS="REFENTRYTITLE"
11225 > associated with him or her
11226 to handle connections to all shares from a given host.
11231 >max smbd processes = 0</B
11236 >max smbd processes = 1000</B
11243 >>max ttl (G)</DT
11246 >This option tells <SPAN
11247 CLASS="CITEREFENTRY"
11249 CLASS="REFENTRYTITLE"
11253 what the default 'time to live' of NetBIOS names should be (in seconds)
11257 > is requesting a name using either a
11258 broadcast packet or from a WINS server. You should never need to
11259 change this parameter. The default is 3 days.</P
11263 >max ttl = 259200</B
11270 >>max wins ttl (G)</DT
11273 >This option tells <SPAN
11274 CLASS="CITEREFENTRY"
11276 CLASS="REFENTRYTITLE"
11279 > when acting as a WINS server (<A
11280 HREF="#WINSSUPPORT"
11283 >wins support = yes</VAR
11285 >) what the maximum
11286 'time to live' of NetBIOS names that <B
11290 will grant will be (in seconds). You should never need to change this
11291 parameter. The default is 6 days (518400 seconds).</P
11304 >max wins ttl = 518400</B
11311 >>max xmit (G)</DT
11314 >This option controls the maximum packet size
11315 that will be negotiated by Samba. The default is 65535, which
11316 is the maximum. In some cases you may find you get better performance
11317 with a smaller value. A value below 2048 is likely to cause problems.
11322 >max xmit = 65535</B
11327 >max xmit = 8192</B
11332 NAME="MESSAGECOMMAND"
11334 >>message command (G)</DT
11337 >This specifies what command to run when the
11338 server receives a WinPopup style message.</P
11340 >This would normally be a command that would
11341 deliver the message somehow. How this is to be done is
11342 up to your imagination.</P
11348 >message command = csh -c 'xedit %s;rm %s' &</B
11352 >This delivers the message using <B
11356 removes it afterwards. <SPAN
11360 >NOTE THAT IT IS VERY IMPORTANT
11361 THAT THIS COMMAND RETURN IMMEDIATELY</I
11364 have the '&' on the end. If it doesn't return immediately then
11365 your PCs may freeze when sending messages (they should recover
11366 after 30 seconds, hopefully).</P
11368 >All messages are delivered as the global guest user.
11369 The command takes the standard substitutions, although <VAR
11378 >Apart from the standard substitutions, some additional
11379 ones apply. In particular:</P
11388 > = the filename containing
11396 > = the destination that
11397 the message was sent to (probably the server name).</P
11404 > = who the message
11409 >You could make this command send mail, or whatever else
11410 takes your fancy. Please let us know of any really interesting
11413 >Here's a way of sending the messages as mail to root:</P
11417 >message command = /bin/mail -s 'message from %f on
11418 %m' root < %s; rm %s</B
11421 >If you don't have a message command then the message
11422 won't be delivered and Samba will tell the sender there was
11423 an error. Unfortunately WfWg totally ignores the error code
11424 and carries on regardless, saying that the message was delivered.
11427 >If you want to silently delete it then try:</P
11431 >message command = rm %s</B
11438 >no message command</I
11444 >message command = csh -c 'xedit %s;
11450 NAME="MINPASSWDLENGTH"
11452 >>min passwd length (G)</DT
11456 HREF="#MINPASSWORDLENGTH"
11459 >min password length</VAR
11465 NAME="MINPASSWORDLENGTH"
11467 >>min password length (G)</DT
11470 >This option sets the minimum length in characters
11471 of a plaintext password that <B
11474 > will accept when performing
11475 UNIX password changing.</P
11478 HREF="#UNIXPASSWORDSYNC"
11485 HREF="#PASSWDPROGRAM"
11488 >passwd program</VAR
11491 HREF="#PASSWDCHATDEBUG"
11494 >passwd chat debug</VAR
11501 >min password length = 5</B
11506 NAME="MINPRINTSPACE"
11508 >>min print space (S)</DT
11511 >This sets the minimum amount of free disk
11512 space that must be available before a user will be able to spool
11513 a print job. It is specified in kilobytes. The default is 0, which
11514 means a user can always spool a print job.</P
11527 >min print space = 0</B
11532 >min print space = 2000</B
11539 >>min protocol (G)</DT
11542 >The value of the parameter (a string) is the
11543 lowest SMB protocol dialect than Samba will support. Please refer
11545 HREF="#MAXPROTOCOL"
11551 parameter for a list of valid protocol names and a brief description
11552 of each. You may also wish to refer to the C source code in
11555 >source/smbd/negprot.c</TT
11556 > for a listing of known protocol
11557 dialects supported by clients.</P
11559 >If you are viewing this parameter as a security measure, you should
11560 also refer to the <A
11567 > parameter. Otherwise, you should never need
11568 to change this parameter.</P
11572 >min protocol = CORE</B
11577 >min protocol = NT1</B
11585 >>min wins ttl (G)</DT
11588 >This option tells <SPAN
11589 CLASS="CITEREFENTRY"
11591 CLASS="REFENTRYTITLE"
11595 when acting as a WINS server (<A
11596 HREF="#WINSSUPPORT"
11599 > wins support = yes</VAR
11601 >) what the minimum 'time to live'
11602 of NetBIOS names that <B
11605 > will grant will be (in
11606 seconds). You should never need to change this parameter. The default
11607 is 6 hours (21600 seconds).</P
11611 >min wins ttl = 21600</B
11618 >>msdfs proxy (S)</DT
11621 >This parameter indicates that the share is a
11622 stand-in for another CIFS share whose location is specified by
11623 the value of the parameter. When clients attempt to connect to
11624 this share, they are redirected to the proxied share using
11625 the SMB-Dfs protocol.</P
11627 >Only Dfs roots can act as proxy shares. Take a look at the
11643 options to find out how to set up a Dfs root share.</P
11647 >msdfs proxy = \\\\otherserver\\someshare</B
11654 >>msdfs root (S)</DT
11657 >This boolean parameter is only available if
11658 Samba is configured and compiled with the <B
11661 > option. If set to <CODE
11665 Samba treats the share as a Dfs root and allows clients to browse
11666 the distributed file system tree rooted at the share directory.
11667 Dfs links are specified in the share directory by symbolic
11668 links of the form <TT
11670 >msdfs:serverA\\shareA,serverB\\shareB</TT
11672 and so on. For more information on setting up a Dfs tree
11673 on Samba, refer to <A
11676 >"Hosting a Microsoft
11677 Distributed File System tree on Samba"</A
11691 >msdfs root = no</B
11696 NAME="NAMECACHETIMEOUT"
11698 >>name cache timeout (G)</DT
11701 >Specifies the number of seconds it takes before
11702 entries in samba's hostname resolve cache time out. If
11703 the timeout is set to 0. the caching is disabled.
11708 >name cache timeout = 660</B
11713 >name cache timeout = 0</B
11718 NAME="NAMERESOLVEORDER"
11720 >>name resolve order (G)</DT
11723 >This option is used by the programs in the Samba
11724 suite to determine what naming services to use and in what order
11725 to resolve host names to IP addresses. The option takes a space
11726 separated string of name resolution options.</P
11728 >The options are :"lmhosts", "host", "wins" and "bcast". They
11729 cause names to be resolved as follows :</P
11739 address in the Samba lmhosts file. If the line in lmhosts has
11740 no name type attached to the NetBIOS name (see the <A
11741 HREF="lmhosts.5.html"
11744 > for details) then
11745 any name type matches for lookup.</P
11752 > : Do a standard host
11753 name to IP address resolution, using the system <TT
11757 >, NIS, or DNS lookups. This method of name resolution
11758 is operating system depended for instance on IRIX or Solaris this
11759 may be controlled by the <TT
11761 >/etc/nsswitch.conf</TT
11763 file. Note that this method is only used if the NetBIOS name
11764 type being queried is the 0x20 (server) name type, otherwise
11772 > : Query a name with
11773 the IP address listed in the <A
11779 > parameter. If no WINS server has
11780 been specified this method will be ignored.</P
11787 > : Do a broadcast on
11788 each of the known local interfaces listed in the <A
11795 parameter. This is the least reliable of the name resolution
11796 methods as it depends on the target host being on a locally
11797 connected subnet.</P
11803 >name resolve order = lmhosts host wins bcast
11809 >name resolve order = lmhosts bcast host
11813 >This will cause the local lmhosts file to be examined
11814 first, followed by a broadcast attempt, followed by a normal
11815 system hostname lookup.</P
11819 NAME="NETBIOSALIASES"
11821 >>netbios aliases (G)</DT
11824 >This is a list of NetBIOS names that <A
11828 > will advertise as additional
11829 names by which the Samba server is known. This allows one machine
11830 to appear in browse lists under multiple names. If a machine is
11831 acting as a browse server or logon server none
11832 of these names will be advertised as either browse server or logon
11833 servers, only the primary name of the machine will be advertised
11834 with these capabilities.</P
11837 HREF="#NETBIOSNAME"
11849 >empty string (no additional names)</I
11855 >netbios aliases = TEST TEST1 TEST2</B
11862 >>netbios name (G)</DT
11865 >This sets the NetBIOS name by which a Samba
11866 server is known. By default it is the same as the first component
11867 of the host's DNS name. If a machine is a browse server or
11868 logon server this name (or the first component
11869 of the hosts DNS name) will be the name that these services are
11870 advertised under.</P
11873 HREF="#NETBIOSALIASES"
11885 >machine DNS name</I
11891 >netbios name = MYNAME</B
11896 NAME="NETBIOSSCOPE"
11898 >>netbios scope (G)</DT
11901 >This sets the NetBIOS scope that Samba will
11902 operate under. This should not be set unless every machine
11903 on your LAN also sets this value.</P
11909 >>nis homedir (G)</DT
11912 >Get the home share server from a NIS map. For
11913 UNIX systems that use an automounter, the user's home directory
11914 will often be mounted on a workstation on demand from a remote
11917 >When the Samba logon server is not the actual home directory
11918 server, but is mounting the home directories via NFS then two
11919 network hops would be required to access the users home directory
11920 if the logon server told the client to use itself as the SMB server
11921 for home directories (one over SMB and one over NFS). This can
11924 >This option allows Samba to return the home share as
11925 being on a different server to the logon server and as
11926 long as a Samba daemon is running on the home directory server,
11927 it will be mounted on the Samba client directly from the directory
11928 server. When Samba is returning the home share to the client, it
11929 will consult the NIS map specified in <A
11935 > and return the server
11938 >Note that for this option to work there must be a working
11939 NIS system and the Samba server with this option must also
11940 be a logon server.</P
11944 >nis homedir = no</B
11949 NAME="NONUNIXACCOUNTRANGE"
11951 >>non unix account range (G)</DT
11954 >The non unix account range parameter specifies
11955 the range of 'user ids' that are allocated by the various 'non unix
11956 account' passdb backends. These backends allow
11957 the storage of passwords for users who don't exist in /etc/passwd.
11958 This is most often used for machine account creation.
11959 This range of ids should have no existing local or NIS users within
11960 it as strange conflicts can occur otherwise.</P
11962 >NOTE: These userids never appear on the system and Samba will never
11963 'become' these users. They are used only to ensure that the algorithmic
11964 RID mapping does not conflict with normal users.
11969 >non unix account range = <empty string>
11975 >non unix account range = 10000-20000</B
11980 NAME="NTACLSUPPORT"
11982 >>nt acl support (S)</DT
11985 >This boolean parameter controls whether
11990 > will attempt to map
11991 UNIX permissions into Windows NT access control lists.
11992 This parameter was formally a global parameter in releases
11997 >nt acl support = yes</B
12002 NAME="NTPIPESUPPORT"
12004 >>nt pipe support (G)</DT
12007 >This boolean parameter controls whether
12009 CLASS="CITEREFENTRY"
12011 CLASS="REFENTRYTITLE"
12014 > will allow Windows NT
12015 clients to connect to the NT SMB specific <CODE
12019 pipes. This is a developer debugging option and can be left
12024 >nt pipe support = yes</B
12029 NAME="NTSTATUSSUPPORT"
12031 >>nt status support (G)</DT
12034 >This boolean parameter controls whether <A
12038 > will negotiate NT specific status
12039 support with Windows NT/2k/XP clients. This is a developer
12040 debugging option and should be left alone.
12041 If this option is set to <CODE
12044 > then Samba offers
12045 exactly the same DOS error codes that versions prior to Samba 2.2.3
12048 >You should not need to ever disable this parameter.</P
12052 >nt status support = yes</B
12057 NAME="NULLPASSWORDS"
12059 >>null passwords (G)</DT
12062 >Allow or disallow client access to accounts
12063 that have null passwords. </P
12066 CLASS="CITEREFENTRY"
12068 CLASS="REFENTRYTITLE"
12075 >null passwords = no</B
12080 NAME="OBEYPAMRESTRICTIONS"
12082 >>obey pam restrictions (G)</DT
12085 >When Samba 2.2 is configured to enable PAM support
12086 (i.e. --with-pam), this parameter will control whether or not Samba
12087 should obey PAM's account and session management directives. The
12088 default behavior is to use PAM for clear text authentication only
12089 and to ignore any account or session management. Note that Samba
12090 always ignores PAM for authentication in the case of <A
12091 HREF="#ENCRYPTPASSWORDS"
12094 >encrypt passwords = yes</VAR
12097 >. The reason is that PAM modules cannot support the challenge/response
12098 authentication mechanism needed in the presence of SMB password encryption.
12103 >obey pam restrictions = no</B
12110 >>only user (S)</DT
12113 >This is a boolean option that controls whether
12114 connections with usernames not in the <VAR
12118 list will be allowed. By default this option is disabled so that a
12119 client can supply a username to be used by the server. Enabling
12120 this parameter will force the server to only use the login
12121 names from the <VAR
12124 > list and is only really
12126 HREF="#SECURITYEQUALSSHARE"
12131 >Note that this also means Samba won't try to deduce
12132 usernames from the service name. This can be annoying for
12133 the [homes] section. To get around this you could use <B
12137 > which means your <VAR
12141 will be just the service name, which for home directories is the
12142 name of the user.</P
12162 >>only guest (S)</DT
12175 NAME="OPLOCKBREAKWAITTIME"
12177 >>oplock break wait time (G)</DT
12180 >This is a tuning parameter added due to bugs in
12181 both Windows 9x and WinNT. If Samba responds to a client too
12182 quickly when that client issues an SMB that can cause an oplock
12183 break request, then the network client can fail and not respond
12184 to the break request. This tuning parameter (which is set in milliseconds)
12185 is the amount of time Samba will wait before sending an oplock break
12186 request to such (broken) clients.</P
12192 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
12193 AND UNDERSTOOD THE SAMBA OPLOCK CODE</I
12199 >oplock break wait time = 0</B
12204 NAME="OPLOCKCONTENTIONLIMIT"
12206 >>oplock contention limit (S)</DT
12221 improve the efficiency of the granting of oplocks under multiple
12222 client contention for the same file.</P
12224 >In brief it specifies a number, which causes <SPAN
12225 CLASS="CITEREFENTRY"
12227 CLASS="REFENTRYTITLE"
12230 >not to grant an oplock even when requested
12231 if the approximate number of clients contending for an oplock on the same file goes over this
12232 limit. This causes <B
12235 > to behave in a similar
12236 way to Windows NT.</P
12242 >DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ
12243 AND UNDERSTOOD THE SAMBA OPLOCK CODE</I
12249 >oplock contention limit = 2</B
12256 >>oplocks (S)</DT
12259 >This boolean option tells <B
12263 issue oplocks (opportunistic locks) to file open requests on this
12264 share. The oplock code can dramatically (approx. 30% or more) improve
12265 the speed of access to files on Samba servers. It allows the clients
12266 to aggressively cache files locally and you may want to disable this
12267 option for unreliable network environments (it is turned on by
12268 default in Windows NT Servers). For more information see the file
12278 >Oplocks may be selectively turned off on certain files with a
12280 HREF="#VETOOPLOCKFILES"
12283 > veto oplock files</VAR
12285 > parameter. On some systems
12286 oplocks are recognized by the underlying operating system. This
12287 allows data synchronization between all access to oplocked files,
12288 whether it be via Samba or NFS or a local UNIX process. See the
12291 >kernel oplocks</VAR
12292 > parameter for details.</P
12295 HREF="#KERNELOPLOCKS"
12302 HREF="#LEVEL2OPLOCKS"
12305 > level2 oplocks</VAR
12318 >>ntlm auth (G)</DT
12321 >This parameter determines
12322 whether or not <SPAN
12323 CLASS="CITEREFENTRY"
12325 CLASS="REFENTRYTITLE"
12329 attempt to authenticate users using the NTLM password hash.
12330 If disabled, only the lanman password hashes will be used.
12333 >Please note that at least this option or <B
12337 be enabled in order to be able to log in.
12342 >ntlm auth = yes</B
12349 >>os level (G)</DT
12352 >This integer value controls what level Samba
12353 advertises itself as for browse elections. The value of this
12354 parameter determines whether <SPAN
12355 CLASS="CITEREFENTRY"
12357 CLASS="REFENTRYTITLE"
12361 has a chance of becoming a local master browser for the <VAR
12364 > in the local broadcast area.</P
12372 >By default, Samba will win
12373 a local master browsing election over all Microsoft operating
12374 systems except a Windows NT 4.0/2000 Domain Controller. This
12375 means that a misconfigured Samba host can effectively isolate
12376 a subnet for browsing purposes. See <TT
12398 NAME="OS2DRIVERMAP"
12400 >>os2 driver map (G)</DT
12403 >The parameter is used to define the absolute
12404 path to a file containing a mapping of Windows NT printer driver
12405 names to OS/2 printer driver names. The format is:</P
12407 ><nt driver name> = <os2 driver
12408 name>.<device name></P
12410 >For example, a valid entry using the HP LaserJet 5
12411 printer driver would appear as <B
12413 >HP LaserJet 5L = LASERJET.HP
12417 >The need for the file is due to the printer driver namespace
12418 problem described in the <A
12419 HREF="printing.html"
12423 >. For more details on OS/2 clients, please
12424 refer to the OS2-Client-HOWTO containing in the Samba documentation.</P
12428 >os2 driver map = <empty string>
12434 NAME="PAMPASSWORDCHANGE"
12436 >>pam password change (G)</DT
12439 >With the addition of better PAM support in Samba 2.2,
12440 this parameter, it is possible to use PAM's password change control
12441 flag for Samba. If enabled, then PAM will be used for password
12442 changes when requested by an SMB client instead of the program listed in
12444 HREF="#PASSWDPROGRAM"
12447 >passwd program</VAR
12450 It should be possible to enable this without changing your
12458 parameter for most setups.
12463 >pam password change = no</B
12470 >>panic action (G)</DT
12473 >This is a Samba developer option that allows a
12474 system command to be called when either <SPAN
12475 CLASS="CITEREFENTRY"
12477 CLASS="REFENTRYTITLE"
12481 CLASS="CITEREFENTRY"
12483 CLASS="REFENTRYTITLE"
12486 > crashes. This is usually used to
12487 draw attention to the fact that a problem occurred.</P
12491 >panic action = <empty string></B
12496 >panic action = "/bin/sleep 90000"</B
12501 NAME="PARANOIDSERVERSECURITY"
12503 >>paranoid server security (G)</DT
12506 >Some version of NT 4.x allow non-guest
12507 users with a bad passowrd. When this option is enabled, samba will not
12508 use a broken NT 4.x server as password server, but instead complain
12509 to the logs and exit.
12512 >Disabling this option prevents Samba from making
12513 this check, which involves deliberatly attempting a
12514 bad logon to the remote server.</P
12518 >paranoid server security = yes</B
12523 NAME="PASSDBBACKEND"
12525 >>passdb backend (G)</DT
12528 >This option allows the administrator to chose which backends to retrieve and store passwords with. This allows (for example) both
12529 smbpasswd and tdbsam to be used without a recompile.
12530 Multiple backends can be specified, separated by spaces. The backends will be searched in the order they are specified. New users are always added to the first backend specified.
12531 Experimental backends must still be selected
12532 (eg --with-tdbsam) at configure time.
12535 >This parameter is in two parts, the backend's name, and a 'location'
12536 string that has meaning only to that particular backed. These are separated
12537 by a : character.</P
12539 >Available backends can include:
12548 > - The default smbpasswd
12549 backend. Takes a path to the smbpasswd file as an optional argument.</P
12557 backend, but with support for 'not unix accounts'.
12558 Takes a path to the smbpasswd file as an optional argument.</P
12561 HREF="#NONUNIXACCOUNTRANGE"
12564 >non unix account range</VAR
12573 > - The TDB based password storage
12574 backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
12588 > - The TDB based password storage
12589 backend, with non unix account support. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
12599 HREF="#NONUNIXACCOUNTRANGE"
12602 >non unix account range</VAR
12611 > - The LDAP based passdb
12612 backend. Takes an LDAP URL as an optional argument (defaults to
12615 >ldap://localhost</B
12623 > - The LDAP based passdb
12624 backend, with non unix account support. Takes an LDAP URL as an optional argument (defaults to
12627 >ldap://localhost</B
12630 >Note: In this module, any account without a matching POSIX account is regarded
12634 HREF="#NONUNIXACCOUNTRANGE"
12642 >LDAP connections should be secured where
12643 possible. This may be done using either
12663 > - The NIS+ based passdb backend. Takes name NIS domain as an optional argument. Only works with sun NIS+ servers. </P
12670 > - Allows Samba to load an
12671 arbitary passdb backend from the .so specified as a compulsary argument.
12674 >Any characters after the (optional) second : are passed to the plugin
12675 for its own processing</P
12682 > - Allows samba to map all (other) available unix users</P
12684 >This backend uses the standard unix database for retrieving users. Users included
12685 in this pdb are NOT listed in samba user listings and users included in this pdb won't be
12686 able to login. The use of this backend is to always be able to display the owner of a file
12687 on the samba server - even when the user doesn't have a 'real' samba account in one of the
12688 other passdb backends.
12691 >This backend should always be the last backend listed, since it contains all users in
12692 the unix passdb and might 'override' mappings if specified earlier. It's meant to only return
12693 accounts for users that aren't covered by the previous backends.</P
12701 >passdb backend = smbpasswd unixsam</B
12706 >passdb backend = tdbsam:/etc/samba/private/passdb.tdb smbpasswd:/etc/samba/smbpasswd unixsam</B
12711 >passdb backend = ldapsam_nua:ldaps://ldap.example.com unixsam</B
12716 >passdb backend = plugin:/usr/local/samba/lib/my_passdb.so:my_plugin_args tdbsam:/etc/samba/private/passdb.tdb</B
12723 >>passwd chat (G)</DT
12726 >This string controls the <SPAN
12733 conversation that takes places between <SPAN
12734 CLASS="CITEREFENTRY"
12736 CLASS="REFENTRYTITLE"
12739 > and the local password changing
12740 program to change the user's password. The string describes a
12741 sequence of response-receive pairs that <SPAN
12742 CLASS="CITEREFENTRY"
12744 CLASS="REFENTRYTITLE"
12747 > uses to determine what to send to the
12749 HREF="#PASSWDPROGRAM"
12752 >passwd program</VAR
12755 > and what to expect back. If the expected output is not
12756 received then the password is not changed.</P
12758 >This chat sequence is often quite site specific, depending
12759 on what local methods are used for password control (such as NIS
12762 >Note that this parameter only is only used if the <A
12763 HREF="#UNIXPASSWORDSYNC"
12769 > parameter is set to <CODE
12773 sequence is then called <SPAN
12779 > when the SMB password
12780 in the smbpasswd file is being changed, without access to the old
12781 password cleartext. This means that root must be able to reset the user's password
12782 without knowing the text of the previous password. In the presence of NIS/YP,
12783 this means that the <A
12784 HREF="#PASSWDPROGRAM"
12787 executed on the NIS master.
12790 >The string can contain the macro <VAR
12793 > which is substituted
12794 for the new password. The chat sequence can also contain the standard
12807 > to give line-feed,
12808 carriage-return, tab and space. The chat sequence string can also contain
12809 a '*' which matches any sequence of characters.
12810 Double quotes can be used to collect strings with spaces
12811 in them into a single string.</P
12813 >If the send string in any part of the chat sequence
12814 is a full stop ".", then no string is sent. Similarly,
12815 if the expect string is a full stop then no string is expected.</P
12818 HREF="#PAMPASSWORDCHANGE"
12822 password change</VAR
12824 > parameter is set to <CODE
12828 may be matched in any order, and success is determined by the PAM result,
12829 not any particular output. The \n macro is ignored for PAM conversions.
12833 HREF="#UNIXPASSWORDSYNC"
12840 HREF="#PASSWDPROGRAM"
12843 > passwd program</VAR
12846 HREF="#PASSWDCHATDEBUG"
12849 >passwd chat debug</VAR
12852 HREF="#PAMPASSWORDCHANGE"
12855 >pam password change</VAR
12861 >passwd chat = *new*password* %n\\n
12862 *new*password* %n\\n *changed*</B
12867 >passwd chat = "*Enter OLD password*" %o\\n
12868 "*Enter NEW password*" %n\\n "*Reenter NEW password*" %n\\n "*Password
12874 NAME="PASSWDCHATDEBUG"
12876 >>passwd chat debug (G)</DT
12879 >This boolean specifies if the passwd chat script
12880 parameter is run in <SPAN
12886 > mode. In this mode the
12887 strings passed to and received from the passwd chat are printed
12889 CLASS="CITEREFENTRY"
12891 CLASS="REFENTRYTITLE"
12902 of 100. This is a dangerous option as it will allow plaintext passwords
12903 to be seen in the <B
12906 > log. It is available to help
12907 Samba admins debug their <VAR
12911 when calling the <VAR
12913 >passwd program</VAR
12915 be turned off after this has been done. This option has no effect if the
12917 HREF="#PAMPASSWORDCHANGE"
12920 >pam password change</VAR
12923 paramter is set. This parameter is off by default.</P
12933 HREF="#PAMPASSWORDCHANGE"
12936 >pam password change</VAR
12940 HREF="#PASSWDPROGRAM"
12943 >passwd program</VAR
12950 >passwd chat debug = no</B
12955 NAME="PASSWDPROGRAM"
12957 >>passwd program (G)</DT
12960 >The name of a program that can be used to set
12961 UNIX user passwords. Any occurrences of <VAR
12965 will be replaced with the user name. The user name is checked for
12966 existence before calling the password changing program.</P
12968 >Also note that many passwd programs insist in <SPAN
12975 > passwords, such as a minimum length, or the inclusion
12976 of mixed case chars and digits. This can pose a problem as some clients
12977 (such as Windows for Workgroups) uppercase the password before sending
12990 > parameter is set to <CODE
12994 > then this program is called <SPAN
13001 before the SMB password in the <A
13002 HREF="smbpasswd.5.html"
13006 > file is changed. If this UNIX password change fails, then
13010 > will fail to change the SMB password also
13011 (this is by design).</P
13015 >unix password sync</VAR
13017 is set this parameter <SPAN
13021 >MUST USE ABSOLUTE PATHS</I
13030 > programs called, and must be examined
13031 for security implications. Note that by default <VAR
13041 HREF="#UNIXPASSWORDSYNC"
13051 >passwd program = /bin/passwd</B
13056 >passwd program = /sbin/npasswd %u</B
13062 NAME="PASSWORDLEVEL"
13064 >>password level (G)</DT
13067 >Some client/server combinations have difficulty
13068 with mixed-case passwords. One offending client is Windows for
13069 Workgroups, which for some reason forces passwords to upper
13070 case when using the LANMAN1 protocol, but leaves them alone when
13071 using COREPLUS! Another problem child is the Windows 95/98
13072 family of operating systems. These clients upper case clear
13073 text passwords even when NT LM 0.12 selected by the protocol
13074 negotiation request/response.</P
13076 >This parameter defines the maximum number of characters
13077 that may be upper case in passwords.</P
13079 >For example, say the password given was "FRED". If <VAR
13081 > password level</VAR
13082 > is set to 1, the following combinations
13083 would be tried if "FRED" failed:</P
13085 >"Fred", "fred", "fRed", "frEd","freD"</P
13089 >password level</VAR
13091 the following combinations would also be tried: </P
13093 >"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..</P
13097 >The higher value this parameter is set to the more likely
13098 it is that a mixed case password will be matched against a single
13099 case password. However, you should be aware that use of this
13100 parameter reduces security and increases the time taken to
13101 process a new connection.</P
13103 >A value of zero will cause only two attempts to be
13104 made - the password as is and the password in all-lower case.</P
13108 >password level = 0</B
13113 >password level = 4</B
13118 NAME="PASSWORDSERVER"
13120 >>password server (G)</DT
13123 >By specifying the name of another SMB server (such
13124 as a WinNT box) with this option, and using <B
13130 >security = server</B
13131 > you can get Samba
13132 to do all its username/password validation via a remote server.</P
13134 >This option sets the name of the password server to use.
13135 It must be a NetBIOS name, so if the machine's NetBIOS name is
13136 different from its Internet name then you may have to add its NetBIOS
13137 name to the lmhosts file which is stored in the same directory
13143 >The name of the password server is looked up using the
13145 HREF="#NAMERESOLVEORDER"
13151 > and so may resolved
13152 by any method and order described in that parameter.</P
13154 >The password server much be a machine capable of using
13155 the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
13156 user level security mode.</P
13164 > Using a password server
13165 means your UNIX box (running Samba) is only as secure as your
13166 password server. <SPAN
13170 >DO NOT CHOOSE A PASSWORD SERVER THAT
13171 YOU DON'T COMPLETELY TRUST</I
13175 >Never point a Samba server at itself for password
13176 serving. This will cause a loop and could lock up your Samba
13179 >The name of the password server takes the standard
13180 substitutions, but probably the only useful one is <VAR
13184 >, which means the Samba server will use the incoming
13185 client as the password server. If you use this then you better
13186 trust your clients, and you had better restrict them with hosts allow!</P
13191 > parameter is set to
13195 >, then the list of machines in this
13196 option must be a list of Primary or Backup Domain controllers for the
13197 Domain or the character '*', as the Samba server is effectively
13198 in that domain, and will use cryptographically authenticated RPC calls
13199 to authenticate the user logging on. The advantage of using <B
13201 > security = domain</B
13202 > is that if you list several hosts in the
13205 >password server</VAR
13210 > will try each in turn till it finds one that responds. This
13211 is useful in case your primary server goes down.</P
13215 >password server</VAR
13217 to the character '*', then Samba will attempt to auto-locate the
13218 Primary or Backup Domain controllers to authenticate against by
13219 doing a query for the name <CODE
13221 >WORKGROUP<1C></CODE
13223 and then contacting each server returned in the list of IP
13224 addresses from the name resolution source. </P
13226 >If the list of servers contains both names and the '*'
13227 character, the list is treated as a list of preferred
13228 domain controllers, but an auto lookup of all remaining DC's
13229 will be added to the list as well. Samba will not attempt to optimize
13230 this list by locating the closest DC.</P
13239 >, then there are different
13240 restrictions that <B
13242 >security = domain</B
13250 >You may list several password servers in
13253 >password server</VAR
13254 > parameter, however if an
13258 > makes a connection to a password server,
13259 and then the password server fails, no more users will be able
13260 to be authenticated from this <B
13264 restriction of the SMB/CIFS protocol when in <B
13268 > mode and cannot be fixed in Samba.</P
13272 >If you are using a Windows NT server as your
13273 password server then you will have to ensure that your users
13274 are able to login from the Samba server, as when in <B
13276 > security = server</B
13277 > mode the network logon will appear to
13278 come from there rather than from the users workstation.</P
13293 >password server = <empty string></B
13299 >password server = NT-PDC, NT-BDC1, NT-BDC2, *
13305 >password server = *</B
13315 >This parameter specifies a directory to which
13316 the user of the service is to be given access. In the case of
13317 printable services, this is where print data will spool prior to
13318 being submitted to the host for printing.</P
13320 >For a printable service offering guest access, the service
13321 should be readonly and the path should be world-writeable and
13322 have the sticky bit set. This is not mandatory of course, but
13323 you probably won't get the results you expect if you do
13326 >Any occurrences of <VAR
13330 will be replaced with the UNIX username that the client is using
13331 on this connection. Any occurrences of <VAR
13335 will be replaced by the NetBIOS name of the machine they are
13336 connecting from. These replacements are very useful for setting
13337 up pseudo home directories for users.</P
13339 >Note that this path will be based on <A
13345 > if one was specified.</P
13357 >path = /home/fred</B
13362 NAME="PIDDIRECTORY"
13364 >>pid directory (G)</DT
13367 >This option specifies the directory where pid
13368 files will be placed. </P
13372 >pid directory = ${prefix}/var/locks</B
13377 >pid directory = /var/run/</B
13383 NAME="POSIXLOCKING"
13385 >>posix locking (S)</DT
13389 CLASS="CITEREFENTRY"
13391 CLASS="REFENTRYTITLE"
13395 daemon maintains an database of file locks obtained by SMB clients.
13396 The default behavior is to map this internal database to POSIX
13397 locks. This means that file locks obtained by SMB clients are
13398 consistent with those seen by POSIX compliant applications accessing
13399 the files via a non-SMB method (e.g. NFS or local file access).
13400 You should never need to disable this parameter.</P
13404 >posix locking = yes</B
13411 >>postexec (S)</DT
13414 >This option specifies a command to be run
13415 whenever the service is disconnected. It takes the usual
13416 substitutions. The command may be run as the root on some
13419 >An interesting example may be to unmount server
13424 >postexec = /etc/umount /cdrom</B
13440 >none (no command executed)</I
13447 >postexec = echo \"%u disconnected from %S
13448 from %m (%I)\" >> /tmp/log</B
13455 >>preexec (S)</DT
13458 >This option specifies a command to be run whenever
13459 the service is connected to. It takes the usual substitutions.</P
13461 >An interesting example is to send the users a welcome
13462 message every time they log in. Maybe a message of the day? Here
13467 >preexec = csh -c 'echo \"Welcome to %S!\" |
13468 /usr/local/samba/bin/smbclient -M %m -I %I' & </B
13471 >Of course, this could get annoying after a while :-)</P
13474 HREF="#PREEXECCLOSE"
13493 >none (no command executed)</I
13499 >preexec = echo \"%u connected to %S from %m
13500 (%I)\" >> /tmp/log</B
13505 NAME="PREEXECCLOSE"
13507 >>preexec close (S)</DT
13510 >This boolean option controls whether a non-zero
13511 return code from <A
13518 > should close the service being connected to.</P
13522 >preexec close = no</B
13527 NAME="PREFERREDMASTER"
13529 >>preferred master (G)</DT
13532 >This boolean parameter controls if <A
13536 > is a preferred master browser
13537 for its workgroup.</P
13539 >If this is set to <CODE
13546 will force an election, and it will have a slight advantage in
13547 winning the election. It is recommended that this parameter is
13548 used in conjunction with <B
13551 HREF="#DOMAINMASTER"
13554 > domain master</VAR
13560 > can guarantee becoming a domain master.</P
13562 >Use this option with caution, because if there are several
13563 hosts (whether Samba servers, Windows 95 or NT) that are preferred
13564 master browsers on the same subnet, they will each periodically
13565 and continuously attempt to become the local master browser.
13566 This will result in unnecessary broadcast traffic and reduced browsing
13580 >preferred master = auto</B
13585 NAME="PREFEREDMASTER"
13587 >>prefered master (G)</DT
13591 HREF="#PREFERREDMASTER"
13594 > preferred master</VAR
13596 > for people who cannot spell :-).</P
13602 >>preload (G)</DT
13605 >This is a list of services that you want to be
13606 automatically added to the browse lists. This is most useful
13607 for homes and printers services that would otherwise not be
13610 >Note that if you just want all printers in your
13611 printcap file loaded then the <A
13612 HREF="#LOADPRINTERS"
13615 >load printers</VAR
13617 > option is easier.</P
13623 >no preloaded services</I
13629 >preload = fred lp colorlp</B
13634 NAME="PRESERVECASE"
13636 >>preserve case (S)</DT
13639 > This controls if new filenames are created
13640 with the case that the client passes, or if they are forced to
13642 HREF="#DEFAULTCASE"
13652 >preserve case = yes</B
13655 >See the section on <A
13659 > for a fuller discussion.</P
13663 NAME="PRINTCOMMAND"
13665 >>print command (S)</DT
13668 >After a print job has finished spooling to
13669 a service, this command will be used via a <B
13673 call to process the spool file. Typically the command specified will
13674 submit the spool file to the host's printing subsystem, but there
13675 is no requirement that this be the case. The server will not remove
13676 the spool file, so whatever command you specify should remove the
13677 spool file when it has been processed, otherwise you will need to
13678 manually remove old spool files.</P
13680 >The print command is simply a text string. It will be used
13681 verbatim after macro substitutions have been made:</P
13683 >s, %p - the path to the spool
13686 >%p - the appropriate printer
13690 name as transmitted by the client.</P
13692 >%c - The number of printed pages
13693 of the spooled job (if known).</P
13695 >%z - the size of the spooled
13696 print job (in bytes)</P
13698 >The print command <SPAN
13705 one occurrence of <VAR
13715 > is optional. At the time
13716 a job is submitted, if no printer name is supplied the <VAR
13720 > will be silently removed from the printer command.</P
13722 >If specified in the [global] section, the print command given
13723 will be used for any printable service that does not have its own
13724 print command specified.</P
13726 >If there is neither a specified print command for a
13727 printable service nor a global print command, spool files will
13728 be created but not processed and (most importantly) not removed.</P
13730 >Note that printing may fail on some UNIXes from the
13734 > account. If this happens then create
13735 an alternative guest account that can print and set the <A
13736 HREF="#GUESTACCOUNT"
13739 >guest account</VAR
13742 in the [global] section.</P
13744 >You can form quite complex print commands by realizing
13745 that they are just passed to a shell. For example the following
13746 will log a print job, print the file, then remove it. Note that
13747 ';' is the usual separator for command in shell scripts.</P
13751 >print command = echo Printing %s >>
13752 /tmp/print.log; lpr -P %p %s; rm %s</B
13755 >You may have to vary this command considerably depending
13756 on how you normally print files on your system. The default for
13757 the parameter varies depending on the setting of the <A
13767 >printing = BSD, AIX, QNX, LPRNG
13773 >print command = lpr -r -P%p %s</B
13778 >printing = SYSV or HPUX :</B
13783 >print command = lp -c -d%p %s; rm %s</B
13788 >printing = SOFTQ :</B
13793 >print command = lp -d%p -s %s; rm %s</B
13796 >For printing = CUPS : If SAMBA is compiled against
13799 >printcap = cups</A
13801 uses the CUPS API to
13802 submit jobs, etc. Otherwise it maps to the System V
13803 commands with the -oraw option for printing, i.e. it
13806 >lp -c -d%p -oraw; rm %s</B
13810 >printing = cups</B
13812 and if SAMBA is compiled against libcups, any manually
13813 set print command will be ignored.</P
13817 >print command = /usr/local/samba/bin/myprintscript
13825 >>print ok (S)</DT
13840 >>printable (S)</DT
13843 >If this parameter is <CODE
13847 clients may open, write to and submit spool files on the directory
13848 specified for the service. </P
13850 >Note that a printable service will ALWAYS allow writing
13851 to the service path (user privileges permitting) via the spooling
13852 of print data. The <A
13859 > parameter controls only non-printing access to
13871 >>printcap (G)</DT
13875 HREF="#PRINTCAPNAME"
13878 > printcap name</VAR
13884 NAME="PRINTCAPNAME"
13886 >>printcap name (G)</DT
13889 >This parameter may be used to override the
13890 compiled-in default printcap name used by the server (usually <TT
13892 > /etc/printcap</TT
13893 >). See the discussion of the <A
13896 > section above for reasons
13897 why you might want to do this.</P
13899 >To use the CUPS printing interface set <B
13901 >printcap name = cups
13903 >. This should be supplemented by an addtional setting
13906 >printing = cups</A
13910 >printcap name = cups</B
13912 "dummy" printcap created by CUPS, as specified in your CUPS
13913 configuration file.
13916 >On System V systems that use <B
13920 list available printers you can use <B
13922 >printcap name = lpstat
13924 > to automatically obtain lists of available printers. This
13925 is the default for systems that define SYSV at configure time in
13926 Samba (this includes most System V based systems). If <VAR
13928 > printcap name</VAR
13933 these systems then Samba will launch <B
13937 attempt to parse the output to obtain a printer list.</P
13939 >A minimal printcap file would look something like this:</P
13942 CLASS="PROGRAMLISTING"
13943 >print1|My Printer 1
13944 print2|My Printer 2
13945 print3|My Printer 3
13946 print4|My Printer 4
13947 print5|My Printer 5</PRE
13950 >where the '|' separates aliases of a printer. The fact
13951 that the second alias has a space in it gives a hint to Samba
13952 that it's a comment.</P
13960 >: Under AIX the default printcap
13964 >. Samba will assume the
13968 > format if the string
13972 > appears in the printcap filename.</P
13976 >printcap name = /etc/printcap</B
13981 >printcap name = /etc/myprintcap</B
13986 NAME="PRINTERADMIN"
13988 >>printer admin (S)</DT
13991 >This is a list of users that can do anything to
13992 printers via the remote administration interfaces offered by MS-RPC
13993 (usually using a NT workstation). Note that the root user always
13994 has admin rights.</P
13998 >printer admin = <empty string></B
14004 >printer admin = admin, @staff</B
14011 >>printer name (S)</DT
14014 >This parameter specifies the name of the printer
14015 to which print jobs spooled through a printable service will be sent.</P
14017 >If specified in the [global] section, the printer
14018 name given will be used for any printable service that does
14019 not have its own printer name specified.</P
14025 >none (but may be <CODE
14029 on many systems)</I
14035 >printer name = laserwriter</B
14042 >>printer (S)</DT
14046 HREF="#PRINTERNAME"
14049 > printer name</VAR
14057 >>printing (S)</DT
14060 >This parameters controls how printer status
14061 information is interpreted on your system. It also affects the
14062 default values for the <VAR
14064 >print command</VAR
14075 >lpresume command</VAR
14080 > if specified in the
14081 [global] section.</P
14083 >Currently nine printing styles are supported. They are
14117 >To see what the defaults are for the other print
14118 commands when using the various options use the <A
14119 HREF="testparm.1.html"
14124 >This option can be set on a per printer basis</P
14126 >See also the discussion in the <A
14135 >>private dir (G)</DT
14138 >This parameters defines the directory
14139 smbd will use for storing such files as <TT
14151 >private dir = ${prefix}/private</B
14158 >>protocol (G)</DT
14162 HREF="#MAXPROTOCOL"
14173 >>public (S)</DT
14187 NAME="QUEUEPAUSECOMMAND"
14189 >>queuepause command (S)</DT
14192 >This parameter specifies the command to be
14193 executed on the server host in order to pause the printer queue.</P
14195 >This command should be a program or script which takes
14196 a printer name as its only parameter and stops the printer queue,
14197 such that no longer jobs are submitted to the printer.</P
14199 >This command is not supported by Windows for Workgroups,
14200 but can be issued from the Printers window under Windows 95
14206 > is given then the printer name
14207 is put in its place. Otherwise it is placed at the end of the command.
14210 >Note that it is good practice to include the absolute
14211 path in the command as the PATH may not be available to the
14218 >depends on the setting of <VAR
14228 >queuepause command = disable %p</B
14233 NAME="QUEUERESUMECOMMAND"
14235 >>queueresume command (S)</DT
14238 >This parameter specifies the command to be
14239 executed on the server host in order to resume the printer queue. It
14240 is the command to undo the behavior that is caused by the
14241 previous parameter (<A
14242 HREF="#QUEUEPAUSECOMMAND"
14245 > queuepause command</VAR
14249 >This command should be a program or script which takes
14250 a printer name as its only parameter and resumes the printer queue,
14251 such that queued jobs are resubmitted to the printer.</P
14253 >This command is not supported by Windows for Workgroups,
14254 but can be issued from the Printers window under Windows 95
14260 > is given then the printer name
14261 is put in its place. Otherwise it is placed at the end of the
14264 >Note that it is good practice to include the absolute
14265 path in the command as the PATH may not be available to the
14272 >depends on the setting of <A
14285 >queuepause command = enable %p
14293 >>read bmpx (G)</DT
14296 >This boolean parameter controls whether <A
14300 > will support the "Read
14301 Block Multiplex" SMB. This is now rarely used and defaults to
14305 >. You should never need to set this
14317 >>read list (S)</DT
14320 >This is a list of users that are given read-only
14321 access to a service. If the connecting user is in this list then
14322 they will not be given write access, no matter what the <A
14329 option is set to. The list can include group names using the
14330 syntax described in the <A
14331 HREF="#INVALIDUSERS"
14334 > invalid users</VAR
14344 > parameter and the <A
14345 HREF="#INVALIDUSERS"
14348 >invalid users</VAR
14355 >read list = <empty string></B
14360 >read list = mary, @students</B
14367 >>read only (S)</DT
14370 >An inverted synonym is <A
14378 >If this parameter is <CODE
14382 of a service may not create or modify files in the service's
14385 >Note that a printable service (<B
14387 >printable = yes</B
14395 > allow writing to the directory
14396 (user privileges permitting), but only via spooling operations.</P
14400 >read only = yes</B
14407 >>read raw (G)</DT
14410 >This parameter controls whether or not the server
14411 will support the raw read SMB requests when transferring data
14414 >If enabled, raw reads allow reads of 65535 bytes in
14415 one packet. This typically provides a major performance benefit.
14418 >However, some clients either negotiate the allowable
14419 block size incorrectly or are incapable of supporting larger block
14420 sizes, and for these clients you may need to disable raw reads.</P
14422 >In general this parameter should be viewed as a system tuning
14423 tool and left severely alone. See also <A
14440 >>read size (G)</DT
14447 affects the overlap of disk reads/writes with network reads/writes.
14448 If the amount of data being transferred in several of the SMB
14449 commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger
14450 than this value then the server begins writing the data before it
14451 has received the whole packet from the network, or in the case of
14452 SMBreadbraw, it begins writing to the network before all the data
14453 has been read from disk.</P
14455 >This overlapping works best when the speeds of disk and
14456 network access are similar, having very little effect when the
14457 speed of one is much greater than the other.</P
14459 >The default value is 16384, but very little experimentation
14460 has been done yet to determine the optimal value, and it is likely
14461 that the best value will vary greatly between systems anyway.
14462 A value over 65536 is pointless and will cause you to allocate
14463 memory unnecessarily.</P
14467 >read size = 16384</B
14472 >read size = 8192</B
14479 >>realm (G)</DT
14482 > This option specifies the kerberos realm to use. The realm is
14483 used as the ADS equivalent of the NT4<B
14487 is usually set to the DNS name of the kerberos server.
14497 >realm = mysambabox.mycompany.com</B
14502 NAME="REMOTEANNOUNCE"
14504 >>remote announce (G)</DT
14507 >This option allows you to setup <A
14511 > to periodically announce itself
14512 to arbitrary IP addresses with an arbitrary workgroup name.</P
14514 >This is useful if you want your Samba server to appear
14515 in a remote workgroup for which the normal browse propagation
14516 rules don't work. The remote workgroup can be anywhere that you
14517 can send IP packets to.</P
14523 >remote announce = 192.168.2.255/SERVERS
14524 192.168.4.255/STAFF</B
14527 >the above line would cause <B
14530 > to announce itself
14531 to the two given IP addresses using the given workgroup names.
14532 If you leave out the workgroup name then the one given in
14540 parameter is used instead.</P
14542 >The IP addresses you choose would normally be the broadcast
14543 addresses of the remote networks, but can also be the IP addresses
14544 of known browse masters if your network config is that stable.</P
14546 >See the documentation file <A
14547 HREF="improved-browsing.html"
14558 >remote announce = <empty string>
14564 NAME="REMOTEBROWSESYNC"
14566 >>remote browse sync (G)</DT
14569 >This option allows you to setup <A
14573 > to periodically request
14574 synchronization of browse lists with the master browser of a Samba
14575 server that is on a remote segment. This option will allow you to
14576 gain browse lists for multiple workgroups across routed networks. This
14577 is done in a manner that does not work with any non-Samba servers.</P
14579 >This is useful if you want your Samba server and all local
14580 clients to appear in a remote workgroup for which the normal browse
14581 propagation rules don't work. The remote workgroup can be anywhere
14582 that you can send IP packets to.</P
14588 >remote browse sync = 192.168.2.255 192.168.4.255
14592 >the above line would cause <B
14596 the master browser on the specified subnets or addresses to
14597 synchronize their browse lists with the local server.</P
14599 >The IP addresses you choose would normally be the broadcast
14600 addresses of the remote networks, but can also be the IP addresses
14601 of known browse masters if your network config is that stable. If
14602 a machine IP address is given Samba makes NO attempt to validate
14603 that the remote machine is available, is listening, nor that it
14604 is in fact the browse master on its segment.</P
14608 >remote browse sync = <empty string>
14614 NAME="RESTRICTANONYMOUS"
14616 >>restrict anonymous (G)</DT
14619 >This is a integer parameter, and
14620 mirrors as much as possible the functinality the
14623 >RestrictAnonymous</CODE
14625 registry key does on NT/Win2k. </P
14629 >restrict anonymous = 0</B
14640 HREF="#ROOTDIRECTORY"
14643 >root directory"</VAR
14651 >>root dir (G)</DT
14655 HREF="#ROOTDIRECTORY"
14658 >root directory"</VAR
14664 NAME="ROOTDIRECTORY"
14666 >>root directory (G)</DT
14669 >The server will <B
14673 Change its root directory) to this directory on startup. This is
14674 not strictly necessary for secure operation. Even without it the
14675 server will deny access to files not in one of the service entries.
14676 It may also check for, and deny access to, soft links to other
14677 parts of the filesystem, or attempts to use ".." in file names
14678 to access other directories (depending on the setting of the <A
14689 >root directory</VAR
14691 than "/" adds an extra level of security, but at a price. It
14692 absolutely ensures that no access is given to files not in the
14693 sub-tree specified in the <VAR
14695 >root directory</VAR
14703 > some files needed for
14704 complete operation of the server. To maintain full operability
14705 of the server you will need to mirror some system files
14708 >root directory</VAR
14709 > tree. In particular
14710 you will need to mirror <TT
14714 subset of it), and any binaries or configuration files needed for
14715 printing (if required). The set of files that must be mirrored is
14716 operating system dependent.</P
14720 >root directory = /</B
14725 >root directory = /homes/smb</B
14730 NAME="ROOTPOSTEXEC"
14732 >>root postexec (S)</DT
14735 >This is the same as the <VAR
14739 parameter except that the command is run as root. This
14740 is useful for unmounting filesystems
14741 (such as CDROMs) after a connection is closed.</P
14753 >root postexec = <empty string>
14761 >>root preexec (S)</DT
14764 >This is the same as the <VAR
14768 parameter except that the command is run as root. This
14769 is useful for mounting filesystems (such as CDROMs) when a
14770 connection is opened.</P
14779 HREF="#PREEXECCLOSE"
14782 >preexec close</VAR
14788 >root preexec = <empty string>
14794 NAME="ROOTPREEXECCLOSE"
14796 >>root preexec close (S)</DT
14799 >This is the same as the <VAR
14803 > parameter except that the command is run as root.</P
14812 HREF="#PREEXECCLOSE"
14815 >preexec close</VAR
14821 >root preexec close = no</B
14828 >>security (G)</DT
14831 >This option affects how clients respond to
14832 Samba and is one of the most important settings in the <TT
14837 >The option sets the "security mode bit" in replies to
14838 protocol negotiations with <SPAN
14839 CLASS="CITEREFENTRY"
14841 CLASS="REFENTRYTITLE"
14844 > to turn share level security on or off. Clients decide
14845 based on this bit whether (and how) to transfer user and password
14846 information to the server.</P
14850 >security = user</B
14852 the most common setting needed when talking to Windows 98 and
14855 >The alternatives are <B
14857 >security = share</B
14861 >security = server</B
14868 >In versions of Samba prior to 2.0.0, the default was
14871 >security = share</B
14872 > mainly because that was
14873 the only option at one stage.</P
14875 >There is a bug in WfWg that has relevance to this
14876 setting. When in user or server level security a WfWg client
14877 will totally ignore the password you type in the "connect
14878 drive" dialog box. This makes it very difficult (if not impossible)
14879 to connect to a Samba service as anyone except the user that
14880 you are logged into WfWg as.</P
14882 >If your PCs use usernames that are the same as their
14883 usernames on the UNIX machine then you will want to use
14886 >security = user</B
14887 >. If you mostly use usernames
14888 that don't exist on the UNIX box then use <B
14894 >You should also use <B
14896 >security = share</B
14898 want to mainly setup shares without a password (guest shares). This
14899 is commonly used for a shared printer server. It is more difficult
14900 to setup guest shares with <B
14902 >security = user</B
14911 >parameter for details.</P
14913 >It is possible to use <B
14922 > where it is offers both user and share
14923 level security under different <A
14924 HREF="#NETBIOSALIASES"
14927 >NetBIOS aliases</VAR
14931 >The different settings will now be explained.</P
14934 NAME="SECURITYEQUALSSHARE"
14945 >When clients connect to a share level security server they
14946 need not log onto the server with a valid username and password before
14947 attempting to connect to a shared resource (although modern clients
14948 such as Windows 95/98 and Windows NT will send a logon request with
14949 a username but no password when talking to a <B
14953 > server). Instead, the clients send authentication information
14954 (passwords) on a per-share basis, at the time they attempt to connect
14967 uses a valid UNIX user to act on behalf of the client, even in
14970 >security = share</B
14971 > level security.</P
14973 >As clients are not required to send a username to the server
14974 in share level security, <B
14978 techniques to determine the correct UNIX user to use on behalf
14981 >A list of possible UNIX usernames to match with the given
14982 client password is constructed using the following methods :</P
14995 > parameter is set, then all the other
14996 stages are missed and only the <A
14997 HREF="#GUESTACCOUNT"
15000 >guest account</VAR
15002 > username is checked.
15007 >Is a username is sent with the share connection
15008 request, then this username (after mapping - see <A
15009 HREF="#USERNAMEMAP"
15015 is added as a potential username.</P
15019 >If the client did a previous <SPAN
15026 > request (the SessionSetup SMB call) then the
15027 username sent in this SMB will be added as a potential username.
15032 >The name of the service the client requested is
15033 added as a potential username.</P
15037 >The NetBIOS name of the client is added to
15038 the list as a potential username.</P
15042 >Any users on the <A
15048 > list are added as potential usernames.
15057 not set, then this list is then tried with the supplied password.
15058 The first user for whom the password matches will be used as the
15065 set, or no username can be determined then if the share is marked
15066 as available to the <VAR
15068 >guest account</VAR
15070 guest user will be used, otherwise access is denied.</P
15072 >Note that it can be <SPAN
15079 in share-level security as to which UNIX username will eventually
15080 be used in granting access.</P
15082 >See also the section <A
15084 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15088 NAME="SECURITYEQUALSUSER"
15099 >This is the default security setting in Samba 3.0.
15100 With user-level security a client must first "log-on" with a
15101 valid username and password (which can be mapped using the <A
15102 HREF="#USERNAMEMAP"
15108 parameter). Encrypted passwords (see the <A
15109 HREF="#ENCRYPTPASSWORDS"
15112 >encrypted passwords</VAR
15114 > parameter) can also
15115 be used in this security mode. Parameters such as <A
15127 > if set are then applied and
15128 may change the UNIX user to use on this connection, but only after
15129 the user has been successfully authenticated.</P
15137 > that the name of the resource being
15144 > sent to the server until after
15145 the server has successfully authenticated the client. This is why
15146 guest shares don't work in user level security without allowing
15147 the server to automatically map unknown users into the <A
15148 HREF="#GUESTACCOUNT"
15151 >guest account</VAR
15161 > parameter for details on doing this.</P
15163 >See also the section <A
15165 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15169 NAME="SECURITYEQUALSDOMAIN"
15181 >This mode will only work correctly if <SPAN
15182 CLASS="CITEREFENTRY"
15184 CLASS="REFENTRYTITLE"
15187 > has been used to add this
15188 machine into a Windows NT Domain. It expects the <A
15189 HREF="#ENCRYPTPASSWORDS"
15192 >encrypted passwords</VAR
15195 > parameter to be set to <CODE
15199 mode Samba will try to validate the username/password by passing
15200 it to a Windows NT Primary or Backup Domain Controller, in exactly
15201 the same way that a Windows NT Server would do.</P
15209 > that a valid UNIX user must still
15210 exist as well as the account on the Domain Controller to allow
15211 Samba to have a valid UNIX account to map file access to.</P
15219 > that from the client's point
15222 >security = domain</B
15223 > is the same as <B
15227 >. It only affects how the server deals with the authentication,
15228 it does not in any way affect what the client sees.</P
15236 > that the name of the resource being
15243 > sent to the server until after
15244 the server has successfully authenticated the client. This is why
15245 guest shares don't work in user level security without allowing
15246 the server to automatically map unknown users into the <A
15247 HREF="#GUESTACCOUNT"
15250 >guest account</VAR
15260 > parameter for details on doing this.</P
15262 >See also the section <A
15264 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15268 HREF="#PASSWORDSERVER"
15274 > parameter and the <A
15275 HREF="#ENCRYPTPASSWORDS"
15278 >encrypted passwords</VAR
15284 NAME="SECURITYEQUALSSERVER"
15295 >In this mode Samba will try to validate the username/password
15296 by passing it to another SMB server, such as an NT box. If this
15297 fails it will revert to <B
15301 >. It expects the <A
15302 HREF="#ENCRYPTPASSWORDS"
15305 >encrypted passwords</VAR
15308 > parameter to be set to
15312 >, unless the remote server
15313 does not support them. However note
15314 that if encrypted passwords have been negotiated then Samba cannot
15315 revert back to checking the UNIX password file, it must have a valid
15319 > file to check users against. See the
15320 documentation file in the <TT
15326 >ENCRYPTION.txt</TT
15327 > for details on how to set this
15336 > this mode of operation
15337 has significant pitfalls, due to the fact that is
15338 activly initiates a man-in-the-middle attack on the
15339 remote SMB server. In particular, this mode of
15340 operation can cause significant resource consuption on
15341 the PDC, as it must maintain an active connection for
15342 the duration of the user's session. Furthermore, if
15343 this connection is lost, there is no way to
15344 reestablish it, and futher authenticaions to the Samba
15345 server may fail. (From a single client, till it
15354 > that from the client's point of
15357 >security = server</B
15358 > is the same as <B
15360 > security = user</B
15361 >. It only affects how the server deals
15362 with the authentication, it does not in any way affect what the
15371 > that the name of the resource being
15378 > sent to the server until after
15379 the server has successfully authenticated the client. This is why
15380 guest shares don't work in user level security without allowing
15381 the server to automatically map unknown users into the <A
15382 HREF="#GUESTACCOUNT"
15385 >guest account</VAR
15395 > parameter for details on doing this.</P
15397 >See also the section <A
15399 > NOTE ABOUT USERNAME/PASSWORD VALIDATION</A
15403 HREF="#PASSWORDSERVER"
15409 > parameter and the <A
15410 HREF="#ENCRYPTPASSWORDS"
15413 >encrypted passwords</VAR
15420 >security = USER</B
15425 >security = DOMAIN</B
15430 NAME="SECURITYMASK"
15432 >>security mask (S)</DT
15435 >This parameter controls what UNIX permission
15436 bits can be modified when a Windows NT client is manipulating
15437 the UNIX permission on a file using the native NT security
15440 >This parameter is applied as a mask (AND'ed with) to
15441 the changed permission bits, thus preventing any bits not in
15442 this mask from being modified. Essentially, zero bits in this
15443 mask may be treated as a set of bits the user is not allowed
15446 >If not set explicitly this parameter is 0777, allowing
15447 a user to modify all the user/group/world permissions on a file.
15456 > that users who can access the
15457 Samba server through other means can easily bypass this
15458 restriction, so it is primarily useful for standalone
15459 "appliance" systems. Administrators of most normal systems will
15460 probably want to leave it set to <CODE
15466 HREF="#FORCEDIRECTORYSECURITYMODE"
15469 >force directory security mode</VAR
15473 HREF="#DIRECTORYSECURITYMASK"
15480 HREF="#FORCESECURITYMODE"
15483 >force security mode</VAR
15489 >security mask = 0777</B
15494 >security mask = 0770</B
15499 NAME="SERVERSTRING"
15501 >>server string (G)</DT
15504 >This controls what string will show up in the
15505 printer comment box in print manager and next to the IPC connection
15509 >. It can be any string that you wish
15510 to show to your users.</P
15512 >It also sets what will appear in browse lists next
15513 to the machine name.</P
15518 > will be replaced with the Samba
15524 > will be replaced with the
15529 >server string = Samba %v</B
15534 >server string = University of GNUs Samba
15540 NAME="SETDIRECTORY"
15542 >>set directory (S)</DT
15547 >set directory = no</B
15549 users of the service may not use the setdir command to change
15555 > command is only implemented
15556 in the Digital Pathworks client. See the Pathworks documentation
15561 >set directory = no</B
15568 >>share modes (S)</DT
15571 >This enables or disables the honoring of
15575 > during a file open. These
15576 modes are used by clients to gain exclusive read or write access
15579 >These open modes are not directly supported by UNIX, so
15580 they are simulated using shared memory, or lock files if your
15581 UNIX doesn't support shared memory (almost all do).</P
15583 >The share modes that are enabled by this option are
15607 >This option gives full share compatibility and enabled
15616 > turn this parameter
15617 off as many Windows applications will break if you do so.</P
15621 >share modes = yes</B
15626 NAME="SHORTPRESERVECASE"
15628 >>short preserve case (S)</DT
15631 >This boolean parameter controls if new files
15632 which conform to 8.3 syntax, that is all in upper case and of
15633 suitable length, are created upper case, or if they are forced
15635 HREF="#DEFAULTCASE"
15641 >. This option can be use with <A
15642 HREF="#PRESERVECASE"
15645 >preserve case = yes</B
15648 > to permit long filenames to retain their case, while short
15649 names are lowered. </P
15651 >See the section on <A
15658 >short preserve case = yes</B
15663 NAME="SHOWADDPRINTERWIZARD"
15665 >>show add printer wizard (G)</DT
15668 >With the introduction of MS-RPC based printing support
15669 for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
15670 appear on Samba hosts in the share listing. Normally this folder will
15671 contain an icon for the MS Add Printer Wizard (APW). However, it is
15672 possible to disable this feature regardless of the level of privilege
15673 of the connected user.</P
15675 >Under normal circumstances, the Windows NT/2000 client will
15676 open a handle on the printer server with OpenPrinterEx() asking for
15677 Administrator privileges. If the user does not have administrative
15678 access on the print server (i.e is not root or a member of the
15681 >printer admin</VAR
15682 > group), the OpenPrinterEx()
15683 call fails and the client makes another open call with a request for
15684 a lower privilege level. This should succeed, however the APW
15685 icon will not be displayed.</P
15687 >Disabling the <VAR
15689 >show add printer wizard</VAR
15691 parameter will always cause the OpenPrinterEx() on the server
15692 to fail. Thus the APW icon will never be displayed. <SPAN
15698 >This does not prevent the same user from having
15699 administrative privilege on an individual printer.</P
15702 HREF="#ADDPRINTERCOMMAND"
15709 HREF="#DELETEPRINTERCOMMAND"
15712 >deleteprinter command</VAR
15715 HREF="#PRINTERADMIN"
15718 >printer admin</VAR
15724 >show add printer wizard = yes</B
15729 NAME="SHUTDOWNSCRIPT"
15731 >>shutdown script (G)</DT
15738 >This parameter only exists in the HEAD cvs branch</I
15741 This a full path name to a script called by
15750 should start a shutdown procedure.</P
15752 >This command will be run as the user connected to the
15755 >%m %t %r %f parameters are expanded</P
15760 > will be substituted with the
15761 shutdown message sent to the server.</P
15766 > will be substituted with the
15767 number of seconds to wait before effectively starting the
15768 shutdown procedure.</P
15773 > will be substituted with the
15780 >. It means reboot after shutdown
15787 > will be substituted with the
15794 >. It means force the shutdown
15795 even if applications do not respond for NT.</P
15807 >abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f</B
15810 >Shutdown script example:
15812 CLASS="PROGRAMLISTING"
15819 /sbin/shutdown $3 $4 +$time $1 &</PRE
15821 Shutdown does not return so we need to launch it in background.
15825 HREF="#ABORTSHUTDOWNSCRIPT"
15828 >abort shutdown script</VAR
15834 NAME="SMBPASSWDFILE"
15836 >>smb passwd file (G)</DT
15839 >This option sets the path to the encrypted
15840 smbpasswd file. By default the path to the smbpasswd file
15841 is compiled into Samba.</P
15845 >smb passwd file = ${prefix}/private/smbpasswd
15851 >smb passwd file = /etc/samba/smbpasswd
15859 >>smb ports (G)</DT
15862 >Specifies which ports the server should listen on
15868 >smb ports = 445 139</B
15873 NAME="SOCKETADDRESS"
15875 >>socket address (G)</DT
15878 >This option allows you to control what
15879 address Samba will listen for connections on. This is used to
15880 support multiple virtual interfaces on the one server, each
15881 with a different configuration.</P
15883 >By default Samba will accept connections on any
15888 >socket address = 192.168.2.20</B
15894 NAME="SOCKETOPTIONS"
15896 >>socket options (G)</DT
15899 >This option allows you to set socket options
15900 to be used when talking with the client.</P
15902 >Socket options are controls on the networking layer
15903 of the operating systems which allow the connection to be
15906 >This option will typically be used to tune your Samba
15907 server for optimal performance for your local network. There is
15908 no way that Samba can know what the optimal parameters are for
15909 your net, so you must experiment and choose them yourself. We
15910 strongly suggest you read the appropriate documentation for your
15911 operating system first (perhaps <B
15917 >You may find that on some systems Samba will say
15918 "Unknown socket option" when you supply an option. This means you
15919 either incorrectly typed it or you need to add an include file
15920 to includes.h for your OS. If the latter is the case please
15921 send the patch to <A
15922 HREF="mailto:samba@samba.org"
15924 > samba@samba.org</A
15927 >Any of the supported socket options may be combined
15928 in any way you like, as long as your OS allows it.</P
15930 >This is the list of socket options currently settable
15931 using this option:</P
15957 >IPTOS_THROUGHPUT</P
15977 >Those marked with a <SPAN
15984 argument. The others can optionally take a 1 or 0 argument to enable
15985 or disable the option, by default they will be enabled if you
15986 don't specify 1 or 0.</P
15988 >To specify an argument use the syntax SOME_OPTION = VALUE
15991 >SO_SNDBUF = 8192</B
15992 >. Note that you must
15993 not have any spaces before or after the = sign.</P
15995 >If you are on a local network then a sensible option
16000 >socket options = IPTOS_LOWDELAY</B
16003 >If you have a local network then you could try:</P
16007 >socket options = IPTOS_LOWDELAY TCP_NODELAY</B
16010 >If you are on a wide area network then perhaps try
16011 setting IPTOS_THROUGHPUT. </P
16013 >Note that several of the options may cause your Samba
16014 server to fail completely. Use these options with caution!</P
16018 >socket options = TCP_NODELAY</B
16023 >socket options = IPTOS_LOWDELAY</B
16028 NAME="SOURCEENVIRONMENT"
16030 >>source environment (G)</DT
16033 >This parameter causes Samba to set environment
16034 variables as per the content of the file named.</P
16036 >If the value of this parameter starts with a "|" character
16037 then Samba will treat that value as a pipe command to open and
16038 will set the environment variables from the output of the pipe.</P
16040 >The contents of the file or the output of the pipe should
16041 be formatted as the output of the standard Unix <B
16045 > command. This is of the form :</P
16047 >Example environment entry:</P
16051 >SAMBA_NETBIOS_NAME = myhostname</B
16058 >No default value</I
16064 >source environment = |/etc/smb.conf.sh
16070 >source environment =
16071 /usr/local/smb_env_vars</B
16078 >>use spnego (G)</DT
16081 > This variable controls controls whether samba will try
16082 to use Simple and Protected NEGOciation (as specified by rfc2478) with
16083 WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism.
16084 Unless further issues are discovered with our SPNEGO
16085 implementation, there is no reason this should ever be
16092 >use spnego = yes</I
16100 >>stat cache (G)</DT
16103 >This parameter determines if <SPAN
16104 CLASS="CITEREFENTRY"
16106 CLASS="REFENTRYTITLE"
16109 > will use a cache in order to
16110 speed up case insensitive name mappings. You should never need
16111 to change this parameter.</P
16115 >stat cache = yes</B
16120 NAME="STATCACHESIZE"
16122 >>stat cache size (G)</DT
16125 >This parameter determines the number of
16126 entries in the <VAR
16130 never need to change this parameter.</P
16134 >stat cache size = 50</B
16139 NAME="STRICTALLOCATE"
16141 >>strict allocate (S)</DT
16144 >This is a boolean that controls the handling of
16145 disk space allocation in the server. When this is set to <CODE
16149 the server will change from UNIX behaviour of not committing real
16150 disk storage blocks when a file is extended to the Windows behaviour
16151 of actually forcing the disk system to allocate real storage blocks
16152 when a file is created or extended to be a given size. In UNIX
16153 terminology this means that Samba will stop creating sparse files.
16154 This can be slow on some systems.</P
16156 >When strict allocate is <CODE
16159 > the server does sparse
16160 disk block allocation when a file is extended.</P
16162 >Setting this to <CODE
16165 > can help Samba return
16166 out of quota messages on systems that are restricting the disk quota
16171 >strict allocate = no</B
16176 NAME="STRICTLOCKING"
16178 >>strict locking (S)</DT
16181 >This is a boolean that controls the handling of
16182 file locking in the server. When this is set to <CODE
16186 the server will check every read and write access for file locks, and
16187 deny access if locks exist. This can be slow on some systems.</P
16189 >When strict locking is <CODE
16192 > the server does file
16193 lock checks only when the client explicitly asks for them.</P
16195 >Well-behaved clients always ask for lock checks when it
16196 is important, so in the vast majority of cases <B
16200 > is preferable.</P
16204 >strict locking = no</B
16211 >>strict sync (S)</DT
16214 >Many Windows applications (including the Windows
16215 98 explorer shell) seem to confuse flushing buffer contents to
16216 disk with doing a sync to disk. Under UNIX, a sync call forces
16217 the process to be suspended until the kernel has ensured that
16218 all outstanding data in kernel disk buffers has been safely stored
16219 onto stable storage. This is very slow and should only be done
16220 rarely. Setting this parameter to <CODE
16224 default) means that <SPAN
16225 CLASS="CITEREFENTRY"
16227 CLASS="REFENTRYTITLE"
16230 > ignores the Windows applications requests for
16231 a sync call. There is only a possibility of losing data if the
16232 operating system itself that Samba is running on crashes, so there is
16233 little danger in this default setting. In addition, this fixes many
16234 performance problems that people have reported with the new Windows98
16235 explorer shell file copies.</P
16248 >strict sync = no</B
16255 >>strip dot (G)</DT
16258 >This is a boolean that controls whether to
16259 strip trailing dots off UNIX filenames. This helps with some
16260 CDROMs that have filenames ending in a single dot.</P
16271 >>sync always (S)</DT
16274 >This is a boolean parameter that controls
16275 whether writes will always be written to stable storage before
16276 the write call returns. If this is <CODE
16279 > then the server will be
16280 guided by the client's request in each write call (clients can
16281 set a bit indicating that a particular write should be synchronous).
16285 > then every write will be followed by a <B
16289 > call to ensure the data is written to disk. Note that
16293 > parameter must be set to
16297 > in order for this parameter to have
16311 >sync always = no</B
16318 >>syslog (G)</DT
16321 >This parameter maps how Samba debug messages
16322 are logged onto the system syslog logging levels. Samba debug
16323 level zero maps onto syslog <CODE
16327 level one maps onto <CODE
16331 two maps onto <CODE
16334 >, debug level three
16335 maps onto LOG_INFO. All higher levels are mapped to <CODE
16340 >This parameter sets the threshold for sending messages
16341 to syslog. Only messages with debug level less than this value
16342 will be sent to syslog.</P
16353 >>syslog only (G)</DT
16356 >If this parameter is set then Samba debug
16357 messages are logged into the system syslog only, and not to
16358 the debug log files.</P
16362 >syslog only = no</B
16367 NAME="TEMPLATEHOMEDIR"
16369 >>template homedir (G)</DT
16372 >When filling out the user information for a Windows NT
16374 HREF="winbindd.8.html"
16378 uses this parameter to fill in the home directory for that user.
16382 > is present it is substituted
16383 with the user's Windows NT domain name. If the string <VAR
16387 > is present it is substituted with the user's Windows
16392 >template homedir = /home/%D/%U</B
16397 NAME="TEMPLATESHELL"
16399 >>template shell (G)</DT
16402 >When filling out the user information for a Windows NT
16404 CLASS="CITEREFENTRY"
16406 CLASS="REFENTRYTITLE"
16410 uses this parameter to fill in the login shell for that user.</P
16414 >template shell = /bin/false</B
16421 >>time offset (G)</DT
16424 >This parameter is a setting in minutes to add
16425 to the normal GMT to local time conversion. This is useful if
16426 you are serving a lot of PCs that have incorrect daylight
16427 saving time handling.</P
16431 >time offset = 0</B
16436 >time offset = 60</B
16443 >>time server (G)</DT
16446 >This parameter determines if <SPAN
16447 CLASS="CITEREFENTRY"
16449 CLASS="REFENTRYTITLE"
16452 > advertises itself as a time server to Windows
16457 >time server = no</B
16462 NAME="TIMESTAMPLOGS"
16464 >>timestamp logs (G)</DT
16468 HREF="#DEBUGTIMESTAMP"
16471 > debug timestamp</VAR
16477 NAME="TOTALPRINTJOBS"
16479 >>total print jobs (G)</DT
16482 >This parameter accepts an integer value which defines
16483 a limit on the maximum number of print jobs that will be accepted
16484 system wide at any given time. If a print job is submitted
16485 by a client which will exceed this number, then <SPAN
16486 CLASS="CITEREFENTRY"
16488 CLASS="REFENTRYTITLE"
16492 error indicating that no space is available on the server. The
16493 default value of 0 means that no such limit exists. This parameter
16494 can be used to prevent a server from exceeding its capacity and is
16495 designed as a printing throttle. See also
16497 HREF="#MAXPRINTJOBS"
16500 >max print jobs</VAR
16507 >total print jobs = 0</B
16512 >total print jobs = 5000</B
16519 >>unicode (G)</DT
16522 >Specifies whether Samba should try
16523 to use unicode on the wire by default. Note: This does NOT
16524 mean that samba will assume that the unix machine uses unicode!
16536 >>unix charset (G)</DT
16539 >Specifies the charset the unix machine
16540 Samba runs on uses. Samba needs to know this in order to be able to
16541 convert text to the charsets other SMB clients use.
16546 >unix charset = UTF8</B
16551 >unix charset = ASCII</B
16556 NAME="UNIXEXTENSIONS"
16558 >>unix extensions(G)</DT
16561 >This boolean parameter controls whether Samba
16562 implments the CIFS UNIX extensions, as defined by HP.
16563 These extensions enable Samba to better serve UNIX CIFS clients
16564 by supporting features such as symbolic links, hard links, etc...
16565 These extensions require a similarly enabled client, and are of
16566 no current use to Windows clients.</P
16570 >unix extensions = no</B
16575 NAME="UNIXPASSWORDSYNC"
16577 >>unix password sync (G)</DT
16580 >This boolean parameter controls whether Samba
16581 attempts to synchronize the UNIX password with the SMB password
16582 when the encrypted SMB password in the smbpasswd file is changed.
16583 If this is set to <CODE
16586 > the program specified in the <VAR
16590 >parameter is called <SPAN
16597 to allow the new UNIX password to be set without access to the
16598 old UNIX password (as the SMB password change code has no
16599 access to the old password cleartext, only the new).</P
16602 HREF="#PASSWDPROGRAM"
16618 >unix password sync = no</B
16623 NAME="UPDATEENCRYPTED"
16625 >>update encrypted (G)</DT
16628 >This boolean parameter allows a user logging
16629 on with a plaintext password to have their encrypted (hashed)
16630 password in the smbpasswd file to be updated automatically as
16631 they log on. This option allows a site to migrate from plaintext
16632 password authentication (users authenticate with plaintext
16633 password over the wire, and are checked against a UNIX account
16634 database) to encrypted password authentication (the SMB
16635 challenge/response authentication mechanism) without forcing
16636 all users to re-enter their passwords via smbpasswd at the time the
16637 change is made. This is a convenience option to allow the change over
16638 to encrypted passwords to be made over a longer period. Once all users
16639 have encrypted representations of their passwords in the smbpasswd
16640 file this parameter should be set to <CODE
16645 >In order for this parameter to work correctly the <A
16646 HREF="#ENCRYPTPASSWORDS"
16649 >encrypt passwords</VAR
16652 > parameter must be set to <CODE
16656 this parameter is set to <CODE
16661 >Note that even when this parameter is set a user
16662 authenticating to <B
16665 > must still enter a valid
16666 password in order to connect correctly, and to update their hashed
16667 (smbpasswd) passwords.</P
16671 >update encrypted = no</B
16676 NAME="USECLIENTDRIVER"
16678 >>use client driver (S)</DT
16681 >This parameter applies only to Windows NT/2000
16682 clients. It has no affect on Windows 95/98/ME clients. When
16683 serving a printer to Windows NT/2000 clients without first installing
16684 a valid printer driver on the Samba host, the client will be required
16685 to install a local printer driver. From this point on, the client
16686 will treat the print as a local printer and not a network printer
16687 connection. This is much the same behavior that will occur
16690 >disable spoolss = yes</B
16693 >The differentiating
16694 factor is that under normal circumstances, the NT/2000 client will
16695 attempt to open the network printer using MS-RPC. The problem is that
16696 because the client considers the printer to be local, it will attempt
16697 to issue the OpenPrinterEx() call requesting access rights associated
16698 with the logged on user. If the user possesses local administator rights
16699 but not root privilegde on the Samba host (often the case), the OpenPrinterEx()
16700 call will fail. The result is that the client will now display an "Access
16701 Denied; Unable to connect" message in the printer queue window (even though
16702 jobs may successfully be printed). </P
16704 >If this parameter is enabled for a printer, then any attempt
16705 to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
16706 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
16707 call to succeed. <SPAN
16711 >This parameter MUST not be able enabled
16712 on a print share which has valid print driver installed on the Samba
16718 HREF="#DISABLESPOOLSS"
16719 >disable spoolss</A
16725 >use client driver = no</B
16732 >>use mmap (G)</DT
16735 >This global parameter determines if the tdb internals of Samba can
16736 depend on mmap working correctly on the running system. Samba requires a coherent
16737 mmap/read-write system memory cache. Currently only HPUX does not have such a
16738 coherent cache, and so this parameter is set to <CODE
16742 default on HPUX. On all other systems this parameter should be left alone. This
16743 parameter is provided to help the Samba developers track down problems with
16744 the tdb internal code.
16771 >>users (S)</DT
16786 >>username (S)</DT
16789 >Multiple users may be specified in a comma-delimited
16790 list, in which case the supplied password will be tested against
16791 each username in turn (left to right).</P
16796 > line is needed only when
16797 the PC is unable to supply its own username. This is the case
16798 for the COREPLUS protocol or where your users have different WfWg
16799 usernames to UNIX usernames. In both these cases you may also be
16800 better using the \\server\share%user syntax instead.</P
16805 > line is not a great
16806 solution in many cases as it means Samba will try to validate
16807 the supplied password against each of the usernames in the
16811 > line in turn. This is slow and
16812 a bad idea for lots of users in case of duplicate passwords.
16813 You may get timeouts or security breaches using this parameter
16816 >Samba relies on the underlying UNIX security. This
16817 parameter does not restrict who can login, it just offers hints
16818 to the Samba server as to what usernames might correspond to the
16819 supplied password. Users can login as whoever they please and
16820 they will be able to do no more damage than if they started a
16821 telnet session. The daemon runs as the user that they log in as,
16822 so they cannot do anything that user cannot do.</P
16824 >To restrict a service to a particular set of users you
16834 >If any of the usernames begin with a '@' then the name
16835 will be looked up first in the NIS netgroups list (if Samba
16836 is compiled with netgroup support), followed by a lookup in
16837 the UNIX groups database and will expand to a list of all users
16838 in the group of that name.</P
16840 >If any of the usernames begin with a '+' then the name
16841 will be looked up only in the UNIX groups database and will
16842 expand to a list of all users in the group of that name.</P
16844 >If any of the usernames begin with a '&' then the name
16845 will be looked up only in the NIS netgroups database (if Samba
16846 is compiled with netgroup support) and will expand to a list
16847 of all users in the netgroup group of that name.</P
16849 >Note that searching though a groups database can take
16850 quite some time, and some clients may time out during the
16853 >See the section <A
16856 USERNAME/PASSWORD VALIDATION</A
16857 > for more information on how
16858 this parameter determines access to the services.</P
16862 >The guest account if a guest service,
16863 else <empty string>.</B
16868 >username = fred, mary, jack, jane,
16869 @users, @pcgroup</B
16874 NAME="USERNAMELEVEL"
16876 >>username level (G)</DT
16879 >This option helps Samba to try and 'guess' at
16880 the real UNIX username, as many DOS clients send an all-uppercase
16881 username. By default Samba tries all lowercase, followed by the
16882 username with the first letter capitalized, and fails if the
16883 username is not found on the UNIX machine.</P
16885 >If this parameter is set to non-zero the behavior changes.
16886 This parameter is a number that specifies the number of uppercase
16887 combinations to try while trying to determine the UNIX user name. The
16888 higher the number the more combinations will be tried, but the slower
16889 the discovery of usernames will be. Use this parameter when you have
16890 strange usernames on your UNIX machine, such as <CODE
16898 >username level = 0</B
16903 >username level = 5</B
16910 >>username map (G)</DT
16913 >This option allows you to specify a file containing
16914 a mapping of usernames from the clients to the server. This can be
16915 used for several purposes. The most common is to map usernames
16916 that users use on DOS or Windows machines to those that the UNIX
16917 box uses. The other is to map multiple users to a single username
16918 so that they can more easily share files.</P
16920 >The map file is parsed line by line. Each line should
16921 contain a single UNIX username on the left then a '=' followed
16922 by a list of usernames on the right. The list of usernames on the
16923 right may contain names of the form @group in which case they
16924 will match any UNIX username in that group. The special client
16925 name '*' is a wildcard and matches any name. Each line of the
16926 map file may be up to 1023 characters long.</P
16928 >The file is processed on each line by taking the
16929 supplied username and comparing it with each username on the right
16930 hand side of the '=' signs. If the supplied name matches any of
16931 the names on the right hand side then it is replaced with the name
16932 on the left. Processing then continues with the next line.</P
16934 >If any line begins with a '#' or a ';' then it is
16937 >If any line begins with an '!' then the processing
16938 will stop after that line if a mapping was done by the line.
16939 Otherwise mapping continues with every line being processed.
16940 Using '!' is most useful when you have a wildcard mapping line
16941 later in the file.</P
16943 >For example to map from the name <CODE
16949 >administrator</CODE
16950 > to the UNIX name <CODE
16953 > you would use:</P
16957 >root = admin administrator</B
16960 >Or to map anyone in the UNIX group <CODE
16964 to the UNIX name <CODE
16967 > you would use:</P
16974 >You can have as many mappings as you like in a username
16977 >If your system supports the NIS NETGROUP option then
16978 the netgroup database is checked before the <TT
16982 > database for matching groups.</P
16984 >You can map Windows usernames that have spaces in them
16985 by using double quotes around the name. For example:</P
16989 >tridge = "Andrew Tridgell"</B
16992 >would map the windows username "Andrew Tridgell" to the
16993 unix username "tridge".</P
16995 >The following example would map mary and fred to the
16996 unix user sys, and map the rest to guest. Note the use of the
16997 '!' to tell Samba to stop processing if it gets a match on
17001 CLASS="PROGRAMLISTING"
17006 >Note that the remapping is applied to all occurrences
17007 of usernames. Thus if you connect to \\server\fred and <CODE
17010 > is remapped to <CODE
17014 will actually be connecting to \\server\mary and will need to
17015 supply a password suitable for <CODE
17022 >. The only exception to this is the
17023 username passed to the <A
17024 HREF="#PASSWORDSERVER"
17027 > password server</VAR
17029 > (if you have one). The password
17030 server will receive whatever username the client supplies without
17033 >Also note that no reverse mapping is done. The main effect
17034 this has is with printing. Users who have been mapped may have
17035 trouble deleting print jobs as PrintManager under WfWg will think
17036 they don't own the print job.</P
17042 >no username map</I
17048 >username map = /usr/local/samba/lib/users.map
17056 >>use sendfile (S)</DT
17059 >If this parameter is <CODE
17063 was built with the --with-sendfile-support option, and the underlying operating
17064 system supports sendfile system call, then some SMB read calls (mainly ReadAndX
17065 and ReadRaw) will use the more efficient sendfile system call for files that
17066 are exclusively oplocked. This may make more efficient use of the system CPU's
17067 and cause Samba to be faster. This is off by default as it's effects are unknown
17073 >use sendfile = no</B
17083 >This boolean parameter is only available if
17084 Samba has been configured and compiled with the option <B
17090 > then Samba will attempt
17091 to add utmp or utmpx records (depending on the UNIX system) whenever a
17092 connection is made to a Samba server. Sites may use this to record the
17093 user connecting to a Samba share.</P
17095 >Due to the requirements of the utmp record, we
17096 are required to create a unique identifier for the
17097 incoming user. Enabling this option creates an n^2
17098 algorithm to find this number. This may impede
17099 performance on large installations. </P
17102 HREF="#UTMPDIRECTORY"
17105 > utmp directory</VAR
17116 NAME="UTMPDIRECTORY"
17118 >>utmp directory(G)</DT
17121 >This parameter is only available if Samba has
17122 been configured and compiled with the option <B
17125 >. It specifies a directory pathname that is
17126 used to store the utmp or utmpx files (depending on the UNIX system) that
17127 record user connections to a Samba server. See also the <A
17133 > parameter. By default this is
17134 not set, meaning the system will use whatever utmp file the
17135 native system is set to use (usually
17145 >no utmp directory</I
17151 >utmp directory = /var/run/utmp</B
17156 NAME="WTMPDIRECTORY"
17158 >>wtmp directory(G)</DT
17161 >This parameter is only available if Samba has
17162 been configured and compiled with the option <B
17165 >. It specifies a directory pathname that is
17166 used to store the wtmp or wtmpx files (depending on the UNIX system) that
17167 record user connections to a Samba server. The difference with
17168 the utmp directory is the fact that user info is kept after a user
17177 > parameter. By default this is
17178 not set, meaning the system will use whatever utmp file the
17179 native system is set to use (usually
17189 >no wtmp directory</I
17195 >wtmp directory = /var/log/wtmp</B
17202 >>valid users (S)</DT
17205 >This is a list of users that should be allowed
17206 to login to this service. Names starting with '@', '+' and '&'
17207 are interpreted using the same rules as described in the
17210 >invalid users</VAR
17213 >If this is empty (the default) then any user can login.
17214 If a username is in both this list and the <VAR
17218 > list then access is denied for that user.</P
17220 >The current servicename is substituted for <VAR
17224 >. This is useful in the [homes] section.</P
17227 HREF="#INVALIDUSERS"
17239 >No valid users list (anyone can login)
17246 >valid users = greg, @pcusers</B
17253 >>veto files(S)</DT
17256 >This is a list of files and directories that
17257 are neither visible nor accessible. Each entry in the list must
17258 be separated by a '/', which allows spaces to be included
17259 in the entry. '*' and '?' can be used to specify multiple files
17260 or directories as in DOS wildcards.</P
17262 >Each entry must be a unix path, not a DOS path and
17269 > include the unix directory
17272 >Note that the <VAR
17274 >case sensitive</VAR
17276 is applicable in vetoing files.</P
17278 >One feature of the veto files parameter that it
17279 is important to be aware of is Samba's behaviour when
17280 trying to delete a directory. If a directory that is
17281 to be deleted contains nothing but veto files this
17282 deletion will <SPAN
17288 > unless you also set
17291 >delete veto files</VAR
17298 >Setting this parameter will affect the performance
17299 of Samba, as it will be forced to check all files and directories
17300 for a match as they are scanned.</P
17310 HREF="#CASESENSITIVE"
17313 > case sensitive</VAR
17321 >No files or directories are vetoed.
17327 CLASS="PROGRAMLISTING"
17328 >; Veto any files containing the word Security,
17329 ; any ending in .tmp, and any directory containing the
17331 veto files = /*Security*/*.tmp/*root*/
17333 ; Veto the Apple specific files that a NetAtalk server
17335 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/</PRE
17340 NAME="VETOOPLOCKFILES"
17342 >>veto oplock files (S)</DT
17345 >This parameter is only valid when the <A
17352 parameter is turned on for a share. It allows the Samba administrator
17353 to selectively turn off the granting of oplocks on selected files that
17354 match a wildcarded list, similar to the wildcarded list used in the
17368 >No files are vetoed for oplock
17373 >You might want to do this on files that you know will
17374 be heavily contended for by clients. A good example of this
17375 is in the NetBench SMB benchmark program, which causes heavy
17376 client contention for files ending in <TT
17380 To cause Samba not to grant oplocks on these files you would use
17381 the line (either in the [global] section or in the section for
17382 the particular NetBench share :</P
17386 >veto oplock files = /*.SEM/
17394 >>vfs path (S)</DT
17397 >This parameter specifies the directory
17398 to look in for vfs modules. The name of every <B
17402 > will be prepended by this directory
17412 >vfs path = /usr/lib/samba/vfs</B
17419 >>vfs object (S)</DT
17422 >This parameter specifies a shared object files that
17423 are used for Samba VFS I/O operations. By default, normal
17424 disk I/O operations are used but these can be overloaded
17425 with one or more VFS objects. </P
17439 >>vfs options (S)</DT
17442 >This parameter allows parameters to be passed
17443 to the vfs layer at initialization time.
17464 >>volume (S)</DT
17467 > This allows you to override the volume label
17468 returned for a share. Useful for CDROMs with installation programs
17469 that insist on a particular volume label.</P
17475 >the name of the share</I
17483 >>wide links (S)</DT
17486 >This parameter controls whether or not links
17487 in the UNIX file system may be followed by the server. Links
17488 that point to areas within the directory tree exported by the
17489 server are always allowed; this parameter controls access only
17490 to areas that are outside the directory tree being exported.</P
17492 >Note that setting this parameter can have a negative
17493 effect on your server performance due to the extra system calls
17494 that Samba has to do in order to perform the link checks.</P
17498 >wide links = yes</B
17503 NAME="WINBINDCACHETIME"
17505 >>winbind cache time (G)</DT
17508 >This parameter specifies the number of
17510 CLASS="CITEREFENTRY"
17512 CLASS="REFENTRYTITLE"
17515 > daemon will cache
17516 user and group information before querying a Windows NT server
17521 >winbind cache type = 15</B
17526 NAME="WINBINDENUMUSERS"
17528 >>winbind enum users (G)</DT
17531 >On large installations using <SPAN
17532 CLASS="CITEREFENTRY"
17534 CLASS="REFENTRYTITLE"
17538 necessary to suppress the enumeration of users through the <B
17549 > group of system calls. If
17552 >winbind enum users</VAR
17561 will not return any data. </P
17570 enumeration may cause some programs to behave oddly. For
17571 example, the finger program relies on having access to the
17572 full user list when searching for matching
17577 >winbind enum users = yes </B
17582 NAME="WINBINDENUMGROUPS"
17584 >>winbind enum groups (G)</DT
17587 >On large installations using <SPAN
17588 CLASS="CITEREFENTRY"
17590 CLASS="REFENTRYTITLE"
17593 > it may be necessary to suppress
17594 the enumeration of groups through the <B
17605 > group of system calls. If
17608 >winbind enum groups</VAR
17617 call will not return any data. </P
17625 > Turning off group
17626 enumeration may cause some programs to behave oddly.
17631 >winbind enum groups = yes </B
17639 >>winbind gid (G)</DT
17642 >The winbind gid parameter specifies the range of group
17643 ids that are allocated by the <SPAN
17644 CLASS="CITEREFENTRY"
17646 CLASS="REFENTRYTITLE"
17649 > daemon. This range of group ids should have no
17650 existing local or NIS groups within it as strange conflicts can
17651 occur otherwise.</P
17655 >winbind gid = <empty string>
17661 >winbind gid = 10000-20000</B
17666 NAME="WINBINDSEPARATOR"
17668 >>winbind separator (G)</DT
17671 >This parameter allows an admin to define the character
17672 used when listing a username of the form of <VAR
17673 CLASS="REPLACEABLE"
17677 CLASS="REPLACEABLE"
17680 is only applicable when using the <TT
17682 >pam_winbind.so</TT
17686 >nss_winbind.so</TT
17687 > modules for UNIX services.
17690 >Please note that setting this parameter to + causes problems
17691 with group membership at least on glibc systems, as the character +
17692 is used as a special character for NIS in /etc/group.</P
17696 >winbind separator = '\'</B
17701 >winbind separator = +</B
17708 >>winbind uid (G)</DT
17711 >The winbind gid parameter specifies the range of group
17712 ids that are allocated by the <SPAN
17713 CLASS="CITEREFENTRY"
17715 CLASS="REFENTRYTITLE"
17718 > daemon. This range of ids should have no
17719 existing local or NIS users within it as strange conflicts can
17720 occur otherwise.</P
17724 >winbind uid = <empty string>
17730 >winbind uid = 10000-20000</B
17735 NAME="WINBINDUSEDEFAULTDOMAIN"
17737 >>winbind use default domain (G)</DT
17740 >This parameter specifies whether the <SPAN
17741 CLASS="CITEREFENTRY"
17743 CLASS="REFENTRYTITLE"
17746 > daemon should operate on users
17747 without domain component in their username.
17748 Users without a domain component are treated as is part of the winbindd server's
17749 own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail
17750 function in a way much closer to the way they would in a native unix system.</P
17754 >winbind use default domain = <no>
17760 >winbind use default domain = yes</B
17767 >>wins hook (G)</DT
17770 >When Samba is running as a WINS server this
17771 allows you to call an external program for all changes to the
17772 WINS database. The primary use for this option is to allow the
17773 dynamic update of external name resolution databases such as
17776 >The wins hook parameter specifies the name of a script
17777 or executable that will be called as follows:</P
17781 >wins_hook operation name nametype ttl IP_list
17789 >The first argument is the operation and is one
17790 of "add", "delete", or "refresh". In most cases the operation can
17791 be ignored as the rest of the parameters provide sufficient
17792 information. Note that "refresh" may sometimes be called when the
17793 name has not previously been added, in that case it should be treated
17798 >The second argument is the NetBIOS name. If the
17799 name is not a legal name then the wins hook is not called.
17800 Legal names contain only letters, digits, hyphens, underscores
17805 >The third argument is the NetBIOS name
17806 type as a 2 digit hexadecimal number. </P
17810 >The fourth argument is the TTL (time to live)
17811 for the name in seconds.</P
17815 >The fifth and subsequent arguments are the IP
17816 addresses currently registered for that name. If this list is
17817 empty then the name should be deleted.</P
17821 >An example script that calls the BIND dynamic DNS update
17825 > is provided in the examples
17826 directory of the Samba source code. </P
17832 >>wins proxy (G)</DT
17835 >This is a boolean that controls if <A
17839 > will respond to broadcast name
17840 queries on behalf of other hosts. You may need to set this
17844 > for some older clients.</P
17848 >wins proxy = no</B
17855 >>wins server (G)</DT
17858 >This specifies the IP address (or DNS name: IP
17859 address for preference) of the WINS server that <SPAN
17860 CLASS="CITEREFENTRY"
17862 CLASS="REFENTRYTITLE"
17865 > should register with. If you have a WINS server on
17866 your network then you should set this to the WINS server's IP.</P
17868 >You should point this at your WINS server if you have a
17869 multi-subnetted network.</P
17877 >. You need to set up Samba to point
17878 to a WINS server if you have multiple subnets and wish cross-subnet
17879 browsing to work correctly.</P
17881 >See the documentation file <A
17882 HREF="improved-browsing.html"
17886 in the docs/ directory of your Samba source distribution.</P
17898 >wins server = 192.9.200.1</B
17905 >>wins support (G)</DT
17908 >This boolean controls if the <SPAN
17909 CLASS="CITEREFENTRY"
17911 CLASS="REFENTRYTITLE"
17914 > process in Samba will act as a WINS server. You should
17915 not set this to <CODE
17918 > unless you have a multi-subnetted network and
17919 you wish a particular <B
17922 > to be your WINS server.
17923 Note that you should <SPAN
17929 > set this to <CODE
17933 on more than one machine in your network.</P
17937 >wins support = no</B
17944 >>workgroup (G)</DT
17947 >This controls what workgroup your server will
17948 appear to be in when queried by clients. Note that this parameter
17949 also controls the Domain name used with the <A
17950 HREF="#SECURITYEQUALSDOMAIN"
17953 >security = domain</B
17962 >set at compile time to WORKGROUP</I
17968 >workgroup = MYGROUP</B
17975 >>writable (S)</DT
17984 > for people who can't spell :-).</P
17988 NAME="WRITECACHESIZE"
17990 >>write cache size (S)</DT
17993 >If this integer parameter is set to non-zero value,
17994 Samba will create an in-memory cache for each oplocked file
18002 non-oplocked files). All writes that the client does not request
18003 to be flushed directly to disk will be stored in this cache if possible.
18004 The cache is flushed onto disk when a write comes in whose offset
18005 would not fit into the cache or when the file is closed by the client.
18006 Reads for the file are also served from this cache if the data is stored
18009 >This cache allows Samba to batch client writes into a more
18010 efficient write size for RAID disks (i.e. writes may be tuned to
18011 be the RAID stripe size) and can improve performance on systems
18012 where the disk subsystem is a bottleneck but there is free
18013 memory for userspace programs.</P
18015 >The integer parameter specifies the size of this cache
18016 (per oplocked file) in bytes.</P
18020 >write cache size = 0</B
18025 >write cache size = 262144</B
18028 >for a 256k cache size per file.</P
18034 >>write list (S)</DT
18037 >This is a list of users that are given read-write
18038 access to a service. If the connecting user is in this list then
18039 they will be given write access, no matter what the <A
18046 option is set to. The list can include group names using the
18049 >Note that if a user is in both the read list and the
18050 write list then they will be given write access.</P
18063 >write list = <empty string>
18069 >write list = admin, root, @staff
18075 NAME="WINSPARTNERS"
18077 >>wins partners (G)</DT
18080 >A space separated list of partners' IP addresses for
18081 WINS replication. WINS partners are always defined as push/pull
18082 partners as defining only one way WINS replication is unreliable.
18083 WINS replication is currently experimental and unreliable between
18089 >wins partners = </B
18094 >wins partners = 192.168.0.1 172.16.1.2</B
18101 >>write ok (S)</DT
18104 >Inverted synonym for <A
18116 >>write raw (G)</DT
18119 >This parameter controls whether or not the server
18120 will support raw write SMB's when transferring data from clients.
18121 You should never need to change this parameter.</P
18125 >write raw = yes</B
18132 >>writeable (S)</DT
18135 >Inverted synonym for <A
18154 >Although the configuration file permits service names
18155 to contain spaces, your client software may not. Spaces will
18156 be ignored in comparisons anyway, so it shouldn't be a
18157 problem - but be aware of the possibility.</P
18159 >On a similar note, many clients - especially DOS clients -
18160 limit service names to eight characters. <SPAN
18161 CLASS="CITEREFENTRY"
18163 CLASS="REFENTRYTITLE"
18166 > has no such limitation, but attempts to connect from such
18167 clients will fail if they truncate the service names. For this reason
18168 you should probably keep your service names down to eight characters
18171 >Use of the [homes] and [printers] special sections make life
18172 for an administrator easy, but the various combinations of default
18173 attributes can be tricky. Take extreme care when designing these
18174 sections. In particular, ensure that the permissions on spool
18175 directories are correct.</P
18185 >This man page is correct for version 3.0 of the Samba suite.</P
18196 CLASS="CITEREFENTRY"
18198 CLASS="REFENTRYTITLE"
18202 CLASS="CITEREFENTRY"
18204 CLASS="REFENTRYTITLE"
18208 CLASS="CITEREFENTRY"
18210 CLASS="REFENTRYTITLE"
18214 CLASS="CITEREFENTRY"
18216 CLASS="REFENTRYTITLE"
18220 CLASS="CITEREFENTRY"
18222 CLASS="REFENTRYTITLE"
18226 CLASS="CITEREFENTRY"
18228 CLASS="REFENTRYTITLE"
18232 CLASS="CITEREFENTRY"
18234 CLASS="REFENTRYTITLE"
18238 CLASS="CITEREFENTRY"
18240 CLASS="REFENTRYTITLE"
18244 CLASS="CITEREFENTRY"
18246 CLASS="REFENTRYTITLE"
18259 >The original Samba software and related utilities
18260 were created by Andrew Tridgell. Samba is now developed
18261 by the Samba Team as an Open Source project similar
18262 to the way the Linux kernel is developed.</P
18264 >The original Samba man pages were written by Karl Auer.
18265 The man page sources were converted to YODL format (another
18266 excellent piece of Open Source software, available at <A
18267 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
18269 > ftp://ftp.icce.rug.nl/pub/unix/</A
18270 >) and updated for the Samba 2.0
18271 release by Jeremy Allison. The conversion to DocBook for
18272 Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
18273 for Samba 3.0 was done by Alexander Bokovoy.</P
git.samba.org / ira / wip.git / blob