admin users (S)

This is a list of users who will be granted administrative privileges on the share. This means that they will do all file operations as the super-user (root).

You should use this option very carefully, as any user in this list will be able to do anything they like on the share, irrespective of file permissions.

.B Default: no admin users

.B Example: admin users = jason

Note that if you just want all printers in your printcap file loaded then the "load printers" option is easier.

.B Default: no auto services

.B Example: auto services = fred lp colorlp

This parameter is a comma delimited set of hosts which are permitted to access a service.

If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting.

You can specify the hosts by name or IP number. For example, you could restrict access to only the hosts on a Class C subnet with something like "allow hosts = 150.203.5.". The full syntax of the list is described in the man page .BR hosts_access (5).

You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups. The EXCEPT keyword can also be used to limit a wildcard list. The following examples may provide some help:

Example 1: allow all IPs in 150.203.*.* except one

hosts allow = 150.203. EXCEPT 150.203.6.66

Example 2: allow hosts that match the given network/netmask

hosts allow = 150.203.15.0/255.255.255.0

Example 3: allow a couple of hosts

hosts allow = lapland, arvidsjaur

Example 4: allow only hosts in netgroup "foonet" or localhost, but deny access from one particular host

hosts allow = @foonet, localhost hosts deny = pirate

Note that access still requires suitable user-level passwords.

See .BR testparm (1) for a way of testing your host access to see if it does what you expect.

.B Default: none (i.e., all hosts permitted access)

.B Example: allow hosts = 150.203.5. myhost.mynet.edu.au

.B Default: available = yes

.B Example: available = no

For name service it causes nmbd to bind to ports 137 and 138 on the interfaces listed in the 'interfaces' parameter. nmbd also binds to the 'all addresses' interface (0.0.0.0) on ports 137 and 138 for the purposes of reading broadcast messages. If this option is not set then nmbd will service name requests on all of these sockets. If "bind interfaces only" is set then nmbd will check the source address of any packets coming in on the broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the 'interfaces' parameter list. As unicast packets are received on the other sockets it allows nmbd to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the 'interfaces' list. IP Source address spoofing does defeat this simple check, however so it must not be used seriously as a security feature for nmbd.

For file service it causes smbd to bind only to the interface list given in the 'interfaces' parameter. This restricts the networks that smbd will serve to packets coming in those interfaces. Note that you should not use this parameter for machines that are serving ppp or other intermittant or non-broadcast network interfaces as it will not cope with non-permanent interfaces.

.B Default: bind interfaces only = False

.B Example: bind interfaces only = True

.B Default: browseable = Yes

.B Default: browse list = Yes

.B Default

character set =

.B Example

character set = iso8859-1

This parameter co-operates with the "valid chars" parameter in determining what characters are valid in filenames and how capitalization is done. It has been added as a convenience for clients whose code page is either 437 or 850 so a convoluted "valid chars" string does not have to be determined. If you set both this parameter and the "valid chars" parameter the "client code page" parameter MUST be set before the "valid chars" in the smb.conf file. The "valid chars" string will then augment the character settings in the "client code page" parameter.

If "client code page" is set to a value other than 850 or 437 it will default to 850.

See also : "valid chars".

.B Default

client code page = 850

.B Example

client code page = 437

If you want to set the string that is displayed next to the machine name then see the server string command.

.B Default: No comment string

.B Example: comment = Fred's Files

This feature lets you set up a 'template' service and create similar services easily. Note that the service being copied must occur earlier in the configuration file than the service doing the copying.

.B Default: none

When a file 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 file. Any bit *not* set here will be removed from the modes set on a file when it is created.

The default value of this parameter removes the 'group' and 'other' write and execute bits from the UNIX modes.

Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the "force create mode" parameter which is set to 000 by default.

For Samba 1.9.17 and above this parameter no longer affects directory modes. See the parameter 'directory mode' for details.

See also the "force create mode" parameter for forcing particular mode bits to be set on created files. See also the "directory mode" parameter for masking mode bits on created directories.

.B Default: create mask = 0744

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.

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.

.B Default: dead time = 0

The default will be the debug level specified on the command line.

default case (S)

See the section on "NAME MANGLING" Also note the addition of "short preserve case"

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).

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 public, read-only service.

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.

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.

