global change from samba.anu.edu.au to samba.org
[samba.git] / docs / yodldocs / smbd.8.yo
index 6d92481b8b3f8b7e41e3208bae2cd92f4282f9be..acd2639a263ff861baca1ec9d1100cc09a4c9adb 100644 (file)
@@ -1,19 +1,22 @@
-mailto(samba-bugs@samba.anu.edu.au
+mailto(samba-bugs@samba.org
 
-manpage(smbd)(8)(23 Oct 1998)(Samba)(SAMBA)
+manpage(smbd htmlcommand((8)))(8)(23 Oct 1998)(Samba)(SAMBA)
 
+label(NAME)
 manpagename(smbd)(server to provide SMB/CIFS services to clients)
 
+label(SYNOPSIS)
 manpagesynopsis()
 
-bf(smbd) [-D] [-a] [-o] [-d debuglevel] [-l log file] [-p port number]
-[-O socket options] [-s configuration file] [-i scope] [-P] [-h]
+bf(smbd) [link(-D)(minusD)] [link(-a)(minusa)] [link(-o)(minuso)] [link(-d debuglevel)(minusd)] [link(-l log file)(minusl)] [link(-p port number)(minusp)] [link(-O socket options)(minusO)] [link(-s configuration file)(minuss)] [link(-i scope)(minusi)] [link(-P)(minusP)] [link(-h)(minush)]
 
+label(DESCRIPTION)
 manpagedescription()
 
 This program is part of the bf(Samba) suite.
 
-bf(smbd) is the server daemon that provides filesharing services to
+bf(smbd) is the server daemon that provides filesharing and printing
+services to
 Windows clients. The server provides filespace and printer services to
 clients using the SMB (or CIFS) protocol. This is compatible with the
 LanManager protocol, and can service LanManager clients.  These
@@ -22,18 +25,20 @@ 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 bf(smb.conf (5))).  This man page
+attributes of those services (see 
+url(bf(smb.conf (5)))(smb.conf.5.html).  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 the bf(smb.conf (5)) manpage should be
+running this server, and the 
+url(bf(smb.conf (5)))(smb.conf.5.html) manpage should be
 regarded as mandatory reading before proceeding with installation.
 
 A session is created whenever a client requests one. Each client gets
 a copy 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
+connections from its client are closed, the copy of the server for
 that client terminates.
 
 The configuration file, and any files that it includes, are
@@ -43,10 +48,12 @@ 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.
 
+label(OPTIONS)
 manpageoptions()
 
 startdit()
 
+label(minusD)
 dit(bf(-D)) If specified, this parameter causes the server to operate as a
 daemon. That is, it detaches itself and runs in the background,
 fielding requests on the appropriate port. Operating the server as a
@@ -55,13 +62,16 @@ more than casual use file and print services.
 
 By default, the server will NOT operate as a daemon. 
 
+label(minusa)
 dit(bf(-a)) If this parameter is specified, each new connection will
 append log messages to the log file.  This is the default.
 
+label(minuso)
 dit(bf(-o)) If this parameter is specified, the log files will be
 overwritten when opened.  By default, the log files will be appended
 to.
 
+label(minusd)
 dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10.
 
 The default value if this parameter is not specified is zero.
@@ -77,15 +87,25 @@ should only be used when investigating a problem. Levels above 3 are
 designed for use only by developers and generate HUGE amounts of log
 data, most of which is extremely cryptic.
 
-dit(bf(-l log file)) If specified, em(logfile) specifies a log filename
-into which informational and debug messages from the running server
-will be logged. The log file generated is never removed by the server
-although its size may be controlled by an bf(smb.conf (5)) option.
-The default log file name is specified at compile time.
-
-dit(bf(-O socket options)) See the socket options section of bf(smb.conf
-(5)) for details.
-
+Note that specifying this parameter here will override the url(bf(log
+level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf
+(5)))(smb.conf.5.html) file.
+
+label(minusl) 
+dit(bf(-l log file)) If specified, em(log file) specifies
+a log filename into which informational and debug messages from the
+running server will be logged. The log file generated is never removed
+by the server although its size may be controlled by the url(bf(max
+log size))(smb.conf.5.html#maxlogsize) option in the url(bf(smb.conf
+(5)))(smb.conf.5.html) file.  The default log file name is specified
+at compile time.
+
+label(minusO)
+dit(bf(-O socket options)) See the url(bf(socket
+options))(smb.conf.5.html#socketoptions) parameter in the
+url(bf(smb.conf (5)))(smb.conf.5.html) file for details.
+
+label(minusp)
 dit(bf(-p port number)) port number is a positive integer value.  The
 default value if this parameter is not specified is 139.
 
@@ -105,15 +125,16 @@ rfc1002.txt section 4.3.5.
 This parameter is not normally specified except in the above
 situation.
 
-dit(bf(-s configuration file)) The default configuration file name is
-determined at compile time.
-
+label(minuss)
+dit(bf(-s configuration file))
 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 bf(smb.conf
 (5)) for more information.
+The default configuration file name is determined at compile time.
 
+label(minusi)
 dit(bf(-i scope)) This specifies a NetBIOS scope that the server will use
 to communicate with when generating NetBIOS names. For details on the
 use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes
@@ -121,35 +142,38 @@ are em(very) rarely used, only set this parameter if you are the
 system administrator in charge of all the NetBIOS systems you
 communicate with.
 
+label(minush)
 dit(bf(-h)) Prints the help information (usage) for smbd.
 
+label(minusP)
 dit(bf(-P)) Passive option. Causes smbd not to send any network traffic
 out. Used for debugging by the developers only.
 
 endit()
 
+label(FILES)
 manpagefiles()
 
 bf(/etc/inetd.conf)
 
 If the server is to be run by the inetd meta-daemon, this file must
 contain suitable startup information for the meta-daemon. See the
-section em(INSTALLATION) below.
+section link(INSTALLATION)(INSTALLATION) below.
 
 bf(/etc/rc)
 
-(or whatever initialisation script your system uses).
+(or whatever initialization script your 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 em(INSTALLATION) below.
+section link(INSTALLATION)(INSTALLATION) below.
 
 bf(/etc/services)
 
 If running the server via the meta-daemon inetd, this file must
-contain a mapping of service name (eg., netbios-ssn) to service port
-(eg., 139) and protocol type (eg., tcp). See the section
-em(INSTALLATION) below.
+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
+link(INSTALLATION)(INSTALLATION) below.
 
 bf(/usr/local/samba/lib/smb.conf)
 
@@ -158,8 +182,9 @@ file. Other common places that systems install this file are
 em(/usr/samba/lib/smb.conf) and em(/etc/smb.conf).
 
 This file describes all the services the server is to make available
-to clients. See bf(smb.conf (5)) for more information.
+to clients. See url(bf(smb.conf (5)))(smb.conf.5.html) for more information.
 
+label(LIMITATIONS)
 manpagesection(LIMITATIONS)
 
 On some systems bf(smbd) cannot change uid back to root after a
@@ -168,6 +193,7 @@ 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.
 
+label(ENVIRONMENTVARIABLES)
 manpagesection(ENVIRONMENT VARIABLES)
 
 bf(PRINTER)
@@ -177,7 +203,7 @@ 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.
 
-
+label(INSTALLATION)
 manpagesection(INSTALLATION)
 
  The location of the server and its support files is a matter for
@@ -200,11 +226,11 @@ exists in Linux, as testing on other systems has thus far shown them
 to be immune.
 
 The server log files should be put in a directory readable and
-writable only by root, as the log files may contain sensitive
+writeable only by root, as the log files may contain sensitive
 information.
 
 The configuration file should be placed in a directory readable and
-writable only by root, as the configuration file controls security for
+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
@@ -231,14 +257,16 @@ utilities such as the tcpd TCP-wrapper may be used for extra security.
 For serious use as file server it is recommended that bf(smbd) be run
 as a daemon.
 
-When you've decided, continue with either em(RUNNING THE SERVER AS A
-DAEMON) or em(RUNNING THE SERVER ON REQUEST).
+When you've decided, continue with either 
+link(RUNNING THE SERVER AS A DAEMON)(RUNNINGTHESERVERASADAEMON) or 
+link(RUNNING THE SERVER ON REQUEST)(RUNNINGTHESERVERONREQUEST).
 
+label(RUNNINGTHESERVERASADAEMON)
 manpagesection(RUNNING THE SERVER AS A DAEMON)
 
 To run the server as a daemon from the command line, simply put the
-bf(-D) option on the command line. There is no need to place an
-ampersand at the end of the command line - the bf(-D) option causes
+link(bf(-D))(minusD) option on the command line. There is no need to place an
+ampersand at the end of the command line - the link(bf(-D))(minusD) option causes
 the server to detach itself from the tty anyway.
 
 Any user can run the server as a daemon (execute permissions
@@ -256,48 +284,49 @@ configuration file location and debug level as desired:
 
 tt(/usr/local/samba/bin/smbd -D -l /var/adm/smblogs/log -s /usr/local/samba/lib/smb.conf)
 
-(The above should appear in your initialisation script as a single line. 
+(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.)
 
 If the options used at compile time are appropriate for your system,
-all parameters except the desired debug level and bf(-D) may be
-omitted. See the section em(OPTIONS) above.
+all parameters except link(bf(-D))(minusD) may be
+omitted. See the section link(OPTIONS)(OPTIONS) above.
 
+label(RUNNINGTHESERVERONREQUEST)
 manpagesection(RUNNING THE SERVER ON REQUEST)
 
- If your system uses a meta-daemon such as inetd, you can arrange to
+ If your system uses a meta-daemon such as bf(inetd), you can arrange to
 have the smbd 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.
 
-You will probably want to set up the NetBIOS name server bf(nmbd) at
+You will probably want to set up the NetBIOS name server url(bf(nmbd))(nmbd.8.html) at
 the same time as bf(smbd). To do this refer to the man page for
-bf(nmbd (8)).
+url(bf(nmbd (8)))(nmbd.8.html).
 
-First, ensure that a port is configured in the file /etc/services. The
+First, ensure that a port is configured in the file tt(/etc/services). The
 well-known port 139 should be used if possible, though any port may be
 used.
 
-Ensure that a line similar to the following is in /etc/services:
+Ensure that a line similar to the following is in tt(/etc/services):
 
 tt(netbios-ssn 139/tcp)
 
 Note for NIS/YP users - you may need to rebuild the NIS service maps
-rather than alter your local /etc/services file.
+rather than alter your local tt(/etc/services file).
 
-Next, put a suitable line in the file /etc/inetd.conf (in the unlikely
+Next, put a suitable line in the file tt(/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
+name in tt(/etc/services).  Substitute appropriate values for your system
 in this line (see bf(inetd (8))):
 
 tt(netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd -d1 -l/var/adm/smblogs/log -s/usr/local/samba/lib/smb.conf)
 
-(The above should appear in /etc/inetd.conf as a single
+(The above should appear in tt(/etc/inetd.conf) 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
@@ -309,18 +338,23 @@ are using a non-standard port number.
 Lastly, edit the configuration file to provide suitable services. To
 start with, the following two services should be all you need:
 
-tt([homes])
-  writable = yes
+verb(
 
-tt([printers])
- writable = no
+[homes]
+  writeable = yes
+
+[printers]
+ writeable = no
  printable = yes
  path = /tmp
  public = yes
 
+)
+
 This will allow you to connect to your home directory and print to any
 printer supported by the host (user privileges permitting).
 
+label(TESTINGTHEINSTALLATION)
 manpagesection(TESTING THE INSTALLATION)
 
 If running the server as a daemon, execute it before proceeding. If
@@ -332,28 +366,17 @@ If your machine's name is "fred" and your name is "mary", you should
 now be able to connect to the service tt(\\fred\mary).
 
 To properly test and experiment with the server, we recommend using
-the smbclient program (see bf(smbclient (1))) and also going through
+the smbclient program (see 
+url(bf(smbclient (1)))(smbclient.1.html)) and also going through
 the steps outlined in the file em(DIAGNOSIS.txt) in the em(docs/)
 directory of your Samba installation.
 
+label(VERSION)
 manpagesection(VERSION)
 
-This man page is (mostly) correct for version 2.0 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.
-
-manpageseealso()
-
-bf(hosts_access (5)), bf(inetd (8)), bf(nmbd (8)), bf(smb.conf (5)),
-bf(smbclient (1)), bf(testparm (1)), bf(testprns (1)), and the
-Internet RFC's bf(rfc1001.txt), bf(rfc1002.txt). In addition the
-CIFS (formerly SMB) specification is available as a link from the
-Web page :
-url(http://samba.anu.edu.au/cifs/)(http://samba.anu.edu.au/cifs/).
+This man page is correct for version 2.0 of the Samba suite.
 
+label(DIAGNOSTICS)
 manpagesection(DIAGNOSTICS)
 
 Most diagnostics issued by the server are logged in a specified log
@@ -364,12 +387,13 @@ The number and nature of diagnostics available depends on the debug
 level used by the server. If you have problems, set the debug level to
 3 and peruse the log files.
 
-Most messages are reasonably self-explanatory. Unfortunately, at time
-of creation of this man page there are too many diagnostics available
+Most messages are reasonably self-explanatory. Unfortunately, at the time
+this man page was created, there are too many diagnostics available
 in the source code 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.
 
+label(SIGNALS)
 manpagesection(SIGNALS)
 
 Sending the smbd a SIGHUP will cause it to re-load its smb.conf
@@ -377,11 +401,11 @@ configuration file within a short period of time.
 
 To shut down a users smbd process it is recommended that SIGKILL (-9)
 em(NOT) be used, except as a last resort, as this may leave the shared
-memory area in an inconsistant state. The safe way to terminate an
+memory area in an inconsistent state. The safe way to terminate an
 smbd is to send it a SIGTERM (-15) signal and wait for it to die on
 its own.
 
-In version 1.9.18 and above the debug log level of smbd may be raised
+The debug log level of smbd may be raised
 by sending it a SIGUSR1 tt((kill -USR1 <smbd-pid>)) and lowered by
 sending it a SIGUSR2 tt((kill -USR2 <smbd-pid>)). This is to allow
 transient problems to be diagnosed, whilst still running at a normally
@@ -394,12 +418,31 @@ make the signal handlers safe by un-blocking the signals before the
 select call and re-blocking them after, however this would affect
 performance.
 
+label(SEEALSO)
+manpageseealso()
+
+bf(hosts_access (5)), bf(inetd (8)), url(bf(nmbd (8)))(nmbd.8.html),
+url(bf(smb.conf (5)))(smb.conf.5.html), url(bf(smbclient
+(1)))(smbclient.1.html), url(bf(testparm (1)))(testparm.1.html),
+url(bf(testprns (1)))(testprns.1.html), and the Internet RFC's
+bf(rfc1001.txt), bf(rfc1002.txt). In addition the CIFS (formerly SMB)
+specification is available as a link from the Web page :
+url(http://samba.org/cifs/)(http://samba.org/cifs/).
+
+label(AUTHOR)
 manpageauthor()
 
 The original Samba software and related utilities were created by
-Andrew Tridgell (samba-bugs@samba.anu.edu.au). Samba is now developed
+Andrew Tridgell email(samba-bugs@samba.org). Samba is now developed
 by the Samba Team as an Open Source project similar to the way the
 Linux kernel is developed.
 
-See bf(samba (8)) to find out how to get a full list of contributors
+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
+url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
+and updated for the Samba2.0 release by Jeremy Allison.
+email(samba-bugs@samba.org).
+
+See url(bf(samba (7)))(samba.7.html) to find out how to get a full list of contributors
 and details on how to submit bug reports, comments etc.