updated bit on kill -HUP to make it clear what effect this has, and its
[kai/samba.git] / docs / manpages / smbd.8
index bae41b2c479525b4de43085dbdf0ee76940e96ad..434844822a4bcb04849912c33e02fc81aead5802 100644 (file)
@@ -1,46 +1,49 @@
-.TH SMBD 8 17/1/1995 smbd smbd
+.TH SMBD 8 smbd smbd
 .SH NAME
 smbd \- provide SMB (aka LanManager) services to clients
 .SH SYNOPSIS
 .B smbd
 [
-.B -D
+.B \-D
 ] [
-.B -a
+.B \-a
 ] [
-.B -d
+.B \-d
 .I debuglevel
 ] [
-.B -l
+.B \-l
 .I log file
 ] [
-.B -p
+.B \-p
 .I port number
 ] [
-.B -O
+.B \-O
 .I socket options
 ] [
-.B -s
+.B \-s
 .I configuration file
 ]
 .SH DESCRIPTION
 This program is part of the Samba suite.
 
 .B smbd
-is a server that can provide most SMB services. The 
-server provides filespace and printer services to clients using the SMB 
-protocol. This is compatible with the LanManager protocol, and can
-service LanManager clients.
+is a server that can provide most SMB services. The server provides
+filespace and printer services to clients using the SMB protocol. This
+is compatible with the LanManager protocol, and can service LanManager
+clients.  These include MSCLIENT 3.0 for DOS, Windows for Workgroups,
+Windows 95, Windows NT, OS/2, DAVE for Macintosh, and smbfs for Linux.
 
 An extensive description of the services that the server can provide is given
 in the man page for the configuration file controlling the attributes of those
 services (see
-.B smb.conf(5)). This man page will not describe the services, but
+.BR smb.conf (5)).
+This man page will not describe the services, but
 will concentrate on the administrative aspects of running the server.
 
 Please note that there are significant security implications to running this
 server, and
-.B smb.conf(5) should be regarded as mandatory reading before proceeding with 
+.BR smb.conf (5)
+should be regarded as mandatory reading before proceeding with 
 installation.
 
 A session is created whenever a client requests one. Each client gets a copy
@@ -48,11 +51,13 @@ of the server for each session. This copy then services all connections made
 by the client during that session. When all connections from its client are
 are closed, the copy of the server for that client terminates.
 
-The configuration file is automatically reloaded if it changes. You
-can force a reload by sending a SIGHUP to the server.
-
+The configuration file, and any files that it includes, are automatically
+reloaded every minute, if they change.  You can force a reload by sending a
+SIGHUP to the server.  Reloading the configuration file will not affect
+connections to any service that is already established.  Either the user
+will have to disconnect from the service, or smbd killed and restarted.
 .SH OPTIONS
-.B -D
+.B \-D
 
 .RS 3
 If specified, this parameter causes the server to operate as a daemon. That is,
@@ -62,18 +67,18 @@ appropriate port.
 By default, the server will NOT operate as a daemon.
 .RE
 
-.B -a
+.B \-a
 
 .RS 3
 If this parameter is specified, the log files will be overwritten with each 
 new connection. By default, the log files will be appended to.
 .RE
 
-.B -d
+.B \-d
 .I debuglevel
 .RS 3
 
-debuglevel is an integer from 0 to 5.
+debuglevel is an integer from 0 to 10.
 
 The default value if this parameter is not specified is zero.
 
@@ -88,7 +93,7 @@ use only by developers and generate HUGE amounts of log data, most of which
 is extremely cryptic.
 .RE
 
-.B -l
+.B \-l
 .I log file
 
 .RS 3
@@ -113,14 +118,16 @@ log.out (containing outbound transaction data)
 The log files generated are never removed by the server.
 .RE
 
-.B -O
+.B \-O
 .I socket options
 .RS 3
 
-See the socket options section of smb.conf(5) for details
+See the socket options section of
+.BR smb.conf (5)
+for details
 
 .RE