.B Example: default service = pub [pub] path = /%S

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

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.

.B Default: none (i.e., no hosts specifically excluded)

.B Example: deny hosts = 150.203.4. badhost.mynet.edu.au

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.

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.

Note: Your script should 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 and remaining space will be used.

.B Example: dfree command = /usr/local/samba/bin/dfree

Where the script dfree (which must be made executable) could be

.nf #!/bin/sh df $1 | tail -1 | awk '{print $2" "$4}' .fi

or perhaps (on Sys V)

.nf #!/bin/sh /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}' .fi

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 modes set on a directory when it is created.

The default value of this parameter removes the 'group' and 'other' write bits from the UNIX mode, allowing only the user who owns the directory to modify it.

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).

See the "force directory mode" 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.

.B Default: directory mask = 0755

.B Example: directory mask = 0775

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 :-)

.B Default: none (i.e., all directories are OK to descend)

.B Example: dont descend = /proc,/dev

.B Default: dos filetimes = False

.B 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.

.B Default: dos filetime resolution = False

.B Example: dos filetime resolution = True

See also the parameter "create mask" for details on masking mode bits on created files.

.B Default: force create mode = 000

.B Example: force create mode = 0755

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.

.B Default: force directory mode = 000

.B Example: force directory mode = 0755

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 Default: no forced group

.B Example: force group = agroup

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.

.B Default: no forced user

.B Example: force user = auser

.B Default: getwd cache = No

.B Example: getwd cache = Yes

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 .

Note that as of version 1.9 of Samba this option may be set differently for each service.

.B Default: specified at compile time

guest only (S)

See the section below on user/password validation for more information about this option.

.B Default: guest only = no

.B Default: hide dot files = yes

.B Example: hide dot files = no

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 must be a unix path, not a DOS path and must not include the unix directory separator "/".

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.

See also "hide dot files", "veto files" and "case sensitive"

.B Default No files or directories are hidden by this option (dot files are hidden by default because of the "hide dot files" option).

.B Example 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.

username server:/some/file/system

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.

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.

See also "nis homedir"

.B Default: homedir map = auto.home

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.

NOTE: The use of 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 :-)

.B Default No host equivalences

.B Example hosts equiv = /etc/hosts.equiv

A name starting with @ is interpreted as a UNIX group.

The current servicename is substituted for %S. This is useful in the [homes] section.

See also "valid users"

.B Default No invalid users

.B Example invalid users = root fred admin @wheel

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.

.B Default: keep alive = 0

.B Example: keep alive = 60

.B Default: load printers = yes

.B Example: load printers = no

.B Default: local master = yes

.B Default: lock directory = /tmp/samba

.B Example: lock directory = /usr/local/samba/var/locks

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 "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).

Be careful about disabling locking either globally or in a specific service, as lack of locking may result in data corruption.

.B Default: locking = yes

.B Example: locking = no

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.

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.

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.

.B Default: Currently no default value is given to this string

.B Example for HPUX: lppause command = /usr/bin/lpalt %p-%j -p0

This command should be a program or script which takes a printer name 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.

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 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.

.B Default: depends on the setting of "printing ="

.B Example: 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.

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 lpresume command as the PATH may not be available to the server.

.B Default: Currently no default value is given to this string

.B Example for HPUX: lpresume command = /usr/bin/lpalt %p-%j -p2

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 %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 lprm command as the PATH may not be available to the server.

.B Default: depends on the setting of "printing ="

.B Example 1: lprm command = /usr/bin/lprm -P%p %j

.B Example 2: lprm command = /usr/bin/cancel %p-%j

Warning: If two clients use the same magic script in the same directory the output file content is undefined. .B Default: magic output = .out

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).

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.

Magic scripts are EXPERIMENTAL and should NOT be relied upon.

.B Default: None. Magic scripts disabled.

.B Example: magic script = user.csh

So to map 'html' to 'htm' you put:

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 *)

.B default: no mangled map

.B Example: mangled map = (*;1 *)

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

If mangling is used then the mangling algorithm is as follows: .RS - 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.

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.

.B Default: mangled names = yes

.B Default: mangling char = ~

.B Example: mangling char = ^

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).

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

