From e5ae6d548ff3c11a1be5ce3509da278b09994a34 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Mon, 24 Mar 2003 14:14:10 +0000 Subject: Document common arguments with entities (This used to be commit adafcbb9af4a22db0fefb70966564d8591b5baed) --- docs/docbook/global.ent | 164 ++++++++++++++++++++++++++++++-- docs/docbook/manpages/nmbd.8.sgml | 98 ++----------------- docs/docbook/manpages/nmblookup.1.sgml | 54 ++--------- docs/docbook/manpages/pdbedit.8.sgml | 3 +- docs/docbook/manpages/profiles.1.sgml | 1 + docs/docbook/manpages/rpcclient.1.sgml | 87 +---------------- docs/docbook/manpages/smbcacls.1.sgml | 7 +- docs/docbook/manpages/smbclient.1.sgml | 167 ++------------------------------- docs/docbook/manpages/smbd.8.sgml | 64 +------------ docs/docbook/manpages/smbstatus.1.sgml | 26 ++--- docs/docbook/manpages/smbtree.1.sgml | 2 + docs/docbook/manpages/swat.8.sgml | 11 ++- docs/docbook/manpages/testparm.1.sgml | 14 ++- docs/docbook/manpages/vfstest.1.sgml | 3 +- docs/docbook/manpages/wbinfo.1.sgml | 6 +- docs/docbook/manpages/winbindd.8.sgml | 20 ++-- 16 files changed, 220 insertions(+), 507 deletions(-) (limited to 'docs') diff --git a/docs/docbook/global.ent b/docs/docbook/global.ent index 46745c2773..a3022ecfaa 100644 --- a/docs/docbook/global.ent +++ b/docs/docbook/global.ent @@ -31,7 +31,7 @@ - -d|--debug=debuglevel @@ -59,13 +59,6 @@ level parameter in the '> - --h|--help -Print a summary of command line options. - -'> - -s <configuration file> @@ -82,7 +75,160 @@ compile time. --v +-V Prints the version number for smbd. '> + + +-l|--logfile=logbasename +File name for log/debug files. The extension +".client" will be appended. The log file is +never removed by the client. + +'> + + + + +-n <primary NetBIOS name> +This option allows you to override +the NetBIOS name that Samba uses for itself. This is identical +to setting the NetBIOS +name parameter in the smb.conf +5 file. However, a command +line setting will take precedence over settings in +smb.conf +5. +'> + + + + +-i <scope> +This specifies a NetBIOS scope that +nmblookup 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 +very rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with. +'> + + +-W|--workgroup=domain +Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM). +'> + + +-O socket options +TCP socket options to set on the client +socket. See the socket options parameter in +the smb.conf +5 manual page for the list of valid +options. + +'> + + + + +-N +If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. + +Unless a password is specified on the command line or +this parameter is specified, the client will request a +password. +'> + + +-U|--user=username[&%;password] +Sets the SMB username or username and password. + +If &%;password is not specified, the user will be prompted. The +client will first check the USER environment variable, then the +LOGNAME variable and if either exists, the +string is uppercased. If these environmental variables are not +found, the username GUEST is used. + +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 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. + +Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the ps command. To be safe always allow +rpcclient to prompt for a password and type +it in directly. + +'> + + +-A|--authfile=filename +This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is + + + +username = <value> +password = <value> +domain = <value> + + +Make certain that the permissions on the file restrict +access from unwanted users. +'> + + +-k + +Try to authenticate with kerberos. Only useful in +an Active Directory environment. + + +'> + + + +-h|--help +Print a summary of command line options. + +'> + + diff --git a/docs/docbook/manpages/nmbd.8.sgml b/docs/docbook/manpages/nmbd.8.sgml index 6c7ecce4e9..5f359ff099 100644 --- a/docs/docbook/manpages/nmbd.8.sgml +++ b/docs/docbook/manpages/nmbd.8.sgml @@ -1,4 +1,6 @@ - + %globalentities; +]> @@ -111,13 +113,6 @@ than a file. - - -a - If this parameter is specified, each new - connection will append log messages to the log file. - This is the default. - - -i If this parameter is specified it causes the @@ -129,19 +124,7 @@ given. - - -o - If this parameter is specified, the - log files will be overwritten when opened. By default, - smbd will append entries to the log - files. - - - - -h - Prints the help information (usage) - for nmbd. - + &stdarg.help; -H <filename> @@ -165,66 +148,9 @@ 5 man page for details on the contents of this file. - - -V - Prints the version number for - nmbd. - + &popt.common.samba; + &popt.common.connection; - - -d <debug level> - debuglevel is an integer - from 0 to 10. The default value if this parameter is - not specified is zero. - - The higher this value, the more detail will - be logged to the log files about the activities of the - server. At level 0, only critical errors and serious - warnings will be logged. Level 1 is a reasonable level for - day to day running - it generates a small amount of - information about operations carried out. - - Levels above 1 will generate considerable amounts - of log data, and should only be used when investigating - a problem. Levels above 3 are designed for use only by developers - and generate HUGE amounts of log data, most of which is extremely - cryptic. - - Note that specifying this parameter here will override - the log level - parameter in the 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 - as part of the build process. Common defaults are - /usr/local/samba/var/log.nmb, - /usr/samba/var/log.nmb or - /var/log/log.nmb. Beware: - If the directory specified does not exist, nmbd - will log to the default debug log location defined at compile time. - - - - - - -n <primary NetBIOS name> - This option allows you to override - the NetBIOS name that Samba uses for itself. This is identical - to setting the NetBIOS - name parameter in the smb.conf - 5 file. However, a command - line setting will take precedence over settings in - smb.conf - 5. - - - -p <UDP port number> UDP port number is a positive integer value. @@ -234,18 +160,6 @@ won't need help! - - -s <configuration file> - The default configuration file name - is set at build time, typically as - /usr/local/samba/lib/smb.conf, but - this may be changed when Samba is autoconfigured. - - The file specified contains the configuration details - required by the server. See smb.conf - 5 for more information. - - diff --git a/docs/docbook/manpages/nmblookup.1.sgml b/docs/docbook/manpages/nmblookup.1.sgml index 7dd7f105d7..176050b9c8 100644 --- a/docs/docbook/manpages/nmblookup.1.sgml +++ b/docs/docbook/manpages/nmblookup.1.sgml @@ -1,4 +1,6 @@ - + %globalentities; +]> @@ -101,12 +103,8 @@ - - -h - Print a help (usage) message. - - - + &popt.common.connection; + &stdarg.help; -B <broadcast address> @@ -131,48 +129,8 @@ - - -d <debuglevel> - debuglevel is an integer from 0 to 10. + &popt.common.samba; - The default value if this parameter is not specified - is zero. - - The higher this value, the more detail will be logged - about the activities of nmblookup. At level - 0, only critical errors and serious warnings will be logged. - - Levels above 1 will generate considerable amounts of - log data, and should only be used when investigating a problem. - Levels above 3 are designed for use only by developers and - generate HUGE amounts of data, most of which is extremely cryptic. - - Note that specifying this parameter here will override - the - log level parameter in the - smb.conf(5) file. - - - - -s <smb.conf> - This parameter specifies the pathname to - the Samba configuration file, - smb.conf(5). This file controls all aspects of - the Samba setup on the machine. - - - - -i <scope> - This specifies a NetBIOS scope that - nmblookup 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 - very rarely used, only set this parameter - if you are the system administrator in charge of all the - NetBIOS systems you communicate with. - - - -T This causes any IP addresses found in the diff --git a/docs/docbook/manpages/pdbedit.8.sgml b/docs/docbook/manpages/pdbedit.8.sgml index 113f23f9c4..fc9a212c19 100644 --- a/docs/docbook/manpages/pdbedit.8.sgml +++ b/docs/docbook/manpages/pdbedit.8.sgml @@ -327,9 +327,8 @@ account policy value for bad lockout attempt is now 3 - &stdarg.debuglevel; &stdarg.help; - &stdarg.configfile; + &popt.common.samba; diff --git a/docs/docbook/manpages/profiles.1.sgml b/docs/docbook/manpages/profiles.1.sgml index 0d18c42c82..6ec8055c28 100644 --- a/docs/docbook/manpages/profiles.1.sgml +++ b/docs/docbook/manpages/profiles.1.sgml @@ -54,6 +54,7 @@ + &stdarg.help; diff --git a/docs/docbook/manpages/rpcclient.1.sgml b/docs/docbook/manpages/rpcclient.1.sgml index 933938d438..225bb064ff 100644 --- a/docs/docbook/manpages/rpcclient.1.sgml +++ b/docs/docbook/manpages/rpcclient.1.sgml @@ -61,33 +61,12 @@ - - -A|--authfile=filename - This option allows - you to specify a file from which to read the username and - password used in the connection. The format of the file is - - - -username = <value> -password = <value> -domain = <value> - - - Make certain that the permissions on the file restrict - access from unwanted users. - - - - -c|--command='command string' execute semicolon separated commands (listed below)) - &stdarg.help; - &stdarg.debuglevel; -I IP-address @@ -107,68 +86,10 @@ domain = <value> above. - - - -l|--logfile=logbasename - File name for log/debug files. The extension - '.client' will be appended. The log file is - never removed by the client. - - - - - - - -N|--nopass - instruct rpcclient not to ask - 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 - smb.conf file. - - - - - - -U|--user=username[%password] - Sets the SMB username or username and password. - - If %password is not specified, the user will be prompted. The - client will first check the USER environment variable, then the - LOGNAME variable and if either exists, the - string is uppercased. If these environmental variables are not - found, the username GUEST is used. - - 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 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. - - Be cautious about including passwords in scripts. Also, on - many systems the command line of a running process may be seen - via the ps command. To be safe always allow - rpcclient to prompt for a password and type - it in directly. - - - - -W|--workgroup=domain - Set the SMB domain of the username. This - overrides the default domain which is the domain defined in - smb.conf. If the domain specified is the same as the server's NetBIOS name, - it causes the client to log on using the server's local SAM (as - opposed to the Domain SAM). - - + &popt.common.samba; + &popt.common.credentials; + &popt.common.connection; + &stdarg.help; diff --git a/docs/docbook/manpages/smbcacls.1.sgml b/docs/docbook/manpages/smbcacls.1.sgml index 4482019669..03fcbd6fd8 100644 --- a/docs/docbook/manpages/smbcacls.1.sgml +++ b/docs/docbook/manpages/smbcacls.1.sgml @@ -141,11 +141,8 @@ - - -h - Print usage information on the smbcacls - program. - + &stdarg.help; + &popt.common.samba.small; diff --git a/docs/docbook/manpages/smbclient.1.sgml b/docs/docbook/manpages/smbclient.1.sgml index a08f6999e4..cd513398b9 100644 --- a/docs/docbook/manpages/smbclient.1.sgml +++ b/docs/docbook/manpages/smbclient.1.sgml @@ -1,4 +1,6 @@ - + %globalentities; +]> @@ -115,23 +117,6 @@ - - -s smb.conf - Specifies the location of the all - important smb.conf - 5 file. - - - - -O socket options - TCP socket options to set on the client - socket. See the socket options parameter in - the smb.conf - 5 manual page for the list of valid - options. - - - -R <name resolve order> This option is used by the programs in the Samba @@ -224,70 +209,6 @@ messages. - - -i scope - This specifies a NetBIOS scope that smbclient 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 very rarely used, only set - this parameter if you are the system administrator in charge of all - the NetBIOS systems you communicate with. - - - - - -N - If specified, this parameter suppresses the normal - password prompt from the client to the user. This is useful when - accessing a service that does not require a password. - - Unless a password is specified on the command line or - this parameter is specified, the client will request a - password. - - - - - - -n NetBIOS name - By default, the client will use the local - machine's hostname (in uppercase) as its NetBIOS name. This parameter - allows you to override the host name and use whatever NetBIOS - name you wish. - - - - - -d debuglevel - debuglevel is an integer from 0 to 10, or - the letter 'A'. - - The default value if this parameter is not specified - is zero. - - The higher this value, the more detail will be logged to - the log files about the activities of the - client. At level 0, only critical errors and serious warnings will - be logged. Level 1 is a reasonable level for day to day running - - it generates a small amount of information about operations - carried out. - - Levels above 1 will generate considerable amounts of log - data, and should only be used when investigating a problem. - Levels above 3 are designed for use only by developers and - generate HUGE amounts of log data, most of which is extremely - cryptic. If debuglevel is set to the letter 'A', then all - debug messages will be printed. This setting - is for developers only (and people who really want - to know how the code works internally). - - Note that specifying this parameter here will override - the log level parameter in the smb.conf (5) - file. - - - -p port This number is the TCP port number that will be used @@ -314,13 +235,7 @@ - - - -h - Print the usage message for the client. - - - + &stdarg.help; -I IP-address @@ -353,59 +268,6 @@ - - -U username[%pass] - Sets the SMB username or username and password. - If %pass is not specified, The user will be prompted. The client - will first check the USER environment variable, then the - LOGNAME variable and if either exists, the - string is uppercased. Anything in these variables following a '%' - sign will be treated as the password. If these environment - variables are not found, the username GUEST - is used. - - If the password is not included in these environment - variables (using the %pass syntax), smbclient will look for - a PASSWD environment variable from which - to read the password. - - A third option is to use a credentials file which - contains the plaintext of the domain name, username and password. This - option is mainly provided for scripts where the admin doesn't - 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. - - Be cautious about including passwords in scripts or in - the PASSWD environment variable. Also, on - many systems the command line of a running process may be seen - via the ps command to be safe always allow - smbclient to prompt for a password and type - it in directly. - - - - - -A filenameThis option allows - you to specify a file from which to read the username, domain name, and - password used in the connection. The format of the file is - - - -username = <value> -password = <value> -domain = <value> - - - - If the domain parameter is missing the current workgroup name - is used instead. Make certain that the permissions on the file restrict - access from unwanted users. - - - - -L This option allows you to look at what services @@ -443,16 +305,9 @@ domain = <value> - - - - -W WORKGROUP - Override the default workgroup (domain) specified - in the workgroup parameter of the smb.conf - 5 file for this connection. This may be - needed to connect to some servers. - - + &popt.common.samba; + &popt.common.credentials; + &popt.common.connection; -T tar options @@ -588,14 +443,6 @@ domain = <value> This is particularly useful in scripts and for printing stdin to the server, e.g. -c 'print -'. - - - -k - - Try to authenticate with kerberos. Only useful in - an Active Directory environment. - - diff --git a/docs/docbook/manpages/smbd.8.sgml b/docs/docbook/manpages/smbd.8.sgml index 32837ba903..b31d919a12 100644 --- a/docs/docbook/manpages/smbd.8.sgml +++ b/docs/docbook/manpages/smbd.8.sgml @@ -1,4 +1,6 @@ - + %globalentities; +]> @@ -122,17 +124,8 @@ - - -h - Prints the help information (usage) - for smbd. - - - - -V - Prints the version number for - smbd. - + &popt.common.samba; + &stdarg.help; -b @@ -140,32 +133,6 @@ Samba was built. - - -d <debug level> - debuglevel is an integer - from 0 to 10. The default value if this parameter is - not specified is zero. - - The higher this value, the more detail will be - logged to the log files about the activities of the - server. At level 0, only critical errors and serious - warnings will be logged. Level 1 is a reasonable level for - day to day running - it generates a small amount of - information about operations carried out. - - Levels above 1 will generate considerable - amounts of log data, and should only be used when - investigating a problem. Levels above 3 are designed for - use only by developers and generate HUGE amounts of log - data, most of which is extremely cryptic. - - Note that specifying this parameter here will - override the log - level parameter in the smb.conf - 5 file. - - - -l <log directory> If specified, @@ -186,14 +153,6 @@ compile time. - - -O <socket options> - See the socket options - parameter in the smb.conf - 5 file for details. - - -p <port number> port number is a positive integer @@ -218,19 +177,6 @@ This parameter is not normally specified except in the above situation. - - - -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 smb.conf - 5 for more information. - The default configuration file name is determined at - compile time. - diff --git a/docs/docbook/manpages/smbstatus.1.sgml b/docs/docbook/manpages/smbstatus.1.sgml index 67d39f2586..98f7e864f6 100644 --- a/docs/docbook/manpages/smbstatus.1.sgml +++ b/docs/docbook/manpages/smbstatus.1.sgml @@ -1,4 +1,7 @@ - + %globalentities; +]> + @@ -54,13 +57,7 @@ gives brief output. - - - -d|--debug=<debuglevel> - sets debugging to specified level - - - + &popt.common.samba; -v|--verbose @@ -96,18 +93,7 @@ - - - - -s|--conf=<configuration file> - The default configuration file name is - determined at compile time. The file specified contains the - configuration details required by the server. See - smb.conf5 - for more information. - - - + &stdarg.help; -u|--user=<username> diff --git a/docs/docbook/manpages/smbtree.1.sgml b/docs/docbook/manpages/smbtree.1.sgml index ce664908bc..3677695d5a 100644 --- a/docs/docbook/manpages/smbtree.1.sgml +++ b/docs/docbook/manpages/smbtree.1.sgml @@ -65,6 +65,8 @@ + &popt.common.samba; + &popt.common.credentials; &stdarg.help; diff --git a/docs/docbook/manpages/swat.8.sgml b/docs/docbook/manpages/swat.8.sgml index a13ba9ff6c..72b3cd65c8 100644 --- a/docs/docbook/manpages/swat.8.sgml +++ b/docs/docbook/manpages/swat.8.sgml @@ -1,4 +1,6 @@ - + %globalentities; +]> @@ -67,10 +69,9 @@ server. - - -V - Print version number of samba suite - + &popt.common.samba; + &stdarg.help; + diff --git a/docs/docbook/manpages/testparm.1.sgml b/docs/docbook/manpages/testparm.1.sgml index ec8092a926..31a9549416 100644 --- a/docs/docbook/manpages/testparm.1.sgml +++ b/docs/docbook/manpages/testparm.1.sgml @@ -1,4 +1,6 @@ - + %globalentities; +]> @@ -65,13 +67,9 @@ will prompt for a carriage return after printing the service names and before dumping the service definitions. - - - - -h - Print usage message - - + + &stdarg.help; + &stdarg.version; -L servername diff --git a/docs/docbook/manpages/vfstest.1.sgml b/docs/docbook/manpages/vfstest.1.sgml index c89035d814..8be9271679 100644 --- a/docs/docbook/manpages/vfstest.1.sgml +++ b/docs/docbook/manpages/vfstest.1.sgml @@ -50,7 +50,6 @@ - &stdarg.debuglevel; &stdarg.help; @@ -61,6 +60,8 @@ + &popt.common.samba; + diff --git a/docs/docbook/manpages/wbinfo.1.sgml b/docs/docbook/manpages/wbinfo.1.sgml index 3c7ae11e2c..2e9a811bcb 100644 --- a/docs/docbook/manpages/wbinfo.1.sgml +++ b/docs/docbook/manpages/wbinfo.1.sgml @@ -1,4 +1,6 @@ - + %globalentities; +]> @@ -226,6 +228,8 @@ + &stdarg.version; + &stdarg.help; diff --git a/docs/docbook/manpages/winbindd.8.sgml b/docs/docbook/manpages/winbindd.8.sgml index a44e195d8c..cae8eb4105 100644 --- a/docs/docbook/manpages/winbindd.8.sgml +++ b/docs/docbook/manpages/winbindd.8.sgml @@ -1,4 +1,6 @@ - + %globalentities; +]> @@ -128,13 +130,9 @@ group: files winbind than a file. - - -d debuglevel - Sets the debuglevel to an integer between - 0 and 100. 0 is for no debugging and 100 is for reams and - reams. To submit a bug report to the Samba Team, use debug - level 100 (see BUGS.txt). - + &popt.common.samba; + &popt.common.connection; + &stdarg.help; -i @@ -168,12 +166,6 @@ group: files winbind - - -s|--conf=smb.conf - Specifies the location of the all-important - smb.conf - 5 file. - -- cgit