diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manpages/pdbedit.8 | 39 | ||||
| -rw-r--r-- | docs/manpages/smb.conf.5 | 1693 | ||||
| -rw-r--r-- | docs/manpages/vfstest.1 | 178 |
3 files changed, 1160 insertions, 750 deletions
diff --git a/docs/manpages/pdbedit.8 b/docs/manpages/pdbedit.8 index e2f5531d5d..523751712d 100644 --- a/docs/manpages/pdbedit.8 +++ b/docs/manpages/pdbedit.8 @@ -1,14 +1,15 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "PDBEDIT" "8" "24 April 2002" "" "" +.TH "PDBEDIT" "8" "20 August 2002" "" "" .SH NAME pdbedit \- manage the SAM database .SH SYNOPSIS -.sp -\fBpdbedit\fR [ \fB-l\fR ] [ \fB-v\fR ] [ \fB-w\fR ] [ \fB-u username\fR ] [ \fB-f fullname\fR ] [ \fB-h homedir\fR ] [ \fB-d drive\fR ] [ \fB-s script\fR ] [ \fB-p profile\fR ] [ \fB-a\fR ] [ \fB-m\fR ] [ \fB-x\fR ] [ \fB-i passdb-backend\fR ] [ \fB-e passdb-backend\fR ] [ \fB-D debuglevel\fR ] + +\fBpdbedit\fR [ \fB-l\fR ] [ \fB-v\fR ] [ \fB-w\fR ] [ \fB-u username\fR ] [ \fB-f fullname\fR ] [ \fB-h homedir\fR ] [ \fB-d drive\fR ] [ \fB-s script\fR ] [ \fB-p profile\fR ] [ \fB-a\fR ] [ \fB-m\fR ] [ \fB-x\fR ] [ \fB-i passdb-backend\fR ] [ \fB-e passdb-backend\fR ] [ \fB-b passdb-backend\fR ] [ \fB-D debuglevel\fR ] + .SH "DESCRIPTION" .PP This tool is part of the Sambasuite. @@ -34,12 +35,11 @@ the ':' character. Example: \fBpdbedit -l\fR -.sp + .nf sorce:500:Simo Sorce samba:45:Test User -.sp .fi .TP \fB-v\fR @@ -49,7 +49,7 @@ out the account fields in a descriptive format. Example: \fBpdbedit -l -v\fR -.sp + .nf --------------- username: sorce @@ -70,7 +70,6 @@ Example: \fBpdbedit -l -v\fR Logon Script: Profile Path: \\\\BERSERKER\\profile -.sp .fi .TP \fB-w\fR @@ -81,12 +80,11 @@ out the account fields in a format compatible with the Example: \fBpdbedit -l -w\fR -.sp + .nf sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX ]:LCT-00000000: samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX ]:LCT-3BFA1E8D: -.sp .fi .TP \fB-u username\fR @@ -138,11 +136,10 @@ the -u switch. When adding a new user pdbedit will also ask for the password to be used Example: \fBpdbedit -a -u sorce\fR -.sp + .nf new password: retype new password -.sp .fi .TP \fB-m\fR @@ -161,11 +158,12 @@ from the database. It need the username be specified with the Example: \fBpdbedit -x -u bob\fR .TP \fB-i passdb-backend\fR -Use a different passdb backend to retrieve users than the one specified in smb.conf. +Use a different passdb backend to retrieve users than the one specified in smb.conf. Can be used to import data into your +local user database. This option will ease migration from one passdb backend to another. -Example: \fBpdbedit -i smbpasswd:/etc/smbpasswd.old -e tdbsam:/etc/samba/passwd.tdb\fR +Example: \fBpdbedit -i smbpasswd:/etc/smbpasswd.old\fR .TP \fB-e passdb-backend\fR Export all currently available users to the specified password database backend. @@ -173,6 +171,11 @@ Export all currently available users to the specified password database backend. This option will ease migration from one passdb backend to another and will ease backupping Example: \fBpdbedit -e smbpasswd:/root/samba-users.backup\fR +.TP +\fB-b passdb-backend\fR +Use a different default passdb backend. + +Example: \fBpdbedit -b xml:/root/pdb-backup.xml -l\fR .SH "NOTES" .PP This command may be used only by root. @@ -194,6 +197,6 @@ to the way the Linux kernel is developed. The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at -ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smb.conf.5 b/docs/manpages/smb.conf.5 index caa27103db..8918325428 100644 --- a/docs/manpages/smb.conf.5 +++ b/docs/manpages/smb.conf.5 @@ -1,9 +1,9 @@ -.\" This manpage has been automatically generated by docbook2man-spec -.\" from a DocBook document. docbook2man-spec can be found at: -.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMB.CONF" "5" "15 August 2002" "" "" +.TH "SMB.CONF" "5" "20 August 2002" "" "" .SH NAME smb.conf \- The configuration file for the Samba suite .SH "SYNOPSIS" @@ -23,7 +23,8 @@ until the next section begins. Sections contain parameters of the form .PP \fIname\fR = \fIvalue -\fR.PP +\fR +.PP The file is line-based - that is, each newline-terminated line represents either a comment, a section name or a parameter. .PP @@ -90,14 +91,13 @@ access than the host system grants. The following sample section defines a file space share. The user has write access to the path \fI/home/bar\fR. The share is accessed via the share name "foo": -.sp + .nf [foo] path = /home/bar writeable = true -.sp .fi .PP The following sample section defines a printable share. @@ -106,7 +106,7 @@ access permitted is via calls to open, write to and close a spool file. The \fBguest ok\fR parameter means access will be permitted as the default guest user (specified elsewhere): -.sp + .nf [aprinter] path = /usr/spool/public @@ -115,16 +115,15 @@ elsewhere): guest ok = true -.sp .fi .SH "SPECIAL SECTIONS" -.SS "THE GLOBAL SECTION" +.SS "THE [GLOBAL] SECTION" .PP parameters in this section apply to the server as a whole, or are defaults for sections which do not specifically define certain items. See the notes under PARAMETERS for more information. -.SS "THE HOMES SECTION" +.SS "THE [HOMES] SECTION" .PP If a section called homes is included in the configuration file, services connecting clients to their @@ -152,38 +151,31 @@ If you decide to use a \fBpath =\fR line in your [homes] section then you may find it useful to use the %S macro. For example : .PP -.PP \fBpath = /data/pchome/%S\fR .PP -.PP would be useful if you have different home directories for your PCs than for UNIX access. .PP -.PP This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss. .PP -.PP A similar process occurs if the requested section name is "homes", except that the share name is not changed to that of the requesting user. This method of using the [homes] section works well if different users share a client PC. .PP -.PP The [homes] section can specify all the parameters a normal service section can specify, though some make more sense than others. The following is a typical and suitable [homes] section: -.PP -.sp + .nf [homes] writeable = yes -.sp .fi .PP An important point is that if guest access is specified @@ -193,15 +185,13 @@ In the very unlikely event that this is actually desirable, it would be wise to also specify \fBread only access\fR. .PP -.PP Note that the \fBbrowseable\fR flag for auto home directories will be inherited from the global browseable flag, not the [homes] browseable flag. This is useful as it means setting \fBbrowseable = no\fR in the [homes] section will hide the [homes] share but make any auto home directories visible. -.PP -.SS "THE PRINTERS SECTION" +.SS "THE [PRINTERS] SECTION" .PP This section works like [homes], but for printers. @@ -239,20 +229,17 @@ Note that the [printers] service MUST be printable - if you specify otherwise, the server will refuse to load the configuration file. .PP -.PP Typically the path specified would be that of a world-writeable spool directory with the sticky bit set on it. A typical [printers] entry would look like this: -.PP -.sp + .nf [printers] path = /usr/spool/public guest ok = yes printable = yes -.sp .fi .PP All aliases given for a printer in the printcap file @@ -260,45 +247,40 @@ are legitimate printer names as far as the server is concerned. If your printing subsystem doesn't work like that, you will have to set up a pseudo-printcap. This is a file consisting of one or more lines like this: -.PP -.sp + .nf alias|alias|alias|alias... -.sp .fi .PP Each alias should be an acceptable printer name for your printing subsystem. In the [global] section, specify -the new file as your printcap. The server will then only recognize +the new file as your printcap. The server will then only recognize names found in your pseudo-printcap, which of course can contain whatever aliases you like. The same technique could be used simply to limit access to a subset of your local printers. .PP -.PP An alias, by the way, is defined as any component of the first entry of a printcap record. Records are separated by newlines, components (if there are more than one) are separated by vertical bar symbols ('|'). .PP -.PP NOTE: On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use "printcap name = lpstat" to automatically obtain a list of printers. See the "printcap name" option for more details. -.PP .SH "PARAMETERS" .PP parameters define the specific attributes of sections. .PP Some parameters are specific to the [global] section -(e.g., \fBsecurity\fR). Some parameters are usable +(e.g., \fBsecurity\fR). Some parameters are usable in all sections (e.g., \fBcreate mode\fR). All others are permissible only in normal sections. For the purposes of the following descriptions the [homes] and [printers] -sections will be considered normal. The letter \fBG\fR +sections will be considered normal. The letter \fBG\fR in parentheses indicates that a parameter is specific to the [global] section. The letter \fBS\fR indicates that a parameter can be specified in a service specific @@ -361,15 +343,15 @@ 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". -Note that this paramater is not available when Samba listens +Note that this parameter is not available when Samba listens on port 445, as clients no longer send this information .TP \fB%M\fR the Internet name of the client machine. .TP \fB%N\fR -the name of your NIS home directory server. -This is obtained from your NIS auto.map entry. If you have +the name of your NIS home directory server. +This is obtained from your NIS auto.map entry. If you have not compiled Samba with the \fB--with-automount\fR option then this value will be the same as %L. .TP @@ -394,7 +376,7 @@ machine. Only some are recognized, and those may not be WinNT and Win2k. Anything else will be known as "UNKNOWN". If it gets it wrong then sending a level 3 log to samba@samba.org - <URL:mailto:samba@samba.org> should allow it to be fixed. +should allow it to be fixed. .TP \fB%I\fR The IP address of the client machine. @@ -408,7 +390,6 @@ The value of the environment variable .PP There are some quite creative things that can be done with these substitutions and other smb.conf options. -.PP .SH "NAME MANGLING" .PP Samba supports "name mangling" so that DOS and @@ -454,39 +435,43 @@ are lowercased. Default \fByes\fR. .PP By default, Samba 2.2 has the same semantics as a Windows NT server, in that it is case insensitive but case preserving. -.PP .SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION" .PP There are a number of ways in which a user can connect to a service. The server uses the following steps in determining if it will allow a connection to a specified service. If all the -steps fail, then the connection request is rejected. However, if one of the +steps fail, then the connection request is rejected. However, if one of the steps succeeds, then the following steps are not checked. .PP If the service is marked "guest only = yes" and the server is running with share-level security ("security = share") then steps 1 to 5 are skipped. -.IP 1. +.TP 3 +1. If the client has passed a username/password pair and that username/password pair is validated by the UNIX system's password programs then the connection is made as that username. Note that this includes the \\\\server\\service%\fIusername\fR method of passing a username. -.IP 2. +.TP 3 +2. If the client has previously registered a username with the system and now supplies a correct password for that username then the connection is allowed. -.IP 3. +.TP 3 +3. The client's NetBIOS name and any previously used user names are checked against the supplied password, if they match then the connection is allowed as the corresponding user. -.IP 4. +.TP 3 +4. If the client has previously validated a username/password pair with the server and the client has passed the validation token then that username is used. -.IP 5. +.TP 3 +5. If a "user = " field is given in the \fIsmb.conf\fR file for the service and the client has supplied a password, and that password matches (according to @@ -496,7 +481,8 @@ the username in the "user =" line. If one of the username in the "user =" list begins with a \&'@' then that name expands to a list of names in the group of the same name. -.IP 6. +.TP 3 +6. If the service is a guest service then a connection is made as the username given in the "guest account =" for the service, irrespective of the @@ -504,13 +490,16 @@ supplied password. .SH "COMPLETE LIST OF GLOBAL PARAMETERS" .PP Here is a list of all global parameters. See the section of -each parameter for details. Note that some are synonyms. +each parameter for details. Note that some are synonyms. .TP 0.2i \(bu \fIabort shutdown script\fR .TP 0.2i \(bu -\fIadd printer command\fR +\fIadd group script\fR +.TP 0.2i +\(bu +\fIaddprinter command\fR .TP 0.2i \(bu \fIadd share command\fR @@ -519,9 +508,18 @@ each parameter for details. Note that some are synonyms. \fIadd user script\fR .TP 0.2i \(bu +\fIadd user to group script\fR +.TP 0.2i +\(bu \fIadd machine script\fR .TP 0.2i \(bu +\fIdelete group script\fR +.TP 0.2i +\(bu +\fIads server\fR +.TP 0.2i +\(bu \fIalgorithmic rid base\fR .TP 0.2i \(bu @@ -579,7 +577,7 @@ each parameter for details. Note that some are synonyms. \fIdefault service\fR .TP 0.2i \(bu -\fIdelete printer command\fR +\fIdeleteprinter command\fR .TP 0.2i \(bu \fIdelete share command\fR @@ -588,12 +586,21 @@ each parameter for details. Note that some are synonyms. \fIdelete user script\fR .TP 0.2i \(bu +\fIdelete user from group script\fR +.TP 0.2i +\(bu \fIdfree command\fR .TP 0.2i \(bu +\fIdisable netbios\fR +.TP 0.2i +\(bu \fIdisable spoolss\fR .TP 0.2i \(bu +\fIdisable charset\fR +.TP 0.2i +\(bu \fIdns proxy\fR .TP 0.2i \(bu @@ -609,6 +616,9 @@ each parameter for details. Note that some are synonyms. \fIdomain master\fR .TP 0.2i \(bu +\fIdos charset\fR +.TP 0.2i +\(bu \fIencrypt passwords\fR .TP 0.2i \(bu @@ -627,12 +637,18 @@ each parameter for details. Note that some are synonyms. \fIhide unreadable\fR .TP 0.2i \(bu +\fIhide unwriteable files\fR +.TP 0.2i +\(bu \fIhomedir map\fR .TP 0.2i \(bu \fIhost msdfs\fR .TP 0.2i \(bu +\fIhostname lookups\fR +.TP 0.2i +\(bu \fIhosts equiv\fR .TP 0.2i \(bu @@ -768,6 +784,9 @@ each parameter for details. Note that some are synonyms. \fImin wins ttl\fR .TP 0.2i \(bu +\fIname cache timeout\fR +.TP 0.2i +\(bu \fIname resolve order\fR .TP 0.2i \(bu @@ -783,6 +802,9 @@ each parameter for details. Note that some are synonyms. \fInis homedir\fR .TP 0.2i \(bu +\fIntlm auth\fR +.TP 0.2i +\(bu \fInon unix account range\fR .TP 0.2i \(bu @@ -813,6 +835,9 @@ each parameter for details. Note that some are synonyms. \fIpanic action\fR .TP 0.2i \(bu +\fIparanoid server security\fR +.TP 0.2i +\(bu \fIpassdb backend\fR .TP 0.2i \(bu @@ -864,6 +889,9 @@ each parameter for details. Note that some are synonyms. \fIread size\fR .TP 0.2i \(bu +\fIrealm\fR +.TP 0.2i +\(bu \fIremote announce\fR .TP 0.2i \(bu @@ -897,6 +925,9 @@ each parameter for details. Note that some are synonyms. \fIsmb passwd file\fR .TP 0.2i \(bu +\fIsmb ports\fR +.TP 0.2i +\(bu \fIsocket address\fR .TP 0.2i \(bu @@ -942,6 +973,12 @@ each parameter for details. Note that some are synonyms. \fItotal print jobs\fR .TP 0.2i \(bu +\fIunicode\fR +.TP 0.2i +\(bu +\fIunix charset\fR +.TP 0.2i +\(bu \fIunix extensions\fR .TP 0.2i \(bu @@ -969,6 +1006,9 @@ each parameter for details. Note that some are synonyms. \fIutmp directory\fR .TP 0.2i \(bu +\fIwtmp directory\fR +.TP 0.2i +\(bu \fIwinbind cache time\fR .TP 0.2i \(bu @@ -993,6 +1033,9 @@ each parameter for details. Note that some are synonyms. \fIwins hook\fR .TP 0.2i \(bu +\fIwins partners\fR +.TP 0.2i +\(bu \fIwins proxy\fR .TP 0.2i \(bu @@ -1024,6 +1067,9 @@ each parameter for details. Note that some are synonyms. \fIblocking locks\fR .TP 0.2i \(bu +\fIblock size\fR +.TP 0.2i +\(bu \fIbrowsable\fR .TP 0.2i \(bu @@ -1195,6 +1241,9 @@ each parameter for details. Note that some are synonyms. \fImangling char\fR .TP 0.2i \(bu +\fImangling method\fR +.TP 0.2i +\(bu \fImap archive\fR .TP 0.2i \(bu @@ -1351,6 +1400,9 @@ each parameter for details. Note that some are synonyms. \fIveto oplock files\fR .TP 0.2i \(bu +\fIvfs path\fR +.TP 0.2i +\(bu \fIvfs object\fR .TP 0.2i \(bu @@ -1390,24 +1442,24 @@ Default: \fBNone\fR. Example: \fBabort shutdown script = /sbin/shutdown -c\fR .TP -\fBadd printer command (G)\fR +\fBaddprinter command (G)\fR With the introduction of MS-RPC based printing support for Windows NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon is now also available in the -"Printers..." folder displayed a share listing. The APW +"Printers..." folder displayed a share listing. The APW allows for printers to be add remotely to a Samba or Windows NT/2000 print server. For a Samba host this means that the printer must be -physically added to the underlying printing system. The \fIadd +physically added to the underlying printing system. The \fIadd printer command\fR defines a script to be run which will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition -to the \fIsmb.conf\fR file in order that it can be +to the \fIsmb.conf\fR file in order that it can be shared by \fBsmbd(8)\fR . -The \fIadd printer command\fR is +The \fIaddprinter command\fR is automatically invoked with the following parameter (in order: .RS @@ -1430,37 +1482,33 @@ order: \(bu \fIWindows 9x driver location\fR .RE -.PP + All parameters are filled in from the PRINTER_INFO_2 structure sent -by the Windows NT/2000 client with one exception. The "Windows 9x +by the Windows NT/2000 client with one exception. The "Windows 9x driver location" parameter is included for backwards compatibility -only. The remaining fields in the structure are generated from answers +only. The remaining fields in the structure are generated from answers to the APW questions. -.PP -.PP -Once the \fIadd printer command\fR has -been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to determine if the share defined by the APW -exists. If the sharename is still invalid, then \fBsmbd -\fRwill return an ACCESS_DENIED error to the client. -.PP -.PP -See also \fI delete printer command\fR, \fIprinting\fR, + +Once the \fIaddprinter command\fR has +been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to determine if the share defined by the APW +exists. If the sharename is still invalid, then \fBsmbd +\fR will return an ACCESS_DENIED error to the client. + +See also \fI deleteprinter command\fR, \fIprinting\fR, \fIshow add printer wizard\fR -.PP -.PP + Default: \fBnone\fR -.PP -.PP + Example: \fBaddprinter command = /usr/bin/addprinter -\fR.PP +\fR .TP \fBadd share command (G)\fR Samba 2.2.0 introduced the ability to dynamically -add and delete shares via the Windows NT 4.0 Server Manager. The +add and delete shares via the Windows NT 4.0 Server Manager. The \fIadd share command\fR is used to define an external program or script which will add a new service definition -to \fIsmb.conf\fR. In order to successfully +to \fIsmb.conf\fR. In order to successfully execute the \fIadd share command\fR, \fBsmbd\fR requires that the administrator be connected using a root account (i.e. uid == 0). @@ -1485,22 +1533,18 @@ directory on disk. \fIcomment\fR - comment string to associate with the new share. .RE -.PP -This parameter is only used for add file shares. To add printer shares, -see the \fIadd printer + +This parameter is only used for add file shares. To add printer shares, +see the \fIaddprinter command\fR. -.PP -.PP + See also \fIchange share command\fR, \fIdelete share command\fR. -.PP -.PP + Default: \fBnone\fR -.PP -.PP + Example: \fBadd share command = /usr/local/bin/addshare\fR -.PP .TP \fBadd machine script (G)\fR This is the full pathname to a script that will @@ -1508,13 +1552,25 @@ be run by smbd(8)when a machine is added to it's domain using the administrator username and password method. This option is only required when using sam back-ends tied to the -Unix uid method of RID calculation such as smbpasswd. This option is only +Unix uid method of RID calculation such as smbpasswd. This option is only available in Samba 3.0. Default: \fBadd machine script = <empty string> \fR + Example: \fBadd machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u -\fR.TP +\fR +.TP +\fBads server (G)\fR +If this option is specified, samba does +not try to figure out what ads server to use itself, but +uses the specified ads server. Either one DNS name or IP +address can be used. + +Default: \fBads server = \fR + +Example: \fBads server = 192.168.1.2\fR +.TP \fBadd user script (G)\fR This is the full pathname to a script that will be run \fBAS ROOT\fR by smbd(8) @@ -1535,33 +1591,33 @@ user given one argument of \fI%u\fR, which expands into the UNIX user name to create. When the Windows user attempts to access the Samba server, -at login (session setup in the SMB protocol) time, smbdcontacts the \fIpassword server\fR and +at login (session setup in the SMB protocol) time, smbdcontacts the \fIpassword server\fR and attempts to authenticate the given user with the given password. If the authentication succeeds then \fBsmbd\fR attempts to find a UNIX user in the UNIX password database to map the Windows user into. If this lookup fails, and \fIadd user script -\fRis set then \fBsmbd\fR will +\fR is set then \fBsmbd\fR will call the specified script \fBAS ROOT\fR, expanding any \fI%u\fR argument to be the user name to create. If this script successfully creates the user then \fBsmbd -\fRwill continue on as though the UNIX user +\fR will continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to match existing Windows NT accounts. -See also \fI security\fR, \fIpassword server\fR, +See also \fI security\fR, \fIpassword server\fR, \fIdelete user script\fR. Default: \fBadd user script = <empty string> \fR + Example: \fBadd user script = /usr/local/samba/bin/add_user %u\fR .TP \fBadd group script (G)\fR This is the full pathname to a script that will -be run \fBAS ROOT\fR by smbd(8) when a new group is requested. It will expand any \fI%g\fR to the group name passed. This script is only useful for installations using the Windows NT domain administration tools. - +be run \fBAS ROOT\fR by smbd(8)when a new group is requested. It will expand any \fI%g\fR to the group name passed. This script is only useful for installations using the Windows NT domain administration tools. .TP \fBadmin users (S)\fR This is a list of users who will be granted @@ -1576,8 +1632,20 @@ Default: \fBno admin users\fR Example: \fBadmin users = jason\fR .TP +\fBadd user to group script (G)\fR +Full path to the script that will be called when +a user is added to a group using the Windows NT domain administration +tools. It will be run by smbd(8) +\fBAS ROOT\fR. Any \fI%g\fR will be +replaced with the group name and any \fI%u\fR will +be replaced with the user name. + +Default: \fBadd user to group script = \fR + +Example: \fBadd user to group script = /usr/sbin/adduser %u %g\fR +.TP \fBallow hosts (S)\fR -Synonym for \fIhosts allow\fR. +Synonym for \fIhosts allow\fR. .TP \fBalgorithmic rid base (G)\fR This determines how Samba will use its @@ -1588,10 +1656,10 @@ Setting this option to a larger value could be useful to sites transitioning from WinNT and Win2k, as existing user and group rids would otherwise clash with sytem users etc. -All UIDs and GIDs must be able to be resolved into SIDs for -the correct operation of ACLs on the server. As such the algorithmic +All UIDs and GIDs must be able to be resolved into SIDs for +the correct operation of ACLs on the server. As such the algorithmic mapping can't be 'turned off', but pushing it 'out of the way' should -resolve the issues. Users and groups can then be assigned 'low' RIDs +resolve the issues. Users and groups can then be assigned 'low' RIDs in arbitary-rid supporting backends. Default: \fBalgorithmic rid base = 1000\fR @@ -1600,7 +1668,7 @@ Example: \fBalgorithmic rid base = 100000\fR .TP \fBallow trusted domains (G)\fR This option only takes effect when the \fIsecurity\fR option is set to -server or domain. +server or domain. If it is set to no, then attempts to connect to a resource from a domain or workgroup other than the one which smbdis running in will fail, even if that domain is trusted by the remote server @@ -1608,11 +1676,11 @@ doing the authentication. This is useful if you only want your Samba server to serve resources to users in the domain it is a member of. As -an example, suppose that there are two domains DOMA and DOMB. DOMB -is trusted by DOMA, which contains the Samba server. Under normal +an example, suppose that there are two domains DOMA and DOMB. DOMB +is trusted by DOMA, which contains the Samba server. Under normal circumstances, a user with an account in DOMB can then access the resources of a UNIX account with the same account name on the -Samba server even if they do not have an account in DOMA. This +Samba server even if they do not have an account in DOMA. This can make implementing a security boundary difficult. Default: \fBallow trusted domains = yes\fR @@ -1637,7 +1705,7 @@ Example: \fBannounce as = Win95\fR \fBannounce version (G)\fR This specifies the major and minor version numbers that nmbd will use when announcing itself as a server. The default -is 4.2. Do not change this parameter unless you have a specific +is 4.2. Do not change this parameter unless you have a specific need to set a Samba server to be a downlevel server. Default: \fBannounce version = 4.5\fR @@ -1645,14 +1713,14 @@ Default: \fBannounce version = 4.5\fR Example: \fBannounce version = 2.0\fR .TP \fBauto services (G)\fR -This is a synonym for the \fIpreload\fR. +This is a synonym for the \fIpreload\fR. .TP \fBauth methods (G)\fR This option allows the administrator to chose what authentication methods \fBsmbd\fR will use when authenticating -a user. This option defaults to sensible values based on \fI security\fR. +a user. This option defaults to sensible values based on \fI security\fR. Each entry in the list attempts to authenticate the user in turn, until -the user authenticates. In practice only one method will ever actually +the user authenticates. In practice only one method will ever actually be able to complete the authentication. Default: \fBauth methods = <empty string>\fR @@ -1676,7 +1744,7 @@ different ways. For name service it causes \fBnmbd\fR to bind to ports 137 and 138 on the interfaces listed in the interfaces parameter. \fBnmbd -\fRalso binds to the "all addresses" interface (0.0.0.0) +\fR 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 \fBnmbd\fR will service name requests on all of these sockets. If \fIbind interfaces @@ -1687,14 +1755,14 @@ interfaces in the \fIinterfaces\fR parameter list. As unicast packets are received on the other sockets it allows \fBnmbd\fR to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the -\fIinterfaces\fR list. IP Source address spoofing +\fIinterfaces\fR list. IP Source address spoofing does defeat this simple check, however so it must not be used seriously as a security feature for \fBnmbd\fR. For file service it causes smbd(8) -to bind only to the interface list given in the interfaces parameter. This restricts the networks that +to bind only to the interface list given in the interfaces parameter. This restricts the networks that \fBsmbd\fR will serve to packets coming in those -interfaces. Note that you should not use this parameter for machines +interfaces. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with non-permanent interfaces. @@ -1709,17 +1777,17 @@ by default connects to the \fBlocalhost - 127.0.0.1\fR address as an SMB client to issue the password change request. If \fIbind interfaces only\fR is set then unless the network address \fB127.0.0.1\fR is added to the -\fIinterfaces\fR parameter list then \fB smbpasswd\fR will fail to connect in it's default mode. +\fIinterfaces\fR parameter list then \fB smbpasswd\fR will fail to connect in it's default mode. \fBsmbpasswd\fR can be forced to use the primary IP interface -of the local host by using its \fI-r remote machine\fR +of the local host by using its \fI-r remote machine\fR parameter, with \fIremote machine\fR set to the IP name of the primary interface of the local host. The \fBswat\fR status page tries to connect with \fBsmbd\fR and \fBnmbd\fR at the address -\fB127.0.0.1\fR to determine if they are running. -Not adding \fB127.0.0.1\fR will cause \fB smbd\fR and \fBnmbd\fR to always show -"not running" even if they really are. This can prevent \fB swat\fR from starting/stopping/restarting \fBsmbd\fR +\fB127.0.0.1\fR to determine if they are running. +Not adding \fB127.0.0.1\fR will cause \fB smbd\fR and \fBnmbd\fR to always show +"not running" even if they really are. This can prevent \fB swat\fR from starting/stopping/restarting \fBsmbd\fR and \fBnmbd\fR. Default: \fBbind interfaces only = no\fR @@ -1741,11 +1809,30 @@ cannot be obtained. Default: \fBblocking locks = yes\fR .TP +\fBblock size (S)\fR +This parameter controls the behavior of +smbd(8)when reporting disk free +sizes. By default, this reports a disk block size of 1024 bytes. + +Changing this parameter may have some effect on the +efficiency of client writes, this is not yet confirmed. This +parameter was added to allow advanced administrators to change +it (usually to a higher value) and test the effect it has on +client write performance without re-compiling the code. As this +is an experimental option it may be removed in a future release. + +Changing this option does not change the disk free reporting +size, just the block size unit reported to the client. + +Default: \fBblock size = 1024\fR + +Example: \fBblock size = 65536\fR +.TP \fBbrowsable (S)\fR -See the \fI browseable\fR. +See the \fI browseable\fR. .TP \fBbrowse list (G)\fR -This controls whether \fBsmbd(8)\fRwill serve a browse list to +This controls whether \fBsmbd(8)\fRwill serve a browse list to a client doing a \fBNetServerEnum\fR call. Normally set to true. You should never need to change this. @@ -1771,7 +1858,7 @@ sensitive. This SMB allows a client to tell a server to "watch" a particular directory for any changes and only reply to the SMB request when a change has occurred. Such constant scanning of -a directory is expensive under UNIX, hence an \fBsmbd(8)\fRdaemon only performs such a scan +a directory is expensive under UNIX, hence an \fBsmbd(8)\fRdaemon only performs such a scan on each requested directory once every \fIchange notify timeout\fR seconds. @@ -1783,10 +1870,10 @@ Would change the scan time to every 5 minutes. .TP \fBchange share command (G)\fR Samba 2.2.0 introduced the ability to dynamically -add and delete shares via the Windows NT 4.0 Server Manager. The +add and delete shares via the Windows NT 4.0 Server Manager. The \fIchange share command\fR is used to define an external program or script which will modify an existing service definition -in \fIsmb.conf\fR. In order to successfully +in \fIsmb.conf\fR. In order to successfully execute the \fIchange share command\fR, \fBsmbd\fR requires that the administrator be connected using a root account (i.e. uid == 0). @@ -1811,21 +1898,17 @@ directory on disk. \fIcomment\fR - comment string to associate with the new share. .RE -.PP -This parameter is only used modify existing file shares definitions. To modify + +This parameter is only used modify existing file shares definitions. To modify printer shares, use the "Printers..." folder as seen when browsing the Samba host. -.PP -.PP + See also \fIadd share command\fR, \fIdelete share command\fR. -.PP -.PP + Default: \fBnone\fR -.PP -.PP + Example: \fBchange share command = /usr/local/bin/addshare\fR -.PP .TP \fBcomment (S)\fR This is a text field that is seen next to a share @@ -1834,7 +1917,7 @@ neighborhood or via \fBnet view\fR to list what shares are available. If you want to set the string that is displayed next to the -machine name then see the \fI server string\fR parameter. +machine name then see the \fI server string\fR parameter. Default: \fBNo comment string\fR @@ -1858,7 +1941,8 @@ If the config file doesn't exist then it won't be loaded clients). Example: \fBconfig file = /usr/local/samba/lib/smb.conf.%m -\fR.TP +\fR +.TP \fBcopy (S)\fR This parameter allows you to "clone" service entries. The specified service is simply duplicated under the @@ -1896,12 +1980,12 @@ parameter which is set to 000 by default. This parameter does not affect directory modes. See the parameter \fIdirectory mode -\fRfor details. +\fR for details. See also the \fIforce create mode\fR parameter for forcing particular mode -bits to be set on created files. See also the \fIdirectory mode\fR parameter for masking -mode bits on created directories. See also the \fIinherit permissions\fR parameter. +bits to be set on created files. See also the \fIdirectory mode\fR parameter for masking +mode bits on created directories. See also the \fIinherit permissions\fR parameter. Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the administrator wishes to enforce @@ -1912,7 +1996,7 @@ Default: \fBcreate mask = 0744\fR Example: \fBcreate mask = 0775\fR .TP \fBcreate mode (S)\fR -This is a synonym for \fI create mask\fR. +This is a synonym for \fI create mask\fR. .TP \fBcsc policy (S)\fR This stands for \fBclient-side caching @@ -1925,7 +2009,7 @@ servers. For example, shares containing roaming profiles can have offline caching disabled using \fBcsc policy = disable -\fR\&. +\fR. Default: \fBcsc policy = manual\fR @@ -1960,7 +2044,7 @@ are needed with a resolution of higher that seconds, this boolean parameter adds microsecond resolution to the timestamp message header when turned on. -Note that the parameter \fI debug timestamp\fR must be on for this to have an +Note that the parameter \fI debug timestamp\fR must be on for this to have an effect. Default: \fBdebug hires timestamp = no\fR @@ -1971,14 +2055,14 @@ forked smbd-process there may be hard to follow which process outputs which message. This boolean parameter is adds the process-id to the timestamp message headers in the logfile when turned on. -Note that the parameter \fI debug timestamp\fR must be on for this to have an +Note that the parameter \fI debug timestamp\fR must be on for this to have an effect. Default: \fBdebug pid = no\fR .TP \fBdebug timestamp (G)\fR Samba 2.2 debug log messages are timestamped -by default. If you are running at a high \fIdebug level\fR these timestamps +by default. If you are running at a high \fIdebug level\fR these timestamps can be distracting. This boolean parameter allows timestamping to be turned off. @@ -1990,47 +2074,47 @@ run as the connected user, this boolean parameter inserts the current euid, egid, uid and gid to the timestamp message headers in the log file if turned on. -Note that the parameter \fI debug timestamp\fR must be on for this to have an +Note that the parameter \fI debug timestamp\fR must be on for this to have an effect. Default: \fBdebug uid = no\fR .TP \fBdebuglevel (G)\fR -Synonym for \fI log level\fR. +Synonym for \fI log level\fR. .TP \fBdefault (G)\fR -A synonym for \fI default service\fR. +A synonym for \fI default service\fR. .TP \fBdefault case (S)\fR -See the section on NAME MANGLING. Also note the \fIshort preserve case\fR parameter. +See the section on NAME MANGLING. Also note the \fIshort preserve case\fR parameter. Default: \fBdefault case = lower\fR .TP \fBdefault devmode (S)\fR -This parameter is only applicable to printable services. When smbd is serving +This parameter is only applicable to printable services. When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba server has a Device Mode which defines things such as paper size and -orientation and duplex settings. The device mode can only correctly be +orientation and duplex settings. The device mode can only correctly be generated by the printer driver itself (which can only be executed on a -Win32 platform). Because smbd is unable to execute the driver code +Win32 platform). Because smbd is unable to execute the driver code to generate the device mode, the default behavior is to set this field to NULL. Most problems with serving printer drivers to Windows NT/2k/XP clients -can be traced to a problem with the generated device mode. Certain drivers +can be traced to a problem with the generated device mode. Certain drivers will do things such as crashing the client's Explorer.exe with a NULL devmode. However, other printer drivers can cause the client's spooler service (spoolsv.exe) to die if the devmode was not created by the driver itself (i.e. smbd generates a default devmode). This parameter should be used with care and tested with the printer -driver in question. It is better to leave the device mode to NULL -and let the Windows client set the correct values. Because drivers do not +driver in question. It is better to leave the device mode to NULL +and let the Windows client set the correct values. Because drivers do not do this all the time, setting \fBdefault devmode = yes\fR will instruct smbd to generate a default one. For more information on Windows NT/2k printing and Device Modes, -see the MSDN documentation <URL:http://msdn.microsoft.com/>. +see the MSDN documentation. Default: \fBdefault devmode = no\fR .TP @@ -2044,7 +2128,7 @@ 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 \fIguest ok\fR, \fIread-only\fR service. +Typically the default service would be a \fIguest ok\fR, \fIread-only\fR service. Also note that the apparent service name will be changed to equal that of the requested service, this is very useful as it @@ -2057,7 +2141,7 @@ interesting things. Example: -.sp + .nf [global] default service = pub @@ -2065,38 +2149,42 @@ Example: [pub] path = /%S -.sp .fi .TP -\fBdelete printer command (G)\fR +\fBdelete group script (G)\fR +This is the full pathname to a script that will +be run \fBAS ROOT\fR by smbd(8)when a group is requested to be deleted. It will expand any \fI%g\fR to the group name passed. This script is only useful for installations using the Windows NT domain administration tools. +.TP +\fBdeleteprinter command (G)\fR With the introduction of MS-RPC based printer support for Windows NT/2000 clients in Samba 2.2, it is now possible to delete printer at run time by issuing the DeletePrinter() RPC call. For a Samba host this means that the printer must be -physically deleted from underlying printing system. The \fI deleteprinter command\fR defines a script to be run which +physically deleted from underlying printing system. The \fI deleteprinter command\fR defines a script to be run which will perform the necessary operations for removing the printer from the print system and from \fIsmb.conf\fR. -The \fIdelete printer command\fR is -automatically called with only one parameter: \fI "printer name"\fR. +The \fIdeleteprinter command\fR is +automatically called with only one parameter: \fI "printer name"\fR. -Once the \fIdelete printer command\fR has -been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to associated printer no longer exists. +Once the \fIdeleteprinter command\fR has +been executed, \fBsmbd\fR will reparse the \fI smb.conf\fR to associated printer no longer exists. If the sharename is still valid, then \fBsmbd -\fRwill return an ACCESS_DENIED error to the client. +\fR will return an ACCESS_DENIED error to the client. -See also \fI add printer command\fR, \fIprinting\fR, +See also \fI addprinter command\fR, \fIprinting\fR, \fIshow add printer wizard\fR Default: \fBnone\fR Example: \fBdeleteprinter command = /usr/bin/removeprinter -\fR.TP +\fR +.TP \fBdelete readonly (S)\fR -This parameter allows readonly files to be deleted. +This parameter allows readonly files to be deleted. This is not normal DOS semantics, but is allowed by UNIX. This option may be useful for running applications such @@ -2107,10 +2195,10 @@ Default: \fBdelete readonly = no\fR .TP \fBdelete share command (G)\fR Samba 2.2.0 introduced the ability to dynamically -add and delete shares via the Windows NT 4.0 Server Manager. The +add and delete shares via the Windows NT 4.0 Server Manager. The \fIdelete share command\fR is used to define an external program or script which will remove an existing service -definition from \fIsmb.conf\fR. In order to successfully +definition from \fIsmb.conf\fR. In order to successfully execute the \fIdelete share command\fR, \fBsmbd\fR requires that the administrator be connected using a root account (i.e. uid == 0). @@ -2127,22 +2215,18 @@ of the global \fIsmb.conf\fR file. \fIshareName\fR - the name of the existing service. .RE -.PP -This parameter is only used to remove file shares. To delete printer shares, -see the \fIdelete printer + +This parameter is only used to remove file shares. To delete printer shares, +see the \fIdeleteprinter command\fR. -.PP -.PP + See also \fIadd share command\fR, \fIchange share command\fR. -.PP -.PP + Default: \fBnone\fR -.PP -.PP + Example: \fBdelete share command = /usr/local/bin/delshare\fR -.PP .TP \fBdelete user script (G)\fR This is the full pathname to a script that will @@ -2157,14 +2241,27 @@ This script should delete the given UNIX username. Default: \fBdelete user script = <empty string> \fR + Example: \fBdelete user script = /usr/local/samba/bin/del_user %u\fR .TP +\fBdelete user from group script (G)\fR +Full path to the script that will be called when +a user is removed from a group using the Windows NT domain administration +tools. It will be run by smbd(8) +\fBAS ROOT\fR. Any \fI%g\fR will be +replaced with the group name and any \fI%u\fR will +be replaced with the user name. + +Default: \fBdelete user from group script = \fR + +Example: \fBdelete user from group script = /usr/sbin/deluser %u %g\fR +.TP \fBdelete veto files (S)\fR This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories (see the \fIveto files\fR -option). If this option is set to false (the default) then if a vetoed +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. @@ -2176,7 +2273,7 @@ directories you might normally veto DOS/Windows users from seeing (e.g. \fI.AppleDouble\fR) Setting \fBdelete veto files = yes\fR allows these -directories to be transparently deleted when the parent directory +directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so). See also the \fIveto @@ -2215,28 +2312,28 @@ setgid and should be owned by (and writeable only by) root! Default: \fBBy default internal routines for determining the disk capacity and remaining space will be used. \fR + Example: \fBdfree command = /usr/local/samba/bin/dfree \fR + Where the script dfree (which must be made executable) could be: -.sp + .nf #!/bin/sh df $1 | tail -1 | awk '{print $2" "$4}' -.sp .fi or perhaps (on Sys V based systems): -.sp + .nf #!/bin/sh /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}' -.sp .fi Note that you may have to replace the command names @@ -2244,7 +2341,7 @@ with full path names on some systems. .TP \fBdirectory (S)\fR Synonym for \fIpath -\fR\&. +\fR. .TP \fBdirectory mask (S)\fR This parameter is the octal modes which are @@ -2265,7 +2362,7 @@ 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 \fIforce directory mode -\fRparameter. This parameter is set to 000 by +\fR parameter. This parameter is set to 000 by default (i.e. no extra mode bits are added). Note that this parameter does not apply to permissions @@ -2277,18 +2374,18 @@ directory mode\fR parameter to cause particular mode bits to always be set on created directories. See also the \fIcreate mode -\fRparameter for masking mode bits on created files, +\fR parameter for masking mode bits on created files, and the \fIdirectory security mask\fR parameter. -Also refer to the \fI inherit permissions\fR parameter. +Also refer to the \fI inherit permissions\fR parameter. Default: \fBdirectory mask = 0755\fR Example: \fBdirectory mask = 0775\fR .TP \fBdirectory mode (S)\fR -Synonym for \fI directory mask\fR +Synonym for \fI directory mask\fR .TP \fBdirectory security mask (S)\fR This parameter controls what UNIX permission bits @@ -2308,26 +2405,38 @@ permissions on a directory. \fBNote\fR that users who can access the Samba server through other means can easily bypass this restriction, -so it is primarily useful for standalone "appliance" systems. +so it is primarily useful for standalone "appliance" systems. Administrators of most normal systems will probably want to leave it as the default of 0777. -See also the \fI force directory security mode\fR, \fIsecurity mask\fR, +See also the \fI force directory security mode\fR, \fIsecurity mask\fR, \fIforce security mode -\fRparameters. +\fR parameters. Default: \fBdirectory security mask = 0777\fR Example: \fBdirectory security mask = 0700\fR .TP +\fBdisable netbios (G)\fR +Enabling this parameter will disable netbios support +in Samba. Netbios is the only available form of browsing in +all windows versions except for 2000 and XP. + +Note that clients that only support netbios won't be able to +see your samba server when netbios support is disabled. + +Default: \fBdisable netbios = no\fR + +Example: \fBdisable netbios = yes\fR +.TP \fBdisable spoolss (G)\fR -Enabling this parameter will disables Samba's support +Enabling this parameter will disable Samba's support for the SPOOLSS set of MS-RPC's and will yield identical behavior -as Samba 2.0.x. Windows NT/2000 clients will downgrade to using +as Samba 2.0.x. Windows NT/2000 clients will downgrade to using Lanman style printing commands. Windows 9x/ME will be uneffected by the parameter. However, this will also disable the ability to upload printer drivers to a Samba server via the Windows NT Add Printer -Wizard or by using the NT printer properties dialog window. It will +Wizard or by using the NT printer properties dialog window. It will also disable the capability of Windows NT/2000 clients to download print drivers from the Samba host upon demand. \fBBe very careful about enabling this parameter.\fR @@ -2336,6 +2445,15 @@ See also use client driver Default : \fBdisable spoolss = no\fR .TP +\fBdisplay charset (G)\fR +Specifies the charset that samba will use +to print messages to stdout and stderr and SWAT will use. +Should generally be the same as the \fBunix charset\fR. + +Default: \fBdisplay charset = ASCII\fR + +Example: \fBdisplay charset = UTF8\fR +.TP \fBdns proxy (G)\fR Specifies that nmbd(8) when acting as a WINS server and finding that a NetBIOS name has not @@ -2351,16 +2469,16 @@ characters, so the DNS name (or DNS alias) can likewise only be DNS name lookup requests, as doing a name lookup is a blocking action. -See also the parameter \fI wins support\fR. +See also the parameter \fI wins support\fR. Default: \fBdns proxy = yes\fR .TP \fBdomain admin group (G)\fR This parameter is intended as a temporary solution to enable users to be a member of the "Domain Admins" group when -a Samba host is acting as a PDC. A complete solution will be provided +a Samba host is acting as a PDC. A complete solution will be provided by a system for mapping Windows NT/2000 groups onto UNIX groups. -Please note that this parameter has a somewhat confusing name. It +Please note that this parameter has a somewhat confusing name. It accepts a list of usernames and of group names in standard \fIsmb.conf\fR notation. @@ -2375,9 +2493,9 @@ Example: \fBdomain admin group = root @wheel\fR \fBdomain guest group (G)\fR This parameter is intended as a temporary solution to enable users to be a member of the "Domain Guests" group when -a Samba host is acting as a PDC. A complete solution will be provided +a Samba host is acting as a PDC. A complete solution will be provided by a system for mapping Windows NT/2000 groups onto UNIX groups. -Please note that this parameter has a somewhat confusing name. It +Please note that this parameter has a somewhat confusing name. It accepts a list of usernames and of group names in standard \fIsmb.conf\fR notation. @@ -2391,24 +2509,24 @@ Example: \fBdomain guest group = nobody @guest\fR .TP \fBdomain logons (G)\fR If set to true, the Samba server will serve -Windows 95/98 Domain logons for the \fIworkgroup\fR it is in. Samba 2.2 also +Windows 95/98 Domain logons for the \fIworkgroup\fR it is in. Samba 2.2 also has limited capability to act as a domain controller for Windows -NT 4 Domains. For more details on setting up this feature see +NT 4 Domains. For more details on setting up this feature see the Samba-PDC-HOWTO included in the \fIhtmldocs/\fR directory shipped with the source code. Default: \fBdomain logons = no\fR .TP \fBdomain master (G)\fR -Tell \fB nmbd(8)\fRto enable WAN-wide browse list +Tell \fB nmbd(8)\fRto enable WAN-wide browse list collation. Setting this option causes \fBnmbd\fR to claim a special domain specific NetBIOS name that identifies -it as a domain master browser for its given \fIworkgroup\fR. Local master browsers +it as a domain master browser for its given \fIworkgroup\fR. Local master browsers in the same \fIworkgroup\fR on broadcast-isolated subnets will give this \fBnmbd\fR their local browse lists, and then ask \fBsmbd(8)\fR for a complete copy of the browse list for the whole wide area -network. Browser clients will then contact their local master browser, +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. @@ -2424,7 +2542,7 @@ strangely and may fail. If \fBdomain logons = yes\fR , then the default behavior is to enable the \fIdomain -master\fR parameter. If \fIdomain logons\fR is +master\fR parameter. If \fIdomain logons\fR is not enabled (the default setting), then neither will \fIdomain master\fR be enabled by default. @@ -2438,21 +2556,31 @@ parameter allows you to specify a comma-delimited list of directories that the server should always show as empty. Note that Samba can be very fussy about the exact format -of the "dont descend" entries. For example you may need \fI ./proc\fR instead of just \fI/proc\fR. -Experimentation is the best policy :-) +of the "dont descend" entries. For example you may need \fI ./proc\fR instead of just \fI/proc\fR. +Experimentation is the best policy :-) Default: \fBnone (i.e., all directories are OK to descend)\fR Example: \fBdont descend = /proc,/dev\fR .TP +\fBdos charset (G)\fR +DOS SMB clients assume the server has +the same charset as they do. This option specifies which +charset Samba should talk to DOS clients. + +The default depends on which charsets you have instaled. +Samba tries to use charset 850 but falls back to ASCII in +case it is not available. Run testparm(1) +to check the default on your system. +.TP \fBdos filemode (S)\fR The default behavior in Samba is to provide UNIX-like behavior where only the owner of a file/directory is -able to change the permissions on it. However, this behavior -is often confusing to DOS/Windows users. Enabling this parameter +able to change the permissions on it. However, this behavior +is often confusing to DOS/Windows users. Enabling this parameter allows a user who has write access to the file (by whatever -means) to modify the permissions on it. Note that a user +means) to modify the permissions on it. Note that a user belonging to the group owning the file will not be allowed to change permissions if the group is only granted read access. Ownership of the file/directory is not changed, only the permissions @@ -2487,7 +2615,7 @@ 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 \fBsmbd\fR is acting -on behalf of is not the file owner. Setting this option to true allows DOS semantics and smbdwill change the file +on behalf of is not the file owner. Setting this option to true allows DOS semantics and smbdwill change the file timestamp as DOS requires. Default: \fBdos filetimes = no\fR @@ -2513,7 +2641,7 @@ Default: \fBencrypt passwords = yes\fR \fBenhanced browsing (G)\fR This option enables a couple of enhancements to cross-subnet browse propagation that have been added in Samba -but which are not standard in Microsoft implementations. +but which are not standard in Microsoft implementations. The first enhancement to browse propagation consists of a regular wildcard query to a Samba WINS server for all Domain Master Browsers, @@ -2533,26 +2661,27 @@ Default: \fBenhanced browsing = yes\fR .TP \fBenumports command (G)\fR The concept of a "port" is fairly foreign -to UNIX hosts. Under Windows NT/2000 print servers, a port +to UNIX hosts. Under Windows NT/2000 print servers, a port is associated with a port monitor and generally takes the form of a local port (i.e. LPT1:, COM1:, FILE:) or a remote port -(i.e. LPD Port Monitor, etc...). By default, Samba has only one -port defined--"Samba Printer Port". Under -Windows NT/2000, all printers must have a valid port name. +(i.e. LPD Port Monitor, etc...). By default, Samba has only one +port defined--"Samba Printer Port". Under +Windows NT/2000, all printers must have a valid port name. If you wish to have a list of ports displayed (\fBsmbd -\fRdoes not use a port name for anything) other than +\fR does not use a port name for anything) other than the default "Samba Printer Port", you can define \fIenumports command\fR to point to a program which should generate a list of ports, one per line, -to standard output. This listing will then be used in response +to standard output. This listing will then be used in response to the level 1 and 2 EnumPorts() RPC. Default: \fBno enumports command\fR Example: \fBenumports command = /usr/bin/listports -\fR.TP +\fR +.TP \fBexec (S)\fR -This is a synonym for \fIpreexec\fR. +This is a synonym for \fIpreexec\fR. .TP \fBfake directory create times (S)\fR NTFS and Windows VFAT file systems keep a create @@ -2573,11 +2702,11 @@ 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 -or deleted in the directory. NMAKE finds all object files in -the object directory. The timestamp of the last one built is then -compared to the timestamp of the object directory. If the +or deleted in the directory. NMAKE finds all object files in +the object directory. The timestamp of the last one built is then +compared to the timestamp of the object directory. If the directory's timestamp if newer, then all object files -will be rebuilt. Enabling this option +will be rebuilt. Enabling this option ensures directories always predate their contents and an NMAKE build will proceed as expected. @@ -2614,9 +2743,9 @@ to stop \fBsmbd(8)\fR 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 +error). This option is very useful to stop users from adding a symbolic link to \fI/etc/passwd\fR in their home -directory for instance. However it will slow filename lookups +directory for instance. However it will slow filename lookups down slightly. This option is enabled (i.e. \fBsmbd\fR will @@ -2658,10 +2787,10 @@ bits to a created directory. This operation is done after the mode mask in the parameter \fIdirectory mask\fR is applied. -See also the parameter \fI directory mask\fR for details on masking mode bits +See also the parameter \fI directory mask\fR for details on masking mode bits on created directories. -See also the \fI inherit permissions\fR parameter. +See also the \fI inherit permissions\fR parameter. Default: \fBforce directory mode = 000\fR @@ -2671,7 +2800,7 @@ 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'. .TP -\fBforce directory\fR +\fBforce directory security mode (S)\fR This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating the UNIX permission on a directory using the native NT security dialog box. @@ -2688,13 +2817,13 @@ directory without restrictions. \fBNote\fR that users who can access the Samba server through other means can easily bypass this restriction, -so it is primarily useful for standalone "appliance" systems. +so it is primarily useful for standalone "appliance" systems. Administrators of most normal systems will probably want to leave it set as 0000. -See also the \fI directory security mask\fR, \fIsecurity mask\fR, +See also the \fI directory security mask\fR, \fIsecurity mask\fR, \fIforce security mode -\fRparameters. +\fR parameters. Default: \fBforce directory security mode = 0\fR @@ -2723,7 +2852,7 @@ primary group assigned to sys when accessing this Samba share. All other users will retain their ordinary primary group. If the \fIforce user -\fRparameter is also set the group specified in +\fR parameter is also set the group specified in \fIforce group\fR will override the primary group set in \fIforce user\fR. @@ -2752,13 +2881,13 @@ with no restrictions. \fBNote\fR that users who can access the Samba server through other means can easily bypass this restriction, -so it is primarily useful for standalone "appliance" systems. +so it is primarily useful for standalone "appliance" systems. Administrators of most normal systems will probably want to leave this set to 0000. -See also the \fI force directory security mode\fR, +See also the \fI force directory security mode\fR, \fIdirectory security -mask\fR, \fI security mask\fR parameters. +mask\fR, \fI security mask\fR parameters. Default: \fBforce security mode = 0\fR @@ -2774,7 +2903,7 @@ This user name only gets used once a connection is established. Thus clients still need to connect as a valid user and supply a valid password. Once connected, all file operations will be performed as the "forced user", no matter what username the client connected -as. This can be very useful. +as. This can be very useful. In Samba 2.0.5 and above this parameter also causes the primary group of the forced user to be used as the primary group @@ -2783,6 +2912,7 @@ as the primary group of the connecting user (this was a bug). See also \fIforce group \fR + Default: \fBno forced user\fR Example: \fBforce user = auser\fR @@ -2816,7 +2946,7 @@ group\fR. .TP \fBguest account (S)\fR This is a username which will be used for access -to services which are specified as \fI guest ok\fR (see below). Whatever privileges this +to services which are specified as \fI guest ok\fR (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 "ftp" is often a good choice @@ -2827,7 +2957,11 @@ 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 \fBsu -\fR command) and trying to print using the -system print command such as \fBlpr(1)\fR or \fB lp(1)\fR. +system print command such as \fBlpr(1)\fR or \fB lp(1)\fR. + +This paramater does not accept % marcos, becouse +many parts of the system require this value to be +constant for correct operation Default: \fBspecified at compile time, usually "nobody"\fR @@ -2837,18 +2971,18 @@ Example: \fBguest account = ftp\fR \fBguest ok (S)\fR If this parameter is yes for a service, then no password is required to connect to the service. -Privileges will be those of the \fI guest account\fR. +Privileges will be those of the \fI guest account\fR. -See the section below on \fI security\fR for more information about this option. +See the section below on \fI security\fR for more information about this option. Default: \fBguest ok = no\fR .TP \fBguest only (S)\fR If this parameter is yes for a service, then only guest connections to the service are permitted. -This parameter will have no effect if \fIguest ok\fR is not set for the service. +This parameter will have no effect if \fIguest ok\fR is not set for the service. -See the section below on \fI security\fR for more information about this option. +See the section below on \fI security\fR for more information about this option. Default: \fBguest only = no\fR .TP @@ -2860,11 +2994,11 @@ Default: \fBhide dot files = yes\fR .TP \fBhide files(S)\fR This is a list of files or directories that are not -visible but are accessible. The DOS 'hidden' attribute is applied +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. '*' +which allows spaces to be included in the entry. '*' and '?' can be used to specify multiple files or directories as in DOS wildcards. @@ -2879,7 +3013,7 @@ as it will be forced to check all files and directories for a match as they are scanned. See also \fIhide -dot files\fR, \fI veto files\fR and \fIcase sensitive\fR. +dot files\fR, \fI veto files\fR and \fIcase sensitive\fR. Default: \fBno file are hidden\fR @@ -2888,7 +3022,7 @@ Example: \fBhide files = The above example is based on files that the Macintosh SMB client (DAVE) available from -Thursby <URL:http://www.thursby.com> creates for internal use, and also still hides +Thursbycreates for internal use, and also still hides all files beginning with a dot. .TP \fBhide local users(G)\fR @@ -2897,24 +3031,31 @@ users (root, wheel, floppy, etc) from remote clients. Default: \fBhide local users = no\fR .TP -\fBhide unreadable (S)\fR +\fBhide unreadable (G)\fR This parameter prevents clients from seeing the existance of files that cannot be read. Defaults to off. Default: \fBhide unreadable = no\fR .TP +\fBhide unwriteable files (G)\fR +This parameter prevents clients from seeing +the existance of files that cannot be written to. Defaults to off. +Note that unwriteable directories are shown as usual. + +Default: \fBhide unwriteable = no\fR +.TP \fBhomedir map (G)\fR If\fInis homedir -\fRis true, and \fBsmbd(8)\fRis also acting +\fR is true, and \fBsmbd(8)\fRis also acting as a Win95/98 \fIlogon server\fR 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 +home directory should be extracted. At present, only the Sun auto.home map format is understood. The form of the map is: \fBusername server:/some/file/system\fR and the program will extract the servername from before -the first ':'. There should probably be a better parsing system +the first ':'. There should probably be a better parsing system that copes with different map formats and also Amd (another automounter) maps. @@ -2931,16 +3072,26 @@ Example: \fBhomedir map = amd.homedir\fR .TP \fBhost msdfs (G)\fR This boolean parameter is only available -if Samba has been configured and compiled with the \fB --with-msdfs\fR option. If set to yes, -Samba will act as a Dfs server, and allow Dfs-aware clients +if Samba has been configured and compiled with the \fB --with-msdfs\fR option. If set to yes, +Samba will act as a Dfs server, and allow Dfs-aware clients to browse Dfs trees hosted on the server. -See also the \fI msdfs root\fR share level parameter. For -more information on setting up a Dfs tree on Samba, +See also the \fI msdfs root\fR share level parameter. For +more information on setting up a Dfs tree on Samba, refer to msdfs_setup.html. Default: \fBhost msdfs = no\fR .TP +\fBhostname lookups (G)\fR +Specifies whether samba should use (expensive) +hostname lookups or use the ip addresses instead. An example place +where hostname lookups are currently used is when checking +the \fBhosts deny\fR and \fBhosts allow\fR. + +Default: \fBhostname lookups = yes\fR + +Example: \fBhostname lookups = no\fR +.TP \fBhosts allow (S)\fR A synonym for this parameter is \fIallow hosts\fR. @@ -2955,7 +3106,7 @@ 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 \fBallow hosts = 150.203.5. -\fR\&. The full syntax of the list is described in the man +\fR. The full syntax of the list is described in the man page \fIhosts_access(5)\fR. Note that this man page may not be present on your system, so a brief description will be given here also. @@ -2995,8 +3146,10 @@ what you expect. Default: \fBnone (i.e., all hosts permitted access) \fR + Example: \fBallow hosts = 150.203.5. myhost.mynet.edu.au -\fR.TP +\fR +.TP \fBhosts deny (S)\fR The opposite of \fIhosts allow\fR - hosts listed here are \fBNOT\fR permitted access to @@ -3006,19 +3159,21 @@ list takes precedence. Default: \fBnone (i.e., no hosts specifically excluded) \fR + Example: \fBhosts deny = 150.203.4. badhost.mynet.edu.au -\fR.TP +\fR +.TP \fBhosts equiv (G)\fR 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 \fIhosts allow\fR which is about hosts -access to services and is more useful for guest services. \fI hosts equiv\fR may be useful for NT clients which will +This is not be confused with \fIhosts allow\fR which is about hosts +access to services and is more useful for guest services. \fI hosts equiv\fR may be useful for NT clients which will not supply passwords to Samba. \fBNOTE :\fR The use of \fIhosts equiv -\fRcan be a major security hole. This is because you are +\fR 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 \fIhosts equiv\fR option be only used if you really @@ -3032,7 +3187,7 @@ Example: \fBhosts equiv = /etc/hosts.equiv\fR .TP \fBinclude (G)\fR This allows you to include one config file -inside another. The file is included literally, as though typed +inside another. The file is included literally, as though typed in place. It takes the standard substitutions, except \fI%u @@ -3041,13 +3196,14 @@ It takes the standard substitutions, except \fI%u Default: \fBno file included\fR Example: \fBinclude = /usr/local/samba/lib/admin_smb.conf -\fR.TP +\fR +.TP \fBinherit acls (S)\fR This parameter can be used to ensure that if default acls exist on parent directories, they are always honored when creating a subdirectory. The default behavior is to use the mode specified -when creating the directory. Enabling this option +when creating the directory. Enabling this option sets the mode to 0777, thus guaranteeing that default directory acls are propagated. @@ -3055,7 +3211,7 @@ Default: \fBinherit acls = no\fR .TP \fBinherit permissions (S)\fR The permissions on new files and directories -are normally governed by \fI create mask\fR, \fIdirectory mask\fR, \fIforce create mode\fR +are normally governed by \fI create mask\fR, \fIdirectory mask\fR, \fIforce create mode\fR and \fIforce directory mode\fR but the boolean inherit permissions parameter overrides this. @@ -3064,7 +3220,7 @@ New directories inherit the mode of the parent directory, including bits such as setgid. New files inherit their read/write bits from the parent -directory. Their execute bits continue to be determined by +directory. Their execute bits continue to be determined by \fImap archive\fR , \fImap hidden\fR and \fImap system\fR @@ -3078,7 +3234,7 @@ many users, perhaps several thousand, to allow a single [homes] share to be used flexibly by each user. See also \fIcreate mask -\fR, \fI directory mask\fR, \fIforce create mode\fR and \fIforce directory mode\fR +\fR, \fI directory mask\fR, \fIforce create mode\fR and \fIforce directory mode\fR \&. Default: \fBinherit permissions = no\fR @@ -3110,35 +3266,29 @@ an IP/mask pair. \(bu a broadcast/mask pair. .RE -.PP + The "mask" parameters can either be a bit length (such as 24 for a C class network) or a full netmask in dotted decimal form. -.PP -.PP + The "IP" parameters above can either be a full dotted decimal IP address or a hostname which will be looked up via the OS's normal hostname resolution mechanisms. -.PP -.PP + For example, the following line: -.PP -.PP + \fBinterfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0 -\fR.PP -.PP +\fR + would configure three network interfaces corresponding to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. The netmasks of the latter two interfaces would be set to 255.255.255.0. -.PP -.PP + See also \fIbind interfaces only\fR. -.PP -.PP + Default: \fBall active interfaces except 127.0.0.1 that are broadcast capable\fR -.PP .TP \fBinvalid users (S)\fR This is a list of users that should not be allowed @@ -3165,12 +3315,13 @@ The current servicename is substituted for \fI%S\fR. This is useful in the [homes] section. See also \fIvalid users -\fR\&. +\fR. Default: \fBno invalid users\fR Example: \fBinvalid users = root fred admin @wheel -\fR.TP +\fR +.TP \fBkeepalive (G)\fR The value of the parameter (an integer) represents the number of seconds between \fIkeepalive\fR @@ -3192,7 +3343,7 @@ For UNIXes that support kernel based \fIoplocks\fR allows the use of them to be turned on or off. Kernel oplocks support allows Samba \fIoplocks -\fRto be broken whenever a local UNIX process or NFS operation +\fR to be broken whenever a local UNIX process or NFS operation accesses a file that \fBsmbd(8)\fR has oplocked. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a \fBvery\fR @@ -3204,7 +3355,7 @@ You should never need to touch this parameter. See also the \fIoplocks\fR and \fIlevel2 oplocks -\fRparameters. +\fR parameters. Default: \fBkernel oplocks = yes\fR .TP @@ -3233,7 +3384,7 @@ The \fIldap admin dn\fR defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information. The \fIldap admin dn\fR is used in conjunction with the admin dn password -stored in the \fIprivate/secrets.tdb\fR file. See the +stored in the \fIprivate/secrets.tdb\fR file. See the \fBsmbpasswd(8)\fRman page for more information on how to accmplish this. @@ -3242,8 +3393,8 @@ Default : \fBnone\fR \fBldap filter (G)\fR This parameter specifies the RFC 2254 compliant LDAP search filter. The default is to match the login name with the uid -attribute for all entries matching the sambaAccount -objectclass. Note that this filter should only return one entry. +attribute for all entries matching the sambaAccount +objectclass. Note that this filter should only return one entry. Default : \fBldap filter = (&(uid=%u)(objectclass=sambaAccount))\fR .TP @@ -3316,11 +3467,11 @@ parameters. Default: \fBlevel2 oplocks = yes\fR .TP \fBlm announce (G)\fR -This parameter determines if \fBnmbd(8)\fRwill produce Lanman announce +This parameter determines if \fBnmbd(8)\fRwill 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. +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 @@ -3331,7 +3482,7 @@ then start sending them at a frequency set by the parameter \fIlm interval\fR. See also \fIlm interval -\fR\&. +\fR. Default: \fBlm announce = auto\fR @@ -3339,9 +3490,9 @@ Example: \fBlm announce = yes\fR .TP \fBlm interval (G)\fR If Samba is set to produce Lanman announce -broadcasts needed by OS/2 clients (see the \fIlm announce\fR parameter) then this +broadcasts needed by OS/2 clients (see the \fIlm announce\fR 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. If this is set to zero then no Lanman announcements will be made despite the setting of the \fIlm announce\fR parameter. @@ -3361,12 +3512,12 @@ more details. Default: \fBload printers = yes\fR .TP \fBlocal master (G)\fR -This option allows \fB nmbd(8)\fRto try and become a local master browser -on a subnet. If set to false then \fB nmbd\fR will not attempt to become a local master browser +This option allows \fB nmbd(8)\fRto try and become a local master browser +on a subnet. If set to false then \fB nmbd\fR 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 \fBbecome\fR the local master -browser on a subnet, just that \fBnmbd\fR will \fB participate\fR in elections for local master browser. +browser on a subnet, just that \fBnmbd\fR will \fB participate\fR in elections for local master browser. Setting this value to false will cause \fBnmbd\fR \fBnever\fR to become a local master browser. @@ -3374,11 +3525,11 @@ Setting this value to false will cause \fBnmbd\fR Default: \fBlocal master = yes\fR .TP \fBlock dir (G)\fR -Synonym for \fI lock directory\fR. +Synonym for \fI lock directory\fR. .TP \fBlock directory (G)\fR This option specifies the directory where lock -files will be placed. The lock files are used to implement the +files will be placed. The lock files are used to implement the \fImax connections\fR option. @@ -3389,10 +3540,10 @@ Example: \fBlock directory = /var/run/samba/locks\fR \fBlock spin count (G)\fR This parameter controls the number of times that smbd should attempt to gain a byte range lock on the -behalf of a client request. Experiments have shown that +behalf of a client request. Experiments have shown that Windows 2k servers do not reply with a failure if the lock could not be immediately granted, but try a few more times -in case the lock could later be aquired. This behavior +in case the lock could later be aquired. This behavior is used to support PC database formats such as MS Access and FoxPro. @@ -3400,7 +3551,7 @@ Default: \fBlock spin count = 2\fR .TP \fBlock spin time (G)\fR The time in microseconds that smbd should -pause before attempting to gain a failed lock. See +pause before attempting to gain a failed lock. See \fIlock spin count\fR for more details. @@ -3437,7 +3588,8 @@ This option takes the standard substitutions, allowing you to have separate log files for each user or machine. Example: \fBlog file = /usr/local/samba/var/log.%m -\fR.TP +\fR +.TP \fBlog level (G)\fR The value of the parameter (a astring) allows the debug level (logging level) to be specified in the @@ -3450,7 +3602,8 @@ The default will be the log level specified on the command line or level zero if none was specified. Example: \fBlog level = 3 passdb:5 auth:10 winbind:2 -\fR.TP +\fR +.TP \fBlogon drive (G)\fR This parameter specifies the local path to which the home directory will be connected (see \fIlogon home\fR) @@ -3465,7 +3618,7 @@ Example: \fBlogon drive = h:\fR .TP \fBlogon home (G)\fR This parameter specifies the home directory -location when a Win95/98 or NT Workstation logs into a Samba PDC. +location when a Win95/98 or NT Workstation logs into a Samba PDC. It allows you to do C:\\> \fBNET USE H: /HOME\fR @@ -3477,19 +3630,19 @@ you to have separate logon scripts for each user or machine. This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a subdirectory of the user's -home directory. This is done in the following way: +home directory. This is done in the following way: \fBlogon home = \\\\%N\\%U\\profile\fR This tells Samba to return the above string, with substitutions made when a client requests the info, generally -in a NetUserGetInfo request. Win9X clients truncate the info to +in a NetUserGetInfo request. Win9X clients truncate the info to \\\\server\\share when a user does \fBnet use /home\fR but use the whole string when dealing with profiles. -Note that in prior versions of Samba, the \fIlogon path\fR was returned rather than -\fIlogon home\fR. This broke \fBnet use -/home\fR but allowed profiles outside the home directory. +Note that in prior versions of Samba, the \fIlogon path\fR was returned rather than +\fIlogon home\fR. This broke \fBnet use +/home\fR but allowed profiles outside the home directory. The current implementation is correct, and can be used for profiles if you use the above trick. @@ -3503,12 +3656,12 @@ Example: \fBlogon home = "\\\\remote_smb_server\\%U"\fR \fBlogon path (G)\fR This parameter specifies the home directory where roaming profiles (NTuser.dat etc files for Windows NT) are -stored. Contrary to previous versions of these manual pages, it has -nothing to do with Win 9X roaming profiles. To find out how to -handle roaming profiles for Win 9X system, see the \fIlogon home\fR parameter. +stored. Contrary to previous versions of these manual pages, it has +nothing to do with Win 9X roaming profiles. To find out how to +handle roaming profiles for Win 9X system, see the \fIlogon home\fR parameter. This option takes the standard substitutions, allowing you -to have separate logon scripts for each user or machine. It also +to have separate logon scripts for each user or machine. It also specifies the directory from which the "Application Data", (\fIdesktop\fR, \fIstart menu\fR, \fInetwork neighborhood\fR, \fIprograms\fR @@ -3517,18 +3670,18 @@ your Windows NT client. The share and the path must be readable by the user for the preferences and directories to be loaded onto the Windows NT -client. The share must be writeable when the user logs in for the first +client. The share must be writeable when the user logs in for the first time, in order that the Windows NT client can create the NTuser.dat and other directories. Thereafter, the directories and any of the contents can, -if required, be made read-only. It is not advisable that the +if required, be made read-only. It is not advisable that the NTuser.dat file be made read-only - rename it to NTuser.man to achieve the desired effect (a \fBMAN\fRdatory profile). Windows clients can sometimes maintain a connection to -the [homes] share, even though there is no user logged in. +the [homes] share, even though there is no user logged in. Therefore, it is vital that the logon path does not include a reference to the homes share (i.e. setting this parameter to \\%N\\%U\\profile_path will cause problems). @@ -3546,22 +3699,22 @@ Example: \fBlogon path = \\\\PROFILESERVER\\PROFILE\\%U\fR \fBlogon script (G)\fR 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 +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. The script must be a relative path to the [netlogon] -service. If the [netlogon] service specifies a \fIpath\fR of \fI/usr/local/samba/netlogon +service. If the [netlogon] service specifies a \fIpath\fR of \fI/usr/local/samba/netlogon \fR, and \fBlogon script = STARTUP.BAT\fR, then the file that will be downloaded is: \fI/usr/local/samba/netlogon/STARTUP.BAT\fR -The contents of the batch file are entirely your choice. A +The contents of the batch file are entirely your choice. A suggested command would be to add \fBNET TIME \\\\SERVER /SET /YES\fR, to force every machine to synchronize clocks with -the same time server. Another use would be to add \fBNET USE -U: \\\\SERVER\\UTILS\fR for commonly used utilities, or \fB NET USE Q: \\\\SERVER\\ISO9001_QA\fR for example. +the same time server. Another use would be to add \fBNET USE +U: \\\\SERVER\\UTILS\fR for commonly used utilities, or \fB NET USE Q: \\\\SERVER\\ISO9001_QA\fR for example. Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users write permission @@ -3591,18 +3744,18 @@ having a too low priority won't be sent to the printer. If a \fI%p\fR is given then the printer name is put in its place. A \fI%j\fR is replaced with -the job number (an integer). On HPUX (see \fIprinting=hpux +the job number (an integer). On HPUX (see \fIprinting=hpux \fR), if the \fI-p%p\fR 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 +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 \fIprinting -\fRparameter. +\fR parameter. Default: Currently no default value is given to this string, unless the value of the \fIprinting\fR @@ -3615,13 +3768,13 @@ is SOFTQ, then the default is: \fBqstat -s -j%j -h\fR -Example for HPUX: \fBlppause command = /usr/bin/lpalt +Example for HPUX: \fBlppause command = /usr/bin/lpalt %p-%j -p0\fR .TP \fBlpq cache time (G)\fR This controls how long lpq info will be cached for to prevent the \fBlpq\fR command being called too -often. A separate cache is kept for each variation of the \fB lpq\fR command used by the system, so if you use different +often. A separate cache is kept for each variation of the \fB lpq\fR command used by the system, so if you use different \fBlpq\fR commands for different users then they won't share cache information. @@ -3636,7 +3789,7 @@ be advisable if your \fBlpq\fR command is very slow. A value of 0 will disable caching completely. See also the \fIprinting -\fRparameter. +\fR parameter. Default: \fBlpq cache time = 10\fR @@ -3668,15 +3821,15 @@ command. Note that it is good practice to include the absolute path in the \fIlpq command\fR as the \fB$PATH -\fRmay not be available to the server. When compiled with +\fR may not be available to the server. When compiled with the CUPS libraries, no \fIlpq command\fR is needed because smbd will make a library call to obtain the print queue listing. See also the \fIprinting -\fRparameter. +\fR parameter. -Default: \fBdepends on the setting of \fI printing\fB\fR +Default: \fBdepends on the setting of \fI printing\fB\fR Example: \fBlpq command = /usr/bin/lpq -P%p\fR .TP @@ -3688,7 +3841,7 @@ printing or spooling a specific print job. This command should be a program or script which takes a printer name and job number to resume the print job. See also the \fIlppause command -\fRparameter. +\fR parameter. If a \fI%p\fR is given then the printer name is put in its place. A \fI%j\fR is replaced with @@ -3699,7 +3852,7 @@ in the \fIlpresume command\fR as the PATH may not be available to the server. See also the \fIprinting -\fRparameter. +\fR parameter. Default: Currently no default value is given to this string, unless the value of the \fIprinting\fR @@ -3731,25 +3884,28 @@ path in the \fIlprm command\fR as the PATH may not be available to the server. See also the \fIprinting -\fRparameter. +\fR parameter. Default: \fBdepends on the setting of \fIprinting \fB\fR + Example 1: \fBlprm command = /usr/bin/lprm -P%p %j \fR + Example 2: \fBlprm command = /usr/bin/cancel %p-%j -\fR.TP +\fR +.TP \fBmachine password timeout (G)\fR If a Samba server is a member of a Windows NT Domain (see the security = domain) -parameter) then periodically a running smbd(8)process will try and change the MACHINE ACCOUNT +parameter) then periodically a running smbd(8)process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called \fIprivate/secrets.tdb -\fR\&. This parameter specifies how often this password +\fR. This parameter specifies how often this password will be changed, in seconds. The default is one week (expressed in seconds), the same as a Windows NT Domain member server. See also \fBsmbpasswd(8) -\fR, and the security = domain) parameter. +\fR, and the security = domain) parameter. Default: \fBmachine password timeout = 604800\fR .TP @@ -3760,11 +3916,12 @@ which will contain output created by a magic script (see the parameter below). Warning: If two clients use the same \fImagic script -\fRin the same directory the output file content +\fR in the same directory the output file content is undefined. Default: \fBmagic output = <magic script name>.out \fR + Example: \fBmagic output = myfile.txt\fR .TP \fBmagic script (S)\fR @@ -3778,7 +3935,7 @@ completion assuming that the user has the appropriate level of privilege and the file permissions allow the deletion. If the script generates output, output will be sent to -the file specified by the \fI magic output\fR parameter (see above). +the file specified by the \fI magic output\fR parameter (see above). Note that some shells are unable to interpret scripts containing CR/LF instead of CR as @@ -3794,14 +3951,14 @@ Default: \fBNone. Magic scripts disabled.\fR Example: \fBmagic script = user.csh\fR .TP \fBmangle case (S)\fR -See the section on NAME MANGLING +See the section on NAME MANGLING Default: \fBmangle case = no\fR .TP \fBmangled map (S)\fR This is for those who want to directly map UNIX -file names which cannot be represented on Windows/DOS. The mangling -of names is not always what is needed. In particular you may have +file names which cannot be represented on Windows/DOS. The mangling +of names is not always what is needed. In particular you may have documents with file extensions that differ between DOS and UNIX. For example, under UNIX it is common to use \fI.html\fR for HTML files, whereas under Windows/DOS \fI.htm\fR @@ -3813,7 +3970,7 @@ you would use: \fBmangled map = (*.html *.htm)\fR One very useful case is to remove the annoying \fI;1 -\fRoff the ends of filenames on some CDROMs (only visible +\fR off the ends of filenames on some CDROMs (only visible under some UNIXes). To do this use a map of (*;1 *;). Default: \fBno mangled map\fR @@ -3825,7 +3982,7 @@ This controls whether non-DOS names under UNIX should be mapped to DOS-compatible names ("mangled") and made visible, or whether non-DOS names should simply be ignored. -See the section on NAME MANGLING for details on how to control the mangling process. +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 @@ -3863,29 +4020,40 @@ for other filenames, but with the leading dot removed and "___" as its extension regardless of actual original extension (that's three underscores). .RE -.PP + The two-digit hash value consists of upper case alphanumeric characters. -.PP -.PP + This algorithm can cause name collisions only if files in a directory share the same first five alphanumeric characters. The probability of such a clash is 1/1300. -.PP -.PP + The name mangling (if enabled) allows a file to be copied between UNIX directories from Windows/DOS while retaining the long UNIX filename. UNIX files can be renamed to a new extension from Windows/DOS and will retain the same basename. Mangled names do not change between sessions. -.PP -.PP + Default: \fBmangled names = yes\fR -.PP +.TP +\fBmangling method (G)\fR +controls the algorithm used for the generating +the mangled names. Can take two different values, "hash" and +"hash2". "hash" is the default and is the algorithm that has been +used in Samba for many years. "hash2" is a newer and considered +a better algorithm (generates less collisions) in the names. +However, many Win32 applications store the mangled names and so +changing to the new algorithm must not be done +lightly as these applications may break unless reinstalled. +New installations of Samba may set the default to hash2. + +Default: \fBmangling method = hash\fR + +Example: \fBmangling method = hash2\fR .TP \fBmangled stack (G)\fR This parameter controls the number of mangled names -that should be cached in the Samba server smbd(8). +that should be cached in the Samba server smbd(8). This stack is a list of recently mangled base names (extensions are only maintained if they are longer than 3 characters @@ -3915,15 +4083,15 @@ Example: \fBmangling char = ^\fR .TP \fBmap archive (S)\fR This controls whether the DOS archive attribute -should be mapped to the UNIX owner execute bit. The DOS archive bit -is set when a file has been modified since its last backup. One +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 +any file it touches from becoming executable under UNIX. This can be quite annoying for shared source code, documents, etc... Note that this requires the \fIcreate mask\fR parameter to be set such that owner execute bit is not masked out -(i.e. it must include 100). See the parameter \fIcreate mask\fR for details. +(i.e. it must include 100). See the parameter \fIcreate mask\fR for details. Default: \fBmap archive = yes\fR .TP @@ -3933,7 +4101,7 @@ should be mapped to the UNIX world execute bit. Note that this requires the \fIcreate mask\fR to be set such that the world execute bit is not masked out (i.e. -it must include 001). See the parameter \fIcreate mask\fR for details. +it must include 001). See the parameter \fIcreate mask\fR for details. Default: \fBmap hidden = no\fR .TP @@ -3943,12 +4111,12 @@ should be mapped to the UNIX group execute bit. Note that this requires the \fIcreate mask\fR to be set such that the group execute bit is not masked out (i.e. -it must include 010). See the parameter \fIcreate mask\fR for details. +it must include 010). See the parameter \fIcreate mask\fR for details. Default: \fBmap system = no\fR .TP \fBmap to guest (G)\fR -This parameter is only useful in security modes other than \fIsecurity = share\fR +This parameter is only useful in security modes other than \fIsecurity = share\fR - i.e. user, server, and domain. @@ -3968,7 +4136,7 @@ default. Bad User - Means user logins with an invalid password are rejected, unless the username does not exist, in which case it is treated as a guest login and -mapped into the \fI guest account\fR. +mapped into the \fI guest account\fR. .TP 0.2i \(bu Bad Password - Means user logins @@ -3982,7 +4150,7 @@ that they got their password wrong. Helpdesk services will \fBhate\fR you if you set the \fImap to guest\fR parameter this way :-). .RE -.PP + Note that this parameter is needed to set up "Guest" share services when using \fIsecurity\fR modes other than share. This is because in these modes the name of the resource being @@ -3990,22 +4158,18 @@ requested is \fBnot\fR sent to the server until after the server has successfully authenticated the client so the server cannot make authentication decisions at the correct time (connection to the share) for "Guest" shares. -.PP -.PP + For people familiar with the older Samba releases, this -parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h. -.PP -.PP +parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h. + Default: \fBmap to guest = Never\fR -.PP -.PP + Example: \fBmap to guest = Bad User\fR -.PP .TP \fBmax connections (S)\fR This option allows the number of simultaneous connections to a service to be limited. If \fImax connections -\fRis greater than 0 then connections will be refused if +\fR 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. @@ -4075,7 +4239,7 @@ Default: \fBmax open files = 10000\fR \fBmax print jobs (S)\fR This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment. -If this number is exceeded, \fB smbd(8)\fRwill remote "Out of Space" to the client. +If this number is exceeded, \fB smbd(8)\fRwill remote "Out of Space" to the client. See all \fItotal print jobs\fR. @@ -4099,7 +4263,7 @@ COREPLUS: Slight improvements on CORE for efficiency. .TP 0.2i \(bu -LANMAN1: First \fB modern\fR version of the protocol. Long filename +LANMAN1: First \fB modern\fR version of the protocol. Long filename support. .TP 0.2i \(bu @@ -4109,21 +4273,17 @@ LANMAN2: Updates to Lanman1 protocol. NT1: Current up to date version of the protocol. Used by Windows NT. Known as CIFS. .RE -.PP + Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol. -.PP -.PP + See also \fImin protocol\fR -.PP -.PP + Default: \fBmax protocol = NT1\fR -.PP -.PP + Example: \fBmax protocol = LANMAN1\fR -.PP .TP \fBmax smbd processes (G)\fR This parameter limits the maximum number of @@ -4131,11 +4291,11 @@ This parameter limits the maximum number of processes concurrently running on a system and is intended as a stopgap to prevent degrading service to clients in the event that the server has insufficient resources to handle more than this -number of connections. Remember that under normal operating +number of connections. Remember that under normal operating conditions, each user will have an smbdassociated with him or her to handle connections to all shares from a given host. -Default: \fBmax smbd processes = 0\fR ## no limit +Default: \fBmax smbd processes = 0\fR ## no limit Example: \fBmax smbd processes = 1000\fR .TP @@ -4150,10 +4310,10 @@ Default: \fBmax ttl = 259200\fR .TP \fBmax wins ttl (G)\fR This option tells nmbd(8) -when acting as a WINS server ( \fIwins support = yes\fR) what the maximum +when acting as a WINS server ( \fIwins support = yes\fR) what the maximum \&'time to live' of NetBIOS names that \fBnmbd\fR will grant will be (in seconds). You should never need to change this -parameter. The default is 6 days (518400 seconds). +parameter. The default is 6 days (518400 seconds). See also the \fImin wins ttl\fR parameter. @@ -4190,7 +4350,7 @@ your PCs may freeze when sending messages (they should recover after 30 seconds, hopefully). All messages are delivered as the global guest user. -The command takes the standard substitutions, although \fI %u\fR won't work (\fI%U\fR may be better +The command takes the standard substitutions, although \fI %u\fR won't work (\fI%U\fR may be better in this case). Apart from the standard substitutions, some additional @@ -4209,40 +4369,32 @@ the message was sent to (probably the server name). \fI%f\fR = who the message is from. .RE -.PP + You could make this command send mail, or whatever else takes your fancy. Please let us know of any really interesting ideas you have. -.PP -.PP + Here's a way of sending the messages as mail to root: -.PP -.PP + \fBmessage command = /bin/mail -s 'message from %f on %m' root < %s; rm %s\fR -.PP -.PP + If you don't have a message command then the message won't be delivered and Samba will tell the sender there was an error. Unfortunately WfWg totally ignores the error code and carries on regardless, saying that the message was delivered. -.PP -.PP + If you want to silently delete it then try: -.PP -.PP + \fBmessage command = rm %s\fR -.PP -.PP + Default: \fBno message command\fR -.PP -.PP + Example: \fBmessage command = csh -c 'xedit %s; rm %s' &\fR -.PP .TP \fBmin passwd length (G)\fR -Synonym for \fImin password length\fR. +Synonym for \fImin password length\fR. .TP \fBmin password length (G)\fR This option sets the minimum length in characters @@ -4250,7 +4402,7 @@ of a plaintext password that \fBsmbd\fR will accept when performing UNIX password changing. See also \fIunix -password sync\fR, \fIpasswd program\fR and \fIpasswd chat debug\fR +password sync\fR, \fIpasswd program\fR and \fIpasswd chat debug\fR \&. Default: \fBmin password length = 5\fR @@ -4262,7 +4414,7 @@ a print job. It is specified in kilobytes. The default is 0, which means a user can always spool a print job. See also the \fIprinting -\fRparameter. +\fR parameter. Default: \fBmin print space = 0\fR @@ -4270,47 +4422,57 @@ Example: \fBmin print space = 2000\fR .TP \fBmin protocol (G)\fR The value of the parameter (a string) is the -lowest SMB protocol dialect than Samba will support. Please refer +lowest SMB protocol dialect than Samba will support. Please refer to the \fImax protocol\fR parameter for a list of valid protocol names and a brief description -of each. You may also wish to refer to the C source code in +of each. You may also wish to refer to the C source code in \fIsource/smbd/negprot.c\fR for a listing of known protocol dialects supported by clients. If you are viewing this parameter as a security measure, you should also refer to the \fIlanman -auth\fR parameter. Otherwise, you should never need +auth\fR parameter. Otherwise, you should never need to change this parameter. Default : \fBmin protocol = CORE\fR -Example : \fBmin protocol = NT1\fR # disable DOS +Example : \fBmin protocol = NT1\fR # disable DOS clients .TP \fBmin wins ttl (G)\fR This option tells nmbd(8) -when acting as a WINS server (\fI wins support = yes\fR) what the minimum 'time to live' +when acting as a WINS server (\fI wins support = yes\fR) what the minimum 'time to live' of NetBIOS names that \fBnmbd\fR will grant will be (in -seconds). You should never need to change this parameter. The default +seconds). You should never need to change this parameter. The default is 6 hours (21600 seconds). Default: \fBmin wins ttl = 21600\fR .TP \fBmsdfs root (S)\fR This boolean parameter is only available if -Samba is configured and compiled with the \fB --with-msdfs\fR option. If set to yes, -Samba treats the share as a Dfs root and allows clients to browse +Samba is configured and compiled with the \fB --with-msdfs\fR option. If set to yes, +Samba treats the share as a Dfs root and allows clients to browse the distributed file system tree rooted at the share directory. -Dfs links are specified in the share directory by symbolic +Dfs links are specified in the share directory by symbolic links of the form \fImsdfs:serverA\\shareA,serverB\\shareB -\fRand so on. For more information on setting up a Dfs tree -on Samba, refer to msdfs_setup.html +\fR and so on. For more information on setting up a Dfs tree +on Samba, refer to msdfs_setup.html . See also \fIhost msdfs \fR + Default: \fBmsdfs root = no\fR .TP +\fBname cache timeout (G)\fR +Specifies the number of seconds it takes before +entries in samba's hostname resolve cache time out. If +the timeout is set to 0. the caching is disabled. + +Default: \fBname cache timeout = 660\fR + +Example: \fBname cache timeout = 0\fR +.TP \fBname resolve order (G)\fR This option is used by the programs in the Samba suite to determine what naming services to use and in what order @@ -4333,13 +4495,13 @@ name to IP address resolution, using the system \fI/etc/hosts \fR, NIS, or DNS lookups. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the \fI/etc/nsswitch.conf\fR -file. Note that this method is only used if the NetBIOS name +file. Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored. .TP 0.2i \(bu wins : Query a name with -the IP address listed in the \fI wins server\fR parameter. If no WINS server has +the IP address listed in the \fI wins server\fR parameter. If no WINS server has been specified this method will be ignored. .TP 0.2i \(bu @@ -4349,17 +4511,16 @@ parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet. .RE -.PP + Default: \fBname resolve order = lmhosts host wins bcast -\fR.PP -.PP +\fR + Example: \fBname resolve order = lmhosts bcast host -\fR.PP -.PP +\fR + This will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup. -.PP .TP \fBnetbios aliases (G)\fR This is a list of NetBIOS names that nmbd(8)will advertise as additional @@ -4415,7 +4576,7 @@ 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 \fIhomedir map\fR and return the server +will consult the NIS map specified in \fIhomedir map\fR and return the server listed there. Note that for this option to work there must be a working @@ -4427,8 +4588,8 @@ Default: \fBnis homedir = no\fR \fBnon unix account range (G)\fR The non unix account range parameter specifies the range of 'user ids' that are allocated by the various 'non unix -account' passdb backends. These backends allow -the storage of passwords for users who don't exist in /etc/passwd. +account' passdb backends. These backends allow +the storage of passwords for users who don't exist in /etc/passwd. This is most often used for machine account creation. This range of ids should have no existing local or NIS users within it as strange conflicts can occur otherwise. @@ -4439,6 +4600,7 @@ RID mapping does not conflict with normal users. Default: \fBnon unix account range = <empty string> \fR + Example: \fBnon unix account range = 10000-20000\fR .TP \fBnt acl support (S)\fR @@ -4482,11 +4644,11 @@ Default: \fBnull passwords = no\fR \fBobey pam restrictions (G)\fR When Samba 2.2 is configured to enable PAM support (i.e. --with-pam), this parameter will control whether or not Samba -should obey PAM's account and session management directives. The +should obey PAM's account and session management directives. The default behavior is to use PAM for clear text authentication only -and to ignore any account or session management. Note that Samba +and to ignore any account or session management. Note that Samba always ignores PAM for authentication in the case of \fIencrypt passwords = yes\fR -\&. The reason is that PAM modules cannot support the challenge/response +\&. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption. Default: \fBobey pam restrictions = no\fR @@ -4495,7 +4657,7 @@ Default: \fBobey pam restrictions = no\fR This is a boolean option that controls whether connections with usernames not in the \fIuser\fR list will be allowed. By default this option is disabled so that a -client can supply a username to be used by the server. Enabling +client can supply a username to be used by the server. Enabling this parameter will force the server to only user the login names from the \fIuser\fR list and is only really useful in shave level @@ -4514,7 +4676,7 @@ parameter. Default: \fBonly user = no\fR .TP \fBonly guest (S)\fR -A synonym for \fI guest only\fR. +A synonym for \fI guest only\fR. .TP \fBoplock break wait time (G)\fR This is a tuning parameter added due to bugs in @@ -4554,34 +4716,43 @@ share. The oplock code can dramatically (approx. 30% or more) improve the speed of access to files on Samba servers. It allows the clients to aggressively cache files locally and you may want to disable this option for unreliable network environments (it is turned on by -default in Windows NT Servers). For more information see the file +default in Windows NT Servers). For more information see the file \fISpeed.txt\fR in the Samba \fIdocs/\fR directory. Oplocks may be selectively turned off on certain files with a -share. See the \fI veto oplock files\fR parameter. On some systems +share. See the \fI veto oplock files\fR parameter. On some systems oplocks are recognized by the underlying operating system. This allows data synchronization between all access to oplocked files, whether it be via Samba or NFS or a local UNIX process. See the \fIkernel oplocks\fR parameter for details. See also the \fIkernel -oplocks\fR and \fI level2 oplocks\fR parameters. +oplocks\fR and \fI level2 oplocks\fR parameters. Default: \fBoplocks = yes\fR .TP +\fBntlm auth (G)\fR +This parameter determines whether or not smbdwill +attempt to authenticate users using the NTLM password hash. +If disabled, only the lanman password hashes will be used. + +Please note that at least this option or \fBlanman auth\fR should be enabled in order to be able to log in. + +Default : \fBntlm auth = yes\fR +.TP \fBos level (G)\fR This integer value controls what level Samba advertises itself as for browse elections. The value of this parameter determines whether nmbd(8) -has a chance of becoming a local master browser for the \fI WORKGROUP\fR in the local broadcast area. +has a chance of becoming a local master browser for the \fI WORKGROUP\fR in the local broadcast area. \fBNote :\fRBy default, Samba will win a local master browsing election over all Microsoft operating -systems except a Windows NT 4.0/2000 Domain Controller. This +systems except a Windows NT 4.0/2000 Domain Controller. This means that a misconfigured Samba host can effectively isolate -a subnet for browsing purposes. See \fIBROWSING.txt -\fRin the Samba \fIdocs/\fR directory +a subnet for browsing purposes. See \fIBROWSING.txt +\fR in the Samba \fIdocs/\fR directory for details. Default: \fBos level = 20\fR @@ -4591,7 +4762,7 @@ Example: \fBos level = 65 \fR \fBos2 driver map (G)\fR The parameter is used to define the absolute path to a file containing a mapping of Windows NT printer driver -names to OS/2 printer driver names. The format is: +names to OS/2 printer driver names. The format is: <nt driver name> = <os2 driver name>.<device name> @@ -4602,16 +4773,17 @@ LaserJet 5L\fR. The need for the file is due to the printer driver namespace problem described in the Samba -Printing HOWTO. For more details on OS/2 clients, please +Printing HOWTO. For more details on OS/2 clients, please refer to the OS2-Client-HOWTO containing in the Samba documentation. Default: \fBos2 driver map = <empty string> -\fR.TP +\fR +.TP \fBpam password change (G)\fR With the addition of better PAM support in Samba 2.2, this parameter, it is possible to use PAM's password change control -flag for Samba. If enabled, then PAM will be used for password +flag for Samba. If enabled, then PAM will be used for password changes when requested by an SMB client instead of the program listed in \fIpasswd program\fR. It should be possible to enable this without changing your @@ -4622,7 +4794,7 @@ Default: \fBpam password change = no\fR .TP \fBpanic action (G)\fR This is a Samba developer option that allows a -system command to be called when either smbd(8) +system command to be called when either smbd(8) crashes. This is usually used to draw attention to the fact that a problem occurred. @@ -4630,6 +4802,14 @@ Default: \fBpanic action = <empty string>\fR Example: \fBpanic action = "/bin/sleep 90000"\fR .TP +\fBparanoid server security (G)\fR +Some version of NT 4.x allow non-guest +users with a bad passowrd. When this option is enabled, samba will not +use a broken NT 4.x server as password server, but instead complain +to the logs and exit. + +Default: \fBparanoid server security = no\fR +.TP \fBpassdb backend (G)\fR This option allows the administrator to chose which backends to retrieve and store passwords with. This allows (for example) both smbpasswd and tdbsam to be used without a recompile. @@ -4637,8 +4817,8 @@ Multiple backends can be specified, seperated by spaces. The backends will be se Experimental backends must still be selected (eg --with-tdbsam) at configure time. -This paramater is in two parts, the backend's name, and a 'location' -string that has meaning only to that particular backed. These are separated +This parameter is in two parts, the backend's name, and a 'location' +string that has meaning only to that particular backed. These are separated by a : character. Available backends can include: @@ -4646,38 +4826,38 @@ Available backends can include: .TP 0.2i \(bu \fBsmbpasswd\fR - The default smbpasswd -backend. Takes a path to the smbpasswd file as an optional argument. +backend. Takes a path to the smbpasswd file as an optional argument. .TP 0.2i \(bu \fBsmbpasswd_nua\fR - The smbpasswd -backend, but with support for 'not unix accounts'. +backend, but with support for 'not unix accounts'. Takes a path to the smbpasswd file as an optional argument. -See also \fInon unix account range\fR +See also \fInon unix account range\fR .TP 0.2i \(bu \fBtdbsam\fR - The TDB based password storage -backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb -in the \fIprivate dir\fR directory. +backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb +in the \fIprivate dir\fR directory. .TP 0.2i \(bu \fBtdbsam_nua\fR - The TDB based password storage -backend, with non unix account support. Takes a path to the TDB as an optional argument (defaults to passdb.tdb -in the \fIprivate dir\fR directory. +backend, with non unix account support. Takes a path to the TDB as an optional argument (defaults to passdb.tdb +in the \fIprivate dir\fR directory. -See also \fInon unix account range\fR +See also \fInon unix account range\fR .TP 0.2i \(bu \fBldapsam\fR - The LDAP based passdb -backend. Takes an LDAP URL as an optional argument (defaults to +backend. Takes an LDAP URL as an optional argument (defaults to \fBldap://localhost\fR) .TP 0.2i \(bu \fBldapsam_nua\fR - The LDAP based passdb -backend, with non unix account support. Takes an LDAP URL as an optional argument (defaults to +backend, with non unix account support. Takes an LDAP URL as an optional argument (defaults to \fBldap://localhost\fR) -See also \fInon unix account range\fR +See also \fInon unix account range\fR .TP 0.2i \(bu \fBplugin\fR - Allows Samba to load an @@ -4699,7 +4879,6 @@ This backend should always be the last backend listed, since it contains all use the unix passdb and might 'override' mappings if specified earlier. It's meant to only return accounts for users that aren't covered by the previous backends. .RE -.PP Default: \fBpassdb backend = smbpasswd unixsam\fR @@ -4713,7 +4892,7 @@ Example: \fBpassdb backend = plugin:/usr/local/samba/lib/my_passdb.so:my_plugin_ This string controls the \fB"chat"\fR conversation that takes places between smbdand the local password changing program to change the user's password. The string describes a -sequence of response-receive pairs that smbd(8)uses to determine what to send to the +sequence of response-receive pairs that smbd(8)uses to determine what to send to the \fIpasswd program\fR and what to expect back. If the expected output is not received then the password is not changed. @@ -4732,15 +4911,15 @@ this means that the passwd program must be executed on the NIS master. The string can contain the macro \fI%n\fR which is substituted -for the new password. The chat sequence can also contain the standard -macros \\n, \\r, \\t and \\s to give line-feed, -carriage-return, tab and space. The chat sequence string can also contain +for the new password. The chat sequence can also contain the standard +macros \\n, \\r, \\t and \\s to give line-feed, +carriage-return, tab and space. The chat sequence string can also contain a '*' which matches any sequence of characters. Double quotes can be used to collect strings with spaces in them into a single string. If the send string in any part of the chat sequence -is a full stop ".", then no string is sent. Similarly, +is a full stop ".", then no string is sent. Similarly, if the expect string is a full stop then no string is expected. If the \fIpam @@ -4749,7 +4928,7 @@ may be matched in any order, and success is determined by the PAM result, not any particular output. The \\n macro is ignored for PAM conversions. See also \fIunix password -sync\fR, \fI passwd program\fR , \fIpasswd chat debug\fR and \fIpam password change\fR. +sync\fR, \fI passwd program\fR , \fIpasswd chat debug\fR and \fIpam password change\fR. Default: \fBpasswd chat = *new*password* %n\\n *new*password* %n\\n *changed*\fR @@ -4781,12 +4960,12 @@ Default: \fBpasswd chat debug = no\fR .TP \fBpasswd program (G)\fR The name of a program that can be used to set -UNIX user passwords. Any occurrences of \fI%u\fR +UNIX user passwords. Any occurrences of \fI%u\fR will be replaced with the user name. The user name is checked for existence before calling the password changing program. Also note that many passwd programs insist in \fBreasonable -\fRpasswords, such as a minimum length, or the inclusion +\fR 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. @@ -4814,18 +4993,18 @@ Example: \fBpasswd program = /sbin/npasswd %u\fR .TP \fBpassword level (G)\fR Some client/server combinations have difficulty -with mixed-case passwords. One offending client is Windows for +with mixed-case passwords. One offending client is Windows for Workgroups, which for some reason forces passwords to upper case when using the LANMAN1 protocol, but leaves them alone when -using COREPLUS! Another problem child is the Windows 95/98 -family of operating systems. These clients upper case clear +using COREPLUS! Another problem child is the Windows 95/98 +family of operating systems. These clients upper case clear text passwords even when NT LM 0.12 selected by the protocol negotiation request/response. This parameter defines the maximum number of characters that may be upper case in passwords. -For example, say the password given was "FRED". If \fI password level\fR is set to 1, the following combinations +For example, say the password given was "FRED". If \fI password level\fR is set to 1, the following combinations would be tried if "FRED" failed: "Fred", "fred", "fRed", "frEd","freD" @@ -4853,13 +5032,13 @@ Example: \fBpassword level = 4\fR \fBpassword server (G)\fR By specifying the name of another SMB server (such as a WinNT box) with this option, and using \fBsecurity = domain -\fRor \fBsecurity = server\fR you can get Samba +\fR or \fBsecurity = server\fR you can get Samba to do all its username/password validation via a remote server. This option sets the name of the password server to use. It must be a NetBIOS name, so if the machine's NetBIOS name is different from its Internet name then you may have to add its NetBIOS -name to the lmhosts file which is stored in the same directory +name to the lmhosts file which is stored in the same directory as the \fIsmb.conf\fR file. The name of the password server is looked up using the @@ -4891,9 +5070,9 @@ domain, then the list of machines in this option must be a list of Primary or Backup Domain controllers for the Domain or the character '*', as the Samba server is effectively in that domain, and will use cryptographically authenticated RPC calls -to authenticate the user logging on. The advantage of using \fB security = domain\fR is that if you list several hosts in the +to authenticate the user logging on. The advantage of using \fB security = domain\fR is that if you list several hosts in the \fIpassword server\fR option then \fBsmbd -\fRwill try each in turn till it finds one that responds. This +\fR will try each in turn till it finds one that responds. This is useful in case your primary server goes down. If the \fIpassword server\fR option is set @@ -4914,29 +5093,26 @@ You may list several password servers in the \fIpassword server\fR parameter, however if an \fBsmbd\fR makes a connection to a password server, and then the password server fails, no more users will be able -to be authenticated from this \fBsmbd\fR. This is a +to be authenticated from this \fBsmbd\fR. This is a restriction of the SMB/CIFS protocol when in \fBsecurity = server -\fRmode and cannot be fixed in Samba. +\fR mode and cannot be fixed in Samba. .TP 0.2i \(bu If you are using a Windows NT server as your password server then you will have to ensure that your users -are able to login from the Samba server, as when in \fB security = server\fR mode the network logon will appear to +are able to login from the Samba server, as when in \fB security = server\fR mode the network logon will appear to come from there rather than from the users workstation. .RE -.PP + See also the \fIsecurity -\fRparameter. -.PP -.PP +\fR parameter. + Default: \fBpassword server = <empty string>\fR -.PP -.PP + Example: \fBpassword server = NT-PDC, NT-BDC1, NT-BDC2 -\fR.PP -.PP +\fR + Example: \fBpassword server = *\fR -.PP .TP \fBpath (S)\fR This parameter specifies a directory to which @@ -4957,7 +5133,7 @@ will be replaced by the NetBIOS name of the machine they are connecting from. These replacements are very useful for setting up pseudo home directories for users. -Note that this path will be based on \fIroot dir\fR if one was specified. +Note that this path will be based on \fIroot dir\fR if one was specified. Default: \fBnone\fR @@ -4965,7 +5141,7 @@ Example: \fBpath = /home/fred\fR .TP \fBpid directory (G)\fR This option specifies the directory where pid -files will be placed. +files will be placed. Default: \fBpid directory = ${prefix}/var/locks\fR @@ -4975,9 +5151,9 @@ Example: \fBpid directory = /var/run/\fR The \fBsmbd(8)\fR daemon maintains an database of file locks obtained by SMB clients. The default behavior is to map this internal database to POSIX -locks. This means that file locks obtained by SMB clients are +locks. This means that file locks obtained by SMB clients are consistent with those seen by POSIX compliant applications accessing -the files via a non-SMB method (e.g. NFS or local file access). +the files via a non-SMB method (e.g. NFS or local file access). You should never need to disable this parameter. Default: \fBposix locking = yes\fR @@ -5026,8 +5202,8 @@ is an example: Of course, this could get annoying after a while :-) See also \fIpreexec close -\fRand \fIpostexec -\fR\&. +\fR and \fIpostexec +\fR. Default: \fBnone (no command executed)\fR @@ -5037,7 +5213,7 @@ Example: \fBpreexec = echo \\"%u connected to %S from %m \fBpreexec close (S)\fR This boolean option controls whether a non-zero return code from \fIpreexec -\fRshould close the service being connected to. +\fR should close the service being connected to. Default: \fBpreexec close = no\fR .TP @@ -5047,13 +5223,13 @@ for its workgroup. If this is set to true, on startup, \fBnmbd\fR will force an election, and it will have a slight advantage in -winning the election. It is recommended that this parameter is -used in conjunction with \fB\fI domain master\fB = yes\fR, so that \fB nmbd\fR can guarantee becoming a domain master. +winning the election. It is recommended that this parameter is +used in conjunction with \fB\fI domain master\fB = yes\fR, so that \fB nmbd\fR can guarantee becoming a domain master. 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. +and continuously attempt to become the local master browser. This will result in unnecessary broadcast traffic and reduced browsing capabilities. @@ -5063,7 +5239,7 @@ See also \fIos level\fR Default: \fBpreferred master = auto\fR .TP \fBprefered master (G)\fR -Synonym for \fI preferred master\fR for people who cannot spell :-). +Synonym for \fI preferred master\fR for people who cannot spell :-). .TP \fBpreload\fR This is a list of services that you want to be @@ -5072,7 +5248,7 @@ for homes and printers services that would otherwise not be visible. Note that if you just want all printers in your -printcap file loaded then the \fIload printers\fR option is easier. +printcap file loaded then the \fIload printers\fR option is easier. Default: \fBno preloaded services\fR @@ -5082,7 +5258,7 @@ Example: \fBpreload = fred lp colorlp\fR This controls if new filenames are created with the case that the client passes, or if they are forced to be the \fIdefault case -\fR\&. +\fR. Default: \fBpreserve case = yes\fR @@ -5119,9 +5295,9 @@ print job (in bytes) The print command \fBMUST\fR contain at least one occurrence of \fI%s\fR or \fI%f -\fR- the \fI%p\fR is optional. At the time +\fR - the \fI%p\fR is optional. At the time a job is submitted, if no printer name is supplied the \fI%p -\fRwill be silently removed from the printer command. +\fR 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 @@ -5146,7 +5322,7 @@ will log a print job, print the file, then remove it. Note that You may have to vary this command considerably depending on how you normally print files on your system. The default for -the parameter varies depending on the setting of the \fIprinting\fR parameter. +the parameter varies depending on the setting of the \fIprinting\fR parameter. Default: For \fBprinting = BSD, AIX, QNX, LPRNG or PLP :\fR @@ -5161,12 +5337,12 @@ For \fBprinting = SOFTQ :\fR \fBprint command = lp -d%p -s %s; rm %s\fR -For printing = CUPS : If SAMBA is compiled against +For printing = CUPS : If SAMBA is compiled against libcups, then printcap = cups uses the CUPS API to -submit jobs, etc. Otherwise it maps to the System V +submit jobs, etc. Otherwise it maps to the System V commands with the -oraw option for printing, i.e. it -uses \fBlp -c -d%p -oraw; rm %s\fR. +uses \fBlp -c -d%p -oraw; rm %s\fR. With \fBprinting = cups\fR, and if SAMBA is compiled against libcups, any manually set print command will be ignored. @@ -5175,7 +5351,7 @@ Example: \fBprint command = /usr/local/samba/bin/myprintscript %p %s\fR .TP \fBprint ok (S)\fR -Synonym for \fIprintable\fR. +Synonym for \fIprintable\fR. .TP \fBprintable (S)\fR If this parameter is yes, then @@ -5185,37 +5361,37 @@ 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 \fIwriteable -\fRparameter controls only non-printing access to +\fR parameter controls only non-printing access to the resource. Default: \fBprintable = no\fR .TP \fBprintcap (G)\fR -Synonym for \fI printcap name\fR. +Synonym for \fI printcap name\fR. .TP \fBprintcap name (G)\fR This parameter may be used to override the -compiled-in default printcap name used by the server (usually \fI /etc/printcap\fR). See the discussion of the [printers] section above for reasons +compiled-in default printcap name used by the server (usually \fI /etc/printcap\fR). See the discussion of the [printers] section above for reasons why you might want to do this. To use the CUPS printing interface set \fBprintcap name = cups -\fR\&. This should be supplemented by an addtional setting +\fR. This should be supplemented by an addtional setting printing = cups in the [global] -section. \fBprintcap name = cups\fR will use the +section. \fBprintcap name = cups\fR will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file. On System V systems that use \fBlpstat\fR to list available printers you can use \fBprintcap name = lpstat -\fRto automatically obtain lists of available printers. This +\fR to automatically obtain lists of available printers. This is the default for systems that define SYSV at configure time in -Samba (this includes most System V based systems). If \fI printcap name\fR is set to \fBlpstat\fR on +Samba (this includes most System V based systems). If \fI printcap name\fR is set to \fBlpstat\fR on these systems then Samba will launch \fBlpstat -v\fR and attempt to parse the output to obtain a printer list. A minimal printcap file would look something like this: -.sp + .nf print1|My Printer 1 print2|My Printer 2 @@ -5223,7 +5399,6 @@ A minimal printcap file would look something like this: print4|My Printer 4 print5|My Printer 5 -.sp .fi where the '|' separates aliases of a printer. The fact @@ -5252,7 +5427,7 @@ Example: \fBprinter admin = admin, @staff\fR \fBprinter driver (S)\fR \fBNote :\fRThis is a deprecated parameter and will be removed in the next major release -following version 2.2. Please see the instructions in +following version 2.2. Please see the instructions in the Samba 2.2. Printing HOWTOfor more information on the new method of loading printer drivers onto a Samba server. @@ -5266,7 +5441,7 @@ system. 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 \fI printer driver\fR option set and the client will +first try with no \fI printer driver\fR option set and the client will give you a list of printer drivers. The appropriate strings are shown in a scroll box after you have chosen the printer manufacturer. @@ -5278,7 +5453,7 @@ Example: \fBprinter driver = HP LaserJet 4L\fR \fBprinter driver file (G)\fR \fBNote :\fRThis is a deprecated parameter and will be removed in the next major release -following version 2.2. Please see the instructions in +following version 2.2. Please see the instructions in the Samba 2.2. Printing HOWTOfor more information on the new method of loading printer drivers onto a Samba server. @@ -5291,12 +5466,12 @@ to be found. If this is not set, the default is : /lib/printers.def\fR This file is created from Windows 95 \fImsprint.inf -\fRfiles found on the Windows 95 client system. For more +\fR files found on the Windows 95 client system. For more details on setting up serving of printer drivers to Windows 95 clients, see the outdated documentation file in the \fIdocs/\fR directory, \fIPRINTER_DRIVER.txt\fR. -See also \fI printer driver location\fR. +See also \fI printer driver location\fR. Default: \fBNone (set in compile).\fR @@ -5306,7 +5481,7 @@ Example: \fBprinter driver file = \fBprinter driver location (S)\fR \fBNote :\fRThis is a deprecated parameter and will be removed in the next major release -following version 2.2. Please see the instructions in +following version 2.2. Please see the instructions in the Samba 2.2. Printing HOWTOfor more information on the new method of loading printer drivers onto a Samba server. @@ -5321,14 +5496,15 @@ to serve printer drivers to Windows 95 machines, this should be set to 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 outdated documentation -file in the \fIdocs/\fR directory, \fI PRINTER_DRIVER.txt\fR. +file in the \fIdocs/\fR directory, \fI PRINTER_DRIVER.txt\fR. -See also \fI printer driver file\fR. +See also \fI printer driver file\fR. Default: \fBnone\fR Example: \fBprinter driver location = \\\\MACHINE\\PRINTER$ -\fR.TP +\fR +.TP \fBprinter name (S)\fR This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent. @@ -5343,7 +5519,7 @@ on many systems)\fR Example: \fBprinter name = laserwriter\fR .TP \fBprinter (S)\fR -Synonym for \fI printer name\fR. +Synonym for \fI printer name\fR. .TP \fBprinting (S)\fR This parameters controls how printer status @@ -5366,7 +5542,7 @@ commands when using the various options use the testparm(1)program. This option can be set on a per printer basis -See also the discussion in the [printers] section. +See also the discussion in the [printers] section. .TP \fBprivate dir (G)\fR This parameters defines the directory @@ -5376,7 +5552,7 @@ and \fIsecrets.tdb\fR. Default :\fBprivate dir = ${prefix}/private\fR .TP \fBprotocol (G)\fR -Synonym for \fImax protocol\fR. +Synonym for \fImax protocol\fR. .TP \fBpublic (S)\fR Synonym for \fIguest @@ -5403,13 +5579,14 @@ server. Default: \fBdepends on the setting of \fIprinting \fB\fR + Example: \fBqueuepause command = disable %p\fR .TP \fBqueueresume command (S)\fR This parameter specifies the command to be executed on the server host in order to resume the printer queue. It is the command to undo the behavior that is caused by the -previous parameter (\fI queuepause command\fR). +previous parameter (\fI queuepause command\fR). This command should be a program or script which takes a printer name as its only parameter and resumes the printer queue, @@ -5430,7 +5607,8 @@ server. Default: \fBdepends on the setting of \fIprinting\fB\fR Example: \fBqueuepause command = enable %p -\fR.TP +\fR +.TP \fBread bmpx (G)\fR This boolean parameter controls whether smbd(8)will support the "Read Block Multiplex" SMB. This is now rarely used and defaults to @@ -5444,9 +5622,9 @@ This is a list of users that are given read-only access to a service. If the connecting user is in this list then they will not be given write access, no matter what the \fIwriteable\fR option is set to. The list can include group names using the -syntax described in the \fI invalid users\fR parameter. +syntax described in the \fI invalid users\fR parameter. -See also the \fI write list\fR parameter and the \fIinvalid users\fR +See also the \fI write list\fR parameter and the \fIinvalid users\fR parameter. Default: \fBread list = <empty string>\fR @@ -5469,7 +5647,7 @@ 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 \fIwrite raw\fR. +tool and left severely alone. See also \fIwrite raw\fR. Default: \fBread raw = yes\fR .TP @@ -5497,6 +5675,15 @@ Default: \fBread size = 16384\fR Example: \fBread size = 8192\fR .TP +\fBrealm (G)\fR +This option specifies the kerberos realm to use. The realm is +used as the ADS equivalent of the NT4\fBdomain\fR. It +is usually set to the DNS name of the kerberos server. + +Default: \fBrealm = \fR + +Example: \fBrealm = mysambabox.mycompany.com\fR +.TP \fBremote announce (G)\fR This option allows you to setup nmbd(8)to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name. @@ -5525,7 +5712,8 @@ See the documentation file \fIBROWSING.txt\fR in the \fIdocs/\fR directory. Default: \fBremote announce = <empty string> -\fR.TP +\fR +.TP \fBremote browse sync (G)\fR This option allows you to setup nmbd(8)to periodically request synchronization of browse lists with the master browser of a Samba @@ -5542,6 +5730,7 @@ For example: \fBremote browse sync = 192.168.2.255 192.168.4.255 \fR + the above line would cause \fBnmbd\fR to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server. @@ -5554,38 +5743,39 @@ that the remote machine is available, is listening, nor that it is in fact the browse master on its segment. Default: \fBremote browse sync = <empty string> -\fR.TP +\fR +.TP \fBrestrict anonymous (G)\fR -This is a boolean parameter. If it is true, then +This is a boolean parameter. If it is true, then anonymous access to the server will be restricted, namely in the case where the server is expecting the client to send a username, -but it doesn't. Setting it to true will force these anonymous +but it doesn't. Setting it to true will force these anonymous connections to be denied, and the client will be required to always supply a username and password when connecting. Use of this parameter is only recommended for homogeneous NT client environments. This parameter makes the use of macro expansions that rely -on the username (%U, %G, etc) consistent. NT 4.0 +on the username (%U, %G, etc) consistent. NT 4.0 likes to use anonymous connections when refreshing the share list, and this is a way to work around that. When restrict anonymous is true, all anonymous connections -are denied no matter what they are for. This can effect the ability +are denied no matter what they are for. This can effect the ability of a machine to access the Samba Primary Domain Controller to revalidate its machine account after someone else has logged on the client -interactively. The NT client will display a message saying that -the machine's account in the domain doesn't exist or the password is -bad. The best way to deal with this is to reboot NT client machines -between interactive logons, using "Shutdown and Restart", rather +interactively. The NT client will display a message saying that +the machine's account in the domain doesn't exist or the password is +bad. The best way to deal with this is to reboot NT client machines +between interactive logons, using "Shutdown and Restart", rather than "Close all programs and logon as a different user". Default: \fBrestrict anonymous = no\fR .TP \fBroot (G)\fR -Synonym for \fIroot directory"\fR. +Synonym for \fIroot directory"\fR. .TP \fBroot dir (G)\fR -Synonym for \fIroot directory"\fR. +Synonym for \fIroot directory"\fR. .TP \fBroot directory (G)\fR The server will \fBchroot()\fR (i.e. @@ -5620,31 +5810,33 @@ parameter except that the command is run as root. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed. -See also \fI postexec\fR. +See also \fI postexec\fR. Default: \fBroot postexec = <empty string> -\fR.TP +\fR +.TP \fBroot preexec (S)\fR This is the same as the \fIpreexec\fR parameter except that the command is run as root. This is useful for mounting filesystems (such as CDROMs) when a connection is opened. -See also \fI preexec\fR and \fIpreexec close\fR. +See also \fI preexec\fR and \fIpreexec close\fR. Default: \fBroot preexec = <empty string> -\fR.TP +\fR +.TP \fBroot preexec close (S)\fR This is the same as the \fIpreexec close -\fRparameter except that the command is run as root. +\fR parameter except that the command is run as root. -See also \fI preexec\fR and \fIpreexec close\fR. +See also \fI preexec\fR and \fIpreexec close\fR. Default: \fBroot preexec close = no\fR .TP \fBsecurity (G)\fR This option affects how clients respond to -Samba and is one of the most important settings in the \fI smb.conf\fR file. +Samba and is one of the most important settings in the \fI smb.conf\fR file. The option sets the "security mode bit" in replies to protocol negotiations with smbd(8) @@ -5658,7 +5850,7 @@ Windows NT. The alternatives are \fBsecurity = share\fR, \fBsecurity = server\fR or \fBsecurity = domain -\fR\&. +\fR. In versions of Samba prior to 2.0.0, the default was \fBsecurity = share\fR mainly because that was @@ -5684,19 +5876,20 @@ to setup guest shares with \fBsecurity = user\fR, see the \fImap to guest\fR parameter for details. -It is possible to use \fBsmbd\fR in a \fB hybrid mode\fR where it is offers both user and share -level security under different \fINetBIOS aliases\fR. +It is possible to use \fBsmbd\fR in a \fB hybrid mode\fR where it is offers both user and share +level security under different \fINetBIOS aliases\fR. The different settings will now be explained. \fBSECURITY = SHARE \fR + When clients connect to a share level security server they need not log onto the server with a valid username and password before attempting to connect to a shared resource (although modern clients such as Windows 95/98 and Windows NT will send a logon request with a username but no password when talking to a \fBsecurity = share -\fRserver). Instead, the clients send authentication information +\fR server). Instead, the clients send authentication information (passwords) on a per-share basis, at the time they attempt to connect to that share. @@ -5716,7 +5909,7 @@ client password is constructed using the following methods : \(bu If the \fIguest only\fR parameter is set, then all the other -stages are missed and only the \fIguest account\fR username is checked. +stages are missed and only the \fIguest account\fR username is checked. .TP 0.2i \(bu Is a username is sent with the share connection @@ -5725,7 +5918,7 @@ is added as a potential username. .TP 0.2i \(bu If the client did a previous \fBlogon -\fRrequest (the SessionSetup SMB call) then the +\fR request (the SessionSetup SMB call) then the username sent in this SMB will be added as a potential username. .TP 0.2i \(bu @@ -5737,41 +5930,36 @@ The NetBIOS name of the client is added to the list as a potential username. .TP 0.2i \(bu -Any users on the \fI user\fR list are added as potential usernames. +Any users on the \fI user\fR list are added as potential usernames. .RE -.PP + If the \fIguest only\fR parameter is not set, then this list is then tried with the supplied password. The first user for whom the password matches will be used as the UNIX user. -.PP -.PP + If the \fIguest only\fR parameter is set, or no username can be determined then if the share is marked as available to the \fIguest account\fR, then this guest user will be used, otherwise access is denied. -.PP -.PP + Note that it can be \fBvery\fR confusing in share-level security as to which UNIX username will eventually be used in granting access. -.PP -.PP -See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. -.PP -.PP + +See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. + \fBSECURITY = USER -\fR.PP -.PP +\fR + This is the default security setting in Samba 2.2. With user-level security a client must first "log-on" with a valid username and password (which can be mapped using the \fIusername map\fR -parameter). Encrypted passwords (see the \fIencrypted passwords\fR parameter) can also -be used in this security mode. Parameters such as \fIuser\fR and \fIguest only\fR if set are then applied and +parameter). Encrypted passwords (see the \fIencrypted passwords\fR parameter) can also +be used in this security mode. Parameters such as \fIuser\fR and \fIguest only\fR if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated. -.PP -.PP + \fBNote\fR that the name of the resource being requested is \fBnot\fR sent to the server until after the server has successfully authenticated the client. This is why @@ -5779,14 +5967,12 @@ guest shares don't work in user level security without allowing the server to automatically map unknown users into the \fIguest account\fR. See the \fImap to guest\fR parameter for details on doing this. -.PP -.PP -See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. -.PP -.PP + +See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. + \fBSECURITY = SERVER -\fR.PP -.PP +\fR + In this mode Samba will try to validate the username/password by passing it to another SMB server, such as an NT box. If this fails it will revert to \fBsecurity = user\fR, but note @@ -5796,14 +5982,12 @@ revert back to checking the UNIX password file, it must have a valid documentation file in the \fIdocs/\fR directory \fIENCRYPTION.txt\fR for details on how to set this up. -.PP -.PP + \fBNote\fR that from the client's point of -view \fBsecurity = server\fR is the same as \fB security = user\fR. It only affects how the server deals +view \fBsecurity = server\fR is the same as \fB security = user\fR. It only affects how the server deals with the authentication, it does not in any way affect what the client sees. -.PP -.PP + \fBNote\fR that the name of the resource being requested is \fBnot\fR sent to the server until after the server has successfully authenticated the client. This is why @@ -5811,38 +5995,32 @@ guest shares don't work in user level security without allowing the server to automatically map unknown users into the \fIguest account\fR. See the \fImap to guest\fR parameter for details on doing this. -.PP -.PP -See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. -.PP -.PP + +See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. + See also the \fIpassword server\fR parameter and the \fIencrypted passwords\fR parameter. -.PP -.PP + \fBSECURITY = DOMAIN -\fR.PP -.PP +\fR + This mode will only work correctly if smbpasswd(8)has been used to add this machine into a Windows NT Domain. It expects the \fIencrypted passwords\fR parameter to be set to true. In this mode Samba will try to validate the username/password by passing it to a Windows NT Primary or Backup Domain Controller, in exactly the same way that a Windows NT Server would do. -.PP -.PP + \fBNote\fR that a valid UNIX user must still exist as well as the account on the Domain Controller to allow Samba to have a valid UNIX account to map file access to. -.PP -.PP + \fBNote\fR that from the client's point of view \fBsecurity = domain\fR is the same as \fBsecurity = user -\fR\&. It only affects how the server deals with the authentication, +\fR. It only affects how the server deals with the authentication, it does not in any way affect what the client sees. -.PP -.PP + \fBNote\fR that the name of the resource being requested is \fBnot\fR sent to the server until after the server has successfully authenticated the client. This is why @@ -5850,8 +6028,7 @@ guest shares don't work in user level security without allowing the server to automatically map unknown users into the \fIguest account\fR. See the \fImap to guest\fR parameter for details on doing this. -.PP -.PP + \fBBUG:\fR There is currently a bug in the implementation of \fBsecurity = domain\fR with respect to multi-byte character set usernames. The communication with a @@ -5859,21 +6036,16 @@ Domain Controller must be done in UNICODE and Samba currently does not widen multi-byte user names to UNICODE correctly, thus a multi-byte username will not be recognized correctly at the Domain Controller. This issue will be addressed in a future release. -.PP -.PP -See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. -.PP -.PP + +See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION. + See also the \fIpassword server\fR parameter and the \fIencrypted passwords\fR parameter. -.PP -.PP + Default: \fBsecurity = USER\fR -.PP -.PP + Example: \fBsecurity = DOMAIN\fR -.PP .TP \fBsecurity mask (S)\fR This parameter controls what UNIX permission @@ -5893,12 +6065,12 @@ a user to modify all the user/group/world permissions on a file. \fBNote\fR that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone -"appliance" systems. Administrators of most normal systems will +"appliance" systems. Administrators of most normal systems will probably want to leave it set to 0777. -See also the \fIforce directory security mode\fR, +See also the \fIforce directory security mode\fR, \fIdirectory -security mask\fR, \fIforce security mode\fR parameters. +security mask\fR, \fIforce security mode\fR parameters. Default: \fBsecurity mask = 0777\fR @@ -5963,38 +6135,38 @@ This boolean parameter controls if new files which conform to 8.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the \fIdefault case -\fR\&. This option can be use with \fBpreserve case = yes\fR +\fR. This option can be use with \fBpreserve case = yes\fR to permit long filenames to retain their case, while short names are lowered. -See the section on NAME MANGLING. +See the section on NAME MANGLING. Default: \fBshort preserve case = yes\fR .TP \fBshow add printer wizard (G)\fR With the introduction of MS-RPC based printing support for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will -appear on Samba hosts in the share listing. Normally this folder will -contain an icon for the MS Add Printer Wizard (APW). However, it is +appear on Samba hosts in the share listing. Normally this folder will +contain an icon for the MS Add Printer Wizard (APW). However, it is possible to disable this feature regardless of the level of privilege of the connected user. Under normal circumstances, the Windows NT/2000 client will open a handle on the printer server with OpenPrinterEx() asking for -Administrator privileges. If the user does not have administrative +Administrator privileges. If the user does not have administrative access on the print server (i.e is not root or a member of the \fIprinter admin\fR group), the OpenPrinterEx() call fails and the client makes another open call with a request for -a lower privilege level. This should succeed, however the APW +a lower privilege level. This should succeed, however the APW icon will not be displayed. Disabling the \fIshow add printer wizard\fR parameter will always cause the OpenPrinterEx() on the server -to fail. Thus the APW icon will never be displayed. \fB Note :\fRThis does not prevent the same user from having +to fail. Thus the APW icon will never be displayed. \fB Note :\fRThis does not prevent the same user from having administrative privilege on an individual printer. See also \fIaddprinter -command\fR, \fIdeleteprinter command\fR, \fIprinter admin\fR +command\fR, \fIdeleteprinter command\fR, \fIprinter admin\fR Default :\fBshow add printer wizard = yes\fR .TP @@ -6029,7 +6201,7 @@ Default: \fBNone\fR. Example: \fBabort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f\fR Shutdown script example: -.sp + .nf #!/bin/bash @@ -6039,7 +6211,6 @@ Shutdown script example: /sbin/shutdown $3 $4 +$time $1 & -.sp .fi Shutdown does not return so we need to launch it in background. @@ -6047,13 +6218,21 @@ See also \fIabort shutdown script\fR. .TP \fBsmb passwd file (G)\fR This option sets the path to the encrypted -smbpasswd file. By default the path to the smbpasswd file +smbpasswd file. By default the path to the smbpasswd file is compiled into Samba. Default: \fBsmb passwd file = ${prefix}/private/smbpasswd \fR + Example: \fBsmb passwd file = /etc/samba/smbpasswd -\fR.TP +\fR +.TP +\fBsmb ports (G)\fR +Specifies which ports the server should listen on +for SMB traffic. + +Default: \fBsmb ports = 445 139\fR +.TP \fBsocket address (G)\fR This option allows you to control what address Samba will listen for connections on. This is used to @@ -6083,9 +6262,9 @@ will help). You may find that on some systems Samba will say "Unknown socket option" when you supply an option. This means you -either incorrectly typed it or you need to add an include file -to includes.h for your OS. If the latter is the case please -send the patch to samba@samba.org <URL:mailto:samba@samba.org>. +either incorrectly typed it or you need to add an include file +to includes.h for your OS. If the latter is the case please +send the patch to samba@samba.org. Any of the supported socket options may be combined in any way you like, as long as your OS allows it. @@ -6124,44 +6303,34 @@ SO_SNDLOWAT * \(bu SO_RCVLOWAT * .RE -.PP + Those marked with a \fB'*'\fR 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. -.PP -.PP + To specify an argument use the syntax SOME_OPTION = VALUE for example \fBSO_SNDBUF = 8192\fR. Note that you must not have any spaces before or after the = sign. -.PP -.PP + If you are on a local network then a sensible option might be -.PP -.PP + \fBsocket options = IPTOS_LOWDELAY\fR -.PP -.PP + If you have a local network then you could try: -.PP -.PP + \fBsocket options = IPTOS_LOWDELAY TCP_NODELAY\fR -.PP -.PP + If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT. -.PP -.PP + Note that several of the options may cause your Samba server to fail completely. Use these options with caution! -.PP -.PP + Default: \fBsocket options = TCP_NODELAY\fR -.PP -.PP + Example: \fBsocket options = IPTOS_LOWDELAY\fR -.PP .TP \fBsource environment (G)\fR This parameter causes Samba to set environment @@ -6173,7 +6342,7 @@ will set the environment variables from the output of the pipe. The contents of the file or the output of the pipe should be formatted as the output of the standard Unix \fBenv(1) -\fRcommand. This is of the form : +\fR command. This is of the form : Example environment entry: @@ -6183,13 +6352,14 @@ Default: \fBNo default value\fR Examples: \fBsource environment = |/etc/smb.conf.sh \fR + Example: \fBsource environment = /usr/local/smb_env_vars\fR .TP \fBuse spnego (G)\fR -This variable controls controls whether samba will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism. As of samba 3.0alpha it must be set to "no" for these clients to join a samba domain controller. It can be set to "yes" to allow samba to participate in an AD domain controlled by a Windows2000 domain controller. +This variable controls controls whether samba will try to use Simple and Protected NEGOciation (as specified by rfc2478) with WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism. As of samba 3.0alpha it must be set to "no" for these clients to join a samba domain controller. It can be set to "yes" to allow samba to participate in an AD domain controlled by a Windows2000 domain controller. -Default: \fBuse spnego = yes\fR +Default: \fBuse spnego = yes\fR .TP \fBstat cache (G)\fR This parameter determines if smbd(8)will use a cache in order to @@ -6200,7 +6370,7 @@ Default: \fBstat cache = yes\fR .TP \fBstat cache size (G)\fR This parameter determines the number of -entries in the \fIstat cache\fR. You should +entries in the \fIstat cache\fR. You should never need to change this parameter. Default: \fBstat cache size = 50\fR @@ -6284,7 +6454,7 @@ the write call returns. If this is false then the server will be guided by the client's request in each write call (clients can set a bit indicating that a particular write should be synchronous). If this is true then every write will be followed by a \fBfsync() -\fRcall to ensure the data is written to disk. Note that +\fR call to ensure the data is written to disk. Note that the \fIstrict sync\fR parameter must be set to yes in order for this parameter to have any affect. @@ -6300,10 +6470,10 @@ are logged onto the system syslog logging levels. Samba debug level zero maps onto syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug level two maps onto LOG_NOTICE, debug level three -maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG. +maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG. This parameter sets the threshold for sending messages -to syslog. Only messages with debug level less than this value +to syslog. Only messages with debug level less than this value will be sent to syslog. Default: \fBsyslog = 1\fR @@ -6318,10 +6488,10 @@ Default: \fBsyslog only = no\fR \fBtemplate homedir (G)\fR When filling out the user information for a Windows NT user, the winbindd(8)daemon -uses this parameter to fill in the home directory for that user. +uses this parameter to fill in the home directory for that user. If the string \fI%D\fR is present it is substituted -with the user's Windows NT domain name. If the string \fI%U -\fRis present it is substituted with the user's Windows +with the user's Windows NT domain name. If the string \fI%U +\fR is present it is substituted with the user's Windows NT user name. Default: \fBtemplate homedir = /home/%D/%U\fR @@ -6344,30 +6514,43 @@ Default: \fBtime offset = 0\fR Example: \fBtime offset = 60\fR .TP \fBtime server (G)\fR -This parameter determines if +This parameter determines if nmbd(8)advertises itself as a time server to Windows clients. Default: \fBtime server = no\fR .TP \fBtimestamp logs (G)\fR -Synonym for \fI debug timestamp\fR. +Synonym for \fI debug timestamp\fR. .TP \fBtotal print jobs (G)\fR This parameter accepts an integer value which defines a limit on the maximum number of print jobs that will be accepted -system wide at any given time. If a print job is submitted +system wide at any given time. If a print job is submitted by a client which will exceed this number, then smbdwill return an -error indicating that no space is available on the server. The -default value of 0 means that no such limit exists. This parameter +error indicating that no space is available on the server. The +default value of 0 means that no such limit exists. This parameter can be used to prevent a server from exceeding its capacity and is -designed as a printing throttle. See also +designed as a printing throttle. See also \fImax print jobs\fR. Default: \fBtotal print jobs = 0\fR Example: \fBtotal print jobs = 5000\fR .TP +\fBunicode (G)\fR +Specifies whether Samba should try +to use unicode on the wire by default. + +Default: \fBunicode = yes\fR +.TP +\fBunix charset (G)\fR +Specifies the charset the unix machine +Samba runs on uses. Samba needs to know this in order to be able to +convert text to the charsets other SMB clients use. + +Default: \fBunix charset = ASCII\fR +.TP \fBunix extensions(G)\fR This boolean parameter controls whether Samba implments the CIFS UNIX extensions, as defined by HP. @@ -6389,7 +6572,7 @@ old UNIX password (as the SMB password change code has no access to the old password cleartext, only the new). See also \fIpasswd -program\fR, \fI passwd chat\fR. +program\fR, \fI passwd chat\fR. Default: \fBunix password sync = no\fR .TP @@ -6421,29 +6604,29 @@ Default: \fBupdate encrypted = no\fR .TP \fBuse client driver (S)\fR This parameter applies only to Windows NT/2000 -clients. It has no affect on Windows 95/98/ME clients. When +clients. It has no affect on Windows 95/98/ME clients. When serving a printer to Windows NT/2000 clients without first installing a valid printer driver on the Samba host, the client will be required -to install a local printer driver. From this point on, the client +to install a local printer driver. From this point on, the client will treat the print as a local printer and not a network printer -connection. This is much the same behavior that will occur -when \fBdisable spoolss = yes\fR. +connection. This is much the same behavior that will occur +when \fBdisable spoolss = yes\fR. The differentiating factor is that under normal circumstances, the NT/2000 client will -attempt to open the network printer using MS-RPC. The problem is that +attempt to open the network printer using MS-RPC. The problem is that because the client considers the printer to be local, it will attempt to issue the OpenPrinterEx() call requesting access rights associated with the logged on user. If the user possesses local administator rights but not root privilegde on the Samba host (often the case), the OpenPrinterEx() -call will fail. The result is that the client will now display an "Access +call will fail. The result is that the client will now display an "Access Denied; Unable to connect" message in the printer queue window (even though -jobs may successfully be printed). +jobs may successfully be printed). If this parameter is enabled for a printer, then any attempt to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped -to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx() -call to succeed. \fBThis parameter MUST not be able enabled +to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx() +call to succeed. \fBThis parameter MUST not be able enabled on a print share which has valid print driver installed on the Samba server.\fR @@ -6469,18 +6652,18 @@ will be read to find the names of hosts and users who will be allowed access without specifying a password. \fBNOTE:\fR The use of \fIuse rhosts -\fRcan be a major security hole. This is because you are +\fR 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 \fI use rhosts\fR option be only used if you really know what +get a PC to supply a false username. I recommend that the \fI use rhosts\fR option be only used if you really know what you are doing. Default: \fBuse rhosts = no\fR .TP \fBuser (S)\fR -Synonym for \fI username\fR. +Synonym for \fI username\fR. .TP \fBusers (S)\fR -Synonym for \fI username\fR. +Synonym for \fI username\fR. .TP \fBusername (S)\fR Multiple users may be specified in a comma-delimited @@ -6511,7 +6694,7 @@ so they cannot do anything that user cannot do. To restrict a service to a particular set of users you can use the \fIvalid users -\fRparameter. +\fR parameter. If any of the usernames begin with a '@' then the name will be looked up first in the NIS netgroups list (if Samba @@ -6593,7 +6776,7 @@ Using '!' is most useful when you have a wildcard mapping line later in the file. For example to map from the name admin -or administrator to the UNIX name root you would use: +or administrator to the UNIX name root you would use: \fBroot = admin administrator\fR @@ -6607,7 +6790,7 @@ map file. If your system supports the NIS NETGROUP option then the netgroup database is checked before the \fI/etc/group -\fRdatabase for matching groups. +\fR database for matching groups. You can map Windows usernames that have spaces in them by using double quotes around the name. For example: @@ -6622,20 +6805,19 @@ unix user sys, and map the rest to guest. Note the use of the \&'!' to tell Samba to stop processing if it gets a match on that line. -.sp + .nf !sys = mary fred guest = * -.sp .fi Note that the remapping is applied to all occurrences -of usernames. Thus if you connect to \\\\server\\fred and fred is remapped to mary then you +of usernames. Thus if you connect to \\\\server\\fred and fred is remapped to mary then you will actually be connecting to \\\\server\\mary and will need to supply a password suitable for mary not fred. The only exception to this is the -username passed to the \fI password server\fR (if you have one). The password +username passed to the \fI password server\fR (if you have one). The password server will receive whatever username the client supplies without modification. @@ -6647,38 +6829,57 @@ they don't own the print job. Default: \fBno username map\fR Example: \fBusername map = /usr/local/samba/lib/users.map -\fR.TP +\fR +.TP \fButmp (G)\fR This boolean parameter is only available if -Samba has been configured and compiled with the option \fB --with-utmp\fR. If set to true then Samba will attempt +Samba has been configured and compiled with the option \fB --with-utmp\fR. If set to true then Samba will attempt to add utmp or utmpx records (depending on the UNIX system) whenever a connection is made to a Samba server. Sites may use this to record the user connecting to a Samba share. Due to the requirements of the utmp record, we are required to create a unique identifier for the -incoming user. Enabling this option creates an n^2 -algorithm to find this number. This may impede +incoming user. Enabling this option creates an n^2 +algorithm to find this number. This may impede performance on large installations. -See also the \fI utmp directory\fR parameter. +See also the \fI utmp directory\fR parameter. Default: \fButmp = no\fR .TP \fButmp directory(G)\fR This parameter is only available if Samba has -been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is +been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is used to store the utmp or utmpx files (depending on the UNIX system) that -record user connections to a Samba server. See also the \fIutmp\fR parameter. By default this is +record user connections to a Samba server. See also the \fIutmp\fR parameter. By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually \fI/var/run/utmp\fR on Linux). Default: \fBno utmp directory\fR + +Example: \fButmp directory = /var/run/utmp\fR +.TP +\fBwtmp directory(G)\fR +This parameter is only available if Samba has +been configured and compiled with the option \fB --with-utmp\fR. It specifies a directory pathname that is +used to store the wtmp or wtmpx files (depending on the UNIX system) that +record user connections to a Samba server. The difference with +the utmp directory is the fact that user info is kept after a user +has logged out. +See also the \fIutmp\fR parameter. By default this is +not set, meaning the system will use whatever utmp file the +native system is set to use (usually +\fI/var/run/wtmp\fR on Linux). + +Default: \fBno wtmp directory\fR + +Example: \fBwtmp directory = /var/log/wtmp\fR .TP \fBvalid users (S)\fR This is a list of users that should be allowed -to login to this service. Names starting with '@', '+' and '&' +to login to this service. Names starting with '@', '+' and '&' are interpreted using the same rules as described in the \fIinvalid users\fR parameter. @@ -6687,23 +6888,25 @@ If a username is in both this list and the \fIinvalid users\fR list then access is denied for that user. The current servicename is substituted for \fI%S -\fR\&. This is useful in the [homes] section. +\fR. This is useful in the [homes] section. See also \fIinvalid users \fR + Default: \fBNo valid users list (anyone can login) \fR + Example: \fBvalid users = greg, @pcusers\fR .TP \fBveto files(S)\fR This is a list of files and directories that -are neither visible nor accessible. Each entry in the list must +are neither visible nor accessible. Each entry in the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?' can be used to specify multiple files or directories as in DOS wildcards. Each entry must be a unix path, not a DOS path and -must \fBnot\fR include the unix directory +must \fBnot\fR include the unix directory separator '/'. Note that the \fIcase sensitive\fR option @@ -6722,12 +6925,13 @@ of Samba, as it will be forced to check all files and directories for a match as they are scanned. See also \fIhide files -\fRand \fI case sensitive\fR. +\fR and \fI case sensitive\fR. Default: \fBNo files or directories are vetoed. \fR + Examples: -.sp + .nf ; Veto any files containing the word Security, ; any ending in .tmp, and any directory containing the @@ -6737,7 +6941,6 @@ veto files = /*Security*/*.tmp/*root*/ ; Veto the Apple specific files that a NetAtalk server ; creates. veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ -.sp .fi .TP \fBveto oplock files (S)\fR @@ -6760,21 +6963,31 @@ the line (either in the [global] section or in the section for the particular NetBench share : Example: \fBveto oplock files = /*.SEM/ -\fR.TP +\fR +.TP +\fBvfs path (S)\fR +This parameter specifies the directory +to look in for vfs modules. The name of every \fBvfs object +\fR will be prepended by this directory + +Default: \fBvfs path = \fR + +Example: \fBvfs path = /usr/lib/samba/vfs\fR +.TP \fBvfs object (S)\fR This parameter specifies a shared object file that -is used for Samba VFS I/O operations. By default, normal +is used for Samba VFS I/O operations. By default, normal disk I/O operations are used but these can be overloaded -with a VFS object. The Samba VFS layer is new to Samba 2.2 and +with a VFS object. The Samba VFS layer is new to Samba 2.2 and must be enabled at compile time with --with-vfs. Default : \fBno value\fR .TP \fBvfs options (S)\fR This parameter allows parameters to be passed -to the vfs layer at initialization time. The Samba VFS layer +to the vfs layer at initialization time. The Samba VFS layer is new to Samba 2.2 and must be enabled at compile time -with --with-vfs. See also \fI vfs object\fR. +with --with-vfs. See also \fI vfs object\fR. Default : \fBno value\fR .TP @@ -6794,7 +7007,7 @@ to areas that are outside the directory tree being exported. Note that setting this parameter can have a negative effect on your server performance due to the extra system calls -that Samba has to do in order to perform the link checks. +that Samba has to do in order to perform the link checks. Default: \fBwide links = yes\fR .TP @@ -6810,15 +7023,15 @@ Default: \fBwinbind cache type = 15\fR On large installations using winbindd(8)it may be necessary to suppress the enumeration of users through the -\fBsetpwent()\fR, +\fB setpwent()\fR, \fBgetpwent()\fR and -\fBendpwent()\fR group of system calls. If +\fBendpwent()\fR group of system calls. If the \fIwinbind enum users\fR parameter is false, calls to the \fBgetpwent\fR system call will not return any data. \fBWarning:\fR Turning off user -enumeration may cause some programs to behave oddly. For +enumeration may cause some programs to behave oddly. For example, the finger program relies on having access to the full user list when searching for matching usernames. @@ -6829,9 +7042,9 @@ Default: \fBwinbind enum users = yes \fR On large installations using winbindd(8)it may be necessary to suppress the enumeration of groups through the -\fBsetgrent()\fR, +\fB setgrent()\fR, \fBgetgrent()\fR and -\fBendgrent()\fR group of system calls. If +\fBendgrent()\fR group of system calls. If the \fIwinbind enum groups\fR parameter is false, calls to the \fBgetgrent()\fR system call will not return any data. @@ -6843,18 +7056,19 @@ Default: \fBwinbind enum groups = yes \fR .TP \fBwinbind gid (G)\fR The winbind gid parameter specifies the range of group -ids that are allocated by the winbindd(8)daemon. This range of group ids should have no +ids that are allocated by the winbindd(8)daemon. This range of group ids should have no existing local or NIS groups within it as strange conflicts can occur otherwise. Default: \fBwinbind gid = <empty string> \fR + Example: \fBwinbind gid = 10000-20000\fR .TP \fBwinbind separator (G)\fR This parameter allows an admin to define the character used when listing a username of the form of \fIDOMAIN -\fR\\\fIuser\fR. This parameter +\fR\\\fIuser\fR. This parameter is only applicable when using the \fIpam_winbind.so\fR and \fInss_winbind.so\fR modules for UNIX services. @@ -6868,25 +7082,27 @@ Example: \fBwinbind separator = +\fR .TP \fBwinbind uid (G)\fR The winbind gid parameter specifies the range of group -ids that are allocated by the winbindd(8)daemon. This range of ids should have no +ids that are allocated by the winbindd(8)daemon. This range of ids should have no existing local or NIS users within it as strange conflicts can occur otherwise. Default: \fBwinbind uid = <empty string> \fR + Example: \fBwinbind uid = 10000-20000\fR .TP \fBwinbind use default domain\fR .TP \fBwinbind use default domain\fR -This parameter specifies whether the winbindd(8) -daemon should operate on users without domain component in their username. +This parameter specifies whether the winbindd(8) +daemon should operate on users without domain component in their username. Users without a domain component are treated as is part of the winbindd server's -own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail +own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail function in a way much closer to the way they would in a native unix system. Default: \fBwinbind use default domain = <falseg> \fR + Example: \fBwinbind use default domain = true\fR .TP \fBwins hook (G)\fR @@ -6900,7 +7116,8 @@ The wins hook parameter specifies the name of a script or executable that will be called as follows: \fBwins_hook operation name nametype ttl IP_list -\fR.RS +\fR +.RS .TP 0.2i \(bu The first argument is the operation and is one @@ -6913,7 +7130,7 @@ as an add. \(bu The second argument is the NetBIOS name. If the name is not a legal name then the wins hook is not called. -Legal names contain only letters, digits, hyphens, underscores +Legal names contain only letters, digits, hyphens, underscores and periods. .TP 0.2i \(bu @@ -6929,22 +7146,21 @@ The fifth and subsequent arguments are the IP addresses currently registered for that name. If this list is empty then the name should be deleted. .RE -.PP + An example script that calls the BIND dynamic DNS update program \fBnsupdate\fR is provided in the examples directory of the Samba source code. -.PP .TP \fBwins proxy (G)\fR This is a boolean that controls if nmbd(8)will respond to broadcast name -queries on behalf of other hosts. You may need to set this +queries on behalf of other hosts. You may need to set this to yes for some older clients. Default: \fBwins proxy = no\fR .TP \fBwins server (G)\fR This specifies the IP address (or DNS name: IP -address for preference) of the WINS server that nmbd(8)should register with. If you have a WINS server on +address for preference) of the WINS server that nmbd(8)should register with. If you have a WINS server on your network then you should set this to the WINS server's IP. You should point this at your WINS server if you have a @@ -6962,7 +7178,7 @@ Default: \fBnot enabled\fR Example: \fBwins server = 192.9.200.1\fR .TP \fBwins support (G)\fR -This boolean controls if the +This boolean controls if the nmbd(8)process in Samba will act as a WINS server. You should not set this to true unless you have a multi-subnetted network and you wish a particular \fBnmbd\fR to be your WINS server. @@ -6982,7 +7198,7 @@ Default: \fBset at compile time to WORKGROUP\fR Example: \fBworkgroup = MYGROUP\fR .TP \fBwritable (S)\fR -Synonym for \fI writeable\fR for people who can't spell :-). +Synonym for \fI writeable\fR for people who can't spell :-). .TP \fBwrite cache size (S)\fR If this integer parameter is set to non-zero value, @@ -7021,14 +7237,27 @@ 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 \fIread list -\fRoption. +\fR option. Default: \fBwrite list = <empty string> \fR + Example: \fBwrite list = admin, root, @staff -\fR.TP +\fR +.TP +\fBwins partners (G)\fR +A space separated list of partners' IP addresses for +WINS replication. WINS partners are always defined as push/pull +partners as defining only one way WINS replication is unreliable. +WINS replication is currently experimental and unreliable between +samba servers. + +Default: \fBwins partners = \fR + +Example: \fBwins partners = 192.168.0.1 172.16.1.2\fR +.TP \fBwrite ok (S)\fR -Synonym for \fI writeable\fR. +Synonym for \fI writeable\fR. .TP \fBwrite raw (G)\fR This parameter controls whether or not the server @@ -7038,7 +7267,7 @@ You should never need to change this parameter. Default: \fBwrite raw = yes\fR .TP \fBwriteable (S)\fR -An inverted synonym is \fIread only\fR. +An inverted synonym is \fIread only\fR. If this parameter is no, then users of a service may not create or modify files in the service's @@ -7059,7 +7288,7 @@ problem - but be aware of the possibility. On a similar note, many clients - especially DOS clients - limit service names to eight characters. smbd(8) has no such limitation, but attempts to connect from such -clients will fail if they truncate the service names. For this reason +clients will fail if they truncate the service names. For this reason you should probably keep your service names down to eight characters in length. .PP @@ -7093,6 +7322,6 @@ to the way the Linux kernel is developed. The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at -ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/vfstest.1 b/docs/manpages/vfstest.1 new file mode 100644 index 0000000000..78e6e6c35a --- /dev/null +++ b/docs/manpages/vfstest.1 @@ -0,0 +1,178 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "VFSTEST" "1" "20 August 2002" "" "" +.SH NAME +vfstest \- tool for testing samba VFS modules +.SH SYNOPSIS + +\fBvfstest\fR [ \fB-d debuglevel\fR ] [ \fB-c command\fR ] [ \fB-l logfile\fR ] [ \fB-h\fR ] + +.SH "DESCRIPTION" +.PP +This tool is part of the Sambasuite. +.PP +\fBvfstest\fR is a small command line +utility that has the ability to test dso samba VFS modules. It gives the +user the ability to call the various VFS functions manually and +supports cascaded VFS modules. +.SH "OPTIONS" +.TP +\fB-c|--command=command\fR +Execute the specified (colon-seperated) commands. +See below for the commands that are available. +.TP +\fB-d|--debug=debuglevel\fR +set the debuglevel. Debug level 0 is the lowest +and 100 being the highest. This should be set to 100 if you are +planning on submitting a bug report to the Samba team (see \fIBUGS.txt\fR). +.TP +\fB-h|--help\fR +Print a summary of command line options. +.TP +\fB-l|--logfile=logbasename\fR +File name for log/debug files. The extension +\&'.client' will be appended. The log file is never removed +by the client. +.SH "COMMANDS" +.PP +\fBVFS COMMANDS\fR +.TP 0.2i +\(bu +\fBload <module.so>\fR - Load specified VFS module +.TP 0.2i +\(bu +\fBpopulate <char> <size>\fR - Populate a data buffer with the specified data +.TP 0.2i +\(bu +\fBshowdata [<offset> <len>]\fR - Show data currently in data buffer +.TP 0.2i +\(bu +\fBconnect\fR - VFS connect() +.TP 0.2i +\(bu +\fBdisconnect\fR - VFS disconnect() +.TP 0.2i +\(bu +\fBdisk_free\fR - VFS disk_free() +.TP 0.2i +\(bu +\fBopendir\fR - VFS opendir() +.TP 0.2i +\(bu +\fBreaddir\fR - VFS readdir() +.TP 0.2i +\(bu +\fBmkdir\fR - VFS mkdir() +.TP 0.2i +\(bu +\fBrmdir\fR - VFS rmdir() +.TP 0.2i +\(bu +\fBclosedir\fR - VFS closedir() +.TP 0.2i +\(bu +\fBopen\fR - VFS open() +.TP 0.2i +\(bu +\fBclose\fR - VFS close() +.TP 0.2i +\(bu +\fBread\fR - VFS read() +.TP 0.2i +\(bu +\fBwrite\fR - VFS write() +.TP 0.2i +\(bu +\fBlseek\fR - VFS lseek() +.TP 0.2i +\(bu +\fBrename\fR - VFS rename() +.TP 0.2i +\(bu +\fBfsync\fR - VFS fsync() +.TP 0.2i +\(bu +\fBstat\fR - VFS stat() +.TP 0.2i +\(bu +\fBfstat\fR - VFS fstat() +.TP 0.2i +\(bu +\fBlstat\fR - VFS lstat() +.TP 0.2i +\(bu +\fBunlink\fR - VFS unlink() +.TP 0.2i +\(bu +\fBchmod\fR - VFS chmod() +.TP 0.2i +\(bu +\fBfchmod\fR - VFS fchmod() +.TP 0.2i +\(bu +\fBchown\fR - VFS chown() +.TP 0.2i +\(bu +\fBfchown\fR - VFS fchown() +.TP 0.2i +\(bu +\fBchdir\fR - VFS chdir() +.TP 0.2i +\(bu +\fBgetwd\fR - VFS getwd() +.TP 0.2i +\(bu +\fButime\fR - VFS utime() +.TP 0.2i +\(bu +\fBftruncate\fR - VFS ftruncate() +.TP 0.2i +\(bu +\fBlock\fR - VFS lock() +.TP 0.2i +\(bu +\fBsymlink\fR - VFS symlink() +.TP 0.2i +\(bu +\fBreadlink\fR - VFS readlink() +.TP 0.2i +\(bu +\fBlink\fR - VFS link() +.TP 0.2i +\(bu +\fBmknod\fR - VFS mknod() +.TP 0.2i +\(bu +\fBrealpath\fR - VFS realpath() +.PP +\fBGENERAL COMMANDS\fR +.TP 0.2i +\(bu +\fBconf <smb.conf>\fR - Load a different configuration file +.TP 0.2i +\(bu +\fBhelp [<command>]\fR - Get list of commands or info about specified command +.TP 0.2i +\(bu +\fBdebuglevel <level>\fR - Set debug level +.TP 0.2i +\(bu +\fBfreemem\fR - Free memory currently in use +.TP 0.2i +\(bu +\fBexit\fR - Exit vfstest +.SH "VERSION" +.PP +This man page is correct for version 3.0 of the Samba +suite. +.SH "AUTHOR" +.PP +The original Samba software and related utilities +were created by Andrew Tridgell. Samba is now developed +by the Samba Team as an Open Source project similar +to the way the Linux kernel is developed. +.PP +The vfstest man page was written by Jelmer Vernooij. |