.B Default: mangled stack = 50

.B Example: mangled stack = 100

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.

.B Default: map archive = yes

.B Example: map archive = no

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.

.B Default: map hidden = no

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.

.B Default: map system = no

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

.B Default: max connections = 0

.B Example: max connections = 10

Note that this option does not limit the amount of data you can put on the disk. In the above case you could still store much more than 100 MB on the disk, but if a client ever asks for the amount of free disk space or the total disk size then the result will be bounded by the amount specified in "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.

.B Default: max disk size = 0

.B Example: max disk size = 1000

.B Default: nis homedir = false

.B Example: nis homedir = true

.B Default: networkstation user login = yes

.B Example: networkstation user login = no

.B Default: null passwords = no

.B Example: null passwords = yes

Note that this also means Samba won't try to deduce usernames from the service name. This can be annoying for the [homes] section. To get around this you could use "user = %S" which means your "user" list will be just the service name, which for home directories is the name of the user.

.B Default: only user = False

.B Example: only user = True

Oplocks may be selectively turned off on certain files on a per share basis. See the 'veto oplock files' parameter.

.B Default: oplocks = True

.B Example: oplocks = False

This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS+ etc).

The string can contain the macros %o and %n which are substituted for the old and new passwords respectively. It can also contain the standard macros \en \er \et and \es to give line-feed, carriage-return, tab and space.

The string can also contain a * which matches any sequence of characters.

Double quotes can be used to collect strings with spaces in them into a single string.

If the send string in any part of the chat sequence is a fullstop "." then no string is sent. Similarly, is the expect string is a fullstop then no string is expected.

.B Example: passwd chat = "*Enter OLD password*" %o\en "*Enter NEW password*" %n\en \e "*Reenter NEW password*" %n\en "*Password changed*"

.B Default: passwd chat = *old*password* %o\en *new*password* %n\en *new*password* %n\en *changed*

This is only necessary if you have enabled remote password changing at compile time. Any occurrences of %u will be replaced with the user name.

Also note that many passwd programs insist in "reasonable" passwords, such as a minimum length, or the inclusion of mixed case chars and digits. This can pose a problem as some clients (such as Windows for Workgroups) uppercase the password before sending it.

.B Default: passwd program = /bin/passwd

.B Example: passwd program = /sbin/passwd %u

This parameter defines the maximum number of characters that may be upper case in passwords.

For example, say the password given was "FRED". If .B password level is set to 1 (one), the following combinations would be tried if "FRED" failed: "Fred", "fred", "fRed", "frEd", "freD". If .B password level was set to 2 (two), the following combinations would also be tried: "FRed", "FrEd", "FreD", "fREd", "fReD", "frED". And so on.

The higher value this parameter is set to the more likely it is that a mixed case password will be matched against a single case password. However, you should be aware that use of this parameter reduces security and increases the time taken to process a new connection.

A value of zero will cause only two attempts to be made - the password as is and the password in all-lower case.

If you find the connections are taking too long with this option then you probably have a slow crypt() routine. Samba now comes with a fast "ufc crypt" that you can select in the Makefile. You should also make sure the PASSWORD_LENGTH option is correct for your system in local.h and includes.h. On most systems only the first 8 chars of a password are significant so PASSWORD_LENGTH should be 8, but on some longer passwords are significant. The includes.h file tries to select the right length for your system.

.B Default: password level = 0

.B Example: password level = 4

This parameter specifies a directory to which the user of the service is to be given access. In the case of printable services, this is where print data will spool prior to being submitted to the host for printing.

For a printable service offering guest access, the service should be readonly and the path should be world-writable and have the sticky bit set. This is not mandatory of course, but you probably won't get the results you expect if you do otherwise.

Any occurrences of %u in the path will be replaced with the username that the client is connecting as. Any occurrences of %m will be replaced by the name of the machine they are connecting from. These replacements are very useful for setting up pseudo home directories for users.

Note that this path will be based on 'root dir' if one was specified. .B Default: none

.B Example: path = /home/fred+

This is most useful when you have lots of PCs that persist in putting a control-D at the start of print jobs, which then confuses your printer.

.B Default: postscript = False

.B Example: postscript = True

