smb.conf.5 [plain text]

.\" This manpage has been automatically generated by docbook2man-spec
.\" from a DocBook document. docbook2man-spec can be found at:
.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "SMB.CONF" "5" "01 February 2002" "" ""
.SH NAME
smb.conf \- The configuration file for the Samba suite
.SH "SYNOPSIS"
.PP
The \fIsmb.conf\fR file is a configuration
file for the Samba suite. \fIsmb.conf\fR contains
runtime configuration information for the Samba programs. The
\fIsmb.conf\fR file is designed to be configured and
administered by the \fBswat(8)\fR
program. The complete description of the file format and
possible parameters held within are here for reference purposes.
.SH "FILE FORMAT"
.PP
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
.PP
\fIname\fR = \fIvalue
\fR.PP
The file is line-based - that is, each newline-terminated
line represents either a comment, a section name or a parameter.
.PP
Section and parameter names are not case sensitive.
.PP
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.
.PP
Any line beginning with a semicolon (';') or a hash ('#')
character is ignored, as are lines containing only whitespace.
.PP
Any line ending in a '\\' is continued
on the next line in the customary UNIX fashion.
.PP
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, 0/1 or true/false. Case is not significant in boolean
values, but is preserved in string values. Some items such as
create modes are numeric.
.SH "SECTION DESCRIPTIONS"
.PP
Each section in the configuration file (except for the
[global] section) describes a shared resource (known
as a "share"). The section name is the name of the
shared resource and the parameters within the section define
the shares attributes.
.PP
There are three special sections, [global],
[homes] and [printers], which are
described under \fBspecial sections\fR. The
following notes apply to ordinary section descriptions.
.PP
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.
.PP
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).
.PP
Sections may be designated \fBguest\fR services,
in which case no password is required to access them. A specified
UNIX \fBguest account\fR is used to define access
privileges in this case.
.PP
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 "user ="
option in the share definition. For modern clients such as
Windows 95/98/ME/NT/2000, this should not be necessary.
.PP
Note that 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.
.PP
The following sample section defines a file space share.
The user has write access to the path \fI/home/bar\fR.
The share is accessed via the share name "foo":
.sp
.nf
[foo]
path = /home/bar
writeable = true

.sp
.fi
.PP
The following sample section defines a printable share.
The share is readonly, but printable. That is, the only write
access permitted is via calls to open, write to and close a
spool file. The \fBguest ok\fR parameter means
access will be permitted as the default guest user (specified
elsewhere):
.sp
.nf
[aprinter]
path = /usr/spool/public
writeable = false
printable = true
guest ok = true

