preserved in string values. Some items such as create modes are
numeric.
-label(SERVICEDESCRIPTIONS)
-manpagesection(SERVICE DESCRIPTIONS)
+label(SECTIONDESCRIPTIONS)
+manpagesection(SECTION DESCRIPTIONS)
-Each section in the configuration file describes a service. The
-section name is the service name and the parameters within the section
-define the service's attributes.
+Each section in the configuration file (except for the
+link(bf([global]))(global) section) describes a shared resource (known
+as a em("share")). The section name is the name of the shared resource
+and the parameters within the section define the shares attributes.
There are three special sections, link(bf([global]))(global),
link(bf([homes]))(homes) and link(bf([printers]))(printers), which are
described under link(bf('special sections'))(specialsections). The
-following notes apply to ordinary service descriptions.
+following notes apply to ordinary section descriptions.
-A service consists of a directory to which access is being given plus
+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.
-Services are either filespace services (used by the client as an
+Sections are either filespace 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).
-Services may be guest services, in which case no password is required
-to access them. A specified UNIX guest account is used to define
-access privileges in this case.
+Sections may be designated link(bf(guest))(guestok) services, in which
+case no password is required to access them. A specified UNIX
+link(bf(guest account))(guestaccount) is used to define access
+privileges in this case.
-Services other than guest services will require a password to access
+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 link(bf("user="))(user) option in
-the service definition. For modern clients such as Windows 95/98 and
+the share definition. For modern clients such as Windows 95/98 and
Windows NT, this should not be neccessary.
Note that the access rights granted by the server are masked by the
system. The server does not grant more access than the host system
grants.
-The following sample section defines a file space service. The user
-has write access to the path tt(/home/bar). The service is accessed via
-the service name "foo":
+The following sample section defines a file space share. The user has
+write access to the path tt(/home/bar). The share is accessed via
+the share name "foo":
verb(
)
-The following sample section defines a printable service. The service
+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
link(bf('guest ok'))(guestok) parameter means access will be permitted
path = /usr/spool/public
read only = true
printable = true
- public = true
+ guest ok = true
)
label(SPECIALSECTIONS)
dit(bf(The [global] section))
Parameters in this section apply to the server as a whole, or are
-defaults for services which do not specifically define certain
+defaults for sections which do not specifically define certain
items. See the notes under link(bf('Parameters'))(Parameters) for more
information.
services connecting clients to their home directories can be created
on the fly by the server.
-When the connection request is made, the existing services are
+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 service name is treated as a user name and looked up in the
-local passwords file. If the name exists and the correct password has
-been given, a service is created by cloning the [homes] section.
+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.
-Some modifications are then made to the newly created section:
+Some modifications are then made to the newly created share:
startit()
-it() The service name is changed from tt('homes') to the located
+it() The share name is changed from tt('homes') to the located
username
it() If no path was given, the path is set to the user's home
This is a fast and simple way to give a large number of clients access
to their home directories with a minimum of fuss.
-A similar process occurs if the requested service name is tt("homes"),
-except that the service name is not changed to that of the requesting
+A similar process occurs if the requested section name is tt("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.
Note that the link(bf(browseable))(browseable) 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
-browseable=no in the [homes] section will hide the [homes] service but
+browseable=no in the [homes] section will hide the [homes] share but
make any auto home directories visible.
label(printers)
able to connect to any printer specified in the local host's printcap
file.
-When a connection request is made, the existing services are
+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
link(bf([homes]))(homes) section exists, it is used as described
-above. Otherwise, the requested service name is treated as a printer
+above. Otherwise, the requested section name is treated as a printer
name and the appropriate printcap file is scanned to see if the
-requested service name is a valid printer name. If a match is found, a
-new service is created by cloning the [printers] section.
+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.
-A few modifications are then made to the newly created section:
+A few modifications are then made to the newly created share:
startit()
-it() The service name is set to the located printer name
+it() The share name is set to the located printer name
it() If no printer name was given, the printer name is set to the
located printer name
-it() If the service does not permit guest access and no username was
+it() If the share does not permit guest access and no username was
given, the username is set to the located printer name.
endit()
[printers]
path = /usr/spool/public
writable = no
- public = yes
+ guest ok = yes
printable = yes
)
label(PARAMETERS)
manpagesection(PARAMETERS)
-Parameters define the specific attributes of services.
+Parameters define the specific attributes of sections.
Some parameters are specific to the link(bf([global]))(global) section
(eg., link(bf(security))(security)). Some parameters are usable in
it() bf(%h) = the internet hostname that Samba is running on.
label(percentm)
-it() bf(%m) = the netbios name of the client machine (very useful).
+it() bf(%m) = the NetBIOS name of the client machine (very useful).
label(percentL)
-it() bf(%L) = the netbios name of the server. This allows you to change your
+it() bf(%L) = 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".
label(percentd)
it() bf(%d) = The process id of the current server process.
-label(percenta)
-it() bf(%a) = the architecture of the remote machine. Only some are recognised,
-and those may not be 100% reliable. It currently recognises Samba,
-WfWg, WinNT and Win95. Anything else will be known as "UNKNOWN". If it
-gets it wrong then sending a level 3 log to
-email(samba-bugs@samba.anu.edu.au) should allow it to be fixed.
+label(percenta)
+it() bf(%a) = the architecture of the remote
+machine. Only some are recognised, and those may not be 100%
+reliable. It currently recognises Samba, WfWg, WinNT and
+Win95. Anything else will be known as "UNKNOWN". If it gets it wrong
+then sending a level 3 log to email(samba-bugs@samba.anu.edu.au)
+should allow it to be fixed.
label(percentI)
it() bf(%I) = The IP address of the client machine.
it() link(bf(domain master))(domainmaster)
-it() link(bf(domain sid))(domainsid)
-
it() link(bf(encrypt passwords))(encryptpasswords)
it() link(bf(getwd cache))(getwdcache)
file permissions.
bf(Default:) nl()
- no admin users
+ no admin users
bf(Example:) nl()
admin users = jason
Note that access still requires suitable user-level passwords.
-See utl(bf(testparm (1)))(testparm.1.html) for a way of testing your
+See url(bf(testparm (1)))(testparm.1.html) for a way of testing your
host access to see if it does what you expect.
bf(Default:)
- none (i.e., all hosts permitted access)
+ none (i.e., all hosts permitted access)
bf(Example:)
- allow hosts = 150.203.5. localhost myhost.mynet.edu.au
+ allow hosts = 150.203.5. localhost myhost.mynet.edu.au
label(alternatepermissions)
dit(bf(alternate permissions (S)))
servers from participating as browser servers correctly.
bf(Default:)
- announce as = NT
+ announce as = NT
bf(Example)
- announce as = Win95
+ announce as = Win95
label(announceversion)
dit(bf(announce version (G)))
to be a downlevel server.
bf(Default:)
- announce version = 4.2
+ announce version = 4.2
bf(Example:)
- announce version = 2.0
+ announce version = 2.0
label(autoservices)
are logged.
bf(Default:)
- available = yes
+ available = yes
bf(Example:)
- available = no
+ available = no
label(bindinterfacesonly)
dit(bf(bind interfaces only (G)))
of the local host.
bf(Default:)
- bind interfaces only = False
+ bind interfaces only = False
bf(Example:)
- bind interfaces only = True
+ bind interfaces only = True
label(blockinglocks)
dit(bf(blocking locks (S)))
This parameter can be set per share.
bf(Default:)
- blocking locks = True
+ blocking locks = True
bf(Example:)
- blocking locks = False
+ blocking locks = False
label(browsable)
dit(bf(broweable (S)))
bf(change notify timeout) is specified in units of seconds.
bf(Default:)
- change notify timeout = 60
+ change notify timeout = 60
bf(Example:)
- change notify timeout = 300
+ change notify timeout = 300
- Would change the scan time to every 5 minutes.
+Would change the scan time to every 5 minutes.
label(characterset)
dit(bf(character set (G)))
See also : link(bf("valid chars"))(validchars)
bf(Default:)
-
client code page = 850
bf(Example:)
-
client code page = 936
label(codingsystem)
-dit(bf(codingsystem))
+dit(bf(codingsystem (G)))
This parameter is used to determine how incoming Shift-JIS Japanese
characters are mapped from the incoming link(bf("client code
name then see the server string command.
bf(Default:)
-
No comment string
bf(Example:)
-
comment = Fred's Files
label(configfile)
to special case the config files of just a few clients).
bf(Example:)
-
tt( config file = /usr/local/samba/lib/smb.conf.%m)
label(copy)
in the configuration file than the service doing the copying.
bf(Default:)
- none
+ none
bf(Example:)
- copy = otherservice
+ copy = otherservice
label(createmode)
dit(bf(create mask (S)))
mode bits on created directories.
bf(Default:)
- create mask = 0744
+ create mask = 0744
bf(Example:)
- create mask = 0775
+ create mask = 0775
-.SS create mode (S)
-See
-.B create mask.
+label(createmode)
+dit(bf(create mode (S)))
+
+This is a synonym for link(bf(create mask))(createmask).
-.SS deadtime (G)
-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.
+label(deadtime)
+dit(bf(deadtime (G)))
+
+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.
This is useful to stop a server's resources being exhausted by a large
number of inactive connections.
-Most clients have an auto-reconnect feature when a connection is broken so
-in most cases this parameter should be transparent to users.
+Most clients have an auto-reconnect feature when a connection is
+broken so in most cases this parameter should be transparent to users.
Using this parameter with a timeout of a few minutes is recommended
for most systems.
-A deadtime of zero indicates that no auto-disconnection should be performed.
+A deadtime of zero indicates that no auto-disconnection should be
+performed.
-.B Default:
- deadtime = 0
+ bf(Default:)
+ deadtime = 0
+
+ bf(Example:)
+ deadtime = 15
+
+label(debug timestamp (G))
+
+Samba2.0 debug log messages are timestamped by default. If you
+are running at a high debug level these timestamps can be
+distracting. This boolean parameter allows them to be turned
+off.
+
+ bf(Default:)
+ debug timestamp = Yes
+
+ bf(Example:)
+ debug timestamp = No
+
+label(debuglevel)
+dit(bf(debug level (G)))
-.B Example:
- deadtime = 15
-.SS debug level (G)
The value of the parameter (an integer) allows the debug level
-(logging level) to be specified in the
-.B smb.conf
-file. This is to give
-greater flexibility in the configuration of the system.
+(logging level) to be specified in the bf(smb.conf) file. This is to
+give greater flexibility in the configuration of the system.
-The default will be the debug level specified on the command line.
+The default will be the debug level specified on the command line
+or level zero if none was specified.
-.B Example:
- debug level = 3
-.SS default (G)
-See
-.B default service.
-.SS default case (S)
+ bf(Example:)
+ debug level = 3
-See the section on "NAME MANGLING" Also note the addition of "short
-preserve case"
+label(default)
+dit(bf(default (G)))
-.SS default service (G)
-A synonym for this parameter is 'default'.
+A synonym for link(bf(default service))(defaultservice).
-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 NOT given in the parameter value (see example below).
+label(defaultcase)
+dit(bf(default case (S)))
-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.
+See the section on link(bf("NAME MANGLING"))(NAMEMANGLING). Also note
+the link(bf("short preserve case"))(shortpreservecase) parameter.
-Typically the default service would be a public, read-only service.
+label(default service)
+dit(bf(default service (G)))
-Also note that as of 1.9.14 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 %S to make a wildcard service.
+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 em(NOT) given in the parameter value (see example
+below).
-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.
+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.
+Typically the default service would be a link(bf(guest ok))(guestok),
+link(bf(read-only))(readonly) service.
-.B Example:
- default service = pub
-
- [pub]
- path = /%S
-
+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 link(bf(%S))(percentS) to make a wildcard service.
-.SS delete readonly (S)
-This parameter allows readonly files to be deleted. This is not normal DOS
-semantics, but is allowed by UNIX.
+Note also that any tt('_') characters in the name of the service used
+in the default service will get mapped to a tt('/'). This allows for
+interesting things.
-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.
-.B Default:
- delete readonly = No
+ bf(Example:)
+verb(
+ default service = pub
+
+ [pub]
+ path = /%S
+)
-.B Example:
- delete readonly = Yes
-.SS deny hosts (S)
-A synonym for this parameter is 'hosts deny'.
+label(deletereadonly)
+dit(bf(delete readonly (S)))
-The opposite of 'allow hosts' - hosts listed here are NOT permitted
-access to services unless the specific services have their own lists to
-override this one. Where the lists conflict, the 'allow' list takes precedence.
+This parameter allows readonly files to be deleted. This is not
+normal DOS semantics, but is allowed by UNIX.
-.B Default:
- none (i.e., no hosts specifically excluded)
+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.
-.B Example:
- deny hosts = 150.203.4. badhost.mynet.edu.au
+ bf(Default:)
+ delete readonly = No
-.SS delete veto files (S)
+ bf(Example:)
+ delete readonly = Yes
+
+label(deletevetofiles)
+dit(bf(delete veto files (S)))
This option is used when Samba is attempting to delete a directory
-that contains one or more vetoed directories (see the 'veto files' option).
-If this option is set to False (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.
-
-If this option is set to True, 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 (eg. .AppleDouble)
-
-Setting 'delete veto files = True' allows these directories to be
+that contains one or more vetoed directories (see the link(bf('veto
+files'))(vetofiles) option). If this option is set to False (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.
+
+If this option is set to True, 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 bf(NetAtalk),
+which create meta-files within directories you might normally veto
+DOS/Windows users from seeing (eg. tt(.AppleDouble))
+
+Setting tt('delete veto files = True') allows these directories to be
transparently deleted when the parent directory is deleted (so long
as the user has permissions to do so).
-.B Default:
- delete veto files = False
+See also the link(bf(veto files))(vetofiles) parameter.
-.B Example:
- delete veto files = True
+ bf(Default:)
+ delete veto files = False
-See
-.B veto files
+ bf(Example:)
+ delete veto files = True
+
+label(denyhosts)
+dit(bf(deny hosts (S)))
+
+The opposite of link(bf('allow hosts'))(allowhosts) - hosts listed
+here are em(NOT) permitted access to services unless the specific
+services have their own lists to override this one. Where the lists
+conflict, the link(bf('allow'))(allowhosts) list takes precedence.
+
+ bf(Default:)
+ none (i.e., no hosts specifically excluded)
+
+ bf(Example:)
+ deny hosts = 150.203.4. badhost.mynet.edu.au
+
+label(dfreecommand)
+dit(bf(dfree command (G)))
-.SS dfree command (G)
The dfree command 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
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.
+this function.
The external program will be passed a single parameter indicating a
directory in the filesystem being queried. This will typically consist
-of the string "./". 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.
+of the string tt("./"). 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.
-Note: Your script should NOT be setuid or setgid and should be owned by
-(and writable only by) root!
+Note: Your script should em(NOT) be setuid or setgid and should be
+owned by (and writable only by) root!
-.B Default:
- By default internal routines for determining the disk capacity
+ bf(Default:)
+ By default internal routines for determining the disk capacity
and remaining space will be used.
-.B Example:
- dfree command = /usr/local/samba/bin/dfree
+ bf(Example:)
+ dfree command = /usr/local/samba/bin/dfree
- Where the script dfree (which must be made executable) could be
+Where the script dfree (which must be made executable) could be:
-.nf
+verb(
#!/bin/sh
df $1 | tail -1 | awk '{print $2" "$4}'
-.fi
+)
- or perhaps (on Sys V)
+or perhaps (on Sys V based systems):
-.nf
+verb(
#!/bin/sh
/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
-.fi
+)
Note that you may have to replace the command names with full
path names on some systems.
-.SS directory (S)
-See
-.B path.
-.SS directory mask (S)
-A synonym for this parameter is 'directory mode'.
+label(directory)
+dit(bf(directory (S)))
-This parameter is the octal modes which are used when converting DOS modes
-to UNIX modes when creating UNIX directories.
+Synonym for link(bf(path))(path).
+
+label(directorymask)
+dit(bf(directory mask (S)))
+
+This parameter is the octal modes which are used when converting DOS
+modes to UNIX modes when creating UNIX directories.
When a directory is created, the neccessary 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 *not* set here will be removed from the
+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 em(*not*) set here will be removed from the
modes set on a directory when it is created.
The default value of this parameter removes the 'group' and 'other'
directory to modify it.
Following this Samba will bit-wise 'OR' the UNIX mode created from
-this parameter with the value of the "force directory mode" parameter.
-This parameter is set to 000 by default (ie. no extra mode bits are added).
+this parameter with the value of the "force directory mode"
+parameter. This parameter is set to 000 by default (ie. no extra mode
+bits are added).
-See the "force directory mode" parameter to cause particular mode
-bits to always be set on created directories.
+See the link(bf("force directory mode"))(forcedirectorymode) parameter
+to cause particular mode bits to always be set on created directories.
-See also the "create mode" parameter for masking mode bits on created
-files.
+See also the link(bf("create mode"))(createmode) parameter for masking
+mode bits on created files.
-.B Default:
- directory mask = 0755
+ bf(Default:)
+ directory mask = 0755
-.B Example:
- directory mask = 0775
+ bf(Example:)
+ directory mask = 0775
-.SS directory mode (S)
-See
-.B directory mask.
+label(directorymode)
+dit(bf(directory mode (S)))
-.SS dns proxy (G)
+Synonym for link(bf(directory mask))(directorymask).
-Specifies that nmbd should (as a WINS server), on finding that a NetBIOS
-name has not been registered, treat the NetBIOS name word-for-word as
-a DNS name.
+label(dnsproxy)
+dit(bf(dns proxy (G)))
-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.
+Specifies that url(bf(nmbd))(nmbd.8.html) 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.
-Note also that nmbd will block completely until the DNS name is resolved.
-This will result in temporary loss of browsing and WINS services.
-Enable this option only if you are certain that DNS resolution is fast,
-or you can live with the consequences of periodic pauses in nmbd service.
+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.
-.B Default:
- dns proxy = yes
+url(bf(nmbd))(nmbd.8.html) spawns a second copy of itself to do the
+DNS name lookup requests, as doing a name lookup is a blocking action.
-.SS domain controller (G)
+See also the parameter link(bf(wins support))(winssupport).
-The meaning of this parameter changed from a string to a boolean (yes/no)
-value. It is currently not used within the Samba source and should be removed
-from all current smb.conf files. It is left behind for compatibility reasons.
+ bf(Default:)
+ dns proxy = yes
+
+label(domainadmingroup)
+bf(domain admin group (G))
+
+This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
+Samba NT Domain Controller Code. It may be removed in a later release.
+To work with the latest code builds that may have more support for
+Samba NT Domain Controller functionality please subscibe to the
+mailing list bf(Samba-ntdom) available by sending email to
+email(listproc@samba.anu.edu.au)
+
+label(domainadminusers)
+dit(bf(domain admin users)
+
+This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
+Samba NT Domain Controller Code. It may be removed in a later release.
+To work with the latest code builds that may have more support for
+Samba NT Domain Controller functionality please subscibe to the
+mailing list bf(Samba-ntdom) available by sending email to
+email(listproc@samba.anu.edu.au)
+
+label(domain controller)
+dit(bf(domain controller (G)))
+
+This is a bf(DEPRECATED) parameter. It is currently not used within
+the Samba source and should be removed from all current smb.conf
+files. It is left behind for compatibility reasons.
+
+label(domaingroups)
+dit(bf(domain groups (G)))
+
+This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
+Samba NT Domain Controller Code. It may be removed in a later release.
+To work with the latest code builds that may have more support for
+Samba NT Domain Controller functionality please subscibe to the
+mailing list bf(Samba-ntdom) available by sending email to
+email(listproc@samba.anu.edu.au)
+
+label(domainguestgroup)
+dit(bf(domain guest group (G)))
+
+This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
+Samba NT Domain Controller Code. It may be removed in a later release.
+To work with the latest code builds that may have more support for
+Samba NT Domain Controller functionality please subscibe to the
+mailing list bf(Samba-ntdom) available by sending email to
+email(listproc@samba.anu.edu.au)
+
+label(domainguestusers)
+dit(bf(domain guest users (G)))
+
+This is an bf(EXPERIMENTAL) parameter that is part of the unfinished
+Samba NT Domain Controller Code. It may be removed in a later release.
+To work with the latest code builds that may have more support for
+Samba NT Domain Controller functionality please subscibe to the
+mailing list bf(Samba-ntdom) available by sending email to
+email(listproc@samba.anu.edu.au)
+
+label(domainlogons)
+dit(bf(domain logons (G)))
+
+If set to true, the Samba server will serve Windows 95/98 Domain
+logons for the link(bf(workgroup))(workgroup) it is in. For more
+details on setting up this feature see the file DOMAINS.txt in the
+Samba documentation directory tt(docs/) shipped with the source code.
+
+Note that Win95/98 Domain logons are em(NOT) the same as Windows
+NT Domain logons. NT Domain logons require a Primary Domain Controller
+(PDC) for the Domain. It is inteded that in a future release Samba
+will be able to provide this functionality for Windows NT clients
+also.
-.B Default:
- domain controller = no
+ bf(Default:)
+ domain logons = no
+
+label(domainmaster)
+dit(bf(domain master (G)))
+
+Tell url(bf(nmbd))(nmbd.8.html) to enable WAN-wide browse list
+collation.Setting this option causes url(bf(nmbd))(nmbd.8.html) to
+claim a special domain specific NetBIOS name that identifies it as a
+domain master browser for its given
+link(bf(workgroup))(workgroup). Local master browsers in the same
+link(bf(workgroup))(workgroup) on broadcast-isolated subnets will give
+this url(bf(nmbd))(nmbd.8.html) their local browse lists, and then
+ask url(bf(smbd))(smbd.8.html) 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.
+
+Note that Windows NT Primary Domain Controllers expect to be able to
+claim this link(bf(workgroup))(workgroup) specific special NetBIOS
+name that identifies them as domain master browsers for that
+link(bf(workgroup))(workgroup) by default (ie. there is no way to
+prevent a Windows NT PDC from attempting to do this). This means that
+if this parameter is set and url(bf(nmbd))(nmbd.8.html) claims the
+special name for a link(bf(workgroup))(workgroup) before a Windows NT
+PDC is able to do so then cross subnet browsing will behave strangely
+and may fail.
-.SS domain logons (G)
+ bf(Default:)
+ domain master = no
-If set to true, the Samba server will serve Windows 95 domain logons
-for the workgroup it is in. For more details on setting up this feature
-see the file DOMAINS.txt in the Samba source documentation directory.
+label(dont descend)
+dit(bf(dont descend (S)))
-.B Default:
- domain logons = no
+There are certain directories on some systems (eg., the tt(/proc) 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.
-.SS domain master (G)
+Note that Samba can be very fussy about the exact format of the "dont
+descend" entries. For example you may need tt("./proc") instead of
+just tt("/proc"). Experimentation is the best policy :-)
-Enable WAN-wide browse list collation. Local master browsers on
-broadcast-isolated subnets will give samba their local browse lists, and
-ask 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.
+ bf(Default:)
+ none (i.e., all directories are OK to descend)
-.B Default:
- domain master = no
+ bf(Example:)
+ dont descend = /proc,/dev
-.SS dont descend (S)
-There are certain directories on some systems (eg., the /proc 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.
+label(dosfiletimeresolution)
+dit(bf(dos filetime resolution (S)))
-Note that Samba can be very fussy about the exact format of the "dont
-descend" entries. For example you may need "./proc" instead of just
-"/proc". Experimentation is the best policy :-)
+Under the DOS and Windows FAT filesystem, the finest granulatity 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 url(bf(smbd))(smbd.8.html).
-.B Default:
- none (i.e., all directories are OK to descend)
+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.
-.B Example:
- dont descend = /proc,/dev
+ bf(Default:)
+ dos filetime resolution = False
+
+ bf(Example:)
+ dos filetime resolution = True
+
+label(dos filetimes)
+dit(bf(dos filetimes (S)))
-.SS dos filetimes (S)
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
smbd is acting on behalf of is not the file owner. Setting this option
-to True allows DOS semantics and smbd will change the file timstamp as
-DOS requires. This is a correct implementation of a previous compile-time
-options (UTIME_WORKAROUND) which was broken and is now removed.
+to True allows DOS semantics and smbd will change the file timstamp as
+DOS requires.
-.B Default:
- dos filetimes = False
-
-.B Example:
- dos filetimes = True
+ bf(Default:)
+ dos filetimes = False
-.SS dos filetime resolution (S)
-Under the DOS and Windows FAT filesystem, the finest granulatity 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 smbd.
+ bf(Example:)
+ dos filetimes = True
-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.
+label(encryptpasswords)
+dit(bf(encrypt passwords (G)))
-.B Default:
- dos filetime resolution = False
+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
+file ENCRYPTION.txt in the Samba documentation directory tt(docs/)
+shipped with the source code.
-.B Example:
- dos filetime resolution = True
+In order for encrypted passwords to work correctly
+url(bf(smbd))(smbd.8.html) must either have access to a local
+url(bf(smbpasswd (5)))(smbpasswd.5.html) file (see the
+url(bf(smbpasswd (8)))(smbpasswd.8.html) program for information on
+how to set up and maintain this file), or set the
+link(bf(security=))(security) parameter to either em("server") or
+em("domain") which causes url(bf(smbd))(smbd.8.html) to authenticate
+against another server.
-.SS encrypt passwords (G)
+label(exec)
+dit(bf(exec (S)))
-This boolean controls whether encrypted passwords will be negotiated
-with the client. Note that Windows NT 4.0 SP3 and above will by default
-expect encrypted passwords unless a registry entry is changed. To use
-encrypted passwords in Samba see the file docs/ENCRYPTION.txt.
+This is a synonym for link(bf(preexec))(preexec).
-.SS exec (S)
-This is an alias for preexec
+label(fake directory create times)
+dit(bf(fake directory create times (S)))
-.SS fake directory create times (S)
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.
-
-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.
-
-However, Unix time semantics mean that the create time reported
-by Samba will be updated whenever a file is created or deleted
-in the directory. NMAKE therefore finds all object files in the
-object directory bar the last one built are out of date compared
-to the directory and rebuilds them. Enabling this option ensures
-directories always predate their contents and an NMAKE build will
-proceed as expected.
+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.
+
+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.
+
+However, Unix time semantics mean that the create time reported by
+Samba will be updated whenever a file is created or deleted in the
+directory. NMAKE therefore finds all object files in the object
+directory bar the last one built are out of date compared to the
+directory and rebuilds them. Enabling this option ensures directories
+always predate their contents and an NMAKE build will proceed as
+expected.
-.B Default:
- fake directory create times = False
+ bf(Default:)
+ fake directory create times = False
-.B Example:
- fake directory create times = True
+ bf(Example:)
+ fake directory create times = True
-.SS fake oplocks (S)
+label(fakeoplocks)
+dit(bf(fake oplocks (S)))
Oplocks are the way that SMB clients get permission from a server to
locally cache file operations. If a server grants an oplock
data. With some oplock types the client may even cache file open/close
operations. This can give enormous performance benefits.
-When you set "fake oplocks = yes" Samba will always grant oplock
-requests no matter how many clients are using the file.
+When you set tt("fake oplocks = yes") url(bf(smbd))(smbd.8.html) will
+always grant oplock requests no matter how many clients are using the
+file.
-By enabling this option on all read-only shares or shares that you know
-will only be accessed from one client at a time 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!
+It is generally much better to use the real link(bf(oplock))(oplock)
+support rather than this parameter.
-It is generally much better to use the real oplock support except for
-physically read-only media such as CDROMs.
+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!
This option is disabled by default.
-.SS follow symlinks (S)
+label(followsymlinks)
+dit(bf(follow symlinks (S)))
-This parameter allows the Samba administrator to stop smbd from
-following symbolic links in a particular share. Setting this
-parameter to "No" 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 /etc/pasword in their home directory for instance.
-However it will slow filename lookups down slightly.
+This parameter allows the Samba administrator to stop
+url(bf(smbd))(smbd.8.html) from following symbolic links in a
+particular share. Setting this parameter to em("No") 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 tt(/etc/pasword) in their home directory for
+instance. However it will slow filename lookups down slightly.
-This option is enabled (ie. smbd will follow symbolic links)
-by default.
+This option is enabled (ie. url(bf(smbd))(smbd.8.html) will follow
+symbolic links) by default.
-.SS force create mode (S)
-This parameter specifies a set of UNIX mode bit permissions that
-will *always* 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 octel)
-000. The modes in this parameter are bitwise 'OR'ed onto the
-file mode after the mask set in the "create mask" parameter
-is applied.
+label(forcecreatemode)
+dit(bf(force create mode (S)))
-See also the parameter "create mask" for details on masking mode
-bits on created files.
+This parameter specifies a set of UNIX mode bit permissions that will
+em(*always*) 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 octel) 000. The modes
+in this parameter are bitwise 'OR'ed onto the file mode after the mask
+set in the link(bf("create mask"))(createmark) parameter is applied.
-.B Default:
- force create mode = 000
+See also the parameter link(bf("create mask"))(createmask) for details
+on masking mode bits on created files.
-.B Example:
- force create mode = 0755
+ bf(Default:)
+ force create mode = 000
-would force all 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'.
+ bf(Example:)
+ force create mode = 0755
-.SS force directory mode (S)
-This parameter specifies a set of UNIX mode bit permissions that
-will *always* 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 octel)
-0000 which will not add any extra permission bits to a created
-directory. This operation is done after the mode mask in the parameter
-"directory mask" is applied.
+would force all 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'.
-See also the parameter "directory mask" for details on masking mode
-bits on created directories.
+label(forcedirectorymode)
+dit(bf(force directory mode (S)))
-.B Default:
- force directory mode = 000
+This parameter specifies a set of UNIX mode bit permissions that will
+em(*always*) 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 octel) 0000 which
+will not add any extra permission bits to a created directory. This
+operation is done after the mode mask in the parameter
+link(bf("directory mask"))(directorymask) is applied.
-.B Example:
- force directory mode = 0755
+See also the parameter link(bf("directory mask"))(directorymask) for
+details on masking mode bits on created directories.
-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'.
+ bf(Default:)
+ force directory mode = 000
-.SS force group (S)
-This specifies a group name that all connections to this service
-should be made as. This may be useful for sharing files.
+ bf(Example:)
+ force directory mode = 0755
-.B Default:
- no forced group
+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'.
-.B Example:
- force group = agroup
+label(forcegroup)
+dit(bf(force group (S)))
-.SS force user (S)
-This specifies a user name that all connections to this service
-should be made as. This may be useful for sharing files. You should
-also use it carefully as using it incorrectly can cause security
-problems.
+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.
+
+ bf(Default:)
+ no forced group
+
+ bf(Example:)
+ force group = agroup
+
+label(forceuser)
+dit(bf(force user (S)))
+
+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.
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", not matter what username the client connected as.
+tt("forced user"), no matter what username the client connected as.
-.B Default:
- no forced user
+This can be very useful.
-.B Example:
- force user = auser
+ bf(Default:)
+ no forced user
+
+ bf(Example:)
+ force user = auser
-.SS getwd cache (G)
-This is a tuning option. When this is enabled a cacheing algorithm will
-be used to reduce the time taken for getwd() calls. This can have a
-significant impact on performance, especially when widelinks is False.
+label(fstype)
+dit(bf(fstype (S)))
-.B Default:
- getwd cache = No
+This parameter allows the administrator to configure the string that
+specifies the type of filesystem a share is using that is reported by
+url(bf(smbd))(smbd.8.html) when a client queries the filesystem type
+for a share. The default type is bf("NTFS") for compatibility with
+Windows NT but this can be changed to other strings such as "Samba" or
+"FAT" if required.
-.B Example:
- getwd cache = Yes
+ bf(Default:)
+ fstype = NTFS
-.SS group (S)
-This is an alias for "force group" and is only kept for compatibility
-with old versions of Samba. It may be removed in future versions.
+ bf(Example:)
+ fstype = Samba
+
+label(getwdcache)
+dit(bf(getwd cache (G)))
+
+This is a tuning option. When this is enabled a cacheing algorithm
+will be used to reduce the time taken for getwd() calls. This can have
+a significant impact on performance, especially when the
+link(bf(widelinks))(widelinks) parameter is set to False.
+
+ bf(Default:)
+ getwd cache = No
+
+ bf(Example:)
+ getwd cache = Yes
+
+label(group)
+dit(bf(group (S)))
+
+Synonym for link(bf("force group"))(forcegroup).
+
+label(guestaccount)
+dit(bf(guest account (S)))
-.SS guest account (S)
This is a username which will be used for access to services which are
-specified as 'guest ok' (see below). Whatever privileges this user has
-will be available to any client connecting to the guest
-service. Typically this user will exist in the password file, but will
-not have a valid login. If a username is specified in a given service,
-the specified username overrides this one.
+specified as link(bf('guest ok'))(guestok) (see below). Whatever
+privileges this user has will be available to any client connecting to
+the guest service. Typically this user will exist in the password
+file, but will not have a valid login. The user account bf("ftp") is
+often a good choice for this parameter. If a username is specified in
+a given service, the specified username overrides this one.
+
+One 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 tt("su -")
+command) and trying to print using the system print command such as
+bf(lpr (1)) or bf(lp (1)).
-One some systems the 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 "su \-" command) and trying to
-print using
-.BR lpr .
+ bf(Default:)
+ specified at compile time, usually "nobody"
-Note that as of version 1.9 of Samba this option may be set
-differently for each service.
+ bf(Example:)
+ guest account = ftp
-.B Default:
- specified at compile time
+label(guestok)
+dit(bf(guest ok (S)))
-.B Example:
- guest account = nobody
-.SS guest ok (S)
-See
-.B public.
-.SS guest only (S)
-If this parameter is 'yes' for a service, then only guest connections to the
-service are permitted. This parameter will have no affect if "guest ok" or
-"public" is not set for the service.
+If this parameter is em('yes') for a service, then no password is
+required to connect to the service. Privileges will be those of the
+link(bf(guest account))(guestaccount).
-See the section below on user/password validation for more information about
-this option.
+See the section below on link(bf(security))(security) for more
+information about this option.
-.B Default:
- guest only = no
+ bf(Default:)
+ guest ok = no
+
+ bf(Example:)
+ guest ok = yes
+
+label(guestonly)
+dit(bf(guest only (S)))
+
+If this parameter is em('yes') for a service, then only guest
+connections to the service are permitted. This parameter will have no
+affect if link(bf("guest ok"))(guestok) or link(bf("public"))(public)
+is not set for the service.
+
+See the section below on link(bf(security))(security) for more
+information about this option.
+
+ bf(Default:)
+ guest only = no
+
+ bf(Example:)
+ guest only = yes
+
+label(hidedotfiles)
+dit(bf(hide dot files (S)))
-.B Example:
- guest only = yes
-.SS hide dot files (S)
This is a boolean parameter that controls whether files starting with
a dot appear as hidden files.
-.B Default:
+ bf(Default:)
hide dot files = yes
-.B Example:
+ bf(Example:)
hide dot files = no
-.SS hide files(S)
+label(hidefiles)
+dit(bf(hide files(S)))
+
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.
-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.
+Each entry in the list must be separated by a tt('/'), which allows
+spaces to be included in the entry. tt('*') and tt('?') can be used
+to specify multiple files or directories as in DOS wildcards.
Each entry must be a unix path, not a DOS path and must not include the
-unix directory separator "/".
+unix directory separator tt('/').
Note that the case sensitivity option is applicable in hiding files.
-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.
+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.
-See also "hide dot files", "veto files" and "case sensitive"
+See also link(bf("hide dot files"))(hidedotfiles), link(bf("veto
+files"))(vetofiles) and link(bf("case sensitive"))(casesensitive).
-.B Default
+ bf(Default)
No files or directories are hidden by this option (dot files are
- hidden by default because of the "hide dot files" option).
+ hidden by default because of the "hide dot files" option).
-.B Example
- hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
+ bf(Example)
+tt( hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/)
-The above example is based on files that the Macintosh client (DAVE)
-creates for internal use, and also still hides all files beginning with
-a dot.
+The above example is based on files that the Macintosh SMB client
+(DAVE) available from url(bf(Thursby))(www.thursby.com) creates for
+internal use, and also still hides all files beginning with a dot.
-.SS homedir map (G)
-If "nis homedir" is true, 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:
+label(homedirmap)
+dit(bf(homedir map (G)))
-username server:/some/file/system
+If link(bf("nis homedir"))(nishomedir) is true, and
+url(bf(smbd))(smbd.8.html) is also acting as a Win95/98 link(bf(logon
+server))(domainlogons) 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:
-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.
+tt(username server:/some/file/system)
-NB: The -DNETGROUP option is required in the Makefile for option to work
-and on some architectures the line -lrpcsvc needs to be added to the
-LIBSM variable. This is required for Solaris 2, FreeBSD and HPUX.
+and the program will extract the servername from before the first
+tt(':'). There should probably be a better parsing system that copes
+with different map formats and also Amd (another automounter) maps.
-See also "nis homedir"
+NB: A working NIS is required on the system for this option to work.
-.B Default:
+See also link(bf("nis homedir"))(nishomedir), link(bf(domain
+logons))(domainlogons).
+
+ bf(Default:)
homedir map = auto.home
-.B Example:
+ bf(Example:)
homedir map = amd.homedir
-.SS hosts allow (S)
-See
-.B allow hosts.
-.SS hosts deny (S)
-See
-.B deny hosts.
-.SS hosts equiv (G)
-If this global parameter is a non-null string, it specifies the name of
-a file to read for the names of hosts and users who will be allowed access
-without specifying a password.
+label(hostsallow)
+dit(bf(hosts allow (S)))
+
+Synonym for link(bf(allow hosts))(allowhosts).
+
+label(hostsdeny)
+dit(bf(hosts deny (S)))
-This is not be confused with
-.B allow hosts
-which is about hosts access to services and is more useful for guest services.
-.B hosts equiv
-may be useful for NT clients which will not supply passwords to samba.
+Synonym for link(bf(denyhosts))(denyhosts).
-NOTE: The use of hosts.equiv can be a major security hole. This is
+label(hostsequiv)
+dit(bf(hosts equiv (G)))
+
+If this global parameter is a non-null string, it specifies the name
+of a file to read for the names of hosts and users who will be allowed
+access without specifying a password.
+
+This is not be confused with link(bf(allow hosts))(allowhosts) which
+is about hosts access to services and is more useful for guest
+services. bf(hosts equiv) may be useful for NT clients which will not
+supply passwords to samba.
+
+NOTE: The use of bf(hosts equiv) can be a major security hole. This is
because you are trusting the PC to supply the correct username. It is
very easy to get a PC to supply a false username. I recommend that the
-hosts.equiv option be only used if you really know what you are doing,
-or perhaps on a home network where you trust your wife and kids :-)
+bf(hosts equiv) option be only used if you really know what you are
+doing, or perhaps on a home network where you trust your spouse and
+kids. And only if you em(really) trust them :-).
-.B Default
+ bf(Default)
No host equivalences
-.B Example
+ bf(Example)
hosts equiv = /etc/hosts.equiv
-.SS include (G)
+label(include)
+dit(bf(include (G)))
-This allows you to include one config file inside another. The file is
-included literally, as though typed in place.
+This allows you to include one config file inside another. The file
+is included literally, as though typed in place.
-It takes the standard substitutions, except %u, %P and %S
+It takes the standard substitutions, except link(bf(%u))(percentu),
+link(bf(%P))(percentP) and link(bf(%S))(percentS).
-.SS interfaces (G)
+label(interfaces)
+dit(bf(interfaces (G)))
This option allows you to setup multiple network interfaces, so that
Samba can properly handle browsing on all interfaces.
The option takes a list of ip/netmask pairs. The netmask may either be
-a bitmask, or a bitlength.
+a bitmask, or a bitlength.
For example, the following line:
-interfaces = 192.168.2.10/24 192.168.3.10/24
+tt(interfaces = 192.168.2.10/24 192.168.3.10/24)
would configure two network interfaces with IP addresses 192.168.2.10
and 192.168.3.10. The netmasks of both interfaces would be set to
-255.255.255.0.
+255.255.255.0.
You could produce an equivalent result by using:
-interfaces = 192.168.2.10/255.255.255.0 192.168.3.10/255.255.255.0
+tt(interfaces = 192.168.2.10/255.255.255.0 192.168.3.10/255.255.255.0)
if you prefer that format.
If this option is not set then Samba will attempt to find a primary
interface, but won't attempt to configure more than one interface.
-.SS invalid users (S)
+See also link(bf("bind interfaces only"))(bindinterfacesonly).
+
+label(invalidusers)
+dit(bf(invalid users (S)))
+
This is a list of users that should not be allowed to login to this
-service. This is really a "paranoid" check to absolutely ensure an
+service. This is really a em("paranoid") check to absolutely ensure an
improper setting does not breach your security.
-A name starting with @ is interpreted as a yp netgroup first (if this
-has been compiled into Samba), and then as a UNIX group if the name
-was not found in the yp netgroup database.
+A name starting with a tt('@') 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.
-A name starting with + is interpreted only by looking in the UNIX
-group database. A name starting with & is interpreted only by looking
-in the yp netgroup database (this has no effect if Samba is compiled
-without netgroup support).
+A name starting with tt('+') is interpreted only by looking in the
+UNIX group database. A name starting with tt('&') is interpreted only
+by looking in the NIS netgroup database (this requires NIS to be
+working on your system). The characters tt('+') and tt('&') may be
+used at the start of the name in either order so the value
+tt("+&group") means check the UNIX group database, followed by the NIS
+netgroup database, and the value tt("&+group") means check the NIS
+netgroup database, followed by the UNIX group database (the same as
+the tt('@') prefix).
-The current servicename is substituted for %S. This is useful in the
-[homes] section.
+The current servicename is substituted for
+link(bf(%S))(percentS). This is useful in the link(bf([homes]))(homes)
+section.
-See also "valid users"
+See also link(bf("valid users"))(validusers).
-.B Default
+ bf(Default:)
No invalid users
-.B Example
- invalid users = root fred admin @wheel
+ bf(Example:)
+tt( invalid users = root fred admin @wheel)
+
+label(keepalive)
+dit(bf(keepalive (G)))
-.SS keepalive (G)
-The value of the parameter (an integer) represents the number of seconds
-between 'keepalive' 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.
+The value of the parameter (an integer) represents the number of
+seconds between bf('keepalive') 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.
Keepalives should, in general, not be needed if the socket being used
-has the SO_KEEPALIVE attribute set on it (see "socket
-options"). Basically you should only use this option if you strike
-difficulties.
+has the SO_KEEPALIVE attribute set on it (see link(bf("socket
+options"))(socketoptions)). Basically you should only use this option
+if you strike difficulties.
-.B Default:
- keep alive = 0
+ bf(Default:)
+ keep alive = 0
-.B Example:
- keep alive = 60
+ bf(Example:)
+ keep alive = 60
-.SS lm announce (G)
+label(kerneloplocks)
+dit(bf(kernel oplocks (G)))
-This parameter determines if Samba 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, true, false, or auto. The default is auto.
-If set to False Samba will never produce these broadcasts. If
-set to true Samba will produce Lanman announce broadcasts at
-a frequency set by the parameter 'lm interval'. If set to auto
-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
-'lm interval'.
+For UNIXs that support kernel based oplocks (currently only IRIX but
+hopefully also Linux and FreeBSD soon) this parameter allows the use
+of them to be turned on or off.
-See also "lm interval".
+Kernel oplocks support allows Samba oplocks to be broken whenever a
+local UNIX process or NFS operation accesses a file that
+url(bf(smbd))(smbd.8.html) has oplocked. This allows complete data
+consistancy between SMB/CIFS, NFS and local file access (and is a
+em(very) cool feature :-).
-.B Default:
- lm announce = auto
+This parameter defaults to em("On") on systems that have the support,
+and em("off") on systems that don't. You should never need to touch
+this parameter.
-.B Example:
- lm announce = true
+label(ldapfilter)
+dit(bf(ldap filter (G)))
-.SS lm interval (G)
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
-If Samba is set to produce Lanman announce broadcasts needed
-by OS/2 clients (see the "lm announce" parameter) 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 "lm announce" parameter.
+This parameter specifies an LDAP search filter used to search for a
+user name in the LDAP database. It must contain the string
+link(bf(%u))(percentU) which will be replaced with the user being
+searched for.
-See also "lm announce".
+ bf(Default:)
+ empty string.
-.B Default:
- lm interval = 60
+label(ldapport)
+dit(bf(ldap port (G)))
-.B Example:
- lm interval = 120
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
+
+This parameter specifies the TCP port number to use to contact
+the LDAP server on.
+
+ bf(Default:)
+ ldap port = 389.
+
+label(ldaproot)
+dit(bf(ldap root (G)))
+
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
+
+This parameter specifies the entity to bind to the LDAP server
+as (essentially the LDAP username) in order to be able to perform
+queries and modifications on the LDAP database.
+
+See also link(bf(ldap root passwd))(ldaprootpasswd).
+
+ bf(Default:)
+ empty string (no user defined)
+
+label(ldaprootpasswd)
+dit(bf(ldap root passwd (G)))
+
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
+
+This parameter specifies the password for the entity to bind to the
+LDAP server as (the password for this LDAP username) in order to be
+able to perform queries and modifications on the LDAP database.
+
+em(BUGS:) This parameter should em(NOT) be a readable parameter
+in the bf(smb.conf) file and will be removed once a correct
+storage place is found.
+
+See also link(bf(ldap root))(ldaproot).
+
+ bf(Default:)
+ empty string.
+
+label(ldapserver)
+dit(bf(ldap server (G)))
+
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
+
+This parameter specifies the DNS name of the LDAP server to use
+for SMB/CIFS authentication purposes.
+
+ bf(Default:)
+ ldap server = localhost
+
+label(ldapsuffix)
+dit(bf(ldap suffix (G)))
+
+This parameter is part of the em(EXPERIMENTAL) Samba support for a
+password database stored on an LDAP server back-end. These options
+are only available if your version of Samba was configured with
+the bf(--with-ldap) option.
+
+This parameter specifies the tt("dn") or LDAP em("distinguished name")
+that tells url(bf(smbd))(smbd.8.html) to start from when searching
+for an entry in the LDAP password database.
+
+ bf(Default:)
+ empty string.
+
+label(lmannounce)
+dit(bf(lm announce (G)))
+
+This parameter determines if url(bf(nmbd))(nmbd.8.html) will produce
+Lanman announce broadcasts that are needed by bf(OS/2) clients in order
+for them to see the Samba server in their browse list. This parameter
+can have three values, tt("true"), tt("false"), or tt("auto"). The
+default is tt("auto"). If set to tt("false") Samba will never produce
+these broadcasts. If set to tt("true") Samba will produce Lanman
+announce broadcasts at a frequency set by the parameter link(bf("lm
+interval"))(lminterval). If set to tt("auto") 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 link(bf("lm interval"))(lminterval).
+
+See also link(bf("lm interval"))(lminterval).
+
+ bf(Default:)
+ lm announce = auto
+
+ bf(Example:)
+ lm announce = true
+
+label(lminterval)
+dit(bf(lm interval (G)))
+
+If Samba is set to produce Lanman announce broadcasts needed by
+bf(OS/2) clients (see the link(bf("lm announce"))(lmannounce)
+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 link(bf("lm
+announce"))(lmannounce) parameter.
+
+See also link(bf("lm announce"))(lmannounce).
+
+ bf(Default:)
+ lm interval = 60
+
+ bf(Example:)
+ lm interval = 120
+
+label(loadprinters)
+dit(bf(load printers (G)))
-.SS load printers (G)
A boolean variable that controls whether all printers in the printcap
-will be loaded for browsing by default.
+will be loaded for browsing by default. See the
+link(bf("printers"))(printers) section for more details.
-.B Default:
+ bf(Default:)
load printers = yes
-.B Example:
+ bg(Example:)
load printers = no
-.SS local master (G)
-This option allows the nmbd to become a local master browser on a
-subnet. If set to False then nmbd 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 true. Setting this value to true doesn't
-mean that Samba will become the local master browser on a subnet, just
-that the nmbd will participate in elections for local master browser.
+label(localmaster)
+dit(bf(local master (G)))
-.B Default:
+This option allows url(bf(nmbd))(nmbd.8.html) to try and become a
+local master browser on a subnet. If set to False then
+url(bf(nmbd))(nmbd.8.html) 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 true. Setting this value to true doesn't
+mean that Samba will em(become) the local master browser on a subnet,
+just that url(bf(nmbd))(nmbd.8.html) will em(participate) in
+elections for local master browser.
+
+Setting this value to False will cause url(bf(nmbd))(nmbd.8.html)
+em(never) to become a local master browser.
+
+ bf(Default:)
local master = yes
-.SS lock directory (G)
+label(lockdirectory)
+dit(bf(lock directory (G)))
+
This option specifies the directory where lock files will be placed.
-The lock files are used to implement the "max connections" option.
+The lock files are used to implement the link(bf("max
+connections"))(maxconnections) option.
-.B Default:
+ bf(Default:)
lock directory = /tmp/samba
-.B Example:
+ bf(Example:)
lock directory = /usr/local/samba/var/locks
-.SS locking (S)
-This controls whether or not locking will be performed by the server in
-response to lock requests from the client.
+label(locking)
+dit(bf(locking (S)))
+
+This controls whether or not locking will be performed by the server
+in response to lock requests from the client.
-If "locking = no", all lock and unlock requests will appear to succeed and
-all lock queries will indicate that the queried lock is clear.
+If tt("locking = no"), all lock and unlock requests will appear to
+succeed and all lock queries will indicate that the queried lock is
+clear.
-If "locking = yes", real locking will be performed by the server.
+If tt("locking = yes"), real locking will be performed by the server.
-This option may be particularly useful for read-only filesystems which
-do not need locking (such as cdrom drives).
+This option em(may) be useful for read-only filesystems which em(may)
+not need locking (such as cdrom drives), although setting this
+parameter of tt("no") is not really recommended even in this case.
Be careful about disabling locking either globally or in a specific
-service, as lack of locking may result in data corruption.
+service, as lack of locking may result in data corruption. You should
+never need to set this parameter.
-.B Default:
+ bf(Default:)
locking = yes
-.B Example:
+ bf(Example:)
locking = no
-.SS log file (G)
+label(logfile)
+dit(bf(log file (G)))
This options allows you to override the name of the Samba log file
(also known as the debug file).
This option takes the standard substitutions, allowing you to have
separate log files for each user or machine.
-.B Example:
- log file = /usr/local/samba/var/log.%m
+ bf(Example:)
+tt( log file = /usr/local/samba/var/log.%m)
-.SS log level (G)
-see "debug level"
+label(loglevel)
+dit(bf(log level (G)))
-.SS logon drive (G)
+Synonym for link(bf("debug level"))(debuglevel).
+
+label(logondrive)
+dit(bf(logon drive (G)))
This parameter specifies the local path to which the home directory
-will be connected (see "logon home") and is only used by NT Workstations.
+will be connected (see link(bf("logon home"))(logonhome)) and is only
+used by NT Workstations.
-.B Example:
+Note that this option is only useful if Samba is set up as a
+link(bf(logon server))(domainlogons).
+
+ bf(Example:)
logon drive = h:
-.SS logon home (G)
+label(logonhome)
+dit(bf(logon home (G)))
-This parameter specifies the home directory location when a Win95 or
-NT Workstation logs into a Samba PDC. It allows you to do "NET USE
-H: /HOME" from a command prompt, for example.
+This parameter specifies the home directory location when a Win95/98 or
+NT Workstation logs into a Samba PDC. It allows you to do
+
+tt("NET USE H: /HOME")
+
+from a command prompt, for example.
-.B
This option takes the standard substitutions, allowing you to have
separate logon scripts for each user or machine.
-.B Example:
- logon home = "\\\\remote_smb_server\\%U"
+Note that this option is only useful if Samba is set up as a
+link(bf(logon server))(domainlogons).
-.B Default:
- logon home = "\\\\%N\\%U"
+ bf(Example:)
+tt( logon home = "\\remote_smb_server\%U")
+
+ bf(Default:)
+tt( logon home = "\\%N\%U")
-.SS logon path (G)
+label(logonpath)
+dit(bf(logon path (G)))
-This parameter specifies the home directory where roaming profiles
-(USER.DAT / USER.MAN files for Windows 95) are stored.
+This parameter specifies the home directory where roaming profiles
+(USER.DAT / USER.MAN files for Windows 95/98) are stored.
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 "desktop", "start menu", "nethood" and
-"programs" folders, and their contents, are loaded and displayed
-on your Windows 95 client.
+the directory from which the tt("desktop"), tt("start menu"),
+tt("network neighborhood") and tt("programs") folders, and their
+contents, are loaded and displayed on your Windows 95/98 client.
-The share and the path must be readable by the user for the preferences
-and directories to be loaded onto the Windows 95 client. The share
-must be writeable when the logs in for the first time, in order that
-the Windows 95 client can create the user.dat and other directories.
+The share and the path must be readable by the user for the
+preferences and directories to be loaded onto the Windows 95/98
+client. The share must be writeable when the logs in for the first
+time, in order that the Windows 95/98 client can create the user.dat
+and other directories.
-Thereafter, the directories and any of contents can, if required,
-be made read-only. It is not adviseable that the USER.DAT file be made
-read-only - rename it to USER.MAN to achieve the desired effect
-(a MANdatory profile).
+Thereafter, the directories and any of contents can, if required, be
+made read-only. It is not adviseable that the USER.DAT file be made
+read-only - rename it to USER.MAN to achieve the desired effect (a
+em(MAN)datory profile).
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 \\\\%N\\HOMES\profile_path will cause problems).
+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 tt(\\%N\HOMES\profile_path) will cause
+problems).
-.B
This option takes the standard substitutions, allowing you to have
separate logon scripts for each user or machine.
-.B Default:
- logon path = \\\\%N\\%U\\profile
+Note that this option is only useful if Samba is set up as a
+link(bf(logon server))(domainlogons).
-.B Example:
- logon path = \\\\PROFILESERVER\\HOME_DIR\\%U\\PROFILE
+ bf(Default:)
+tt( logon path = \\%N\%U\profile)
-.SS logon script (G)
+ bf(Example:)
+tt( logon path = \\PROFILESERVER\HOME_DIR\%U\PROFILE)
-This parameter specifies the batch file (.bat) or NT command file (.cmd)
-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.
+label(logonscript)
+dit(bf(logon script (G)))
-The script must be a relative path to the [netlogon] service. If the
-[netlogon] service specifies a path of /usr/local/samba/netlogon, and
-logon script = STARTUP.BAT, then file that will be downloaded is:
+This parameter specifies the batch file (.bat) or NT command file
+(.cmd) 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.
-.B /usr/local/samba/netlogon/STARTUP.BAT
+The script must be a relative path to the tt([netlogon]) service. If
+the tt([netlogon]) service specifies a link(bf(path))(path) of
+/usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the
+file that will be downloaded is:
+
+tt(/usr/local/samba/netlogon/STARTUP.BAT)
The contents of the batch file is entirely your choice. A suggested
-command would be to add NET TIME \\\\SERVER /SET /YES, to force every
+command would be to add tt(NET TIME \\SERVER /SET /YES), to force every
machine to synchronise clocks with the same time server. Another use
-would be to add NET USE U: \\\\SERVER\\UTILS for commonly used utilities,
-or NET USE Q: \\\\SERVER\\ISO9001_QA.
+would be to add tt(NET USE U: \\SERVER\UTILS) for commonly used
+utilities, or tt(NET USE Q: \\SERVER\ISO9001_QA) for example.
Note that it is particularly important not to allow write access to
-the [netlogon] share, or to grant users write permission on the
+the tt([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.
+files to be arbitrarily modified and security to be breached.
-.B
This option takes the standard substitutions, allowing you to have
separate logon scripts for each user or machine.
-.B Example:
- logon script = scripts\\%U.bat
+Note that this option is only useful if Samba is set up as a
+link(bf(logon server))(domainlogons).
-.SS lppause command (S)
-This parameter specifies the command to be executed on the server host in
-order to stop printing or spooling a specific print job.
-
-This command should be a program or script which takes a printer name and
-job number to pause the print job. Currently I don't know of any print
-spooler system that can do this with a simple option, except for the PPR
-system from Trinity College (ppr\-dist.trincoll.edu/pub/ppr). One way
-of implementing this is by using job priorities, where jobs having a too
-low priority won't be sent to the printer. See also the
-.B lppause
-command.
+ bf(Example:)
+tt( logon script = scripts\%U.bat)
-If a %p is given then the printername is put in its place. A %j is
-replaced with the job number (an integer).
-On HPUX (see printing=hpux), if the -p%p 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.
+label(lppausecommand)
+dit(bf(lppause command (S)))
-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.
+This parameter specifies the command to be executed on the server host
+in order to stop printing or spooling a specific print job.
-.B Default:
- Currently no default value is given to this string
+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.
+
+If a tt("%p") is given then the printername is put in its place. A
+tt("%j") is replaced with the job number (an integer). On HPUX (see
+link(bf(printing=hpux))(printing)), if the tt("-p%p") 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.
+
+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.
+
+See also the link(bf("printing"))(printing) parameter.
+
+ bf(Default:)
+ Currently no default value is given to this string, unless the
+value of the link(bf("printing"))(printing) parameter is tt(SYSV), in
+which case the default is :
+
+tt( lp -i %p-%j -H hold)
+
+or if the value of the link(bf("printing"))(printing) parameter is tt(HPUX),
+then the default is:
-.B Example for HPUX:
+tt( disable %p)
+
+or if the value of the link(bf("printing"))(printing) parameter is tt(softq),
+then the default is:
+
+tt( qstat -s -j%j -h)
+
+ bf(Example for HPUX:)
lppause command = /usr/bin/lpalt %p-%j -p0
-.SS lpq cache time (G)
+label(lpqcachetime)
+dit(bf(lpq cache time (G)))
-This controls how long lpq info will be cached for to prevent the lpq
-command being called too often. A separate cache is kept for each
-variation of the lpq command used by the system, so if you use
-different lpq commands for different users then they won't share cache
-information.
+This controls how long lpq info will be cached for to prevent the
+bf(lpq) command being called too often. A separate cache is kept for
+each variation of the bf(lpq) command used by the system, so if you
+use different bf(lpq) commands for different users then they won't
+share cache information.
-The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash
-of the lpq command in use.
+The cache files are stored in tt(/tmp/lpq.xxxx) where xxxx is a hash of
+the bf(lpq) command in use.
The default is 10 seconds, meaning that the cached results of a
-previous identical lpq command will be used if the cached data is less
-than 10 seconds old. A large value may be advisable if your lpq
-command is very slow.
+previous identical bf(lpq) command will be used if the cached data is
+less than 10 seconds old. A large value may be advisable if your
+bf(lpq) command is very slow.
A value of 0 will disable cacheing completely.
-.B Default:
+See also the link(bf("printing"))(printing) parameter.
+
+ bf(Default:)
lpq cache time = 10
-.B Example:
+ bf(Example:)
lpq cache time = 30
-.SS lpq command (S)
-This parameter specifies the command to be executed on the server host in
-order to obtain "lpq"-style printer status information.
+label(lpqcommand)
+dit(bf(lpq command (S)))
+
+This parameter specifies the command to be executed on the server host
+in order to obtain tt("lpq")-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.
+as its only parameter and outputs printer status information.
-Currently six styles of printer status information are supported; BSD,
-SYSV, AIX, HPUX, QNX, LPRNG and PLP. This covers most UNIX systems. You
-control which type is expected using the "printing =" option.
+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
+link(bf("printing ="))(printing) 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.
+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 %p is given then the printername is put in its place. Otherwise
+If a tt(%p) is given then the printername 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 lpq
-command as the PATH may not be available to the server.
+Note that it is good practice to include the absolute path in the bf(lpq
+command) as the PATH may not be available to the server.
-.B Default:
- depends on the setting of "printing ="
+See also the link(bf("printing"))(printing) parameter.
-.B Example:
- lpq command = /usr/bin/lpq %p
+ bf(Default:)
+ depends on the setting of link(bf("printing ="))(printing)
-.SS lpresume command (S)
-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.
+ bf(Example:)
+tt( lpq command = /usr/bin/lpq %p)
-This command should be a program or script which takes a printer name and
-job number to resume the print job. See also the lppause command.
+label(lpresumecommand)
+dit(bf(lpresume command (S)))
-If a %p is given then the printername is put in its place. A %j is
-replaced with the job number (an integer).
+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.
-Note that it is good practice to include the absolute path in the lpresume
-command as the PATH may not be available to the server.
+This command should be a program or script which takes a printer name
+and job number to resume the print job. See also the link(bf("lppause
+command"))(lppausecommand) parameter.
-.B Default:
- Currently no default value is given to this string
+If a tt(%p) is given then the printername is put in its place. A
+tt(%j) is replaced with the job number (an integer).
-.B Example for HPUX:
- lpresume command = /usr/bin/lpalt %p-%j -p2
+Note that it is good practice to include the absolute path in the bf(lpresume
+command) as the PATH may not be available to the server.
-.SS lprm command (S)
-This parameter specifies the command to be executed on the server host in
-order to delete a print job.
+See also the link(bf("printing"))(printing) parameter.
+
+ bf(Default:)
+
+ Currently no default value is given to this string, unless the
+value of the link(bf("printing"))(printing) parameter is tt(SYSV), in
+which case the default is :
+
+tt( lpc start %p)
+
+or if the value of the link(bf("printing"))(printing) parameter is tt(HPUX),
+then the default is:
+
+tt( enable %p)
+
+or if the value of the link(bf("printing"))(printing) parameter is tt(softq),
+then the default is:
+
+tt( qstat -s -j%j -r)
+
+ bf(Example for HPUX:)
+tt( lpresume command = /usr/bin/lpalt %p-%j -p2)
+
+label(lprmcommand)
+dit(bf(lprm command (S)))
+
+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.
-Currently seven styles of printer control are supported; BSD, SYSV, AIX
-HPUX, QNX, LPRNG and PLP. This covers most UNIX systems. You control
-which type is expected using the "printing =" option.
+If a tt(%p) is given then the printername is put in its place. A
+tt(%j) is replaced with the job number (an integer).
-If a %p is given then the printername is put in its place. A %j is
-replaced with the job number (an integer).
+Note that it is good practice to include the absolute path in the
+bf(lprm command) as the PATH may not be available to the server.
-Note that it is good practice to include the absolute path in the lprm
-command as the PATH may not be available to the server.
+See also the link(bf("printing"))(printing) parameter.
.B Default:
depends on the setting of "printing ="
-.B Example 1:
- lprm command = /usr/bin/lprm -P%p %j
+ bf(Example 1:)
+tt( lprm command = /usr/bin/lprm -P%p %j)
+
+ bf(Example 2:)
+tt( lprm command = /usr/bin/cancel %p-%j)
+
+label(machinepasswordtimeout)
+dit(bf(machine password timeout (G)))
-.B Example 2:
- lprm command = /usr/bin/cancel %p-%j
+If a Samba server is a member of an Windows NT Domain (see the
+link(bf("security=domain"))(security)) parameter) then periodically a
+running url(bf(smbd))(smbd.8.html) process will try and change the
+bf(MACHINE ACCOUNT PASWORD) stored in the file called
+tt(<Domain>.<Machine>.mac) where tt(<Domain>) is the name of the
+Domain we are a member of and tt<Machine> is the primary
+link(bf("NetBIOS name"))(netbiosname) of the machine
+url(bf(smbd))(smbd.8.html) is running on. 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 url(bf(smbpasswd (8)))(smbpasswd.8.html), and the
+link(bf("security=domain"))(security)) parameter.
+
+ bf(Default:)
+ machine password timeout = 604800
+
+label(magicoutput)
+dit(bf(magic output (S)))
-.SS magic output (S)
This parameter specifies the name of a file which will contain output
-created by a magic script (see
-.I magic script
-below).
+created by a magic script (see the link(bf("magic
+script"))(magicscript) parameter below).
-Warning: If two clients use the same magic script in the same directory the
-output file content is undefined.
-.B Default:
+Warning: If two clients use the same link(bf("magic
+script"))(magicscript) in the same directory the output file content
+is undefined.
+
+ bf(Default:)
magic output = <magic script name>.out
-.B Example:
+ bf(Example:)
magic output = myfile.txt
-.SS magic script (S)
+
+label(magicscript)
+dit(bf(magic script (S)))
+
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.
+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, permissions
-permitting.
+Scripts executed in this way will be deleted upon completion,
+permissions permitting.
-If the script generates output, output will be sent to the file specified by
-the
-.I magic output
-parameter (see above).
+If the script generates output, output will be sent to the file
+specified by the link(bf("magic output"))(magicoutput) parameter (see
+above).
Note that some shells are unable to interpret scripts containing
carriage-return-linefeed instead of linefeed as the end-of-line
-marker. Magic scripts must be executable "as is" on the host, which
-for some hosts and some shells will require filtering at the DOS end.
+marker. Magic scripts must be executable em("as is") on the host,
+which for some hosts and some shells will require filtering at the DOS
+end.
-Magic scripts are EXPERIMENTAL and should NOT be relied upon.
+Magic scripts are em(EXPERIMENTAL) and should em(NOT) be relied upon.
-.B Default:
- None. Magic scripts disabled.
+ bf(Default:)
+ None. Magic scripts disabled.
-.B Example:
+ bf(Example:)
magic script = user.csh
-.SS mangle case (S)
+label(manglecase)
+dit(bf(mangle case (S)))
+
+See the section on link(bf("NAME MANGLING"))(NAMEMANGLING).
-See the section on "NAME MANGLING"
+label(mangledmap)
+dit(bf(mangled map (S)))
-.SS mangled map (S)
This is for those who want to directly map UNIX file names which are
-not representable on 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 .html for HTML files, whereas under DOS .htm is more commonly
-used.
+not representable 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 tt(".html") for HTML files, whereas under
+Windows/DOS tt(".htm") is more commonly used.
-So to map 'html' to 'htm' you put:
+So to map tt("html") to tt("htm") you would use:
- mangled map = (*.html *.htm)
+tt( mangled map = (*.html *.htm))
-One very useful case is to remove the annoying ;1 off the ends of
-filenames on some CDROMS (only visible under some UNIXes). To do this
-use a map of (*;1 *)
+One very useful case is to remove the annoying tt(";1") off the ends
+of filenames on some CDROMS (only visible under some UNIXes). To do
+this use a map of (*;1 *).
-.B default:
+ bf(default:)
no mangled map
-.B Example:
- mangled map = (*;1 *)
+ bf(Example:)
+tt( mangled map = (*;1 *))
+
+label(manglednames)
+dit(bf(mangled names (S)))
-.SS mangled names (S)
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.
+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.
+See the section on link(bf("NAME MANGLING"))(NAMEMANGLING) for details
+on how to control the mangling process.
If mangling is used then the mangling algorithm is as follows:
-.RS
-- 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.
-
-- 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 "mangling
-char" option, if you don't like ~.
-
-- 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).
-
-- 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
-The two-digit hash value consists of upper case alphanumeric characters.
+startit()
+
+it() 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.
+
+it() A tilde tt("~") 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
+link(bf("mangling char"))(manglingchar) option, if you don't like
+tt('~').
+
+it() 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 link(bf("hidden files"))(hidefiles) - see below).
+
+it() 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 tt("___") as its extension regardless
+of actual original extension (that's three underscores).
+
+endit()
+
+The two-digit hash value consists of upper case alphanumeric
+characters.
-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.
+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.
The name mangling (if enabled) allows a file to be copied between UNIX
-directories from DOS while retaining the long UNIX filename. UNIX files can
-be renamed to a new extension from DOS and will retain the same basename.
-Mangled names do not change between sessions.
+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.
-.B Default:
+ bf(Default:)
mangled names = yes
-.B Example:
+ bf(Example:)
mangled names = no
-.SS mangling char (S)
-This controls what character is used as the "magic" 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.
-.B Default:
+label(manglingchar)
+dit(bf(mangling char (S)))
+
+This controls what character is used as the em("magic") character in
+link(bf(name mangling))(manglednames). The default is a tt('~') but
+this may interfere with some software. Use this option to set it to
+whatever you prefer.
+
+ bf(Default:)
mangling char = ~
-.B Example:
+ bf(Example:)
mangling char = ^
-.SS mangled stack (G)
-This parameter controls the number of mangled names that should be cached in
-the Samba server.
+label(mangledstack)
+dit(bf(mangled stack (G)))
-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).
+This parameter controls the number of mangled names that should be
+cached in the Samba server url(bf(smbd))(smbd.8.html).
+
+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 access. Smaller stacks save memory in the
-server (each stack element costs 256 bytes).
+successfully converted to correct long UNIX names. However, large
+stack sizes will slow most directory access. Smaller stacks save
+memory in the server (each stack element costs 256 bytes).
It is not possible to absolutely guarantee correct long file names, so
be prepared for some surprises!
-.B Default:
+ bf(Default:)
mangled stack = 50
-.B Example:
+ bf(Example:)
mangled stack = 100
-.SS map archive (S)
-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...
+label(maparchive)
+dit(bf(map archive (S)))
-Note that this requires the 'create mask' to be set such that owner
-execute bit is not masked out (ie. it must include 100). See the
-parameter "create mask" for details.
+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...
-.B Default:
+Note that this requires the link(bf("create mask"))(createmask)
+parameter to be set such that owner execute bit is not masked out
+(ie. it must include 100). See the parameter link(bf("create
+mask"))(createmask) for details.
+
+ bf(Default:)
map archive = yes
-.B Example:
+ bf(Example:)
map archive = no
-.SS map hidden (S)
+label(maphidden)
+dit(bf(map hidden (S)))
+
This controls whether DOS style hidden files should be mapped to the
UNIX world execute bit.
-Note that this requires the 'create mask' to be set such that the world
-execute bit is not masked out (ie. it must include 001).
-See the parameter "create mask" for details.
+Note that this requires the link(bf("create mask"))(createmask) to be
+set such that the world execute bit is not masked out (ie. it must
+include 001). See the parameter link(bf("create mask"))(createmask)
+for details.
-.B Default:
+ bf(Default:)
map hidden = no
-.B Example:
+ bf(Example:)
map hidden = yes
-.SS map system (S)
+
+label(mapsystem)
+dit(bf(map system (S)))
+
This controls whether DOS style system files should be mapped to the
UNIX group execute bit.
-Note that this requires the 'create mask' to be set such that the group
-execute bit is not masked out (ie. it must include 010). See the parameter
-"create mask" for details.
+Note that this requires the link(bf("create mask"))(createmask) to be
+set such that the group execute bit is not masked out (ie. it must
+include 010). See the parameter link(bf("create mask"))(createmask)
+for details.
-.B Default:
+ bf(Default:)
map system = no
-.B Example:
+ bf(Example:)
map system = yes
-.SS max connections (S)
-This option allows the number of simultaneous connections to a
-service to be limited. If "max connections" is greater than 0 then
+
+label(maxconnections)
+dit(bf(max connections (S)))
+
+This option allows the number of simultaneous connections to a service
+to be limited. If bf("max connections") 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.
Record lock files are used to implement this feature. The lock files
-will be stored in the directory specified by the "lock directory" option.
+will be stored in the directory specified by the link(bf("lock
+directory"))(lockdirectory) option.
-.B Default:
+ bf(Default:)
max connections = 0
-.B Example:
+ bf(Example:)
max connections = 10
-.SS max disk size (G)
+label(maxdisksize)
+dit(bf(max disk size (G)))
+
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.
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 "max disk size".
+amount specified in bf("max disk size").
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 "max disk size" of 0 means no limit.
+A bf("max disk size") of 0 means no limit.
-.B Default:
+ bf(Default:)
max disk size = 0
-.B Example:
+ bf(Example:)
max disk size = 1000
-.SS max log size (G)
+label(maxlogsize)
+dit(bf(max log size (G)))
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 .old extension.
+exceeded it will rename the file, adding a tt(".old") extension.
A size of 0 means no limit.
-.B Default:
+ bf(Default:)
max log size = 5000
-.B Example:
+ bf(Example:)
max log size = 1000
-.SS max mux (G)
+label(maxmux)
+dit(bf(max mux (G)))
-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.
+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.
-.B Default:
+ bf(Default:)
max mux = 50
-.SS max packet (G)
+label(maxopenfiles)
+dit(bf(maxopenfiles (G)))
-A synonym for this parameter is 'packet size'.
+This parameter limits the maximum number of open files that one
+url(bf(smbd))(smbd.8.html) 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 un-opened file.
-.SS max ttl (G)
+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.
-This option tells nmbd what the default 'time to live' of NetBIOS
-names should be (in seconds) when nmbd is requesting a name using
-either a broadcast or from a WINS server. You should never need to
-change this parameter.
+ bf(Default:)
+ max open files = 10000
-.B Default:
- max ttl = 14400
+label(maxpacket)
+dit(bf(max packet (G)))
-.SS max wins ttl (G)
+Synonym for label(bf("packet size"))(packetsize).
-This option tells nmbd when acting as a WINS server (wins support = true)
-what the maximum 'time to live' of NetBIOS names that nmbd will grant will
-be (in seconds). You should never need to change this parameter.
-The default is 3 days (259200 seconds).
+label(maxttl)
+dit(bf(max ttl (G)))
-.B Default:
- max wins ttl = 259200
+This option tells url(bf(nmbd))(nmbd.8.html) what the default 'time
+to live' of NetBIOS names should be (in seconds) when
+url(bf(nmbd))(nmbd.8.html) 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.
-.SS max xmit (G)
+ bf(Default:)
+ max ttl = 259200
+
+label(maxwinsttl)
+dit(bf(max wins ttl (G)))
+
+This option tells url(bf(nmbd))(nmbd.8.html) when acting as a WINS
+server link(bf((wins support =true)))(winssupport) what the maximum
+'time to live' of NetBIOS names that url(bf(nmbd))(nmbd.8.html) will
+grant will be (in seconds). You should never need to change this
+parameter. The default is 6 days (518400 seconds).
+
+See also the link(bf("min wins ttl"))(minwinsttl) parameter.
+
+ bf(Default:)
+ max wins ttl = 518400
+
+label(maxxmit)
+dit(bf(max xmit (G)))
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.
-.B Default:
+ bf(Default:)
max xmit = 65535
-.B Example:
+ bf(Example:)
max xmit = 8192
-.SS message command (G)
+label(messagecommand)
+dit(bf(message command (G)))
This specifies what command to run when the server receives a WinPopup
style message.
What I use is:
- message command = csh -c 'xedit %s;rm %s' &
+tt( message command = csh -c 'xedit %s;rm %s' &)
-This delivers the message using xedit, then removes it
-afterwards. NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
-IMMEDIATELY. 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 30secs, hopefully).
+This delivers the message using bf(xedit), then removes it
+afterwards. em(NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
+IMMEDIATELY). That's why I have the tt('&') on the end. If it doesn't
+return immediately then your PCs may freeze when sending messages
+(they should recover after 30secs, hopefully).
All messages are delivered as the global guest user. The command takes
-the standard substitutions, although %u won't work (%U may be better
-in this case).
+the standard substitutions, although link(bf(%u))(percentu) won't work
+(link(bf(%U))(percentU) may be better in this case).
Apart from the standard substitutions, some additional ones apply. In
particular:
-%s = the filename containing the message
+startit()
+
+it() %s = the filename containing the message
-%t = the destination that the message was sent to (probably the server
+it() %t = the destination that the message was sent to (probably the server
name)
-%f = who the message is from
+it() %f = who the message is from
+
+endit()
You could make this command send mail, or whatever else takes your
-fancy. Please let me know of any really interesting ideas you have.
+fancy. Please let us know of any really interesting ideas you have.
Here's a way of sending the messages as mail to root:
-message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s
+tt(message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s)
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.
-If you want to silently delete it then try "message command = rm %s".
+If you want to silently delete it then try:
+
+ tt("message command = rm %s").
For the really adventurous, try something like this:
-message command = csh -c 'csh < %s |& /usr/local/samba/bin/smbclient \e
- -M %m; rm %s' &
+tt(message command = csh -c 'csh < %s |& /usr/local/samba/bin/smbclient -M %m; rm %s' &)
this would execute the command as a script on the server, then give
them the result in a WinPopup message. Note that this could cause a
loop if you send a message from the server using smbclient! You better
wrap the above in a script that checks for this :-)
-.B Default:
+ bf(Default:)
no message command
-.B Example:
- message command = csh -c 'xedit %s;rm %s' &
+ bf(Example:)
+tt( message command = csh -c 'xedit %s;rm %s' &)
-.SS min print space (S)
+label(minprintspace)
+dit(bf(min print space (S)))
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 no limit.
+kilobytes. The default is 0, which means a user can always spool a print
+job.
-.B Default:
+See also the link(bf(printing))(printing) parameter.
+
+ bf(Default:)
min print space = 0
-.B Example:
+ bf(Example:)
min print space = 2000
-.SS min wins ttl (G)
+label(minwinsttl)
+dit(bf(min wins ttl (G)))
-This option tells nmbd when acting as a WINS server (wins support = true)
-what the minimum 'time to live' of NetBIOS names that nmbd will grant will
-be (in seconds). You should never need to change this parameter.
-The default is 6 hours (21600 seconds).
+This option tells url(bf(nmbd))(nmbd.8.html) when acting as a WINS
+server link(bf((wins support = true)))(winssupport) what the minimum
+'time to live' of NetBIOS names that url(bf(nmbd))(nmbd.8.html) will
+grant will be (in seconds). You should never need to change this
+parameter. The default is 6 hours (21600 seconds).
-.B Default:
- min wins ttl = 21600
-
-.SS name resolve order (G)
-
-This option is used by the programs smbd, nmbd and smbclient to determine
-what naming services and in what order to resolve host names to IP addresses.
-This option is most useful in smbclient. The option takes a space separated
-string of different name resolution options. These are "lmhosts", "host",
-"wins" and "bcast". They cause names to be resolved as follows :
-
-lmhosts : Lookup an IP address in the Samba lmhosts file.
-host : Do a standard host name to IP address resolution, using the
- system /etc/hosts, NIS, or DNS lookups. This method of name
- resolution is operating system depended (for instance on Solaris
- this may be controlled by the /etc/nsswitch.conf file).
-wins : Query a name with the IP address listed in the "wins server ="
- parameter. If no WINS server has been specified this method will
- be ignored.
-bcast : Do a broadcast on each of the known local interfaces listed in
- the "interfaces =" parameter. This is the least reliable of the
- name resolution methods as it depends on the target host being
- on a locally connected subnet.
-
-The default order is lmhosts, host, wins, bcast and these name resolution
-methods will be attempted in this order.
-
-This option was first introduced in Samba 1.9.18p4.
+ bf(Default:)
+ min wins ttl = 21600
-.B Default:
- name resolve order = lmhosts host wins bcast
-.Example:
- name resolve order = lmhosts bcast host
+label(nameresolveorder)
+dit(bf(name resolve order (G)))
+
+This option is used by the programs in the Samba suite to determine
+what naming services and in what order to resolve host names to IP
+addresses. The option takes a space separated string of different name
+resolution options.
+
+The options are :"lmhosts", "host", "wins" and "bcast". They cause
+names to be resolved as follows :
+
+startit()
+
+it() bf(lmhosts) : Lookup an IP address in the Samba lmhosts file.
+
+it() bf(host) : Do a standard host name to IP address resolution,
+using the system /etc/hosts, 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 em(/etc/nsswitch.conf) file).
+
+it() bf(wins) : Query a name with the IP address listed in the
+link(bf(wins server))(winsserver) parameter. If no WINS server has
+been specified this method will be ignored.
+
+it() bf(bcast) : Do a broadcast on each of the known local interfaces
+listed in the link(bf(interfaces))(interfaces) parameter. This is the
+least reliable of the name resolution methods as it depends on the
+target host being on a locally connected subnet.
+
+endit()
+
+ bf(Default:)
+ name resolve order = lmhosts host wins bcast
+
+ bf(Example:)
+ name resolve order = lmhosts bcast host
This will cause the local lmhosts file to be examined first, followed
by a broadcast attempt, followed by a normal system hostname lookup.
-.SS netbios aliases (G)
+label(netbiosaliases)
+dit(bf(netbios aliases (G)))
-This is a list of 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.
+This is a list of NetBIOS names that url(bf(nmbd))(nmbd.8.html) 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 link(bf(browse server))(localmaster) or
+link(bf(logon server))(domainlogons) 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.
-See also 'netbios name'.
+See also link(bf("netbios name"))(netbiosname).
-.B Example:
- netbios aliases = TEST TEST1 TEST2
+ bf(Default:)
+ empty string (no additional names)
+
+ bf(Example:)
+ netbios aliases = TEST TEST1 TEST2
-.SS netbios name (G)
+label(netbiosname)
+dit(bf(netbios name (G)))
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.
+If a machine is a link(bf(browse server))(localmaster) or
+link(bf(logon server))(domainlogons) this name (or the first component
+of the hosts DNS name) will be the name that these services are
+advertised under.
-See also 'netbios aliases'.
+See also link(bf("netbios aliases"))(netbiosaliases).
-.B Example:
- netbios name = MYNAME
-
-.SS nis homedir (G)
-Get the home share server from a NIS (or YP) 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. When the Samba logon server
-is not the actual home directory server, two network hops are required
-to access the home directory and this can be very slow especially with
-writing via Samba to an NFS mounted directory. 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 (or YP) map specified in "homedir map" and return the
-server listed there.
+ bf(Default:)
+ Machine DNS name.
-.B Default:
+ bf(Example:)
+ netbios name = MYNAME
+
+label(nishomedir)
+dit(bf(nis homedir (G)))
+
+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.
+
+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.
+
+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
+link(bf("homedir map"))(homedirmap) and return the server listed
+there.
+
+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
+link(bf(logon server))(domainlogons).
+
+ bf(Default:)
nis homedir = false
-.B Example:
+ bf(Example:)
nis homedir = true
-.SS networkstation user login (G)
-This global parameter (new for 1.9.18p3) affects server level security.
-With this set (recommended) samba will do a full NetWkstaUserLogon to
-confirm that the client really should have login rights. This can cause
-problems with machines in trust relationships in which case you can
-disable it here, but be warned, we have heard that some NT machines
-will then allow anyone in with any password! Make sure you test it.
-
-In Samba 1.9.18p5 this parameter is of limited use, as smbd now
-explicitly tests for this NT bug and will refuse to use a password
-server that has the problem. The parameter now defaults to off,
-and it should not be neccessary to set this parameter to on. It will
-be removed in a future Samba release.
-
-.B Default:
- networkstation user login = no
+label(nullpasswords)
+dit(bf(null passwords (G)))
-.B Example:
- networkstation user login = yes
+Allow or disallow client access to accounts that have null passwords.
-.SS null passwords (G)
-Allow or disallow access to accounts that have null passwords.
+See also url(bf(smbpasswd (5)))(smbpasswd.5.html).
-.B Default:
+ bf(Default:)
null passwords = no
-.B Example:
+ bf(Example:)
null passwords = yes
.SS ole locking compatibility (G)
.SS public (S)
A synonym for this parameter is 'guest ok'.
-If this parameter is 'yes' for a service, then no password is required
-to connect to the service. Privileges will be those of the guest
-account.
-
-See the section below on user/password validation for more information about
-this option.
-
-.B Default:
- public = no
-
-.B Example:
- public = yes
-
.SS queuepause command (S)
This parameter specifies the command to be executed on the server host in
order to pause the printerqueue.
git.samba.org / samba.git / blobdiff