Use this option with caution, because if there are several hosts (whether samba servers, Windows 95 or NT) that are preferred master browsers on the same subnet, they will each periodically and continuously attempt to become the local master browser. This will result in unnecessary broadcast traffic and reduced browsing capabilities.

See .B os level = nn

.B Default: preferred master = no

preload

The print command is simply a text string. It will be used verbatim, with two exceptions: All occurrences of "%s" will be replaced by the appropriate spool file name, and all occurrences of "%p" will be replaced by the appropriate printer name. The spool file name is generated automatically by the server, the printer name is discussed below.

The full path name will be used for the filename if %s is not preceded by a /. If you don't like this (it can stuff up some lpq output) then use %f instead. Any occurrences of %f get replaced by the spool filename without the full path at the front.

The print command MUST contain at least one occurrence of "%s" or %f - the "%p" is optional. At the time a job is submitted, if no printer name is supplied the "%p" will be silently removed from the printer command.

If specified in the [global] section, the print command given will be used for any printable service that does not have its own print command specified.

If there is neither a specified print command for a printable service nor a global print command, spool files will be created but not processed and (most importantly) not removed.

Note that printing may fail on some UNIXes from the "nobody" account. If this happens then create an alternative guest account that can print and set the "guest account" in the [global] section.

You can form quite complex print commands by realising that they are just passed to a shell. For example the following will log a print job, print the file, then remove it. Note that ; is the usual separator for command in shell scripts.

print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s

You may have to vary this command considerably depending on how you normally print files on your system.

.B Default: print command = lpr -r -P %p %s

printable (S)

If this parameter is 'yes', then clients may open, write to and submit spool files on the directory specified for the service.

Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data. The 'read only' parameter controls only non-printing access to the resource.

.B Default: printable = no

.B Example: printable = yes

On SystemV systems that use lpstat to list available printers you can use "printcap name = lpstat" to automatically obtain lists of available printers. This is the default for systems that define SYSV at compile time in Samba (this includes most SystemV based systems). If "printcap name" is set to lpstat on these systems then Samba will launch "lpstat -v" and attempt to parse the output to obtain a printer list.

A minimal printcap file would look something like this:

print1|My Printer 1 .br print2|My Printer 2 .br print3|My Printer 3 .br print4|My Printer 4 .br print5|My Printer 5

where the | separates aliases of a printer. The fact that the second alias has a space in it gives a hint to Samba that it's a comment.

NOTE: Under AIX the default printcap name is "/etc/qconfig". Samba will assume the file is in AIX "qconfig" format if the string "/qconfig" appears in the printcap filename.

.B Default: printcap name = /etc/printcap

.B Example: printcap name = /etc/myprintcap

This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent.

If specified in the [global] section, the printer name given will be used for any printable service that does not have its own printer name specified.

.B Default: none (but may be 'lp' on many systems)

.B Example: printer name = laserwriter

You need to set this parameter to the exact string (case sensitive) that describes the appropriate printer driver for your system. If you don't know the exact string to use then you should first try with no "printer driver" option set and the client will give you a list of printer drivers. The appropriate strings are shown in a scrollbox after you have chosen the printer manufacturer.

.B Example: printer driver = HP LaserJet 4L

SAMBA_INSTALL_DIRECTORY/lib/printers.def

This file is created from Windows 95 'msprint.def' files found on the Windows 95 client system. For more details on setting up serving of printer drivers to Windows 95 clients, see the documentation file docs/PRINTER_DRIVER.txt.

.B Default: None (set in compile).

.B Example: printer driver file = /usr/local/samba/printers/drivers.def

Related parameters. .B printer driver location

\e\eMACHINE\ePRINTER$

Where MACHINE is the NetBIOS name of your Samba server, and PRINTER$ is a share you set up for serving printer driver files. For more details on setting this up see the documentation file docs/PRINTER_DRIVER.txt.

.B Default: None

.B Example: printer driver location = \e\eMACHINE\ePRINTER$

Related paramerers. .B printer driver file

Currently six printing styles are supported. They are "printing = bsd", "printing = sysv", "printing = hpux", "printing = aix", "printing = qnx" and "printing = plp".

To see what the defaults are for the other print commands when using these three options use the "testparm" program.

As of version 1.9.18 of Samba this option can be set on a per printer basis