-.B -p
+.B \-p
 .I port number
 .RS 3
 
@@ -135,10 +142,14 @@ user rather than as root, most systems will require you to use a port number
 greater than 1024 - ask your system administrator for help if you are in this
 situation.
 
+In order for the server to be useful by most clients, should you configure
+it on a port other than 139, you will require port redirection services
+on port 139, details of which are outlined in rfc1002.txt section 4.3.5.
+
 This parameter is not normally specified except in the above situation.
 .RE
 
-.B -s
+.B \-s
 .I configuration file
 
 .RS 3
@@ -148,9 +159,9 @@ The file specified contains the configuration details required by the server.
 The information in this file includes server-specific information such as
 what printcap file to use, as well as descriptions of all the services that the
 server is to provide. See
-.B smb.conf(5) for more information.
+.BR smb.conf (5)
+for more information.
 .RE
-
 .SH FILES
 
 .B /etc/inetd.conf
@@ -179,23 +190,23 @@ mapping of service name (eg., netbios-ssn)  to service port (eg., 139) and
 protocol type (eg., tcp). See the section "INSTALLATION" below.
 .RE
 
-.B /usr/local/smb/smb.conf
+.B /usr/local/samba/lib/smb.conf
 
 .RS 3
 This file describes all the services the server is to make available to
 clients. See
-.B smb.conf(5) for more information.
+.BR smb.conf (5)
+for more information.
 .RE
-.RE
-
 .SH LIMITATIONS
 
-On some systems smbd cannot change uid back to root after a setuid() call.
+On some systems
+.B smbd
+cannot change uid back to root after a setuid() call.
 Such systems are called "trapdoor" uid systems. If you have such a system,
 you will be unable to connect from a client (such as a PC) as two different
 users at once. Attempts to connect the second user will result in "access
 denied" or similar.
-
 .SH ENVIRONMENT VARIABLES
 
 .B PRINTER
@@ -206,13 +217,12 @@ 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.
 .RE
-
 .SH INSTALLATION
 The location of the server and its support files is a matter for individual
 system administrators. The following are thus suggestions only.
 
 It is recommended that the server software be installed under the
-/usr/local hierarchy, in a directory readable by all, writeable only
+/usr/local/samba 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
@@ -220,7 +230,7 @@ setuid. On some systems it may be worthwhile to make smbd 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 smbd file setgid to an empty group may prevent
-this hole from being exploited. This secrity hole and the suggested
+this hole from being exploited. This security hole and the suggested
 fix has only been confirmed on 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.
@@ -239,9 +249,10 @@ modified to suit your needs.
 The remaining notes will assume the following:
 
 .RS 3
-smbd (the server program) installed in /usr/local/smb
+.B smbd
+(the server program) installed in /usr/local/samba/bin
 
-smb.conf (the configuration file) installed in /usr/local/smb
+smb.conf (the configuration file) installed in /usr/local/samba/lib
 
 log files stored in /var/adm/smblogs
 .RE
@@ -255,9 +266,13 @@ TCP-wrapper may be used for extra security.
 When you've decided, continue with either "RUNNING THE SERVER AS A DAEMON" or
 "RUNNING THE SERVER ON REQUEST".
 .SH RUNNING THE SERVER AS A DAEMON
-To run the server as a daemon from the command line, simply put the "-D" option
+To run the server as a daemon from the command line, simply put the
+.B \-D
+option
 on the command line. There is no need to place an ampersand at the end of the