.sp
.fi
.SH "SPECIAL SECTIONS"
.SS "THE GLOBAL SECTION"
.PP
parameters in this section apply to the server
as a whole, or are defaults for sections which do not
specifically define certain items. See the notes
under PARAMETERS for more information.
.SS "THE HOMES SECTION"
.PP
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.
.PP
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
user name 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.
.PP
Some modifications are then made to the newly
created share:
.TP 0.2i
\(bu
The share name is changed from homes to
the located username.
.TP 0.2i
\(bu
If no path was given, the path is set to
the user's home directory.
.PP
If you decide to use a \fBpath =\fR line
in your [homes] section then you may find it useful
to use the %S macro. For example :
.PP
.PP
\fBpath = /data/pchome/%S\fR
.PP
.PP
would be useful if you have different home directories
for your PCs than for UNIX access.
.PP
.PP
This is a fast and simple way to give a large number
of clients access to their home directories with a minimum
of fuss.
.PP
.PP
A similar process occurs if the requested section
name is "homes", 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.
.PP
.PP
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:
.PP
.sp
.nf
[homes]
writeable = yes

.sp
.fi
.PP
An important point is that if guest access is specified
in the [homes] section, all home directories will be
visible to all clients \fBwithout a password\fR.
In the very unlikely event that this is actually desirable, it
would be wise to also specify \fBread only
access\fR.
.PP
.PP
Note that the \fBbrowseable\fR 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 \fBbrowseable = no\fR in
the [homes] section will hide the [homes] share but make
any auto home directories visible.
.PP
.SS "THE PRINTERS SECTION"
.PP
This section works like [homes],
but for printers.
.PP
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.
.PP
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.
.PP
A few modifications are then made to the newly created
share:
.TP 0.2i
\(bu
The share name is set to the located printer
name
.TP 0.2i
\(bu
If no printer name was given, the printer name
is set to the located printer name
.TP 0.2i
\(bu
If the share does not permit guest access and
no username was given, the username is set to the located
printer name.
.PP
Note that the [printers] service MUST be
printable - if you specify otherwise, the server will refuse
to load the configuration file.
.PP
.PP
Typically the path specified would be that of a
world-writeable spool directory with the sticky bit set on
it. A typical [printers] entry would look like
this:
.PP
.sp
.nf
[printers]
path = /usr/spool/public
guest ok = yes
printable = yes

.sp
.fi
.PP
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:
.PP
.sp
.nf
alias|alias|alias|alias...

.sp
.fi
.PP
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 then 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.
.PP
.PP
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 ('|').
.PP
.PP
NOTE: On SYSV systems which use lpstat to determine what
printers are defined on the system you may be able to use
"printcap name = lpstat" to automatically obtain a list
of printers. See the "printcap name" option
for more details.
.PP
.SH "PARAMETERS"
.PP
parameters define the specific attributes of sections.
.PP
Some parameters are specific to the [global] section
(e.g., \fBsecurity\fR). Some parameters are usable
in all sections (e.g., \fBcreate mode\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 \fBG\fR
in parentheses indicates that a parameter is specific to the
[global] section. The letter \fBS\fR
indicates that a parameter can be specified in a service specific
section. Note that all \fBS\fR parameters can also be specified in
the [global] section - in which case they will define
the default behavior for all services.
.PP
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.
.SH "VARIABLE SUBSTITUTIONS"
.PP
Many of the strings that are settable in the config file
can take substitutions. For example the option "path =
/tmp/%u" would be interpreted as "path =
/tmp/john" if the user connected with the username john.
.PP
These substitutions are mostly noted in the descriptions below,
but there are some general substitutions which apply whenever they
might be relevant. These are:
.TP
\fB%S\fR
the name of the current service, if any.
.TP
\fB%P\fR
the root directory of the current service,
if any.
.TP
\fB%u\fR
user name of the current service, if any.
.TP
\fB%g\fR
primary group name of %u.
.TP
\fB%U\fR
session user name (the user name that the client
wanted, not necessarily the same as the one they got).
.TP
\fB%G\fR
primary group name of %U.
.TP
\fB%H\fR
the home directory of the user given
by %u.
.TP
\fB%v\fR
the Samba version.
.TP
\fB%h\fR
the Internet hostname that Samba is running
on.
.TP
\fB%m\fR
the NetBIOS name of the client machine
(very useful).
.TP
\fB%L\fR
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 "dual personality".
.TP
\fB%M\fR
the Internet name of the client machine.
.TP
\fB%N\fR
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 \fB--with-automount\fR
option then this value will be the same as %L.
.TP
\fB%p\fR
the path of the service's home directory,
obtained from your NIS auto.map entry. The NIS auto.map entry
is split up as "%N:%p".
.TP
\fB%R\fR
the selected protocol level after
protocol negotiation. It can be one of CORE, COREPLUS,
LANMAN1, LANMAN2 or NT1.
.TP
\fB%d\fR
The process id of the current server
process.
.TP
\fB%a\fR
the architecture of the remote
machine. Only some are recognized, and those may not be
100% reliable. It currently recognizes Samba, WfWg, Win95,
WinNT and Win2k. Anything else will be known as
"UNKNOWN". If it gets it wrong then sending a level
3 log to samba@samba.org
<URL:mailto:samba@samba.org> should allow it to be fixed.
.TP
\fB%I\fR
The IP address of the client machine.
.TP
\fB%T\fR
the current date and time.
.TP
\fB%$(\fIenvvar\fB)\fR
The value of the environment variable
\fIenvar\fR.
.PP
There are some quite creative things that can be done
with these substitutions and other smb.conf options.
.PP
.SH "NAME MANGLING"
.PP
Samba supports "name mangling" 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.
.PP
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.
.PP
All of these options can be set separately for each service
(or globally, of course).
.PP
The options are:
.TP
\fBmangle case = yes/no\fR
controls if names that have characters that
aren't of the "default" case are mangled. For example,
if this is yes then a name like "Mail" would be mangled.
Default \fBno\fR.
.TP
\fBcase sensitive = yes/no\fR
controls whether filenames are case sensitive. If
they aren't then Samba must do a filename search and match on passed
names. Default \fBno\fR.
.TP
\fBdefault case = upper/lower\fR
controls what the default case is for new
filenames. Default \fBlower\fR.
.TP
\fBpreserve case = yes/no\fR
controls if new files are created with the
case that the client passes, or if they are forced to be the
"default" case. Default \fByes\fR.
.TP
\fBshort preserve case = yes/no\fR
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 "default"
case. This option can be use with "preserve case = yes"
to permit long filenames to retain their case, while short names
are lowercased. Default \fByes\fR.
.PP
By default, Samba 2.2 has the same semantics as a Windows
NT server, in that it is case insensitive but case preserving.
.PP
.SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
.PP
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, then the connection request is rejected. However, if one of the
steps succeeds, then the following steps are not checked.
.PP
If the service is marked "guest only = yes" then
steps 1 to 5 are skipped.
.IP 1.
If the client has passed a username/password
pair and that username/password pair is validated by the UNIX
system's password programs then the connection is made as that
username. Note that this includes the
\\\\server\\service%\fIusername\fR method of passing
a username.
.IP 2.
If the client has previously registered a username
with the system and now supplies a correct password for that
username then the connection is allowed.
.IP 3.
The client's NetBIOS name and any previously
used user names are checked against the supplied password, if
they match then the connection is allowed as the corresponding
user.
.IP 4.
If the client has previously validated a
username/password pair with the server and the client has passed
the validation token then that username is used.
.IP 5.
If a "user = " field is given in the
\fIsmb.conf\fR 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 "user =" field then the connection is made as
the username in the "user =" line. If one
of the username in the "user =" list begins with a
\&'@' then that name expands to a list of names in
the group of the same name.
.IP 6.
If the service is a guest service then a
connection is made as the username given in the "guest
account =" for the service, irrespective of the
supplied password.
.SH "COMPLETE LIST OF GLOBAL PARAMETERS"
.PP
Here is a list of all global parameters. See the section of
each parameter for details. Note that some are synonyms.
.TP 0.2i
\(bu
\fIabort shutdown script\fR
.TP 0.2i
\(bu
\fIadd printer command\fR
.TP 0.2i
\(bu
\fIadd share command\fR
.TP 0.2i
\(bu
\fIadd user script\fR
.TP 0.2i
\(bu
\fIadd machine script\fR
.TP 0.2i
\(bu
\fIallow trusted domains\fR
.TP 0.2i
\(bu
\fIannounce as\fR
.TP 0.2i
\(bu
\fIannounce version\fR
.TP 0.2i
\(bu
\fIauto services\fR
.TP 0.2i
\(bu
\fIbind interfaces only\fR
.TP 0.2i
\(bu
\fIbrowse list\fR
.TP 0.2i
\(bu
\fIchange notify timeout\fR
.TP 0.2i
\(bu
\fIchange share command\fR
.TP 0.2i
\(bu
\fIcharacter set\fR
.TP 0.2i
\(bu
\fIclient code page\fR
.TP 0.2i
\(bu
\fIcode page directory\fR
.TP 0.2i
\(bu
\fIcoding system\fR
.TP 0.2i
\(bu
\fIconfig file\fR
.TP 0.2i
\(bu
\fIdeadtime\fR
.TP 0.2i
\(bu
\fIdebug hires timestamp\fR
.TP 0.2i
\(bu
\fIdebug pid\fR
.TP 0.2i
\(bu
\fIdebug timestamp\fR
.TP 0.2i
\(bu
\fIdebug uid\fR
.TP 0.2i
\(bu
\fIdebuglevel\fR
.TP 0.2i
\(bu
\fIdefault\fR
.TP 0.2i
\(bu
\fIdefault service\fR
.TP 0.2i
\(bu
\fIdelete printer command\fR
.TP 0.2i
\(bu
\fIdelete share command\fR
.TP 0.2i
\(bu
\fIdelete user script\fR
.TP 0.2i
\(bu
\fIdfree command\fR
.TP 0.2i
\(bu
\fIdisable spoolss\fR
.TP 0.2i
\(bu
\fIdns proxy\fR
.TP 0.2i
\(bu
\fIdomain admin group\fR
.TP 0.2i
\(bu
\fIdomain guest group\fR
.TP 0.2i
\(bu
\fIdomain logons\fR
.TP 0.2i
\(bu
\fIdomain master\fR
.TP 0.2i
\(bu
\fIencrypt passwords\fR
.TP 0.2i
\(bu
\fIenhanced browsing\fR
.TP 0.2i
\(bu
\fIenumports command\fR
.TP 0.2i
\(bu
\fIgetwd cache\fR
.TP 0.2i
\(bu
\fIhide local users\fR
.TP 0.2i
\(bu
\fIhide unreadable\fR
.TP 0.2i
\(bu
\fIhomedir map\fR
.TP 0.2i
\(bu
\fIhost msdfs\fR
.TP 0.2i
\(bu
\fIhosts equiv\fR
.TP 0.2i
\(bu
\fIinterfaces\fR
.TP 0.2i
\(bu
\fIkeepalive\fR
.TP 0.2i
\(bu
\fIkernel oplocks\fR
.TP 0.2i
\(bu
\fIlanman auth\fR
.TP 0.2i
\(bu
\fIlarge readwrite\fR
.TP 0.2i
\(bu
\fIldap admin dn\fR
.TP 0.2i
\(bu
\fIldap filter\fR
.TP 0.2i
\(bu
\fIldap port\fR
.TP 0.2i
\(bu
\fIldap server\fR
.TP 0.2i
\(bu
\fIldap ssl\fR
.TP 0.2i
\(bu
\fIldap suffix\fR
.TP 0.2i
\(bu
\fIlm announce\fR
.TP 0.2i
\(bu
\fIlm interval\fR
.TP 0.2i
\(bu
\fIload printers\fR
.TP 0.2i
\(bu
\fIlocal master\fR
.TP 0.2i
\(bu
\fIlock dir\fR
.TP 0.2i
\(bu
\fIlock directory\fR
.TP 0.2i
\(bu
\fIlog file\fR
.TP 0.2i
\(bu
\fIlog level\fR
.TP 0.2i
\(bu
\fIlogon drive\fR
.TP 0.2i
\(bu
\fIlogon home\fR
.TP 0.2i
\(bu
\fIlogon path\fR
.TP 0.2i
\(bu
\fIlogon script\fR
.TP 0.2i
\(bu
\fIlpq cache time\fR
.TP 0.2i
\(bu
\fImachine password timeout\fR
.TP 0.2i
\(bu
\fImangled stack\fR
.TP 0.2i
\(bu
\fImap to guest\fR
.TP 0.2i
\(bu
\fImax disk size\fR
.TP 0.2i
\(bu
\fImax log size\fR
.TP 0.2i
\(bu
\fImax mux\fR
.TP 0.2i
\(bu
\fImax open files\fR
.TP 0.2i
\(bu
\fImax protocol\fR
.TP 0.2i
\(bu
\fImax smbd processes\fR
.TP 0.2i
\(bu
\fImax ttl\fR
.TP 0.2i
\(bu
\fImax wins ttl\fR
.TP 0.2i
\(bu
\fImax xmit\fR
.TP 0.2i
\(bu
\fImessage command\fR
.TP 0.2i
\(bu
\fImin passwd length\fR
.TP 0.2i
\(bu
\fImin password length\fR
.TP 0.2i
\(bu
\fImin protocol\fR
.TP 0.2i
\(bu
\fImin wins ttl\fR
.TP 0.2i
\(bu
\fIname resolve order\fR
.TP 0.2i
\(bu
\fInetbios aliases\fR
.TP 0.2i
\(bu
\fInetbios name\fR
.TP 0.2i
\(bu
\fInetbios scope\fR
.TP 0.2i
\(bu
\fInis homedir\fR
.TP 0.2i
\(bu
\fInt pipe support\fR
.TP 0.2i
\(bu
\fInt smb support\fR
.TP 0.2i
\(bu
\fInull passwords\fR
.TP 0.2i
\(bu
\fIobey pam restrictions\fR
.TP 0.2i
\(bu
\fIoplock break wait time\fR
.TP 0.2i
\(bu
\fIos level\fR
.TP 0.2i
\(bu
\fIos2 driver map\fR
.TP 0.2i
\(bu
\fIpam password change\fR
.TP 0.2i
\(bu
\fIpanic action\fR
.TP 0.2i
\(bu
\fIpasswd chat\fR
.TP 0.2i
\(bu
\fIpasswd chat debug\fR
.TP 0.2i
\(bu
\fIpasswd program\fR
.TP 0.2i
\(bu
\fIpassword level\fR
.TP 0.2i
\(bu
\fIpassword server\fR
.TP 0.2i
\(bu
\fIprefered master\fR
.TP 0.2i
\(bu
\fIpreferred master\fR
.TP 0.2i
\(bu
\fIpreload\fR
.TP 0.2i
\(bu
\fIprintcap\fR
.TP 0.2i
\(bu
\fIprintcap name\fR
.TP 0.2i
\(bu
\fIprinter driver file\fR
.TP 0.2i
\(bu
\fIprotocol\fR
.TP 0.2i
\(bu
\fIread bmpx\fR
.TP 0.2i
\(bu
\fIread raw\fR
.TP 0.2i
\(bu
\fIread size\fR
.TP 0.2i
\(bu
\fIremote announce\fR
.TP 0.2i
\(bu
\fIremote browse sync\fR
.TP 0.2i
\(bu
\fIrestrict anonymous\fR
.TP 0.2i
\(bu
\fIroot\fR
.TP 0.2i
\(bu
\fIroot dir\fR
.TP 0.2i
\(bu
\fIroot directory\fR
.TP 0.2i
\(bu
\fIsecurity\fR
.TP 0.2i
\(bu
\fIserver string\fR
.TP 0.2i
\(bu
\fIshow add printer wizard\fR
.TP 0.2i
\(bu
\fIshutdown script\fR
.TP 0.2i
\(bu
\fIsmb passwd file\fR
.TP 0.2i
\(bu
\fIsocket address\fR
.TP 0.2i
\(bu
\fIsocket options\fR
.TP 0.2i
\(bu
\fIsource environment\fR
.TP 0.2i
\(bu
\fIssl\fR
.TP 0.2i
\(bu
\fIssl CA certDir\fR
.TP 0.2i
\(bu
\fIssl CA certFile\fR
.TP 0.2i
\(bu
\fIssl ciphers\fR
.TP 0.2i
\(bu
\fIssl client cert\fR
.TP 0.2i
\(bu
\fIssl client key\fR
.TP 0.2i
\(bu
\fIssl compatibility\fR
.TP 0.2i
\(bu
\fIssl egd socket\fR
.TP 0.2i
\(bu
\fIssl entropy bytes\fR
.TP 0.2i
\(bu
\fIssl entropy file\fR
.TP 0.2i
\(bu
\fIssl hosts\fR
.TP 0.2i
\(bu
\fIssl hosts resign\fR
.TP 0.2i
\(bu
\fIssl require clientcert\fR
.TP 0.2i
\(bu
\fIssl require servercert\fR
.TP 0.2i
\(bu
\fIssl server cert\fR
.TP 0.2i
\(bu
\fIssl server key\fR
.TP 0.2i
\(bu
\fIssl version\fR
.TP 0.2i
\(bu
\fIstat cache\fR
.TP 0.2i
\(bu
\fIstat cache size\fR
.TP 0.2i
\(bu
\fIstrip dot\fR
.TP 0.2i
\(bu
\fIsyslog\fR
.TP 0.2i
\(bu
\fIsyslog only\fR
.TP 0.2i
\(bu
\fItemplate homedir\fR
.TP 0.2i
\(bu
\fItemplate shell\fR
.TP 0.2i
\(bu
\fItime offset\fR
.TP 0.2i
\(bu
\fItime server\fR
.TP 0.2i
\(bu
\fItimestamp logs\fR
.TP 0.2i
\(bu
\fItotal print jobs\fR
.TP 0.2i
\(bu
\fIunix extensions\fR
.TP 0.2i
\(bu
\fIunix password sync\fR
.TP 0.2i
\(bu
\fIupdate encrypted\fR
.TP 0.2i
\(bu
\fIuse mmap\fR
.TP 0.2i
\(bu
\fIuse rhosts\fR
.TP 0.2i
\(bu
\fIusername level\fR
.TP 0.2i
\(bu
\fIusername map\fR
.TP 0.2i
\(bu
\fIutmp\fR
.TP 0.2i
\(bu
\fIutmp directory\fR
.TP 0.2i
\(bu
\fIvalid chars\fR
.TP 0.2i
\(bu
\fIwinbind cache time\fR
.TP 0.2i
\(bu
\fIwinbind enum users\fR
.TP 0.2i
\(bu
\fIwinbind enum groups\fR
.TP 0.2i
\(bu
\fIwinbind gid\fR
.TP 0.2i
\(bu
\fIwinbind separator\fR
.TP 0.2i
\(bu
\fIwinbind uid\fR
.TP 0.2i
\(bu
\fIwins hook\fR
.TP 0.2i
\(bu
\fIwins proxy\fR
.TP 0.2i
\(bu
\fIwins server\fR
.TP 0.2i
\(bu
\fIwins support\fR
.TP 0.2i
\(bu
\fIworkgroup\fR
.TP 0.2i
\(bu
\fIwrite raw\fR
.SH "COMPLETE LIST OF SERVICE PARAMETERS"
.PP
Here is a list of all service parameters. See the section on
each parameter for details. Note that some are synonyms.
.TP 0.2i
\(bu
\fIadmin users\fR
.TP 0.2i
\(bu
\fIallow hosts\fR
.TP 0.2i
\(bu
\fIavailable\fR
.TP 0.2i
\(bu
\fIblocking locks\fR
.TP 0.2i
\(bu
\fIbrowsable\fR
.TP 0.2i
\(bu
\fIbrowseable\fR
.TP 0.2i
\(bu
\fIcase sensitive\fR
.TP 0.2i
\(bu
\fIcasesignames\fR
.TP 0.2i
\(bu
\fIcomment\fR
.TP 0.2i
\(bu
\fIcopy\fR
.TP 0.2i
\(bu
\fIcreate mask\fR
.TP 0.2i
\(bu
\fIcreate mode\fR
.TP 0.2i
\(bu
\fIdefault case\fR
.TP 0.2i
\(bu
\fIdefault devmode\fR
.TP 0.2i
\(bu
\fIdelete readonly\fR
.TP 0.2i
\(bu
\fIdelete veto files\fR
.TP 0.2i
\(bu
\fIdeny hosts\fR
.TP 0.2i
\(bu
\fIdirectory\fR
.TP 0.2i
\(bu
\fIdirectory mask\fR
.TP 0.2i
\(bu
\fIdirectory mode\fR
.TP 0.2i
\(bu
\fIdirectory security mask\fR
.TP 0.2i
\(bu
\fIdont descend\fR
.TP 0.2i
\(bu
\fIdos filemode\fR
.TP 0.2i
\(bu
\fIdos filetime resolution\fR
.TP 0.2i
\(bu
\fIdos filetimes\fR
.TP 0.2i
\(bu
\fIexec\fR
.TP 0.2i
\(bu
\fIfake directory create times\fR
.TP 0.2i
\(bu
\fIfake oplocks\fR
.TP 0.2i
\(bu
\fIfollow symlinks\fR
.TP 0.2i
\(bu
\fIforce create mode\fR
.TP 0.2i
\(bu
\fIforce directory mode\fR
.TP 0.2i
\(bu
\fIforce directory security mode\fR
.TP 0.2i
\(bu
\fIforce group\fR
.TP 0.2i
\(bu
\fIforce security mode\fR
.TP 0.2i
\(bu
\fIforce user\fR
.TP 0.2i
\(bu
\fIfstype\fR
.TP 0.2i
\(bu
\fIgroup\fR
.TP 0.2i
\(bu
\fIguest account\fR
.TP 0.2i
\(bu
\fIguest ok\fR
.TP 0.2i
\(bu
\fIguest only\fR
.TP 0.2i
\(bu
\fIhide dot files\fR
.TP 0.2i
\(bu
\fIhide files\fR
.TP 0.2i
\(bu
\fIhosts allow\fR
.TP 0.2i
\(bu
\fIhosts deny\fR
.TP 0.2i
\(bu
\fIinclude\fR
.TP 0.2i
\(bu
\fIinherit permissions\fR
.TP 0.2i
\(bu
\fIinvalid users\fR
.TP 0.2i
\(bu
\fIlevel2 oplocks\fR
.TP 0.2i
\(bu
\fIlocking\fR
.TP 0.2i
\(bu
\fIlppause command\fR
.TP 0.2i
\(bu
\fIlpq command\fR
.TP 0.2i
\(bu
\fIlpresume command\fR
.TP 0.2i
\(bu
\fIlprm command\fR
.TP 0.2i
\(bu
\fImagic output\fR
.TP 0.2i
\(bu
\fImagic script\fR
.TP 0.2i
\(bu
\fImangle case\fR
.TP 0.2i
\(bu
\fImangled map\fR
.TP 0.2i
\(bu
\fImangled names\fR
.TP 0.2i
\(bu
\fImangling char\fR
.TP 0.2i
\(bu
\fImap archive\fR
.TP 0.2i
\(bu
\fImap hidden\fR
.TP 0.2i
\(bu
\fImap system\fR
.TP 0.2i
\(bu
\fImax connections\fR
.TP 0.2i
\(bu
\fImax print jobs\fR
.TP 0.2i
\(bu
\fImin print space\fR
.TP 0.2i
\(bu
\fImsdfs root\fR
.TP 0.2i
\(bu
\fInt acl support\fR
.TP 0.2i
\(bu
\fIonly guest\fR
.TP 0.2i
\(bu
\fIonly user\fR
.TP 0.2i
\(bu
\fIoplock contention limit\fR
.TP 0.2i
\(bu
\fIoplocks\fR
.TP 0.2i
\(bu
\fIpath\fR
.TP 0.2i
\(bu
\fIposix locking\fR
.TP 0.2i
\(bu
\fIpostexec\fR
.TP 0.2i
\(bu
\fIpostscript\fR
.TP 0.2i
\(bu
\fIpreexec\fR
.TP 0.2i
\(bu
\fIpreexec close\fR
.TP 0.2i
\(bu
\fIpreserve case\fR
.TP 0.2i
\(bu
\fIprint command\fR
.TP 0.2i
\(bu
\fIprint ok\fR
.TP 0.2i
\(bu
\fIprintable\fR
.TP 0.2i
\(bu
\fIprinter\fR
.TP 0.2i
\(bu
\fIprinter admin\fR
.TP 0.2i
\(bu
\fIprinter driver\fR
.TP 0.2i
\(bu
\fIprinter driver location\fR
.TP 0.2i
\(bu
\fIprinter name\fR
.TP 0.2i
\(bu
\fIprinting\fR
.TP 0.2i
\(bu
\fIpublic\fR
.TP 0.2i
\(bu
\fIqueuepause command\fR
.TP 0.2i
\(bu
\fIqueueresume command\fR
.TP 0.2i
\(bu
\fIread list\fR
.TP 0.2i
\(bu
\fIread only\fR
.TP 0.2i
\(bu
\fIroot postexec\fR
.TP 0.2i
\(bu
\fIroot preexec\fR
.TP 0.2i
\(bu
\fIroot preexec close\fR
.TP 0.2i
\(bu
\fIsecurity mask\fR
.TP 0.2i
\(bu
\fIset directory\fR
.TP 0.2i
\(bu
\fIshort preserve case\fR
.TP 0.2i
\(bu
\fIstatus\fR
.TP 0.2i
\(bu
\fIstrict allocate\fR
.TP 0.2i
\(bu
\fIstrict locking\fR
.TP 0.2i
\(bu
\fIstrict sync\fR
.TP 0.2i
\(bu
\fIsync always\fR
.TP 0.2i
\(bu
\fIuse client driver\fR
.TP 0.2i
\(bu
\fIuser\fR
.TP 0.2i
\(bu
\fIusername\fR
.TP 0.2i
\(bu
\fIusers\fR
.TP 0.2i
\(bu
\fIvalid users\fR
.TP 0.2i
\(bu
\fIveto files\fR
.TP 0.2i
\(bu
\fIveto oplock files\fR
.TP 0.2i
\(bu
\fIvfs object\fR
.TP 0.2i
\(bu
\fIvfs options\fR
.TP 0.2i
\(bu
\fIvolume\fR
.TP 0.2i
\(bu
\fIwide links\fR
.TP 0.2i
\(bu
\fIwritable\fR
.TP 0.2i
\(bu
\fIwrite cache size\fR
.TP 0.2i
\(bu
\fIwrite list\fR
.TP 0.2i
\(bu
\fIwrite ok\fR
.TP 0.2i
\(bu
\fIwriteable\fR
.SH "EXPLANATION OF EACH PARAMETER"
.TP
\fBabort shutdown script (G)\fR
\fBThis parameter only exists in the HEAD cvs branch\fR
This a full path name to a script called by
\fBsmbd(8)\fRthat
should stop a shutdown procedure issued by the \fIshutdown script\fR.

This command will be run as user.

Default: \fBNone\fR.

Example: \fBabort shutdown script = /sbin/shutdown -c\fR
.TP
\fBadd printer command (G)\fR
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.

For a Samba host this means that the printer must be
physically added to the underlying printing system. The \fIadd
printer command\fR 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 \fIsmb.conf\fR file in order that it can be
shared by \fBsmbd(8)\fR
.

The \fIadd printer command\fR is
automatically invoked with the following parameter (in
order:
.RS
.TP 0.2i
\(bu
\fIprinter name\fR
.TP 0.2i
\(bu
\fIshare name\fR
.TP 0.2i
\(bu
\fIport name\fR
.TP 0.2i
\(bu
\fIdriver name\fR
.TP 0.2i
\(bu
\fIlocation\fR
.TP 0.2i
\(bu
\fIWindows 9x driver location\fR
.RE
.PP
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.
.PP
.PP
Once the \fIadd printer command\fR has
been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to determine if the share defined by the APW
exists. If the sharename is still invalid, then \fBsmbd
\fRwill return an ACCESS_DENIED error to the client.
.PP
.PP
See also \fI delete printer command\fR, \fIprinting\fR,
\fIshow add
printer wizard\fR
.PP
.PP
Default: \fBnone\fR
.PP
.PP
Example: \fBaddprinter command = /usr/bin/addprinter
\fR.PP
.TP
\fBadd share command (G)\fR
Samba 2.2.0 introduced the ability to dynamically
add and delete shares via the Windows NT 4.0 Server Manager. The
\fIadd share command\fR is used to define an
external program or script which will add a new service definition
to \fIsmb.conf\fR. In order to successfully
execute the \fIadd share command\fR, \fBsmbd\fR
requires that the administrator be connected using a root account (i.e.
uid == 0).

When executed, \fBsmbd\fR will automatically invoke the
\fIadd share command\fR with four parameters.
.RS
.TP 0.2i
\(bu
\fIconfigFile\fR - the location
of the global \fIsmb.conf\fR file.
.TP 0.2i
\(bu
\fIshareName\fR - the name of the new
share.
.TP 0.2i
\(bu
\fIpathName\fR - path to an **existing**
directory on disk.
.TP 0.2i
\(bu
\fIcomment\fR - comment string to associate
with the new share.
.RE
.PP
This parameter is only used for add file shares. To add printer shares,
see the \fIadd printer
command\fR.
.PP
.PP
See also \fIchange share
command\fR, \fIdelete share
command\fR.
.PP
.PP
Default: \fBnone\fR
.PP
.PP
Example: \fBadd share command = /usr/local/bin/addshare\fR
.PP
.TP
\fBadd machine script (G)\fR
This is the full pathname to a script that will
be run by smbd(8)when a machine is added
to it's domain using the administrator username and password method.

This option is only required when using sam back-ends tied to the
Unix uid method of RID calculation such as smbpasswd. This option is only
available in Samba 3.0.

Default: \fBadd machine script = <empty string>
\fR
Example: \fBadd machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u
\fR.TP
\fBadd user script (G)\fR
This is the full pathname to a script that will
be run \fBAS ROOT\fR by smbd(8)
under special circumstances described below.

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 smbdto create the required UNIX users
\fBON DEMAND\fR when a user accesses the Samba server.

In order to use this option, smbd
must be set to \fIsecurity = server\fR or \fI security = domain\fR and \fIadd user script\fR
must be set to a full pathname for a script that will create a UNIX
user given one argument of \fI%u\fR, which expands into
the UNIX user name to create.

When the Windows user attempts to access the Samba server,
at login (session setup in the SMB protocol) time, smbdcontacts the \fIpassword server\fR and
attempts to authenticate the given user with the given password. If the
authentication succeeds then \fBsmbd\fR
attempts to find a UNIX user in the UNIX password database to map the
Windows user into. If this lookup fails, and \fIadd user script
\fRis set then \fBsmbd\fR will
call the specified script \fBAS ROOT\fR, expanding
any \fI%u\fR argument to be the user name to create.

If this script successfully creates the user then \fBsmbd
\fRwill continue on as though the UNIX user
already existed. In this way, UNIX users are dynamically created to
match existing Windows NT accounts.

See also \fI security\fR, \fIpassword server\fR,
\fIdelete user
script\fR.

Default: \fBadd user script = <empty string>
\fR
Example: \fBadd user script = /usr/local/samba/bin/add_user
%u\fR
.TP
\fBadmin users (S)\fR
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).

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.

Default: \fBno admin users\fR

Example: \fBadmin users = jason\fR
.TP
\fBallow hosts (S)\fR
Synonym for \fIhosts allow\fR.
.TP
\fBallow trusted domains (G)\fR
This option only takes effect when the \fIsecurity\fR option is set to
server or domain.
If it is set to no, then attempts to connect to a resource from
a domain or workgroup other than the one which smbdis running
in will fail, even if that domain is trusted by the remote server
doing the authentication.

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.

Default: \fBallow trusted domains = yes\fR
.TP
\fBannounce as (G)\fR
This specifies what type of server
\fBnmbd\fR
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.

Default: \fBannounce as = NT Server\fR

Example: \fBannounce as = Win95\fR
.TP
\fBannounce version (G)\fR
This specifies the major and minor version numbers
that nmbd will use when announcing itself as a server. The default
is 4.2. Do not change this parameter unless you have a specific
need to set a Samba server to be a downlevel server.

Default: \fBannounce version = 4.5\fR

Example: \fBannounce version = 2.0\fR
.TP
\fBauto services (G)\fR
This is a synonym for the \fIpreload\fR.
.TP
\fBavailable (S)\fR
This parameter lets you "turn off" a service. If
\fIavailable = no\fR, then \fBALL\fR
attempts to connect to the service will fail. Such failures are
logged.

Default: \fBavailable = yes\fR
.TP
\fBbind interfaces only (G)\fR
This global parameter allows the Samba admin
to limit what interfaces on a machine will serve SMB requests. If
affects file service smbd(8)and
name service nmbd(8)in slightly
different ways.

For name service it causes \fBnmbd\fR to bind
to ports 137 and 138 on the interfaces listed in the interfaces parameter. \fBnmbd
\fRalso 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 \fBnmbd\fR will service
name requests on all of these sockets. If \fIbind interfaces
only\fR is set then \fBnmbd\fR 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 \fIinterfaces\fR parameter list.
As unicast packets are received on the other sockets it allows
\fBnmbd\fR to refuse to serve names to machines that
send packets that arrive through any interfaces not listed in the
\fIinterfaces\fR list. IP Source address spoofing
does defeat this simple check, however so it must not be used
seriously as a security feature for \fBnmbd\fR.

For file service it causes smbd(8)
to bind only to the interface list given in the interfaces parameter. This restricts the networks that
\fBsmbd\fR will serve to packets coming in 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.

If \fIbind interfaces only\fR is set then
unless the network address \fB127.0.0.1\fR is added
to the \fIinterfaces\fR parameter list \fBsmbpasswd(8)\fR
and \fBswat(8)\fRmay
not work as expected due to the reasons covered below.

To change a users SMB password, the \fBsmbpasswd\fR
by default connects to the \fBlocalhost - 127.0.0.1\fR
address as an SMB client to issue the password change request. If
\fIbind interfaces only\fR is set then unless the
network address \fB127.0.0.1\fR is added to the
\fIinterfaces\fR parameter list then \fB smbpasswd\fR will fail to connect in it's default mode.
\fBsmbpasswd\fR can be forced to use the primary IP interface
of the local host by using its \fI-r remote machine\fR
parameter, with \fIremote machine\fR set
to the IP name of the primary interface of the local host.

The \fBswat\fR status page tries to connect with
\fBsmbd\fR and \fBnmbd\fR at the address
\fB127.0.0.1\fR to determine if they are running.
Not adding \fB127.0.0.1\fR will cause \fB smbd\fR and \fBnmbd\fR to always show
"not running" even if they really are. This can prevent \fB swat\fR from starting/stopping/restarting \fBsmbd\fR
and \fBnmbd\fR.

Default: \fBbind interfaces only = no\fR
.TP
\fBblocking locks (S)\fR
This parameter controls the behavior of smbd(8)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.

If this parameter is set and the lock range requested
cannot be immediately satisfied, Samba 2.2 will internally
queue the lock request, and periodically attempt to obtain
the lock until the timeout period expires.

If this parameter is set to false, then
Samba 2.2 will behave as previous versions of Samba would and
will fail the lock request immediately if the lock range
cannot be obtained.

Default: \fBblocking locks = yes\fR
.TP
\fBbrowsable (S)\fR
See the \fI browseable\fR.
.TP
\fBbrowse list (G)\fR
This controls whether \fBsmbd(8)\fRwill serve a browse list to
a client doing a \fBNetServerEnum\fR call. Normally
set to true. You should never need to change
this.

Default: \fBbrowse list = yes\fR
.TP
\fBbrowseable (S)\fR
This controls whether this share is seen in
the list of available shares in a net view and in the browse list.

Default: \fBbrowseable = yes\fR
.TP
\fBcase sensitive (S)\fR
See the discussion in the section NAME MANGLING.

Default: \fBcase sensitive = no\fR
.TP
\fBcasesignames (S)\fR
Synonym for case
sensitive.
.TP
\fBchange notify timeout (G)\fR
This SMB allows a client to tell a server to
"watch" a particular directory for any changes and only reply to
the SMB request when a change has occurred. Such constant scanning of
a directory is expensive under UNIX, hence an \fBsmbd(8)\fRdaemon only performs such a scan
on each requested directory once every \fIchange notify
timeout\fR seconds.

Default: \fBchange notify timeout = 60\fR

Example: \fBchange notify timeout = 300\fR

Would change the scan time to every 5 minutes.
.TP
\fBchange share command (G)\fR
Samba 2.2.0 introduced the ability to dynamically
add and delete shares via the Windows NT 4.0 Server Manager. The
\fIchange share command\fR is used to define an
external program or script which will modify an existing service definition
in \fIsmb.conf\fR. In order to successfully
execute the \fIchange share command\fR, \fBsmbd\fR
requires that the administrator be connected using a root account (i.e.
uid == 0).

When executed, \fBsmbd\fR will automatically invoke the
\fIchange share command\fR with four parameters.
.RS
.TP 0.2i
\(bu
\fIconfigFile\fR - the location
of the global \fIsmb.conf\fR file.
.TP 0.2i
\(bu
\fIshareName\fR - the name of the new
share.
.TP 0.2i
\(bu
\fIpathName\fR - path to an **existing**
directory on disk.
.TP 0.2i
\(bu
\fIcomment\fR - comment string to associate
with the new share.
.RE
.PP
This parameter is only used modify existing file shares definitions. To modify
printer shares, use the "Printers..." folder as seen when browsing the Samba host.
.PP
.PP
See also \fIadd share
command\fR, \fIdelete
share command\fR.
.PP
.PP
Default: \fBnone\fR
.PP
.PP
Example: \fBchange share command = /usr/local/bin/addshare\fR
.PP
.TP
\fBcharacter set (G)\fR
This allows smbdto map incoming filenames
from a DOS Code page (see the client
code page parameter) to several built in UNIX character sets.
The built in code page translations are:
.RS
.TP 0.2i
\(bu
ISO8859-1 : Western European
UNIX character set. The parameter \fIclient code page\fR
\fBMUST\fR be set to code page 850 if the
\fIcharacter set\fR parameter is set to
ISO8859-1 in order for the conversion to the
UNIX character set to be done correctly.
.TP 0.2i
\(bu
ISO8859-2 : Eastern European
UNIX character set. The parameter \fIclient code page
\fR\fBMUST\fR be set to code page 852 if
the \fI character set\fR parameter is set
to ISO8859-2 in order for the conversion
to the UNIX character set to be done correctly.
.TP 0.2i
\(bu
ISO8859-5 : Russian Cyrillic
UNIX character set. The parameter \fIclient code page
\fR\fBMUST\fR be set to code page
866 if the \fIcharacter set \fR parameter is
set to ISO8859-5 in order for the conversion
to the UNIX character set to be done correctly.
.TP 0.2i
\(bu
ISO8859-7 : Greek UNIX
character set. The parameter \fIclient code page
\fR\fBMUST\fR be set to code page
737 if the \fIcharacter set\fR parameter is
set to ISO8859-7 in order for the conversion
to the UNIX character set to be done correctly.
.TP 0.2i
\(bu
KOI8-R : Alternate mapping
for Russian Cyrillic UNIX character set. The parameter
\fIclient code page\fR \fBMUST\fR
be set to code page 866 if the \fIcharacter set\fR
parameter is set to KOI8-R in order for the
conversion to the UNIX character set to be done correctly.
.RE
.PP
\fBBUG\fR. These MSDOS code page to UNIX character
set mappings should be dynamic, like the loading of MS DOS code pages,
not static.
.PP
.PP
Normally this parameter is not set, meaning no filename
translation is done.
.PP
.PP
Default: \fBcharacter set = <empty string>\fR
.PP
.PP
Example: \fBcharacter set = ISO8859-1\fR
.PP
.TP
\fBclient code page (G)\fR
This parameter specifies the DOS code page
that the clients accessing Samba are using. To determine what code
page a Windows or DOS client is using, open a DOS command prompt
and type the command \fBchcp\fR. This will output
the code page. The default for USA MS-DOS, Windows 95, and
Windows NT releases is code page 437. The default for western
European releases of the above operating systems is code page 850.

This parameter tells smbd(8)
which of the \fIcodepage.XXX
\fRfiles to dynamically load on startup. These files,
described more fully in the manual page \fBmake_smbcodepage(1)\fR, tell \fB smbd\fR how to map lower to upper case characters to provide
the case insensitivity of filenames that Windows clients expect.

Samba currently ships with the following code page files :
.RS
.TP 0.2i
\(bu
Code Page 437 - MS-DOS Latin US
.TP 0.2i
\(bu
Code Page 737 - Windows '95 Greek
.TP 0.2i
\(bu
Code Page 850 - MS-DOS Latin 1
.TP 0.2i
\(bu
Code Page 852 - MS-DOS Latin 2
.TP 0.2i
\(bu
Code Page 861 - MS-DOS Icelandic
.TP 0.2i
\(bu
Code Page 866 - MS-DOS Cyrillic
.TP 0.2i
\(bu
Code Page 932 - MS-DOS Japanese SJIS
.TP 0.2i
\(bu
Code Page 936 - MS-DOS Simplified Chinese
.TP 0.2i
\(bu
Code Page 949 - MS-DOS Korean Hangul
.TP 0.2i
\(bu
Code Page 950 - MS-DOS Traditional Chinese
.RE
.PP
Thus this parameter may have any of the values 437, 737, 850, 852,
861, 932, 936, 949, or 950. If you don't find the codepage you need,
read the comments in one of the other codepage files and the
\fBmake_smbcodepage(1)\fR man page and write one. Please
remember to donate it back to the Samba user community.
.PP
.PP
This parameter co-operates with the \fIvalid
chars\fR parameter in determining what characters are
valid in filenames and how capitalization is done. If you set both
this parameter and the \fIvalid chars\fR parameter
the \fIclient code page\fR parameter
\fBMUST\fR be set before the \fIvalid
chars\fR parameter in the \fIsmb.conf\fR
file. The \fIvalid chars\fR string will then
augment the character settings in the \fIclient code page\fR
parameter.
.PP
.PP
If not set, \fIclient code page\fR defaults
to 850.
.PP
.PP
See also : \fIvalid
chars\fR, \fIcode page directory\fR
.PP
.PP
Default: \fBclient code page = 850\fR
.PP
.PP
Example: \fBclient code page = 936\fR
.PP
.TP
\fBcode page directory (G)\fR
Define the location of the various client code page
files.

See also the \fIprinting
\fRparameter.

Default: Currently no default value is given to
this string, unless the value of the \fIprinting\fR
parameter is SYSV, in which case the default is :

\fBlp -i %p-%j -H hold\fR

or if the value of the \fIprinting\fR parameter
is SOFTQ, then the default is:

\fBqstat -s -j%j -h\fR

Example for HPUX: \fBlppause command = /usr/bin/lpalt
%p-%j -p0\fR
.TP
\fBlpq cache time (G)\fR
This controls how long lpq info will be cached
for to prevent the \fBlpq\fR command being called too
often. A separate cache is kept for each variation of the \fB lpq\fR command used by the system, so if you use different
\fBlpq\fR commands for different users then they won't
share cache information.

The cache files are stored in \fI/tmp/lpq.xxxx\fR
where xxxx is a hash of the \fBlpq\fR command in use.

The default is 10 seconds, meaning that the cached results
of a previous identical \fBlpq\fR command will be used
if the cached data is less than 10 seconds old. A large value may
be advisable if your \fBlpq\fR command is very slow.

A value of 0 will disable caching completely.

See also the \fIprinting
\fRparameter.

Default: \fBlpq cache time = 10\fR

Example: \fBlpq cache time = 30\fR
.TP
\fBlpq command (S)\fR
This parameter specifies the command to be
executed on the server host in order to obtain \fBlpq
\fR-style printer status information.

This command should be a program or script which
takes a printer name as its only parameter and outputs printer
status information.

Currently eight styles of printer status information
are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX and SOFTQ.
This covers most UNIX systems. You control which type is expected
using the \fIprinting =\fR option.

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.

If a \fI%p\fR is given then the printer name
is put in its place. Otherwise it is placed at the end of the
command.

Note that it is good practice to include the absolute path
in the \fIlpq command\fR as the \fB$PATH
\fRmay not be available to the server.

See also the \fIprinting
\fRparameter.

Default: \fBdepends on the setting of \fI printing\fB\fR

Example: \fBlpq command = /usr/bin/lpq -P%p\fR
.TP
\fBlpresume command (S)\fR
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.

This command should be a program or script which takes
a printer name and job number to resume the print job. See
also the \fIlppause command
\fRparameter.

If a \fI%p\fR is given then the printer name
is put in its place. A \fI%j\fR is replaced with
the job number (an integer).

Note that it is good practice to include the absolute path
in the \fIlpresume command\fR as the PATH may not
be available to the server.

See also the \fIprinting
\fRparameter.

Default: Currently no default value is given
to this string, unless the value of the \fIprinting\fR
parameter is SYSV, in which case the default is :

\fBlp -i %p-%j -H resume\fR

or if the value of the \fIprinting\fR parameter
is SOFTQ, then the default is:

\fBqstat -s -j%j -r\fR

Example for HPUX: \fBlpresume command = /usr/bin/lpalt
%p-%j -p2\fR
.TP
\fBlprm command (S)\fR
This parameter specifies the command to be
executed on the server host in order to delete a print job.

This command should be a program or script which takes
a printer name and job number, and deletes the print job.

If a \fI%p\fR is given then the printer name
is put in its place. A \fI%j\fR is replaced with
the job number (an integer).

Note that it is good practice to include the absolute
path in the \fIlprm command\fR as the PATH may not be
available to the server.

See also the \fIprinting
\fRparameter.

Default: \fBdepends on the setting of \fIprinting
\fB\fR
Example 1: \fBlprm command = /usr/bin/lprm -P%p %j
\fR
Example 2: \fBlprm command = /usr/bin/cancel %p-%j
\fR.TP
\fBmachine password timeout (G)\fR
If a Samba server is a member of a Windows
NT Domain (see the security = domain)
parameter) then periodically a running smbd(8)process will try and change the MACHINE ACCOUNT
PASSWORD stored in the TDB called \fIprivate/secrets.tdb
\fR\&. 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.

See also \fBsmbpasswd(8)
\fR, and the security = domain) parameter.

Default: \fBmachine password timeout = 604800\fR
.TP
\fBmagic output (S)\fR
This parameter specifies the name of a file
which will contain output created by a magic script (see the
\fImagic script\fR
parameter below).

Warning: If two clients use the same \fImagic script
\fRin the same directory the output file content
is undefined.

Default: \fBmagic output = <magic script name>.out
\fR
Example: \fBmagic output = myfile.txt\fR
.TP
\fBmagic script (S)\fR
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.

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.

If the script generates output, output will be sent to
the file specified by the \fI magic output\fR parameter (see above).

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
\fBas is\fR on the host, which for some hosts and
some shells will require filtering at the DOS end.

Magic scripts are \fBEXPERIMENTAL\fR and
should \fBNOT\fR be relied upon.

Default: \fBNone. Magic scripts disabled.\fR

Example: \fBmagic script = user.csh\fR
.TP
\fBmangle case (S)\fR
See the section on NAME MANGLING

Default: \fBmangle case = no\fR
.TP
\fBmangled map (S)\fR
This is for those who want to directly map UNIX
file names which cannot be represented on Windows/DOS. The mangling
of names is not always what is needed. In particular you may have
documents with file extensions that differ between DOS and UNIX.
For example, under UNIX it is common to use \fI.html\fR
for HTML files, whereas under Windows/DOS \fI.htm\fR
is more commonly used.

So to map \fIhtml\fR to \fIhtm\fR
you would use:

\fBmangled map = (*.html *.htm)\fR

One very useful case is to remove the annoying \fI;1
\fRoff the ends of filenames on some CDROMs (only visible
under some UNIXes). To do this use a map of (*;1 *;).

Default: \fBno mangled map\fR

Example: \fBmangled map = (*;1 *;)\fR
.TP
\fBmangled names (S)\fR
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.

See the section on NAME MANGLING for details on how to control the mangling process.

If mangling is used then the mangling algorithm is as follows:
.RS
.TP 0.2i
\(bu
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.
.TP 0.2i
\(bu
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.

Note that the character to use may be specified using
the \fImangling char\fR
option, if you don't like '~'.
.TP 0.2i
\(bu
The first three alphanumeric characters of the final
extension are preserved, forced to upper case and appear as the
extension of the mangled name. The final extension is defined as that
part of the original filename after the rightmost dot. If there are no
dots in the filename, the mangled name will have no extension (except
in the case of "hidden files" - see below).
.TP 0.2i
\(bu
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).
.RE
.PP
The two-digit hash value consists of upper case
alphanumeric characters.
.PP
.PP
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.
.PP
.PP
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.
.PP
.PP
Default: \fBmangled names = yes\fR
.PP
.TP
\fBmangled stack (G)\fR
This parameter controls the number of mangled names
that should be cached in the Samba server smbd(8).

This stack is a list of recently mangled base names
(extensions are only maintained if they are longer than 3 characters
or contains upper case characters).

The larger this value, the more likely it is that mangled
names can be successfully converted to correct long UNIX names.
However, large stack sizes will slow most directory accesses. Smaller
stacks save memory in the server (each stack element costs 256 bytes).

It is not possible to absolutely guarantee correct long
filenames, so be prepared for some surprises!

Default: \fBmangled stack = 50\fR

Example: \fBmangled stack = 100\fR
.TP
\fBmangling char (S)\fR
This controls what character is used as
the \fBmagic\fR character in name mangling. The default is a '~'
but this may interfere with some software. Use this option to set
it to whatever you prefer.

Default: \fBmangling char = ~\fR

Example: \fBmangling char = ^\fR
.TP
\fBmap archive (S)\fR
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 it 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...

Note that this requires the \fIcreate mask\fR
parameter to be set such that owner execute bit is not masked out
(i.e. it must include 100). See the parameter \fIcreate mask\fR for details.

Default: \fBmap archive = yes\fR
.TP
\fBmap hidden (S)\fR
This controls whether DOS style hidden files
should be mapped to the UNIX world execute bit.

Note that this requires the \fIcreate mask\fR
to be set such that the world execute bit is not masked out (i.e.
it must include 001). See the parameter \fIcreate mask\fR for details.

Default: \fBmap hidden = no\fR
.TP
\fBmap system (S)\fR
This controls whether DOS style system files
should be mapped to the UNIX group execute bit.

Note that this requires the \fIcreate mask\fR
to be set such that the group execute bit is not masked out (i.e.
it must include 010). See the parameter \fIcreate mask\fR for details.

Default: \fBmap system = no\fR
.TP
\fBmap to guest (G)\fR
This parameter is only useful in security modes other than \fIsecurity = share\fR
- i.e. user, server,
and domain.

This parameter can take three different values, which tell
smbd(8)what to do with user
login requests that don't match a valid UNIX user in some way.

The three settings are :
.RS
.TP 0.2i
\(bu
Never - Means user login
requests with an invalid password are rejected. This is the
default.
.TP 0.2i
\(bu
Bad User - 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 \fI guest account\fR.
.TP 0.2i
\(bu
Bad Password - Means user logins
with an invalid password are treated as a guest login and mapped
into the guest account. 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
\fBhate\fR you if you set the \fImap to
guest\fR parameter this way :-).
.RE
.PP
Note that this parameter is needed to set up "Guest"
share services when using \fIsecurity\fR modes other than
share. This is because in these modes the name of the resource being
requested is \fBnot\fR 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.
.PP
.PP
For people familiar with the older Samba releases, this
parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h.
.PP
.PP
Default: \fBmap to guest = Never\fR
.PP
.PP
Example: \fBmap to guest = Bad User\fR
.PP
.TP
\fBmax connections (S)\fR
This option allows the number of simultaneous
connections to a service to be limited. If \fImax connections
\fRis 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.

Record lock files are used to implement this feature. The
lock files will be stored in the directory specified by the \fIlock directory\fR
option.

Default: \fBmax connections = 0\fR

Example: \fBmax connections = 10\fR
.TP
\fBmax disk size (G)\fR
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.

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 \fImax
disk size\fR.

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.

A \fImax disk size\fR of 0 means no limit.

Default: \fBmax disk size = 0\fR

Example: \fBmax disk size = 1000\fR
.TP
\fBmax log size (G)\fR
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 \fI.old\fR extension.

A size of 0 means no limit.

Default: \fBmax log size = 5000\fR

Example: \fBmax log size = 1000\fR
.TP
\fBmax mux (G)\fR
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.

Default: \fBmax mux = 50\fR
.TP
\fBmax open files (G)\fR
This parameter limits the maximum number of
open files that one smbd(8)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.

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.

Default: \fBmax open files = 10000\fR
.TP
\fBmax print jobs (S)\fR
This parameter limits the maximum number of
jobs allowable in a Samba printer queue at any given moment.
If this number is exceeded, \fB smbd(8)\fRwill remote "Out of Space" to the client.
See all \fItotal
print jobs\fR.

Default: \fBmax print jobs = 1000\fR

Example: \fBmax print jobs = 5000\fR
.TP
\fBmax protocol (G)\fR
The value of the parameter (a string) is the highest
protocol level that will be supported by the server.

Possible values are :
.RS
.TP 0.2i
\(bu
CORE: Earliest version. No
concept of user names.
.TP 0.2i
\(bu
COREPLUS: Slight improvements on
CORE for efficiency.
.TP 0.2i
\(bu
LANMAN1: First \fB modern\fR version of the protocol. Long filename
support.
.TP 0.2i
\(bu
LANMAN2: Updates to Lanman1 protocol.
.TP 0.2i
\(bu
NT1: Current up to date version of
the protocol. Used by Windows NT. Known as CIFS.
.RE
.PP
Normally this option should not be set as the automatic
negotiation phase in the SMB protocol takes care of choosing
the appropriate protocol.
.PP
.PP
See also \fImin
protocol\fR
.PP
.PP
Default: \fBmax protocol = NT1\fR
.PP
.PP
Example: \fBmax protocol = LANMAN1\fR
.PP
.TP
\fBmax smbd processes (G)\fR
This parameter limits the maximum number of
\fBsmbd(8)\fR
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 smbdassociated with him or her
to handle connections to all shares from a given host.

Default: \fBmax smbd processes = 0\fR ## no limit

Example: \fBmax smbd processes = 1000\fR
.TP
\fBmax ttl (G)\fR
This option tells nmbd(8)
what the default 'time to live' of NetBIOS names should be (in seconds)
when \fBnmbd\fR 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.

Default: \fBmax ttl = 259200\fR
.TP
\fBmax wins ttl (G)\fR
This option tells nmbd(8)
when acting as a WINS server ( \fIwins support = yes\fR) what the maximum
\&'time to live' of NetBIOS names that \fBnmbd\fR
will grant will be (in seconds). You should never need to change this
parameter. The default is 6 days (518400 seconds).

See also the \fImin
wins ttl\fR parameter.

Default: \fBmax wins ttl = 518400\fR
.TP
\fBmax xmit (G)\fR
This option controls the maximum packet size
that will be negotiated by Samba. The default is 65535, which
is the maximum. In some cases you may find you get better performance
with a smaller value. A value below 2048 is likely to cause problems.

Default: \fBmax xmit = 65535\fR

Example: \fBmax xmit = 8192\fR
.TP
\fBmessage command (G)\fR
This specifies what command to run when the
server receives a WinPopup style message.

This would normally be a command that would
deliver the message somehow. How this is to be done is
up to your imagination.

An example is:

\fBmessage command = csh -c 'xedit %s;rm %s' &\fR

This delivers the message using \fBxedit\fR, then
removes it afterwards. \fBNOTE 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).

All messages are delivered as the global guest user.
The command takes the standard substitutions, although \fI %u\fR won't work (\fI%U\fR may be better
in this case).

Apart from the standard substitutions, some additional
ones apply. In particular:
.RS
.TP 0.2i
\(bu
\fI%s\fR = the filename containing
the message.
.TP 0.2i
\(bu
\fI%t\fR = the destination that
the message was sent to (probably the server name).
.TP 0.2i
\(bu
\fI%f\fR = who the message
is from.
.RE
.PP
You could make this command send mail, or whatever else
takes your fancy. Please let us know of any really interesting
ideas you have.
.PP
.PP
Here's a way of sending the messages as mail to root:
.PP
.PP
\fBmessage command = /bin/mail -s 'message from %f on
%m' root < %s; rm %s\fR
.PP
.PP
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.
.PP
.PP
If you want to silently delete it then try:
.PP
.PP
\fBmessage command = rm %s\fR
.PP
.PP
Default: \fBno message command\fR
.PP
.PP
Example: \fBmessage command = csh -c 'xedit %s;
rm %s' &\fR
.PP
.TP
\fBmin passwd length (G)\fR
Synonym for \fImin password length\fR.
.TP
\fBmin password length (G)\fR
This option sets the minimum length in characters
of a plaintext password that \fBsmbd\fR will accept when performing
UNIX password changing.

See also \fIunix
password sync\fR, \fIpasswd program\fR and \fIpasswd chat debug\fR
\&.

Default: \fBmin password length = 5\fR
.TP
\fBmin print space (S)\fR
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.

See also the \fIprinting
\fRparameter.

Default: \fBmin print space = 0\fR

Example: \fBmin print space = 2000\fR
.TP
\fBmin protocol (G)\fR
The value of the parameter (a string) is the
lowest SMB protocol dialect than Samba will support. Please refer
to the \fImax protocol\fR
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
\fIsource/smbd/negprot.c\fR for a listing of known protocol
dialects supported by clients.

If you are viewing this parameter as a security measure, you should
also refer to the \fIlanman
auth\fR parameter. Otherwise, you should never need
to change this parameter.

Default : \fBmin protocol = CORE\fR

Example : \fBmin protocol = NT1\fR # disable DOS
clients
.TP
\fBmin wins ttl (G)\fR
This option tells nmbd(8)
when acting as a WINS server (\fI wins support = yes\fR) what the minimum 'time to live'
of NetBIOS names that \fBnmbd\fR will grant will be (in
seconds). You should never need to change this parameter. The default
is 6 hours (21600 seconds).

Default: \fBmin wins ttl = 21600\fR
.TP
\fBmsdfs root (S)\fR
This boolean parameter is only available if
Samba is configured and compiled with the \fB --with-msdfs\fR option. If set to yes,
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 \fImsdfs:serverA\\shareA,serverB\\shareB
\fRand so on. For more information on setting up a Dfs tree
on Samba, refer to msdfs_setup.html
.

See also \fIhost msdfs
\fR
Default: \fBmsdfs root = no\fR
.TP
\fBname resolve order (G)\fR
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. The option takes a space
separated string of name resolution options.

The options are :"lmhosts", "host", "wins" and "bcast". They
cause names to be resolved as follows :
.RS
.TP 0.2i
\(bu
lmhosts : 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 lmhosts(5)for details) then
any name type matches for lookup.
.TP 0.2i
\(bu
host : Do a standard host
name to IP address resolution, using the system \fI/etc/hosts
\fR, 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 \fI/etc/nsswitch.conf\fR
file. Note that this method is only used if the NetBIOS name
type being queried is the 0x20 (server) name type, otherwise
it is ignored.
.TP 0.2i
\(bu
wins : Query a name with
the IP address listed in the \fI wins server\fR parameter. If no WINS server has
been specified this method will be ignored.
.TP 0.2i
\(bu
bcast : Do a broadcast on
each of the known local interfaces listed in the \fIinterfaces\fR
parameter. This is the least reliable of the name resolution
methods as it depends on the target host being on a locally
connected subnet.
.RE
.PP
Default: \fBname resolve order = lmhosts host wins bcast
\fR.PP
.PP
Example: \fBname resolve order = lmhosts bcast host
\fR.PP
.PP
This will cause the local lmhosts file to be examined
first, followed by a broadcast attempt, followed by a normal
system hostname lookup.
.PP
.TP
\fBnetbios aliases (G)\fR
This is a list of NetBIOS names that nmbd(8)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.