diff options
author | Herb Lewis <herb@samba.org> | 1998-11-14 00:14:47 +0000 |
---|---|---|
committer | Herb Lewis <herb@samba.org> | 1998-11-14 00:14:47 +0000 |
commit | eaf9944b3eeb6fdacc655052396e0b238b75dbcb (patch) | |
tree | 96e1176d6c6e49d4711481cde0e6c0b266cefb9f /docs/yodldocs | |
parent | ddc6296370310298f428e38468b2d94288bc078f (diff) | |
download | samba-eaf9944b3eeb6fdacc655052396e0b238b75dbcb.tar.gz samba-eaf9944b3eeb6fdacc655052396e0b238b75dbcb.tar.bz2 samba-eaf9944b3eeb6fdacc655052396e0b238b75dbcb.zip |
ran spell check and other minor tweaks
(This used to be commit 7d8ec97b451721cddbb859415490d65c41e8afe2)
Diffstat (limited to 'docs/yodldocs')
-rw-r--r-- | docs/yodldocs/lmhosts.5.yo | 6 | ||||
-rw-r--r-- | docs/yodldocs/make_smbcodepage.1.yo | 16 | ||||
-rw-r--r-- | docs/yodldocs/nmbd.8.yo | 56 | ||||
-rw-r--r-- | docs/yodldocs/nmblookup.1.yo | 9 | ||||
-rw-r--r-- | docs/yodldocs/samba.7.yo | 13 | ||||
-rw-r--r-- | docs/yodldocs/smb.conf.5.yo | 264 | ||||
-rw-r--r-- | docs/yodldocs/smbclient.1.yo | 38 | ||||
-rw-r--r-- | docs/yodldocs/smbd.8.yo | 64 | ||||
-rw-r--r-- | docs/yodldocs/smbpasswd.5.yo | 28 | ||||
-rw-r--r-- | docs/yodldocs/smbpasswd.8.yo | 31 | ||||
-rw-r--r-- | docs/yodldocs/smbrun.1.yo | 2 | ||||
-rw-r--r-- | docs/yodldocs/smbstatus.1.yo | 2 | ||||
-rw-r--r-- | docs/yodldocs/smbtar.1.yo | 2 | ||||
-rw-r--r-- | docs/yodldocs/swat.8.yo | 12 | ||||
-rw-r--r-- | docs/yodldocs/testparm.1.yo | 6 | ||||
-rw-r--r-- | docs/yodldocs/testprns.1.yo | 4 |
16 files changed, 282 insertions, 271 deletions
diff --git a/docs/yodldocs/lmhosts.5.yo b/docs/yodldocs/lmhosts.5.yo index fc3d6b4afd..640b81f5cf 100644 --- a/docs/yodldocs/lmhosts.5.yo +++ b/docs/yodldocs/lmhosts.5.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(lmhosts)(5)(23 Oct 1998)(Samba)(SAMBA) +manpage(lmhosts htmlcommand((5)))(5)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(lmhosts)(The Samba NetBIOS hosts file) @@ -15,7 +15,7 @@ manpagedescription() This file is part of the bf(Samba) suite. -lmhosts is the bf(Samba) NetBIOS name to IP address mapping file. It +bf(lmhosts) is the bf(Samba) NetBIOS name to IP address mapping file. It is very similar to the bf(/etc/hosts) file format, except that the hostname component must correspond to the NetBIOS naming format. @@ -81,7 +81,7 @@ 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.anu.edu.au). Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. diff --git a/docs/yodldocs/make_smbcodepage.1.yo b/docs/yodldocs/make_smbcodepage.1.yo index 269d43c016..73483689d2 100644 --- a/docs/yodldocs/make_smbcodepage.1.yo +++ b/docs/yodldocs/make_smbcodepage.1.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(make_smbcodepage)(1)(23 Oct 1998)(Samba)(SAMBA) +manpage(make_smbcodepage htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(make_codepage)(Construct a codepage file for Samba) @@ -24,17 +24,17 @@ manpageoptions() startdit() label(cord) -dit(c|d) This tells make_smbcodepage if it is compiling (c) a text -format code page file to binary, or (d) de-compiling a binary codepage +dit(c|d) This tells bf(make_smbcodepage) if it is compiling (bf(c)) a text +format code page file to binary, or (bf(d)) de-compiling a binary codepage file to text. label(codepage) -dit(codepage) This is the codepage we are processing (a number, eg. 850). +dit(codepage) This is the codepage we are processing (a number, e.g. 850). label(inputfile) -dit(inputfile) This is the input file to process. In the 'c' case this +dit(inputfile) This is the input file to process. In the 'bf(c)' case this will be a text codepage definition file such as the ones found in the -Samba em(source/codepages) directory. In the 'd' case this will be the +Samba em(source/codepages) directory. In the 'bf(d)' case this will be the binary format codepage definition file normally found in the em(lib/codepages) directory in the Samba install directory path. @@ -51,8 +51,8 @@ Samba how to map from upper to lower case for characters greater than ascii 127 in the specified DOS code page. Note that for certain DOS codepages (437 for example) mapping from lower to upper case may be non-symmetrical. For example, in code page 437 lower case a acute maps to -a plain upper case A when going from lower to upper case, but maps -from plain upper case A to plain lower case a when lower casing a +a plain upper case A when going from lower to upper case, but +plain upper case A maps to plain lower case a when lower casing a character. A binary Samba codepage definition file is a binary representation of diff --git a/docs/yodldocs/nmbd.8.yo b/docs/yodldocs/nmbd.8.yo index f24aa1ff4f..c0949d2677 100644 --- a/docs/yodldocs/nmbd.8.yo +++ b/docs/yodldocs/nmbd.8.yo @@ -26,21 +26,21 @@ SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS server. That is, they wish to know what IP number a specified host is using. -Amongst other services, this program will listen for such requests, +Amongst other services, bf(nmbd) will listen for such requests, and if its own NetBIOS name is specified it will respond with the IP number of the host it is running on. Its "own NetBIOS name" is by default the primary DNS name of the host it is running on, but this -can be overriden with the bf(-n) option (see em(OPTIONS) below). Thus -nmbd will reply to broadcast queries for its own name(s). Additional -names for nmbd to respond on can be set via parameters in the -bf(smb.conf (5)) configuration file. +can be overridden with the bf(-n) option (see link(OPTIONS)(OPTIONS) below). Thus +bf(nmbd) will reply to broadcast queries for its own name(s). Additional +names for bf(nmbd) to respond on can be set via parameters in the +url(bf(smb.conf(5)))(smb.conf.5.html) configuration file. -nmbd can also be used as a WINS (Windows Internet Name Server) +bf(nmbd) can also be used as a WINS (Windows Internet Name Server) server. What this basically means is that it will act as a WINS database server, creating a database from name registration requests that it receives and replying to queries from clients for these names. -In addition, nmbd can act as a WINS proxy, relaying broadcast queries +In addition, bf(nmbd) can act as a WINS proxy, relaying broadcast queries from clients that do not understand how to talk the WINS protocol to a WIN server. @@ -50,9 +50,9 @@ manpageoptions() startdit() label(minusD) -dit(bf(-D)) If specified, this parameter causes the server to operate +dit(bf(-D)) If specified, this parameter causes bf(nmbd) to operate as a daemon. That is, it detaches itself and runs in the background, -fielding requests on the appropriate port. By default, the server will +fielding requests on the appropriate port. By default, bf(nmbd) will NOT operate as a daemon. nmbd can also be operated from the inetd meta-daemon, although this is not recommended. @@ -70,16 +70,17 @@ dit(bf(-H filename)) NetBIOS lmhosts file. The lmhosts file is a list of NetBIOS names to IP addresses that is loaded by the nmbd server and used via the name resolution mechanism -em(name resolve order) described in bf(smbd.conf (5)) to resolve any +url(bf(name resolve order))(smb.conf.5.html#nameresolveorder) described in +url(bf(smb.conf (5)))(smb.conf.5.html) to resolve any NetBIOS name queries needed by the server. Note that the contents of -this file are em(NOT) used by nmbd to answer any name queries, adding +this file are em(NOT) used by bf(nmbd) to answer any name queries. Adding a line to this file affects name NetBIOS resolution from this host em(ONLY). The default path to this file is compiled into Samba as part of the build process. Common defaults are em(/usr/local/samba/lib/lmhosts), -em(/usr/samba/lib/lmhosts) or em(/etc/lmhosts). See the bf(lmhosts -(5)) man page for details on the contents of this file. +em(/usr/samba/lib/lmhosts) or em(/etc/lmhosts). See the +url(bf(lmhosts (5)))(lmhosts.5.html) man page for details on the contents of this file. label(minusd) dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10. @@ -109,7 +110,7 @@ extension ".nmb" to the specified base name. For example, if the name specified was "log" then the file log.nmb would contain the debugging data. -The default log file path is is compiled into Samba as part of the +The default log file path is compiled into Samba as part of the build process. Common defaults are em(/usr/local/samba/var/log.nmb), em(/usr/samba/var/log.nmb) or em(/var/log/log.nmb). @@ -124,7 +125,7 @@ label(minusp) dit(bf(-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 +bf(nmbd) responds to name queries on. Don't use this option unless you are an expert, in which case you won't need help! label(minuss) @@ -136,7 +137,7 @@ The file specified contains the configuration details required by the server. See url(bf(smb.conf (5)))(smb.conf.5.html) for more information. label(minusi) -dit(bf(-i scope)) This specifies a NetBIOS scope that the server will use +dit(bf(-i scope)) This specifies a NetBIOS scope that bf(nmbd) 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 are em(very) rarely used, only set this parameter if you are the @@ -144,7 +145,7 @@ system administrator in charge of all the NetBIOS systems you communicate with. label(minush) -dit(bf(-h)) Prints the help information (usage) for nmbd. +dit(bf(-h)) Prints the help information (usage) for bf(nmbd). endit() @@ -158,14 +159,15 @@ contain suitable startup information for the meta-daemon. 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. bf(/usr/local/samba/lib/smb.conf) -This is the default location of the em(smb.conf) server configuration +This is the default location of the +url(bf(smb.conf))(smb.conf.5.html) server configuration file. Other common places that systems install this file are em(/usr/samba/lib/smb.conf) and em(/etc/smb.conf). @@ -182,18 +184,18 @@ configured under wherever Samba was configured to install itself. label(SIGNALS) manpagesection(SIGNALS) -To shut down an nmbd process it is recommended that SIGKILL (-9) +To shut down an bf(nmbd) process it is recommended that SIGKILL (-9) em(NOT) be used, except as a last resort, as this may leave the name -database in an inconsistant state. The correct way to terminate -nmbd is to send it a SIGTERM (-15) signal and wait for it to die on +database in an inconsistent state. The correct way to terminate +bf(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 it to dump out it's -namelists into the file namelist.debug in the +bf(nmbd) will accept SIGHUP, which will cause it to dump out it's +namelists into the file tt(namelist.debug) in the em(/usr/local/samba/var/locks) directory (or the em(var/locks) directory configured under wherever Samba was configured to install -itself). This will also cause nmbd to dump out it's server database in -the log.nmb file. In addition, the the debug log level of nmbd may be raised +itself). This will also cause bf(nmbd) to dump out it's server database in +the log.nmb file. In addition, the debug log level of nmbd may be raised by sending it a SIGUSR1 (tt(kill -USR1 <nmbd-pid>)) and lowered by sending it a SIGUSR2 (tt(kill -USR2 <nmbd-pid>)). This is to allow transient problems to be diagnosed, whilst still running at a normally low log @@ -219,7 +221,7 @@ 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.anu.edu.au). Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. diff --git a/docs/yodldocs/nmblookup.1.yo b/docs/yodldocs/nmblookup.1.yo index 60ee3daf09..98de643fd0 100644 --- a/docs/yodldocs/nmblookup.1.yo +++ b/docs/yodldocs/nmblookup.1.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(nmblookup)(1)(23 Oct 1998)(Samba)(SAMBA) +manpage(nmblookup htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(nmblookup)(NetBIOS over TCP/IP client used to lookup NetBIOS names) @@ -17,7 +17,7 @@ This program is part of the bf(Samba) suite. bf(nmblookup) is used to query NetBIOS names and map them to IP addresses in a network using NetBIOS over TCP/IP queries. The options -allow the name queries to be directed at a particlar IP broadcast area +allow the name queries to be directed at a particular IP broadcast area or to a particular machine. All queries are done over UDP. label(OPTIONS) @@ -46,7 +46,7 @@ label(minusr) dit(bf(-r)) Try and bind to UDP port 137 to send and receive UDP datagrams. The reason for this option is a bug in Windows 95 where it ignores the source port of the requesting packet and only replies to -UDP port 137. Unfortunately, on most UNIX systems root privillage is +UDP port 137. Unfortunately, on most UNIX systems root privilage is needed to bind to this port, and in addition, if the url(bf(nmbd))(nmbd.8.html) daemon is running on this machine it also binds to this port. @@ -91,7 +91,8 @@ level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf label(minuss) dit(bf(-s smb.conf)) This parameter specifies the pathname to the -Samba configuration file, smb.conf. This file controls all aspects of +Samba configuration file, url(bf(smb.conf))(smb.conf.5.html). +This file controls all aspects of the Samba setup on the machine. label(minusi) diff --git a/docs/yodldocs/samba.7.yo b/docs/yodldocs/samba.7.yo index a57201b602..3951d13fa8 100644 --- a/docs/yodldocs/samba.7.yo +++ b/docs/yodldocs/samba.7.yo @@ -1,5 +1,5 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(Samba)(7)(23 Oct 1998)(Samba)() +manpage(Samba htmlcommand((7)))(7)(23 Oct 1998)(Samba)() label(NAME) manpagename(Samba)(A Windows SMB/CIFS fileserver for UNIX) @@ -13,7 +13,7 @@ label(DESCRIPTION) manpagedescription() The Samba software suite is a collection of programs that implements -the Server Message Block(commenly abbreviated as SMB) protocol for +the Server Message Block(commonly abbreviated as SMB) protocol for UNIX systems. This protocol is sometimes also referred to as the Common Internet File System (CIFS), LanManager or NetBIOS protocol. @@ -24,7 +24,8 @@ The Samba suite is made up of several components. Each component is described in a separate manual page. It is strongly recommended that you read the documentation that comes with Samba and the manual pages of those components that you use. If the manual pages aren't clear -enough then please send a patch to email(samba-bugs@samba.anu.edu.au). +enough then please send a patch or bug report +to email(samba-bugs@samba.anu.edu.au). startdit() @@ -79,7 +80,7 @@ manpagesection(AVAILABILITY) The Samba software suite is licensed under the GNU Public License (GPL). A copy of that license should have come with the package in the file COPYING. You are encouraged to distribute copies of the Samba -suite, but please keep obey the terms of this license. +suite, but please obey the terms of this license. The latest version of the Samba suite can be obtained via anonymous ftp from samba.anu.edu.au in the directory pub/samba/. It is @@ -111,7 +112,7 @@ for details on how to do this. If you have patches to submit or bugs to report then you may mail them directly to email(samba-bugs@samba.anu.edu.au). Note, however, that due to the enormous popularity of this package the Samba Team may take some -time to repond to mail. We prefer patches in em(diff -u) format. +time to respond to mail. We prefer patches in em(diff -u) format. label(CREDITS) manpagesection(CREDITS) @@ -125,7 +126,7 @@ for the contributors to Samba post-CVS. CVS is the Open Source source code control system used by the Samba Team to develop Samba. The project would have been unmanageable without it. -In addition, several commercial organisations now help fund the Samba +In addition, several commercial organizations now help fund the Samba Team with money and equipment. For details see the Samba Web pages at url(http://samba.anu.edu.au/samba/samba-thanks.html)(http://samba.anu.edu.au/samba/samba-thanks.html). diff --git a/docs/yodldocs/smb.conf.5.yo b/docs/yodldocs/smb.conf.5.yo index 6be09fce2f..ce8db45b65 100644 --- a/docs/yodldocs/smb.conf.5.yo +++ b/docs/yodldocs/smb.conf.5.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(smb.conf)(5)(23 Oct 1998)(Samba)(SAMBA) +manpage(smb.conf htmlcommand((5)))(5)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(smb.conf)(The configuration file for the Samba suite) @@ -79,7 +79,7 @@ them. The client provides the username. As older clients only provide passwords and not usernames, you may specify a list of usernames to check against the password using the link(bf("user="))(user) option in the share definition. For modern clients such as Windows 95/98 and -Windows NT, this should not be neccessary. +Windows NT, this should not be necessary. Note that the access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host @@ -94,7 +94,7 @@ verb( [foo] path = /home/bar - writable = true + writeable = true ) @@ -173,7 +173,7 @@ following is a typical and suitable [homes] section: verb( [homes] - writable = yes + writeable = yes ) An important point is that if guest access is specified in the [homes] @@ -223,14 +223,14 @@ endit() Note that the [printers] service MUST be printable - if you specify otherwise, the server will refuse to load the configuration file. -Typically the path specified would be that of a world-writable spool +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: verb( [printers] path = /usr/spool/public - writable = no + writeable = no guest ok = yes printable = yes ) @@ -245,7 +245,7 @@ verb( alias|alias|alias|alias... ) Each alias should be an acceptable printer name for your printing subsystem. In the link(bf([global]))(global) section, specify the new -file as your printcap. The server will then only recognise names +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. @@ -259,7 +259,7 @@ NOTE: On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use link(bf("printcap name = lpstat"))(printcapname) to automatically obtain a list of printers. See the link(bf("printcap name"))(printcapname) option for -more detils. +more details. enddit() @@ -269,8 +269,8 @@ manpagesection(PARAMETERS) Parameters define the specific attributes of sections. Some parameters are specific to the link(bf([global]))(global) section -(eg., link(bf(security))(security)). Some parameters are usable in -all sections (eg., link(bf(create mode))(createmode)). All others are +(e.g., link(bf(security))(security)). Some parameters are usable in +all sections (e.g., link(bf(create mode))(createmode)). All others are permissible only in normal sections. For the purposes of the following descriptions the link(bf([homes]))(homes) and link(bf([printers]))(printers) sections will be considered normal. @@ -279,7 +279,7 @@ specific to the link(bf([global]))(global) section. The letter tt('S') indicates that a parameter can be specified in a service specific section. Note that all tt('S') parameters can also be specified in the link(bf([global]))(global) section - in which case they will define -the default behaviour for all services. +the default behavior for all services. Parameters are arranged here in alphabetical order - this may not create best bedfellows, but at least you can find them! Where there @@ -358,8 +358,8 @@ it() bf(%d) = The process id of the current server process. label(percenta) it() bf(%a) = the architecture of the remote -machine. Only some are recognised, and those may not be 100% -reliable. It currently recognises Samba, WfWg, WinNT and +machine. Only some are recognized, and those may not be 100% +reliable. It currently recognizes Samba, WfWg, WinNT and Win95. Anything else will be known as "UNKNOWN". If it gets it wrong then sending a level 3 log to email(samba-bugs@samba.anu.edu.au) should allow it to be fixed. @@ -1065,7 +1065,7 @@ dit(bf(announce as (G))) This specifies what type of server url(bf(nmbd))(nmbd.8.html) will announce itself as, to a network neighborhood browse list. By default this is set to Windows NT. The valid options are : "NT", "Win95" or -"WfW" meaining Windows NT, Windows 95 and Windows for Workgroups +"WfW" meaning Windows NT, Windows 95 and Windows for Workgroups respectively. Do not change this parameter unless you have a specific need to stop Samba appearing as an NT server as this may prevent Samba servers from participating as browser servers correctly. @@ -1152,7 +1152,7 @@ the interface list given in the link(bf('interfaces'))(interfaces) parameter. This restricts the networks that url(bf(smbd))(smbd.8.html) will serve to packets coming in those interfaces. Note that you should not use this parameter for machines that are serving PPP or -other intermittant or non-broadcast network interfaces as it will not +other intermittent or non-broadcast network interfaces as it will not cope with non-permanent interfaces. In addition, to change a users SMB password, the @@ -1199,16 +1199,9 @@ tt( blocking locks = True) tt( blocking locks = False) label(browsable) -dit(bf(broweable (S))) +dit(bf(browseable (S))) -This controls whether this share is seen in the list of available -shares in a net view and in the browse list. - - bf(Default:) -tt( browsable = Yes) - - bf(Example:) -tt( browsable = No) +Synonym for link(bf(browseable))(browseable). label(browselist) dit(bf(browse list(G))) @@ -1223,7 +1216,14 @@ tt( browse list = Yes) label(browseable) dit(bf(browseable)) -Synonym for link(bf(browsable))(browsable). +This controls whether this share is seen in the list of available +shares in a net view and in the browse list. + + bf(Default:) +tt( browseable = Yes) + + bf(Example:) +tt( browseable = No) label(casesensitive) dit(bf(case sensitive (G))) @@ -1320,7 +1320,7 @@ described more fully in the manual page url(bf(make_smbcodepage to map lower to upper case characters to provide the case insensitivity of filenames that Windows clients expect. -Samba currenly ships with the following code page files : +Samba currently ships with the following code page files : startit() @@ -1401,11 +1401,11 @@ Shift-JIS to JUNET code with different shift-in, shift out codes. it() bf(EUC) Convert an incoming Shift-JIS character to EUC code. it() bf(HEX) Convert an incoming Shift-JIS character to a 3 byte hex -representation, ie. tt(:AB). +representation, i.e. tt(:AB). it() bf(CAP) Convert an incoming Shift-JIS character to the 3 byte hex -representation used by the Columbia Appletalk Program (CAP), -ie. tt(:AB). This is used for compatibility between Samba and CAP. +representation used by the Columbia AppleTalk Program (CAP), +i.e. tt(:AB). This is used for compatibility between Samba and CAP. endit() @@ -1467,7 +1467,7 @@ dit(bf(create mask (S))) A synonym for this parameter is link(bf('create mode'))(createmode). -When a file is created, the neccessary permissions are calculated +When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit-wise 'AND'ed with this parameter. This parameter may be thought of as a bit-wise MASK for the UNIX modes @@ -1626,7 +1626,7 @@ If this option is set to True, then Samba will attempt to recursively delete any files and directories within the vetoed directory. This can be useful for integration with file serving systems such as bf(NetAtalk), which create meta-files within directories you might normally veto -DOS/Windows users from seeing (eg. tt(.AppleDouble)) +DOS/Windows users from seeing (e.g. tt(.AppleDouble)) Setting tt('delete veto files = True') allows these directories to be transparently deleted when the parent directory is deleted (so long @@ -1677,7 +1677,7 @@ return value can give the block size in bytes. The default blocksize is 1024 bytes. Note: Your script should em(NOT) be setuid or setgid and should be -owned by (and writable only by) root! +owned by (and writeable only by) root! bf(Default:) tt( By default internal routines for determining the disk capacity @@ -1714,7 +1714,7 @@ dit(bf(directory mask (S))) This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories. -When a directory is created, the neccessary permissions are calculated +When a directory is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit-wise 'AND'ed with this parameter. This parameter may be thought of as a bit-wise MASK for the UNIX modes @@ -1727,7 +1727,7 @@ directory to modify it. Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the "force directory mode" -parameter. This parameter is set to 000 by default (ie. no extra mode +parameter. This parameter is set to 000 by default (i.e. no extra mode bits are added). See the link(bf("force directory mode"))(forcedirectorymode) parameter @@ -1774,7 +1774,7 @@ bf(domain admin group (G)) This is an bf(EXPERIMENTAL) parameter that is part of the unfinished Samba NT Domain Controller Code. It may be removed in a later release. To work with the latest code builds that may have more support for -Samba NT Domain Controller functionality please subscibe to the +Samba NT Domain Controller functionality please subscribe to the mailing list bf(Samba-ntdom) available by sending email to email(listproc@samba.anu.edu.au) @@ -1784,7 +1784,7 @@ dit(bf(domain admin users (G))) This is an bf(EXPERIMENTAL) parameter that is part of the unfinished Samba NT Domain Controller Code. It may be removed in a later release. To work with the latest code builds that may have more support for -Samba NT Domain Controller functionality please subscibe to the +Samba NT Domain Controller functionality please subscribe to the mailing list bf(Samba-ntdom) available by sending email to email(listproc@samba.anu.edu.au) @@ -1801,7 +1801,7 @@ dit(bf(domain groups (G))) This is an bf(EXPERIMENTAL) parameter that is part of the unfinished Samba NT Domain Controller Code. It may be removed in a later release. To work with the latest code builds that may have more support for -Samba NT Domain Controller functionality please subscibe to the +Samba NT Domain Controller functionality please subscribe to the mailing list bf(Samba-ntdom) available by sending email to email(listproc@samba.anu.edu.au) @@ -1811,7 +1811,7 @@ dit(bf(domain guest group (G))) This is an bf(EXPERIMENTAL) parameter that is part of the unfinished Samba NT Domain Controller Code. It may be removed in a later release. To work with the latest code builds that may have more support for -Samba NT Domain Controller functionality please subscibe to the +Samba NT Domain Controller functionality please subscribe to the mailing list bf(Samba-ntdom) available by sending email to email(listproc@samba.anu.edu.au) @@ -1821,7 +1821,7 @@ dit(bf(domain guest users (G))) This is an bf(EXPERIMENTAL) parameter that is part of the unfinished Samba NT Domain Controller Code. It may be removed in a later release. To work with the latest code builds that may have more support for -Samba NT Domain Controller functionality please subscibe to the +Samba NT Domain Controller functionality please subscribe to the mailing list bf(Samba-ntdom) available by sending email to email(listproc@samba.anu.edu.au) @@ -1835,7 +1835,7 @@ Samba documentation directory tt(docs/) shipped with the source code. Note that Win95/98 Domain logons are em(NOT) the same as Windows NT Domain logons. NT Domain logons require a Primary Domain Controller -(PDC) for the Domain. It is inteded that in a future release Samba +(PDC) for the Domain. It is intended that in a future release Samba will be able to provide this functionality for Windows NT clients also. @@ -1846,7 +1846,7 @@ label(domainmaster) dit(bf(domain master (G))) Tell url(bf(nmbd))(nmbd.8.html) to enable WAN-wide browse list -collation.Setting this option causes url(bf(nmbd))(nmbd.8.html) to +collation. Setting this option causes url(bf(nmbd))(nmbd.8.html) to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given link(bf(workgroup))(workgroup). Local master browsers in the same @@ -1860,7 +1860,7 @@ list, instead of just the list for their broadcast-isolated subnet. Note that Windows NT Primary Domain Controllers expect to be able to claim this link(bf(workgroup))(workgroup) specific special NetBIOS name that identifies them as domain master browsers for that -link(bf(workgroup))(workgroup) by default (ie. there is no way to +link(bf(workgroup))(workgroup) by default (i.e. there is no way to prevent a Windows NT PDC from attempting to do this). This means that if this parameter is set and url(bf(nmbd))(nmbd.8.html) claims the special name for a link(bf(workgroup))(workgroup) before a Windows NT @@ -1873,7 +1873,7 @@ tt( domain master = no) label(dont descend) dit(bf(dont descend (S))) -There are certain directories on some systems (eg., the tt(/proc) tree +There are certain directories on some systems (e.g., the tt(/proc) tree under Linux) that are either not of interest to clients or are infinitely deep (recursive). This parameter allows you to specify a comma-delimited list of directories that the server should always show @@ -1892,7 +1892,7 @@ tt( dont descend = /proc,/dev) label(dosfiletimeresolution) dit(bf(dos filetime resolution (S))) -Under the DOS and Windows FAT filesystem, the finest granulatity on +Under the DOS and Windows FAT filesystem, the finest granularity on time resolution is two seconds. Setting this parameter for a share causes Samba to round the reported time down to the nearest two second boundary when a query call that requires one second resolution is made @@ -1923,7 +1923,7 @@ 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 smbd is acting on behalf of is not the file owner. Setting this option -to True allows DOS semantics and smbd will change the file timstamp as +to True allows DOS semantics and smbd will change the file timestamp as DOS requires. bf(Default:) @@ -2024,10 +2024,10 @@ url(bf(smbd))(smbd.8.html) from following symbolic links in a particular share. Setting this parameter to em("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 symbolic link to tt(/etc/pasword) in their home directory for +adding a symbolic link to tt(/etc/passwd) in their home directory for instance. However it will slow filename lookups down slightly. -This option is enabled (ie. url(bf(smbd))(smbd.8.html) will follow +This option is enabled (i.e. url(bf(smbd))(smbd.8.html) will follow symbolic links) by default. label(forcecreatemode) @@ -2036,7 +2036,7 @@ dit(bf(force create mode (S))) This parameter specifies a set of UNIX mode bit permissions that will em(*always*) be set on a file created by Samba. This is done by bitwise 'OR'ing these bits onto the mode bits of a file that is being -created. The default for this parameter is (in octel) 000. The modes +created. The default for this parameter is (in octal) 000. The modes in this parameter are bitwise 'OR'ed onto the file mode after the mask set in the link(bf("create mask"))(createmask) parameter is applied. @@ -2059,7 +2059,7 @@ dit(bf(force directory mode (S))) This parameter specifies a set of UNIX mode bit permissions that will em(*always*) be set on a directory created by Samba. This is done by bitwise 'OR'ing these bits onto the mode bits of a directory that is -being created. The default for this parameter is (in octel) 0000 which +being created. The default for this parameter is (in octal) 0000 which will not add any extra permission bits to a created directory. This operation is done after the mode mask in the parameter link(bf("directory mask"))(directorymask) is applied. @@ -2134,7 +2134,7 @@ tt( fstype = Samba) label(getwdcache) dit(bf(getwd cache (G))) -This is a tuning option. When this is enabled a cacheing algorithm +This is a tuning option. When this is enabled a caching algorithm will be used to reduce the time taken for getwd() calls. This can have a significant impact on performance, especially when the link(bf(widelinks))(widelinks) parameter is set to False. @@ -2230,8 +2230,8 @@ Each entry in the list must be separated by a tt('/'), which allows spaces to be included in the entry. tt('*') and tt('?') 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 not include the -unix directory separator tt('/'). +Each entry must be a Unix path, not a DOS path and must not include the +Unix directory separator tt('/'). Note that the case sensitivity option is applicable in hiding files. @@ -2416,7 +2416,7 @@ parameter allows the use of them to be turned on or off. Kernel oplocks support allows Samba link(bf(oplocks))(oplocks) to be broken whenever a local UNIX process or NFS operation accesses a file that url(bf(smbd))(smbd.8.html) has oplocked. This allows complete -data consistancy between SMB/CIFS, NFS and local file access (and is a +data consistency between SMB/CIFS, NFS and local file access (and is a em(very) cool feature :-). This parameter defaults to em("On") on systems that have the support, @@ -2571,7 +2571,7 @@ link(bf("printers"))(printers) section for more details. bf(Default:) tt( load printers = yes) - bg(Example:) + bf(Example:) tt( load printers = no) label(localmaster) @@ -2706,15 +2706,15 @@ client. The share must be writeable when the logs in for the first time, in order that the Windows 95/98 client can create the user.dat and other directories. -Thereafter, the directories and any of contents can, if required, be -made read-only. It is not adviseable that the USER.DAT file be made +Thereafter, the directories and any of the contents can, if required, be +made read-only. It is not advisable that the USER.DAT file be made read-only - rename it to USER.MAN to achieve the desired effect (a em(MAN)datory profile). Windows clients can sometimes maintain a connection to 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 tt(\\%N\HOMES\profile_path) will cause +(i.e. setting this parameter to tt(\\%N\HOMES\profile_path) will cause problems). This option takes the standard substitutions, allowing you to have @@ -2746,7 +2746,7 @@ tt(/usr/local/samba/netlogon/STARTUP.BAT) The contents of the batch file is entirely your choice. A suggested command would be to add tt(NET TIME \\SERVER /SET /YES), to force every -machine to synchronise clocks with the same time server. Another use +machine to synchronize clocks with the same time server. Another use would be to add tt(NET USE U: \\SERVER\UTILS) for commonly used utilities, or tt(NET USE Q: \\SERVER\ISO9001_QA) for example. @@ -2820,7 +2820,7 @@ previous identical bf(lpq) command will be used if the cached data is less than 10 seconds old. A large value may be advisable if your bf(lpq) command is very slow. -A value of 0 will disable cacheing completely. +A value of 0 will disable caching completely. See also the link(bf("printing"))(printing) parameter. @@ -3000,8 +3000,8 @@ See the section on link(bf("NAME MANGLING"))(NAMEMANGLING). label(mangledmap) dit(bf(mangled map (S))) -This is for those who want to directly map UNIX file names which are -not representable on Windows/DOS. The mangling of names is not always +This is for those who want to directly map UNIX file names which can +not 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 tt(".html") for HTML files, whereas under @@ -3012,7 +3012,7 @@ So to map tt("html") to tt("htm") you would use: tt( mangled map = (*.html *.htm)) One very useful case is to remove the annoying tt(";1") off the ends -of filenames on some CDROMS (only visible under some UNIXes). To do +of filenames on some CDROMS (only visible under some UNIXs). To do this use a map of (*;1 *). bf(default:) @@ -3133,7 +3133,7 @@ source code, documents, etc... Note that this requires the link(bf("create mask"))(createmask) parameter to be set such that owner execute bit is not masked out -(ie. it must include 100). See the parameter link(bf("create +(i.e. it must include 100). See the parameter link(bf("create mask"))(createmask) for details. bf(Default:) @@ -3149,7 +3149,7 @@ This controls whether DOS style hidden files should be mapped to the UNIX world execute bit. Note that this requires the link(bf("create mask"))(createmask) to be -set such that the world execute bit is not masked out (ie. it must +set such that the world execute bit is not masked out (i.e. it must include 001). See the parameter link(bf("create mask"))(createmask) for details. @@ -3166,7 +3166,7 @@ This controls whether DOS style system files should be mapped to the UNIX group execute bit. Note that this requires the link(bf("create mask"))(createmask) to be -set such that the group execute bit is not masked out (ie. it must +set such that the group execute bit is not masked out (i.e. it must include 010). See the parameter link(bf("create mask"))(createmask) for details. @@ -3180,7 +3180,7 @@ label(maptoguest) dit(bf(map to guest (G))) This parameter is only useful in link(bf(security))(security) modes -other than link(bf("security=share"))(securityequalshare) - ie. user, +other than link(bf("security=share"))(securityequalshare) - i.e. user, server, and domain. This parameter can take three different values, which tell @@ -3202,7 +3202,7 @@ account"))(guestaccount). it() bf("Bad Password") - Means user logins with an invalid password are treated as a guest login and mapped into the link(bf("guest account"))(guestaccount). Note that this can -cause problems as it means that any user mistyping their +cause problems as it means that any user incorrectly typing their password will be silently logged on a bf("guest") - and will not know the reason they cannot access files they think they should - there will have been no message given to them @@ -3304,7 +3304,7 @@ dit(bf(maxopenfiles (G))) This parameter limits the maximum number of open files that one url(bf(smbd))(smbd.8.html) file serving process may have open for a client at any one time. The default for this parameter is set -very high (10,000) as Samba uses only one bit per un-opened file. +very high (10,000) as Samba uses only one bit per unopened file. The limit of the number of open files is usually set by the UNIX per-process file descriptor limit rather than this parameter @@ -3567,7 +3567,7 @@ tt( nis homedir = true) label(ntpipesupport) dit(bf(nt pipe support (G))) -This boolean parameter controlls whether url(bf(smbd))(smbd.8.html) +This boolean parameter controls whether url(bf(smbd))(smbd.8.html) will allow Windows NT clients to connect to the NT SMB specific tt(IPC$) pipes. This is a developer debugging option and can be left alone. @@ -3578,7 +3578,7 @@ tt( nt pipe support = yes) label(ntsmbsupport) dit(bf(nt smb support (G))) -This boolean parameter controlls whether url(bf(smbd))(smbd.8.html) +This boolean parameter controls whether url(bf(smbd))(smbd.8.html) 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 @@ -3655,15 +3655,15 @@ dit(bf(oplocks (S))) This boolean option tells smbd whether to issue oplocks (opportunistic locks) to file open requests on this 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 agressively cache files +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 Speed.txt in the Samba docs/ directory. Oplocks may be selectively turned off on certain files on a per share basis. -See the 'veto oplock files' parameter. On some systems oplocks are recognised -by the underlying operating system. This allows data synchronisation between +See the 'veto oplock files' 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 link(bf(kernel oplocks))(kerneloplocks) parameter for details. @@ -3704,7 +3704,7 @@ dit(bf(panic action (G))) This is a Samba developer option that allows a system command to be called when either url(bf(smbd))(smbd.8.html) or url(bf(nmbd))(nmbd.8.html) crashes. This is usually used to draw -attention to the fact that a problem occured. +attention to the fact that a problem occurred. bf(Default:) tt( panic action = <empty string>) @@ -3783,7 +3783,7 @@ dit(bf(passwd program (G))) The name of a program that can be used to set UNIX user passwords. Any occurrences of link(bf(%u))(percentu) will be replaced with the -user name. The user name is checked for existance before calling the +user name. The user name is checked for existence before calling the password changing program. Also note that many passwd programs insist in em("reasonable") @@ -3794,7 +3794,7 @@ Windows for Workgroups) uppercase the password before sending it. em(Note) that if the link(bf("unix password sync"))(unixpasswordsync) parameter is set to tt("True") then this program is called em(*AS ROOT*) before the SMB password in the -url(bf(smbpassswd))(smbpasswd.5.html) file is changed. If this UNIX +url(bf(smbpasswd))(smbpasswd.5.html) file is changed. If this UNIX password change fails, then url(bf(smbd))(smbd.8.html) will fail to change the SMB password also (this is by design). @@ -3889,8 +3889,8 @@ better restrict them with hosts allow! If the link(bf("security"))(security) parameter is set to bf("domain"), then the list of machines in this option must be a list of Primary or Backup Domain controllers for the -link(bf(Domain))(workgroup), as the Samba server is cryptographically -in that domain, and will use crpytographically authenticated RPC calls +link(bf(Domain))(workgroup), as the Samba server is cryptographicly +in that domain, and will use cryptographicly authenticated RPC calls to authenticate the user logging on. The advantage of using link(bf("security=domain"))(securityequaldomain) is that if you list several hosts in the bf("password server") option then @@ -3938,7 +3938,7 @@ where print data will spool prior to being submitted to the host for printing. For a printable service offering guest access, the service should be -readonly and the path should be world-writable and have the sticky bit +readonly and the path should be world-writeable and have the sticky bit set. This is not mandatory of course, but you probably won't get the results you expect if you do otherwise. @@ -4103,12 +4103,12 @@ If there is neither a specified print command for a printable service nor a global print command, spool files will be created but not processed and (most importantly) not removed. -Note that printing may fail on some UNIXes from the tt("nobody") +Note that printing may fail on some UNIXs from the tt("nobody") account. If this happens then create an alternative guest account that can print and set the link(bf("guest account"))(guestaccount) in the link(bf("[global]"))(global) section. -You can form quite complex print commands by realising that they are +You can form quite complex print commands by realizing that they are just passed to a shell. For example the following will log a print job, print the file, then remove it. Note that tt(';') is the usual separator for command in shell scripts. @@ -4378,7 +4378,7 @@ dit(bf(queueresume command (S))) This parameter specifies the command to be executed on the server host in order to resume the printerqueue. It is the command to undo the -behaviour that is caused by the previous parameter +behavior that is caused by the previous parameter (link(bf("queuepause command))(queuepausecommand)). This command should be a program or script which takes a printer name @@ -4432,9 +4432,9 @@ label(readonly) dit(bf(read only (S))) Note that this is an inverted synonym for -link(bf("writable"))(writable) and link(bf("write ok"))(writeok). +link(bf("writeable"))(writeable) and link(bf("write ok"))(writeok). -See also link(bf("writable"))(writable) and link(bf("write +See also link(bf("writeable"))(writeable) and link(bf("write ok"))(writeok). label(readprediction) @@ -4535,7 +4535,7 @@ label(remotebrowsesync) dit(bf(remote browse sync (G))) This option allows you to setup url(bf(nmbd))(nmbd.8.html) to -periodically request synchronisation of browse lists with the master +periodically request synchronization of browse lists with the master browser of a samba server that is on a remote segment. This option will allow you to gain browse lists for multiple workgroups across routed networks. This is done in a manner that does not work with any @@ -4551,7 +4551,7 @@ For example: tt( remote browse sync = 192.168.2.255 192.168.4.255) the above line would cause url(bf(nmbd))(nmbd.8.html) to request the -master browser on the specified subnets or addresses to synchronise +master browser on the specified subnets or addresses to synchronize their browse lists with the local server. The IP addresses you choose would normally be the broadcast addresses @@ -4602,7 +4602,7 @@ Synonym for link(bf("root directory"))(rootdirectory). label(rootdirectory) dit(bf(root directory (G))) -The server will tt("chroot()") (ie. Change it's root directory) to +The server will tt("chroot()") (i.e. Change it's root directory) to this directory on startup. This is not strictly necessary for secure operation. Even without it the server will deny access to files not in one of the service entries. It may also check for, and deny access to, @@ -4641,7 +4641,7 @@ dit(bf(root preexec (S))) This is the same as the link(bf("preexec"))(preexec) parameter except that the command is run as root. This is useful for mounting -filesystems (such as cdroms) before a connection is finalised. +filesystems (such as cdroms) before a connection is finalized. See also link(bf("preexec"))(preexec). @@ -4671,7 +4671,7 @@ In previous versions of Samba the default was link(bf("security=share"))(securityequalshare) mainly because that was the only option at one stage. -There is a bug in WfWg that has relevence to this setting. When in +There is a bug in WfWg that has relevance to this setting. When in user or server level security a WfWg client will totally ignore the password you type in the "connect drive" dialog box. This makes it very difficult (if not impossible) to connect to a Samba service as @@ -4689,7 +4689,7 @@ difficult to setup guest shares with link(bf(security=user))(securityequaluser), see the link(bf("map to guest"))(maptoguest)parameter for details. -It is possible to use url(bf(smbd))(smbd.8.html) in a em("hybred +It is possible to use url(bf(smbd))(smbd.8.html) in a em("hybrid mode") where it is offers both user and share level security under different link(bf(NetBIOS aliases))(netbiosaliases). See the link(bf(NetBIOS aliases))(netbiosaliases) and the @@ -4775,7 +4775,7 @@ are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated. -em(Note) that the the name of the resource being requested is +em(Note) that the name of the resource being requested is em(*not*) sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in user level security without allowing the server to automatically map unknown @@ -4802,7 +4802,7 @@ the same as link(bf("security=user"))(securityequaluser). It only affects how the server deals with the authentication, it does not in any way affect what the client sees. -em(Note) that the the name of the resource being requested is +em(Note) that the name of the resource being requested is em(*not*) sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in server level security without allowing the server to automatically map unknown @@ -4836,7 +4836,7 @@ the same as link(bf("security=user"))(securityequaluser). It only affects how the server deals with the authentication, it does not in any way affect what the client sees. -em(Note) that the the name of the resource being requested is +em(Note) that the name of the resource being requested is em(*not*) sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in domain level security without allowing the server to automatically map unknown @@ -4849,7 +4849,7 @@ bf("security=domain) with respect to multi-byte character set usernames. The communication with a 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 recognised correctly at the Domain Controller. +username will not be recognized correctly at the Domain Controller. This issue will be addressed in a future release. See also the section link(bf("NOTE ABOUT USERNAME/PASSWORD @@ -4904,7 +4904,7 @@ tt( set directory = yes) label(sharemodes) dit(bf(share modes (S))) -This enables or disables the honouring of the tt("share modes") during a +This enables or disables the honoring of the tt("share modes") during a file open. These modes are used by clients to gain exclusive read or write access to a file. @@ -5014,9 +5014,9 @@ appropriate documentation for your operating system first (perhaps bf("man setsockopt") will help). You may find that on some systems Samba will say "Unknown socket -option" when you supply an option. This means you either mis-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 +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 email(samba-bugs@samba.anu.edu.au). Any of the supported socket options may be combined in any way you @@ -5109,7 +5109,7 @@ em(Note) that for export control reasons this code is em(**NOT**) enabled by default in any current binary version of Samba. This variable defines where to look up the Certification -Autorities. The given directory should contain one file for each CA +Authorities. The given directory should contain one file for each CA that samba will trust. The file name must be the hash value over the "Distinguished Name" of the CA. How this directory is set up is explained later in this document. All files within the directory that @@ -5133,7 +5133,7 @@ This variable is a second way to define the trusted CAs. The certificates of the trusted CAs are collected in one big file and this variable points to the file. You will probably only use one of the two ways to define your CAs. The first choice is preferable if you have -many CAs or want to be flexible, the second is perferable if you only +many CAs or want to be flexible, the second is preferable if you only have one CA and want to keep things simple (you won't need to create the hashed file names). You don't need this variable if you don't verify client certificates. @@ -5373,7 +5373,7 @@ change this parameter. status = yes label(strictlocking) -dir(bf(strict locking (S))) +dit(bf(strict locking (S))) This is a boolean that controls the handling of file locking in the server. When this is set to tt("yes") the server will check every read and @@ -5400,7 +5400,7 @@ Many Windows applications (including the Windows 98 explorer shell) seem to confuse flushing buffer contents to disk with doing a sync to disk. Under UNIX, a sync call forces the process to be suspended until the kernel has ensured that all outstanding data in kernel disk -buffers has been safely stored onto stable storate. This is very slow +buffers has been safely stored onto stable storage. This is very slow and should only be done rarely. Setting this parameter to "no" (the default) means that smbd ignores the Windows applications requests for a sync call. There is only a possibility of losing data if the @@ -5447,7 +5447,7 @@ See also the link(bf("strict sync"))(strictsync) parameter. bf(Default:) tt( sync always = no) - bf(xample:) + bf(Example:) tt( sync always = yes) label(syslog) @@ -5456,9 +5456,9 @@ dit(bf(syslog (G))) This parameter maps how Samba debug messages 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 -to LOG_NOTICE, debug level three maps onto LOG_INFO. The paramter +to LOG_NOTICE, debug level three maps onto LOG_INFO. The parameter sets the threshold for doing the mapping, all Samba debug messages -above this threashold are mapped to syslog LOG_DEBUG messages. +above this threshold are mapped to syslog LOG_DEBUG messages. bf(Default:) tt( syslog = 1) @@ -5514,7 +5514,7 @@ tt( timestamp logs = False) label(unixpasswordsync) dit(bf(unix password sync (G))) -This boolean parameter controlls whether Samba attempts to synchronise +This boolean parameter controls whether Samba attempts to synchronize the UNIX password with the SMB password when the encrypted SMB password in the smbpasswd file is changed. If this is set to true the program specified in the link(bf("passwd program"))(passwdprogram) @@ -5675,7 +5675,7 @@ tries all lowercase, followed by the username with the first letter capitalized, and fails if the username is not found on the UNIX machine. -If this parameter is set to non-zero the behaviour changes. This +If this parameter is set to non-zero the behavior changes. This parameter is a number that specifies the number of uppercase combinations to try whilst trying to determine the UNIX user name. The higher the number the more combinations will be tried, but the slower @@ -5691,7 +5691,7 @@ tt( username level = 5) label(usernamemap) dit(bf(username map (G))) -This option allows you to to specify a file containing a mapping of +This option allows you to specify a file containing a mapping of usernames from the clients to the server. This can be used for several purposes. The most common is to map usernames that users use on DOS or Windows machines to those that the UNIX box uses. The other is to map @@ -5813,13 +5813,13 @@ See also the link(bf("client code page"))(clientcodepage) parameter. bf(Default:) verb( Samba defaults to using a reasonable set of valid characters - for english systems + for English systems ) bf(Example) tt( valid chars = 0345:0305 0366:0326 0344:0304) -The above example allows filenames to have the swedish characters in +The above example allows filenames to have the Swedish characters in them. NOTE: It is actually quite difficult to correctly produce a bf("valid @@ -6004,7 +6004,7 @@ label(workgroup) dit(bf(workgroup (G))) This controls what workgroup your server will appear to be in when -queried by clients. Note that this parameter also controlls the Domain +queried by clients. Note that this parameter also controls the Domain name used with the link(bf("security=domain"))(securityequaldomain) setting. @@ -6017,24 +6017,7 @@ tt( set at compile time to WORKGROUP) label(writable) dit(bf(writable (S))) -An inverted synonym is link(bf("read only"))(readonly). - -If this parameter is tt("no"), then users of a service may not create -or modify files in the service's directory. - -Note that a printable service link(bf(("printable = yes")))(printable) -will em(*ALWAYS*) allow writing to the directory (user privileges -permitting), but only via spooling operations. - - bf(Default:) -tt( writable = no) - - bf(Examples:) -verb( - read only = no - writable = yes - write ok = yes -) +Synonym for link(bf("writeable"))(writeable) for people who can't spell :-). label(writelist) dit(bf(write list (S))) @@ -6059,7 +6042,7 @@ tt( write list = admin, root, @staff) label(writeok) dit(bf(write ok (S))) -Synonym for link(bf(writable))(writable). +Synonym for link(bf(writeable))(writeable). label(writeraw) dit(bf(write raw (G))) @@ -6074,7 +6057,24 @@ tt( write raw = yes) label(writeable) dit(bf(writeable)) -Synonym for link(bf("writable"))(writable) for people who can't spell :-). +An inverted synonym is link(bf("read only"))(readonly). + +If this parameter is tt("no"), then users of a service may not create +or modify files in the service's directory. + +Note that a printable service link(bf(("printable = yes")))(printable) +will em(*ALWAYS*) allow writing to the directory (user privileges +permitting), but only via spooling operations. + + bf(Default:) +tt( writeable = no) + + bf(Examples:) +verb( + read only = no + writeable = yes + write ok = yes +) label(WARNINGS) manpagesection(WARNINGS) diff --git a/docs/yodldocs/smbclient.1.yo b/docs/yodldocs/smbclient.1.yo index fbb754ea10..a211499408 100644 --- a/docs/yodldocs/smbclient.1.yo +++ b/docs/yodldocs/smbclient.1.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(smbclient)(1)(23 Oct 1998)(Samba)(SAMBA) +manpage(smbclient htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(smbclient)(ftp-like client to access SMB/CIFS resources on servers) @@ -112,7 +112,7 @@ may be used. endit() -If this parameter is not set then the name resolver order defined +If this parameter is not set then the name resolve order defined in the url(bf(smb.conf))(smb.conf.5.html) file parameter url((bf(name resolve order)))(smb.conf.5.html#nameresolveorder) will be used. @@ -261,7 +261,7 @@ the environment variable tt(USER) or tt(LOGNAME) in that order. If no username is supplied and neither environment variable exists the username "GUEST" will be used. -If the tt(USER) environment variable containts a '%' character, +If the tt(USER) environment variable contains a '%' character, everything after that will be treated as a password. This allows you to set the environment variable to be tt(USER=username%password) so that a password is not passed on the command line (where it may be @@ -323,7 +323,7 @@ Samba source code for the complete list. label(minusm) dit(bf(-m max protocol level)) With the new code in Samba2.0, -bf(smbclient) allways attempts to connect at the maximum +bf(smbclient) always attempts to connect at the maximum protocols level the server supports. This parameter is preserved for backwards compatibility, but any string following the bf(-m) will be ignored. @@ -350,12 +350,12 @@ share. The secondary tar flags that can be given to this option are : share. Unless the link(bf(-D))(minusD) option is given, the tar files will be restored from the top level of the share. Must be followed by the name of the tar file, device or tt("-") for standard input. Mutually exclusive - with the bf(c) flag. Restored files have theuir creation times (mtime) + with the bf(c) flag. Restored files have their creation times (mtime) set to the date saved in the tar file. Directories currently do not get their creation dates restored properly. dit(bf(I)) Include files and directories. Is the default - behaviour when filenames are specified above. Causes tar files to + behavior when filenames are specified above. Causes tar files to be included in an extract or create (and therefore everything else to be excluded). See example below. Filename globbing does not work for included files for extractions (yet). @@ -458,13 +458,13 @@ be case sensitive, depending on the command. You can specify file names which have spaces in them by quoting the name with double quotes, for example "a long file name". -Parameters shown in square brackets (eg., "[parameter]") are +Parameters shown in square brackets (e.g., "[parameter]") are optional. If not given, the command will use suitable -defaults. Parameters shown in angle brackets (eg., "<parameter>") are +defaults. Parameters shown in angle brackets (e.g., "<parameter>") are required. Note that all commands operating on the server are actually performed -by issuing a request to the server. Thus the behaviour may vary from +by issuing a request to the server. Thus the behavior may vary from server to server, depending on how the server was implemented. The commands available are given here in alphabetical order. @@ -584,7 +584,7 @@ mode to suit either binary data (such as graphical information) or text. Subsequent print commands will use the currently set print mode. -label(prompt) dir(bf(prompt)) Toggle prompting for filenames during +label(prompt) dit(bf(prompt)) Toggle prompting for filenames during operation of the link(bf(mget))(mget) and link(bf(mput))(mput) commands. @@ -598,15 +598,15 @@ the server. If specified, name the remote copy "remote file name". Note that all transfers in smbclient are binary. See also the link(bf(lowercase))(lowercase) command. -label(queue) dir(bf(queue)) Displays the print queue, showing the job +label(queue) dit(bf(queue)) Displays the print queue, showing the job id, name, size and current status. label(quit) dit(bf(quit)) See the link(bf(exit))(exit) command. -label(rd) dir(bf(rd <directory name>)) See the link(bf(rmdir))(rmdir) +label(rd) dit(bf(rd <directory name>)) See the link(bf(rmdir))(rmdir) command. -label(recurse) dir(bf(recurse)) Toggle directory recursion for the +label(recurse) dit(bf(recurse)) Toggle directory recursion for the commands link(bf(mget))(mget) and link(bf(mput))(mput). When toggled ON, these commands will process all directories in the @@ -622,14 +622,14 @@ link(bf(mget))(mget) or link(bf(mput))(mput) commands will be copied, and any mask specified using the link(bf(mask))(mask) command will be ignored. -label(rm) dir(bf(rm <mask>)) Remove all files matching mask from +label(rm) dit(bf(rm <mask>)) Remove all files matching mask from the current working directory on the server. label(rmdir) dit(bf(rmdir <directory name>)) Remove the specified directory (user access privileges permitting) from the server. label(tar) dit(bf(tar <c|x>[IXbgNa])) Performs a tar operation - see -the link(bf(-T))(minusT) command line option above. Behaviour may be +the link(bf(-T))(minusT) command line option above. Behavior may be affected by the link(bf(tarmode))(tarmode) command (see below). Using g (incremental) and N (newer) will affect tarmode settings. Note that using the "-" option with tar x may not work - use the command line @@ -639,8 +639,8 @@ label(blocksize) dit(bf(blocksize <blocksize>)) Blocksize. Must be followed by a valid (greater than zero) blocksize. Causes tar file to be written out in blocksize*TBLOCK (usually 512 byte) blocks. -label(tarmode) dir(bf(tarmode <full|inc|reset|noreset>)) Changes tar's -behaviour with regard to archive bits. In full mode, tar will back up +label(tarmode) dit(bf(tarmode <full|inc|reset|noreset>)) Changes tar's +behavior with regard to archive bits. In full mode, tar will back up everything regardless of the archive bit setting (this is the default mode). In incremental mode, tar will only back up files with the archive bit set. In reset mode, tar will reset the archive bit on all @@ -659,7 +659,7 @@ label(NOTES) manpagesection(NOTES) Some servers are fussy about the case of supplied usernames, -passwords, share names (aka service names) and machine names. If you +passwords, share names (AKA service names) and machine names. If you fail to connect try giving all parameters in uppercase. It is often necessary to use the link(bf(-n))(minusn) option when connecting to some @@ -694,7 +694,7 @@ should be executable by all. The client should em(NOT) be setuid or setgid! The client log files should be put in a directory readable and -writable only by the user. +writeable only by the user. To test the client, you will need to know the name of a running SMB/CIFS server. It is possible to run url(bf(smbd (8)))(smbd.8.html) diff --git a/docs/yodldocs/smbd.8.yo b/docs/yodldocs/smbd.8.yo index d13a8f8333..eded744ad2 100644 --- a/docs/yodldocs/smbd.8.yo +++ b/docs/yodldocs/smbd.8.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -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) @@ -15,7 +15,8 @@ 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 @@ -24,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 @@ -123,14 +126,13 @@ This parameter is not normally specified except in the above situation. label(minuss) -dit(bf(-s configuration file)) The default configuration file name is -determined at compile time. - +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 @@ -156,22 +158,22 @@ 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) @@ -180,7 +182,7 @@ 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) @@ -224,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 @@ -255,8 +257,9 @@ 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) @@ -281,19 +284,19 @@ 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 link(bf(-D))(minusD) 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 @@ -338,10 +341,10 @@ start with, the following two services should be all you need: verb( [homes] - writable = yes + writeable = yes [printers] - writable = no + writeable = no printable = yes path = /tmp public = yes @@ -363,7 +366,8 @@ 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. @@ -383,8 +387,8 @@ 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. @@ -397,7 +401,7 @@ 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. @@ -429,7 +433,7 @@ 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.anu.edu.au). Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. diff --git a/docs/yodldocs/smbpasswd.5.yo b/docs/yodldocs/smbpasswd.5.yo index d1f6853e2f..2dc8458013 100644 --- a/docs/yodldocs/smbpasswd.5.yo +++ b/docs/yodldocs/smbpasswd.5.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(smbpasswd)(5)(23 Oct 1998)(Samba)(SAMBA) +manpage(smbpasswd htmlcommand((5)))(5)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(smbpasswd)(The Samba encrypted password file) @@ -16,7 +16,7 @@ manpagedescription() This file is part of the bf(Samba) suite. smbpasswd is the bf(Samba) encrypted password file. It contains -the username, unix user id and the SMB hashed passwords of the +the username, Unix user id and the SMB hashed passwords of the user, as well as account flag information and the time the password was last changed. This file format has been evolving with Samba and has had several different formats in the past. @@ -25,7 +25,7 @@ label(FILEFORMAT) manpagesection(FILE FORMAT) The format of the smbpasswd file used by Samba 2.0 is very similar to -the familiar unix bf(passwd (5)) file. It is an ASCII file containing +the familiar Unix bf(passwd (5)) file. It is an ASCII file containing one line for each user. Each field within each line is separated from the next by a colon. Any entry beginning with # is ignored. The smbpasswd file contains the following information for each user: @@ -43,7 +43,7 @@ dit(bf(uid)) nl() nl() This is the UNIX uid. It must match the uid field for the same user entry in the standard UNIX passwd file. If this does not - match then Samba will refuse to recognis this bf(smbpasswd) file entry + match then Samba will refuse to recognize this bf(smbpasswd) file entry as being valid for a user. label(LanmanPasswordHash) @@ -54,7 +54,7 @@ dit(bf(Lanman Password Hash)) nl() nl() string with the users password as the DES key. This is the same password used by Windows 95/98 machines. Note that this password hash is regarded as weak as it is vulnerable to dictionary attacks and if - two users choose the same password this entry will be identical (ie. + two users choose the same password this entry will be identical (i.e. the password is not em("salted") as the UNIX password is). If the user has a null password this field will contain the characters tt("NO PASSWORD") as the start of the hex string. If the hex string @@ -64,7 +64,7 @@ dit(bf(Lanman Password Hash)) nl() nl() em(WARNING !!). Note that, due to the challenge-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this - password hash will be able to impersonate the user of the network. + password hash will be able to impersonate the user on the network. For this reason these hashes are known as em("plain text equivalent") and must em(NOT) be made available to anyone but the root user. To protect these passwords the bf(smbpasswd) file is placed in a @@ -84,12 +84,12 @@ dit(bf(NT Password Hash)) nl() nl() Password Hash))(LanmanPasswordHash) as it preserves the case of the password and uses a much higher quality hashing algorithm. However, it is still the case that if two users choose the same password this - entry will be identical (ie. the password is not em("salted") as the + entry will be identical (i.e. the password is not em("salted") as the UNIX password is). em(WARNING !!). Note that, due to the challenge-response nature of the SMB/CIFS authentication protocol, anyone with a knowledge of this - password hash will be able to impersonate the user of the network. + password hash will be able to impersonate the user on the network. For this reason these hashes are known as em("plain text equivalent") and must em(NOT) be made available to anyone but the root user. To protect these passwords the bf(smbpasswd) file is placed in a @@ -109,8 +109,8 @@ dit(bf(Account Flags)) nl() nl() startit() label(capU) - it() bf('U') This means this is a em("User") account, ie. an ordinary - user. Only bf(User) and link(bf(Worskstation Trust))(capW) accounts are + it() bf('U') This means this is a em("User") account, i.e. an ordinary + user. Only bf(User) and link(bf(Workstation Trust))(capW) accounts are currently supported in the bf(smbpasswd) file. label(capN) @@ -122,7 +122,7 @@ dit(bf(Account Flags)) nl() nl() in the url(bf(smb.conf (5)))(smb.conf.5.html) config file. label(capD) - it() bf('D') This means the account is diabled and no SMB/CIFS logins + it() bf('D') This means the account is disabled and no SMB/CIFS logins will be allowed for this user. label(capW) @@ -197,13 +197,15 @@ 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.anu.edu.au). Samba is now developed by the Samba Team as an Open Source project similar 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) and updated for the Samba2.0 release by Jeremy +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.anu.edu.au). See url(bf(samba (7)))(samba.7.html) to find out how to get a full diff --git a/docs/yodldocs/smbpasswd.8.yo b/docs/yodldocs/smbpasswd.8.yo index 3019baa24a..b32a65a129 100644 --- a/docs/yodldocs/smbpasswd.8.yo +++ b/docs/yodldocs/smbpasswd.8.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(smbpasswd)(8)(23 Oct 1998)(Samba)(SAMBA) +manpage(smbpasswd htmlcommand((8)))(8)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(smbpasswd)(change a users SMB password) @@ -22,7 +22,7 @@ sessions on any machines that store SMB passwords. By default (when run with no arguments) it will attempt to change the current users SMB password on the local machine. This is similar to -the way the bf(passwd (1)) program works. bf(smbpasswd) differs from +the way the bf(passwd (1)) program works. bf(smbpasswd) differs from how the bf(passwd) program works however in that it is not em(setuid root) but works in a client-server mode and communicates with a locally running url(bf(smbd))(smbd.8.html). As a consequence in order for this @@ -38,14 +38,14 @@ typed. If you have a blank smb password (specified by the string "NO PASSWORD" in the url(bf(smbpasswd))(smbpasswd.5.html) file) then just press the <Enter> key when asked for your old password. -bf(smbpasswd) also can be used by a normal user to change their SMB +bf(smbpasswd) can also be used by a normal user to change their SMB password on remote machines, such as Windows NT Primary Domain Controllers. See the link((bf(-r)))(minusr) and link(bf(-U))(minusU) options below. When run by root, bf(smbpasswd) allows new users to be added and deleted in the url(bf(smbpasswd))(smbpasswd.5.html) file, as well as -changes to the attributes of the user in this file to be made. When +allows changes to the attributes of the user in this file to be made. When run by root, bf(smbpasswd) accesses the local url(bf(smbpasswd))(smbpasswd.5.html) file directly, thus enabling changes to be made even if url(bf(smbd))(smbd.8.html) is not running. @@ -61,8 +61,8 @@ be added to the local url(bf(smbpasswd))(smbpasswd.5.html) file, with the new password typed (type <Enter> for the old password). This option is ignored if the username following already exists in the url(bf(smbpasswd))(smbpasswd.5.html) file and it is treated like a -regular change password command. Note that the user to be added .B -must already exist in the system password file (usually /etc/passwd) +regular change password command. Note that the user to be added +bf(must) already exist in the system password file (usually /etc/passwd) else the request to add the user will fail. This option is only available when running bf(smbpasswd) as @@ -173,12 +173,13 @@ it() bf(lmhosts) : Lookup an IP address in the Samba lmhosts file. label(host) it() bf(host) : Do a standard host name to IP address resolution, using the system /etc/hosts, 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 em(/etc/nsswitch.conf) file). +resolution is operating system dependent. For instance on IRIX or +Solaris, this may be controlled by the em(/etc/nsswitch.conf) file). label(wins) -it() bf(wins) : Query a name with the IP address listed in the url(bf(wins -server))(smb.conf.5.html#winsserver) parameter in the smb.conf file. If +it() bf(wins) : Query a name with the IP address listed in the +url(bf(wins server))(smb.conf.5.html#winsserver) parameter in the +url(bf(smb.conf file))(smb.conf.5.html). If no WINS server has been specified this method will be ignored. label(bcast) @@ -190,7 +191,7 @@ subnet. endit() -If this parameter is not set then the name resolver order defined +If this parameter is not set then the name resolve order defined in the url(bf(smb.conf))(smb.conf.5.html) file parameter url(bf(name resolve order))(smb.conf.5.html#nameresolveorder) will be used. @@ -230,7 +231,7 @@ url(bf(password server))(smb.conf.5.html#passwordserver) and change the machine account password used to create the secure Domain communication. This password is then stored by bf(smbpasswd) in a file, read only by root, called tt(<Domain>.<Machine>.mac) where -tt(<Domain>) is the name of the Domain we are joining and tt<Machine> +tt(<Domain>) is the name of the Domain we are joining and tt(<Machine>) is the primary NetBIOS name of the machine we are running on. Once this operation has been performed the @@ -258,13 +259,13 @@ dit(bf(-h)) This option prints the help string for bf(smbpasswd), selecting the correct one for running as root or as an ordinary user. label(minuss) -dit(bf(-s)) This option causes bf(smbpasswd) to be silent (ie. not +dit(bf(-s)) This option causes bf(smbpasswd) to be silent (i.e. not issue prompts) and to read it's old and new passwords from standard input, rather than from tt(/dev/tty) (like the bf(passwd (1)) program does). This option is to aid people writing scripts to drive bf(smbpasswd) label(username) -dir(bf(username)) This specifies the username for all of the em(root +dit(bf(username)) This specifies the username for all of the em(root only) options to operate on. Only root can specify this parameter as only root has the permission needed to modify attributes directly in the local url(bf(smbpasswd))(smbpasswd.5.html) file. @@ -272,7 +273,7 @@ in the local url(bf(smbpasswd))(smbpasswd.5.html) file. label(NOTES) manpagesection(NOTES) -As bf(smbpasswd) works in client-server mode communicating with a +Since bf(smbpasswd) works in client-server mode communicating with a local url(bf(smbd))(smbd.8.html) for a non-root user then the bf(smbd) daemon must be running for this to work. A common problem is to add a restriction to the hosts that may access the bf(smbd) running on the diff --git a/docs/yodldocs/smbrun.1.yo b/docs/yodldocs/smbrun.1.yo index bda3e1871b..d8e05c6e09 100644 --- a/docs/yodldocs/smbrun.1.yo +++ b/docs/yodldocs/smbrun.1.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(smbrun)(1)(23 Oct 1998)(Samba)(SAMBA) +manpage(smbrun htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(smbrun)(interface program between smbd and external programs) diff --git a/docs/yodldocs/smbstatus.1.yo b/docs/yodldocs/smbstatus.1.yo index 2dad98b393..0312cdb251 100644 --- a/docs/yodldocs/smbstatus.1.yo +++ b/docs/yodldocs/smbstatus.1.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(smbstatus)(1)(23 Oct 1998)(Samba)(SAMBA) +manpage(smbstatus htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(smbstatus)(report on current Samba connections) diff --git a/docs/yodldocs/smbtar.1.yo b/docs/yodldocs/smbtar.1.yo index eb63fba06c..d35cea6939 100644 --- a/docs/yodldocs/smbtar.1.yo +++ b/docs/yodldocs/smbtar.1.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(smbtar)(1)(23 Oct 1998)(Samba)(SAMBA) +manpage(smbtar htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(smbtar)(shell script for backing up SMB/CIFS shares directly to UNIX tape drives) diff --git a/docs/yodldocs/swat.8.yo b/docs/yodldocs/swat.8.yo index 9061bd99fe..5d226adcd5 100644 --- a/docs/yodldocs/swat.8.yo +++ b/docs/yodldocs/swat.8.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(swat)(8)(23 Oct 1998)(Samba)(SAMBA) +manpage(swat htmlcommand((8)))(8)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(swat)(swat - Samba Web Administration Tool) @@ -122,7 +122,7 @@ your Samba configuration which would allow them to easily gain root access on your machine. After testing the authentication you need to change the ownership and -permissions on the bf(swat) binary. It should be owned by root wth the +permissions on the bf(swat) binary. It should be owned by root with the setuid bit set. It should be ONLY executable by the user that the web server runs as. Make sure you do this carefully! @@ -131,14 +131,14 @@ group tt("nobody"). tt(-rws--x--- 1 root nobody ) -You must also realise that this means that any user who can run +You must also realize that this means that any user who can run programs as the tt("nobody") group can run bf(swat) and modify your Samba config. Be sure to think about this! label(LAUNCHING) manpagesection(LAUNCHING) -To launch bf(swat) just run your favourite web browser and point it at +To launch bf(swat) just run your favorite web browser and point it at tt(http://localhost:901/) or tt(http://localhost/cgi-bin/swat/) depending on how you installed it. @@ -166,8 +166,8 @@ section link(bf(RUNNING VIA INETD))(RUNNINGVIAINETD) above. bf(/etc/services) If running the server via the meta-daemon inetd, this file must -contain a mapping of service name (eg., swat) to service port -(eg., 901) and protocol type (eg., tcp). See the section +contain a mapping of service name (e.g., swat) to service port +(e.g., 901) and protocol type (e.g., tcp). See the section link(bf(RUNNING VIA INETD))(RUNNINGVIAINETD) above. bf(/usr/local/samba/lib/smb.conf) diff --git a/docs/yodldocs/testparm.1.yo b/docs/yodldocs/testparm.1.yo index 43f025a952..ebb6120746 100644 --- a/docs/yodldocs/testparm.1.yo +++ b/docs/yodldocs/testparm.1.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(testparm)(1)(23 Oct 1998)(Samba)(SAMBA) +manpage(testparm htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(testparm)(check an smb.conf configuration file for internal correctness) @@ -44,9 +44,9 @@ then testparm will examine the url(bf("hosts allow"))(smb.conf.5.html#hostsallow) and url(bf("hosts deny"))(smb.conf.5.html#hostsdeny) parameters in the url(bf(smb.conf))(smb.conf.5.html) file to determine if the hostname -with this IP address would be allowed acces to the +with this IP address would be allowed access to the url(bf(smbd))(smbd.8.html) server. If this parameter is supplied, the -hostIP parameter must also be supplied. +link(hostIP)(hostIP) parameter must also be supplied. label(hostIP) dit(bf(hostIP)) This is the IP address of the host specified in the diff --git a/docs/yodldocs/testprns.1.yo b/docs/yodldocs/testprns.1.yo index f7dfed7d26..8ec0410426 100644 --- a/docs/yodldocs/testprns.1.yo +++ b/docs/yodldocs/testprns.1.yo @@ -1,6 +1,6 @@ mailto(samba-bugs@samba.anu.edu.au) -manpage(testprns)(1)(23 Oct 1998)(Samba)(SAMBA) +manpage(testprns htmlcommand((1)))(1)(23 Oct 1998)(Samba)(SAMBA) label(NAME) manpagename(testprns)(check printer name for validity with smbd ) @@ -33,7 +33,7 @@ dit(bf(printername)) The printer name to validate. Printer names are taken from the first field in each record in the printcap file, single printer names and sets of aliases separated by -vertical bars ("|") are recognised. Note that no validation or +vertical bars ("|") are recognized. Note that no validation or checking of the printcap syntax is done beyond that required to extract the printer name. It may be that the print spooling system is more forgiving or less forgiving than bf(testprns). However, if |