-command line - the "-D" option causes the server to detach itself from the
+command line - the
+.B \-D
+option causes the server to detach itself from the
 tty anyway.
 
 Any user can run the server as a daemon (execute permissions permitting, of 
@@ -273,7 +288,7 @@ port number, log file location, configuration file location and debug level as
 desired:
 
 .RS 3
-/usr/local/smb/smbd -D -l /var/adm/smblogs/log -s /usr/local/smb/smb.conf
+/usr/local/samba/bin/smbd -D -l /var/adm/smblogs/log -s /usr/local/samba/lib/smb.conf
 .RE
 
 (The above should appear in your initialisation script as a single line. 
@@ -282,7 +297,9 @@ 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.)
 
 If the options used at compile time are appropriate for your system, all
-parameters except the desired debug level and "-D" may be omitted. See the
+parameters except the desired debug level and
+.B \-D
+may be omitted. See the
 section "OPTIONS" above.
 .SH RUNNING THE SERVER ON REQUEST
 If your system uses a meta-daemon such as inetd, you can arrange to have the
@@ -294,8 +311,9 @@ assistance of your system administrator to modify the system files.
 You will probably want to set up the name server
 .B nmbd
 at the same time as
-the smbd - refer to the man page 
-.B nmbd(8).
+.B smbd
+- refer to the man page 
+.BR nmbd (8).
 
 First, ensure that a port is configured in the file /etc/services. The 
 well-known port 139 should be used if possible, though any port may be used.
@@ -313,11 +331,14 @@ Next, put a suitable line in the file /etc/inetd.conf (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 /etc/services.
 Substitute appropriate values for your system in this line (see
-.B inetd(8)):
+.BR inetd (8)):
 
 .RS 3
-netbios-ssn stream tcp nowait root /usr/local/smb/smbd -d1 
--l/var/adm/smblogs/log -s/usr/local/smb/smb.conf
+.\" turn off right adjustment
+.ad l
+netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd -d1 
+-l/var/adm/smblogs/log -s/usr/local/samba/lib/smb.conf
+.ad
 .RE
 
 (The above should appear in /etc/inetd.conf as a single line. Depending on 
@@ -355,27 +376,28 @@ meta-daemon. Some versions of inetd will reread their configuration tables if
 they receive a HUP signal.
 
 If your machine's name is "fred" and your name is "mary", you should now be
-able to connect to the service "\\\\fred\\mary".
+able to connect to the service "\e\efred\emary".
 
 To properly test and experiment with the server, we recommend using the
 smbclient program (see
-.B smbclient(1)).
+.BR smbclient (1)).
 .SH VERSION
-This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
-of the recent patches to it. These notes will necessarily lag behind 
+This man page is (mostly) correct for version 1.9.00 of the Samba suite,
+plus some of the recent patches to it. These notes will necessarily lag behind 
 development of the software, so it is possible that your version of 
 the server has extensions or parameter semantics that differ from or are not 
 covered by this man page. Please notify these to the address below for 
 rectification.
 .SH SEE ALSO
-.B hosts_access(5),
-.B inetd(8),
-.B nmbd(8), 
-.B smb.conf(5),
-.B smbclient(1),
-.B testparm(1), 
-.B testprns(1)
-
+.BR hosts_access (5),
+.BR inetd (8),
+.BR nmbd (8), 
+.BR smb.conf (5),
+.BR smbclient (1),
+.BR testparm (1), 
+.BR testprns (1)
+.BR rfc1001.txt
+.BR rfc1002.txt
 .SH DIAGNOSTICS
 [This section under construction]
 
@@ -392,16 +414,15 @@ creation of this man page the source code is still too fluid to warrant
 describing each and every diagnostic. At this stage your best bet is still
 to grep the source code and inspect the conditions that gave rise to the 
 diagnostics you are seeing.
-
 .SH BUGS
 None known.
 .SH CREDITS
 The original Samba software and related utilities were created by 
-Andrew Tridgell (samba-bugs@anu.edu.au). Andrew is also the Keeper
+Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
 of the Source for this project.
 
-This man page written by Karl Auer (Karl.Auer@anu.edu.au)
 
 See
-.B smb.conf(5) for a full list of contributors and details on how to 
+.BR smb.conf (5)
+for a full list of contributors and details on how to 
 submit bug reports, comments etc.