Possible values are CORE, COREPLUS, LANMAN1, LANMAN2 and NT1. The relative merits of each are discussed in the README file.

Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol.

.B Default: protocol = NT1

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

See also the "write list" option

.B Default: read list =

.B Example: read list = mary, @students

read prediction (G)

Default:

Example:

read raw (G)

If enabled, raw reads allow reads of 65535 bytes in one packet. This typically provides a major performance benefit.

However, some clients either negotiate the allowable block size incorrectly or are incapable of supporting larger block sizes, and for these clients you may need to disable raw reads.

In general this parameter should be viewed as a system tuning tool and left severely alone. See also .B write raw.

.B Default: read raw = yes

root dir (G)

root directory (G)

The server will chroot() to this directory on startup. This is not strictly necessary for secure operation. Even without it the server will deny access to files not in one of the service entries. It may also check for, and deny access to, soft links to other parts of the filesystem, or attempts to use .. in file names to access other directories (depending on the setting of the "wide links" parameter).

Adding a "root dir" entry other than "/" adds an extra level of security, but at a price. It absolutely ensures that no access is given to files not in the sub-tree specified in the "root dir" option, *including* some files needed for complete operation of the server. To maintain full operability of the server you will need to mirror some system files into the "root dir" tree. In particular you will need to mirror /etc/passwd (or a subset of it), and any binaries or configuration files needed for printing (if required). The set of files that must be mirrored is operating system dependent.

.B Default: root directory = /

The option sets the "security mode bit" in replies to protocol negotiations to turn share level security on or off. Clients decide based on this bit whether (and how) to transfer user and password information to the server.

The default is "security=SHARE", mainly because that was the only option at one stage.

The alternatives are "security = user" or "security = server".

If your PCs use usernames that are the same as their usernames on the UNIX machine then you will want to use "security = user". If you mostly use usernames that don't exist on the UNIX box then use "security = share".

There is a bug in WfWg that may affect your decision. When in user level security a WfWg client will totally ignore the password you type in the "connect drive" dialog box. This makes it very difficult (if not impossible) to connect to a Samba service as anyone except the user that you are logged into WfWg as.

If you use "security = server" then Samba will try to validate the username/password by passing it to another SMB server, such as an NT box. If this fails it will revert to "security = USER".

See the "password server" option for more details.

.B Default: security = SHARE

It also sets what will appear in browse lists next to the machine name.

A %v will be replaced with the Samba version number.

A %h will be replaced with the hostname.

.B Default: server string = Samba %v

.B Example: server string = University of GNUs Samba Server

The setdir command is only implemented in the Digital Pathworks client. See the Pathworks documentation for details.

.B Default: set directory = no

.B Example: set directory = yes

.B Default shared mem size = 102400

You must get this path right for many services to work correctly.

.B Default: taken from Makefile

.B Example: smbrun = /usr/local/samba/bin/smbrun

Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned.

This option will typically be used to tune your Samba server for optimal performance for your local network. There is no way that Samba can know what the optimal parameters are for your net, so you must experiment and choose them yourself. I strongly suggest you read the appropriate documentation for your operating system first (perhaps "man setsockopt" will help).

You may find that on some systems Samba will say "Unknown socket option" when you supply an option. This means you either mis-typed it or you need to add an include file to includes.h for your OS. If the latter is the case please send the patch to me (samba-bugs@samba.anu.edu.au).

Any of the supported socket options may be combined in any way you like, as long as your OS allows it.

This is the list of socket options currently settable using this option:

SO_KEEPALIVE

SO_REUSEADDR

SO_BROADCAST

TCP_NODELAY

IPTOS_LOWDELAY

IPTOS_THROUGHPUT

SO_SNDBUF *

SO_RCVBUF *

SO_SNDLOWAT *

SO_RCVLOWAT *

Those marked with a * take an integer argument. The others can optionally take a 1 or 0 argument to enable or disable the option, by default they will be enabled if you don't specify 1 or 0.

To specify an argument use the syntax SOME_OPTION=VALUE for example SO_SNDBUF=8192. Note that you must not have any spaces before or after the = sign.

If you are on a local network then a sensible option might be

socket options = IPTOS_LOWDELAY

