From 789ccf3094a577f08c379b6d45f81326beef1630 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Fri, 27 Sep 2002 16:45:57 +0000 Subject: Apply Vance Lankhaars' cifs2002 documentation patch - mostly grammar and English typo fixes and updates of documentation (This used to be commit bba2ee620a286dcc7fcd509c8954227e203274a1) --- docs/docbook/manpages/findsmb.1.sgml | 4 +- docs/docbook/manpages/make_smbcodepage.1.sgml | 4 +- docs/docbook/manpages/nmbd.8.sgml | 16 +-- docs/docbook/manpages/pdbedit.8.sgml | 45 +++---- docs/docbook/manpages/rpcclient.1.sgml | 34 ++--- docs/docbook/manpages/samba.7.sgml | 31 ++--- docs/docbook/manpages/smb.conf.5.sgml | 4 +- docs/docbook/manpages/smbcacls.1.sgml | 6 +- docs/docbook/manpages/smbcontrol.1.sgml | 2 +- docs/docbook/manpages/smbgroupedit.8.sgml | 8 +- docs/docbook/manpages/smbmount.8.sgml | 4 +- docs/docbook/manpages/smbpasswd.8.sgml | 27 ++-- docs/docbook/manpages/smbspool.8.sgml | 6 +- docs/docbook/manpages/smbtar.1.sgml | 4 +- docs/docbook/manpages/swat.8.sgml | 4 +- docs/docbook/manpages/winbindd.8.sgml | 174 ++++---------------------- 16 files changed, 125 insertions(+), 248 deletions(-) (limited to 'docs/docbook/manpages') diff --git a/docs/docbook/manpages/findsmb.1.sgml b/docs/docbook/manpages/findsmb.1.sgml index d8f436c4a1..7b2371fdb7 100644 --- a/docs/docbook/manpages/findsmb.1.sgml +++ b/docs/docbook/manpages/findsmb.1.sgml @@ -45,7 +45,7 @@ will probe the subnet of the machine where findsmb is run. This value is passed to nmblookup as part of the - -B option + -B option. @@ -73,7 +73,7 @@ get proper responses from Windows 95 and Windows 98 machines, the command must be run as root. - For example running findsmb on a machine + For example, running findsmb on a machine without nmbd running would yield output similar to the following diff --git a/docs/docbook/manpages/make_smbcodepage.1.sgml b/docs/docbook/manpages/make_smbcodepage.1.sgml index a36f9b968c..774b3d8f8b 100644 --- a/docs/docbook/manpages/make_smbcodepage.1.sgml +++ b/docs/docbook/manpages/make_smbcodepage.1.sgml @@ -57,10 +57,10 @@ inputfile This is the input file to process. In - the c case this will be a text + the c case, this will be a text codepage definition file such as the ones found in the Samba source/codepages directory. In - the d case this will be the + the d case, this will be the binary format codepage definition file normally found in the lib/codepages directory in the Samba install directory path. diff --git a/docs/docbook/manpages/nmbd.8.sgml b/docs/docbook/manpages/nmbd.8.sgml index d5c89064e7..2b8e066120 100644 --- a/docs/docbook/manpages/nmbd.8.sgml +++ b/docs/docbook/manpages/nmbd.8.sgml @@ -67,7 +67,7 @@ In addition, 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 + not understand how to talk the WINS protocol to a WINS server. @@ -99,7 +99,7 @@ If this parameter is specified it causes the server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell. Setting this - parameter negates the implicit deamon mode when run from the + parameter negates the implicit daemon mode when run from the command line. @@ -136,9 +136,9 @@ Samba as part of the build process. Common defaults are /usr/local/samba/lib/lmhosts, /usr/samba/lib/lmhosts or - /etc/lmhosts. See the - lmhosts(5) man page for details on the - contents of this file. + /etc/lmhosts. See the + lmhosts(5) + man page for details on the contents of this file. @@ -169,15 +169,15 @@ Note that specifying this parameter here will override the log level parameter in the - smb.conf file. + smb.conf(5) file. -l <log directory> The -l parameter specifies a directory into which the "log.nmbd" log file will be created - for operational data from the running - nmbd server. The default log directory is compiled into Samba + for operational data from the running nmbd + server. The default log directory is compiled into Samba as part of the build process. Common defaults are /usr/local/samba/var/log.nmb, /usr/samba/var/log.nmb or diff --git a/docs/docbook/manpages/pdbedit.8.sgml b/docs/docbook/manpages/pdbedit.8.sgml index 213275b7cc..45ccbaee64 100644 --- a/docs/docbook/manpages/pdbedit.8.sgml +++ b/docs/docbook/manpages/pdbedit.8.sgml @@ -41,11 +41,11 @@ Samba suite. The pdbedit program is used to manage the users accounts - stored in the sam database and can be run only by root. + stored in the sam database and can only be run by root. - The pdbedit tool use the passdb modular interface and is + The pdbedit tool uses the passdb modular interface and is independent from the kind of users database used (currently there - are smbpasswd, ldap, nis+ and tdb based and more can be addedd + are smbpasswd, ldap, nis+ and tdb based and more can be added without changing the tool). There are five main ways to use pdbedit: adding a user account, @@ -58,7 +58,7 @@ -l - This option list all the user accounts + This option lists all the user accounts present in the users database. This option prints a list of user/uid pairs separated by the ':' character. @@ -75,8 +75,8 @@ -v - This option sets the verbose listing format. - It will make pdbedit list the users in the database printing + This option enables the verbose listing format. + It causes pdbedit to list the users in the database, printing out the account fields in a descriptive format. Example: pdbedit -l -v @@ -108,7 +108,7 @@ -w This option sets the "smbpasswd" listing format. - It will make pdbedit list the users in the database printing + It will make pdbedit list the users in the database, printing out the account fields in a format compatible with the smbpasswd file format. (see the smbpasswd(5) for details) @@ -124,8 +124,8 @@ -u username - This option specifies that the username to be - used for the operation requested (listing, adding, removing) + This option specifies the username to be + used for the operation requested (listing, adding, removing). It is required in add, remove and modify operations and optional in list operations. @@ -198,9 +198,9 @@ -a This option is used to add a user into the - database. This command need the user name be specified with - the -u switch. When adding a new user pdbedit will also - ask for the password to be used + database. This command needs a user name specified with + the -u switch. When adding a new user, pdbedit will also + ask for the password to be used. Example: pdbedit -a -u sorce new password: @@ -227,7 +227,7 @@ -x This option causes pdbedit to delete an account - from the database. It need the username be specified with the + from the database. It needs a username specified with the -u switch. Example: pdbedit -x -u bob @@ -237,22 +237,25 @@ -i passdb-backend - Use a different passdb backend to retrieve users than the one specified in smb.conf. Can be used to import data into your - local user database. + Use a different passdb backend to retrieve users + than the one specified in smb.conf. Can be used to import data into + your local user database. - This option will ease migration from one passdb backend to another. - + This option will ease migration from one passdb backend to + another. - Example: pdbedit -i smbpasswd:/etc/smbpasswd.old - + Example: pdbedit -i smbpasswd:/etc/smbpasswd.old + -e passdb-backend - Export all currently available users to the specified password database backend. + Exports all currently available users to the + specified password database backend. - This option will ease migration from one passdb backend to another and will ease backupping + This option will ease migration from one passdb backend to + another and will ease backing up. Example: pdbedit -e smbpasswd:/root/samba-users.backup diff --git a/docs/docbook/manpages/rpcclient.1.sgml b/docs/docbook/manpages/rpcclient.1.sgml index f1ba474cfb..7a7a19c837 100644 --- a/docs/docbook/manpages/rpcclient.1.sgml +++ b/docs/docbook/manpages/rpcclient.1.sgml @@ -127,8 +127,8 @@ -l|--logfile=logbasename File name for log/debug files. The extension - '.client' will be appended. The log file is never removed - by the client. + '.client' will be appended. The log file is + never removed by the client. @@ -137,14 +137,15 @@ -N|--nopass instruct rpcclient not to ask - for a password. By default, rpcclient will prompt - for a password. See also the -U option. + for a password. By default, rpcclient will + prompt for a password. See also the -U + option. -s|--conf=smb.conf - Specifies the location of the all important + Specifies the location of the all-important smb.conf file. @@ -162,8 +163,8 @@ A third option is to use a credentials file which contains the plaintext of the username and password. This - option is mainly provided for scripts where the admin doesn't - desire to pass the credentials on the command line or via environment + option is mainly provided for scripts where the admin does not + wish to pass the credentials on the command line or via environment variables. If this method is used, make certain that the permissions on the file restrict access from unwanted users. See the -A for more details. @@ -203,7 +204,7 @@ of SIDs to usernames. - lookupnames - Resolve s list + lookupnames - Resolve a list of usernames to SIDs. @@ -290,7 +291,7 @@ enumjobs <printer> - - List the jobs and status of a given printer. + - List the jobs and status of a given printer. This command corresponds to the MS Platform SDK EnumJobs() function (* This command is currently unimplemented). @@ -339,7 +340,7 @@ getdriverdir <arch> - Execute a GetPrinterDriverDirectory() - RPC to retreive the SMB share name and subdirectory for + RPC to retrieve the SMB share name and subdirectory for storing printer driver files for a given architecture. Possible values for arch are "Windows 4.0" (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows @@ -359,10 +360,11 @@ against a given printer. - setdriver <printername> <drivername> - - Execute a SetPrinter() command to update the printer driver associated - with an installed printer. The printer driver must already be correctly - installed on the print server. + setdriver <printername> + <drivername> + - Execute a SetPrinter() command to update the printer driver + associated with an installed printer. The printer driver must + already be correctly installed on the print server. See also the enumprinters and enumdrivers commands for obtaining a list of @@ -374,8 +376,8 @@ GENERAL OPTIONS - debuglevel - Set the current debug level - used to log information. + debuglevel - Set the current + debug level used to log information. help (?) - Print a listing of all known commands or extended help on a particular command. diff --git a/docs/docbook/manpages/samba.7.sgml b/docs/docbook/manpages/samba.7.sgml index 5d81d9d446..ce443e78d9 100644 --- a/docs/docbook/manpages/samba.7.sgml +++ b/docs/docbook/manpages/samba.7.sgml @@ -22,8 +22,10 @@ The Samba software suite is a collection of programs that implements 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. + also referred to as the Common Internet File System (CIFS). For a + more thorough description, see + http://www.ubiqx.org/cifs/. Samba also implements the NetBIOS + protocol in nmbd. @@ -39,7 +41,7 @@ nmbd The nmbd - daemon provides NetBIOS nameserving and browsing + daemon provides NetBIOS nameservice and browsing support. The configuration file for this daemon is described in smb.conf @@ -68,7 +70,7 @@ testprns The testprns utility supports testing printer names defined - in your printcap> file used + in your printcap file used by Samba. @@ -115,12 +117,14 @@ 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 or - bug report to - samba@samba.org - - + manual pages and documents aren't clear enough then please visit + http://devel.samba.org + for information on how to file a bug report or submit a patch. + If you require help, visit the Samba webpage at + http://www.samba.org/ and + explore the many option available to you. + @@ -164,11 +168,10 @@ http://lists.samba.org. - If you have patches to submit or bugs to report - then you may mail them directly to samba-patches@samba.org. - Note, however, that due to the enormous popularity of this - package the Samba Team may take some time to respond to mail. We - prefer patches in diff -u format. + If you have patches to submit, visit + http://devel.samba.org/ + for information on how to do it properly. We prefer patches in + diff -u format. diff --git a/docs/docbook/manpages/smb.conf.5.sgml b/docs/docbook/manpages/smb.conf.5.sgml index 0c565e7e51..c0893f1005 100644 --- a/docs/docbook/manpages/smb.conf.5.sgml +++ b/docs/docbook/manpages/smb.conf.5.sgml @@ -2904,9 +2904,9 @@ system print command such as lpr(1) or lp(1). - This paramater does not accept % marcos, becouse + This paramater does not accept % macros, because many parts of the system require this value to be - constant for correct operation + constant for correct operation. Default: specified at compile time, usually "nobody" diff --git a/docs/docbook/manpages/smbcacls.1.sgml b/docs/docbook/manpages/smbcacls.1.sgml index 69aa967492..766d2a78b1 100644 --- a/docs/docbook/manpages/smbcacls.1.sgml +++ b/docs/docbook/manpages/smbcacls.1.sgml @@ -35,8 +35,8 @@ This tool is part of the Samba suite. - The smbcacls program manipulates NT Access Control Lists - (ACLs) on SMB file shares. + The smbcacls program manipulates NT Access Control + Lists (ACLs) on SMB file shares. @@ -79,7 +79,7 @@ -S acls This command sets the ACLs on the file with only the ones specified on the command line. All other ACLs are - erased. Note that the ACL specified must contain at least a revision, + erased. Note that the ACL specified must contain at least a revision, type, owner and group for the call to succeed. diff --git a/docs/docbook/manpages/smbcontrol.1.sgml b/docs/docbook/manpages/smbcontrol.1.sgml index 9a6f31b336..166ef63e87 100644 --- a/docs/docbook/manpages/smbcontrol.1.sgml +++ b/docs/docbook/manpages/smbcontrol.1.sgml @@ -121,7 +121,7 @@ The printnotify message-type sends a message to smbd which in turn sends a printer notify message to - any Windows NT clients connected to a printer. This message-type + any Windows NT clients connected to a printer. This message-type takes the following arguments: diff --git a/docs/docbook/manpages/smbgroupedit.8.sgml b/docs/docbook/manpages/smbgroupedit.8.sgml index b9607312ff..53bc0bec61 100644 --- a/docs/docbook/manpages/smbgroupedit.8.sgml +++ b/docs/docbook/manpages/smbgroupedit.8.sgml @@ -19,7 +19,7 @@ smbroupedit -v [l|s] - -a UNIX-groupname [-d NT-groupname|-p prividge| + -a UNIX-groupname [-d NT-groupname|-p privilege|] @@ -73,10 +73,10 @@ etc. For examples, Users - SID : S-1-5-32-545 + SID : S-1-5-32-545 Unix group: -1 Group type: Local group - Comment : + Comment : Privilege : No privilege @@ -195,7 +195,7 @@ Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> -1 -To verify that you mapping has taken effect: +To verify that your mapping has taken effect: diff --git a/docs/docbook/manpages/smbmount.8.sgml b/docs/docbook/manpages/smbmount.8.sgml index ec4dbbaff1..c4b91a5572 100644 --- a/docs/docbook/manpages/smbmount.8.sgml +++ b/docs/docbook/manpages/smbmount.8.sgml @@ -73,7 +73,7 @@ given. - Note that password which contain the arguement delimiter + Note that passwords which contain the argument delimiter character (i.e. a comma ',') will failed to be parsed correctly on the command line. However, the same password defined in the PASSWD environment variable or a credentials file (see @@ -222,7 +222,7 @@ ttl=<arg> - how long a directory listing is cached in milliseconds + sets how long a directory listing is cached in milliseconds (also affects visibility of file size and date changes). A higher value means that changes on the server take longer to be noticed but it can give diff --git a/docs/docbook/manpages/smbpasswd.8.sgml b/docs/docbook/manpages/smbpasswd.8.sgml index 3c7a6a5150..c0b7ac3359 100644 --- a/docs/docbook/manpages/smbpasswd.8.sgml +++ b/docs/docbook/manpages/smbpasswd.8.sgml @@ -24,7 +24,6 @@ -r <remote machine> -R <name resolve order> -m - -j DOMAIN -U username[%password] -h -s @@ -56,7 +55,7 @@ UNIX machine the encrypted SMB passwords are usually stored in the smbpasswd(5) file. - When run by an ordinary user with no options. smbpasswd + When run by an ordinary user with no options, smbpasswd will prompt them for their old SMB password and then ask them for their new password twice, to ensure that the new password was typed correctly. No passwords will be echoed on the screen @@ -89,7 +88,7 @@ password command. Note that the default passdb backends require the user to already exist in the system password file (usually /etc/passwd), else the request to add the - user will fail. + user will fail. This option is only available when running smbpasswd as root. @@ -220,12 +219,12 @@ -R name resolve order - This option allows the user of smbpasswd to determine + This option allows the user of smbpasswd to determine what name resolution services to use when looking up the NetBIOS name of the host being connected to. - The options are :"lmhosts", "host", "wins" and "bcast". They cause - names to be resolved as follows : + The options are :"lmhosts", "host", "wins" and "bcast". They + cause names to be resolved as follows : lmhosts : Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has @@ -244,14 +243,14 @@ wins : Query a name with the IP address listed in the wins server - parameter. If no WINS server has been specified this method - will be ignored. + parameter. If no WINS server has been specified this method + will be ignored. bcast : Do a broadcast on each of the known local interfaces listed in the interfaces parameter. This is the least - reliable of the name resolution methods as it depends on the - target host being on a locally connected subnet. + reliable of the name resolution methods as it depends on the + target host being on a locally connected subnet. The default order is lmhosts, host, wins, bcast @@ -267,7 +266,7 @@ being changed is a MACHINE account. Currently this is used when Samba is being used as an NT Primary Domain Controller. - This option is only available when running smbpasswd as root. + This option is only available when running smbpasswd as root. @@ -305,15 +304,15 @@ -w password - This parameter is only available is Samba - has been configured to use the experiemental + This parameter is only available if Samba + has been configured to use the experimental --with-ldapsam option. The -w switch is used to specify the password to be used with the ldap admin dn. Note that the password is stored in the private/secrets.tdb and is keyed off of the admin's DN. This means that if the value of ldap - admin dn ever changes, the password will beed to be + admin dn ever changes, the password will need to be manually updated as well. diff --git a/docs/docbook/manpages/smbspool.8.sgml b/docs/docbook/manpages/smbspool.8.sgml index d5c9c0a114..d164cb0864 100644 --- a/docs/docbook/manpages/smbspool.8.sgml +++ b/docs/docbook/manpages/smbspool.8.sgml @@ -9,7 +9,7 @@ smbspool - send print file to an SMB printer + send a print file to an SMB printer @@ -79,11 +79,11 @@ The copies argument (argv[4]) contains the number of copies to be printed of the named file. If - no filename is provided than this argument is not used by + no filename is provided then this argument is not used by smbspool. The options argument (argv[5]) contains - the print options in a single string and is presently + the print options in a single string and is currently not used by smbspool. The filename argument (argv[6]) contains the diff --git a/docs/docbook/manpages/smbtar.1.sgml b/docs/docbook/manpages/smbtar.1.sgml index d1585d7ca3..bd70493b6b 100644 --- a/docs/docbook/manpages/smbtar.1.sgml +++ b/docs/docbook/manpages/smbtar.1.sgml @@ -164,7 +164,7 @@ BUGS The smbtar script has different - options from ordinary tar and tar called from smbclient. + options from ordinary tar and from smbclient's tar command. @@ -173,7 +173,7 @@ Sites that are more careful about security may not like the way the script handles PC passwords. Backup and restore work - on entire shares, should work on file lists. smbtar works best + on entire shares; should work on file lists. smbtar works best with GNU tar and may not work well with other versions. diff --git a/docs/docbook/manpages/swat.8.sgml b/docs/docbook/manpages/swat.8.sgml index dc6989d566..c0052f3d53 100644 --- a/docs/docbook/manpages/swat.8.sgml +++ b/docs/docbook/manpages/swat.8.sgml @@ -62,7 +62,7 @@ swat in demo mode. In that mode anyone will be able to modify the smb.conf file. - Do NOT enable this option on a production + WARNING: Do NOT enable this option on a production server. @@ -168,7 +168,7 @@ swat will rewrite your smb.conf file. It will rearrange the entries and delete all - comments, include= and copy=" + comments, include= and copy= options. If you have a carefully crafted smb.conf then back it up or don't use swat! diff --git a/docs/docbook/manpages/winbindd.8.sgml b/docs/docbook/manpages/winbindd.8.sgml index 0325f9bfe1..32ea86b0d6 100644 --- a/docs/docbook/manpages/winbindd.8.sgml +++ b/docs/docbook/manpages/winbindd.8.sgml @@ -46,10 +46,10 @@ The pam_winbind module in the 2.2.2 release only supports the auth and account - module-types. The latter is simply + module-types. The latter simply performs a getpwnam() to verify that the system can obtain a uid for the user. If the libnss_winbind library has been correctly - installed, this should always suceed. + installed, this should always succeed. The following nsswitch databases are implemented by @@ -156,156 +156,26 @@ group: files winbind file. All parameters should be specified in the [global] section of smb.conf. - - - winbind separator - The winbind separator option allows you - to specify how NT domain names and user names are combined - into unix user names when presented to users. By default, - winbindd will use the traditional '\' - separator so that the unix user names look like - DOMAIN\username. In some cases this separator character may - cause problems as the '\' character has special meaning in - unix shells. In that case you can use the winbind separator - option to specify an alternative separator character. Good - alternatives may be '/' (although that conflicts - with the unix directory separator) or a '+ 'character. - The '+' character appears to be the best choice for 100% - compatibility with existing unix utilities, but may be an - aesthetically bad choice depending on your taste. - - Default: winbind separator = \ - - Example: winbind separator = + - - - - - winbind uid - The winbind uid parameter specifies the - range of user ids that are allocated by the winbindd daemon. - This range of ids should have no existing local or NIS users - within it as strange conflicts can occur otherwise. - - Default: winbind uid = <empty string> - - Example: winbind uid = 10000-20000 - - - - - - winbind gid - The winbind gid parameter specifies the - range of group ids that are allocated by the winbindd daemon. - This range of group ids should have no existing local or NIS - groups within it as strange conflicts can occur otherwise. - - Default: winbind gid = <empty string> - - Example: winbind gid = 10000-20000 - - - - - - winbind cache time - This parameter specifies the number of - seconds the winbindd daemon will cache user and group information - before querying a Windows NT server again. When a item in the - cache is older than this time winbindd will ask the domain - controller for the sequence number of the server's account database. - If the sequence number has not changed then the cached item is - marked as valid for a further winbind cache time - seconds. Otherwise the item is fetched from the - server. This means that as long as the account database is not - actively changing winbindd will only have to send one sequence - number query packet every winbind cache time - seconds. - - Default: winbind cache time = 15 - - - - - winbind enum users - On large installations it may be necessary - to suppress the enumeration of users through the - setpwent(), getpwent() and - endpwent() group of system calls. If - the winbind enum users parameter is false, - calls to the getpwent system call will not - return any data. - - Warning: Turning off user enumeration - may cause some programs to behave oddly. For example, the finger - program relies on having access to the full user list when - searching for matching usernames. - - Default: winbind enum users = yes - - - - - winbind enum groups - On large installations it may be necessary - to suppress the enumeration of groups through the - setgrent(), getgrent() and - endgrent() group of system calls. If - the winbind enum groups parameter is - false, calls to the getgrent() system - call will not return any data. - - Warning: Turning off group - enumeration may cause some programs to behave oddly. - - - Default: winbind enum groups = no - - - - - - - template homedir - When filling out the user information - for a Windows NT user, the winbindd daemon - uses this parameter to fill in the home directory for that user. - If the string %D is present it is - substituted with the user's Windows NT domain name. If the - string %U is present it is substituted - with the user's Windows NT user name. - - Default: template homedir = /home/%D/%U - - - - - - template shell - When filling out the user information for - a Windows NT user, the winbindd daemon - uses this parameter to fill in the shell for that user. - - - Default: template shell = /bin/false - - - - - winbind use default domain - This parameter specifies whether the winbindd - daemon should operate on users without domain component in their username. - Users without a domain component are treated as is part of the winbindd server's - own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail - function in a way much closer to the way they would in a native unix system. - - Default: winbind use default domain = <falseg> - - Example: winbind use default domain = true - - - + + + winbind separator + + winbind uid + + winbind gid + + winbind cache time + + winbind enum users + + winbind enum groups + + template homedir + + template shell + + winbind use default domain + -- cgit