2 .\" Author: [see the "AUTHOR" section]
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
5 .\" Manual: File Formats and Conventions
9 .TH "SMB\&.CONF" "5" "09/30/2009" "Samba 3\&.4" "File Formats and Conventions"
10 .\" -----------------------------------------------------------------
11 .\" * (re)Define some macros
12 .\" -----------------------------------------------------------------
13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 .\" toupper - uppercase a string (locale-aware)
15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 .\" put an extra blank line of space above the head in non-TTY output
43 .nr an-prevailing-indent \\n[IN]
47 .HTML-TAG ".NH \\n[an-level]"
49 .nr an-no-space-flag 1
51 \." make the size of the head bigger
56 .\" if n (TTY output), use uppercase
61 .\" if not n (not TTY), use normal case (not uppercase)
65 .\" if not n (not TTY), put a border/line under subheading
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77 .nr an-prevailing-indent \\n[IN]
82 .nr an-no-space-flag 1
85 \." make the size of the head bigger
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 .if "\\$2"adjust-for-leading-newline" \{\
114 .nr BW \\n(.lu-\\n(.i
117 .ie "\\$2"adjust-for-leading-newline" \{\
118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
164 .\" disable justification (adjust text to left margin only)
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
170 smb.conf \- The configuration file for the Samba suite
175 file is a configuration file for the Samba suite\&.
177 contains runtime configuration information for the Samba programs\&. The
179 file is designed to be configured and administered by the
181 program\&. The complete description of the file format and possible parameters held within are here for reference purposes\&.
184 The file consists of sections and parameters\&. A section begins with the name of the section in square brackets and continues until the next section begins\&. Sections contain parameters of the form:
195 .BB lightgray adjust-for-leading-newline
198 \fIname\fR = \fIvalue \fR
199 .EB lightgray adjust-for-leading-newline
210 The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\&.
212 Section and parameter names are not case sensitive\&.
214 Only the first equals sign in a parameter is significant\&. Whitespace before or after the first equals sign is discarded\&. Leading, trailing and internal whitespace in section and parameter names is irrelevant\&. Leading and trailing whitespace in a parameter value is discarded\&. Internal whitespace within a parameter value is retained verbatim\&.
216 Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\&.
220 is continued on the next line in the customary UNIX fashion\&.
222 The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 1/0 or true/false\&. Case is not significant in boolean values, but is preserved in string values\&. Some items such as create masks are numeric\&.
223 .SH "SECTION DESCRIPTIONS"
225 Each section in the configuration file (except for the [global] section) describes a shared resource (known as a
226 \(lqshare\(rq)\&. The section name is the name of the shared resource and the parameters within the section define the shares attributes\&.
228 There are three special sections, [global], [homes] and [printers], which are described under
229 \fIspecial sections\fR\&. The following notes apply to ordinary section descriptions\&.
231 A share consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service\&. Some housekeeping options are also specifiable\&.
233 Sections are either file share services (used by the client as an extension of their native file systems) or printable services (used by the client to access print services on the host running the server)\&.
235 Sections may be designated
237 services, in which case no password is required to access them\&. A specified UNIX
239 is used to define access privileges in this case\&.
241 Sections other than guest services will require a password to access them\&. The client provides the username\&. As older clients only provide passwords and not usernames, you may specify a list of usernames to check against the password using the
243 option in the share definition\&. For modern clients such as Windows 95/98/ME/NT/2000, this should not be necessary\&.
245 The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system\&. The server does not grant more access than the host system grants\&.
247 The following sample section defines a file space share\&. The user has write access to the path
248 \FC/home/bar\F[]\&. The share is accessed via the share name
260 .BB lightgray adjust-for-leading-newline
264 \m[blue]\fBpath = /home/bar\fR\m[]
265 \m[blue]\fBread only = no\fR\m[]
266 .EB lightgray adjust-for-leading-newline
277 The following sample section defines a printable share\&. The share is read\-only, but printable\&. That is, the only write access permitted is via calls to open, write to and close a spool file\&. The
279 parameter means access will be permitted as the default guest user (specified elsewhere):
290 .BB lightgray adjust-for-leading-newline
294 \m[blue]\fBpath = /usr/spool/public\fR\m[]
295 \m[blue]\fBread only = yes\fR\m[]
296 \m[blue]\fBprintable = yes\fR\m[]
297 \m[blue]\fBguest ok = yes\fR\m[]
298 .EB lightgray adjust-for-leading-newline
309 .SH "SPECIAL SECTIONS"
310 .SS "The [global] section"
312 Parameters in this section apply to the server as a whole, or are defaults for sections that do not specifically define certain items\&. See the notes under PARAMETERS for more information\&.
313 .SS "The [homes] section"
315 If a section called [homes] is included in the configuration file, services connecting clients to their home directories can be created on the fly by the server\&.
317 When the connection request is made, the existing sections are scanned\&. If a match is found, it is used\&. If no match is found, the requested section name is treated as a username and looked up in the local password file\&. If the name exists and the correct password has been given, a share is created by cloning the [homes] section\&.
319 Some modifications are then made to the newly created share:
329 The share name is changed from homes to the located username\&.
340 If no path was given, the path is set to the user\'s home directory\&.
344 If you decide to use a
346 line in your [homes] section, it may be useful to use the %S macro\&. For example:
357 .BB lightgray adjust-for-leading-newline
360 \fBpath = /data/pchome/%S\fR
361 .EB lightgray adjust-for-leading-newline
372 is useful if you have different home directories for your PCs than for UNIX access\&.
374 This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss\&.
376 A similar process occurs if the requested section name is
377 \(lqhomes\(rq, except that the share name is not changed to that of the requesting user\&. This method of using the [homes] section works well if different users share a client PC\&.
379 The [homes] section can specify all the parameters a normal service section can specify, though some make more sense than others\&. The following is a typical and suitable [homes] section:
390 .BB lightgray adjust-for-leading-newline
394 \m[blue]\fBread only = no\fR\m[]
395 .EB lightgray adjust-for-leading-newline
406 An important point is that if guest access is specified in the [homes] section, all home directories will be visible to all clients
407 \fIwithout a password\fR\&. In the very unlikely event that this is actually desirable, it is wise to also specify
408 \fIread only access\fR\&.
412 flag for auto home directories will be inherited from the global browseable flag, not the [homes] browseable flag\&. This is useful as it means setting
413 \fIbrowseable = no\fR
414 in the [homes] section will hide the [homes] share but make any auto home directories visible\&.
415 .SS "The [printers] section"
417 This section works like [homes], but for printers\&.
419 If a [printers] section occurs in the configuration file, users are able to connect to any printer specified in the local host\'s printcap file\&.
421 When a connection request is made, the existing sections are scanned\&. If a match is found, it is used\&. If no match is found, but a [homes] section exists, it is used as described above\&. Otherwise, the requested section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested section name is a valid printer share name\&. If a match is found, a new printer share is created by cloning the [printers] section\&.
423 A few modifications are then made to the newly created share:
433 The share name is set to the located printer name
444 If no printer name was given, the printer name is set to the located printer name
455 If the share does not permit guest access and no username was given, the username is set to the located printer name\&.
459 The [printers] service MUST be printable \- if you specify otherwise, the server will refuse to load the configuration file\&.
461 Typically the path specified is that of a world\-writeable spool directory with the sticky bit set on it\&. A typical [printers] entry looks like this:
472 .BB lightgray adjust-for-leading-newline
476 \m[blue]\fBpath = /usr/spool/public\fR\m[]
477 \m[blue]\fBguest ok = yes\fR\m[]
478 \m[blue]\fBprintable = yes\fR\m[]
479 .EB lightgray adjust-for-leading-newline
490 All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned\&. If your printing subsystem doesn\'t work like that, you will have to set up a pseudo\-printcap\&. This is a file consisting of one or more lines like this:
501 .BB lightgray adjust-for-leading-newline
504 alias|alias|alias|alias\&.\&.\&.
505 .EB lightgray adjust-for-leading-newline
516 Each alias should be an acceptable printer name for your printing subsystem\&. In the [global] section, specify the new file as your printcap\&. The server will only recognize names found in your pseudo\-printcap, which of course can contain whatever aliases you like\&. The same technique could be used simply to limit access to a subset of your local printers\&.
518 An alias, by the way, is defined as any component of the first entry of a printcap record\&. Records are separated by newlines, components (if there are more than one) are separated by vertical bar symbols (\FC|\F[])\&.
525 .nr an-no-space-flag 1
533 On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use
534 \FCprintcap name = lpstat\F[]
535 to automatically obtain a list of printers\&. See the
537 option for more details\&.
543 Starting with Samba version 3\&.0\&.23 the capability for non\-root users to add, modify, and delete their own share definitions has been added\&. This capability is called
545 and is controlled by a set of parameters in the [global] section of the smb\&.conf\&. The relevant parameters are :
547 usershare allow guests
549 Controls if usershares can permit guest access\&.
554 Maximum number of user defined shares allowed\&.
559 If set only directories owned by the sharing user can be shared\&.
564 Points to the directory containing the user defined share definitions\&. The filesystem permissions on this directory control who can create user defined shares\&.
567 usershare prefix allow list
569 Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Only directories below the pathnames in this list are permitted\&.
572 usershare prefix deny list
574 Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Directories below the pathnames in this list are prohibited\&.
577 usershare template share
579 Names a pre\-existing share used as a template for creating new usershares\&. All other share parameters not specified in the user defined share definition are copied from this named share\&.
582 To allow members of the UNIX group
584 to create user defined shares, create the directory to contain the share definitions as follows:
597 .BB lightgray adjust-for-leading-newline
600 mkdir /usr/local/samba/lib/usershares
601 chgrp foo /usr/local/samba/lib/usershares
602 chmod 1770 /usr/local/samba/lib/usershares
603 .EB lightgray adjust-for-leading-newline
614 Then add the parameters
625 .BB lightgray adjust-for-leading-newline
628 \m[blue]\fBusershare path = /usr/local/samba/lib/usershares\fR\m[]
629 \m[blue]\fBusershare max shares = 10\fR\m[] # (or the desired number of shares)
630 .EB lightgray adjust-for-leading-newline
641 to the global section of your
642 \FCsmb\&.conf\F[]\&. Members of the group foo may then manipulate the user defined shares using the following commands\&.
644 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]
646 To create or modify (overwrite) a user defined share\&.
649 net usershare delete sharename
651 To delete a user defined share\&.
654 net usershare list wildcard\-sharename
656 To list user defined shares\&.
659 net usershare info wildcard\-sharename
661 To print information about user defined shares\&.
665 Parameters define the specific attributes of sections\&.
667 Some parameters are specific to the [global] section (e\&.g\&.,
668 \fIsecurity\fR)\&. Some parameters are usable in all sections (e\&.g\&.,
669 \fIcreate mask\fR)\&. All others are permissible only in normal sections\&. For the purposes of the following descriptions the [homes] and [printers] sections will be considered normal\&. The letter
671 in parentheses indicates that a parameter is specific to the [global] section\&. The letter
673 indicates that a parameter can be specified in a service specific section\&. All
675 parameters can also be specified in the [global] section \- in which case they will define the default behavior for all services\&.
677 Parameters are arranged here in alphabetical order \- this may not create best bedfellows, but at least you can find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred synonym\&.
678 .SH "VARIABLE SUBSTITUTIONS"
680 Many of the strings that are settable in the config file can take substitutions\&. For example the option
681 \(lqpath = /tmp/%u\(rq
683 \(lqpath = /tmp/john\(rq
684 if the user connected with the username john\&.
686 These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant\&. These are:
690 session username (the username that the client wanted, not necessarily the same as the one they got)\&.
695 primary group name of %U\&.
700 the Internet hostname that Samba is running on\&.
705 the NetBIOS name of the client machine (very useful)\&.
707 This parameter is not available when Samba listens on port 445, as clients no longer send this information\&. If you use this macro in an include statement on a domain that has a Samba domain controller be sure to set in the [global] section
708 \fIsmb ports = 139\fR\&. This will cause Samba to not listen on port 445 and will permit include functionality to function as it did with Samba 2\&.x\&.
713 the NetBIOS name of the server\&. This allows you to change your config based on what the client calls you\&. Your server can have a
714 \(lqdual personality\(rq\&.
719 the Internet name of the client machine\&.
724 the selected protocol level after protocol negotiation\&. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1\&.
729 the process id of the current server process\&.
734 The architecture of the remote machine\&. It currently recognizes Samba (\fBSamba\fR), the Linux CIFS file system (\fBCIFSFS\fR), OS/2, (\fBOS2\fR), Windows for Workgroups (\fBWfWg\fR), Windows 9x/ME (\fBWin95\fR), Windows NT (\fBWinNT\fR), Windows 2000 (\fBWin2K\fR), Windows XP (\fBWinXP\fR), Windows XP 64\-bit(\fBWinXP64\fR), Windows 2003 including 2003R2 (\fBWin2K3\fR), and Windows Vista (\fBVista\fR)\&. Anything else will be known as
740 the IP address of the client machine\&.
745 the local IP address to which a client connected\&.
750 the current date and time\&.
755 name of the domain or workgroup of the current user\&.
760 the winbind separator\&.
765 the value of the environment variable
769 The following substitutes apply only to some configuration options (only those that are used when a connection has been established):
773 the name of the current service, if any\&.
778 the root directory of the current service, if any\&.
783 username of the current service, if any\&.
788 primary group name of %u\&.
793 the home directory of the user given by %u\&.
798 the name of your NIS home directory server\&. This is obtained from your NIS auto\&.map entry\&. If you have not compiled Samba with the
799 \fI\-\-with\-automount\fR
800 option, this value will be the same as %L\&.
805 the path of the service\'s home directory, obtained from your NIS auto\&.map entry\&. The NIS auto\&.map entry is split up as
809 There are some quite creative things that can be done with these substitutions and other
816 so that DOS and Windows clients can use files that don\'t conform to the 8\&.3 format\&. It can also be set to adjust the case of 8\&.3 format filenames\&.
818 There are several options that control the way mangling is performed, and they are grouped here rather than listed separately\&. For the defaults look at the output of the testparm program\&.
820 These options can be set separately for each service\&.
824 case sensitive = yes/no/auto
826 controls whether filenames are case sensitive\&. If they aren\'t, Samba must do a filename search and match on passed names\&. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS and smbclient 3\&.0\&.5 and above currently) to tell the Samba server on a per\-packet basis that they wish to access the file system in a case\-sensitive manner (to support UNIX case sensitive semantics)\&. No Windows or DOS system supports case\-sensitive filename so setting this option to auto is that same as setting it to no for them\&. Default
830 default case = upper/lower
832 controls what the default case is for new filenames (ie\&. files that don\'t currently exist in the filesystem)\&. Default
833 \fIlower\fR\&. IMPORTANT NOTE: This option will be used to modify the case of
835 incoming client filenames, not just new filenames if the options
836 \m[blue]\fBcase sensitive = yes\fR\m[],
837 \m[blue]\fBpreserve case = No\fR\m[],
838 \m[blue]\fBshort preserve case = No\fR\m[]
839 are set\&. This change is needed as part of the optimisations for directories containing large numbers of files\&.
842 preserve case = yes/no
844 controls whether new files (ie\&. files that don\'t currently exist in the filesystem) are created with the case that the client passes, or if they are forced to be the
850 short preserve case = yes/no
852 controls if new files (ie\&. files that don\'t currently exist in the filesystem) which conform to 8\&.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the
854 case\&. This option can be used with
855 \FCpreserve case = yes\F[]
856 to permit long filenames to retain their case, while short names are lowercased\&. Default
860 By default, Samba 3\&.0 has the same semantics as a Windows NT server, in that it is case insensitive but case preserving\&. As a special case for directories with large numbers of files, if the case options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no" then the "default case" option will be applied and will modify all filenames sent from the client when accessing this share\&.
861 .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
863 There are a number of ways in which a user can connect to a service\&. The server uses the following steps in determining if it will allow a connection to a specified service\&. If all the steps fail, the connection request is rejected\&. However, if one of the steps succeeds, the following steps are not checked\&.
865 If the service is marked
866 \(lqguest only = yes\(rq
867 and the server is running with share\-level security (\(lqsecurity = share\(rq, steps 1 to 5 are skipped\&.
877 If the client has passed a username/password pair and that username/password pair is validated by the UNIX system\'s password programs, the connection is made as that username\&. This includes the
878 \FC\e\eserver\eservice\F[]%\fIusername\fR
879 method of passing a username\&.
890 If the client has previously registered a username with the system and now supplies a correct password for that username, the connection is allowed\&.
901 The client\'s NetBIOS name and any previously used usernames are checked against the supplied password\&. If they match, the connection is allowed as the corresponding user\&.
912 If the client has previously validated a username/password pair with the server and the client has passed the validation token, that username is used\&.
925 field is given in the
927 file for the service and the client has supplied a password, and that password matches (according to the UNIX system\'s password checking) with one of the usernames from the
929 field, the connection is made as the username in the
931 line\&. If one of the usernames in the
934 \FC@\F[], that name expands to a list of names in the group of the same name\&.
945 If the service is a guest service, a connection is made as the username given in the
946 \FCguest account =\F[]
947 for the service, irrespective of the supplied password\&.
949 .SH "REGISTRY-BASED CONFIGURATION"
951 Starting with Samba version 3\&.2\&.0, the capability to store Samba configuration in the registry is available\&. The configuration is stored in the registry key
952 \fI\FCHKLM\eSoftware\eSamba\esmbconf\F[]\fR\&. There are two levels of registry configuration:
962 Share definitions stored in registry are used\&. This is triggered by setting the global parameter
963 \fIregistry shares\fR
969 The registry shares are loaded not at startup but on demand at runtime by
970 \fIsmbd\fR\&. Shares defined in
972 take priority over shares of the same name defined in registry\&.
985 options stored in registry are used\&. This can be activated in two different ways:
987 Firstly, a registry only configuration is triggered by setting
988 \m[blue]\fBconfig backend = registry\fR\m[]
989 in the [global] section of
990 \fIsmb\&.conf\fR\&. This resets everything that has been read from config files to this point and reads the content of the global configuration section from the registry\&. This is the recommended method of using registry based configuration\&.
992 Secondly, a mixed configuration can be activated by a special new meaning of the parameter
993 \m[blue]\fBinclude = registry\fR\m[]
994 in the [global] section of
995 \fIsmb\&.conf\fR\&. This reads the global options from registry with the same priorities as for an include of a text file\&. This may be especially useful in cases where an initial configuration is needed to access the registry\&.
997 Activation of global registry options automatically activates registry shares\&. So in the registry only case, shares are loaded on demand only\&.
1002 Note: To make registry\-based configurations foolproof at least to a certain extent, the use of
1003 \fIlock directory\fR
1005 \fIconfig backend\fR
1006 inside the registry configuration has been disabled: Especially by changing the
1007 \fIlock directory\fR
1008 inside the registry configuration, one would create a broken setup where the daemons do not see the configuration they loaded once it is active\&.
1010 The registry configuration can be accessed with tools like
1013 \fInet (rpc) registry\fR
1015 \fI\FCHKLM\eSoftware\eSamba\esmbconf\F[]\fR\&. More conveniently, the
1019 utility offers a dedicated interface to read and write the registry based configuration locally, i\&.e\&. directly accessing the database file, circumventing the server\&.
1020 .SH "EXPLANATION OF EACH PARAMETER"
1023 abort shutdown script (G)
1024 .\" abort shutdown script
1027 This a full path name to a script called by
1029 that should stop a shutdown procedure issued by the
1030 \m[blue]\fBshutdown script\fR\m[]\&.
1032 If the connected user posseses the
1033 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.
1036 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
1039 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI\FC/sbin/shutdown \-c\F[]\fR\fI \fR
1046 This parameter is a synonym for
1047 access based share enum\&.
1050 access based share enum (S)
1051 .\" access based share enum
1054 If this parameter is
1056 for a service, then the share hosted by the service will only be visible to users who have read or write access to the share during share enumeration (for example net view \e\esambaserver)\&. This has parallels to access based enumeration, the main difference being that only share permissions are evaluated, and security descriptors on files contained on the share are not used in computing enumeration access rights\&.
1059 \fI\fIaccess based share enum\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1062 acl check permissions (S)
1063 .\" acl check permissions
1066 This boolean parameter controls what
1067 \fBsmbd\fR(8)does on receiving a protocol request of "open for delete" from a Windows client\&. If a Windows client doesn\'t have permissions to delete a file then they expect this to be denied at open time\&. POSIX systems normally only detect restrictions on delete by actually attempting to delete the file or directory\&. As Windows clients can (and do) "back out" a delete request by unsetting the "delete on close" bit Samba cannot delete the file immediately on "open for delete" request as we cannot restore such a deleted file\&. With this parameter set to true (the default) then smbd checks the file system permissions directly on "open for delete" and denies the request without actually deleting the file if the file system permissions would seem to deny it\&. This is not perfect, as it\'s possible a user could have deleted a file without Samba being able to check the permissions correctly, but it is close enough to Windows semantics for mostly correct behaviour\&. Samba will correctly check POSIX ACL semantics in this case\&.
1069 If this parameter is set to "false" Samba doesn\'t check permissions on "open for delete" and allows the open\&. If the user doesn\'t have permission to delete the file this will only be discovered at close time, which is too late for the Windows user tools to display an error message to the user\&. The symptom of this is files that appear to have been deleted "magically" re\-appearing on a Windows explorer refresh\&. This is an extremely advanced protocol option which should not need to be changed\&. This parameter was introduced in its final form in 3\&.0\&.21, an earlier version with slightly different semantics was introduced in 3\&.0\&.20\&. That older version is not documented here\&.
1072 \fI\fIacl check permissions\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
1075 acl compatibility (G)
1076 .\" acl compatibility
1079 This parameter specifies what OS ACL semantics should be compatible with\&. Possible values are
1083 for Windows 2000 and above and
1084 \fIauto\fR\&. If you specify
1085 \fIauto\fR, the value for this parameter will be based upon the version of the client\&. There should be no reason to change this parameter from the default\&.
1088 \fI\fIacl compatibility\fR\fR\fI = \fR\fI\FCAuto\F[]\fR\fI \fR
1091 \fI\fIacl compatibility\fR\fR\fI = \fR\fI\FCwin2k\F[]\fR\fI \fR
1094 acl group control (S)
1095 .\" acl group control
1098 In a POSIX filesystem, only the owner of a file or directory and the superuser can modify the permissions and ACLs on a file\&. If this parameter is set, then Samba overrides this restriction, and also allows the
1099 \fIprimary group owner\fR
1100 of a file or directory to modify the permissions and ACLs on that file\&.
1102 On a Windows server, groups may be the owner of a file or directory \- thus allowing anyone in that group to modify the permissions on it\&. This allows the delegation of security controls on a point in the filesystem to the group owner of a directory and anything below it also owned by that group\&. This means there are multiple people with permissions to modify ACLs on a file or directory, easing managability\&.
1104 This parameter allows Samba to also permit delegation of the control over a point in the exported directory hierarchy in much the same way as Windows\&. This allows all members of a UNIX group to control the permissions on a file or directory they have group ownership on\&.
1106 This parameter is best used with the
1107 \m[blue]\fBinherit owner\fR\m[]
1108 option and also on on a share containing directories with the UNIX
1110 set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory\&.
1112 This is parameter has been was deprecated in Samba 3\&.0\&.23, but re\-activated in Samba 3\&.0\&.31 and above, as it now only controls permission changes if the user is in the owning primary group\&. It is now no longer equivalent to the
1117 \fI\fIacl group control\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1120 acl map full control (S)
1121 .\" acl map full control
1124 This boolean parameter controls whether
1125 \fBsmbd\fR(8)maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum allowed POSIX permission set, into a Windows ACL of "FULL CONTROL"\&. If this parameter is set to true any POSIX ACE entry of "rwx" will be returned in a Windows ACL as "FULL CONTROL", is this parameter is set to false any POSIX ACE entry of "rwx" will be returned as the specific Windows ACL bits representing read, write and execute\&.
1128 \fI\fIacl map full control\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
1131 add group script (G)
1132 .\" add group script
1135 This is the full pathname to a script that will be run
1139 when a new group is requested\&. It will expand any
1141 to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&. The script is free to create a group with an arbitrary name to circumvent unix group name restrictions\&. In that case the script must print the numeric gid of the created group on stdout\&.
1144 \fI\fIadd group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1147 \fI\fIadd group script\fR\fR\fI = \fR\fI\FC/usr/sbin/groupadd %g\F[]\fR\fI \fR
1150 add machine script (G)
1151 .\" add machine script
1154 This is the full pathname to a script that will be run by
1156 when a machine is added to Samba\'s domain and a Unix account matching the machine\'s name appended with a "$" does not already exist\&.
1158 This option is very similar to the
1159 \m[blue]\fBadd user script\fR\m[], and likewise uses the %u substitution for the account name\&. Do not use the %m substitution\&.
1162 \fI\fIadd machine script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1165 \fI\fIadd machine script\fR\fR\fI = \fR\fI\FC/usr/sbin/adduser \-n \-g machines \-c Machine \-d /var/lib/nobody \-s /bin/false %u\F[]\fR\fI \fR
1168 add port command (G)
1169 .\" add port command
1172 Samba 3\&.0\&.23 introduced support for adding printer ports remotely using the Windows "Add Standard TCP/IP Port Wizard"\&. This option defines an external program to be executed when smbd receives a request to add a new Port to the system\&. The script is passed two parameters:
1176 \h'-04'\(bu\h'+03'\c
1187 \h'-04'\(bu\h'+03'\c
1196 The deviceURI is in the for of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>\&.
1199 \fI\fIadd port command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1202 \fI\fIadd port command\fR\fR\fI = \fR\fI\FC/etc/samba/scripts/addport\&.sh\F[]\fR\fI \fR
1205 addprinter command (G)
1206 .\" addprinter command
1209 With the introduction of MS\-RPC based printing support for Windows NT/2000 clients in Samba 2\&.2, The MS Add Printer Wizard (APW) icon is now also available in the "Printers\&.\&.\&." folder displayed a share listing\&. The APW allows for printers to be add remotely to a Samba or Windows NT/2000 print server\&.
1211 For a Samba host this means that the printer must be physically added to the underlying printing system\&. The
1212 \fIaddprinter command\fR
1213 defines a script to be run which will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition to the
1215 file in order that it can be shared by
1219 \fIaddprinter command\fR
1220 is automatically invoked with the following parameter (in order):
1224 \h'-04'\(bu\h'+03'\c
1235 \h'-04'\(bu\h'+03'\c
1246 \h'-04'\(bu\h'+03'\c
1257 \h'-04'\(bu\h'+03'\c
1268 \h'-04'\(bu\h'+03'\c
1279 \h'-04'\(bu\h'+03'\c
1285 \fIWindows 9x driver location\fR
1288 All parameters are filled in from the PRINTER_INFO_2 structure sent by the Windows NT/2000 client with one exception\&. The "Windows 9x driver location" parameter is included for backwards compatibility only\&. The remaining fields in the structure are generated from answers to the APW questions\&.
1291 \fIaddprinter command\fR
1296 to determine if the share defined by the APW exists\&. If the sharename is still invalid, then
1298 will return an ACCESS_DENIED error to the client\&.
1301 \fIaddprinter command\fR
1302 program can output a single line of text, which Samba will set as the port the new printer is connected to\&. If this line isn\'t output, Samba won\'t reload its printer shares\&.
1305 \fI\fIaddprinter command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1308 \fI\fIaddprinter command\fR\fR\fI = \fR\fI\FC/usr/bin/addprinter\F[]\fR\fI \fR
1311 add share command (G)
1312 .\" add share command
1315 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
1316 \fIadd share command\fR
1317 is used to define an external program or script which will add a new service definition to
1318 \FCsmb\&.conf\F[]\&.
1320 In order to successfully execute the
1321 \fIadd share command\fR,
1323 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
1324 \FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
1325 \fIadd share command\fR
1326 parameter are executed as root\&.
1330 will automatically invoke the
1331 \fIadd share command\fR
1332 with five parameters\&.
1336 \h'-04'\(bu\h'+03'\c
1343 \- the location of the global
1350 \h'-04'\(bu\h'+03'\c
1357 \- the name of the new share\&.
1362 \h'-04'\(bu\h'+03'\c
1369 \- path to an **existing** directory on disk\&.
1374 \h'-04'\(bu\h'+03'\c
1381 \- comment string to associate with the new share\&.
1386 \h'-04'\(bu\h'+03'\c
1392 \fImax connections\fR
1393 Number of maximum simultaneous connections to this share\&.
1396 This parameter is only used to add file shares\&. To add printer shares, see the
1397 \m[blue]\fBaddprinter command\fR\m[]\&.
1400 \fI\fIadd share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1403 \fI\fIadd share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/addshare\F[]\fR\fI \fR
1410 This is the full pathname to a script that will be run
1414 under special circumstances described below\&.
1416 Normally, a Samba server requires that UNIX users are created for all users accessing files on this server\&. For sites that use Windows NT account databases as their primary user database creating these users and keeping the user list in sync with the Windows NT PDC is an onerous task\&. This option allows smbd to create the required UNIX users
1418 when a user accesses the Samba server\&.
1420 In order to use this option,
1425 \m[blue]\fBsecurity = share\fR\m[]
1427 \m[blue]\fBadd user script\fR\m[]
1428 must be set to a full pathname for a script that will create a UNIX user given one argument of
1429 \fI%u\fR, which expands into the UNIX user name to create\&.
1431 When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time,
1434 \m[blue]\fBpassword server\fR\m[]
1435 and attempts to authenticate the given user with the given password\&. If the authentication succeeds then
1437 attempts to find a UNIX user in the UNIX password database to map the Windows user into\&. If this lookup fails, and
1438 \m[blue]\fBadd user script\fR\m[]
1441 will call the specified script
1442 \fIAS ROOT\fR, expanding any
1444 argument to be the user name to create\&.
1446 If this script successfully creates the user then
1448 will continue on as though the UNIX user already existed\&. In this way, UNIX users are dynamically created to match existing Windows NT accounts\&.
1451 \m[blue]\fBsecurity\fR\m[],
1452 \m[blue]\fBpassword server\fR\m[],
1453 \m[blue]\fBdelete user script\fR\m[]\&.
1456 \fI\fIadd user script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1459 \fI\fIadd user script\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/add_user %u\F[]\fR\fI \fR
1462 add user to group script (G)
1463 .\" add user to group script
1466 Full path to the script that will be called when a user is added to a group using the Windows NT domain administration tools\&. It will be run by
1468 \fIAS ROOT\fR\&. Any
1470 will be replaced with the group name and any
1472 will be replaced with the user name\&.
1476 command used in the example below does not support the used syntax on all systems\&.
1479 \fI\fIadd user to group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1482 \fI\fIadd user to group script\fR\fR\fI = \fR\fI\FC/usr/sbin/adduser %u %g\F[]\fR\fI \fR
1485 administrative share (S)
1486 .\" administrative share
1489 If this parameter is set to
1491 for a share, then the share will be an administrative share\&. The Administrative Shares are the default network shares created by all Windows NT\-based operating systems\&. These are shares like C$, D$ or ADMIN$\&. The type of these shares is STYPE_DISKTREE_HIDDEN\&.
1493 See the section below on
1494 \m[blue]\fBsecurity\fR\m[]
1495 for more information about this option\&.
1498 \fI\fIadministrative share\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1505 This is a list of users who will be granted administrative privileges on the share\&. This means that they will do all file operations as the super\-user (root)\&.
1507 You should use this option very carefully, as any user in this list will be able to do anything they like on the share, irrespective of file permissions\&.
1509 This parameter will not work with the
1510 \m[blue]\fBsecurity = share\fR\m[]
1511 in Samba 3\&.0\&. This is by design\&.
1514 \fI\fIadmin users\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1517 \fI\fIadmin users\fR\fR\fI = \fR\fI\FCjason\F[]\fR\fI \fR
1524 This parameter controls whether special AFS features are enabled for this share\&. If enabled, it assumes that the directory exported via the
1526 parameter is a local AFS import\&. The special AFS features include the attempt to hand\-craft an AFS token if you enabled \-\-with\-fake\-kaserver in configure\&.
1529 \fI\fIafs share\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1532 afs username map (G)
1533 .\" afs username map
1536 If you are using the fake kaserver AFS feature, you might want to hand\-craft the usernames you are creating tokens for\&. For example this is necessary if you have users from several domain in your AFS Protection Database\&. One possible scheme to code users as DOMAIN+User as it is done by winbind with the + as a separator\&.
1538 The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token\&.
1541 \fI\fIafs username map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1544 \fI\fIafs username map\fR\fR\fI = \fR\fI\FC%u@afs\&.samba\&.org\F[]\fR\fI \fR
1551 If Samba has been built with asynchronous I/O support and this integer parameter is set to non\-zero value, Samba will read from file asynchronously when size of request is bigger than this value\&. Note that it happens only for non\-chained and non\-chaining reads and when not using write cache\&.
1553 Current implementation of asynchronous I/O in Samba 3\&.0 does support only up to 10 outstanding asynchronous requests, read and write combined\&.
1556 \m[blue]\fBwrite cache size\fR\m[]
1559 \m[blue]\fBaio write size\fR\m[]
1562 \fI\fIaio read size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
1565 \fI\fIaio read size\fR\fR\fI = \fR\fI\FC16384 # Use asynchronous I/O for reads bigger than 16KB request size\F[]\fR\fI \fR
1572 If Samba has been built with asynchronous I/O support and this integer parameter is set to non\-zero value, Samba will write to file asynchronously when size of request is bigger than this value\&. Note that it happens only for non\-chained and non\-chaining reads and when not using write cache\&.
1574 Current implementation of asynchronous I/O in Samba 3\&.0 does support only up to 10 outstanding asynchronous requests, read and write combined\&.
1577 \m[blue]\fBwrite cache size\fR\m[]
1580 \m[blue]\fBaio read size\fR\m[]
1583 \fI\fIaio write size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
1586 \fI\fIaio write size\fR\fR\fI = \fR\fI\FC16384 # Use asynchronous I/O for writes bigger than 16KB request size\F[]\fR\fI \fR
1589 algorithmic rid base (G)
1590 .\" algorithmic rid base
1593 This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers\&.
1595 Setting this option to a larger value could be useful to sites transitioning from WinNT and Win2k, as existing user and group rids would otherwise clash with sytem users etc\&.
1597 All UIDs and GIDs must be able to be resolved into SIDs for the correct operation of ACLs on the server\&. As such the algorithmic mapping can\'t be \'turned off\', but pushing it \'out of the way\' should resolve the issues\&. Users and groups can then be assigned \'low\' RIDs in arbitrary\-rid supporting backends\&.
1600 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
1603 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI\FC100000\F[]\fR\fI \fR
1606 allocation roundup size (S)
1607 .\" allocation roundup size
1610 This parameter allows an administrator to tune the allocation size reported to Windows clients\&. The default size of 1Mb generally results in improved Windows client performance\&. However, rounding the allocation size may cause difficulties for some applications, e\&.g\&. MS Visual Studio\&. If the MS Visual Studio compiler starts to crash with an internal error, set this parameter to zero for this share\&.
1612 The integer parameter specifies the roundup size in bytes\&.
1615 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI\FC1048576\F[]\fR\fI \fR
1618 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI\FC0 # (to disable roundups)\F[]\fR\fI \fR
1621 allow trusted domains (G)
1622 .\" allow trusted domains
1625 This option only takes effect when the
1626 \m[blue]\fBsecurity\fR\m[]
1631 \fBads\fR\&. If it is set to no, then attempts to connect to a resource from a domain or workgroup other than the one which smbd is running in will fail, even if that domain is trusted by the remote server doing the authentication\&.
1633 This is useful if you only want your Samba server to serve resources to users in the domain it is a member of\&. As an example, suppose that there are two domains DOMA and DOMB\&. DOMB is trusted by DOMA, which contains the Samba server\&. Under normal circumstances, a user with an account in DOMB can then access the resources of a UNIX account with the same account name on the Samba server even if they do not have an account in DOMA\&. This can make implementing a security boundary difficult\&.
1636 \fI\fIallow trusted domains\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1643 This specifies what type of server
1645 will announce itself as, to a network neighborhood browse list\&. By default this is set to Windows NT\&. The valid options are : "NT Server" (which can also be written as "NT"), "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, Windows NT Workstation, Windows 95 and Windows for Workgroups respectively\&. Do not change this parameter unless you have a specific need to stop Samba appearing as an NT server as this may prevent Samba servers from participating as browser servers correctly\&.
1648 \fI\fIannounce as\fR\fR\fI = \fR\fI\FCNT Server\F[]\fR\fI \fR
1651 \fI\fIannounce as\fR\fR\fI = \fR\fI\FCWin95\F[]\fR\fI \fR
1654 announce version (G)
1655 .\" announce version
1658 This specifies the major and minor version numbers that nmbd will use when announcing itself as a server\&. The default is 4\&.9\&. Do not change this parameter unless you have a specific need to set a Samba server to be a downlevel server\&.
1661 \fI\fIannounce version\fR\fR\fI = \fR\fI\FC4\&.9\F[]\fR\fI \fR
1664 \fI\fIannounce version\fR\fR\fI = \fR\fI\FC2\&.0\F[]\fR\fI \fR
1671 This option allows the administrator to chose what authentication methods
1673 will use when authenticating a user\&. This option defaults to sensible values based on
1674 \m[blue]\fBsecurity\fR\m[]\&. This should be considered a developer option and used only in rare circumstances\&. In the majority (if not all) of production servers, the default setting should be adequate\&.
1676 Each entry in the list attempts to authenticate the user in turn, until the user authenticates\&. In practice only one method will ever actually be able to complete the authentication\&.
1678 Possible options include
1682 (lookups in local list of accounts based on netbios name or domain name),
1684 (relay authentication requests for remote users through winbindd),
1686 (pre\-winbindd method of authentication for remote domain users; deprecated in favour of winbind method),
1688 (authenticate trusted users by contacting the remote DC directly from smbd; deprecated in favour of winbind method)\&.
1691 \fI\fIauth methods\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1694 \fI\fIauth methods\fR\fR\fI = \fR\fI\FCguest sam winbind\F[]\fR\fI \fR
1701 This parameter lets you "turn off" a service\&. If
1702 \fIavailable = no\fR, then
1704 attempts to connect to the service will fail\&. Such failures are logged\&.
1707 \fI\fIavailable\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1710 bind interfaces only (G)
1711 .\" bind interfaces only
1714 This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\&. It affects file service
1718 in a slightly different ways\&.
1720 For name service it causes
1722 to bind to ports 137 and 138 on the interfaces listed in the
1723 \m[blue]\fBinterfaces\fR\m[]
1726 also binds to the "all addresses" interface (0\&.0\&.0\&.0) on ports 137 and 138 for the purposes of reading broadcast messages\&. If this option is not set then
1728 will service name requests on all of these sockets\&. If
1729 \m[blue]\fBbind interfaces only\fR\m[]
1732 will check the source address of any packets coming in on the broadcast sockets and discard any that don\'t match the broadcast addresses of the interfaces in the
1733 \m[blue]\fBinterfaces\fR\m[]
1734 parameter list\&. As unicast packets are received on the other sockets it allows
1736 to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the
1737 \m[blue]\fBinterfaces\fR\m[]
1738 list\&. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
1741 For file service it causes
1743 to bind only to the interface list given in the
1744 \m[blue]\fBinterfaces\fR\m[]
1745 parameter\&. This restricts the networks that
1747 will serve, to packets coming in on those interfaces\&. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non\-broadcast network interfaces as it will not cope with non\-permanent interfaces\&.
1750 \m[blue]\fBbind interfaces only\fR\m[]
1751 is set and the network address
1752 \fI127\&.0\&.0\&.1\fR
1754 \m[blue]\fBinterfaces\fR\m[]
1759 may not work as expected due to the reasons covered below\&.
1761 To change a users SMB password, the
1763 by default connects to the
1764 \fIlocalhost \- 127\&.0\&.0\&.1\fR
1765 address as an SMB client to issue the password change request\&. If
1766 \m[blue]\fBbind interfaces only\fR\m[]
1767 is set then unless the network address
1768 \fI127\&.0\&.0\&.1\fR
1770 \m[blue]\fBinterfaces\fR\m[]
1773 will fail to connect in it\'s default mode\&.
1775 can be forced to use the primary IP interface of the local host by using its
1777 \fI\-r \fR\fI\fIremote machine\fR\fR
1779 \fIremote machine\fR
1780 set to the IP name of the primary interface of the local host\&.
1784 status page tries to connect with
1789 \fI127\&.0\&.0\&.1\fR
1790 to determine if they are running\&. Not adding
1791 \fI127\&.0\&.0\&.1\fR
1796 to always show "not running" even if they really are\&. This can prevent
1798 from starting/stopping/restarting
1804 \fI\fIbind interfaces only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1811 This parameter controls the behavior of
1813 when given a request by a client to obtain a byte range lock on a region of an open file, and the request has a time limit associated with it\&.
1815 If this parameter is set and the lock range requested cannot be immediately satisfied, samba will internally queue the lock request, and periodically attempt to obtain the lock until the timeout period expires\&.
1817 If this parameter is set to
1818 \fBno\fR, then samba will behave as previous versions of Samba would and will fail the lock request immediately if the lock range cannot be obtained\&.
1821 \fI\fIblocking locks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1828 This parameter controls the behavior of
1830 when reporting disk free sizes\&. By default, this reports a disk block size of 1024 bytes\&.
1832 Changing this parameter may have some effect on the efficiency of client writes, this is not yet confirmed\&. This parameter was added to allow advanced administrators to change it (usually to a higher value) and test the effect it has on client write performance without re\-compiling the code\&. As this is an experimental option it may be removed in a future release\&.
1834 Changing this option does not change the disk free reporting size, just the block size unit reported to the client\&.
1837 \fI\fIblock size\fR\fR\fI = \fR\fI\FC1024\F[]\fR\fI \fR
1840 \fI\fIblock size\fR\fR\fI = \fR\fI\FC4096\F[]\fR\fI \fR
1847 This parameter is a synonym for
1855 This controls whether this share is seen in the list of available shares in a net view and in the browse list\&.
1858 \fI\fIbrowseable\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1865 This controls whether
1867 will serve a browse list to a client doing a
1868 \FCNetServerEnum\F[]
1869 call\&. Normally set to
1870 \fByes\fR\&. You should never need to change this\&.
1873 \fI\fIbrowse list\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1880 This parameter is a synonym for
1888 See the discussion in the section
1889 \m[blue]\fBname mangling\fR\m[]\&.
1892 \fI\fIcase sensitive\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1899 This parameter specifies whether Samba should reply to a client\'s file change notify requests\&.
1901 You should never need to change this parameter
1904 \fI\fIchange notify\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1907 change share command (G)
1908 .\" change share command
1911 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
1912 \fIchange share command\fR
1913 is used to define an external program or script which will modify an existing service definition in
1914 \FCsmb\&.conf\F[]\&.
1916 In order to successfully execute the
1917 \fIchange share command\fR,
1919 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
1920 \FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
1921 \fIchange share command\fR
1922 parameter are executed as root\&.
1926 will automatically invoke the
1927 \fIchange share command\fR
1928 with five parameters\&.
1932 \h'-04'\(bu\h'+03'\c
1939 \- the location of the global
1946 \h'-04'\(bu\h'+03'\c
1953 \- the name of the new share\&.
1958 \h'-04'\(bu\h'+03'\c
1965 \- path to an **existing** directory on disk\&.
1970 \h'-04'\(bu\h'+03'\c
1977 \- comment string to associate with the new share\&.
1982 \h'-04'\(bu\h'+03'\c
1988 \fImax connections\fR
1989 Number of maximum simultaneous connections to this share\&.
1992 This parameter is only used to modify existing file share definitions\&. To modify printer shares, use the "Printers\&.\&.\&." folder as seen when browsing the Samba host\&.
1995 \fI\fIchange share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1998 \fI\fIchange share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/changeshare\F[]\fR\fI \fR
2001 check password script (G)
2002 .\" check password script
2005 The name of a program that can be used to check password complexity\&. The password is sent to the program\'s standard input\&.
2007 The program must return 0 on a good password, or any other value if the password is bad\&. In case the password is considered weak (the program does not return 0) the user will be notified and the password change will fail\&.
2009 Note: In the example directory is a sample program called
2011 that uses cracklib to check the password quality\&.
2014 \fI\fIcheck password script\fR\fR\fI = \fR\fI\FCDisabled\F[]\fR\fI \fR
2017 \fI\fIcheck password script\fR\fR\fI = \fR\fI\FC/usr/local/sbin/crackcheck\F[]\fR\fI \fR
2020 client lanman auth (G)
2021 .\" client lanman auth
2024 This parameter determines whether or not
2026 and other samba client tools will attempt to authenticate itself to servers using the weaker LANMAN password hash\&. If disabled, only server which support NT password hashes (e\&.g\&. Windows NT/2000, Samba, etc\&.\&.\&. but not Windows 95/98) will be able to be connected from the Samba client\&.
2028 The LANMAN encrypted response is easily broken, due to its case\-insensitive nature, and the choice of algorithm\&. Clients without Windows 95/98 servers are advised to disable this option\&.
2030 Disabling this option will also disable the
2031 \FCclient plaintext auth\F[]
2035 \FCclient ntlmv2 auth\F[]
2036 parameter is enabled, then only NTLMv2 logins will be attempted\&.
2039 \fI\fIclient lanman auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2042 client ldap sasl wrapping (G)
2043 .\" client ldap sasl wrapping
2047 \m[blue]\fBclient ldap sasl wrapping\fR\m[]
2048 defines whether ldap traffic will be signed or signed and encrypted (sealed)\&. Possible values are
2058 are only available if Samba has been compiled against a modern OpenLDAP version (2\&.3\&.x or higher)\&.
2060 This option is needed in the case of Domain Controllers enforcing the usage of signed LDAP connections (e\&.g\&. Windows 2000 SP3 or higher)\&. LDAP sign and seal can be controlled with the registry key "\FCHKLM\eSystem\eCurrentControlSet\eServices\e\F[]
2061 \FCNTDS\eParameters\eLDAPServerIntegrity\F[]" on the Windows server side\&.
2063 Depending on the used KRB5 library (MIT and older Heimdal versions) it is possible that the message "integrity only" is not supported\&. In this case,
2065 is just an alias for
2068 The default value is
2070 which is not irritable to KRB5 clock skew errors\&. That implies synchronizing the time with the KDC in the case of using
2076 \fI\fIclient ldap sasl wrapping\fR\fR\fI = \fR\fI\FCplain\F[]\fR\fI \fR
2079 client ntlmv2 auth (G)
2080 .\" client ntlmv2 auth
2083 This parameter determines whether or not
2085 will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\&.
2087 If enabled, only an NTLMv2 and LMv2 response (both much more secure than earlier versions) will be sent\&. Many servers (including NT4 < SP4, Win9x and Samba 2\&.2) are not compatible with NTLMv2\&.
2089 Similarly, if enabled, NTLMv1,
2090 \FCclient lanman auth\F[]
2092 \FCclient plaintext auth\F[]
2093 authentication will be disabled\&. This also disables share\-level authentication\&.
2095 If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of
2096 \FCclient lanman auth\F[]\&.
2098 Note that some sites (particularly those following \'best practice\' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM\&.
2101 \fI\fIclient ntlmv2 auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2104 client plaintext auth (G)
2105 .\" client plaintext auth
2108 Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\&.
2111 \fI\fIclient plaintext auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2118 This controls whether the client offers or even demands the use of the netlogon schannel\&.
2119 \m[blue]\fBclient schannel = no\fR\m[]
2120 does not offer the schannel,
2121 \m[blue]\fBclient schannel = auto\fR\m[]
2122 offers the schannel but does not enforce it, and
2123 \m[blue]\fBclient schannel = yes\fR\m[]
2124 denies access if the server is not able to speak netlogon schannel\&.
2127 \fI\fIclient schannel\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
2130 \fI\fIclient schannel\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
2137 This controls whether the client is allowed or required to use SMB signing\&. Possible values are
2143 When set to auto, SMB signing is offered, but not enforced\&. When set to mandatory, SMB signing is required and if set to disabled, SMB signing is not offered either\&.
2146 \fI\fIclient signing\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
2149 client use spnego (G)
2150 .\" client use spnego
2153 This variable controls whether Samba clients will try to use Simple and Protected NEGOciation (as specified by rfc2478) with supporting servers (including WindowsXP, Windows2000 and Samba 3\&.0) to agree upon an authentication mechanism\&. This enables Kerberos authentication in particular\&.
2156 \fI\fIclient use spnego\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
2159 cluster addresses (G)
2160 .\" cluster addresses
2163 With this parameter you can add additional addresses nmbd will register with a WINS server\&. These addresses are not necessarily present on all nodes simultaneously, but they will be registered with the WINS server so that clients can contact any of the nodes\&.
2166 \fI\fIcluster addresses\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2169 \fI\fIcluster addresses\fR\fR\fI = \fR\fI\FC10\&.0\&.0\&.1 10\&.0\&.0\&.2 10\&.0\&.0\&.3\F[]\fR\fI \fR
2176 This parameter specifies whether Samba should contact ctdb for accessing its tdb files and use ctdb as a backend for its messaging backend\&.
2178 Set this parameter to
2180 only if you have a cluster setup with ctdb running\&.
2183 \fI\fIclustering\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2190 This is a text field that is seen next to a share when a client does a queries the server, either via the network neighborhood or via
2192 to list what shares are available\&.
2194 If you want to set the string that is displayed next to the machine name then see the
2195 \m[blue]\fBserver string\fR\m[]
2199 \fI\fIcomment\fR\fR\fI = \fR\fI\FC # No comment\F[]\fR\fI \fR
2202 \fI\fIcomment\fR\fR\fI = \fR\fI\FCFred\'s Files\F[]\fR\fI \fR
2209 This controls the backend for storing the configuration\&. Possible values are
2212 \fIregistry\fR\&. When
2213 \m[blue]\fBconfig backend = registry\fR\m[]
2214 is encountered while loading
2215 \fIsmb\&.conf\fR, the configuration read so far is dropped and the global options are read from registry instead\&. So this triggers a registry only configuration\&. Share definitions are not read immediately but instead
2216 \fIregistry shares\fR
2220 Note: This option can not be set inside the registry configuration itself\&.
2223 \fI\fIconfig backend\fR\fR\fI = \fR\fI\FCfile\F[]\fR\fI \fR
2226 \fI\fIconfig backend\fR\fR\fI = \fR\fI\FCregistry\F[]\fR\fI \fR
2233 This allows you to override the config file to use, instead of the default (usually
2234 \FCsmb\&.conf\F[])\&. There is a chicken and egg problem here as this option is set in the config file!
2236 For this reason, if the name of the config file has changed when the parameters are loaded then it will reload them from the new config file\&.
2238 This option takes the usual substitutions, which can be very useful\&.
2240 If the config file doesn\'t exist then it won\'t be loaded (allowing you to special case the config files of just a few clients)\&.
2245 \fI\fIconfig file\fR\fR\fI = \fR\fI\FC/usr/local/samba/lib/smb\&.conf\&.%m\F[]\fR\fI \fR
2252 This parameter allows you to "clone" service entries\&. The specified service is simply duplicated under the current service\'s name\&. Any parameters specified in the current section will override those in the section being copied\&.
2254 This feature lets you set up a \'template\' service and create similar services easily\&. Note that the service being copied must occur earlier in the configuration file than the service doing the copying\&.
2257 \fI\fIcopy\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2260 \fI\fIcopy\fR\fR\fI = \fR\fI\FCotherservice\F[]\fR\fI \fR
2267 This parameter is a synonym for
2275 When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit\-wise \'AND\'ed with this parameter\&. This parameter may be thought of as a bit\-wise MASK for the UNIX modes of a file\&. Any bit
2277 set here will be removed from the modes set on a file when it is created\&.
2279 The default value of this parameter removes the
2283 write and execute bits from the UNIX modes\&.
2285 Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the
2286 \m[blue]\fBforce create mode\fR\m[]
2287 parameter which is set to 000 by default\&.
2289 This parameter does not affect directory masks\&. See the parameter
2290 \m[blue]\fBdirectory mask\fR\m[]
2293 Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors\&. If the administrator wishes to enforce a mask on access control lists also, they need to set the
2294 \m[blue]\fBsecurity mask\fR\m[]\&.
2297 \fI\fIcreate mask\fR\fR\fI = \fR\fI\FC0744\F[]\fR\fI \fR
2300 \fI\fIcreate mask\fR\fR\fI = \fR\fI\FC0775\F[]\fR\fI \fR
2308 \fIclient\-side caching policy\fR, and specifies how clients capable of offline caching will cache the files in the share\&. The valid values are: manual, documents, programs, disable\&.
2310 These values correspond to those used on Windows servers\&.
2312 For example, shares containing roaming profiles can have offline caching disabled using
2313 \m[blue]\fBcsc policy = disable\fR\m[]\&.
2316 \fI\fIcsc policy\fR\fR\fI = \fR\fI\FCmanual\F[]\fR\fI \fR
2319 \fI\fIcsc policy\fR\fR\fI = \fR\fI\FCprograms\F[]\fR\fI \fR
2327 \FCclustering=yes\F[], you need to tell Samba where ctdbd listens on its unix domain socket\&. The default path as of ctdb 1\&.0 is /tmp/ctdb\&.socket which you have to explicitly set for Samba in smb\&.conf\&.
2330 \fI\fIctdbd socket\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2333 \fI\fIctdbd socket\fR\fR\fI = \fR\fI\FC/tmp/ctdb\&.socket\F[]\fR\fI \fR
2336 cups connection timeout (G)
2337 .\" cups connection timeout
2340 This parameter is only applicable if
2341 \m[blue]\fBprinting\fR\m[]
2345 If set, this option specifies the number of seconds that smbd will wait whilst trying to contact to the CUPS server\&. The connection will fail if it takes longer than this number of seconds\&.
2348 \fI\fIcups connection timeout\fR\fR\fI = \fR\fI\FC30\F[]\fR\fI \fR
2351 \fI\fIcups connection timeout\fR\fR\fI = \fR\fI\FC60\F[]\fR\fI \fR
2358 This parameter is only applicable if
2359 \m[blue]\fBprinting\fR\m[]
2361 \fBcups\fR\&. Its value is a free form string of options passed directly to the cups library\&.
2363 You can pass any generic print option known to CUPS (as listed in the CUPS "Software Users\' Manual")\&. You can also pass any printer specific option (as listed in "lpoptions \-d printername \-l") valid for the target queue\&. Multiple parameters should be space\-delimited name/value pairs according to the PAPI text option ABNF specification\&. Collection values ("name={a=\&.\&.\&. b=\&.\&.\&. c=\&.\&.\&.}") are stored with the curley brackets intact\&.
2365 You should set this parameter to
2369 file contains messages such as "Unsupported format \'application/octet\-stream\'" when printing from a Windows client through Samba\&. It is no longer necessary to enable system wide raw printing in
2370 \FC/etc/cups/mime\&.{convs,types}\F[]\&.
2373 \fI\fIcups options\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
2376 \fI\fIcups options\fR\fR\fI = \fR\fI\FC"raw media=a4"\F[]\fR\fI \fR
2383 This parameter is only applicable if
2384 \m[blue]\fBprinting\fR\m[]
2388 If set, this option overrides the ServerName option in the CUPS
2389 \FCclient\&.conf\F[]\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
2391 Optionally, a port can be specified by separating the server name and port number with a colon\&. If no port was specified, the default port for IPP (631) will be used\&.
2394 \fI\fIcups server\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
2397 \fI\fIcups server\fR\fR\fI = \fR\fI\FCmycupsserver\F[]\fR\fI \fR
2400 \fI\fIcups server\fR\fR\fI = \fR\fI\FCmycupsserver:1631\F[]\fR\fI \fR
2407 The value of the parameter (a decimal integer) represents the number of minutes of inactivity before a connection is considered dead, and it is disconnected\&. The deadtime only takes effect if the number of open files is zero\&.
2409 This is useful to stop a server\'s resources being exhausted by a large number of inactive connections\&.
2411 Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\&.
2413 Using this parameter with a timeout of a few minutes is recommended for most systems\&.
2415 A deadtime of zero indicates that no auto\-disconnection should be performed\&.
2418 \fI\fIdeadtime\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
2421 \fI\fIdeadtime\fR\fR\fI = \fR\fI\FC15\F[]\fR\fI \fR
2428 With this boolean parameter enabled, the debug class (DBGC_CLASS) will be displayed in the debug header\&.
2430 For more information about currently available debug classes, see section about
2431 \m[blue]\fBlog level\fR\m[]\&.
2434 \fI\fIdebug class\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2437 debug hires timestamp (G)
2438 .\" debug hires timestamp
2441 Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this boolean parameter adds microsecond resolution to the timestamp message header when turned on\&.
2443 Note that the parameter
2444 \m[blue]\fBdebug timestamp\fR\m[]
2445 must be on for this to have an effect\&.
2448 \fI\fIdebug hires timestamp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2455 When using only one log file for more then one forked
2456 \fBsmbd\fR(8)\-process there may be hard to follow which process outputs which message\&. This boolean parameter is adds the process\-id to the timestamp message headers in the logfile when turned on\&.
2458 Note that the parameter
2459 \m[blue]\fBdebug timestamp\fR\m[]
2460 must be on for this to have an effect\&.
2463 \fI\fIdebug pid\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2466 debug prefix timestamp (G)
2467 .\" debug prefix timestamp
2470 With this option enabled, the timestamp message header is prefixed to the debug message without the filename and function information that is included with the
2471 \m[blue]\fBdebug timestamp\fR\m[]
2472 parameter\&. This gives timestamps to the messages without adding an additional line\&.
2474 Note that this parameter overrides the
2475 \m[blue]\fBdebug timestamp\fR\m[]
2479 \fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2486 This parameter is a synonym for
2494 Samba debug log messages are timestamped by default\&. If you are running at a high
2495 \m[blue]\fBdebug level\fR\m[]
2496 these timestamps can be distracting\&. This boolean parameter allows timestamping to be turned off\&.
2499 \fI\fIdebug timestamp\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
2506 Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the current euid, egid, uid and gid to the timestamp message headers in the log file if turned on\&.
2508 Note that the parameter
2509 \m[blue]\fBdebug timestamp\fR\m[]
2510 must be on for this to have an effect\&.
2513 \fI\fIdebug uid\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2516 dedicated keytab file (G)
2517 .\" dedicated keytab file
2520 Specifies the path to the kerberos keytab file when
2521 \m[blue]\fBkerberos method\fR\m[]
2522 is set to "dedicated keytab"\&.
2525 \fI\fIdedicated keytab file\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2528 \fI\fIdedicated keytab file\fR\fR\fI = \fR\fI\FC/usr/local/etc/krb5\&.keytab\F[]\fR\fI \fR
2536 \m[blue]\fBname mangling\fR\m[]\&. Also note the
2537 \m[blue]\fBshort preserve case\fR\m[]
2541 \fI\fIdefault case\fR\fR\fI = \fR\fI\FClower\F[]\fR\fI \fR
2548 This parameter is only applicable to
2549 \m[blue]\fBprintable\fR\m[]
2550 services\&. When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba server has a Device Mode which defines things such as paper size and orientation and duplex settings\&. The device mode can only correctly be generated by the printer driver itself (which can only be executed on a Win32 platform)\&. Because smbd is unable to execute the driver code to generate the device mode, the default behavior is to set this field to NULL\&.
2552 Most problems with serving printer drivers to Windows NT/2k/XP clients can be traced to a problem with the generated device mode\&. Certain drivers will do things such as crashing the client\'s Explorer\&.exe with a NULL devmode\&. However, other printer drivers can cause the client\'s spooler service (spoolsv\&.exe) to die if the devmode was not created by the driver itself (i\&.e\&. smbd generates a default devmode)\&.
2554 This parameter should be used with care and tested with the printer driver in question\&. It is better to leave the device mode to NULL and let the Windows client set the correct values\&. Because drivers do not do this all the time, setting
2555 \FCdefault devmode = yes\F[]
2556 will instruct smbd to generate a default one\&.
2558 For more information on Windows NT/2k printing and Device Modes, see the
2559 MSDN documentation\&.
2562 \fI\fIdefault devmode\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
2569 This parameter is a synonym for
2577 This parameter specifies the name of a service which will be connected to if the service actually requested cannot be found\&. Note that the square brackets are
2579 given in the parameter value (see example below)\&.
2581 There is no default value for this parameter\&. If this parameter is not given, attempting to connect to a nonexistent service results in an error\&.
2583 Typically the default service would be a
2584 \m[blue]\fBguest ok\fR\m[],
2585 \m[blue]\fBread\-only\fR\m[]
2588 Also note that the apparent service name will be changed to equal that of the requested service, this is very useful as it allows you to use macros like
2590 to make a wildcard service\&.
2592 Note also that any "_" characters in the name of the service used in the default service will get mapped to a "/"\&. This allows for interesting things\&.
2595 \fI\fIdefault service\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2598 \fI\fIdefault service\fR\fR\fI = \fR\fI\FCpub\F[]\fR\fI \fR
2601 defer sharing violations (G)
2602 .\" defer sharing violations
2605 Windows allows specifying how a file will be shared with other processes when it is opened\&. Sharing violations occur when a file is opened by a different process using options that violate the share settings specified by other processes\&. This parameter causes smbd to act as a Windows server does, and defer returning a "sharing violation" error message for up to one second, allowing the client to close the file causing the violation in the meantime\&.
2607 UNIX by default does not have this behaviour\&.
2609 There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\&.
2612 \fI\fIdefer sharing violations\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
2615 delete group script (G)
2616 .\" delete group script
2619 This is the full pathname to a script that will be run
2622 when a group is requested to be deleted\&. It will expand any
2624 to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&.
2627 \fI\fIdelete group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2630 deleteprinter command (G)
2631 .\" deleteprinter command
2634 With the introduction of MS\-RPC based printer support for Windows NT/2000 clients in Samba 2\&.2, it is now possible to delete a printer at run time by issuing the DeletePrinter() RPC call\&.
2636 For a Samba host this means that the printer must be physically deleted from the underlying printing system\&. The
2637 \m[blue]\fBdeleteprinter command\fR\m[]
2638 defines a script to be run which will perform the necessary operations for removing the printer from the print system and from
2639 \FCsmb\&.conf\F[]\&.
2642 \m[blue]\fBdeleteprinter command\fR\m[]
2643 is automatically called with only one parameter:
2644 \m[blue]\fBprinter name\fR\m[]\&.
2647 \m[blue]\fBdeleteprinter command\fR\m[]
2652 to check that the associated printer no longer exists\&. If the sharename is still valid, then
2654 will return an ACCESS_DENIED error to the client\&.
2657 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2660 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\FC/usr/bin/removeprinter\F[]\fR\fI \fR
2667 This parameter allows readonly files to be deleted\&. This is not normal DOS semantics, but is allowed by UNIX\&.
2669 This option may be useful for running applications such as rcs, where UNIX file ownership prevents changing file permissions, and DOS semantics prevent deletion of a read only file\&.
2672 \fI\fIdelete readonly\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2675 delete share command (G)
2676 .\" delete share command
2679 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
2680 \fIdelete share command\fR
2681 is used to define an external program or script which will remove an existing service definition from
2682 \FCsmb\&.conf\F[]\&.
2684 In order to successfully execute the
2685 \fIdelete share command\fR,
2687 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
2688 \FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
2689 \fIdelete share command\fR
2690 parameter are executed as root\&.
2694 will automatically invoke the
2695 \fIdelete share command\fR
2696 with two parameters\&.
2700 \h'-04'\(bu\h'+03'\c
2707 \- the location of the global
2714 \h'-04'\(bu\h'+03'\c
2721 \- the name of the existing service\&.
2724 This parameter is only used to remove file shares\&. To delete printer shares, see the
2725 \m[blue]\fBdeleteprinter command\fR\m[]\&.
2728 \fI\fIdelete share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2731 \fI\fIdelete share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/delshare\F[]\fR\fI \fR
2734 delete user from group script (G)
2735 .\" delete user from group script
2738 Full path to the script that will be called when a user is removed from a group using the Windows NT domain administration tools\&. It will be run by
2740 \fIAS ROOT\fR\&. Any
2742 will be replaced with the group name and any
2744 will be replaced with the user name\&.
2747 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2750 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI\FC/usr/sbin/deluser %u %g\F[]\fR\fI \fR
2753 delete user script (G)
2754 .\" delete user script
2757 This is the full pathname to a script that will be run by
2759 when managing users with remote RPC (NT) tools\&.
2761 This script is called when a remote client removes a user from the server, normally using \'User Manager for Domains\' or
2764 This script should delete the given UNIX username\&.
2767 \fI\fIdelete user script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2770 \fI\fIdelete user script\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/del_user %u\F[]\fR\fI \fR
2773 delete veto files (S)
2774 .\" delete veto files
2777 This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories (see the
2778 \m[blue]\fBveto files\fR\m[]
2779 option)\&. If this option is set to
2781 (the default) then if a vetoed directory contains any non\-vetoed files or directories then the directory delete will fail\&. This is usually what you want\&.
2783 If this option is set to
2784 \fByes\fR, then Samba will attempt to recursively delete any files and directories within the vetoed directory\&. This can be useful for integration with file serving systems such as NetAtalk which create meta\-files within directories you might normally veto DOS/Windows users from seeing (e\&.g\&.
2785 \FC\&.AppleDouble\F[])
2788 \m[blue]\fBdelete veto files = yes\fR\m[]
2789 allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\&.
2792 \fI\fIdelete veto files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2795 dfree cache time (S)
2796 .\" dfree cache time
2800 \fIdfree cache time\fR
2801 should only be used on systems where a problem occurs with the internal disk space calculations\&. This has been known to happen with Ultrix, but may occur with other operating systems\&. The symptom that was seen was an error of "Abort Retry Ignore" at the end of each directory listing\&.
2803 This is a new parameter introduced in Samba version 3\&.0\&.21\&. It specifies in seconds the time that smbd will cache the output of a disk free query\&. If set to zero (the default) no caching is done\&. This allows a heavily loaded server to prevent rapid spawning of
2804 \m[blue]\fBdfree command\fR\m[]
2805 scripts increasing the load\&.
2807 By default this parameter is zero, meaning no caching will be done\&.
2812 \fI\fIdfree cache time\fR\fR\fI = \fR\fI\FCdfree cache time = 60\F[]\fR\fI \fR
2821 setting should only be used on systems where a problem occurs with the internal disk space calculations\&. This has been known to happen with Ultrix, but may occur with other operating systems\&. The symptom that was seen was an error of "Abort Retry Ignore" at the end of each directory listing\&.
2823 This setting allows the replacement of the internal routines to calculate the total disk space and amount available with an external routine\&. The example below gives a possible script that might fulfill this function\&.
2825 In Samba version 3\&.0\&.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter
2826 \m[blue]\fBdfree cache time\fR\m[]
2827 was added to allow the output of this script to be cached for systems under heavy load\&.
2829 The external program will be passed a single parameter indicating a directory in the filesystem being queried\&. This will typically consist of the string
2830 \FC\&./\F[]\&. The script should return two integers in ASCII\&. The first should be the total disk space in blocks, and the second should be the number of available blocks\&. An optional third return value can give the block size in bytes\&. The default blocksize is 1024 bytes\&.
2832 Note: Your script should
2834 be setuid or setgid and should be owned by (and writeable only by) root!
2836 Where the script dfree (which must be made executable) could be:
2847 df $1 | tail \-1 | awk \'{print $(NF\-4),$(NF\-2)}\'
2856 or perhaps (on Sys V based systems):
2867 /usr/bin/df \-k $1 | tail \-1 | awk \'{print $3" "$5}\'
2876 Note that you may have to replace the command names with full path names on some systems\&.
2878 By default internal routines for determining the disk capacity and remaining space will be used\&.
2883 \fI\fIdfree command\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/dfree\F[]\fR\fI \fR
2890 This parameter is a synonym for
2898 This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\&.
2900 When a directory is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit\-wise \'AND\'ed with this parameter\&. This parameter may be thought of as a bit\-wise MASK for the UNIX modes of a directory\&. Any bit
2902 set here will be removed from the modes set on a directory when it is created\&.
2904 The default value of this parameter removes the \'group\' and \'other\' write bits from the UNIX mode, allowing only the user who owns the directory to modify it\&.
2906 Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the
2907 \m[blue]\fBforce directory mode\fR\m[]
2908 parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode bits are added)\&.
2910 Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors\&. If the administrator wishes to enforce a mask on access control lists also, they need to set the
2911 \m[blue]\fBdirectory security mask\fR\m[]\&.
2914 \fI\fIdirectory mask\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
2917 \fI\fIdirectory mask\fR\fR\fI = \fR\fI\FC0775\F[]\fR\fI \fR
2920 directory security mask (S)
2921 .\" directory security mask
2924 This parameter controls what UNIX permission bits will be set when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box\&.
2926 This parameter is applied as a mask (AND\'ed with) to the incoming permission bits, thus resetting any bits not in this mask\&. Make sure not to mix up this parameter with
2927 \m[blue]\fBforce directory security mode\fR\m[], which works similar like this one but uses logical OR instead of AND\&. Essentially, zero bits in this mask are a set of bits that will always be set to zero\&.
2929 Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the file permissions regardless of the previous status of this bits on the file\&.
2931 If not set explicitly this parameter is set to 0777 meaning a user is allowed to set all the user/group/world permissions on a directory\&.
2934 that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems\&. Administrators of most normal systems will probably want to leave it as the default of
2938 \fI\fIdirectory security mask\fR\fR\fI = \fR\fI\FC0777\F[]\fR\fI \fR
2941 \fI\fIdirectory security mask\fR\fR\fI = \fR\fI\FC0700\F[]\fR\fI \fR
2948 Enabling this parameter will disable netbios support in Samba\&. Netbios is the only available form of browsing in all windows versions except for 2000 and XP\&.
2955 .nr an-no-space-flag 1
2962 Clients that only support netbios won\'t be able to see your samba server when netbios support is disabled\&.
2967 \fI\fIdisable netbios\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2974 Enabling this parameter will disable Samba\'s support for the SPOOLSS set of MS\-RPC\'s and will yield identical behavior as Samba 2\&.0\&.x\&. Windows NT/2000 clients will downgrade to using Lanman style printing commands\&. Windows 9x/ME will be unaffected by the parameter\&. However, this will also disable the ability to upload printer drivers to a Samba server via the Windows NT Add Printer Wizard or by using the NT printer properties dialog window\&. It will also disable the capability of Windows NT/2000 clients to download print drivers from the Samba host upon demand\&.
2975 \fIBe very careful about enabling this parameter\&.\fR
2978 \fI\fIdisable spoolss\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2985 Specifies the charset that samba will use to print messages to stdout and stderr\&. The default value is "LOCALE", which means automatically set, depending on the current locale\&. The value should generally be the same as the value of the parameter
2986 \m[blue]\fBunix charset\fR\m[]\&.
2989 \fI\fIdisplay charset\fR\fR\fI = \fR\fI\FC"LOCALE" or "ASCII" (depending on the system)\F[]\fR\fI \fR
2992 \fI\fIdisplay charset\fR\fR\fI = \fR\fI\FCUTF8\F[]\fR\fI \fR
2999 This parameter specifies whether Samba should use DMAPI to determine whether a file is offline or not\&. This would typically be used in conjunction with a hierarchical storage system that automatically migrates files to tape\&.
3001 Note that Samba infers the status of a file by examining the events that a DMAPI application has registered interest in\&. This heuristic is satisfactory for a number of hierarchical storage systems, but there may be system for which it will fail\&. In this case, Samba may erroneously report files to be offline\&.
3003 This parameter is only available if a supported DMAPI implementation was found at compilation time\&. It will only be used if DMAPI is found to enabled on the system at run time\&.
3006 \fI\fIdmapi support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3015 when acting as a WINS server and finding that a NetBIOS name has not been registered, should treat the NetBIOS name word\-for\-word as a DNS name and do a lookup with the DNS server for that name on behalf of the name\-querying client\&.
3017 Note that the maximum length for a NetBIOS name is 15 characters, so the DNS name (or DNS alias) can likewise only be 15 characters, maximum\&.
3020 spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\&.
3023 \fI\fIdns proxy\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3031 \fByes\fR, the Samba server will provide the netlogon service for Windows 9X network logons for the
3032 \m[blue]\fBworkgroup\fR\m[]
3033 it is in\&. This will also cause the Samba server to act as a domain controller for NT4 style domain services\&. For more details on setting up this feature see the Domain Control chapter of the Samba HOWTO Collection\&.
3036 \fI\fIdomain logons\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3045 to enable WAN\-wide browse list collation\&. Setting this option causes
3047 to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given
3048 \m[blue]\fBworkgroup\fR\m[]\&. Local master browsers in the same
3049 \m[blue]\fBworkgroup\fR\m[]
3050 on broadcast\-isolated subnets will give this
3052 their local browse lists, and then ask
3054 for a complete copy of the browse list for the whole wide area network\&. Browser clients will then contact their local master browser, and will receive the domain\-wide browse list, instead of just the list for their broadcast\-isolated subnet\&.
3056 Note that Windows NT Primary Domain Controllers expect to be able to claim this
3057 \m[blue]\fBworkgroup\fR\m[]
3058 specific special NetBIOS name that identifies them as domain master browsers for that
3059 \m[blue]\fBworkgroup\fR\m[]
3060 by default (i\&.e\&. there is no way to prevent a Windows NT PDC from attempting to do this)\&. This means that if this parameter is set and
3062 claims the special name for a
3063 \m[blue]\fBworkgroup\fR\m[]
3064 before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\&.
3067 \m[blue]\fBdomain logons = yes\fR\m[], then the default behavior is to enable the
3068 \m[blue]\fBdomain master\fR\m[]
3070 \m[blue]\fBdomain logons\fR\m[]
3071 is not enabled (the default setting), then neither will
3072 \m[blue]\fBdomain master\fR\m[]
3073 be enabled by default\&.
3076 \m[blue]\fBdomain logons = Yes\fR\m[]
3077 the default setting for this parameter is Yes, with the result that Samba will be a PDC\&. If
3078 \m[blue]\fBdomain master = No\fR\m[], Samba will function as a BDC\&. In general, this parameter should be set to \'No\' only on a BDC\&.
3081 \fI\fIdomain master\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
3088 There are certain directories on some systems (e\&.g\&., the
3090 tree under Linux) that are either not of interest to clients or are infinitely deep (recursive)\&. This parameter allows you to specify a comma\-delimited list of directories that the server should always show as empty\&.
3092 Note that Samba can be very fussy about the exact format of the "dont descend" entries\&. For example you may need
3095 \FC/proc\F[]\&. Experimentation is the best policy :\-)
3098 \fI\fIdont descend\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3101 \fI\fIdont descend\fR\fR\fI = \fR\fI\FC/proc,/dev\F[]\fR\fI \fR
3108 DOS SMB clients assume the server has the same charset as they do\&. This option specifies which charset Samba should talk to DOS clients\&.
3110 The default depends on which charsets you have installed\&. Samba tries to use charset 850 but falls back to ASCII in case it is not available\&. Run
3112 to check the default on your system\&.
3121 The default behavior in Samba is to provide UNIX\-like behavior where only the owner of a file/directory is able to change the permissions on it\&. However, this behavior is often confusing to DOS/Windows users\&. Enabling this parameter allows a user who has write access to the file (by whatever means, including an ACL permission) to modify the permissions (including ACL) on it\&. Note that a user belonging to the group owning the file will not be allowed to change permissions if the group is only granted read access\&. Ownership of the file/directory may also be changed\&.
3124 \fI\fIdos filemode\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3127 dos filetime resolution (S)
3128 .\" dos filetime resolution
3131 Under the DOS and Windows FAT filesystem, the finest granularity on time resolution is two seconds\&. Setting this parameter for a share causes Samba to round the reported time down to the nearest two second boundary when a query call that requires one second resolution is made to
3134 This option is mainly used as a compatibility option for Visual C++ when used against Samba shares\&. If oplocks are enabled on a share, Visual C++ uses two different time reading calls to check if a file has changed since it was last read\&. One of these calls uses a one\-second granularity, the other uses a two second granularity\&. As the two second call rounds any odd second down, then if the file has a timestamp of an odd number of seconds then the two timestamps will not match and Visual C++ will keep reporting the file has changed\&. Setting this option causes the two timestamps to match, and Visual C++ is happy\&.
3137 \fI\fIdos filetime resolution\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3144 Under DOS and Windows, if a user can write to a file they can change the timestamp on it\&. Under POSIX semantics, only the owner of the file or root may change the timestamp\&. By default, Samba runs with POSIX semantics and refuses to change the timestamp on a file if the user
3146 is acting on behalf of is not the file owner\&. Setting this option to
3148 allows DOS semantics and
3150 will change the file timestamp as DOS requires\&. Due to changes in Microsoft Office 2000 and beyond, the default for this parameter has been changed from "no" to "yes" in Samba 3\&.0\&.14 and above\&. Microsoft Excel will display dialog box warnings about the file being changed by another user if this parameter is not set to "yes" and files are being shared between users\&.
3153 \fI\fIdos filetimes\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3160 This boolean parameter controls whether
3162 will allow clients to attempt to store OS/2 style Extended attributes on a share\&. In order to enable this parameter the underlying filesystem exported by the share must support extended attributes (such as provided on XFS and EXT3 on Linux, with the correct kernel patches)\&. On Linux the filesystem must have been mounted with the mount option user_xattr in order for extended attributes to work, also extended attributes must be compiled into the Linux kernel\&.
3165 \fI\fIea support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3168 enable asu support (G)
3169 .\" enable asu support
3172 Hosts running the "Advanced Server for Unix (ASU)" product require some special accomodations such as creating a builtin [ADMIN$] share that only supports IPC connections\&. The has been the default behavior in smbd for many years\&. However, certain Microsoft applications such as the Print Migrator tool require that the remote server support an [ADMIN$} file share\&. Disabling this parameter allows for creating an [ADMIN$] file share in smb\&.conf\&.
3175 \fI\fIenable asu support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3178 enable privileges (G)
3179 .\" enable privileges
3182 This parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either
3183 \FCnet rpc rights\F[]
3184 or one of the Windows user and group manager tools\&. This parameter is enabled by default\&. It can be disabled to prevent members of the Domain Admins group from being able to assign privileges to users or groups which can then result in certain smbd operations running as root that would normally run under the context of the connected user\&.
3186 An example of how privileges can be used is to assign the right to join clients to a Samba controlled domain without providing root access to the server via smbd\&.
3188 Please read the extended description provided in the Samba HOWTO documentation\&.
3191 \fI\fIenable privileges\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3194 encrypt passwords (G)
3195 .\" encrypt passwords
3198 This boolean controls whether encrypted passwords will be negotiated with the client\&. Note that Windows NT 4\&.0 SP3 and above and also Windows 98 will by default expect encrypted passwords unless a registry entry is changed\&. To use encrypted passwords in Samba see the chapter "User Database" in the Samba HOWTO Collection\&.
3200 MS Windows clients that expect Microsoft encrypted passwords and that do not have plain text password support enabled will be able to connect only to a Samba server that has encrypted password support enabled and for which the user accounts have a valid encrypted password\&. Refer to the smbpasswd command man page for information regarding the creation of encrypted passwords for user accounts\&.
3202 The use of plain text passwords is NOT advised as support for this feature is no longer maintained in Microsoft Windows products\&. If you want to use plain text passwords you must set this parameter to no\&.
3204 In order for encrypted passwords to work correctly
3206 must either have access to a local
3210 program for information on how to set up and maintain this file), or set the
3211 \m[blue]\fBsecurity = [server|domain|ads]\fR\m[]
3212 parameter which causes
3214 to authenticate against another server\&.
3217 \fI\fIencrypt passwords\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3220 enhanced browsing (G)
3221 .\" enhanced browsing
3224 This option enables a couple of enhancements to cross\-subnet browse propagation that have been added in Samba but which are not standard in Microsoft implementations\&.
3226 The first enhancement to browse propagation consists of a regular wildcard query to a Samba WINS server for all Domain Master Browsers, followed by a browse synchronization with each of the returned DMBs\&. The second enhancement consists of a regular randomised browse synchronization with all currently known DMBs\&.
3228 You may wish to disable this option if you have a problem with empty workgroups not disappearing from browse lists\&. Due to the restrictions of the browse protocols, these enhancements can cause a empty workgroup to stay around forever which can be annoying\&.
3230 In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\&.
3233 \fI\fIenhanced browsing\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3236 enumports command (G)
3237 .\" enumports command
3240 The concept of a "port" is fairly foreign to UNIX hosts\&. Under Windows NT/2000 print servers, a port is associated with a port monitor and generally takes the form of a local port (i\&.e\&. LPT1:, COM1:, FILE:) or a remote port (i\&.e\&. LPD Port Monitor, etc\&.\&.\&.)\&. By default, Samba has only one port defined\-\-\fB"Samba Printer Port"\fR\&. Under Windows NT/2000, all printers must have a valid port name\&. If you wish to have a list of ports displayed (\FCsmbd \F[]
3241 does not use a port name for anything) other than the default
3242 \fB"Samba Printer Port"\fR, you can define
3243 \fIenumports command\fR
3244 to point to a program which should generate a list of ports, one per line, to standard output\&. This listing will then be used in response to the level 1 and 2 EnumPorts() RPC\&.
3247 \fI\fIenumports command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3250 \fI\fIenumports command\fR\fR\fI = \fR\fI\FC/usr/bin/listports\F[]\fR\fI \fR
3257 This option defines a list of log names that Samba will report to the Microsoft EventViewer utility\&. The listed eventlogs will be associated with tdb file on disk in the
3258 \FC$(lockdir)/eventlog\F[]\&.
3260 The administrator must use an external process to parse the normal Unix logs such as
3261 \FC/var/log/messages\F[]
3262 and write then entries to the eventlog tdb files\&. Refer to the eventlogadm(8) utility for how to write eventlog entries\&.
3265 \fI\fIeventlog list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3268 \fI\fIeventlog list\fR\fR\fI = \fR\fI\FCSecurity Application Syslog Apache\F[]\fR\fI \fR
3271 fake directory create times (S)
3272 .\" fake directory create times
3275 NTFS and Windows VFAT file systems keep a create time for all files and directories\&. This is not the same as the ctime \- status change time \- that Unix keeps, so Samba by default reports the earliest of the various times Unix does keep\&. Setting this parameter for a share causes Samba to always report midnight 1\-1\-1980 as the create time for directories\&.
3277 This option is mainly used as a compatibility option for Visual C++ when used against Samba shares\&. Visual C++ generated makefiles have the object directory as a dependency for each object file, and a make rule to create the directory\&. Also, when NMAKE compares timestamps it uses the creation time when examining a directory\&. Thus the object directory will be created if it does not exist, but once it does exist it will always have an earlier timestamp than the object files it contains\&.
3279 However, Unix time semantics mean that the create time reported by Samba will be updated whenever a file is created or or deleted in the directory\&. NMAKE finds all object files in the object directory\&. The timestamp of the last one built is then compared to the timestamp of the object directory\&. If the directory\'s timestamp if newer, then all object files will be rebuilt\&. Enabling this option ensures directories always predate their contents and an NMAKE build will proceed as expected\&.
3282 \fI\fIfake directory create times\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3289 Oplocks are the way that SMB clients get permission from a server to locally cache file operations\&. If a server grants an oplock (opportunistic lock) then the client is free to assume that it is the only one accessing the file and it will aggressively cache file data\&. With some oplock types the client may even cache file open/close operations\&. This can give enormous performance benefits\&.
3292 \FCfake oplocks = yes\F[],
3294 will always grant oplock requests no matter how many clients are using the file\&.
3296 It is generally much better to use the real
3297 \m[blue]\fBoplocks\fR\m[]
3298 support rather than this parameter\&.
3300 If you enable this option on all read\-only shares or shares that you know will only be accessed from one client at a time such as physically read\-only media like CDROMs, you will see a big performance improvement on many operations\&. If you enable this option on shares where multiple clients may be accessing the files read\-write at the same time you can get data corruption\&. Use this option carefully!
3303 \fI\fIfake oplocks\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3310 This parameter allows the Samba administrator to stop
3312 from following symbolic links in a particular share\&. Setting this parameter to
3314 prevents any file or directory that is a symbolic link from being followed (the user will get an error)\&. This option is very useful to stop users from adding a symbolic link to
3316 in their home directory for instance\&. However it will slow filename lookups down slightly\&.
3318 This option is enabled (i\&.e\&.
3320 will follow symbolic links) by default\&.
3323 \fI\fIfollow symlinks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3326 force create mode (S)
3327 .\" force create mode
3330 This parameter specifies a set of UNIX mode bit permissions that will
3332 be set on a file created by Samba\&. This is done by bitwise \'OR\'ing these bits onto the mode bits of a file that is being created\&. The default for this parameter is (in octal) 000\&. The modes in this parameter are bitwise \'OR\'ed onto the file mode after the mask set in the
3334 parameter is applied\&.
3336 The example below would force all newly created files to have read and execute permissions set for \'group\' and \'other\' as well as the read/write/execute bits set for the \'user\'\&.
3339 \fI\fIforce create mode\fR\fR\fI = \fR\fI\FC000\F[]\fR\fI \fR
3342 \fI\fIforce create mode\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
3345 force directory mode (S)
3346 .\" force directory mode
3349 This parameter specifies a set of UNIX mode bit permissions that will
3351 be set on a directory created by Samba\&. This is done by bitwise \'OR\'ing these bits onto the mode bits of a directory that is being created\&. The default for this parameter is (in octal) 0000 which will not add any extra permission bits to a created directory\&. This operation is done after the mode mask in the parameter
3352 \fIdirectory mask\fR
3355 The example below would force all created directories to have read and execute permissions set for \'group\' and \'other\' as well as the read/write/execute bits set for the \'user\'\&.
3358 \fI\fIforce directory mode\fR\fR\fI = \fR\fI\FC000\F[]\fR\fI \fR
3361 \fI\fIforce directory mode\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
3364 force directory security mode (S)
3365 .\" force directory security mode
3368 This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box\&.
3370 This parameter is applied as a mask (OR\'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on\&. Make sure not to mix up this parameter with
3371 \m[blue]\fBdirectory security mask\fR\m[], which works in a similar manner to this one, but uses a logical AND instead of an OR\&.
3373 Essentially, this mask may be treated as a set of bits that, when modifying security on a directory, to will enable (1) any flags that are off (0) but which the mask has set to on (1)\&.
3375 If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world permissions on a directory without restrictions\&.
3382 .nr an-no-space-flag 1
3389 Users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems\&. Administrators of most normal systems will probably want to leave it set as 0000\&.
3394 \fI\fIforce directory security mode\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
3397 \fI\fIforce directory security mode\fR\fR\fI = \fR\fI\FC700\F[]\fR\fI \fR
3404 This parameter is a synonym for
3412 This specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service\&. This is useful for sharing files by ensuring that all access to files on service will use the named group for their permissions checking\&. Thus, by assigning permissions for this group to the files and directories within this service the Samba administrator can restrict or allow sharing of these files\&.
3414 In Samba 2\&.0\&.5 and above this parameter has extended functionality in the following way\&. If the group name listed here has a \'+\' character prepended to it then the current user accessing the share only has the primary group default assigned to this group if they are already assigned as a member of that group\&. This allows an administrator to decide that only users who are already in a particular group will create files with group ownership set to that group\&. This gives a finer granularity of ownership assignment\&. For example, the setting
3415 \FCforce group = +sys\F[]
3416 means that only users who are already in group sys will have their default primary group assigned to sys when accessing this Samba share\&. All other users will retain their ordinary primary group\&.
3419 \m[blue]\fBforce user\fR\m[]
3420 parameter is also set the group specified in
3422 will override the primary group set in
3426 \fI\fIforce group\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3429 \fI\fIforce group\fR\fR\fI = \fR\fI\FCagroup\F[]\fR\fI \fR
3432 force printername (S)
3433 .\" force printername
3436 When printing from Windows NT (or later), each printer in
3438 has two associated names which can be used by the client\&. The first is the sharename (or shortname) defined in smb\&.conf\&. This is the only printername available for use by Windows 9x clients\&. The second name associated with a printer can be seen when browsing to the "Printers" (or "Printers and Faxes") folder on the Samba server\&. This is referred to simply as the printername (not to be confused with the
3442 When assigning a new driver to a printer on a remote Windows compatible print server such as Samba, the Windows client will rename the printer to match the driver name just uploaded\&. This can result in confusion for users when multiple printers are bound to the same driver\&. To prevent Samba from allowing the printer\'s printername to differ from the sharename defined in smb\&.conf, set
3443 \fIforce printername = yes\fR\&.
3445 Be aware that enabling this parameter may affect migrating printers from a Windows server to Samba since Windows has no way to force the sharename and printername to match\&.
3447 It is recommended that this parameter\'s value not be changed once the printer is in use by clients as this could cause a user not be able to delete printer connections from their local Printers folder\&.
3450 \fI\fIforce printername\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3453 force security mode (S)
3454 .\" force security mode
3457 This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a file using the native NT security dialog box\&.
3459 This parameter is applied as a mask (OR\'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on\&. Make sure not to mix up this parameter with
3460 \m[blue]\fBsecurity mask\fR\m[], which works similar like this one but uses logical AND instead of OR\&.
3462 Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file, the user has always set to be on\&.
3464 If not set explicitly this parameter is set to 0, and allows a user to modify all the user/group/world permissions on a file, with no restrictions\&.
3467 that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems\&. Administrators of most normal systems will probably want to leave this set to 0000\&.
3470 \fI\fIforce security mode\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
3473 \fI\fIforce security mode\fR\fR\fI = \fR\fI\FC700\F[]\fR\fI \fR
3476 force unknown acl user (S)
3477 .\" force unknown acl user
3480 If this parameter is set, a Windows NT ACL that contains an unknown SID (security descriptor, or representation of a user or group id) as the owner or group owner of the file will be silently mapped into the current UNIX uid or gid of the currently connected user\&.
3482 This is designed to allow Windows NT clients to copy files and folders containing ACLs that were created locally on the client machine and contain users local to that machine only (no domain users) to be copied to a Samba server (usually with XCOPY /O) and have the unknown userid and groupid of the file owner map to the current connected user\&. This can only be fixed correctly when winbindd allows arbitrary mapping from any Windows NT SID to a UNIX uid or gid\&.
3484 Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\&.
3487 \fI\fIforce unknown acl user\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3494 This specifies a UNIX user name that will be assigned as the default user for all users connecting to this service\&. This is useful for sharing files\&. You should also use it carefully as using it incorrectly can cause security problems\&.
3496 This user name only gets used once a connection is established\&. Thus clients still need to connect as a valid user and supply a valid password\&. Once connected, all file operations will be performed as the "forced user", no matter what username the client connected as\&. This can be very useful\&.
3498 In Samba 2\&.0\&.5 and above this parameter also causes the primary group of the forced user to be used as the primary group for all file activity\&. Prior to 2\&.0\&.5 the primary group was left as the primary group of the connecting user (this was a bug)\&.
3501 \fI\fIforce user\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3504 \fI\fIforce user\fR\fR\fI = \fR\fI\FCauser\F[]\fR\fI \fR
3511 This parameter allows the administrator to configure the string that specifies the type of filesystem a share is using that is reported by
3513 when a client queries the filesystem type for a share\&. The default type is
3515 for compatibility with Windows NT but this can be changed to other strings such as
3522 \fI\fIfstype\fR\fR\fI = \fR\fI\FCNTFS\F[]\fR\fI \fR
3525 \fI\fIfstype\fR\fR\fI = \fR\fI\FCSamba\F[]\fR\fI \fR
3528 get quota command (G)
3529 .\" get quota command
3533 \FCget quota command\F[]
3534 should only be used whenever there is no operating system API available from the OS that samba can use\&.
3536 This option is only available you have compiled Samba with the
3537 \FC\-\-with\-sys\-quotas\F[]
3538 option or on Linux with
3539 \FC\-\-with\-quotas\F[]
3540 and a working quota api was found in the system\&.
3542 This parameter should specify the path to a script that queries the quota information for the specified user/group for the partition that the specified directory is on\&.
3544 Such a script should take 3 arguments:
3548 \h'-04'\(bu\h'+03'\c
3559 \h'-04'\(bu\h'+03'\c
3570 \h'-04'\(bu\h'+03'\c
3576 uid of user or gid of group
3579 The type of query can be one of :
3583 \h'-04'\(bu\h'+03'\c
3594 \h'-04'\(bu\h'+03'\c
3600 2 \- user default quotas (uid = \-1)
3605 \h'-04'\(bu\h'+03'\c
3616 \h'-04'\(bu\h'+03'\c
3622 4 \- group default quotas (gid = \-1)
3625 This script should print one line as output with spaces between the arguments\&. The arguments are:
3629 \h'-04'\(bu\h'+03'\c
3635 Arg 1 \- quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)
3640 \h'-04'\(bu\h'+03'\c
3646 Arg 2 \- number of currently used blocks
3651 \h'-04'\(bu\h'+03'\c
3657 Arg 3 \- the softlimit number of blocks
3662 \h'-04'\(bu\h'+03'\c
3668 Arg 4 \- the hardlimit number of blocks
3673 \h'-04'\(bu\h'+03'\c
3679 Arg 5 \- currently used number of inodes
3684 \h'-04'\(bu\h'+03'\c
3690 Arg 6 \- the softlimit number of inodes
3695 \h'-04'\(bu\h'+03'\c
3701 Arg 7 \- the hardlimit number of inodes
3706 \h'-04'\(bu\h'+03'\c
3712 Arg 8(optional) \- the number of bytes in a block(default is 1024)
3716 \fI\fIget quota command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3719 \fI\fIget quota command\fR\fR\fI = \fR\fI\FC/usr/local/sbin/query_quota\F[]\fR\fI \fR
3726 This is a tuning option\&. When this is enabled a caching algorithm will be used to reduce the time taken for getwd() calls\&. This can have a significant impact on performance, especially when the
3727 \m[blue]\fBwide smbconfoptions\fR\m[]
3732 \fI\fIgetwd cache\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3739 This is a username which will be used for access to services which are specified as
3740 \m[blue]\fBguest ok\fR\m[]
3741 (see below)\&. Whatever privileges this user has will be available to any client connecting to the guest service\&. This user must exist in the password file, but does not require a valid login\&. The user account "ftp" is often a good choice for this parameter\&.
3743 On some systems the default guest account "nobody" may not be able to print\&. Use another account in this case\&. You should test this by trying to log in as your guest user (perhaps by using the
3745 command) and trying to print using the system print command such as
3750 This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation\&.
3753 \fI\fIguest account\fR\fR\fI = \fR\fI\FCnobody # default can be changed at compile\-time\F[]\fR\fI \fR
3756 \fI\fIguest account\fR\fR\fI = \fR\fI\FCftp\F[]\fR\fI \fR
3763 This parameter is a synonym for
3771 If this parameter is
3773 for a service, then no password is required to connect to the service\&. Privileges will be those of the
3774 \m[blue]\fBguest account\fR\m[]\&.
3776 This paramater nullifies the benifits of setting
3777 \m[blue]\fBrestrict anonymous = 2\fR\m[]
3779 See the section below on
3780 \m[blue]\fBsecurity\fR\m[]
3781 for more information about this option\&.
3784 \fI\fIguest ok\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3791 This parameter is a synonym for
3799 If this parameter is
3801 for a service, then only guest connections to the service are permitted\&. This parameter will have no effect if
3802 \m[blue]\fBguest ok\fR\m[]
3803 is not set for the service\&.
3805 See the section below on
3806 \m[blue]\fBsecurity\fR\m[]
3807 for more information about this option\&.
3810 \fI\fIguest only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3817 This is a boolean parameter that controls whether files starting with a dot appear as hidden files\&.
3820 \fI\fIhide dot files\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3827 This is a list of files or directories that are not visible but are accessible\&. The DOS \'hidden\' attribute is applied to any files or directories that match\&.
3829 Each entry in the list must be separated by a \'/\', which allows spaces to be included in the entry\&. \'*\' and \'?\' can be used to specify multiple files or directories as in DOS wildcards\&.
3831 Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator \'/\'\&.
3833 Note that the case sensitivity option is applicable in hiding files\&.
3835 Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned\&.
3837 The example shown above is based on files that the Macintosh SMB client (DAVE) available from
3839 creates for internal use, and also still hides all files beginning with a dot\&.
3841 An example of us of this parameter is:
3852 .BB lightgray adjust-for-leading-newline
3855 hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/
3856 .EB lightgray adjust-for-leading-newline
3868 \fI\fIhide files\fR\fR\fI = \fR\fI\FC # no file are hidden\F[]\fR\fI \fR
3871 hide special files (S)
3872 .\" hide special files
3875 This parameter prevents clients from seeing special files such as sockets, devices and fifo\'s in directory listings\&.
3878 \fI\fIhide special files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3885 This parameter prevents clients from seeing the existance of files that cannot be read\&. Defaults to off\&.
3888 \fI\fIhide unreadable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3891 hide unwriteable files (S)
3892 .\" hide unwriteable files
3895 This parameter prevents clients from seeing the existance of files that cannot be written to\&. Defaults to off\&. Note that unwriteable directories are shown as usual\&.
3898 \fI\fIhide unwriteable files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3906 \m[blue]\fBnis homedir\fR\m[]
3910 is also acting as a Win95/98
3912 then this parameter specifies the NIS (or YP) map from which the server for the user\'s home directory should be extracted\&. At present, only the Sun auto\&.home map format is understood\&. The form of the map is:
3923 .BB lightgray adjust-for-leading-newline
3926 \FCusername server:/some/file/system\F[]
3927 .EB lightgray adjust-for-leading-newline
3938 and the program will extract the servername from before the first \':\'\&. There should probably be a better parsing system that copes with different map formats and also Amd (another automounter) maps\&.
3945 .nr an-no-space-flag 1
3952 A working NIS client is required on the system for this option to work\&.
3957 \fI\fIhomedir map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3960 \fI\fIhomedir map\fR\fR\fI = \fR\fI\FCamd\&.homedir\F[]\fR\fI \fR
3968 \fByes\fR, Samba will act as a Dfs server, and allow Dfs\-aware clients to browse Dfs trees hosted on the server\&.
3971 \m[blue]\fBmsdfs root\fR\m[]
3972 share level parameter\&. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\&.
3975 \fI\fIhost msdfs\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3978 hostname lookups (G)
3979 .\" hostname lookups
3982 Specifies whether samba should use (expensive) hostname lookups or use the ip addresses instead\&. An example place where hostname lookups are currently used is when checking the
3985 \FChosts allow\F[]\&.
3988 \fI\fIhostname lookups\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3991 \fI\fIhostname lookups\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3998 This parameter is a synonym for
4006 A synonym for this parameter is
4007 \m[blue]\fBallow hosts\fR\m[]\&.
4009 This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\&.
4011 If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\&.
4013 You can specify the hosts by name or IP number\&. For example, you could restrict access to only the hosts on a Class C subnet with something like
4014 \FCallow hosts = 150\&.203\&.5\&.\F[]\&. The full syntax of the list is described in the man page
4015 \FChosts_access(5)\F[]\&. Note that this man page may not be present on your system, so a brief description will be given here also\&.
4017 Note that the localhost address 127\&.0\&.0\&.1 will always be allowed access unless specifically denied by a
4018 \m[blue]\fBhosts deny\fR\m[]
4021 You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\&. The
4023 keyword can also be used to limit a wildcard list\&. The following examples may provide some help:
4025 Example 1: allow all IPs in 150\&.203\&.*\&.*; except one
4027 \FChosts allow = 150\&.203\&. EXCEPT 150\&.203\&.6\&.66\F[]
4029 Example 2: allow hosts that match the given network/netmask
4031 \FChosts allow = 150\&.203\&.15\&.0/255\&.255\&.255\&.0\F[]
4033 Example 3: allow a couple of hosts
4035 \FChosts allow = lapland, arvidsjaur\F[]
4037 Example 4: allow only hosts in NIS netgroup "foonet", but deny access from one particular host
4039 \FChosts allow = @foonet\F[]
4041 \FChosts deny = pirate\F[]
4048 .nr an-no-space-flag 1
4055 Note that access still requires suitable user\-level passwords\&.
4061 for a way of testing your host access to see if it does what you expect\&.
4064 \fI\fIhosts allow\fR\fR\fI = \fR\fI\FC # none (i\&.e\&., all hosts permitted access)\F[]\fR\fI \fR
4067 \fI\fIhosts allow\fR\fR\fI = \fR\fI\FC150\&.203\&.5\&. myhost\&.mynet\&.edu\&.au\F[]\fR\fI \fR
4074 This parameter is a synonym for
4084 \- hosts listed here are
4086 permitted access to services unless the specific services have their own lists to override this one\&. Where the lists conflict, the
4088 list takes precedence\&.
4090 In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask
4091 \FC0\&.0\&.0\&.0/0\F[]) and then explicitly specify to the
4092 \m[blue]\fBhosts allow = hosts allow\fR\m[]
4093 parameter those hosts that should be permitted access\&.
4096 \fI\fIhosts deny\fR\fR\fI = \fR\fI\FC # none (i\&.e\&., no hosts specifically excluded)\F[]\fR\fI \fR
4099 \fI\fIhosts deny\fR\fR\fI = \fR\fI\FC150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\F[]\fR\fI \fR
4102 idmap alloc backend (G)
4103 .\" idmap alloc backend
4106 The idmap alloc backend provides a plugin interface for Winbind to use when allocating Unix uids/gids for Windows SIDs\&. This option refers to the name of the idmap module which will provide the id allocation functionality\&. Please refer to the man page for each idmap plugin to determine whether or not the module implements the allocation feature\&. The most common plugins are the tdb (\fBidmap_tdb\fR(8)) and ldap (\fBidmap_ldap\fR(8)) libraries\&.
4108 This parameter defaults to the value
4109 \m[blue]\fBidmap backend\fR\m[]
4110 was set to, so by default winbind will allocate Unix IDs from the default backend\&. You will only need to set this parameter explicitly if you have an external source for Unix IDs, like a central database service somewhere in your company\&.
4113 \m[blue]\fBidmap alloc config\fR\m[]
4119 \fI\fIidmap alloc backend\fR\fR\fI = \fR\fI\FCtdb\F[]\fR\fI \fR
4122 idmap alloc config (G)
4123 .\" idmap alloc config
4126 The idmap alloc config prefix provides a means of managing settings for the backend defined by the
4127 \m[blue]\fBidmap alloc backend\fR\m[]
4128 parameter\&. Refer to the man page for each idmap plugin regarding specific configuration details\&.
4137 The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables\&.
4139 This option specifies the default backend that is used when no special configuration set by
4140 \m[blue]\fBidmap config\fR\m[]
4141 matches the specific request\&.
4143 This default backend also specifies the place where winbind\-generated idmap entries will be stored\&. So it is highly recommended that you specify a writable backend like
4147 as the idmap backend\&. The
4151 backends are not writable and thus will generate unexpected results if set as idmap backend\&.
4153 To use the rid and ad backends, please specify them via the
4154 \m[blue]\fBidmap config\fR\m[]
4155 parameter, possibly also for the domain your machine is member of, specified by
4156 \m[blue]\fBworkgroup\fR\m[]\&.
4158 Examples of SID/uid/gid backends include tdb (\fBidmap_tdb\fR(8)), ldap (\fBidmap_ldap\fR(8)), rid (\fBidmap_rid\fR(8)), and ad (\fBidmap_ad\fR(8))\&.
4161 \fI\fIidmap backend\fR\fR\fI = \fR\fI\FCtdb\F[]\fR\fI \fR
4164 idmap cache time (G)
4165 .\" idmap cache time
4168 This parameter specifies the number of seconds that Winbind\'s idmap interface will cache positive SID/uid/gid query results\&.
4171 \fI\fIidmap cache time\fR\fR\fI = \fR\fI\FC604800 (one week)\F[]\fR\fI \fR
4178 The idmap config prefix provides a means of managing each trusted domain separately\&. The idmap config prefix should be followed by the name of the domain, a colon, and a setting specific to the chosen backend\&. There are three options available for all domains:
4180 backend = backend_name
4182 Specifies the name of the idmap plugin to use as the SID/uid/gid backend for this domain\&.
4187 Defines the available matching uid and gid range for which the backend is authoritative\&. Note that the range commonly matches the allocation range due to the fact that the same backend will store and retrieve SID/uid/gid mapping entries\&.
4189 winbind uses this parameter to find the backend that is authoritative for a unix ID to SID mapping, so it must be set for each individually configured domain, and it must be disjoint from the ranges set via
4190 \m[blue]\fBidmap uid\fR\m[]
4192 \m[blue]\fBidmap gid\fR\m[]\&.
4195 The following example illustrates how to configure the
4197 for the CORP domain and the
4199 backend for all other domains\&. This configuration assumes that the admin of CORP assigns unix ids below 1000000 via the SFU extensions, and winbind is supposed to use the next million entries for its own mappings from trusted domains and for local groups for example\&.
4210 .BB lightgray adjust-for-leading-newline
4214 idmap uid = 1000000\-1999999
4215 idmap gid = 1000000\-1999999
4217 idmap config CORP : backend = ad
4218 idmap config CORP : range = 1000\-999999
4220 .EB lightgray adjust-for-leading-newline
4238 This parameter is a synonym for
4246 The idmap gid parameter specifies the range of group ids that are allocated for the purpose of mapping UNX groups to NT group SIDs\&. This range of group ids should have no existing local or NIS groups within it as strange conflicts can occur otherwise\&.
4249 \m[blue]\fBidmap backend\fR\m[], and
4250 \m[blue]\fBidmap config\fR\m[]
4254 \fI\fIidmap gid\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4257 \fI\fIidmap gid\fR\fR\fI = \fR\fI\FC10000\-20000\F[]\fR\fI \fR
4260 idmap negative cache time (G)
4261 .\" idmap negative cache time
4264 This parameter specifies the number of seconds that Winbind\'s idmap interface will cache negative SID/uid/gid query results\&.
4267 \fI\fIidmap negative cache time\fR\fR\fI = \fR\fI\FC120\F[]\fR\fI \fR
4274 This parameter is a synonym for
4282 The idmap uid parameter specifies the range of user ids that are allocated for use in mapping UNIX users to NT user SIDs\&. This range of ids should have no existing local or NIS users within it as strange conflicts can occur otherwise\&.
4285 \m[blue]\fBidmap backend\fR\m[]
4287 \m[blue]\fBidmap config\fR\m[]
4291 \fI\fIidmap uid\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4294 \fI\fIidmap uid\fR\fR\fI = \fR\fI\FC10000\-20000\F[]\fR\fI \fR
4301 This allows you to include one config file inside another\&. The file is included literally, as though typed in place\&.
4303 It takes the standard substitutions, except
4310 \fIinclude = registry\fR
4311 has a special meaning: It does
4313 include a file named
4315 from the current working directory, but instead reads the global configuration options from the registry\&. See the section on registry\-based configuration for details\&. Note that this option automatically activates registry shares\&.
4318 \fI\fIinclude\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4321 \fI\fIinclude\fR\fR\fI = \fR\fI\FC/usr/local/samba/lib/admin_smb\&.conf\F[]\fR\fI \fR
4328 This parameter can be used to ensure that if default acls exist on parent directories, they are always honored when creating a new file or subdirectory in these parent directories\&. The default behavior is to use the unix mode specified when creating the directory\&. Enabling this option sets the unix mode to 0777, thus guaranteeing that default directory acls are propagated\&.
4331 \fI\fIinherit acls\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4338 The ownership of new files and directories is normally governed by effective uid of the connected user\&. This option allows the Samba administrator to specify that the ownership for new files and directories should be controlled by the ownership of the parent directory\&.
4340 Common scenarios where this behavior is useful is in implementing drop\-boxes where users can create and edit files but not delete them and to ensure that newly create files in a user\'s roaming profile directory are actually owner by the user\&.
4343 \fI\fIinherit owner\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4346 inherit permissions (S)
4347 .\" inherit permissions
4350 The permissions on new files and directories are normally governed by
4351 \m[blue]\fBcreate mask\fR\m[],
4352 \m[blue]\fBdirectory mask\fR\m[],
4353 \m[blue]\fBforce create mode\fR\m[]
4355 \m[blue]\fBforce directory mode\fR\m[]
4356 but the boolean inherit permissions parameter overrides this\&.
4358 New directories inherit the mode of the parent directory, including bits such as setgid\&.
4360 New files inherit their read/write bits from the parent directory\&. Their execute bits continue to be determined by
4361 \m[blue]\fBmap archive\fR\m[],
4362 \m[blue]\fBmap hidden\fR\m[]
4364 \m[blue]\fBmap system\fR\m[]
4367 Note that the setuid bit is
4369 set via inheritance (the code explicitly prohibits this)\&.
4371 This can be particularly useful on large systems with many users, perhaps several thousand, to allow a single [homes] share to be used flexibly by each user\&.
4374 \fI\fIinherit permissions\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4377 init logon delayed hosts (G)
4378 .\" init logon delayed hosts
4381 This parameter takes a list of host names, addresses or networks for which the initial samlogon reply should be delayed (so other DCs get preferred by XP workstations if there are any)\&.
4383 The length of the delay can be specified with the
4384 \m[blue]\fBinit logon delay\fR\m[]
4388 \fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4391 \fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI\FC150\&.203\&.5\&. myhost\&.mynet\&.de\F[]\fR\fI \fR
4394 init logon delay (G)
4395 .\" init logon delay
4398 This parameter specifies a delay in milliseconds for the hosts configured for delayed initial samlogon with
4399 \m[blue]\fBinit logon delayed hosts\fR\m[]\&.
4402 \fI\fIinit logon delay\fR\fR\fI = \fR\fI\FC100\F[]\fR\fI \fR
4409 This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other NetBIOS over TCP/IP (NBT) traffic\&. By default Samba will query the kernel for the list of all active interfaces and use any interfaces except 127\&.0\&.0\&.1 that are broadcast capable\&.
4411 The option takes a list of interface strings\&. Each string can be in any of the following forms:
4415 \h'-04'\(bu\h'+03'\c
4421 a network interface name (such as eth0)\&. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth"
4426 \h'-04'\(bu\h'+03'\c
4432 an IP address\&. In this case the netmask is determined from the list of interfaces obtained from the kernel
4437 \h'-04'\(bu\h'+03'\c
4448 \h'-04'\(bu\h'+03'\c
4454 a broadcast/mask pair\&.
4457 The "mask" parameters can either be a bit length (such as 24 for a C class network) or a full netmask in dotted decimal form\&.
4459 The "IP" parameters above can either be a full dotted decimal IP address or a hostname which will be looked up via the OS\'s normal hostname resolution mechanisms\&.
4461 By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\&.0\&.0\&.1)\&.
4463 The example below configures three network interfaces corresponding to the eth0 device and IP addresses 192\&.168\&.2\&.10 and 192\&.168\&.3\&.10\&. The netmasks of the latter two interfaces would be set to 255\&.255\&.255\&.0\&.
4466 \fI\fIinterfaces\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4469 \fI\fIinterfaces\fR\fR\fI = \fR\fI\FCeth0 192\&.168\&.2\&.10/24 192\&.168\&.3\&.10/255\&.255\&.255\&.0\F[]\fR\fI \fR
4476 This is a list of users that should not be allowed to login to this service\&. This is really a
4478 check to absolutely ensure an improper setting does not breach your security\&.
4480 A name starting with a \'@\' is interpreted as an NIS netgroup first (if your system supports NIS), and then as a UNIX group if the name was not found in the NIS netgroup database\&.
4482 A name starting with \'+\' is interpreted only by looking in the UNIX group database via the NSS getgrnam() interface\&. A name starting with \'&\' is interpreted only by looking in the NIS netgroup database (this requires NIS to be working on your system)\&. The characters \'+\' and \'&\' may be used at the start of the name in either order so the value
4484 means check the UNIX group database, followed by the NIS netgroup database, and the value
4486 means check the NIS netgroup database, followed by the UNIX group database (the same as the \'@\' prefix)\&.
4488 The current servicename is substituted for
4489 \fI%S\fR\&. This is useful in the [homes] section\&.
4492 \fI\fIinvalid users\fR\fR\fI = \fR\fI\FC # no invalid users\F[]\fR\fI \fR
4495 \fI\fIinvalid users\fR\fR\fI = \fR\fI\FCroot fred admin @wheel\F[]\fR\fI \fR
4502 This parameter is only applicable if
4503 \m[blue]\fBprinting\fR\m[]
4507 If set, this option overrides the ServerName option in the CUPS
4508 \FCclient\&.conf\F[]\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
4511 \fI\fIiprint server\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
4514 \fI\fIiprint server\fR\fR\fI = \fR\fI\FCMYCUPSSERVER\F[]\fR\fI \fR
4521 The value of the parameter (an integer) represents the number of seconds between
4523 packets\&. If this parameter is zero, no keepalive packets will be sent\&. Keepalive packets, if sent, allow the server to tell whether a client is still present and responding\&.
4525 Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\&. (see
4526 \m[blue]\fBsocket options\fR\m[])\&. Basically you should only use this option if you strike difficulties\&.
4529 \fI\fIkeepalive\fR\fR\fI = \fR\fI\FC300\F[]\fR\fI \fR
4532 \fI\fIkeepalive\fR\fR\fI = \fR\fI\FC600\F[]\fR\fI \fR
4539 Controls how kerberos tickets are verified\&.
4545 \h'-04'\(bu\h'+03'\c
4551 secrets only \- use only the secrets\&.tdb for ticket verification (default)
4556 \h'-04'\(bu\h'+03'\c
4562 system keytab \- use only the system keytab for ticket verification
4567 \h'-04'\(bu\h'+03'\c
4573 dedicated keytab \- use a dedicated keytab for ticket verification
4578 \h'-04'\(bu\h'+03'\c
4584 secrets and keytab \- use the secrets\&.tdb first, then the system keytab
4587 The major difference between "system keytab" and "dedicated keytab" is that the latter method relies on kerberos to find the correct keytab entry instead of filtering based on expected principals\&.
4589 When the kerberos method is in "dedicated keytab" mode,
4590 \m[blue]\fBdedicated keytab file\fR\m[]
4591 must be set to specify the location of the keytab file\&.
4594 \fI\fIkerberos method\fR\fR\fI = \fR\fI\FCsecrets only\F[]\fR\fI \fR
4597 kernel change notify (S)
4598 .\" kernel change notify
4601 This parameter specifies whether Samba should ask the kernel for change notifications in directories so that SMB clients can refresh whenever the data on the server changes\&.
4603 This parameter is only used when your kernel supports change notification to user programs using the inotify interface\&.
4606 \fI\fIkernel change notify\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
4613 For UNIXes that support kernel based
4614 \m[blue]\fBoplocks\fR\m[]
4615 (currently only IRIX and the Linux 2\&.4 kernel), this parameter allows the use of them to be turned on or off\&.
4617 Kernel oplocks support allows Samba
4619 to be broken whenever a local UNIX process or NFS operation accesses a file that
4621 has oplocked\&. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a
4623 cool feature :\-)\&.
4625 This parameter defaults to
4626 \fBon\fR, but is translated to a no\-op on systems that no not have the necessary kernel support\&. You should never need to touch this parameter\&.
4629 \fI\fIkernel oplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
4636 This parameter determines whether or not
4638 will attempt to authenticate users or permit password changes using the LANMAN password hash\&. If disabled, only clients which support NT password hashes (e\&.g\&. Windows NT/2000 clients, smbclient, but not Windows 95/98 or the MS DOS network client) will be able to connect to the Samba host\&.
4640 The LANMAN encrypted response is easily broken, due to its case\-insensitive nature, and the choice of algorithm\&. Servers without Windows 95/98/ME or MS DOS clients are advised to disable this option\&.
4643 \FCencrypt passwords\F[]
4644 option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\&. See the
4645 \FCclient lanman auth\F[]
4646 to disable this for Samba\'s clients (such as smbclient)
4650 are both disabled, then only NTLMv2 logins will be permited\&. Not all clients support NTLMv2, and most will require special configuration to use it\&.
4653 \fI\fIlanman auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4660 This parameter determines whether or not
4662 supports the new 64k streaming read and write varient SMB requests introduced with Windows 2000\&. Note that due to Windows 2000 client redirector bugs this requires Samba to be running on a 64\-bit capable operating system such as IRIX, Solaris or a Linux 2\&.4 kernel\&. Can improve performance by 10% with Windows 2000 clients\&. Defaults to on\&. Not as tested as some other Samba code paths\&.
4665 \fI\fIlarge readwrite\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
4673 \m[blue]\fBldap admin dn\fR\m[]
4674 defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information\&. The
4675 \m[blue]\fBldap admin dn\fR\m[]
4676 is used in conjunction with the admin dn password stored in the
4677 \FCprivate/secrets\&.tdb\F[]
4680 man page for more information on how to accomplish this\&.
4683 \m[blue]\fBldap admin dn\fR\m[]
4684 requires a fully specified DN\&. The
4685 \m[blue]\fBldap suffix\fR\m[]
4686 is not appended to the
4687 \m[blue]\fBldap admin dn\fR\m[]\&.
4692 ldap connection timeout (G)
4693 .\" ldap connection timeout
4696 This parameter tells the LDAP library calls which timeout in seconds they should honor during initial connection establishments to LDAP servers\&. It is very useful in failover scenarios in particular\&. If one or more LDAP servers are not reachable at all, we do not have to wait until TCP timeouts are over\&. This feature must be supported by your LDAP library\&.
4698 This parameter is different from
4699 \m[blue]\fBldap timeout\fR\m[]
4700 which affects operations on LDAP servers using an existing connection and not establishing an initial connection\&.
4703 \fI\fIldap connection timeout\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
4706 ldap debug level (G)
4707 .\" ldap debug level
4710 This parameter controls the debug level of the LDAP library calls\&. In the case of OpenLDAP, it is the same bit\-field as understood by the server and documented in the
4712 manpage\&. A typical useful value will be
4714 for tracing function calls\&.
4716 The debug ouput from the LDAP libraries appears with the prefix [LDAP] in Samba\'s logging output\&. The level at which LDAP logging is printed is controlled by the parameter
4717 \fIldap debug threshold\fR\&.
4720 \fI\fIldap debug level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
4723 \fI\fIldap debug level\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
4726 ldap debug threshold (G)
4727 .\" ldap debug threshold
4730 This parameter controls the Samba debug level at which the ldap library debug output is printed in the Samba logs\&. See the description of
4731 \fIldap debug level\fR
4735 \fI\fIldap debug threshold\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
4738 \fI\fIldap debug threshold\fR\fR\fI = \fR\fI\FC5\F[]\fR\fI \fR
4745 This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\&.
4748 \fI\fIldap delete dn\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4751 ldap group suffix (G)
4752 .\" ldap group suffix
4755 This parameter specifies the suffix that is used for groups when these are added to the LDAP directory\&. If this parameter is unset, the value of
4756 \m[blue]\fBldap suffix\fR\m[]
4757 will be used instead\&. The suffix string is pre\-pended to the
4758 \m[blue]\fBldap suffix\fR\m[]
4759 string so use a partial DN\&.
4762 \fI\fIldap group suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4765 \fI\fIldap group suffix\fR\fR\fI = \fR\fI\FCou=Groups\F[]\fR\fI \fR
4768 ldap idmap suffix (G)
4769 .\" ldap idmap suffix
4772 This parameters specifies the suffix that is used when storing idmap mappings\&. If this parameter is unset, the value of
4773 \m[blue]\fBldap suffix\fR\m[]
4774 will be used instead\&. The suffix string is pre\-pended to the
4775 \m[blue]\fBldap suffix\fR\m[]
4776 string so use a partial DN\&.
4779 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4782 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\FCou=Idmap\F[]\fR\fI \fR
4785 ldap machine suffix (G)
4786 .\" ldap machine suffix
4789 It specifies where machines should be added to the ldap tree\&. If this parameter is unset, the value of
4790 \m[blue]\fBldap suffix\fR\m[]
4791 will be used instead\&. The suffix string is pre\-pended to the
4792 \m[blue]\fBldap suffix\fR\m[]
4793 string so use a partial DN\&.
4796 \fI\fIldap machine suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4799 \fI\fIldap machine suffix\fR\fR\fI = \fR\fI\FCou=Computers\F[]\fR\fI \fR
4802 ldap passwd sync (G)
4803 .\" ldap passwd sync
4806 This option is used to define whether or not Samba should sync the LDAP password with the NT and LM hashes for normal accounts (NOT for workstation, server or domain trusts) on a password change via SAMBA\&.
4809 \m[blue]\fBldap passwd sync\fR\m[]
4810 can be set to one of three values:
4814 \h'-04'\(bu\h'+03'\c
4821 = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\&.
4826 \h'-04'\(bu\h'+03'\c
4833 = Update NT and LM passwords and update the pwdLastSet time\&.
4838 \h'-04'\(bu\h'+03'\c
4845 = Only update the LDAP password and let the LDAP server do the rest\&.
4849 \fI\fIldap passwd sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4852 ldap replication sleep (G)
4853 .\" ldap replication sleep
4856 When Samba is asked to write to a read\-only LDAP replica, we are redirected to talk to the read\-write master server\&. This server then replicates our changes back to the \'local\' server, however the replication might take some seconds, especially over slow links\&. Certain client activities, particularly domain joins, can become confused by the \'success\' that does not immediately change the LDAP back\-end\'s data\&.
4858 This option simply causes Samba to wait a short time, to allow the LDAP server to catch up\&. If you have a particularly high\-latency network, you may wish to time the LDAP replication with a network sniffer, and increase this value accordingly\&. Be aware that no checking is performed that the data has actually replicated\&.
4860 The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\&.
4863 \fI\fIldap replication sleep\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
4866 ldapsam:editposix (G)
4867 .\" ldapsam:editposix
4870 Editposix is an option that leverages ldapsam:trusted to make it simpler to manage a domain controller eliminating the need to set up custom scripts to add and manage the posix users and groups\&. This option will instead directly manipulate the ldap tree to create, remove and modify user and group entries\&. This option also requires a running winbindd as it is used to allocate new uids/gids on user/group creation\&. The allocation range must be therefore configured\&.
4872 To use this option, a basic ldap tree must be provided and the ldap suffix parameters must be properly configured\&. On virgin servers the default users and groups (Administrator, Guest, Domain Users, Domain Admins, Domain Guests) can be precreated with the command
4873 \FCnet sam provision\F[]\&. To run this command the ldap server must be running, Winindd must be running and the smb\&.conf ldap options must be properly configured\&. The typical ldap setup used with the
4874 \m[blue]\fBldapsam:trusted = yes\fR\m[]
4875 option is usually sufficient to use
4876 \m[blue]\fBldapsam:editposix = yes\fR\m[]
4879 An example configuration can be the following:
4890 .BB lightgray adjust-for-leading-newline
4893 encrypt passwords = true
4894 passdb backend = ldapsam
4897 ldapsam:editposix=yes
4899 ldap admin dn = cn=admin,dc=samba,dc=org
4900 ldap delete dn = yes
4901 ldap group suffix = ou=groups
4902 ldap idmap suffix = ou=idmap
4903 ldap machine suffix = ou=computers
4904 ldap user suffix = ou=users
4905 ldap suffix = dc=samba,dc=org
4907 idmap backend = ldap:"ldap://localhost"
4909 idmap uid = 5000\-50000
4910 idmap gid = 5000\-50000
4912 .EB lightgray adjust-for-leading-newline
4923 This configuration assumes a directory layout like described in the following ldif:
4934 .BB lightgray adjust-for-leading-newline
4939 objectClass: dcObject
4940 objectClass: organization
4944 dn: cn=admin,dc=samba,dc=org
4945 objectClass: simpleSecurityObject
4946 objectClass: organizationalRole
4948 description: LDAP administrator
4949 userPassword: secret
4951 dn: ou=users,dc=samba,dc=org
4953 objectClass: organizationalUnit
4956 dn: ou=groups,dc=samba,dc=org
4958 objectClass: organizationalUnit
4961 dn: ou=idmap,dc=samba,dc=org
4963 objectClass: organizationalUnit
4966 dn: ou=computers,dc=samba,dc=org
4968 objectClass: organizationalUnit
4971 .EB lightgray adjust-for-leading-newline
4983 \fI\fIldapsam:editposix\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4990 By default, Samba as a Domain Controller with an LDAP backend needs to use the Unix\-style NSS subsystem to access user and group information\&. Due to the way Unix stores user information in /etc/passwd and /etc/group this inevitably leads to inefficiencies\&. One important question a user needs to know is the list of groups he is member of\&. The plain UNIX model involves a complete enumeration of the file /etc/group and its NSS counterparts in LDAP\&. UNIX has optimized functions to enumerate group membership\&. Sadly, other functions that are used to deal with user and group attributes lack such optimization\&.
4992 To make Samba scale well in large environments, the
4993 \m[blue]\fBldapsam:trusted = yes\fR\m[]
4994 option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the standard posixAccount/posixGroup attributes\&. It further assumes that the Samba auxiliary object classes are stored together with the POSIX data in the same LDAP object\&. If these assumptions are met,
4995 \m[blue]\fBldapsam:trusted = yes\fR\m[]
4996 can be activated and Samba can bypass the NSS system to query user group memberships\&. Optimized LDAP queries can greatly speed up domain logon and administration tasks\&. Depending on the size of the LDAP database a factor of 100 or more for common queries is easily achieved\&.
4999 \fI\fIldapsam:trusted\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
5006 This option is used to define whether or not Samba should use SSL when connecting to the ldap server using
5008 methods\&. Rpc methods are not affected by this parameter\&. Please note, that this parameter won\'t have any effect if
5009 \m[blue]\fBldap ssl\fR\m[]
5015 for more information on
5016 \m[blue]\fBldap ssl\fR\m[]\&.
5019 \fI\fIldap ssl ads\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
5026 This option is used to define whether or not Samba should use SSL when connecting to the ldap server This is
5028 related to Samba\'s previous SSL support which was enabled by specifying the
5029 \FC\-\-with\-ssl\F[]
5034 LDAP connections should be secured where possible\&. This may be done setting
5041 in the URL argument of
5042 \m[blue]\fBpassdb backend\fR\m[]\&.
5045 \m[blue]\fBldap ssl\fR\m[]
5046 can be set to one of two values:
5050 \h'-04'\(bu\h'+03'\c
5057 = Never use SSL when querying the directory\&.
5062 \h'-04'\(bu\h'+03'\c
5069 = Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\&.
5072 Please note that this parameter does only affect
5074 methods\&. To enable the LDAPv3 StartTLS extended operation (RFC2830) for
5076 \m[blue]\fBldap ssl = yes\fR\m[]
5078 \m[blue]\fBldap ssl ads = yes\fR\m[]\&. See
5080 for more information on
5081 \m[blue]\fBldap ssl ads\fR\m[]\&.
5084 \fI\fIldap ssl\fR\fR\fI = \fR\fI\FCstart tls\F[]\fR\fI \fR
5091 Specifies the base for all ldap suffixes and for storing the sambaDomain object\&.
5093 The ldap suffix will be appended to the values specified for the
5094 \m[blue]\fBldap user suffix\fR\m[],
5095 \m[blue]\fBldap group suffix\fR\m[],
5096 \m[blue]\fBldap machine suffix\fR\m[], and the
5097 \m[blue]\fBldap idmap suffix\fR\m[]\&. Each of these should be given only a DN relative to the
5098 \m[blue]\fBldap suffix\fR\m[]\&.
5101 \fI\fIldap suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
5104 \fI\fIldap suffix\fR\fR\fI = \fR\fI\FCdc=samba,dc=org\F[]\fR\fI \fR
5111 This parameter defines the number of seconds that Samba should use as timeout for LDAP operations\&.
5114 \fI\fIldap timeout\fR\fR\fI = \fR\fI\FC15\F[]\fR\fI \fR
5117 ldap user suffix (G)
5118 .\" ldap user suffix
5121 This parameter specifies where users are added to the tree\&. If this parameter is unset, the value of
5122 \m[blue]\fBldap suffix\fR\m[]
5123 will be used instead\&. The suffix string is pre\-pended to the
5124 \m[blue]\fBldap suffix\fR\m[]
5125 string so use a partial DN\&.
5128 \fI\fIldap user suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
5131 \fI\fIldap user suffix\fR\fR\fI = \fR\fI\FCou=people\F[]\fR\fI \fR
5138 This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\&.
5140 Level2, or read\-only oplocks allow Windows NT clients that have an oplock on a file to downgrade from a read\-write oplock to a read\-only oplock once a second client opens the file (instead of releasing all oplocks on a second open, as in traditional, exclusive oplocks)\&. This allows all openers of the file that support level2 oplocks to cache the file for read\-ahead only (ie\&. they may not cache writes or lock requests) and increases performance for many accesses of files that are not commonly written (such as application \&.EXE files)\&.
5142 Once one of the clients which have a read\-only oplock writes to the file all clients are notified (no reply is needed or waited for) and told to break their oplocks to "none" and delete any read\-ahead caches\&.
5144 It is recommended that this parameter be turned on to speed access to shared executables\&.
5146 For more discussions on level2 oplocks see the CIFS spec\&.
5149 \m[blue]\fBkernel oplocks\fR\m[]
5150 are supported then level2 oplocks are not granted (even if this parameter is set to
5151 \fByes\fR)\&. Note also, the
5152 \m[blue]\fBoplocks\fR\m[]
5153 parameter must be set to
5155 on this share in order for this parameter to have any effect\&.
5158 \fI\fIlevel2 oplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
5165 This parameter determines if
5167 will produce Lanman announce broadcasts that are needed by OS/2 clients in order for them to see the Samba server in their browse list\&. This parameter can have three values,
5170 \fBauto\fR\&. The default is
5171 \fBauto\fR\&. If set to
5173 Samba will never produce these broadcasts\&. If set to
5175 Samba will produce Lanman announce broadcasts at a frequency set by the parameter
5176 \m[blue]\fBlm interval\fR\m[]\&. If set to
5178 Samba will not send Lanman announce broadcasts by default but will listen for them\&. If it hears such a broadcast on the wire it will then start sending them at a frequency set by the parameter
5179 \m[blue]\fBlm interval\fR\m[]\&.
5182 \fI\fIlm announce\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
5185 \fI\fIlm announce\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
5192 If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the
5193 \m[blue]\fBlm announce\fR\m[]
5194 parameter) then this parameter defines the frequency in seconds with which they will be made\&. If this is set to zero then no Lanman announcements will be made despite the setting of the
5195 \m[blue]\fBlm announce\fR\m[]
5199 \fI\fIlm interval\fR\fR\fI = \fR\fI\FC60\F[]\fR\fI \fR
5202 \fI\fIlm interval\fR\fR\fI = \fR\fI\FC120\F[]\fR\fI \fR
5209 A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\&. See the
5210 \m[blue]\fBprinters\fR\m[]
5211 section for more details\&.
5214 \fI\fIload printers\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
5223 to try and become a local master browser on a subnet\&. If set to
5227 will not attempt to become a local master browser on a subnet and will also lose in all browsing elections\&. By default this value is set to
5228 \fByes\fR\&. Setting this value to
5230 doesn\'t mean that Samba will
5232 the local master browser on a subnet, just that
5236 in elections for local master browser\&.
5238 Setting this value to
5243 to become a local master browser\&.
5246 \fI\fIlocal master\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
5253 This parameter is a synonym for
5261 This option specifies the directory where lock files will be placed\&. The lock files are used to implement the
5262 \m[blue]\fBmax connections\fR\m[]
5265 Note: This option can not be set inside registry configurations\&.
5268 \fI\fIlock directory\fR\fR\fI = \fR\fI\FC${prefix}/var/locks\F[]\fR\fI \fR
5271 \fI\fIlock directory\fR\fR\fI = \fR\fI\FC/var/run/samba/locks\F[]\fR\fI \fR
5278 This controls whether or not locking will be performed by the server in response to lock requests from the client\&.
5281 \FClocking = no\F[], all lock and unlock requests will appear to succeed and all lock queries will report that the file in question is available for locking\&.
5284 \FClocking = yes\F[], real locking will be performed by the server\&.
5288 be useful for read\-only filesystems which
5290 not need locking (such as CDROM drives), although setting this parameter of
5292 is not really recommended even in this case\&.
5294 Be careful about disabling locking either globally or in a specific service, as lack of locking may result in data corruption\&. You should never need to set this parameter\&.
5303 This parameter has been made inoperative in Samba 3\&.0\&.24\&. The functionality it contolled is now controlled by the parameter
5304 \m[blue]\fBlock spin time\fR\m[]\&.
5307 \fI\fIlock spin count\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
5314 The time in microseconds that smbd should keep waiting to see if a failed lock request can be granted\&. This parameter has changed in default value from Samba 3\&.0\&.23 from 10 to 200\&. The associated
5315 \m[blue]\fBlock spin count\fR\m[]
5316 parameter is no longer used in Samba 3\&.0\&.24\&. You should not need to change the value of this parameter\&.
5319 \fI\fIlock spin time\fR\fR\fI = \fR\fI\FC200\F[]\fR\fI \fR
5326 This option allows you to override the name of the Samba log file (also known as the debug file)\&.
5328 This option takes the standard substitutions, allowing you to have separate log files for each user or machine\&.
5333 \fI\fIlog file\fR\fR\fI = \fR\fI\FC/usr/local/samba/var/log\&.%m\F[]\fR\fI \fR
5340 This parameter is a synonym for
5348 The value of the parameter (a astring) allows the debug level (logging level) to be specified in the
5352 This parameter has been extended since the 2\&.2\&.x series, now it allows to specify the debug level for multiple debug classes\&. This is to give greater flexibility in the configuration of the system\&. The following debug classes are currently implemented:
5356 \h'-04'\(bu\h'+03'\c
5367 \h'-04'\(bu\h'+03'\c
5378 \h'-04'\(bu\h'+03'\c
5389 \h'-04'\(bu\h'+03'\c
5400 \h'-04'\(bu\h'+03'\c
5411 \h'-04'\(bu\h'+03'\c
5422 \h'-04'\(bu\h'+03'\c
5433 \h'-04'\(bu\h'+03'\c
5444 \h'-04'\(bu\h'+03'\c
5455 \h'-04'\(bu\h'+03'\c
5466 \h'-04'\(bu\h'+03'\c
5477 \h'-04'\(bu\h'+03'\c
5488 \h'-04'\(bu\h'+03'\c
5499 \h'-04'\(bu\h'+03'\c
5510 \h'-04'\(bu\h'+03'\c
5521 \h'-04'\(bu\h'+03'\c
5532 \h'-04'\(bu\h'+03'\c
5543 \h'-04'\(bu\h'+03'\c
5554 \h'-04'\(bu\h'+03'\c
5565 \h'-04'\(bu\h'+03'\c
5575 \fI\fIlog level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
5578 \fI\fIlog level\fR\fR\fI = \fR\fI\FC3 passdb:5 auth:10 winbind:2\F[]\fR\fI \fR
5585 This parameter specifies the local path to which the home directory will be connected (see
5586 \m[blue]\fBlogon home\fR\m[]) and is only used by NT Workstations\&.
5588 Note that this option is only useful if Samba is set up as a logon server\&.
5591 \fI\fIlogon drive\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
5594 \fI\fIlogon drive\fR\fR\fI = \fR\fI\FCh:\F[]\fR\fI \fR
5601 This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\&. It allows you to do
5604 \FCC:\e>\F[]\fBNET USE H: /HOME\fR
5606 from a command prompt, for example\&.
5608 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
5610 This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a subdirectory of the user\'s home directory\&. This is done in the following way:
5613 \FClogon home = \e\e%N\e%U\eprofile\F[]
5615 This tells Samba to return the above string, with substitutions made when a client requests the info, generally in a NetUserGetInfo request\&. Win9X clients truncate the info to \e\eserver\eshare when a user does
5616 \FCnet use /home\F[]
5617 but use the whole string when dealing with profiles\&.
5619 Note that in prior versions of Samba, the
5620 \m[blue]\fBlogon path\fR\m[]
5621 was returned rather than
5622 \fIlogon home\fR\&. This broke
5623 \FCnet use /home\F[]
5624 but allowed profiles outside the home directory\&. The current implementation is correct, and can be used for profiles if you use the above trick\&.
5626 Disable this feature by setting
5627 \m[blue]\fBlogon home = ""\fR\m[]
5628 \- using the empty string\&.
5630 This option is only useful if Samba is set up as a logon server\&.
5633 \fI\fIlogon home\fR\fR\fI = \fR\fI\FC\e\e%N\e%U\F[]\fR\fI \fR
5636 \fI\fIlogon home\fR\fR\fI = \fR\fI\FC\e\eremote_smb_server\e%U\F[]\fR\fI \fR
5643 This parameter specifies the directory where roaming profiles (Desktop, NTuser\&.dat, etc) are stored\&. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming profiles\&. To find out how to handle roaming profiles for Win 9X system, see the
5644 \m[blue]\fBlogon home\fR\m[]
5647 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&. It also specifies the directory from which the "Application Data",
5650 \FCnetwork neighborhood\F[],
5652 and other folders, and their contents, are loaded and displayed on your Windows NT client\&.
5654 The share and the path must be readable by the user for the preferences and directories to be loaded onto the Windows NT client\&. The share must be writeable when the user logs in for the first time, in order that the Windows NT client can create the NTuser\&.dat and other directories\&. Thereafter, the directories and any of the contents can, if required, be made read\-only\&. It is not advisable that the NTuser\&.dat file be made read\-only \- rename it to NTuser\&.man to achieve the desired effect (a
5655 \fIMAN\fRdatory profile)\&.
5657 Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged in\&. Therefore, it is vital that the logon path does not include a reference to the homes share (i\&.e\&. setting this parameter to \e\e%N\ehomes\eprofile_path will cause problems)\&.
5659 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
5666 .nr an-no-space-flag 1
5673 Do not quote the value\&. Setting this as
5674 \(lq\e\e%N\eprofile\e%U\(rq
5675 will break profile handling\&. Where the tdbsam or ldapsam passdb backend is used, at the time the user account is created the value configured for this parameter is written to the passdb backend and that value will over\-ride the parameter value present in the smb\&.conf file\&. Any error present in the passdb backend account record must be editted using the appropriate tool (pdbedit on the command\-line, or any other locally provided system tool)\&.
5679 Note that this option is only useful if Samba is set up as a domain controller\&.
5681 Disable the use of roaming profiles by setting the value of this parameter to the empty string\&. For example,
5682 \m[blue]\fBlogon path = ""\fR\m[]\&. Take note that even if the default setting in the smb\&.conf file is the empty string, any value specified in the user account settings in the passdb backend will over\-ride the effect of setting this parameter to null\&. Disabling of all roaming profile use requires that the user account settings must also be blank\&.
5684 An example of use is:
5695 .BB lightgray adjust-for-leading-newline
5698 logon path = \e\ePROFILESERVER\ePROFILE\e%U
5699 .EB lightgray adjust-for-leading-newline
5711 \fI\fIlogon path\fR\fR\fI = \fR\fI\FC\e\e%N\e%U\eprofile\F[]\fR\fI \fR
5718 This parameter specifies the batch file (\FC\&.bat\F[]) or NT command file (\FC\&.cmd\F[]) to be downloaded and run on a machine when a user successfully logs in\&. The file must contain the DOS style CR/LF line endings\&. Using a DOS\-style editor to create the file is recommended\&.
5720 The script must be a relative path to the
5722 service\&. If the [netlogon] service specifies a
5723 \m[blue]\fBpath\fR\m[]
5725 \FC/usr/local/samba/netlogon\F[], and
5726 \m[blue]\fBlogon script = STARTUP\&.BAT\fR\m[], then the file that will be downloaded is:
5737 .BB lightgray adjust-for-leading-newline
5740 /usr/local/samba/netlogon/STARTUP\&.BAT
5741 .EB lightgray adjust-for-leading-newline
5752 The contents of the batch file are entirely your choice\&. A suggested command would be to add
5753 \FCNET TIME \e\eSERVER /SET /YES\F[], to force every machine to synchronize clocks with the same time server\&. Another use would be to add
5754 \FCNET USE U: \e\eSERVER\eUTILS\F[]
5755 for commonly used utilities, or
5766 .BB lightgray adjust-for-leading-newline
5769 \fBNET USE Q: \e\eSERVER\eISO9001_QA\fR
5770 .EB lightgray adjust-for-leading-newline
5783 Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users write permission on the batch files in a secure environment, as this would allow the batch files to be arbitrarily modified and security to be breached\&.
5785 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
5787 This option is only useful if Samba is set up as a logon server\&.
5790 \fI\fIlogon script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
5793 \fI\fIlogon script\fR\fR\fI = \fR\fI\FCscripts\e%U\&.bat\F[]\fR\fI \fR
5800 This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\&.
5802 This command should be a program or script which takes a printer name and job number to pause the print job\&. One way of implementing this is by using job priorities, where jobs having a too low priority won\'t be sent to the printer\&.
5806 is given then the printer name is put in its place\&. A
5808 is replaced with the job number (an integer)\&. On HPUX (see
5809 \fIprinting=hpux \fR), if the
5811 option is added to the lpq command, the job will show up with the correct status, i\&.e\&. if the job priority is lower than the set fence priority it will have the PAUSED status, whereas if the priority is equal or higher it will have the SPOOLED or PRINTING status\&.
5813 Note that it is good practice to include the absolute path in the lppause command as the PATH may not be available to the server\&.
5816 \fI\fIlppause command\fR\fR\fI = \fR\fI\FC # Currently no default value is given to this string, unless the value of the \m[blue]\fBprinting\fR\m[] parameter is \fBSYSV\fR, in which case the default is : \FClp \-i %p\-%j \-H hold\F[] or if the value of the \fIprinting\fR parameter is \fBSOFTQ\fR, then the default is: \FCqstat \-s \-j%j \-h\F[]\&. \F[]\fR\fI \fR
5819 \fI\fIlppause command\fR\fR\fI = \fR\fI\FC/usr/bin/lpalt %p\-%j \-p0\F[]\fR\fI \fR
5826 This controls how long lpq info will be cached for to prevent the
5828 command being called too often\&. A separate cache is kept for each variation of the
5830 command used by the system, so if you use different
5832 commands for different users then they won\'t share cache information\&.
5834 The cache files are stored in
5835 \FC/tmp/lpq\&.xxxx\F[]
5836 where xxxx is a hash of the
5840 The default is 30 seconds, meaning that the cached results of a previous identical
5842 command will be used if the cached data is less than 30 seconds old\&. A large value may be advisable if your
5844 command is very slow\&.
5846 A value of 0 will disable caching completely\&.
5849 \fI\fIlpq cache time\fR\fR\fI = \fR\fI\FC30\F[]\fR\fI \fR
5852 \fI\fIlpq cache time\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
5859 This parameter specifies the command to be executed on the server host in order to obtain
5860 \FClpq \F[]\-style printer status information\&.
5862 This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\&.
5864 Currently nine styles of printer status information are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ\&. This covers most UNIX systems\&. You control which type is expected using the
5868 Some clients (notably Windows for Workgroups) may not correctly send the connection number for the printer they are requesting status information about\&. To get around this, the server reports on the first printer service connected to by the client\&. This only happens if the connection number sent is invalid\&.
5872 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
5874 Note that it is good practice to include the absolute path in the
5878 may not be available to the server\&. When compiled with the CUPS libraries, no
5880 is needed because smbd will make a library call to obtain the print queue listing\&.
5883 \fI\fIlpq command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
5886 \fI\fIlpq command\fR\fR\fI = \fR\fI\FC/usr/bin/lpq \-P%p\F[]\fR\fI \fR
5889 lpresume command (S)
5890 .\" lpresume command
5893 This parameter specifies the command to be executed on the server host in order to restart or continue printing or spooling a specific print job\&.
5895 This command should be a program or script which takes a printer name and job number to resume the print job\&. See also the
5896 \m[blue]\fBlppause command\fR\m[]
5901 is given then the printer name is put in its place\&. A
5903 is replaced with the job number (an integer)\&.
5905 Note that it is good practice to include the absolute path in the
5906 \fIlpresume command\fR
5907 as the PATH may not be available to the server\&.
5910 \m[blue]\fBprinting\fR\m[]
5913 Default: Currently no default value is given to this string, unless the value of the
5916 \fBSYSV\fR, in which case the default is:
5918 \FClp \-i %p\-%j \-H resume\F[]
5920 or if the value of the
5923 \fBSOFTQ\fR, then the default is:
5925 \FCqstat \-s \-j%j \-r\F[]
5930 \fI\fIlpresume command\fR\fR\fI = \fR\fI\FC/usr/bin/lpalt %p\-%j \-p2\F[]\fR\fI \fR
5937 This parameter specifies the command to be executed on the server host in order to delete a print job\&.
5939 This command should be a program or script which takes a printer name and job number, and deletes the print job\&.
5943 is given then the printer name is put in its place\&. A
5945 is replaced with the job number (an integer)\&.
5947 Note that it is good practice to include the absolute path in the
5949 as the PATH may not be available to the server\&.
5951 Examples of use are:
5962 .BB lightgray adjust-for-leading-newline
5965 lprm command = /usr/bin/lprm \-P%p %j
5969 lprm command = /usr/bin/cancel %p\-%j
5970 .EB lightgray adjust-for-leading-newline
5982 \fI\fIlprm command\fR\fR\fI = \fR\fI\FC determined by printing parameter\F[]\fR\fI \fR
5985 machine password timeout (G)
5986 .\" machine password timeout
5989 If a Samba server is a member of a Windows NT Domain (see the
5990 \m[blue]\fBsecurity = domain\fR\m[]
5991 parameter) then periodically a running smbd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called
5992 \FCprivate/secrets\&.tdb \F[]\&. This parameter specifies how often this password will be changed, in seconds\&. The default is one week (expressed in seconds), the same as a Windows NT Domain member server\&.
5995 \fBsmbpasswd\fR(8), and the
5996 \m[blue]\fBsecurity = domain\fR\m[]
6000 \fI\fImachine password timeout\fR\fR\fI = \fR\fI\FC604800\F[]\fR\fI \fR
6007 This parameter specifies the name of a file which will contain output created by a magic script (see the
6008 \m[blue]\fBmagic script\fR\m[]
6016 .nr an-no-space-flag 1
6023 If two clients use the same
6025 in the same directory the output file content is undefined\&.
6030 \fI\fImagic output\fR\fR\fI = \fR\fI\FC<magic script name>\&.out\F[]\fR\fI \fR
6033 \fI\fImagic output\fR\fR\fI = \fR\fI\FCmyfile\&.txt\F[]\fR\fI \fR
6040 This parameter specifies the name of a file which, if opened, will be executed by the server when the file is closed\&. This allows a UNIX script to be sent to the Samba host and executed on behalf of the connected user\&.
6042 Scripts executed in this way will be deleted upon completion assuming that the user has the appropriate level of privilege and the file permissions allow the deletion\&.
6044 If the script generates output, output will be sent to the file specified by the
6045 \m[blue]\fBmagic output\fR\m[]
6046 parameter (see above)\&.
6048 Note that some shells are unable to interpret scripts containing CR/LF instead of CR as the end\-of\-line marker\&. Magic scripts must be executable
6050 on the host, which for some hosts and some shells will require filtering at the DOS end\&.
6059 \fI\fImagic script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
6062 \fI\fImagic script\fR\fR\fI = \fR\fI\FCuser\&.csh\F[]\fR\fI \fR
6069 This controls whether non\-DOS names under UNIX should be mapped to DOS\-compatible names ("mangled") and made visible, or whether non\-DOS names should simply be ignored\&.
6072 \m[blue]\fBname mangling\fR\m[]
6073 for details on how to control the mangling process\&.
6075 If mangling is used then the mangling algorithm is as follows:
6079 \h'-04'\(bu\h'+03'\c
6085 The first (up to) five alphanumeric characters before the rightmost dot of the filename are preserved, forced to upper case, and appear as the first (up to) five characters of the mangled name\&.
6090 \h'-04'\(bu\h'+03'\c
6096 A tilde "~" is appended to the first part of the mangled name, followed by a two\-character unique sequence, based on the original root name (i\&.e\&., the original filename minus its final extension)\&. The final extension is included in the hash calculation only if it contains any upper case characters or is longer than three characters\&.
6098 Note that the character to use may be specified using the
6099 \m[blue]\fBmangling char\fR\m[]
6100 option, if you don\'t like \'~\'\&.
6105 \h'-04'\(bu\h'+03'\c
6111 Files whose UNIX name begins with a dot will be presented as DOS hidden files\&. The mangled name will be created as for other filenames, but with the leading dot removed and "___" as its extension regardless of actual original extension (that\'s three underscores)\&.
6114 The two\-digit hash value consists of upper case alphanumeric characters\&.
6116 This algorithm can cause name collisions only if files in a directory share the same first five alphanumeric characters\&. The probability of such a clash is 1/1300\&.
6118 The name mangling (if enabled) allows a file to be copied between UNIX directories from Windows/DOS while retaining the long UNIX filename\&. UNIX files can be renamed to a new extension from Windows/DOS and will retain the same basename\&. Mangled names do not change between sessions\&.
6121 \fI\fImangled names\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
6128 controls the number of prefix characters from the original name used when generating the mangled names\&. A larger value will give a weaker hash and therefore more name collisions\&. The minimum value is 1 and the maximum value is 6\&.
6130 mangle prefix is effective only when mangling method is hash2\&.
6133 \fI\fImangle prefix\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
6136 \fI\fImangle prefix\fR\fR\fI = \fR\fI\FC4\F[]\fR\fI \fR
6143 This controls what character is used as the
6146 \m[blue]\fBname mangling\fR\m[]\&. The default is a \'~\' but this may interfere with some software\&. Use this option to set it to whatever you prefer\&. This is effective only when mangling method is hash\&.
6149 \fI\fImangling char\fR\fR\fI = \fR\fI\FC~\F[]\fR\fI \fR
6152 \fI\fImangling char\fR\fR\fI = \fR\fI\FC^\F[]\fR\fI \fR
6159 controls the algorithm used for the generating the mangled names\&. Can take two different values, "hash" and "hash2"\&. "hash" is the algorithm that was used used in Samba for many years and was the default in Samba 2\&.2\&.x "hash2" is now the default and is newer and considered a better algorithm (generates less collisions) in the names\&. Many Win32 applications store the mangled names and so changing to algorithms must not be done lightly as these applications may break unless reinstalled\&.
6162 \fI\fImangling method\fR\fR\fI = \fR\fI\FChash2\F[]\fR\fI \fR
6165 \fI\fImangling method\fR\fR\fI = \fR\fI\FChash\F[]\fR\fI \fR
6172 This boolean parameter controls whether
6174 will attempt to map the \'inherit\' and \'protected\' access control entry flags stored in Windows ACLs into an extended attribute called user\&.SAMBA_PAI\&. This parameter only takes effect if Samba is being run on a platform that supports extended attributes (Linux and IRIX so far) and allows the Windows 2000 ACL editor to correctly use inheritance with the Samba POSIX ACL mapping code\&.
6177 \fI\fImap acl inherit\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
6184 This controls whether the DOS archive attribute should be mapped to the UNIX owner execute bit\&. The DOS archive bit is set when a file has been modified since its last backup\&. One motivation for this option is to keep Samba/your PC from making any file it touches from becoming executable under UNIX\&. This can be quite annoying for shared source code, documents, etc\&.\&.\&.
6186 Note that this requires the
6187 \m[blue]\fBcreate mask\fR\m[]
6188 parameter to be set such that owner execute bit is not masked out (i\&.e\&. it must include 100)\&. See the parameter
6189 \m[blue]\fBcreate mask\fR\m[]
6193 \fI\fImap archive\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
6200 This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\&.
6202 Note that this requires the
6203 \m[blue]\fBcreate mask\fR\m[]
6204 to be set such that the world execute bit is not masked out (i\&.e\&. it must include 001)\&. See the parameter
6205 \m[blue]\fBcreate mask\fR\m[]
6215 This controls how the DOS read only attribute should be mapped from a UNIX filesystem\&.
6217 This parameter can take three different values, which tell
6219 how to display the read only attribute on files, where either
6220 \m[blue]\fBstore dos attributes\fR\m[]
6222 \fBNo\fR, or no extended attribute is present\&. If
6223 \m[blue]\fBstore dos attributes\fR\m[]
6226 then this parameter is
6227 \fIignored\fR\&. This is a new parameter introduced in Samba version 3\&.0\&.21\&.
6229 The three settings are :
6233 \h'-04'\(bu\h'+03'\c
6241 \- The read only DOS attribute is mapped to the inverse of the user or owner write bit in the unix permission mode set\&. If the owner write bit is not set, the read only attribute is reported as being set on the file\&. If the read only DOS attribute is set, Samba sets the owner, group and others write bits to zero\&. Write bits set in an ACL are ignored by Samba\&. If the read only DOS attribute is unset, Samba simply sets the write bit of the owner to one\&.
6246 \h'-04'\(bu\h'+03'\c
6254 \- The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by
6256 by reading the unix permissions and POSIX ACL (if present)\&. If the connecting user does not have permission to modify the file, the read only attribute is reported as being set on the file\&.
6261 \h'-04'\(bu\h'+03'\c
6269 \- The read only DOS attribute is unaffected by permissions, and can only be set by the
6270 \m[blue]\fBstore dos attributes\fR\m[]
6271 method\&. This may be useful for exporting mounted CDs\&.
6275 \fI\fImap read only\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
6282 This controls whether DOS style system files should be mapped to the UNIX group execute bit\&.
6284 Note that this requires the
6285 \m[blue]\fBcreate mask\fR\m[]
6286 to be set such that the group execute bit is not masked out (i\&.e\&. it must include 010)\&. See the parameter
6287 \m[blue]\fBcreate mask\fR\m[]
6291 \fI\fImap system\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
6298 This parameter is only useful in
6299 \m[blue]\fBSECURITY = security\fR\m[]
6301 \fIsecurity = share\fR
6303 \fIsecurity = server\fR
6308 This parameter can take four different values, which tell
6310 what to do with user login requests that don\'t match a valid UNIX user in some way\&.
6312 The four settings are :
6316 \h'-04'\(bu\h'+03'\c
6323 \- Means user login requests with an invalid password are rejected\&. This is the default\&.
6328 \h'-04'\(bu\h'+03'\c
6335 \- Means user logins with an invalid password are rejected, unless the username does not exist, in which case it is treated as a guest login and mapped into the
6336 \m[blue]\fBguest account\fR\m[]\&.
6341 \h'-04'\(bu\h'+03'\c
6348 \- Means user logins with an invalid password are treated as a guest login and mapped into the
6349 \m[blue]\fBguest account\fR\m[]\&. Note that this can cause problems as it means that any user incorrectly typing their password will be silently logged on as "guest" \- and will not know the reason they cannot access files they think they should \- there will have been no message given to them that they got their password wrong\&. Helpdesk services will
6353 parameter this way :\-)\&.
6358 \h'-04'\(bu\h'+03'\c
6365 \- Is only applicable when Samba is configured in some type of domain mode security (security = {domain|ads}) and means that user logins which are successfully authenticated but which have no valid Unix user account (and smbd is unable to create one) should be mapped to the defined guest account\&. This was the default behavior of Samba 2\&.x releases\&. Note that if a member server is running winbindd, this option should never be required because the nss_winbind library will export the Windows domain users and groups to the underlying OS via the Name Service Switch interface\&.
6368 Note that this parameter is needed to set up "Guest" share services when using
6370 modes other than share and server\&. This is because in these modes the name of the resource being requested is
6372 sent to the server until after the server has successfully authenticated the client so the server cannot make authentication decisions at the correct time (connection to the share) for "Guest" shares\&. This parameter is not useful with
6373 \fIsecurity = server\fR
6374 as in this security mode no information is returned about whether a user logon failed due to a bad username or bad password, the same error is returned from a modern server in both cases\&.
6376 For people familiar with the older Samba releases, this parameter maps to the old compile\-time setting of the
6377 \fB GUEST_SESSSETUP\fR
6378 value in local\&.h\&.
6381 \fI\fImap to guest\fR\fR\fI = \fR\fI\FCNever\F[]\fR\fI \fR
6384 \fI\fImap to guest\fR\fR\fI = \fR\fI\FCBad User\F[]\fR\fI \fR
6387 map untrusted to domain (G)
6388 .\" map untrusted to domain
6391 If a client connects to smbd using an untrusted domain name, such as BOGUS\euser, smbd replaces the BOGUS domain with it\'s SAM name before attempting to authenticate that user\&. In the case where smbd is acting as a PDC this will be DOMAIN\euser\&. In the case where smbd is acting as a domain member server or a standalone server this will be WORKSTATION\euser\&.
6393 In previous versions of Samba (pre 3\&.4), if smbd was acting as a domain member server, the BOGUS domain name would instead be replaced by the primary domain which smbd was a member of\&. In this case authentication would be deferred off to a DC using the credentials DOMAIN\euser\&.
6395 When this parameter is set to
6397 smbd provides the legacy behavior of mapping untrusted domain names to the primary domain\&. When smbd is not acting as a domain member server, this parameter has no effect\&.
6400 \fI\fImap untrusted to domain\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
6407 This option allows the number of simultaneous connections to a service to be limited\&. If
6408 \fImax connections\fR
6409 is greater than 0 then connections will be refused if this number of connections to the service are already open\&. A value of zero mean an unlimited number of connections may be made\&.
6411 Record lock files are used to implement this feature\&. The lock files will be stored in the directory specified by the
6412 \m[blue]\fBlock directory\fR\m[]
6416 \fI\fImax connections\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6419 \fI\fImax connections\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
6426 This option allows you to put an upper limit on the apparent size of disks\&. If you set this option to 100 then all shares will appear to be not larger than 100 MB in size\&.
6428 Note that this option does not limit the amount of data you can put on the disk\&. In the above case you could still store much more than 100 MB on the disk, but if a client ever asks for the amount of free disk space or the total disk size then the result will be bounded by the amount specified in
6429 \fImax disk size\fR\&.
6431 This option is primarily useful to work around bugs in some pieces of software that can\'t handle very large disks, particularly disks over 1GB in size\&.
6435 of 0 means no limit\&.
6438 \fI\fImax disk size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6441 \fI\fImax disk size\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
6448 This option (an integer in kilobytes) specifies the max size the log file should grow to\&. Samba periodically checks the size and if it is exceeded it will rename the file, adding a
6452 A size of 0 means no limit\&.
6455 \fI\fImax log size\fR\fR\fI = \fR\fI\FC5000\F[]\fR\fI \fR
6458 \fI\fImax log size\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
6465 This option controls the maximum number of outstanding simultaneous SMB operations that Samba tells the client it will allow\&. You should never need to set this parameter\&.
6468 \fI\fImax mux\fR\fR\fI = \fR\fI\FC50\F[]\fR\fI \fR
6475 This parameter limits the maximum number of open files that one
6477 file serving process may have open for a client at any one time\&. The default for this parameter is set very high (10,000) as Samba uses only one bit per unopened file\&.
6479 The limit of the number of open files is usually set by the UNIX per\-process file descriptor limit rather than this parameter so you should never need to touch this parameter\&.
6482 \fI\fImax open files\fR\fR\fI = \fR\fI\FC10000\F[]\fR\fI \fR
6489 This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\&. If this number is exceeded,
6491 will remote "Out of Space" to the client\&.
6494 \fI\fImax print jobs\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
6497 \fI\fImax print jobs\fR\fR\fI = \fR\fI\FC5000\F[]\fR\fI \fR
6504 This parameter is a synonym for
6512 The value of the parameter (a string) is the highest protocol level that will be supported by the server\&.
6514 Possible values are :
6518 \h'-04'\(bu\h'+03'\c
6524 \fBCORE\fR: Earliest version\&. No concept of user names\&.
6529 \h'-04'\(bu\h'+03'\c
6535 \fBCOREPLUS\fR: Slight improvements on CORE for efficiency\&.
6540 \h'-04'\(bu\h'+03'\c
6546 \fBLANMAN1\fR: First
6548 version of the protocol\&. Long filename support\&.
6553 \h'-04'\(bu\h'+03'\c
6559 \fBLANMAN2\fR: Updates to Lanman1 protocol\&.
6564 \h'-04'\(bu\h'+03'\c
6570 \fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.
6573 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
6576 \fI\fImax protocol\fR\fR\fI = \fR\fI\FCNT1\F[]\fR\fI \fR
6579 \fI\fImax protocol\fR\fR\fI = \fR\fI\FCLANMAN1\F[]\fR\fI \fR
6582 max reported print jobs (S)
6583 .\" max reported print jobs
6586 This parameter limits the maximum number of jobs displayed in a port monitor for Samba printer queue at any given moment\&. If this number is exceeded, the excess jobs will not be shown\&. A value of zero means there is no limit on the number of print jobs reported\&.
6589 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6592 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
6595 max smbd processes (G)
6596 .\" max smbd processes
6599 This parameter limits the maximum number of
6601 processes concurrently running on a system and is intended as a stopgap to prevent degrading service to clients in the event that the server has insufficient resources to handle more than this number of connections\&. Remember that under normal operating conditions, each user will have an
6603 associated with him or her to handle connections to all shares from a given host\&.
6606 \fI\fImax smbd processes\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6609 \fI\fImax smbd processes\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
6612 max stat cache size (G)
6613 .\" max stat cache size
6616 This parameter limits the size in memory of any
6618 being used to speed up case insensitive name mappings\&. It represents the number of kilobyte (1024) units the stat cache can use\&. A value of zero, meaning unlimited, is not advisable due to increased memory useage\&. You should not need to change this parameter\&.
6621 \fI\fImax stat cache size\fR\fR\fI = \fR\fI\FC256\F[]\fR\fI \fR
6624 \fI\fImax stat cache size\fR\fR\fI = \fR\fI\FC100\F[]\fR\fI \fR
6633 what the default \'time to live\' of NetBIOS names should be (in seconds) when
6635 is requesting a name using either a broadcast packet or from a WINS server\&. You should never need to change this parameter\&. The default is 3 days\&.
6638 \fI\fImax ttl\fR\fR\fI = \fR\fI\FC259200\F[]\fR\fI \fR
6647 when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the maximum \'time to live\' of NetBIOS names that
6649 will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 days (518400 seconds)\&.
6652 \fI\fImax wins ttl\fR\fR\fI = \fR\fI\FC518400\F[]\fR\fI \fR
6659 This option controls the maximum packet size that will be negotiated by Samba\&. The default is 16644, which matches the behavior of Windows 2000\&. A value below 2048 is likely to cause problems\&. You should never need to change this parameter from its default value\&.
6662 \fI\fImax xmit\fR\fR\fI = \fR\fI\FC16644\F[]\fR\fI \fR
6665 \fI\fImax xmit\fR\fR\fI = \fR\fI\FC8192\F[]\fR\fI \fR
6672 This specifies what command to run when the server receives a WinPopup style message\&.
6674 This would normally be a command that would deliver the message somehow\&. How this is to be done is up to your imagination\&.
6687 .BB lightgray adjust-for-leading-newline
6690 \FCmessage command = csh \-c \'xedit %s;rm %s\' &\F[]
6691 .EB lightgray adjust-for-leading-newline
6702 This delivers the message using
6703 \FCxedit\F[], then removes it afterwards\&.
6704 \fINOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN IMMEDIATELY\fR\&. That\'s why I have the \'&\' on the end\&. If it doesn\'t return immediately then your PCs may freeze when sending messages (they should recover after 30 seconds, hopefully)\&.
6706 All messages are delivered as the global guest user\&. The command takes the standard substitutions, although
6708 won\'t work (\fI%U\fR
6709 may be better in this case)\&.
6711 Apart from the standard substitutions, some additional ones apply\&. In particular:
6715 \h'-04'\(bu\h'+03'\c
6722 = the filename containing the message\&.
6727 \h'-04'\(bu\h'+03'\c
6734 = the destination that the message was sent to (probably the server name)\&.
6739 \h'-04'\(bu\h'+03'\c
6746 = who the message is from\&.
6749 You could make this command send mail, or whatever else takes your fancy\&. Please let us know of any really interesting ideas you have\&.
6751 Here\'s a way of sending the messages as mail to root:
6762 .BB lightgray adjust-for-leading-newline
6765 \FCmessage command = /bin/mail \-s \'message from %f on %m\' root < %s; rm %s\F[]
6766 .EB lightgray adjust-for-leading-newline
6777 If you don\'t have a message command then the message won\'t be delivered and Samba will tell the sender there was an error\&. Unfortunately WfWg totally ignores the error code and carries on regardless, saying that the message was delivered\&.
6779 If you want to silently delete it then try:
6790 .BB lightgray adjust-for-leading-newline
6793 \FCmessage command = rm %s\F[]
6794 .EB lightgray adjust-for-leading-newline
6806 \fI\fImessage command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
6809 \fI\fImessage command\fR\fR\fI = \fR\fI\FCcsh \-c \'xedit %s; rm %s\' &\F[]\fR\fI \fR
6816 This sets the minimum amount of free disk space that must be available before a user will be able to spool a print job\&. It is specified in kilobytes\&. The default is 0, which means a user can always spool a print job\&.
6819 \fI\fImin print space\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6822 \fI\fImin print space\fR\fR\fI = \fR\fI\FC2000\F[]\fR\fI \fR
6829 The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support\&. Please refer to the
6830 \m[blue]\fBmax protocol\fR\m[]
6831 parameter for a list of valid protocol names and a brief description of each\&. You may also wish to refer to the C source code in
6832 \FCsource/smbd/negprot\&.c\F[]
6833 for a listing of known protocol dialects supported by clients\&.
6835 If you are viewing this parameter as a security measure, you should also refer to the
6836 \m[blue]\fBlanman auth\fR\m[]
6837 parameter\&. Otherwise, you should never need to change this parameter\&.
6840 \fI\fImin protocol\fR\fR\fI = \fR\fI\FCCORE\F[]\fR\fI \fR
6843 \fI\fImin protocol\fR\fR\fI = \fR\fI\FCNT1\F[]\fR\fI \fR
6846 min receivefile size (G)
6847 .\" min receivefile size
6850 This option changes the behavior of
6852 when processing SMBwriteX calls\&. Any incoming SMBwriteX call on a non\-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will be passed to any underlying kernel recvfile or splice system call (if there is no such call Samba will emulate in user space)\&. This allows zero\-copy writes directly from network socket buffers into the filesystem buffer cache, if available\&. It may improve performance but user testing is recommended\&. If set to zero Samba processes SMBwriteX calls in the normal way\&. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be nonzero\&. The maximum value is 128k\&. Values greater than 128k will be silently set to 128k\&.
6854 Note this option will have NO EFFECT if set on a SMB signed connection\&.
6856 The default is zero, which diables this option\&.
6859 \fI\fImin receivefile size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6868 when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the minimum \'time to live\' of NetBIOS names that
6870 will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 hours (21600 seconds)\&.
6873 \fI\fImin wins ttl\fR\fR\fI = \fR\fI\FC21600\F[]\fR\fI \fR
6880 This parameter indicates that the share is a stand\-in for another CIFS share whose location is specified by the value of the parameter\&. When clients attempt to connect to this share, they are redirected to the proxied share using the SMB\-Dfs protocol\&.
6882 Only Dfs roots can act as proxy shares\&. Take a look at the
6883 \m[blue]\fBmsdfs root\fR\m[]
6885 \m[blue]\fBhost msdfs\fR\m[]
6886 options to find out how to set up a Dfs root share\&.
6891 \fI\fImsdfs proxy\fR\fR\fI = \fR\fI\FC\eotherserver\esomeshare\F[]\fR\fI \fR
6899 \fByes\fR, Samba treats the share as a Dfs root and allows clients to browse the distributed file system tree rooted at the share directory\&. Dfs links are specified in the share directory by symbolic links of the form
6900 \FCmsdfs:serverA\e\eshareA,serverB\e\eshareB\F[]
6901 and so on\&. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\&.
6904 \fI\fImsdfs root\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
6907 name cache timeout (G)
6908 .\" name cache timeout
6911 Specifies the number of seconds it takes before entries in samba\'s hostname resolve cache time out\&. If the timeout is set to 0\&. the caching is disabled\&.
6914 \fI\fIname cache timeout\fR\fR\fI = \fR\fI\FC660\F[]\fR\fI \fR
6917 \fI\fIname cache timeout\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6920 name resolve order (G)
6921 .\" name resolve order
6924 This option is used by the programs in the Samba suite to determine what naming services to use and in what order to resolve host names to IP addresses\&. Its main purpose to is to control how netbios name resolution is performed\&. The option takes a space separated string of name resolution options\&.
6926 The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows:
6930 \h'-04'\(bu\h'+03'\c
6938 : Lookup an IP address in the Samba lmhosts file\&. If the line in lmhosts has no name type attached to the NetBIOS name (see the manpage for lmhosts for details) then any name type matches for lookup\&.
6943 \h'-04'\(bu\h'+03'\c
6951 : Do a standard host name to IP address resolution, using the system
6952 \FC/etc/hosts \F[], NIS, or DNS lookups\&. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the
6953 \FC/etc/nsswitch\&.conf\F[]
6954 file\&. Note that this method is used only if the NetBIOS name type being queried is the 0x20 (server) name type or 0x1c (domain controllers)\&. The latter case is only useful for active directory domains and results in a DNS query for the SRV RR entry matching _ldap\&._tcp\&.domain\&.
6959 \h'-04'\(bu\h'+03'\c
6966 : Query a name with the IP address listed in the
6967 \m[blue]\fBWINSSERVER\fR\m[]
6968 parameter\&. If no WINS server has been specified this method will be ignored\&.
6973 \h'-04'\(bu\h'+03'\c
6980 : Do a broadcast on each of the known local interfaces listed in the
6981 \m[blue]\fBinterfaces\fR\m[]
6982 parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.
6985 The example below will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup\&.
6987 When Samba is functioning in ADS security mode (\FCsecurity = ads\F[]) it is advised to use following settings for
6988 \fIname resolve order\fR:
6990 \FCname resolve order = wins bcast\F[]
6992 DC lookups will still be done via DNS, but fallbacks to netbios names will not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups\&.
6995 \fI\fIname resolve order\fR\fR\fI = \fR\fI\FClmhosts host wins bcast\F[]\fR\fI \fR
6998 \fI\fIname resolve order\fR\fR\fI = \fR\fI\FClmhosts bcast host\F[]\fR\fI \fR
7005 This is a list of NetBIOS names that nmbd will advertise as additional names by which the Samba server is known\&. This allows one machine to appear in browse lists under multiple names\&. If a machine is acting as a browse server or logon server none of these names will be advertised as either browse server or logon servers, only the primary name of the machine will be advertised with these capabilities\&.
7008 \fI\fInetbios aliases\fR\fR\fI = \fR\fI\FC # empty string (no additional names)\F[]\fR\fI \fR
7011 \fI\fInetbios aliases\fR\fR\fI = \fR\fI\FCTEST TEST1 TEST2\F[]\fR\fI \fR
7018 This sets the NetBIOS name by which a Samba server is known\&. By default it is the same as the first component of the host\'s DNS name\&. If a machine is a browse server or logon server this name (or the first component of the hosts DNS name) will be the name that these services are advertised under\&.
7020 There is a bug in Samba\-3 that breaks operation of browsing and access to shares if the netbios name is set to the literal name
7021 \FCPIPE\F[]\&. To avoid this problem, do not name your Samba\-3 server
7025 \fI\fInetbios name\fR\fR\fI = \fR\fI\FC # machine DNS name\F[]\fR\fI \fR
7028 \fI\fInetbios name\fR\fR\fI = \fR\fI\FCMYNAME\F[]\fR\fI \fR
7035 This sets the NetBIOS scope that Samba will operate under\&. This should not be set unless every machine on your LAN also sets this value\&.
7038 \fI\fInetbios scope\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7045 Get the home share server from a NIS map\&. For UNIX systems that use an automounter, the user\'s home directory will often be mounted on a workstation on demand from a remote server\&.
7047 When the Samba logon server is not the actual home directory server, but is mounting the home directories via NFS then two network hops would be required to access the users home directory if the logon server told the client to use itself as the SMB server for home directories (one over SMB and one over NFS)\&. This can be very slow\&.
7049 This option allows Samba to return the home share as being on a different server to the logon server and as long as a Samba daemon is running on the home directory server, it will be mounted on the Samba client directly from the directory server\&. When Samba is returning the home share to the client, it will consult the NIS map specified in
7050 \m[blue]\fBhomedir map\fR\m[]
7051 and return the server listed there\&.
7053 Note that for this option to work there must be a working NIS system and the Samba server with this option must also be a logon server\&.
7056 \fI\fInis homedir\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7063 This boolean parameter controls whether
7065 will attempt to map UNIX permissions into Windows NT access control lists\&. The UNIX permissions considered are the the traditional UNIX owner and group permissions, as well as POSIX ACLs set on any files or directories\&. This parameter was formally a global parameter in releases prior to 2\&.2\&.2\&.
7068 \fI\fInt acl support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7075 This parameter determines whether or not
7077 will attempt to authenticate users using the NTLM encrypted password response\&. If disabled, either the lanman password hash or an NTLMv2 response will need to be sent by the client\&.
7081 are both disabled, then only NTLMv2 logins will be permited\&. Not all clients support NTLMv2, and most will require special configuration to use it\&.
7084 \fI\fIntlm auth\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7091 This boolean parameter controls whether
7093 will allow Windows NT clients to connect to the NT SMB specific
7095 pipes\&. This is a developer debugging option and can be left alone\&.
7098 \fI\fInt pipe support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7101 nt status support (G)
7102 .\" nt status support
7105 This boolean parameter controls whether
7107 will negotiate NT specific status support with Windows NT/2k/XP clients\&. This is a developer debugging option and should be left alone\&. If this option is set to
7109 then Samba offers exactly the same DOS error codes that versions prior to Samba 2\&.2\&.3 reported\&.
7111 You should not need to ever disable this parameter\&.
7114 \fI\fInt status support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7121 Allow or disallow client access to accounts that have null passwords\&.
7124 \fBsmbpasswd\fR(5)\&.
7127 \fI\fInull passwords\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7130 obey pam restrictions (G)
7131 .\" obey pam restrictions
7134 When Samba 3\&.0 is configured to enable PAM support (i\&.e\&. \-\-with\-pam), this parameter will control whether or not Samba should obey PAM\'s account and session management directives\&. The default behavior is to use PAM for clear text authentication only and to ignore any account or session management\&. Note that Samba always ignores PAM for authentication in the case of
7135 \m[blue]\fBencrypt passwords = yes\fR\m[]\&. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption\&.
7138 \fI\fIobey pam restrictions\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7145 This is a boolean option that controls whether connections with usernames not in the
7147 list will be allowed\&. By default this option is disabled so that a client can supply a username to be used by the server\&. Enabling this parameter will force the server to only use the login names from the
7149 list and is only really useful in
7150 \m[blue]\fBsecurity = share\fR\m[]
7153 Note that this also means Samba won\'t try to deduce usernames from the service name\&. This can be annoying for the [homes] section\&. To get around this you could use
7157 list will be just the service name, which for home directories is the name of the user\&.
7160 \fI\fIonly user\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7163 oplock break wait time (G)
7164 .\" oplock break wait time
7167 This is a tuning parameter added due to bugs in both Windows 9x and WinNT\&. If Samba responds to a client too quickly when that client issues an SMB that can cause an oplock break request, then the network client can fail and not respond to the break request\&. This tuning parameter (which is set in milliseconds) is the amount of time Samba will wait before sending an oplock break request to such (broken) clients\&.
7174 .nr an-no-space-flag 1
7181 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
7186 \fI\fIoplock break wait time\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
7189 oplock contention limit (S)
7190 .\" oplock contention limit
7197 tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file\&.
7199 In brief it specifies a number, which causes
7200 \fBsmbd\fR(8)not to grant an oplock even when requested if the approximate number of clients contending for an oplock on the same file goes over this limit\&. This causes
7202 to behave in a similar way to Windows NT\&.
7209 .nr an-no-space-flag 1
7216 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
7221 \fI\fIoplock contention limit\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
7228 This boolean option tells
7230 whether to issue oplocks (opportunistic locks) to file open requests on this share\&. The oplock code can dramatically (approx\&. 30% or more) improve the speed of access to files on Samba servers\&. It allows the clients to aggressively cache files locally and you may want to disable this option for unreliable network environments (it is turned on by default in Windows NT Servers)\&. For more information see the file
7236 Oplocks may be selectively turned off on certain files with a share\&. See the
7237 \m[blue]\fBveto oplock files\fR\m[]
7238 parameter\&. On some systems oplocks are recognized by the underlying operating system\&. This allows data synchronization between all access to oplocked files, whether it be via Samba or NFS or a local UNIX process\&. See the
7239 \m[blue]\fBkernel oplocks\fR\m[]
7240 parameter for details\&.
7243 \fI\fIoplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7250 The parameter is used to define the absolute path to a file containing a mapping of Windows NT printer driver names to OS/2 printer driver names\&. The format is:
7252 <nt driver name> = <os2 driver name>\&.<device name>
7254 For example, a valid entry using the HP LaserJet 5 printer driver would appear as
7255 \FCHP LaserJet 5L = LASERJET\&.HP LaserJet 5L\F[]\&.
7257 The need for the file is due to the printer driver namespace problem described in the chapter on Classical Printing in the Samba3\-HOWTO book\&. For more details on OS/2 clients, please refer to chapter on other clients in the Samba3\-HOWTO book\&.
7260 \fI\fIos2 driver map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7267 This integer value controls what level Samba advertises itself as for browse elections\&. The value of this parameter determines whether
7269 has a chance of becoming a local master browser for the
7270 \m[blue]\fBworkgroup\fR\m[]
7271 in the local broadcast area\&.
7274 By default, Samba will win a local master browsing election over all Microsoft operating systems except a Windows NT 4\&.0/2000 Domain Controller\&. This means that a misconfigured Samba host can effectively isolate a subnet for browsing purposes\&. This parameter is largely auto\-configured in the Samba\-3 release series and it is seldom necessary to manually override the default setting\&. Please refer to the chapter on Network Browsing in the Samba\-3 HOWTO document for further information regarding the use of this parameter\&.
7276 The maximum value for this parameter is 255\&. If you use higher values, counting will start at 0!
7279 \fI\fIos level\fR\fR\fI = \fR\fI\FC20\F[]\fR\fI \fR
7282 \fI\fIos level\fR\fR\fI = \fR\fI\FC65\F[]\fR\fI \fR
7285 pam password change (G)
7286 .\" pam password change
7289 With the addition of better PAM support in Samba 2\&.2, this parameter, it is possible to use PAM\'s password change control flag for Samba\&. If enabled, then PAM will be used for password changes when requested by an SMB client instead of the program listed in
7290 \m[blue]\fBpasswd program\fR\m[]\&. It should be possible to enable this without changing your
7291 \m[blue]\fBpasswd chat\fR\m[]
7292 parameter for most setups\&.
7295 \fI\fIpam password change\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7302 This is a Samba developer option that allows a system command to be called when either
7306 crashes\&. This is usually used to draw attention to the fact that a problem occurred\&.
7309 \fI\fIpanic action\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7312 \fI\fIpanic action\fR\fR\fI = \fR\fI\FC"/bin/sleep 90000"\F[]\fR\fI \fR
7315 paranoid server security (G)
7316 .\" paranoid server security
7319 Some version of NT 4\&.x allow non\-guest users with a bad passowrd\&. When this option is enabled, samba will not use a broken NT 4\&.x server as password server, but instead complain to the logs and exit\&.
7321 Disabling this option prevents Samba from making this check, which involves deliberatly attempting a bad logon to the remote server\&.
7324 \fI\fIparanoid server security\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7331 This option allows the administrator to chose which backend will be used for storing user and possibly group information\&. This allows you to swap between different storage mechanisms without recompile\&.
7333 The parameter value is divided into two parts, the backend\'s name, and a \'location\' string that has meaning only to that particular backed\&. These are separated by a : character\&.
7335 Available backends can include:
7339 \h'-04'\(bu\h'+03'\c
7346 \- The old plaintext passdb backend\&. Some Samba features will not work if this passdb backend is used\&. Takes a path to the smbpasswd file as an optional argument\&.
7351 \h'-04'\(bu\h'+03'\c
7358 \- The TDB based password storage backend\&. Takes a path to the TDB as an optional argument (defaults to passdb\&.tdb in the
7359 \m[blue]\fBprivate dir\fR\m[]
7365 \h'-04'\(bu\h'+03'\c
7372 \- The LDAP based passdb backend\&. Takes an LDAP URL as an optional argument (defaults to
7373 \FCldap://localhost\F[])
7375 LDAP connections should be secured where possible\&. This may be done using either Start\-TLS (see
7376 \m[blue]\fBldap ssl\fR\m[]) or by specifying
7378 in the URL argument\&.
7380 Multiple servers may also be specified in double\-quotes\&. Whether multiple servers are supported or not and the exact syntax depends on the LDAP library you use\&.
7384 Examples of use are:
7395 .BB lightgray adjust-for-leading-newline
7398 passdb backend = tdbsam:/etc/samba/private/passdb\&.tdb
7400 or multi server LDAP URL with OpenLDAP library:
7402 passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap://ldap\-2\&.example\&.com"
7404 or multi server LDAP URL with Netscape based LDAP library:
7406 passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap\-2\&.example\&.com"
7407 .EB lightgray adjust-for-leading-newline
7419 \fI\fIpassdb backend\fR\fR\fI = \fR\fI\FCtdbsam\F[]\fR\fI \fR
7422 passdb expand explicit (G)
7423 .\" passdb expand explicit
7426 This parameter controls whether Samba substitutes %\-macros in the passdb fields if they are explicitly set\&. We used to expand macros here, but this turned out to be a bug because the Windows client can expand a variable %G_osver% in which %G would have been substituted by the user\'s primary group\&.
7429 \fI\fIpassdb expand explicit\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7432 passwd chat debug (G)
7433 .\" passwd chat debug
7436 This boolean specifies if the passwd chat script parameter is run in
7438 mode\&. In this mode the strings passed to and received from the passwd chat are printed in the
7441 \m[blue]\fBdebug level\fR\m[]
7442 of 100\&. This is a dangerous option as it will allow plaintext passwords to be seen in the
7444 log\&. It is available to help Samba admins debug their
7446 scripts when calling the
7447 \fIpasswd program\fR
7448 and should be turned off after this has been done\&. This option has no effect if the
7449 \m[blue]\fBpam password change\fR\m[]
7450 parameter is set\&. This parameter is off by default\&.
7453 \fI\fIpasswd chat debug\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7456 passwd chat timeout (G)
7457 .\" passwd chat timeout
7460 This integer specifies the number of seconds smbd will wait for an initial answer from a passwd chat script being run\&. Once the initial answer is received the subsequent answers must be received in one tenth of this time\&. The default it two seconds\&.
7463 \fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
7470 This string controls the
7472 conversation that takes places between
7474 and the local password changing program to change the user\'s password\&. The string describes a sequence of response\-receive pairs that
7476 uses to determine what to send to the
7477 \m[blue]\fBpasswd program\fR\m[]
7478 and what to expect back\&. If the expected output is not received then the password is not changed\&.
7480 This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc)\&.
7482 Note that this parameter only is used if the
7483 \m[blue]\fBunix password sync\fR\m[]
7485 \fByes\fR\&. This sequence is then called
7487 when the SMB password in the smbpasswd file is being changed, without access to the old password cleartext\&. This means that root must be able to reset the user\'s password without knowing the text of the previous password\&. In the presence of NIS/YP, this means that the
7488 \m[blue]\fBpasswd program\fR\m[]
7489 must be executed on the NIS master\&.
7491 The string can contain the macro
7493 which is substituted for the new password\&. The old passsword (\fI%o\fR) is only available when
7494 \m[blue]\fBencrypt passwords\fR\m[]
7495 has been disabled\&. The chat sequence can also contain the standard macros \en, \er, \et and \es to give line\-feed, carriage\-return, tab and space\&. The chat sequence string can also contain a \'*\' which matches any sequence of characters\&. Double quotes can be used to collect strings with spaces in them into a single string\&.
7497 If the send string in any part of the chat sequence is a full stop "\&.", then no string is sent\&. Similarly, if the expect string is a full stop then no string is expected\&.
7500 \m[blue]\fBpam password change\fR\m[]
7502 \fByes\fR, the chat pairs may be matched in any order, and success is determined by the PAM result, not any particular output\&. The \en macro is ignored for PAM conversions\&.
7505 \fI\fIpasswd chat\fR\fR\fI = \fR\fI\FC*new*password* %n\en*new*password* %n\en *changed*\F[]\fR\fI \fR
7508 \fI\fIpasswd chat\fR\fR\fI = \fR\fI\FC"*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"\F[]\fR\fI \fR
7515 The name of a program that can be used to set UNIX user passwords\&. Any occurrences of
7517 will be replaced with the user name\&. The user name is checked for existence before calling the password changing program\&.
7519 Also note that many passwd programs insist in
7521 passwords, such as a minimum length, or the inclusion of mixed case chars and digits\&. This can pose a problem as some clients (such as Windows for Workgroups) uppercase the password before sending it\&.
7525 \fIunix password sync\fR
7528 then this program is called
7530 before the SMB password in the smbpasswd file is changed\&. If this UNIX password change fails, then
7532 will fail to change the SMB password also (this is by design)\&.
7535 \fIunix password sync\fR
7536 parameter is set this parameter
7537 \fIMUST USE ABSOLUTE PATHS\fR
7540 programs called, and must be examined for security implications\&. Note that by default
7541 \fIunix password sync\fR
7546 \fI\fIpasswd program\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7549 \fI\fIpasswd program\fR\fR\fI = \fR\fI\FC/bin/passwd %u\F[]\fR\fI \fR
7556 Some client/server combinations have difficulty with mixed\-case passwords\&. One offending client is Windows for Workgroups, which for some reason forces passwords to upper case when using the LANMAN1 protocol, but leaves them alone when using COREPLUS! Another problem child is the Windows 95/98 family of operating systems\&. These clients upper case clear text passwords even when NT LM 0\&.12 selected by the protocol negotiation request/response\&.
7558 This parameter defines the maximum number of characters that may be upper case in passwords\&.
7560 For example, say the password given was "FRED"\&. If
7561 \fI password level\fR
7562 is set to 1, the following combinations would be tried if "FRED" failed:
7564 "Fred", "fred", "fRed", "frEd","freD"
7567 \fIpassword level\fR
7568 was set to 2, the following combinations would also be tried:
7570 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", \&.\&.
7574 The higher value this parameter is set to the more likely it is that a mixed case password will be matched against a single case password\&. However, you should be aware that use of this parameter reduces security and increases the time taken to process a new connection\&.
7576 A value of zero will cause only two attempts to be made \- the password as is and the password in all\-lower case\&.
7578 This parameter is used only when using plain\-text passwords\&. It is not at all used when encrypted passwords as in use (that is the default since samba\-3\&.0\&.0)\&. Use this only when
7579 \m[blue]\fBencrypt passwords = No\fR\m[]\&.
7582 \fI\fIpassword level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
7585 \fI\fIpassword level\fR\fR\fI = \fR\fI\FC4\F[]\fR\fI \fR
7592 By specifying the name of another SMB server or Active Directory domain controller with this option, and using
7593 \FCsecurity = [ads|domain|server]\F[]
7594 it is possible to get Samba to do all its username/password validation using a specific remote server\&.
7596 This option sets the name or IP address of the password server to use\&. New syntax has been added to support defining the port to use when connecting to the server the case of an ADS realm\&. To define a port other than the default LDAP port of 389, add the port number using a colon after the name or IP address (e\&.g\&. 192\&.168\&.1\&.100:389)\&. If you do not specify a port, Samba will use the standard LDAP port of tcp/389\&. Note that port numbers have no effect on password servers for Windows NT 4\&.0 domains or netbios connections\&.
7598 If parameter is a name, it is looked up using the parameter
7599 \m[blue]\fBname resolve order\fR\m[]
7600 and so may resolved by any method and order described in that parameter\&.
7602 The password server must be a machine capable of using the "LM1\&.2X002" or the "NT LM 0\&.12" protocol, and it must be in user level security mode\&.
7609 .nr an-no-space-flag 1
7616 Using a password server means your UNIX box (running Samba) is only as secure as your password server\&.
7617 \fIDO NOT CHOOSE A PASSWORD SERVER THAT YOU DON\'T COMPLETELY TRUST\fR\&.
7621 Never point a Samba server at itself for password serving\&. This will cause a loop and could lock up your Samba server!
7623 The name of the password server takes the standard substitutions, but probably the only useful one is
7624 \fI%m \fR, which means the Samba server will use the incoming client as the password server\&. If you use this then you better trust your clients, and you had better restrict them with hosts allow!
7631 \fBads\fR, then the list of machines in this option must be a list of Primary or Backup Domain controllers for the Domain or the character \'*\', as the Samba server is effectively in that domain, and will use cryptographically authenticated RPC calls to authenticate the user logging on\&. The advantage of using
7632 \FC security = domain\F[]
7633 is that if you list several hosts in the
7634 \fIpassword server\fR
7637 will try each in turn till it finds one that responds\&. This is useful in case your primary server goes down\&.
7640 \fIpassword server\fR
7641 option is set to the character \'*\', then Samba will attempt to auto\-locate the Primary or Backup Domain controllers to authenticate against by doing a query for the name
7643 and then contacting each server returned in the list of IP addresses from the name resolution source\&.
7645 If the list of servers contains both names/IP\'s and the \'*\' character, the list is treated as a list of preferred domain controllers, but an auto lookup of all remaining DC\'s will be added to the list as well\&. Samba will not attempt to optimize this list by locating the closest DC\&.
7650 \fBserver\fR, then there are different restrictions that
7651 \FCsecurity = domain\F[]
7652 doesn\'t suffer from:
7656 \h'-04'\(bu\h'+03'\c
7662 You may list several password servers in the
7663 \fIpassword server\fR
7664 parameter, however if an
7666 makes a connection to a password server, and then the password server fails, no more users will be able to be authenticated from this
7667 \FCsmbd\F[]\&. This is a restriction of the SMB/CIFS protocol when in
7668 \FCsecurity = server \F[]
7669 mode and cannot be fixed in Samba\&.
7674 \h'-04'\(bu\h'+03'\c
7680 If you are using a Windows NT server as your password server then you will have to ensure that your users are able to login from the Samba server, as when in
7681 \FC security = server\F[]
7682 mode the network logon will appear to come from there rather than from the users workstation\&.
7686 \fI\fIpassword server\fR\fR\fI = \fR\fI\FC*\F[]\fR\fI \fR
7689 \fI\fIpassword server\fR\fR\fI = \fR\fI\FCNT\-PDC, NT\-BDC1, NT\-BDC2, *\F[]\fR\fI \fR
7692 \fI\fIpassword server\fR\fR\fI = \fR\fI\FCwindc\&.mydomain\&.com:389 192\&.168\&.1\&.101 *\F[]\fR\fI \fR
7699 This parameter is a synonym for
7707 This parameter specifies a directory to which the user of the service is to be given access\&. In the case of printable services, this is where print data will spool prior to being submitted to the host for printing\&.
7709 For a printable service offering guest access, the service should be readonly and the path should be world\-writeable and have the sticky bit set\&. This is not mandatory of course, but you probably won\'t get the results you expect if you do otherwise\&.
7713 in the path will be replaced with the UNIX username that the client is using on this connection\&. Any occurrences of
7715 will be replaced by the NetBIOS name of the machine they are connecting from\&. These replacements are very useful for setting up pseudo home directories for users\&.
7717 Note that this path will be based on
7718 \m[blue]\fBroot dir\fR\m[]
7719 if one was specified\&.
7722 \fI\fIpath\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7725 \fI\fIpath\fR\fR\fI = \fR\fI\FC/home/fred\F[]\fR\fI \fR
7728 perfcount module (G)
7729 .\" perfcount module
7732 This parameter specifies the perfcount backend to be used when monitoring SMB operations\&. Only one perfcount module may be used, and it must implement all of the apis contained in the smb_perfcount_handler structure defined in smb\&.h\&.
7741 This option specifies the directory where pid files will be placed\&.
7744 \fI\fIpid directory\fR\fR\fI = \fR\fI\FC${prefix}/var/locks\F[]\fR\fI \fR
7747 \fI\fIpid directory\fR\fR\fI = \fR\fI\FCpid directory = /var/run/\F[]\fR\fI \fR
7756 daemon maintains an database of file locks obtained by SMB clients\&. The default behavior is to map this internal database to POSIX locks\&. This means that file locks obtained by SMB clients are consistent with those seen by POSIX compliant applications accessing the files via a non\-SMB method (e\&.g\&. NFS or local file access)\&. You should never need to disable this parameter\&.
7759 \fI\fIposix locking\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7766 This option specifies a command to be run whenever the service is disconnected\&. It takes the usual substitutions\&. The command may be run as the root on some systems\&.
7768 An interesting example may be to unmount server resources:
7770 \FCpostexec = /etc/umount /cdrom\F[]
7773 \fI\fIpostexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7776 \fI\fIpostexec\fR\fR\fI = \fR\fI\FCecho \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log\F[]\fR\fI \fR
7783 This boolean option controls whether a non\-zero return code from
7784 \m[blue]\fBpreexec\fR\m[]
7785 should close the service being connected to\&.
7788 \fI\fIpreexec close\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7795 This parameter is a synonym for
7803 This option specifies a command to be run whenever the service is connected to\&. It takes the usual substitutions\&.
7805 An interesting example is to send the users a welcome message every time they log in\&. Maybe a message of the day? Here is an example:
7808 \FCpreexec = csh \-c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient \-M %m \-I %I\' & \F[]
7810 Of course, this could get annoying after a while :\-)
7813 \m[blue]\fBpreexec close\fR\m[]
7815 \m[blue]\fBpostexec\fR\m[]\&.
7818 \fI\fIpreexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7821 \fI\fIpreexec\fR\fR\fI = \fR\fI\FCecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\F[]\fR\fI \fR
7828 This parameter is a synonym for
7832 preferred master (G)
7833 .\" preferred master
7836 This boolean parameter controls if
7838 is a preferred master browser for its workgroup\&.
7841 \fByes\fR, on startup,
7843 will force an election, and it will have a slight advantage in winning the election\&. It is recommended that this parameter is used in conjunction with
7844 \m[blue]\fBdomain master = yes\fR\m[], so that
7846 can guarantee becoming a domain master\&.
7848 Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT) that are preferred master browsers on the same subnet, they will each periodically and continuously attempt to become the local master browser\&. This will result in unnecessary broadcast traffic and reduced browsing capabilities\&.
7851 \fI\fIpreferred master\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
7858 This is a list of paths to modules that should be loaded into smbd before a client connects\&. This improves the speed of smbd when reacting to new connections somewhat\&.
7861 \fI\fIpreload modules\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7864 \fI\fIpreload modules\fR\fR\fI = \fR\fI\FC/usr/lib/samba/passdb/mysql\&.so\F[]\fR\fI \fR
7871 This parameter is a synonym for
7879 This is a list of services that you want to be automatically added to the browse lists\&. This is most useful for homes and printers services that would otherwise not be visible\&.
7881 Note that if you just want all printers in your printcap file loaded then the
7882 \m[blue]\fBload printers\fR\m[]
7886 \fI\fIpreload\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7889 \fI\fIpreload\fR\fR\fI = \fR\fI\FCfred lp colorlp\F[]\fR\fI \fR
7896 This controls if new filenames are created with the case that the client passes, or if they are forced to be the
7897 \m[blue]\fBdefault case\fR\m[]\&.
7901 for a fuller discussion\&.
7904 \fI\fIpreserve case\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7911 This parameter is a synonym for
7919 If this parameter is
7920 \fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\&.
7922 Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\&. The
7923 \m[blue]\fBread only\fR\m[]
7924 parameter controls only non\-printing access to the resource\&.
7927 \fI\fIprintable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7930 printcap cache time (G)
7931 .\" printcap cache time
7934 This option specifies the number of seconds before the printing subsystem is again asked for the known printers\&. If the value is greater than 60 the initial waiting time is set to 60 seconds to allow an earlier first rescan of the printing subsystem\&.
7936 Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\&.
7939 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI\FC750\F[]\fR\fI \fR
7942 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI\FC600\F[]\fR\fI \fR
7949 This parameter is a synonym for
7957 This parameter may be used to override the compiled\-in default printcap name used by the server (usually
7958 \FC /etc/printcap\F[])\&. See the discussion of the
7960 section above for reasons why you might want to do this\&.
7962 To use the CUPS printing interface set
7963 \FCprintcap name = cups \F[]\&. This should be supplemented by an addtional setting
7964 \m[blue]\fBprinting = cups\fR\m[]
7965 in the [global] section\&.
7966 \FCprintcap name = cups\F[]
7967 will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\&.
7969 On System V systems that use
7971 to list available printers you can use
7972 \FCprintcap name = lpstat \F[]
7973 to automatically obtain lists of available printers\&. This is the default for systems that define SYSV at configure time in Samba (this includes most System V based systems)\&. If
7974 \fI printcap name\fR
7977 on these systems then Samba will launch
7979 and attempt to parse the output to obtain a printer list\&.
7981 A minimal printcap file would look something like this:
7992 .BB lightgray adjust-for-leading-newline
8000 .EB lightgray adjust-for-leading-newline
8011 where the \'|\' separates aliases of a printer\&. The fact that the second alias has a space in it gives a hint to Samba that it\'s a comment\&.
8018 .nr an-no-space-flag 1
8025 Under AIX the default printcap name is
8026 \FC/etc/qconfig\F[]\&. Samba will assume the file is in AIX
8028 format if the string
8030 appears in the printcap filename\&.
8035 \fI\fIprintcap name\fR\fR\fI = \fR\fI\FC/etc/printcap\F[]\fR\fI \fR
8038 \fI\fIprintcap name\fR\fR\fI = \fR\fI\FC/etc/myprintcap\F[]\fR\fI \fR
8045 After a print job has finished spooling to a service, this command will be used via a
8047 call to process the spool file\&. Typically the command specified will submit the spool file to the host\'s printing subsystem, but there is no requirement that this be the case\&. The server will not remove the spool file, so whatever command you specify should remove the spool file when it has been processed, otherwise you will need to manually remove old spool files\&.
8049 The print command is simply a text string\&. It will be used verbatim after macro substitutions have been made:
8051 %s, %f \- the path to the spool file name
8053 %p \- the appropriate printer name
8055 %J \- the job name as transmitted by the client\&.
8057 %c \- The number of printed pages of the spooled job (if known)\&.
8059 %z \- the size of the spooled print job (in bytes)
8063 contain at least one occurrence of
8069 is optional\&. At the time a job is submitted, if no printer name is supplied the
8071 will be silently removed from the printer command\&.
8073 If specified in the [global] section, the print command given will be used for any printable service that does not have its own print command specified\&.
8075 If there is neither a specified print command for a printable service nor a global print command, spool files will be created but not processed and (most importantly) not removed\&.
8077 Note that printing may fail on some UNIXes from the
8079 account\&. If this happens then create an alternative guest account that can print and set the
8080 \m[blue]\fBguest account\fR\m[]
8081 in the [global] section\&.
8083 You can form quite complex print commands by realizing that they are just passed to a shell\&. For example the following will log a print job, print the file, then remove it\&. Note that \';\' is the usual separator for command in shell scripts\&.
8085 \FCprint command = echo Printing %s >> /tmp/print\&.log; lpr \-P %p %s; rm %s\F[]
8087 You may have to vary this command considerably depending on how you normally print files on your system\&. The default for the parameter varies depending on the setting of the
8088 \m[blue]\fBprinting\fR\m[]
8092 \FCprinting = BSD, AIX, QNX, LPRNG or PLP :\F[]
8094 \FCprint command = lpr \-r \-P%p %s\F[]
8097 \FCprinting = SYSV or HPUX :\F[]
8099 \FCprint command = lp \-c \-d%p %s; rm %s\F[]
8102 \FCprinting = SOFTQ :\F[]
8104 \FCprint command = lp \-d%p \-s %s; rm %s\F[]
8106 For printing = CUPS : If SAMBA is compiled against libcups, then
8107 \m[blue]\fBprintcap = cups\fR\m[]
8108 uses the CUPS API to submit jobs, etc\&. Otherwise it maps to the System V commands with the \-oraw option for printing, i\&.e\&. it uses
8109 \FClp \-c \-d%p \-oraw; rm %s\F[]\&. With
8110 \FCprinting = cups\F[], and if SAMBA is compiled against libcups, any manually set print command will be ignored\&.
8115 \fI\fIprint command\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/myprintscript %p %s\F[]\fR\fI \fR
8122 This lists users who can do anything to printers via the remote administration interfaces offered by MS\-RPC (usually using a NT workstation)\&. This parameter can be set per\-share or globally\&. Note: The root user always has admin rights\&. Use caution with use in the global stanza as this can cause side effects\&.
8124 This parameter has been marked deprecated in favor of using the SePrintOperatorPrivilege and individual print security descriptors\&. It will be removed in a future release\&.
8127 \fI\fIprinter admin\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8130 \fI\fIprinter admin\fR\fR\fI = \fR\fI\FCadmin, @staff\F[]\fR\fI \fR
8137 This parameter is a synonym for
8145 This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\&.
8147 If specified in the [global] section, the printer name given will be used for any printable service that does not have its own printer name specified\&.
8149 The default value of the
8150 \m[blue]\fBprinter name\fR\m[]
8156 \fI\fIprinter name\fR\fR\fI = \fR\fI\FCnone\F[]\fR\fI \fR
8159 \fI\fIprinter name\fR\fR\fI = \fR\fI\FClaserwriter\F[]\fR\fI \fR
8166 This parameters controls how printer status information is interpreted on your system\&. It also affects the default values for the
8167 \fIprint command\fR,
8169 \fIlppause command \fR,
8170 \fIlpresume command\fR, and
8172 if specified in the [global] section\&.
8174 Currently nine printing styles are supported\&. They are
8185 To see what the defaults are for the other print commands when using the various options use the
8189 This option can be set on a per printer basis\&. Please be aware however, that you must place any of the various printing commands (e\&.g\&. print command, lpq command, etc\&.\&.\&.) after defining the value for the
8191 option since it will reset the printing commands to default values\&.
8193 See also the discussion in the
8198 \fI\fIprinting\fR\fR\fI = \fR\fI\FCDepends on the operating system, see \FCtestparm \-v\&.\F[]\F[]\fR\fI \fR
8201 printjob username (S)
8202 .\" printjob username
8205 This parameter specifies which user information will be passed to the printing system\&. Usually, the username is sent, but in some cases, e\&.g\&. the domain prefix is useful, too\&.
8208 \fI\fIprintjob username\fR\fR\fI = \fR\fI\FC%U\F[]\fR\fI \fR
8211 \fI\fIprintjob username\fR\fR\fI = \fR\fI\FC%D\e%U\F[]\fR\fI \fR
8218 This parameters defines the directory smbd will use for storing such files as
8221 \FCsecrets\&.tdb\F[]\&.
8224 \fI\fIprivate dir\fR\fR\fI = \fR\fI\FC${prefix}/private\F[]\fR\fI \fR
8231 This boolean parameter was added to fix the problems that people have been having with storing user profiles on Samba shares from Windows 2000 or Windows XP clients\&. New versions of Windows 2000 or Windows XP service packs do security ACL checking on the owner and ability to write of the profile directory stored on a local workstation when copied from a Samba share\&.
8233 When not in domain mode with winbindd then the security info copied onto the local workstation has no meaning to the logged in user (SID) on that workstation so the profile storing fails\&. Adding this parameter onto a share used for profile storage changes two things about the returned Windows ACL\&. Firstly it changes the owner and group owner of all reported files and directories to be BUILTIN\e\eAdministrators, BUILTIN\e\eUsers respectively (SIDs S\-1\-5\-32\-544, S\-1\-5\-32\-545)\&. Secondly it adds an ACE entry of "Full Control" to the SID BUILTIN\e\eUsers to every returned ACL\&. This will allow any Windows 2000 or XP workstation user to access the profile\&.
8235 Note that if you have multiple users logging on to a workstation then in order to prevent them from being able to access each others profiles you must remove the "Bypass traverse checking" advanced user right\&. This will prevent access to other users profile directories as the top level profile directory (named after the user) is created by the workstation profile code and has an ACL restricting entry to the directory tree to the owning user\&.
8238 \fI\fIprofile acls\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
8241 queuepause command (S)
8242 .\" queuepause command
8245 This parameter specifies the command to be executed on the server host in order to pause the printer queue\&.
8247 This command should be a program or script which takes a printer name as its only parameter and stops the printer queue, such that no longer jobs are submitted to the printer\&.
8249 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
8253 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
8255 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
8260 \fI\fIqueuepause command\fR\fR\fI = \fR\fI\FCdisable %p\F[]\fR\fI \fR
8263 queueresume command (S)
8264 .\" queueresume command
8267 This parameter specifies the command to be executed on the server host in order to resume the printer queue\&. It is the command to undo the behavior that is caused by the previous parameter (\m[blue]\fBqueuepause command\fR\m[])\&.
8269 This command should be a program or script which takes a printer name as its only parameter and resumes the printer queue, such that queued jobs are resubmitted to the printer\&.
8271 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
8275 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
8277 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
8280 \fI\fIqueueresume command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8283 \fI\fIqueueresume command\fR\fR\fI = \fR\fI\FCenable %p\F[]\fR\fI \fR
8290 This is a list of users that are given read\-only access to a service\&. If the connecting user is in this list then they will not be given write access, no matter what the
8291 \m[blue]\fBread only\fR\m[]
8292 option is set to\&. The list can include group names using the syntax described in the
8293 \m[blue]\fBinvalid users\fR\m[]
8296 This parameter will not work with the
8297 \m[blue]\fBsecurity = share\fR\m[]
8298 in Samba 3\&.0\&. This is by design\&.
8301 \fI\fIread list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8304 \fI\fIread list\fR\fR\fI = \fR\fI\FCmary, @students\F[]\fR\fI \fR
8311 An inverted synonym is
8312 \m[blue]\fBwriteable\fR\m[]\&.
8314 If this parameter is
8315 \fByes\fR, then users of a service may not create or modify files in the service\'s directory\&.
8317 Note that a printable service (\FCprintable = yes\F[]) will
8319 allow writing to the directory (user privileges permitting), but only via spooling operations\&.
8322 \fI\fIread only\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
8329 This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients\&.
8331 If enabled, raw reads allow reads of 65535 bytes in one packet\&. This typically provides a major performance benefit\&.
8333 However, some clients either negotiate the allowable block size incorrectly or are incapable of supporting larger block sizes, and for these clients you may need to disable raw reads\&.
8335 In general this parameter should be viewed as a system tuning tool and left severely alone\&.
8338 \fI\fIread raw\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
8345 This option specifies the kerberos realm to use\&. The realm is used as the ADS equivalent of the NT4
8346 \FCdomain\F[]\&. It is usually set to the DNS name of the kerberos server\&.
8349 \fI\fIrealm\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8352 \fI\fIrealm\fR\fR\fI = \fR\fI\FCmysambabox\&.mycompany\&.com\F[]\fR\fI \fR
8359 This turns on or off support for share definitions read from registry\&. Shares defined in
8361 take precedence over shares with the same name defined in registry\&. See the section on registry\-based configuration for details\&.
8363 Note that this parameter defaults to
8364 \fIno\fR, but it is set to
8367 \fIconfig backend\fR
8372 \fI\fIregistry shares\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
8375 \fI\fIregistry shares\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
8382 This option allows you to setup
8384 to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name\&.
8386 This is useful if you want your Samba server to appear in a remote workgroup for which the normal browse propagation rules don\'t work\&. The remote workgroup can be anywhere that you can send IP packets to\&.
8399 .BB lightgray adjust-for-leading-newline
8402 \FCremote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\F[]
8403 .EB lightgray adjust-for-leading-newline
8414 the above line would cause
8416 to announce itself to the two given IP addresses using the given workgroup names\&. If you leave out the workgroup name, then the one given in the
8417 \m[blue]\fBworkgroup\fR\m[]
8418 parameter is used instead\&.
8420 The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable\&.
8422 See the chapter on Network Browsing in the Samba\-HOWTO book\&.
8425 \fI\fIremote announce\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8428 remote browse sync (G)
8429 .\" remote browse sync
8432 This option allows you to setup
8434 to periodically request synchronization of browse lists with the master browser of a Samba server that is on a remote segment\&. This option will allow you to gain browse lists for multiple workgroups across routed networks\&. This is done in a manner that does not work with any non\-Samba servers\&.
8436 This is useful if you want your Samba server and all local clients to appear in a remote workgroup for which the normal browse propagation rules don\'t work\&. The remote workgroup can be anywhere that you can send IP packets to\&.
8449 .BB lightgray adjust-for-leading-newline
8452 \fIremote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fR
8453 .EB lightgray adjust-for-leading-newline
8464 the above line would cause
8466 to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server\&.
8468 The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable\&. If a machine IP address is given Samba makes NO attempt to validate that the remote machine is available, is listening, nor that it is in fact the browse master on its segment\&.
8471 \m[blue]\fBremote browse sync\fR\m[]
8472 may be used on networks where there is no WINS server, and may be used on disjoint networks where each network has its own WINS server\&.
8475 \fI\fIremote browse sync\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8478 rename user script (G)
8479 .\" rename user script
8482 This is the full pathname to a script that will be run as root by
8484 under special circumstances described below\&.
8486 When a user with admin authority or SeAddUserPrivilege rights renames a user (e\&.g\&.: from the NT4 User Manager for Domains), this script will be run to rename the POSIX user\&. Two variables,
8489 \FC%unew\F[], will be substituted with the old and new usernames, respectively\&. The script should return 0 upon successful completion, and nonzero otherwise\&.
8496 .nr an-no-space-flag 1
8503 The script has all responsibility to rename all the necessary data that is accessible in this posix method\&. This can mean different requirements for different backends\&. The tdbsam and smbpasswd backends will take care of the contents of their respective files, so the script is responsible only for changing the POSIX username, and other data that may required for your circumstances, such as home directory\&. Please also consider whether or not you need to rename the actual home directories themselves\&. The ldapsam backend will not make any changes, because of the potential issues with renaming the LDAP naming attribute\&. In this case the script is responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that needs to change for other applications using the same directory\&.
8508 \fI\fIrename user script\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
8511 reset on zero vc (G)
8512 .\" reset on zero vc
8515 This boolean option controls whether an incoming session setup should kill other connections coming from the same IP\&. This matches the default Windows 2003 behaviour\&. Setting this parameter to yes becomes necessary when you have a flaky network and windows decides to reconnect while the old connection still has files with share modes open\&. These files become inaccessible over the new connection\&. The client sends a zero VC on the new connection, and Windows 2003 kills all other connections coming from the same IP\&. This way the locked files are accessible again\&. Please be aware that enabling this option will kill connections behind a masquerading router\&.
8518 \fI\fIreset on zero vc\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
8521 restrict anonymous (G)
8522 .\" restrict anonymous
8525 The setting of this parameter determines whether user and group list information is returned for an anonymous connection\&. and mirrors the effects of the
8536 .BB lightgray adjust-for-leading-newline
8539 HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\e
8540 Control\eLSA\eRestrictAnonymous
8541 .EB lightgray adjust-for-leading-newline
8552 registry key in Windows 2000 and Windows NT\&. When set to 0, user and group list information is returned to anyone who asks\&. When set to 1, only an authenticated user can retrive user and group list information\&. For the value 2, supported by Windows 2000/XP and Samba, no anonymous connections are allowed at all\&. This can break third party and Microsoft applications which expect to be allowed to perform operations anonymously\&.
8554 The security advantage of using restrict anonymous = 1 is dubious, as user and group list information can be obtained using other means\&.
8561 .nr an-no-space-flag 1
8568 The security advantage of using restrict anonymous = 2 is removed by setting
8569 \m[blue]\fBguest ok = yes\fR\m[]
8575 \fI\fIrestrict anonymous\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
8582 This parameter is a synonym for
8590 This parameter is a synonym for
8600 (i\&.e\&. Change its root directory) to this directory on startup\&. This is not strictly necessary for secure operation\&. Even without it the server will deny access to files not in one of the service entries\&. It may also check for, and deny access to, soft links to other parts of the filesystem, or attempts to use "\&.\&." in file names to access other directories (depending on the setting of the
8601 \m[blue]\fBwide smbconfoptions\fR\m[]
8605 \fIroot directory\fR
8606 entry other than "/" adds an extra level of security, but at a price\&. It absolutely ensures that no access is given to files not in the sub\-tree specified in the
8607 \fIroot directory\fR
8610 some files needed for complete operation of the server\&. To maintain full operability of the server you will need to mirror some system files into the
8611 \fIroot directory\fR
8612 tree\&. In particular you will need to mirror
8614 (or a subset of it), and any binaries or configuration files needed for printing (if required)\&. The set of files that must be mirrored is operating system dependent\&.
8617 \fI\fIroot directory\fR\fR\fI = \fR\fI\FC/\F[]\fR\fI \fR
8620 \fI\fIroot directory\fR\fR\fI = \fR\fI\FC/homes/smb\F[]\fR\fI \fR
8627 This is the same as the
8629 parameter except that the command is run as root\&. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed\&.
8632 \fI\fIroot postexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8635 root preexec close (S)
8636 .\" root preexec close
8639 This is the same as the
8640 \fIpreexec close \fR
8641 parameter except that the command is run as root\&.
8644 \fI\fIroot preexec close\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
8651 This is the same as the
8653 parameter except that the command is run as root\&. This is useful for mounting filesystems (such as CDROMs) when a connection is opened\&.
8656 \fI\fIroot preexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8663 This parameter controls what UNIX permission bits will be set when a Windows NT client is manipulating the UNIX permission on a file using the native NT security dialog box\&.
8665 This parameter is applied as a mask (AND\'ed with) to the incoming permission bits, thus resetting any bits not in this mask\&. Make sure not to mix up this parameter with
8666 \m[blue]\fBforce security mode\fR\m[], which works in a manner similar to this one but uses a logical OR instead of an AND\&.
8668 Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the file permissions regardless of the previous status of this bits on the file\&.
8670 If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file\&.
8673 that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems\&. Administrators of most normal systems will probably want to leave it set to
8677 \fI\fIsecurity mask\fR\fR\fI = \fR\fI\FC0777\F[]\fR\fI \fR
8680 \fI\fIsecurity mask\fR\fR\fI = \fR\fI\FC0770\F[]\fR\fI \fR
8687 This option affects how clients respond to Samba and is one of the most important settings in the
8691 The option sets the "security mode bit" in replies to protocol negotiations with
8693 to turn share level security on or off\&. Clients decide based on this bit whether (and how) to transfer user and password information to the server\&.
8696 \FCsecurity = user\F[], as this is the most common setting needed when talking to Windows 98 and Windows NT\&.
8698 The alternatives are
8699 \FCsecurity = share\F[],
8700 \FCsecurity = server\F[]
8702 \FCsecurity = domain \F[]\&.
8704 In versions of Samba prior to 2\&.0\&.0, the default was
8705 \FCsecurity = share\F[]
8706 mainly because that was the only option at one stage\&.
8708 There is a bug in WfWg that has relevance to this setting\&. When in user or server level security a WfWg client will totally ignore the username and password you type in the "connect drive" dialog box\&. This makes it very difficult (if not impossible) to connect to a Samba service as anyone except the user that you are logged into WfWg as\&.
8710 If your PCs use usernames that are the same as their usernames on the UNIX machine then you will want to use
8711 \FCsecurity = user\F[]\&. If you mostly use usernames that don\'t exist on the UNIX box then use
8712 \FCsecurity = share\F[]\&.
8715 \FCsecurity = share\F[]
8716 if you want to mainly setup shares without a password (guest shares)\&. This is commonly used for a shared printer server\&. It is more difficult to setup guest shares with
8717 \FCsecurity = user\F[], see the
8718 \m[blue]\fBmap to guest\fR\m[]
8719 parameter for details\&.
8721 It is possible to use
8725 where it is offers both user and share level security under different
8726 \m[blue]\fBNetBIOS aliases\fR\m[]\&.
8728 The different settings will now be explained\&.
8730 \fISECURITY = SHARE\fR
8732 When clients connect to a share level security server, they need not log onto the server with a valid username and password before attempting to connect to a shared resource (although modern clients such as Windows 95/98 and Windows NT will send a logon request with a username but no password when talking to a
8733 \FCsecurity = share \F[]
8734 server)\&. Instead, the clients send authentication information (passwords) on a per\-share basis, at the time they attempt to connect to that share\&.
8739 uses a valid UNIX user to act on behalf of the client, even in
8740 \FCsecurity = share\F[]
8743 As clients are not required to send a username to the server in share level security,
8745 uses several techniques to determine the correct UNIX user to use on behalf of the client\&.
8747 A list of possible UNIX usernames to match with the given client password is constructed using the following methods :
8751 \h'-04'\(bu\h'+03'\c
8758 \m[blue]\fBguest only\fR\m[]
8759 parameter is set, then all the other stages are missed and only the
8760 \m[blue]\fBguest account\fR\m[]
8761 username is checked\&.
8766 \h'-04'\(bu\h'+03'\c
8772 Is a username is sent with the share connection request, then this username (after mapping \- see
8773 \m[blue]\fBusername map\fR\m[]), is added as a potential username\&.
8778 \h'-04'\(bu\h'+03'\c
8784 If the client did a previous
8786 request (the SessionSetup SMB call) then the username sent in this SMB will be added as a potential username\&.
8791 \h'-04'\(bu\h'+03'\c
8797 The name of the service the client requested is added as a potential username\&.
8802 \h'-04'\(bu\h'+03'\c
8808 The NetBIOS name of the client is added to the list as a potential username\&.
8813 \h'-04'\(bu\h'+03'\c
8820 \m[blue]\fBuser\fR\m[]
8821 list are added as potential usernames\&.
8826 parameter is not set, then this list is then tried with the supplied password\&. The first user for whom the password matches will be used as the UNIX user\&.
8830 parameter is set, or no username can be determined then if the share is marked as available to the
8831 \fIguest account\fR, then this guest user will be used, otherwise access is denied\&.
8835 confusing in share\-level security as to which UNIX username will eventually be used in granting access\&.
8837 See also the section
8838 NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
8840 \fISECURITY = USER\fR
8842 This is the default security setting in Samba 3\&.0\&. With user\-level security a client must first "log\-on" with a valid username and password (which can be mapped using the
8843 \m[blue]\fBusername map\fR\m[]
8844 parameter)\&. Encrypted passwords (see the
8845 \m[blue]\fBencrypted passwords\fR\m[]
8846 parameter) can also be used in this security mode\&. Parameters such as
8847 \m[blue]\fBuser\fR\m[]
8849 \m[blue]\fBguest only\fR\m[]
8850 if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated\&.
8853 that the name of the resource being requested is
8855 sent to the server until after the server has successfully authenticated the client\&. This is why guest shares don\'t work in user level security without allowing the server to automatically map unknown users into the
8856 \m[blue]\fBguest account\fR\m[]\&. See the
8857 \m[blue]\fBmap to guest\fR\m[]
8858 parameter for details on doing this\&.
8860 See also the section
8861 NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
8863 \fISECURITY = DOMAIN\fR
8865 This mode will only work correctly if
8867 has been used to add this machine into a Windows NT Domain\&. It expects the
8868 \m[blue]\fBencrypted passwords\fR\m[]
8869 parameter to be set to
8870 \fByes\fR\&. In this mode Samba will try to validate the username/password by passing it to a Windows NT Primary or Backup Domain Controller, in exactly the same way that a Windows NT Server would do\&.
8873 that a valid UNIX user must still exist as well as the account on the Domain Controller to allow Samba to have a valid UNIX account to map file access to\&.
8876 that from the client\'s point of view
8877 \FCsecurity = domain\F[]
8879 \FCsecurity = user\F[]\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
8882 that the name of the resource being requested is
8884 sent to the server until after the server has successfully authenticated the client\&. This is why guest shares don\'t work in user level security without allowing the server to automatically map unknown users into the
8885 \m[blue]\fBguest account\fR\m[]\&. See the
8886 \m[blue]\fBmap to guest\fR\m[]
8887 parameter for details on doing this\&.
8889 See also the section
8890 NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
8893 \m[blue]\fBpassword server\fR\m[]
8895 \m[blue]\fBencrypted passwords\fR\m[]
8898 \fISECURITY = SERVER\fR
8900 In this mode Samba will try to validate the username/password by passing it to another SMB server, such as an NT box\&. If this fails it will revert to
8901 \FCsecurity = user\F[]\&. It expects the
8902 \m[blue]\fBencrypted passwords\fR\m[]
8903 parameter to be set to
8904 \fByes\fR, unless the remote server does not support them\&. However note that if encrypted passwords have been negotiated then Samba cannot revert back to checking the UNIX password file, it must have a valid
8906 file to check users against\&. See the chapter about the User Database in the Samba HOWTO Collection for details on how to set this up\&.
8913 .nr an-no-space-flag 1
8920 This mode of operation has significant pitfalls since it is more vulnerable to man\-in\-the\-middle attacks and server impersonation\&. In particular, this mode of operation can cause significant resource consuption on the PDC, as it must maintain an active connection for the duration of the user\'s session\&. Furthermore, if this connection is lost, there is no way to reestablish it, and futher authentications to the Samba server may fail (from a single client, till it disconnects)\&.
8930 .nr an-no-space-flag 1
8937 From the client\'s point of view,
8938 \FCsecurity = server\F[]
8940 \FCsecurity = user\F[]\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
8945 that the name of the resource being requested is
8947 sent to the server until after the server has successfully authenticated the client\&. This is why guest shares don\'t work in user level security without allowing the server to automatically map unknown users into the
8948 \m[blue]\fBguest account\fR\m[]\&. See the
8949 \m[blue]\fBmap to guest\fR\m[]
8950 parameter for details on doing this\&.
8952 See also the section
8953 NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
8956 \m[blue]\fBpassword server\fR\m[]
8958 \m[blue]\fBencrypted passwords\fR\m[]
8961 \fISECURITY = ADS\fR
8963 In this mode, Samba will act as a domain member in an ADS realm\&. To operate in this mode, the machine running Samba will need to have Kerberos installed and configured and Samba will need to be joined to the ADS realm using the net utility\&.
8965 Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\&.
8967 Read the chapter about Domain Membership in the HOWTO for details\&.
8970 \fI\fIsecurity\fR\fR\fI = \fR\fI\FCUSER\F[]\fR\fI \fR
8973 \fI\fIsecurity\fR\fR\fI = \fR\fI\FCDOMAIN\F[]\fR\fI \fR
8980 This controls whether the server offers or even demands the use of the netlogon schannel\&.
8981 \m[blue]\fBserver schannel = no\fR\m[]
8982 does not offer the schannel,
8983 \m[blue]\fBserver schannel = auto\fR\m[]
8984 offers the schannel but does not enforce it, and
8985 \m[blue]\fBserver schannel = yes\fR\m[]
8986 denies access if the client is not able to speak netlogon schannel\&. This is only the case for Windows NT4 before SP4\&.
8988 Please note that with this set to
8989 \FCno\F[], you will have to apply the WindowsXP
8990 \FCWinXP_SignOrSeal\&.reg\F[]
8991 registry patch found in the docs/registry subdirectory of the Samba distribution tarball\&.
8994 \fI\fIserver schannel\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
8997 \fI\fIserver schannel\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9004 This controls whether the client is allowed or required to use SMB signing\&. Possible values are
9010 When set to auto, SMB signing is offered, but not enforced\&. When set to mandatory, SMB signing is required and if set to disabled, SMB signing is not offered either\&.
9013 \fI\fIserver signing\fR\fR\fI = \fR\fI\FCDisabled\F[]\fR\fI \fR
9020 This controls what string will show up in the printer comment box in print manager and next to the IPC connection in
9021 \FCnet view\F[]\&. It can be any string that you wish to show to your users\&.
9023 It also sets what will appear in browse lists next to the machine name\&.
9027 will be replaced with the Samba version number\&.
9031 will be replaced with the hostname\&.
9034 \fI\fIserver string\fR\fR\fI = \fR\fI\FCSamba %v\F[]\fR\fI \fR
9037 \fI\fIserver string\fR\fR\fI = \fR\fI\FCUniversity of GNUs Samba Server\F[]\fR\fI \fR
9045 \FCset directory = no\F[], then users of the service may not use the setdir command to change directory\&.
9049 command is only implemented in the Digital Pathworks client\&. See the Pathworks documentation for details\&.
9052 \fI\fIset directory\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9055 set primary group script (G)
9056 .\" set primary group script
9059 Thanks to the Posix subsystem in NT a Windows User has a primary group in addition to the auxiliary groups\&. This script sets the primary group in the unix userdatase when an administrator sets the primary group from the windows user manager or when fetching a SAM with
9060 \FCnet rpc vampire\F[]\&.
9062 will be replaced with the user whose primary group is to be set\&.
9064 will be replaced with the group to set\&.
9067 \fI\fIset primary group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9070 \fI\fIset primary group script\fR\fR\fI = \fR\fI\FC/usr/sbin/usermod \-g \'%g\' \'%u\'\F[]\fR\fI \fR
9073 set quota command (G)
9074 .\" set quota command
9078 \FCset quota command\F[]
9079 should only be used whenever there is no operating system API available from the OS that samba can use\&.
9081 This option is only available if Samba was configured with the argument
9082 \FC\-\-with\-sys\-quotas\F[]
9084 \FC\&./configure \-\-with\-quotas\F[]
9085 was used and a working quota api was found in the system\&. Most packages are configured with these options already\&.
9087 This parameter should specify the path to a script that can set quota for the specified arguments\&.
9089 The specified script should take the following arguments:
9093 \h'-04'\(bu\h'+03'\c
9103 \h'-04'\(bu\h'+03'\c
9114 \h'-04'\(bu\h'+03'\c
9120 2 \- user default quotas (uid = \-1)
9125 \h'-04'\(bu\h'+03'\c
9136 \h'-04'\(bu\h'+03'\c
9142 4 \- group default quotas (gid = \-1)
9149 \h'-04'\(bu\h'+03'\c
9155 2 \- id (uid for user, gid for group, \-1 if N/A)
9160 \h'-04'\(bu\h'+03'\c
9166 3 \- quota state (0 = disable, 1 = enable, 2 = enable and enforce)
9171 \h'-04'\(bu\h'+03'\c
9177 4 \- block softlimit
9182 \h'-04'\(bu\h'+03'\c
9188 5 \- block hardlimit
9193 \h'-04'\(bu\h'+03'\c
9199 6 \- inode softlimit
9204 \h'-04'\(bu\h'+03'\c
9210 7 \- inode hardlimit
9215 \h'-04'\(bu\h'+03'\c
9221 8(optional) \- block size, defaults to 1024
9224 The script should output at least one line of data on success\&. And nothing on failure\&.
9227 \fI\fIset quota command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9230 \fI\fIset quota command\fR\fR\fI = \fR\fI\FC/usr/local/sbin/set_quota\F[]\fR\fI \fR
9237 This enables or disables the honoring of the
9239 during a file open\&. These modes are used by clients to gain exclusive read or write access to a file\&.
9241 This is a deprecated option from old versions of Samba, and will be removed in the next major release\&.
9243 These open modes are not directly supported by UNIX, so they are simulated using shared memory\&.
9245 The share modes that are enabled by this option are the standard Windows share modes\&.
9247 This option gives full share compatibility and is enabled by default\&.
9251 turn this parameter off as many Windows applications will break if you do so\&.
9254 \fI\fIshare modes\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9257 short preserve case (S)
9258 .\" short preserve case
9261 This boolean parameter controls if new files which conform to 8\&.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the
9262 \m[blue]\fBdefault case\fR\m[]\&. This option can be use with
9263 \m[blue]\fBpreserve case = yes\fR\m[]
9264 to permit long filenames to retain their case, while short names are lowered\&.
9270 \fI\fIshort preserve case\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9273 show add printer wizard (G)
9274 .\" show add printer wizard
9277 With the introduction of MS\-RPC based printing support for Windows NT/2000 client in Samba 2\&.2, a "Printers\&.\&.\&." folder will appear on Samba hosts in the share listing\&. Normally this folder will contain an icon for the MS Add Printer Wizard (APW)\&. However, it is possible to disable this feature regardless of the level of privilege of the connected user\&.
9279 Under normal circumstances, the Windows NT/2000 client will open a handle on the printer server with OpenPrinterEx() asking for Administrator privileges\&. If the user does not have administrative access on the print server (i\&.e is not root or a member of the
9281 group), the OpenPrinterEx() call fails and the client makes another open call with a request for a lower privilege level\&. This should succeed, however the APW icon will not be displayed\&.
9284 \fIshow add printer wizard\fR
9285 parameter will always cause the OpenPrinterEx() on the server to fail\&. Thus the APW icon will never be displayed\&.
9292 .nr an-no-space-flag 1
9299 This does not prevent the same user from having administrative privilege on an individual printer\&.
9304 \fI\fIshow add printer wizard\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9311 This a full path name to a script called by
9313 that should start a shutdown procedure\&.
9315 If the connected user posseses the
9316 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.
9318 The %z %t %r %f variables are expanded as follows:
9322 \h'-04'\(bu\h'+03'\c
9329 will be substituted with the shutdown message sent to the server\&.
9334 \h'-04'\(bu\h'+03'\c
9341 will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\&.
9346 \h'-04'\(bu\h'+03'\c
9353 will be substituted with the switch
9354 \fI\-r\fR\&. It means reboot after shutdown for NT\&.
9359 \h'-04'\(bu\h'+03'\c
9366 will be substituted with the switch
9367 \fI\-f\fR\&. It means force the shutdown even if applications do not respond for NT\&.
9370 Shutdown script example:
9381 .BB lightgray adjust-for-leading-newline
9390 /sbin/shutdown $3 $4 +$time $1 &
9391 .EB lightgray adjust-for-leading-newline
9402 Shutdown does not return so we need to launch it in background\&.
9405 \fI\fIshutdown script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9408 \fI\fIshutdown script\fR\fR\fI = \fR\fI\FC/usr/local/samba/sbin/shutdown %m %t %r %f\F[]\fR\fI \fR
9415 This is a new feature introduced with Samba 3\&.2 and above\&. It is an extension to the SMB/CIFS protocol negotiated as part of the UNIX extensions\&. SMB encryption uses the GSSAPI (SSPI on Windows) ability to encrypt and sign every request/response in a SMB protocol stream\&. When enabled it provides a secure method of SMB/CIFS communication, similar to an ssh protected session, but using SMB/CIFS authentication to negotiate encryption and signing keys\&. Currently this is only supported by Samba 3\&.2 smbclient, and hopefully soon Linux CIFSFS and MacOS/X clients\&. Windows clients do not support this feature\&.
9417 This controls whether the remote client is allowed or required to use SMB encryption\&. Possible values are
9421 \fIdisabled\fR\&. This may be set on a per\-share basis, but clients may chose to encrypt the entire session, not just traffic to a specific share\&. If this is set to mandatory then all traffic to a share
9423 must be encrypted once the connection has been made to the share\&. The server would return "access denied" to all non\-encrypted requests on such a share\&. Selecting encrypted traffic reduces throughput as smaller packet sizes must be used (no huge UNIX style read/writes allowed) as well as the overhead of encrypting and signing all the data\&.
9425 If SMB encryption is selected, Windows style SMB signing (see the
9426 \m[blue]\fBserver signing\fR\m[]
9427 option) is no longer necessary, as the GSSAPI flags use select both signing and sealing of the data\&.
9429 When set to auto, SMB encryption is offered, but not enforced\&. When set to mandatory, SMB encryption is required and if set to disabled, SMB encryption can not be negotiated\&.
9432 \fI\fIsmb encrypt\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
9439 This option sets the path to the encrypted smbpasswd file\&. By default the path to the smbpasswd file is compiled into Samba\&.
9441 An example of use is:
9452 .BB lightgray adjust-for-leading-newline
9455 smb passwd file = /etc/samba/smbpasswd
9456 .EB lightgray adjust-for-leading-newline
9468 \fI\fIsmb passwd file\fR\fR\fI = \fR\fI\FC${prefix}/private/smbpasswd\F[]\fR\fI \fR
9475 Specifies which ports the server should listen on for SMB traffic\&.
9478 \fI\fIsmb ports\fR\fR\fI = \fR\fI\FC445 139\F[]\fR\fI \fR
9485 This option allows you to control what address Samba will listen for connections on\&. This is used to support multiple virtual interfaces on the one server, each with a different configuration\&.
9487 Setting this option should never be necessary on usual Samba servers running only one nmbd\&.
9489 By default Samba will accept connections on any address\&.
9492 \fI\fIsocket address\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9495 \fI\fIsocket address\fR\fR\fI = \fR\fI\FC192\&.168\&.2\&.20\F[]\fR\fI \fR
9502 This option allows you to set socket options to be used when talking with the client\&.
9504 Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\&.
9506 This option will typically be used to tune your Samba server for optimal performance for your local network\&. There is no way that Samba can know what the optimal parameters are for your net, so you must experiment and choose them yourself\&. We strongly suggest you read the appropriate documentation for your operating system first (perhaps
9507 \FCman setsockopt\F[]
9510 You may find that on some systems Samba will say "Unknown socket option" when you supply an option\&. This means you either incorrectly typed it or you need to add an include file to includes\&.h for your OS\&. If the latter is the case please send the patch to
9511 samba\-technical@samba\&.org\&.
9513 Any of the supported socket options may be combined in any way you like, as long as your OS allows it\&.
9515 This is the list of socket options currently settable using this option:
9519 \h'-04'\(bu\h'+03'\c
9530 \h'-04'\(bu\h'+03'\c
9541 \h'-04'\(bu\h'+03'\c
9552 \h'-04'\(bu\h'+03'\c
9563 \h'-04'\(bu\h'+03'\c
9574 \h'-04'\(bu\h'+03'\c
9585 \h'-04'\(bu\h'+03'\c
9596 \h'-04'\(bu\h'+03'\c
9607 \h'-04'\(bu\h'+03'\c
9618 \h'-04'\(bu\h'+03'\c
9629 take an integer argument\&. The others can optionally take a 1 or 0 argument to enable or disable the option, by default they will be enabled if you don\'t specify 1 or 0\&.
9631 To specify an argument use the syntax SOME_OPTION = VALUE for example
9632 \FCSO_SNDBUF = 8192\F[]\&. Note that you must not have any spaces before or after the = sign\&.
9634 If you are on a local network then a sensible option might be:
9636 \FCsocket options = IPTOS_LOWDELAY\F[]
9638 If you have a local network then you could try:
9640 \FCsocket options = IPTOS_LOWDELAY TCP_NODELAY\F[]
9642 If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\&.
9644 Note that several of the options may cause your Samba server to fail completely\&. Use these options with caution!
9647 \fI\fIsocket options\fR\fR\fI = \fR\fI\FCTCP_NODELAY\F[]\fR\fI \fR
9650 \fI\fIsocket options\fR\fR\fI = \fR\fI\FCIPTOS_LOWDELAY\F[]\fR\fI \fR
9657 This parameter determines if
9659 will use a cache in order to speed up case insensitive name mappings\&. You should never need to change this parameter\&.
9662 \fI\fIstat cache\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9665 store dos attributes (S)
9666 .\" store dos attributes
9669 If this parameter is set Samba attempts to first read DOS attributes (SYSTEM, HIDDEN, ARCHIVE or READ\-ONLY) from a filesystem extended attribute, before mapping DOS attributes to UNIX permission bits (such as occurs with
9670 \m[blue]\fBmap hidden\fR\m[]
9672 \m[blue]\fBmap readonly\fR\m[])\&. When set, DOS attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or directory\&. For no other mapping to occur as a fall\-back, the parameters
9673 \m[blue]\fBmap hidden\fR\m[],
9674 \m[blue]\fBmap system\fR\m[],
9675 \m[blue]\fBmap archive\fR\m[]
9677 \m[blue]\fBmap readonly\fR\m[]
9678 must be set to off\&. This parameter writes the DOS attributes as a string into the extended attribute named "user\&.DOSATTRIB"\&. This extended attribute is explicitly hidden from smbd clients requesting an EA list\&. On Linux the filesystem must have been mounted with the mount option user_xattr in order for extended attributes to work, also extended attributes must be compiled into the Linux kernel\&.
9681 \fI\fIstore dos attributes\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9688 This is a boolean that controls the handling of disk space allocation in the server\&. When this is set to
9690 the server will change from UNIX behaviour of not committing real disk storage blocks when a file is extended to the Windows behaviour of actually forcing the disk system to allocate real storage blocks when a file is created or extended to be a given size\&. In UNIX terminology this means that Samba will stop creating sparse files\&. This can be slow on some systems\&.
9692 When strict allocate is
9694 the server does sparse disk block allocation when a file is extended\&.
9698 can help Samba return out of quota messages on systems that are restricting the disk quota of users\&.
9701 \fI\fIstrict allocate\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9708 This is an enumerated type that controls the handling of file locking in the server\&. When this is set to
9709 \fByes\fR, the server will check every read and write access for file locks, and deny access if locks exist\&. This can be slow on some systems\&.
9711 When strict locking is set to Auto (the default), the server performs file lock checks only on non\-oplocked files\&. As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for improved performance\&.
9713 When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\&.
9715 Well\-behaved clients always ask for lock checks when it is important\&. So in the vast majority of cases,
9716 \FCstrict locking = Auto\F[]
9718 \FCstrict locking = no\F[]
9722 \fI\fIstrict locking\fR\fR\fI = \fR\fI\FCAuto\F[]\fR\fI \fR
9729 Many Windows applications (including the Windows 98 explorer shell) seem to confuse flushing buffer contents to disk with doing a sync to disk\&. Under UNIX, a sync call forces the process to be suspended until the kernel has ensured that all outstanding data in kernel disk buffers has been safely stored onto stable storage\&. This is very slow and should only be done rarely\&. Setting this parameter to
9731 (the default) means that
9733 ignores the Windows applications requests for a sync call\&. There is only a possibility of losing data if the operating system itself that Samba is running on crashes, so there is little danger in this default setting\&. In addition, this fixes many performance problems that people have reported with the new Windows98 explorer shell file copies\&.
9736 \fI\fIstrict sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9743 This option defines a list of init scripts that smbd will use for starting and stopping Unix services via the Win32 ServiceControl API\&. This allows Windows administrators to utilize the MS Management Console plug\-ins to manage a Unix server running Samba\&.
9745 The administrator must create a directory name
9747 in Samba\'s $(libdir) and create symbolic links to the init scripts in
9748 \FC/etc/init\&.d/\F[]\&. The name of the links must match the names given as part of the
9749 \fIsvcctl list\fR\&.
9752 \fI\fIsvcctl list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9755 \fI\fIsvcctl list\fR\fR\fI = \fR\fI\FCcups postfix portmap httpd\F[]\fR\fI \fR
9762 This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\&. If this is
9764 then the server will be guided by the client\'s request in each write call (clients can set a bit indicating that a particular write should be synchronous)\&. If this is
9766 then every write will be followed by a
9768 call to ensure the data is written to disk\&. Note that the
9770 parameter must be set to
9772 in order for this parameter to have any effect\&.
9775 \fI\fIsync always\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9782 If this parameter is set then Samba debug messages are logged into the system syslog only, and not to the debug log files\&. There still will be some logging to log\&.[sn]mbd even if
9787 \fI\fIsyslog only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9794 This parameter maps how Samba debug messages are logged onto the system syslog logging levels\&. Samba debug level zero maps onto syslog
9795 \fBLOG_ERR\fR, debug level one maps onto
9796 \fBLOG_WARNING\fR, debug level two maps onto
9797 \fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\&. All higher levels are mapped to
9800 This parameter sets the threshold for sending messages to syslog\&. Only messages with debug level less than this value will be sent to syslog\&. There still will be some logging to log\&.[sn]mbd even if
9805 \fI\fIsyslog\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
9808 template homedir (G)
9809 .\" template homedir
9812 When filling out the user information for a Windows NT user, the
9814 daemon uses this parameter to fill in the home directory for that user\&. If the string
9816 is present it is substituted with the user\'s Windows NT domain name\&. If the string
9818 is present it is substituted with the user\'s Windows NT user name\&.
9821 \fI\fItemplate homedir\fR\fR\fI = \fR\fI\FC/home/%D/%U\F[]\fR\fI \fR
9828 When filling out the user information for a Windows NT user, the
9830 daemon uses this parameter to fill in the login shell for that user\&.
9839 This parameter is a setting in minutes to add to the normal GMT to local time conversion\&. This is useful if you are serving a lot of PCs that have incorrect daylight saving time handling\&.
9842 \fI\fItime offset\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
9845 \fI\fItime offset\fR\fR\fI = \fR\fI\FC60\F[]\fR\fI \fR
9852 This parameter determines if
9854 advertises itself as a time server to Windows clients\&.
9857 \fI\fItime server\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9864 Specifies the charset the unix machine Samba runs on uses\&. Samba needs to know this in order to be able to convert text to the charsets other SMB clients use\&.
9866 This is also the charset Samba will use when specifying arguments to scripts that it invokes\&.
9869 \fI\fIunix charset\fR\fR\fI = \fR\fI\FCUTF8\F[]\fR\fI \fR
9872 \fI\fIunix charset\fR\fR\fI = \fR\fI\FCASCII\F[]\fR\fI \fR
9879 This boolean parameter controls whether Samba implements the CIFS UNIX extensions, as defined by HP\&. These extensions enable Samba to better serve UNIX CIFS clients by supporting features such as symbolic links, hard links, etc\&.\&.\&. These extensions require a similarly enabled client, and are of no current use to Windows clients\&.
9882 \fI\fIunix extensions\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9885 unix password sync (G)
9886 .\" unix password sync
9889 This boolean parameter controls whether Samba attempts to synchronize the UNIX password with the SMB password when the encrypted SMB password in the smbpasswd file is changed\&. If this is set to
9891 the program specified in the
9892 \fIpasswd program\fR
9895 \- to allow the new UNIX password to be set without access to the old UNIX password (as the SMB password change code has no access to the old password cleartext, only the new)\&.
9898 \fI\fIunix password sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9901 update encrypted (G)
9902 .\" update encrypted
9905 This boolean parameter allows a user logging on with a plaintext password to have their encrypted (hashed) password in the smbpasswd file to be updated automatically as they log on\&. This option allows a site to migrate from plaintext password authentication (users authenticate with plaintext password over the wire, and are checked against a UNIX account database) to encrypted password authentication (the SMB challenge/response authentication mechanism) without forcing all users to re\-enter their passwords via smbpasswd at the time the change is made\&. This is a convenience option to allow the change over to encrypted passwords to be made over a longer period\&. Once all users have encrypted representations of their passwords in the smbpasswd file this parameter should be set to
9908 In order for this parameter to be operative the
9909 \m[blue]\fBencrypt passwords\fR\m[]
9910 parameter must be set to
9911 \fBno\fR\&. The default value of
9912 \m[blue]\fBencrypt passwords = Yes\fR\m[]\&. Note: This must be set to
9915 \m[blue]\fBupdate encrypted\fR\m[]
9918 Note that even when this parameter is set, a user authenticating to
9920 must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords\&.
9923 \fI\fIupdate encrypted\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9926 use client driver (S)
9927 .\" use client driver
9930 This parameter applies only to Windows NT/2000 clients\&. It has no effect on Windows 95/98/ME clients\&. When serving a printer to Windows NT/2000 clients without first installing a valid printer driver on the Samba host, the client will be required to install a local printer driver\&. From this point on, the client will treat the print as a local printer and not a network printer connection\&. This is much the same behavior that will occur when
9931 \FCdisable spoolss = yes\F[]\&.
9933 The differentiating factor is that under normal circumstances, the NT/2000 client will attempt to open the network printer using MS\-RPC\&. The problem is that because the client considers the printer to be local, it will attempt to issue the OpenPrinterEx() call requesting access rights associated with the logged on user\&. If the user possesses local administator rights but not root privilege on the Samba host (often the case), the OpenPrinterEx() call will fail\&. The result is that the client will now display an "Access Denied; Unable to connect" message in the printer queue window (even though jobs may successfully be printed)\&.
9935 If this parameter is enabled for a printer, then any attempt to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped to PRINTER_ACCESS_USE instead\&. Thus allowing the OpenPrinterEx() call to succeed\&.
9936 \fIThis parameter MUST not be enabled on a print share which has valid print driver installed on the Samba server\&.\fR
9939 \fI\fIuse client driver\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9946 This global parameter determines if the tdb internals of Samba can depend on mmap working correctly on the running system\&. Samba requires a coherent mmap/read\-write system memory cache\&. Currently only HPUX does not have such a coherent cache, and so this parameter is set to
9948 by default on HPUX\&. On all other systems this parameter should be left alone\&. This parameter is provided to help the Samba developers track down problems with the tdb internal code\&.
9951 \fI\fIuse mmap\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9958 This option helps Samba to try and \'guess\' at the real UNIX username, as many DOS clients send an all\-uppercase username\&. By default Samba tries all lowercase, followed by the username with the first letter capitalized, and fails if the username is not found on the UNIX machine\&.
9960 If this parameter is set to non\-zero the behavior changes\&. This parameter is a number that specifies the number of uppercase combinations to try while trying to determine the UNIX user name\&. The higher the number the more combinations will be tried, but the slower the discovery of usernames will be\&. Use this parameter when you have strange usernames on your UNIX machine, such as
9961 \fBAstrangeUser \fR\&.
9963 This parameter is needed only on UNIX systems that have case sensitive usernames\&.
9966 \fI\fIusername level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
9969 \fI\fIusername level\fR\fR\fI = \fR\fI\FC5\F[]\fR\fI \fR
9972 username map script (G)
9973 .\" username map script
9976 This script is a mutually exclusive alternative to the
9977 \m[blue]\fBusername map\fR\m[]
9978 parameter\&. This parameter specifies and external program or script that must accept a single command line option (the username transmitted in the authentication request) and return a line line on standard output (the name to which the account should mapped)\&. In this way, it is possible to store username map tables in an LDAP or NIS directory services\&.
9981 \fI\fIusername map script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9984 \fI\fIusername map script\fR\fR\fI = \fR\fI\FC/etc/samba/scripts/mapusers\&.sh\F[]\fR\fI \fR
9991 This option allows you to specify a file containing a mapping of usernames from the clients to the server\&. This can be used for several purposes\&. The most common is to map usernames that users use on DOS or Windows machines to those that the UNIX box uses\&. The other is to map multiple users to a single username so that they can more easily share files\&.
9993 Please note that for user or share mode security, the username map is applied prior to validating the user credentials\&. Domain member servers (domain or ads) apply the username map after the user has been successfully authenticated by the domain controller and require fully qualified enties in the map table (e\&.g\&. biddle =
9994 \FCDOMAIN\efoo\F[])\&.
9996 The map file is parsed line by line\&. Each line should contain a single UNIX username on the left then a \'=\' followed by a list of usernames on the right\&. The list of usernames on the right may contain names of the form @group in which case they will match any UNIX username in that group\&. The special client name \'*\' is a wildcard and matches any name\&. Each line of the map file may be up to 1023 characters long\&.
9998 The file is processed on each line by taking the supplied username and comparing it with each username on the right hand side of the \'=\' signs\&. If the supplied name matches any of the names on the right hand side then it is replaced with the name on the left\&. Processing then continues with the next line\&.
10000 If any line begins with a \'#\' or a \';\' then it is ignored\&.
10002 If any line begins with an \'!\' then the processing will stop after that line if a mapping was done by the line\&. Otherwise mapping continues with every line being processed\&. Using \'!\' is most useful when you have a wildcard mapping line later in the file\&.
10004 For example to map from the name
10007 \fBadministrator\fR
10021 .BB lightgray adjust-for-leading-newline
10024 \FCroot = admin administrator\F[]
10025 .EB lightgray adjust-for-leading-newline
10036 Or to map anyone in the UNIX group
10051 .BB lightgray adjust-for-leading-newline
10054 \FCsys = @system\F[]
10055 .EB lightgray adjust-for-leading-newline
10066 You can have as many mappings as you like in a username map file\&.
10068 If your system supports the NIS NETGROUP option then the netgroup database is checked before the
10070 database for matching groups\&.
10072 You can map Windows usernames that have spaces in them by using double quotes around the name\&. For example:
10083 .BB lightgray adjust-for-leading-newline
10086 \FCtridge = "Andrew Tridgell"\F[]
10087 .EB lightgray adjust-for-leading-newline
10098 would map the windows username "Andrew Tridgell" to the unix username "tridge"\&.
10100 The following example would map mary and fred to the unix user sys, and map the rest to guest\&. Note the use of the \'!\' to tell Samba to stop processing if it gets a match on that line:
10111 .BB lightgray adjust-for-leading-newline
10116 .EB lightgray adjust-for-leading-newline
10127 Note that the remapping is applied to all occurrences of usernames\&. Thus if you connect to \e\eserver\efred and
10131 then you will actually be connecting to \e\eserver\emary and will need to supply a password suitable for
10134 \fBfred\fR\&. The only exception to this is the username passed to the
10135 \m[blue]\fBpassword server\fR\m[]
10136 (if you have one)\&. The password server will receive whatever username the client supplies without modification\&.
10138 Also note that no reverse mapping is done\&. The main effect this has is with printing\&. Users who have been mapped may have trouble deleting print jobs as PrintManager under WfWg will think they don\'t own the print job\&.
10140 Samba versions prior to 3\&.0\&.8 would only support reading the fully qualified username (e\&.g\&.:
10141 \FCDOMAIN\euser\F[]) from the username map when performing a kerberos login from a client\&. However, when looking up a map entry for a user authenticated by NTLM[SSP], only the login name would be used for matches\&. This resulted in inconsistent behavior sometimes even on the same server\&.
10143 The following functionality is obeyed in version 3\&.0\&.8 and later:
10145 When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\&.
10147 When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\&.e\&.
10148 \FCDOMAIN\euser\F[]) only after the user has been successfully authenticated\&.
10150 An example of use is:
10161 .BB lightgray adjust-for-leading-newline
10164 username map = /usr/local/samba/lib/users\&.map
10165 .EB lightgray adjust-for-leading-newline
10177 \fI\fIusername map\fR\fR\fI = \fR\fI\FC # no username map\F[]\fR\fI \fR
10184 This parameter is a synonym for
10192 This parameter is a synonym for
10200 Multiple users may be specified in a comma\-delimited list, in which case the supplied password will be tested against each username in turn (left to right)\&.
10204 line is needed only when the PC is unable to supply its own username\&. This is the case for the COREPLUS protocol or where your users have different WfWg usernames to UNIX usernames\&. In both these cases you may also be better using the \e\eserver\eshare%user syntax instead\&.
10208 line is not a great solution in many cases as it means Samba will try to validate the supplied password against each of the usernames in the
10210 line in turn\&. This is slow and a bad idea for lots of users in case of duplicate passwords\&. You may get timeouts or security breaches using this parameter unwisely\&.
10212 Samba relies on the underlying UNIX security\&. This parameter does not restrict who can login, it just offers hints to the Samba server as to what usernames might correspond to the supplied password\&. Users can login as whoever they please and they will be able to do no more damage than if they started a telnet session\&. The daemon runs as the user that they log in as, so they cannot do anything that user cannot do\&.
10214 To restrict a service to a particular set of users you can use the
10215 \m[blue]\fBvalid users\fR\m[]
10218 If any of the usernames begin with a \'@\' then the name will be looked up first in the NIS netgroups list (if Samba is compiled with netgroup support), followed by a lookup in the UNIX groups database and will expand to a list of all users in the group of that name\&.
10220 If any of the usernames begin with a \'+\' then the name will be looked up only in the UNIX groups database and will expand to a list of all users in the group of that name\&.
10222 If any of the usernames begin with a \'&\' then the name will be looked up only in the NIS netgroups database (if Samba is compiled with netgroup support) and will expand to a list of all users in the netgroup group of that name\&.
10224 Note that searching though a groups database can take quite some time, and some clients may time out during the search\&.
10227 NOTE ABOUT USERNAME/PASSWORD VALIDATION
10228 for more information on how this parameter determines access to the services\&.
10231 \fI\fIusername\fR\fR\fI = \fR\fI\FC # The guest account if a guest service, else <empty string>\&.\F[]\fR\fI \fR
10234 \fI\fIusername\fR\fR\fI = \fR\fI\FCfred, mary, jack, jane, @users, @pcgroup\F[]\fR\fI \fR
10237 usershare allow guests (G)
10238 .\" usershare allow guests
10241 This parameter controls whether user defined shares are allowed to be accessed by non\-authenticated users or not\&. It is the equivalent of allowing people who can create a share the option of setting
10242 \fIguest ok = yes\fR
10243 in a share definition\&. Due to its security sensitive nature, the default is set to off\&.
10246 \fI\fIusershare allow guests\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10249 usershare max shares (G)
10250 .\" usershare max shares
10253 This parameter specifies the number of user defined shares that are allowed to be created by users belonging to the group owning the usershare directory\&. If set to zero (the default) user defined shares are ignored\&.
10256 \fI\fIusershare max shares\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
10259 usershare owner only (G)
10260 .\" usershare owner only
10263 This parameter controls whether the pathname exported by a user defined shares must be owned by the user creating the user defined share or not\&. If set to True (the default) then smbd checks that the directory path being shared is owned by the user who owns the usershare file defining this share and refuses to create the share if not\&. If set to False then no such check is performed and any directory path may be exported regardless of who owns it\&.
10266 \fI\fIusershare owner only\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
10273 This parameter specifies the absolute path of the directory on the filesystem used to store the user defined share definition files\&. This directory must be owned by root, and have no access for other, and be writable only by the group owner\&. In addition the "sticky" bit must also be set, restricting rename and delete to owners of a file (in the same way the /tmp directory is usually configured)\&. Members of the group owner of this directory are the users allowed to create usershares\&. If this parameter is undefined then no user defined shares are allowed\&.
10275 For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\&.
10288 .BB lightgray adjust-for-leading-newline
10291 ls \-ld /usr/local/samba/lib/usershares/
10292 drwxrwx\-\-T 2 root power_users 4096 2006\-05\-05 12:27 /usr/local/samba/lib/usershares/
10294 .EB lightgray adjust-for-leading-newline
10305 In this case, only members of the group "power_users" can create user defined shares\&.
10308 \fI\fIusershare path\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
10311 usershare prefix allow list (G)
10312 .\" usershare prefix allow list
10315 This parameter specifies a list of absolute pathnames the root of which are allowed to be exported by user defined share definitions\&. If the pathname to be exported doesn\'t start with one of the strings in this list, the user defined share will not be allowed\&. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares\&.
10317 If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation\&.
10320 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
10323 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\FC/home /data /space\F[]\fR\fI \fR
10326 usershare prefix deny list (G)
10327 .\" usershare prefix deny list
10330 This parameter specifies a list of absolute pathnames the root of which are NOT allowed to be exported by user defined share definitions\&. If the pathname exported starts with one of the strings in this list the user defined share will not be allowed\&. Any pathname not starting with one of these strings will be allowed to be exported as a usershare\&. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares\&.
10332 If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation\&.
10335 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
10338 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\FC/etc /dev /private\F[]\fR\fI \fR
10341 usershare template share (G)
10342 .\" usershare template share
10345 User defined shares only have limited possible parameters such as path, guest ok, etc\&. This parameter allows usershares to "cloned" from an existing share\&. If "usershare template share" is set to the name of an existing share, then all usershares created have their defaults set from the parameters set on this share\&.
10347 The target share may be set to be invalid for real file sharing by setting the parameter "\-valid = False" on the template share definition\&. This causes it not to be seen as a real exported share but to be able to be used as a template for usershares\&.
10350 \fI\fIusershare template share\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
10353 \fI\fIusershare template share\fR\fR\fI = \fR\fI\FCtemplate_share\F[]\fR\fI \fR
10360 If this parameter is
10363 system call is supported by the underlying operating system, then some SMB read calls (mainly ReadAndX and ReadRaw) will use the more efficient sendfile system call for files that are exclusively oplocked\&. This may make more efficient use of the system CPU\'s and cause Samba to be faster\&. Samba automatically turns this off for clients that use protocol levels lower than NT LM 0\&.12 and when it detects a client is Windows 9x (using sendfile from Linux will cause these clients to fail)\&.
10366 \fI\fIuse sendfile\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
10373 This variable controls controls whether samba will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000 clients to agree upon an authentication mechanism\&.
10375 Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled\&.
10378 \fI\fIuse spnego\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10385 This parameter is only available if Samba has been configured and compiled with the option
10386 \FC \-\-with\-utmp\F[]\&. It specifies a directory pathname that is used to store the utmp or utmpx files (depending on the UNIX system) that record user connections to a Samba server\&. By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually
10387 \FC/var/run/utmp\F[]
10391 \fI\fIutmp directory\fR\fR\fI = \fR\fI\FC # Determined automatically\F[]\fR\fI \fR
10394 \fI\fIutmp directory\fR\fR\fI = \fR\fI\FC/var/run/utmp\F[]\fR\fI \fR
10401 This boolean parameter is only available if Samba has been configured and compiled with the option
10402 \FC\-\-with\-utmp\F[]\&. If set to
10404 then Samba will attempt to add utmp or utmpx records (depending on the UNIX system) whenever a connection is made to a Samba server\&. Sites may use this to record the user connecting to a Samba share\&.
10406 Due to the requirements of the utmp record, we are required to create a unique identifier for the incoming user\&. Enabling this option creates an n^2 algorithm to find this number\&. This may impede performance on large installations\&.
10409 \fI\fIutmp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10416 This is a list of users that should be allowed to login to this service\&. Names starting with \'@\', \'+\' and \'&\' are interpreted using the same rules as described in the
10417 \fIinvalid users\fR
10420 If this is empty (the default) then any user can login\&. If a username is in both this list and the
10421 \fIinvalid users\fR
10422 list then access is denied for that user\&.
10424 The current servicename is substituted for
10425 \fI%S\fR\&. This is useful in the [homes] section\&.
10428 \fI\fIvalid users\fR\fR\fI = \fR\fI\FC # No valid users list (anyone can login) \F[]\fR\fI \fR
10431 \fI\fIvalid users\fR\fR\fI = \fR\fI\FCgreg, @pcusers\F[]\fR\fI \fR
10438 This parameter indicates whether a share is valid and thus can be used\&. When this parameter is set to false, the share will be in no way visible nor accessible\&.
10440 This option should not be used by regular users but might be of help to developers\&. Samba uses this option internally to mark shares as deleted\&.
10443 \fI\fI\-valid\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10450 This is a list of files and directories that are neither visible nor accessible\&. Each entry in the list must be separated by a \'/\', which allows spaces to be included in the entry\&. \'*\' and \'?\' can be used to specify multiple files or directories as in DOS wildcards\&.
10452 Each entry must be a unix path, not a DOS path and must
10454 include the unix directory separator \'/\'\&.
10457 \m[blue]\fBcase sensitive\fR\m[]
10458 option is applicable in vetoing files\&.
10460 One feature of the veto files parameter that it is important to be aware of is Samba\'s behaviour when trying to delete a directory\&. If a directory that is to be deleted contains nothing but veto files this deletion will
10462 unless you also set the
10463 \m[blue]\fBdelete veto files\fR\m[]
10467 Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned\&.
10469 Examples of use include:
10480 .BB lightgray adjust-for-leading-newline
10483 ; Veto any files containing the word Security,
10484 ; any ending in \&.tmp, and any directory containing the
10486 veto files = /*Security*/*\&.tmp/*root*/
10488 ; Veto the Apple specific files that a NetAtalk server
10490 veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
10491 .EB lightgray adjust-for-leading-newline
10503 \fI\fIveto files\fR\fR\fI = \fR\fI\FCNo files or directories are vetoed\&.\F[]\fR\fI \fR
10506 veto oplock files (S)
10507 .\" veto oplock files
10510 This parameter is only valid when the
10511 \m[blue]\fBoplocks\fR\m[]
10512 parameter is turned on for a share\&. It allows the Samba administrator to selectively turn off the granting of oplocks on selected files that match a wildcarded list, similar to the wildcarded list used in the
10513 \m[blue]\fBveto files\fR\m[]
10516 You might want to do this on files that you know will be heavily contended for by clients\&. A good example of this is in the NetBench SMB benchmark program, which causes heavy client contention for files ending in
10517 \FC\&.SEM\F[]\&. To cause Samba not to grant oplocks on these files you would use the line (either in the [global] section or in the section for the particular NetBench share\&.
10519 An example of use is:
10530 .BB lightgray adjust-for-leading-newline
10533 veto oplock files = /\&.*SEM/
10534 .EB lightgray adjust-for-leading-newline
10546 \fI\fIveto oplock files\fR\fR\fI = \fR\fI\FC # No files are vetoed for oplock grants\F[]\fR\fI \fR
10553 This parameter is a synonym for
10561 This parameter specifies the backend names which are used for Samba VFS I/O operations\&. By default, normal disk I/O operations are used but these can be overloaded with one or more VFS objects\&.
10564 \fI\fIvfs objects\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
10567 \fI\fIvfs objects\fR\fR\fI = \fR\fI\FCextd_audit recycle\F[]\fR\fI \fR
10574 This allows you to override the volume label returned for a share\&. Useful for CDROMs with installation programs that insist on a particular volume label\&.
10577 \fI\fIvolume\fR\fR\fI = \fR\fI\FC # the name of the share\F[]\fR\fI \fR
10584 This parameter controls whether or not links in the UNIX file system may be followed by the server\&. Links that point to areas within the directory tree exported by the server are always allowed; this parameter controls access only to areas that are outside the directory tree being exported\&.
10586 Note that setting this parameter can have a negative effect on your server performance due to the extra system calls that Samba has to do in order to perform the link checks\&.
10589 \fI\fIwide links\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10592 winbind cache time (G)
10593 .\" winbind cache time
10596 This parameter specifies the number of seconds the
10598 daemon will cache user and group information before querying a Windows NT server again\&.
10600 This does not apply to authentication requests, these are always evaluated in real time unless the
10601 \m[blue]\fBwinbind offline logon\fR\m[]
10602 option has been enabled\&.
10605 \fI\fIwinbind cache time\fR\fR\fI = \fR\fI\FC300\F[]\fR\fI \fR
10608 winbind enum groups (G)
10609 .\" winbind enum groups
10612 On large installations using
10614 it may be necessary to suppress the enumeration of groups through the
10619 group of system calls\&. If the
10620 \fIwinbind enum groups\fR
10622 \fBno\fR, calls to the
10624 system call will not return any data\&.
10631 .nr an-no-space-flag 1
10632 .nr an-break-flag 1
10638 Turning off group enumeration may cause some programs to behave oddly\&.
10643 \fI\fIwinbind enum groups\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10646 winbind enum users (G)
10647 .\" winbind enum users
10650 On large installations using
10652 it may be necessary to suppress the enumeration of users through the
10657 group of system calls\&. If the
10658 \fIwinbind enum users\fR
10660 \fBno\fR, calls to the
10662 system call will not return any data\&.
10669 .nr an-no-space-flag 1
10670 .nr an-break-flag 1
10676 Turning off user enumeration may cause some programs to behave oddly\&. For example, the finger program relies on having access to the full user list when searching for matching usernames\&.
10681 \fI\fIwinbind enum users\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10684 winbind expand groups (G)
10685 .\" winbind expand groups
10688 This option controls the maximum depth that winbindd will traverse when flattening nested group memberships of Windows domain groups\&. This is different from the
10689 \m[blue]\fBwinbind nested groups\fR\m[]
10690 option which implements the Windows NT4 model of local group nesting\&. The "winbind expand groups" parameter specifically applies to the membership of domain groups\&.
10692 Be aware that a high value for this parameter can result in system slowdown as the main parent winbindd daemon must perform the group unrolling and will be unable to answer incoming NSS or authentication requests during this time\&.
10695 \fI\fIwinbind expand groups\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
10698 winbind nested groups (G)
10699 .\" winbind nested groups
10702 If set to yes, this parameter activates the support for nested groups\&. Nested groups are also called local groups or aliases\&. They work like their counterparts in Windows: Nested groups are defined locally on any machine (they are shared between DC\'s through their SAM) and can contain users and global groups from any trusted SAM\&. To be able to use nested groups, you need to run nss_winbind\&.
10705 \fI\fIwinbind nested groups\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10708 winbind normalize names (G)
10709 .\" winbind normalize names
10712 This parameter controls whether winbindd will replace whitespace in user and group names with an underscore (_) character\&. For example, whether the name "Space Kadet" should be replaced with the string "space_kadet"\&. Frequently Unix shell scripts will have difficulty with usernames contains whitespace due to the default field separator in the shell\&. If your domain possesses names containing the underscore character, this option may cause problems unless the name aliasing feature is supported by your nss_info plugin\&.
10714 This feature also enables the name aliasing API which can be used to make domain user and group names to a non\-qualified version\&. Please refer to the manpage for the configured idmap and nss_info plugin for the specifics on how to configure name aliasing for a specific configuration\&. Name aliasing takes precendence (and is mutually exclusive) over the whitespace replacement mechanism discussed previsouly\&.
10717 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10720 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10723 winbind nss info (G)
10724 .\" winbind nss info
10727 This parameter is designed to control how Winbind retrieves Name Service Information to construct a user\'s home directory and login shell\&. Currently the following settings are available:
10731 \h'-04'\(bu\h'+03'\c
10738 \- The default, using the parameters of
10739 \fItemplate shell\fR
10741 \fItemplate homedir\fR)
10746 \h'-04'\(bu\h'+03'\c
10752 \fI<sfu | rfc2307 >\fR
10753 \- When Samba is running in security = ads and your Active Directory Domain Controller does support the Microsoft "Services for Unix" (SFU) LDAP schema, winbind can retrieve the login shell and the home directory attributes directly from your Directory Server\&. Note that retrieving UID and GID from your ADS\-Server requires to use
10754 \fIidmap backend\fR
10756 \fIidmap config DOMAIN:backend\fR
10762 \fI\fIwinbind nss info\fR\fR\fI = \fR\fI\FCtemplate\F[]\fR\fI \fR
10765 \fI\fIwinbind nss info\fR\fR\fI = \fR\fI\FCtemplate sfu\F[]\fR\fI \fR
10768 winbind offline logon (G)
10769 .\" winbind offline logon
10772 This parameter is designed to control whether Winbind should allow to login with the
10774 module using Cached Credentials\&. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\&.
10777 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
10780 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fI\FCtrue\F[]\fR\fI \fR
10783 winbind reconnect delay (G)
10784 .\" winbind reconnect delay
10787 This parameter specifies the number of seconds the
10789 daemon will wait between attempts to contact a Domain controller for a domain that is determined to be down or not contactable\&.
10792 \fI\fIwinbind reconnect delay\fR\fR\fI = \fR\fI\FC30\F[]\fR\fI \fR
10795 winbind refresh tickets (G)
10796 .\" winbind refresh tickets
10799 This parameter is designed to control whether Winbind should refresh Kerberos Tickets retrieved using the
10804 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
10807 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fI\FCtrue\F[]\fR\fI \fR
10810 winbind rpc only (G)
10811 .\" winbind rpc only
10814 Setting this parameter to
10816 forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers\&.
10819 \fI\fIwinbind rpc only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10822 winbind separator (G)
10823 .\" winbind separator
10826 This parameter allows an admin to define the character used when listing a username of the form of
10827 \fIDOMAIN \fR\e\fIuser\fR\&. This parameter is only applicable when using the
10828 \FCpam_winbind\&.so\F[]
10830 \FCnss_winbind\&.so\F[]
10831 modules for UNIX services\&.
10833 Please note that setting this parameter to + causes problems with group membership at least on glibc systems, as the character + is used as a special character for NIS in /etc/group\&.
10836 \fI\fIwinbind separator\fR\fR\fI = \fR\fI\FC\'\e\'\F[]\fR\fI \fR
10839 \fI\fIwinbind separator\fR\fR\fI = \fR\fI\FC+\F[]\fR\fI \fR
10842 winbind trusted domains only (G)
10843 .\" winbind trusted domains only
10846 This parameter is designed to allow Samba servers that are members of a Samba controlled domain to use UNIX accounts distributed via NIS, rsync, or LDAP as the uid\'s for winbindd users in the hosts primary domain\&. Therefore, the user
10847 \FCDOMAIN\euser1\F[]
10848 would be mapped to the account user1 in /etc/passwd instead of allocating a new uid for him or her\&.
10850 This parameter is now deprecated in favor of the newer idmap_nss backend\&. Refer to the
10852 man page for more information\&.
10855 \fI\fIwinbind trusted domains only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10858 winbind use default domain (G)
10859 .\" winbind use default domain
10862 This parameter specifies whether the
10864 daemon should operate on users without domain component in their username\&. Users without a domain component are treated as is part of the winbindd server\'s own domain\&. While this does not benifit Windows users, it makes SSH, FTP and e\-mail function in a way much closer to the way they would in a native unix system\&.
10867 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10870 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10877 When Samba is running as a WINS server this allows you to call an external program for all changes to the WINS database\&. The primary use for this option is to allow the dynamic update of external name resolution databases such as dynamic DNS\&.
10879 The wins hook parameter specifies the name of a script or executable that will be called as follows:
10881 \FCwins_hook operation name nametype ttl IP_list\F[]
10885 \h'-04'\(bu\h'+03'\c
10891 The first argument is the operation and is one of "add", "delete", or "refresh"\&. In most cases the operation can be ignored as the rest of the parameters provide sufficient information\&. Note that "refresh" may sometimes be called when the name has not previously been added, in that case it should be treated as an add\&.
10896 \h'-04'\(bu\h'+03'\c
10902 The second argument is the NetBIOS name\&. If the name is not a legal name then the wins hook is not called\&. Legal names contain only letters, digits, hyphens, underscores and periods\&.
10907 \h'-04'\(bu\h'+03'\c
10913 The third argument is the NetBIOS name type as a 2 digit hexadecimal number\&.
10918 \h'-04'\(bu\h'+03'\c
10924 The fourth argument is the TTL (time to live) for the name in seconds\&.
10929 \h'-04'\(bu\h'+03'\c
10935 The fifth and subsequent arguments are the IP addresses currently registered for that name\&. If this list is empty then the name should be deleted\&.
10938 An example script that calls the BIND dynamic DNS update program
10940 is provided in the examples directory of the Samba source code\&.
10949 This is a boolean that controls if
10951 will respond to broadcast name queries on behalf of other hosts\&. You may need to set this to
10953 for some older clients\&.
10956 \fI\fIwins proxy\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10963 This specifies the IP address (or DNS name: IP address for preference) of the WINS server that
10965 should register with\&. If you have a WINS server on your network then you should set this to the WINS server\'s IP\&.
10967 You should point this at your WINS server if you have a multi\-subnetted network\&.
10969 If you want to work in multiple namespaces, you can give every wins server a \'tag\'\&. For each tag, only one (working) server will be queried for a name\&. The tag should be separated from the ip address by a colon\&.
10976 .nr an-no-space-flag 1
10977 .nr an-break-flag 1
10983 You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross\-subnet browsing to work correctly\&.
10987 See the chapter in the Samba3\-HOWTO on Network Browsing\&.
10990 \fI\fIwins server\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
10993 \fI\fIwins server\fR\fR\fI = \fR\fI\FCmary:192\&.9\&.200\&.1 fred:192\&.168\&.3\&.199 mary:192\&.168\&.2\&.61 # For this example when querying a certain name, 192\&.19\&.200\&.1 will be asked first and if that doesn\'t respond 192\&.168\&.2\&.61\&. If either of those doesn\'t know the name 192\&.168\&.3\&.199 will be queried\&.\F[]\fR\fI \fR
10996 \fI\fIwins server\fR\fR\fI = \fR\fI\FC192\&.9\&.200\&.1 192\&.168\&.2\&.61\F[]\fR\fI \fR
11003 This boolean controls if the
11005 process in Samba will act as a WINS server\&. You should not set this to
11007 unless you have a multi\-subnetted network and you wish a particular
11009 to be your WINS server\&. Note that you should
11013 on more than one machine in your network\&.
11016 \fI\fIwins support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
11023 This controls what workgroup your server will appear to be in when queried by clients\&. Note that this parameter also controls the Domain name used with the
11024 \m[blue]\fBsecurity = domain\fR\m[]
11028 \fI\fIworkgroup\fR\fR\fI = \fR\fI\FCWORKGROUP\F[]\fR\fI \fR
11031 \fI\fIworkgroup\fR\fR\fI = \fR\fI\FCMYGROUP\F[]\fR\fI \fR
11038 This parameter is a synonym for
11046 Inverted synonym for
11047 \m[blue]\fBread only\fR\m[]\&.
11050 \fI\fIwriteable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
11053 write cache size (S)
11054 .\" write cache size
11057 If this integer parameter is set to non\-zero value, Samba will create an in\-memory cache for each oplocked file (it does
11059 do this for non\-oplocked files)\&. All writes that the client does not request to be flushed directly to disk will be stored in this cache if possible\&. The cache is flushed onto disk when a write comes in whose offset would not fit into the cache or when the file is closed by the client\&. Reads for the file are also served from this cache if the data is stored within it\&.
11061 This cache allows Samba to batch client writes into a more efficient write size for RAID disks (i\&.e\&. writes may be tuned to be the RAID stripe size) and can improve performance on systems where the disk subsystem is a bottleneck but there is free memory for userspace programs\&.
11063 The integer parameter specifies the size of this cache (per oplocked file) in bytes\&.
11066 \fI\fIwrite cache size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
11069 \fI\fIwrite cache size\fR\fR\fI = \fR\fI\FC262144 # for a 256k cache size per file\F[]\fR\fI \fR
11076 This is a list of users that are given read\-write access to a service\&. If the connecting user is in this list then they will be given write access, no matter what the
11077 \m[blue]\fBread only\fR\m[]
11078 option is set to\&. The list can include group names using the @group syntax\&.
11080 Note that if a user is in both the read list and the write list then they will be given write access\&.
11082 By design, this parameter will not work with the
11083 \m[blue]\fBsecurity = share\fR\m[]
11087 \fI\fIwrite list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
11090 \fI\fIwrite list\fR\fR\fI = \fR\fI\FCadmin, root, @staff\F[]\fR\fI \fR
11097 This parameter controls whether or not the server will support raw write SMB\'s when transferring data from clients\&. You should never need to change this parameter\&.
11100 \fI\fIwrite raw\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
11107 This parameter is only available if Samba has been configured and compiled with the option
11108 \FC \-\-with\-utmp\F[]\&. It specifies a directory pathname that is used to store the wtmp or wtmpx files (depending on the UNIX system) that record user connections to a Samba server\&. The difference with the utmp directory is the fact that user info is kept after a user has logged out\&.
11110 By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually
11111 \FC/var/run/wtmp\F[]
11115 \fI\fIwtmp directory\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
11118 \fI\fIwtmp directory\fR\fR\fI = \fR\fI\FC/var/log/wtmp\F[]\fR\fI \fR
11122 Although the configuration file permits service names to contain spaces, your client software may not\&. Spaces will be ignored in comparisons anyway, so it shouldn\'t be a problem \- but be aware of the possibility\&.
11124 On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\&.
11126 has no such limitation, but attempts to connect from such clients will fail if they truncate the service names\&. For this reason you should probably keep your service names down to eight characters in length\&.
11132 special sections make life for an administrator easy, but the various combinations of default attributes can be tricky\&. Take extreme care when designing these sections\&. In particular, ensure that the permissions on spool directories are correct\&.
11135 This man page is correct for version 3 of the Samba suite\&.
11140 \fBsmbpasswd\fR(8),
11144 \fBsmbclient\fR(1),
11145 \fBnmblookup\fR(1),
11147 \fBtestprns\fR(1)\&.
11150 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
11152 The original Samba man pages were written by Karl Auer\&. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at
11153 ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
git.samba.org / abartlet / samba-debian.git / blob