If you have an almost unloaded local network and you don't mind a lot of extra CPU usage in the server then you could try

socket options = IPTOS_LOWDELAY TCP_NODELAY

If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT.

Note that several of the options may cause your Samba server to fail completely. Use these options with caution!

.B Default: no socket options

.B Example: socket options = IPTOS_LOWDELAY

With this disabled .B smbstatus won't be able to tell you what connections are active.

.B Default: status = yes

.B Example: status = no

When strict locking is "no" the server does file lock checks only when the client explicitly asks for them.

Well behaved clients always ask for lock checks when it is important, so in the vast majority of cases "strict locking = no" is preferable.

.B Default: strict locking = no

.B Example: strict locking = yes

.B Default: strip dot = no

.B Example: strip dot = yes

.B Default:

syslog = 1

.B Default: syslog only = no

.B Default: time offset = 0

.B Example: time offset = 60

.B Default: time server = False

.B Example: time server = True

.B Default: unix realname = no

.B Example: unix realname = yes

username (S)

Multiple users may be specified in a comma-delimited list, in which case the supplied password will be tested against each username in turn (left to right).

The username= line is needed only when the PC is unable to supply its own username. This is the case for the coreplus protocol or where your users have different WfWg usernames to UNIX usernames. In both these cases you may also be better using the \e\eserver\eshare%user syntax instead.

The username= line is not a great solution in many cases as it means Samba will try to validate the supplied password against each of the usernames in the username= line in turn. This is slow and a bad idea for lots of users in case of duplicate passwords. You may get timeouts or security breaches using this parameter unwisely.

Samba relies on the underlying UNIX security. This parameter does not restrict who can login, it just offers hints to the Samba server as to what usernames might correspond to the supplied password. Users can login as whoever they please and they will be able to do no more damage than if they started a telnet session. The daemon runs as the user that they log in as, so they cannot do anything that user cannot do.

To restrict a service to a particular set of users you can use the "valid users=" line.

If any of the usernames begin with a @ then the name will be looked up in the groups file and will expand to a list of all users in the group of that name. Note that searching though a groups file can take quite some time, and some clients may time out during the search.

See the section below on username/password validation for more information on how this parameter determines access to the services.

.B Default: The guest account if a guest service, else the name of the service.

.B Examples: username = fred username = fred, mary, jack, jane, @users, @pcgroup

If this is empty (the default) then any user can login. If a username is in both this list and the "invalid users" list then access is denied for that user.

The current servicename is substituted for %S. This is useful in the [homes] section.

See also "invalid users"

.B Default No valid users list. (anyone can login)

.B Example valid users = greg, @pcusers

Each entry must be a unix path, not a DOS path and must not include the unix directory separator "/".

Note that the case sensitivity option is applicable in vetoing files.

One feature of the veto files parameter that it is important to be aware of, is that if a directory contains nothing but files that match the veto files parameter (which means that Windows/DOS clients cannot ever see them) is deleted, the veto files within that directory *are automatically deleted* along with it, if the user has UNIX permissions to do so. 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 files" and "case sensitive"

.B Default No files or directories are vetoed.

.B Examples Example 1. Veto any files containing the word Security, any ending in .tmp, and any directory containing the word root.

veto files = /*Security*/*.tmp/*root*/

Example 2. Veto the Apple specific files that a NetAtalk server creates.

veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/

.B Default No files are vetoed for oplock grants.

.B Examples You might want to do this on files that you know will be heavily contended for by clients. A good example of this is in the NetBench SMB benchmark program, which causes heavy client contention for files ending in .SEM. To cause Samba not to grant oplocks on these files you would use the line (either in the [global] section or in the section for the particular NetBench share :

veto oplock files = /*.SEM/

The default is the name of the share

.B Default: wide links = yes

.B Example: wide links = no

If this parameter is 'no', then users of a service may not create or modify files in the service's directory.

Note that a printable service ('printable = yes') will ALWAYS allow writing to the directory (user privileges permitting), but only via spooling operations.

.B Default: writable = no

Note that if a user is in both the read list and the write list then they will be given write access.

See also the "read list" option

.B Default: write list =

.B Example: write list = admin, root, @staff

.B Default: write raw = yes

.B Example: write raw = no