From 2f10ca1f2859c4d276849ee5c78fee059a7114a9 Mon Sep 17 00:00:00 2001 From: Gerald Carter Date: Thu, 24 Jan 2002 17:02:51 +0000 Subject: [PATCH] fixed broken links, fixed, typo, and bad SGML syntax --- docs/docbook/manpages/nmbd.8.sgml | 100 +++++++------ docs/docbook/manpages/smbd.8.sgml | 300 +++++++------------------------------ docs/docbook/manpages/smbsh.1.sgml | 2 +- 3 files changed, 104 insertions(+), 298 deletions(-) diff --git a/docs/docbook/manpages/nmbd.8.sgml b/docs/docbook/manpages/nmbd.8.sgml index a1de5860c47..92149d503a2 100644 --- a/docs/docbook/manpages/nmbd.8.sgml +++ b/docs/docbook/manpages/nmbd.8.sgml @@ -198,25 +198,25 @@ smb.conf. - + -p <UDP port number> UDP port number is a positive integer value. - This option changes the default UDP port number (normally 137) - that nmbd responds to name queries on. Don't - use this option unless you are an expert, in which case you + This option changes the default UDP port number (normally 137) + that nmbd responds to name queries on. Don't + use this option unless you are an expert, in which case you won't need help! - + -s <configuration file> - The default configuration file name + The default configuration file name is set at build time, typically as /usr/local/samba/lib/smb.conf, but this may be changed when Samba is autoconfigured. - The file specified contains the configuration details - required by the server. See + The file specified contains the configuration details + required by the server. See smb.conf(5) for more information. @@ -229,54 +229,58 @@ /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 INSTALLATION below. + 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 UNIX_INSTALL.html document + for details. - + /etc/rc - or whatever initialization script your + 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 INSTALLATION - below. + If running the server as a daemon at startup, + this file will need to contain an appropriate startup + sequence for the server. See the UNIX_INSTALL.html document + for details. - + /etc/services - If running the server via the - meta-daemon inetd, 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. + If running the server via the + meta-daemon inetd, 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 UNIX_INSTALL.html + document for details. - + /usr/local/samba/lib/smb.conf - This is the default location of the + This is the default location of the smb.conf - server configuration file. Other common places that systems - install this file are /usr/samba/lib/smb.conf + server configuration file. Other common places that systems + install this file are /usr/samba/lib/smb.conf and /etc/smb.conf. - - When run as a WINS server (see the - wins support - parameter in the - smb.conf(5) man page), nmbd - will store the WINS database in the file wins.dat - in the var/locks directory configured under + + When run as a WINS server (see the + wins support + parameter in the smb.conf(5) man page), + nmbd + will store the WINS database in the file wins.dat + in the var/locks directory configured under wherever Samba was configured to install itself. If nmbd is acting as a - browse master (see the local master - parameter in the - smb.conf(5) man page), nmbd + browse master (see the local master + parameter in the smb.conf(5) man page, + nmbd will store the browsing database in the file browse.dat in the var/locks directory configured under wherever Samba was configured to install itself. @@ -288,20 +292,20 @@ SIGNALS - To shut down an nmbd process it is recommended - that SIGKILL (-9) NOT be used, except as a last - resort, as this may leave the name database in an inconsistent state. - The correct way to terminate nmbd is to send it + To shut down an nmbd process it is recommended + that SIGKILL (-9) NOT be used, except as a last + resort, as this may leave the name database in an inconsistent state. + The correct way to terminate nmbd is to send it a SIGTERM (-15) signal and wait for it to die on its own. - nmbd will accept SIGHUP, which will cause + nmbd will accept SIGHUP, which will cause it to dump out its namelists into the file namelist.debug - in the /usr/local/samba/var/locks - directory (or the var/locks directory configured - under wherever Samba was configured to install itself). This will also + in the /usr/local/samba/var/locks + directory (or the var/locks directory configured + under wherever Samba was configured to install itself). This will also cause nmbd to dump out its server database in the log.nmb file. - + The debug log level of nmbd may be raised or lowered using smbcontrol(1) (SIGUSR[1|2] signals are no longer used in Samba 2.2). This is diff --git a/docs/docbook/manpages/smbd.8.sgml b/docs/docbook/manpages/smbd.8.sgml index 2037e963d5e..f82e3c65950 100644 --- a/docs/docbook/manpages/smbd.8.sgml +++ b/docs/docbook/manpages/smbd.8.sgml @@ -54,7 +54,7 @@ Please note that there are significant security implications to running this server, and the smb.conf(5) - manpage should be regarded as mandatory reading before + manpage should be regarded as mandatory reading before proceeding with installation. A session is created whenever a client requests one. @@ -142,7 +142,7 @@ logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for - day to day running - it generates a small amount of + day to day running - it generates a small amount of information about operations carried out. Levels above 1 will generate considerable @@ -186,14 +186,14 @@ -p <port number> - port number is a positive integer + port number is a positive integer value. The default value if this parameter is not specified is 139. This number is the port number that will be used when making connections to the server from client software. The standard (well-known) port number for the - SMB over TCP is 139, hence the default. If you wish to + SMB over TCP is 139, hence the default. If you wish to run the server as an ordinary user rather than as root, most systems will require you to use a port number greater than 1024 - ask your system administrator @@ -218,7 +218,7 @@ as descriptions of all the services that the server is to provide. See smb.conf(5) for more information. - The default configuration file name is determined at + The default configuration file name is determined at compile time. @@ -230,42 +230,44 @@ /etc/inetd.conf - If the server is to be run by the + 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 INSTALLATION below. + meta-daemon. See the UNIX_INSTALL.html + document for details. - + /etc/rc - or whatever initialization script your + 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 INSTALLATION - below. + If running the server as a daemon at startup, + this file will need to contain an appropriate startup + sequence for the server. See the UNIX_INSTALL.html + document for details. - + /etc/services - If running the server via the - meta-daemon inetd, 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. + If running the server via the + meta-daemon inetd, 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 UNIX_INSTALL.html + document for details. - + /usr/local/samba/lib/smb.conf - This is the default location of the + This is the default location of the smb.conf - server configuration file. Other common places that systems - install this file are /usr/samba/lib/smb.conf + server configuration file. Other common places that systems + install this file are /usr/samba/lib/smb.conf and /etc/smb.conf. - - This file describes all the services the server + + This file describes all the services the server is to make available to clients. See smb.conf(5) for more information. @@ -275,10 +277,10 @@ LIMITATIONS - On some systems 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 + On some systems 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. @@ -299,191 +301,13 @@ - - 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/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 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 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. - - The server log files should be put in a directory readable and - writeable only by root, as the log files may contain sensitive - information. - - 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 smb.conf.sample - is supplied with the source to the server - this may - be renamed to smb.conf and modified to suit - your needs. - - The remaining notes will assume the following: - - - smbd (the server program) - installed in /usr/local/samba/bin - - - smb.conf (the configuration - file) installed in /usr/local/samba/lib - - - log files stored in /var/adm/smblogs - - - - 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 - inetd 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 smbd be run as a daemon. - - When you've decided, continue with either - - - RUNNING THE SERVER AS A DAEMON or - RUNNING THE SERVER ON REQUEST. - - - - - RUNNING THE SERVER AS A DAEMON - - To run the server as a daemon from the command - line, simply put the -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 tty - anyway. - - 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. - - 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 - /etc/rc), insert the following line, - substituting port number, log file location, configuration file - location and debug level as desired: - - /usr/local/samba/bin/smbd -D -l /var/adm/smblogs/log - -s /usr/local/samba/lib/smb.conf - - (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 -D may - be omitted. See the section OPTIONS above. - - - - RUNNING THE SERVER ON REQUEST - - If your system uses a meta-daemon such as 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 - nmbd at - the same time as smbd. To do this refer to the - man page for 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. - - Ensure that a line similar to the following is in - /etc/services: - - 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. - - 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 inetd(8)): - - 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 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.) - - Note that there is no need to specify a port number here, - even if you 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: - - - - [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). - PAM INTERACTION - Samba uses PAM for authentication (when presented with a plaintext + Samba uses PAM for authentication (when presented with a plaintext password), for account checking (is this account disabled?) and for session management. The degree too which samba supports PAM is restricted - by the limitations of the SMB protocol and the + by the limitations of the SMB protocol and the obey pam restricions smb.conf paramater. When this is set, the following restrictions apply: @@ -496,7 +320,7 @@ Session Management: When not using share - level secuirty, users must pass PAM's session checks before access + 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. @@ -505,71 +329,49 @@ - TESTING THE INSTALLATION - - 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 - 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. - - - To properly test and experiment with the server, we - recommend using the smbclient program (see - smbclient(1)) - and also going through the steps outlined in the file - DIAGNOSIS.txt in the docs/ - directory of your Samba installation. - - - VERSION - This man page is correct for version 2.2 of + This man page is correct for version 2.2 of the Samba suite. DIAGNOSTICS - Most diagnostics issued by the server are logged - in a specified log file. The log file name is specified + Most diagnostics issued by the server are logged + in a specified log file. The log file name is specified at compile time, but may be overridden on the command line. - The number and nature of diagnostics available depends - on the debug level used by the server. If you have problems, set + 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 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 + 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. SIGNALS - Sending the smbd a SIGHUP will cause it to - reload its smb.conf configuration + Sending the smbd a SIGHUP will cause it to + reload its smb.conf configuration file within a short period of time. - To shut down a user's smbd process it is recommended - that SIGKILL (-9) NOT + To shut down a user's smbd process it is recommended + that SIGKILL (-9) NOT be used, except as a last resort, as this may leave the shared - memory area in an inconsistent state. The safe way to terminate - an smbd is to send it a SIGTERM (-15) signal and wait for + 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. The debug log level of smbd may be raised or lowered using smbcontrol(1) program (SIGUSR[1|2] signals are no longer used in - Samba 2.2). This is to allow transient problems to be diagnosed, + Samba 2.2). This is to allow transient problems to be diagnosed, whilst still running at a normally low log level. Note that as the signal handlers send a debug write, diff --git a/docs/docbook/manpages/smbsh.1.sgml b/docs/docbook/manpages/smbsh.1.sgml index 2641c0f6f5d..82efb334ba7 100644 --- a/docs/docbook/manpages/smbsh.1.sgml +++ b/docs/docbook/manpages/smbsh.1.sgml @@ -150,7 +150,7 @@ -L libdir This parameter specifies the location of the - shared libraries used by smbsh. The default + shared libraries used by smbsh. The default value is specified at compile time. -- 2.11.4.GIT