diff options
Diffstat (limited to 'docs/manpages')
| -rw-r--r-- | docs/manpages/nmbd.8 | 18 | ||||
| -rw-r--r-- | docs/manpages/smb.conf.5 | 85 | ||||
| -rw-r--r-- | docs/manpages/smbd.8 | 202 | ||||
| -rw-r--r-- | docs/manpages/smbpasswd.8 | 49 | ||||
| -rw-r--r-- | docs/manpages/winbindd.8 | 13 |
5 files changed, 105 insertions, 262 deletions
diff --git a/docs/manpages/nmbd.8 b/docs/manpages/nmbd.8 index 928cfce6e5..8270f5f749 100644 --- a/docs/manpages/nmbd.8 +++ b/docs/manpages/nmbd.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "NMBD" "8" "04 January 2002" "" "" +.TH "NMBD" "8" "24 January 2002" "" "" .SH NAME nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clients .SH SYNOPSIS @@ -161,7 +161,8 @@ required by the server. See If the server is to be run by the \fBinetd\fR meta-daemon, this file must contain suitable startup information for the -meta-daemon. See the section INSTALLATION below. +meta-daemon. See the UNIX_INSTALL.htmldocument +for details. .TP \fB\fI/etc/rc\fB\fR or whatever initialization script your @@ -169,15 +170,16 @@ system uses). If running the server as a daemon at startup, this file will need to contain an appropriate startup -sequence for the server. See the section INSTALLATION -below. +sequence for the server. See the UNIX_INSTALL.htmldocument +for details. .TP \fB\fI/etc/services\fB\fR If running the server via the meta-daemon \fBinetd\fR, this file must contain a mapping of service name (e.g., netbios-ssn) to service port (e.g., 139) and protocol type (e.g., tcp). -See the section INSTALLATION below. +See the UNIX_INSTALL.html +document for details. .TP \fB\fI/usr/local/samba/lib/smb.conf\fB\fR This is the default location of the @@ -188,13 +190,15 @@ and \fI/etc/smb.conf\fR. When run as a WINS server (see the wins support -parameter in the \fI smb.conf(5)\fRman page), \fBnmbd\fR +parameter in the \fIsmb.conf(5)\fR man page), +\fBnmbd\fR will store the WINS database in the file \fIwins.dat\fR in the \fIvar/locks\fR directory configured under wherever Samba was configured to install itself. If \fBnmbd\fR is acting as a \fB browse master\fR (see the local master -parameter in the \fI smb.conf(5)\fRman page), \fBnmbd\fR +parameter in the \fIsmb.conf(5)\fR man page, +\fBnmbd\fR will store the browsing database in the file \fIbrowse.dat \fRin the \fIvar/locks\fR directory configured under wherever Samba was configured to install itself. diff --git a/docs/manpages/smb.conf.5 b/docs/manpages/smb.conf.5 index 92ad1158f5..ace3e54946 100644 --- a/docs/manpages/smb.conf.5 +++ b/docs/manpages/smb.conf.5 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMB.CONF" "5" "04 January 2002" "" "" +.TH "SMB.CONF" "5" "24 January 2002" "" "" .SH NAME smb.conf \- The configuration file for the Samba suite .SH "SYNOPSIS" @@ -527,6 +527,9 @@ each parameter for details. Note that some are synonyms. \fIannounce version\fR .TP 0.2i \(bu +\fIauth methods\fR +.TP 0.2i +\(bu \fIauto services\fR .TP 0.2i \(bu @@ -776,10 +779,10 @@ each parameter for details. Note that some are synonyms. \fInis homedir\fR .TP 0.2i \(bu -\fInt pipe support\fR +\fInon unix account range\fR .TP 0.2i \(bu -\fInt smb support\fR +\fInt pipe support\fR .TP 0.2i \(bu \fInull passwords\fR @@ -803,6 +806,9 @@ each parameter for details. Note that some are synonyms. \fIpanic action\fR .TP 0.2i \(bu +\fIpassdb backend\fR +.TP 0.2i +\(bu \fIpasswd chat\fR .TP 0.2i \(bu @@ -1019,6 +1025,9 @@ each parameter for details. Note that some are synonyms. \fIwinbind uid\fR .TP 0.2i \(bu +\fIwinbind use default domain\fR +.TP 0.2i +\(bu \fIwins hook\fR .TP 0.2i \(bu @@ -1639,6 +1648,18 @@ Example: \fBannounce version = 2.0\fR \fBauto services (G)\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. +Each entry in the list attempts to authenticate the user in turn, until +the user authenticates. In practice only one method will ever actually +be able to complete the authentication. + +Default: \fBauth methods = <empty string>\fR + +Example: \fBauth methods = guest sam ntdomain\fR +.TP \fBavailable (S)\fR This parameter lets you "turn off" a service. If \fIavailable = no\fR, then \fBALL\fR @@ -2678,7 +2699,7 @@ In order for encrypted passwords to work correctly \fBsmbd(8)\fRmust either have access to a local \fIsmbpasswd(5) \fRprogram for information on how to set up -and maintain this file), or set the security = [server|domain] parameter which +and maintain this file), or set the security = [server|domain|ads] parameter which causes \fBsmbd\fR to authenticate against another server. @@ -4596,6 +4617,23 @@ be a logon server. Default: \fBnis homedir = no\fR .TP +\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. +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. + +NOTE: These userids never appear on the system and Samba will never +\&'become' these users. They are used only to ensure that the algorithmic +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 This boolean parameter controls whether smbd(8)will attempt to map @@ -4614,21 +4652,6 @@ alone. Default: \fBnt pipe support = yes\fR .TP -\fBnt smb support (G)\fR -This boolean parameter controls whether smbd(8)will negotiate NT specific SMB -support with Windows NT clients. Although this is a developer -debugging option and should be left alone, benchmarking has discovered -that Windows NT clients give faster performance with this option -set to no. This is still being investigated. -If this option is set to no then Samba offers -exactly the same SMB calls that versions prior to Samba 2.0 offered. -This information may be of use if any users are having problems -with NT SMB support. - -You should not need to ever disable this parameter. - -Default: \fBnt smb support = yes\fR -.TP \fBnull passwords (G)\fR Allow or disallow client access to accounts that have null passwords. @@ -4788,6 +4811,17 @@ Default: \fBpanic action = <empty string>\fR Example: \fBpanic action = "/bin/sleep 90000"\fR .TP +\fBpassdb backend (G)\fR +This option allows the administrator to chose what +backend in which to store passwords. This allows (for example) both +smbpasswd and tdbsam to be used without a recompile. Only one can +be used at a time however, and experimental backends must still be selected +(eg --with-tdbsam) at configure time. + +Default: \fBpassdb backend = smbpasswd\fR + +Example: \fBpassdb backend = tdbsam\fR +.TP \fBpasswd chat (G)\fR This string controls the \fB"chat"\fR conversation that takes places between smbdand the local password changing @@ -7165,6 +7199,19 @@ 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. +Users without a domain component are treated as is part of the winbindd server's +own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail +function in a way much closer to the way they would in a native unix system. + +Default: \fBwinbind use default domain = <falseg> +\fR +Example: \fBwinbind use default domain = true\fR +.TP \fBwins hook (G)\fR When Samba is running as a WINS server this allows you to call an external program for all changes to the diff --git a/docs/manpages/smbd.8 b/docs/manpages/smbd.8 index 9554bba6d5..365e618782 100644 --- a/docs/manpages/smbd.8 +++ b/docs/manpages/smbd.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBD" "8" "04 January 2002" "" "" +.TH "SMBD" "8" "24 January 2002" "" "" .SH NAME smbd \- server to provide SMB/CIFS services to clients .SH SYNOPSIS @@ -172,7 +172,8 @@ compile time. If the server is to be run by the \fBinetd\fR meta-daemon, this file must contain suitable startup information for the -meta-daemon. See the section INSTALLATION below. +meta-daemon. See the UNIX_INSTALL.html +document for details. .TP \fB\fI/etc/rc\fB\fR or whatever initialization script your @@ -180,15 +181,16 @@ system uses). If running the server as a daemon at startup, this file will need to contain an appropriate startup -sequence for the server. See the section INSTALLATION -below. +sequence for the server. See the UNIX_INSTALL.html +document for details. .TP \fB\fI/etc/services\fB\fR If running the server via the meta-daemon \fBinetd\fR, this file must contain a mapping of service name (e.g., netbios-ssn) to service port (e.g., 139) and protocol type (e.g., tcp). -See the section INSTALLATION below. +See the UNIX_INSTALL.html +document for details. .TP \fB\fI/usr/local/samba/lib/smb.conf\fB\fR This is the default location of the @@ -216,178 +218,6 @@ printable services, most systems will use the value of this variable (or lp if this variable is not defined) as the name of the printer to use. This is not specific to the server, however. -.SH "INSTALLATION" -.PP -The location of the server and its support files -is a matter for individual system administrators. The following -are thus suggestions only. -.PP -It is recommended that the server software be installed -under the \fI/usr/local/samba/\fR hierarchy, -in a directory readable by all, writeable only by root. The server -program itself should be executable by all, as users may wish to -run the server themselves (in which case it will of course run -with their privileges). The server should NOT be setuid. On some -systems it may be worthwhile to make \fBsmbd\fR setgid to an empty group. -This is because some systems may have a security hole where daemon -processes that become a user can be attached to with a debugger. -Making the \fBsmbd\fR file setgid to an empty group may prevent -this hole from being exploited. This security hole and the suggested -fix has only been confirmed on old versions (pre-kernel 2.0) of Linux -at the time this was written. It is possible that this hole only -exists in Linux, as testing on other systems has thus far shown them -to be immune. -.PP -The server log files should be put in a directory readable and -writeable only by root, as the log files may contain sensitive -information. -.PP -The configuration file should be placed in a directory -readable and writeable only by root, as the configuration file -controls security for the services offered by the server. The -configuration file can be made readable by all if desired, but -this is not necessary for correct operation of the server and is -not recommended. A sample configuration file \fIsmb.conf.sample -\fRis supplied with the source to the server - this may -be renamed to \fIsmb.conf\fR and modified to suit -your needs. -.PP -The remaining notes will assume the following: -.TP 0.2i -\(bu -\fBsmbd\fR (the server program) -installed in \fI/usr/local/samba/bin\fR -.TP 0.2i -\(bu -\fIsmb.conf\fR (the configuration -file) installed in \fI/usr/local/samba/lib\fR -.TP 0.2i -\(bu -log files stored in \fI/var/adm/smblogs -\fR.PP -The server may be run either as a daemon by users -or at startup, or it may be run from a meta-daemon such as -\fBinetd\fR upon request. If run as a daemon, -the server will always be ready, so starting sessions will be -faster. If run from a meta-daemon some memory will be saved and -utilities such as the tcpd TCP-wrapper may be used for extra -security. For serious use as file server it is recommended -that \fBsmbd\fR be run as a daemon. -.PP -.PP -When you've decided, continue with either -.PP -.TP 0.2i -\(bu -RUNNING THE SERVER AS A DAEMON or -.TP 0.2i -\(bu -RUNNING THE SERVER ON REQUEST. -.SH "RUNNING THE SERVER AS A DAEMON" -.PP -To run the server as a daemon from the command -line, simply put the \fB-D\fR option on the -command line. There is no need to place an ampersand at -the end of the command line - the \fB-D\fR -option causes the server to detach itself from the tty -anyway. -.PP -Any user can run the server as a daemon (execute -permissions permitting, of course). This is useful for -testing purposes, and may even be useful as a temporary -substitute for something like ftp. When run this way, however, -the server will only have the privileges of the user who ran -it. -.PP -To ensure that the server is run as a daemon whenever -the machine is started, and to ensure that it runs as root -so that it can serve multiple clients, you will need to modify -the system startup files. Wherever appropriate (for example, in -\fI/etc/rc\fR), insert the following line, -substituting port number, log file location, configuration file -location and debug level as desired: -.PP -\fB/usr/local/samba/bin/smbd -D -l /var/adm/smblogs/log --s /usr/local/samba/lib/smb.conf\fR -.PP -(The above should appear in your initialization script -as a single line. Depending on your terminal characteristics, -it may not appear that way in this man page. If the above appears -as more than one line, please treat any newlines or indentation -as a single space or TAB character.) -.PP -If the options used at compile time are appropriate for -your system, all parameters except \fB-D\fR may -be omitted. See the section OPTIONS above. -.SH "RUNNING THE SERVER ON REQUEST" -.PP -If your system uses a meta-daemon such as \fBinetd -\fR, you can arrange to have the \fBsmbd\fR server started -whenever a process attempts to connect to it. This requires several -changes to the startup files on the host machine. If you are -experimenting as an ordinary user rather than as root, you will -need the assistance of your system administrator to modify the -system files. -.PP -You will probably want to set up the NetBIOS name server -\fBnmbd\fRat -the same time as \fBsmbd\fR. To do this refer to the -man page for \fBnmbd(8)\fR -. -.PP -First, ensure that a port is configured in the file -\fI/etc/services\fR. The well-known port 139 -should be used if possible, though any port may be used. -.PP -Ensure that a line similar to the following is in -\fI/etc/services\fR: -.PP -\fBnetbios-ssn 139/tcp\fR -.PP -Note for NIS/YP users - you may need to rebuild the -NIS service maps rather than alter your local \fI/etc/services -\fRfile. -.PP -Next, put a suitable line in the file \fI/etc/inetd.conf -\fR(in the unlikely event that you are using a meta-daemon -other than inetd, you are on your own). Note that the first item -in this line matches the service name in \fI/etc/services -\fR\&. Substitute appropriate values for your system -in this line (see \fBinetd(8)\fR): -.PP -\fBnetbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd --d1 -l/var/adm/smblogs/log -s/usr/local/samba/lib/smb.conf\fR -.PP -(The above should appear in \fI/etc/inetd.conf\fR -as a single line. Depending on your terminal characteristics, it may -not appear that way in this man page. If the above appears as more -than one line, please treat any newlines or indentation as a single -space or TAB character.) -.PP -Note that there is no need to specify a port number here, -even if you are using a non-standard port number. -.PP -Lastly, edit the configuration file to provide suitable -services. To start with, the following two services should be -all you need: -.sp -.nf - [homes] - writeable = yes - - [printers] - writeable = no - printable = yes - path = /tmp - public = yes - - -.sp -.fi -.PP -This will allow you to connect to your home directory -and print to any printer supported by the host (user privileges -permitting). .SH "PAM INTERACTION" .PP Samba uses PAM for authentication (when presented with a plaintext @@ -409,24 +239,6 @@ level secuirty, users must pass PAM's session checks before access is granted. Note however, that this is bypassed in share level secuirty. Note also that some older pam configuration files may need a line added for session support. -.SH "TESTING THE INSTALLATION" -.PP -If running the server as a daemon, execute it before -proceeding. If using a meta-daemon, either restart the system -or kill and restart the meta-daemon. Some versions of -\fBinetd\fR will reread their configuration -tables if they receive a HUP signal. -.PP -If your machine's name is \fIfred\fR and your -name is \fImary\fR, you should now be able to connect -to the service \fI\\\\fred\\mary\fR. -.PP -To properly test and experiment with the server, we -recommend using the \fBsmbclient\fR program (see -\fBsmbclient(1)\fR) -and also going through the steps outlined in the file -\fIDIAGNOSIS.txt\fR in the \fIdocs/\fR -directory of your Samba installation. .SH "VERSION" .PP This man page is correct for version 2.2 of diff --git a/docs/manpages/smbpasswd.8 b/docs/manpages/smbpasswd.8 index 151a3270ff..07d9c6e549 100644 --- a/docs/manpages/smbpasswd.8 +++ b/docs/manpages/smbpasswd.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBPASSWD" "8" "04 January 2002" "" "" +.TH "SMBPASSWD" "8" "24 January 2002" "" "" .SH NAME smbpasswd \- change a user's SMB password .SH SYNOPSIS @@ -56,9 +56,10 @@ following should be added to the local smbpasswd file, with the new password typed (type <Enter> for the old password). This option is ignored if the username following already exists in the smbpasswd file and it is treated like a regular change -password command. Note that the user to be added must already exist -in the system password file (usually \fI/etc/passwd\fR) -else the request to add the user will fail. +password command. Note that the default passdb backends require +the user to already exist in the system password file (usually +\fI/etc/passwd\fR), else the request to add the +user will fail. This option is only available when running smbpasswd as root. @@ -80,8 +81,7 @@ will fail. If the smbpasswd file is in the 'old' format (pre-Samba 2.0 format) there is no space in the user's password entry to write -this information and so the user is disabled by writing 'X' characters -into the password space in the smbpasswd file. See \fBsmbpasswd(5) +this information and the command will FAIL. See \fBsmbpasswd(5) \fRfor details on the 'old' and new password file formats. This option is only available when running smbpasswd as @@ -94,9 +94,8 @@ if the account was previously disabled. If the account was not disabled this option has no effect. Once the account is enabled then the user will be able to authenticate via SMB once again. -If the smbpasswd file is in the 'old' format, then \fB smbpasswd\fR will prompt for a new password for this user, -otherwise the account will be enabled by removing the 'D' -flag from account control space in the \fI smbpasswd\fR file. See \fBsmbpasswd (5)\fR for +If the smbpasswd file is in the 'old' format, then \fB smbpasswd\fR will FAIL to enable the account. +See \fBsmbpasswd (5)\fR for details on the 'old' and new password file formats. This option is only available when running smbpasswd as root. @@ -210,36 +209,6 @@ when Samba is being used as an NT Primary Domain Controller. This option is only available when running smbpasswd as root. .TP -\fB-j DOMAIN\fR -This option is used to add a Samba server -into a Windows NT Domain, as a Domain member capable of authenticating -user accounts to any Domain Controller in the same way as a Windows -NT Server. See the \fBsecurity = domain\fR option in -the \fIsmb.conf(5)\fR man page. - -In order to be used in this way, the Administrator for -the Windows NT Domain must have used the program "Server Manager -for Domains" to add the primary NetBIOS name of the Samba server -as a member of the Domain. - -After this has been done, to join the Domain invoke \fB smbpasswd\fR with this parameter. smbpasswd will then -look up the Primary Domain Controller for the Domain (found in -the \fIsmb.conf\fR file in the parameter -\fIpassword server\fR and change the machine account -password used to create the secure Domain communication. This -password is then stored by smbpasswd in a TDB, writeable only by root, -called \fIsecrets.tdb\fR - -Once this operation has been performed the \fI smb.conf\fR file may be updated to set the \fB security = domain\fR option and all future logins -to the Samba server will be authenticated to the Windows NT -PDC. - -Note that even though the authentication is being -done to the PDC all users accessing the Samba server must still -have a valid UNIX account on that machine. - -This option is only available when running smbpasswd as root. -.TP \fB-U username\fR This option may only be used in conjunction with the \fI-r\fR option. When changing @@ -292,7 +261,7 @@ has been set up to use encrypted passwords. See the file on how to do this. .SH "VERSION" .PP -This man page is correct for version 2.2 of +This man page is correct for version 3.0 of the Samba suite. .SH "SEE ALSO" .PP diff --git a/docs/manpages/winbindd.8 b/docs/manpages/winbindd.8 index da5988811a..0ca8c94f94 100644 --- a/docs/manpages/winbindd.8 +++ b/docs/manpages/winbindd.8 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "WINBINDD" "8" "04 January 2002" "" "" +.TH "WINBINDD" "8" "24 January 2002" "" "" .SH NAME winbindd \- Name Service Switch daemon for resolving names from NT servers .SH SYNOPSIS @@ -205,6 +205,17 @@ a Windows NT user, the \fBwinbindd\fR daemon uses this parameter to fill in the shell for that user. Default: \fBtemplate shell = /bin/false \fR +.TP +\fBwinbind use default domain\fR +This parameter specifies whether the \fBwinbindd\fR +daemon should operate on users without domain component in their username. +Users without a domain component are treated as is part of the winbindd server's +own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail +function in a way much closer to the way they would in a native unix system. + +Default: \fBwinbind use default domain = <falseg> +\fR +Example: \fBwinbind use default domain = true\fR .SH "EXAMPLE SETUP" .PP To setup winbindd for user and group lookups plus |