summaryrefslogtreecommitdiff
path: root/docs/docbook
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2003-03-24 14:14:10 +0000
committerJelmer Vernooij <jelmer@samba.org>2003-03-24 14:14:10 +0000
commite5ae6d548ff3c11a1be5ce3509da278b09994a34 (patch)
treea029925c7ca8a04c269beb6e73c2d9afd7d7170d /docs/docbook
parent9ae249c6f10d3d548a6f1f19b34acf27e237f638 (diff)
downloadsamba-e5ae6d548ff3c11a1be5ce3509da278b09994a34.tar.gz
samba-e5ae6d548ff3c11a1be5ce3509da278b09994a34.tar.bz2
samba-e5ae6d548ff3c11a1be5ce3509da278b09994a34.zip
Document common arguments with entities
(This used to be commit adafcbb9af4a22db0fefb70966564d8591b5baed)
Diffstat (limited to 'docs/docbook')
-rw-r--r--docs/docbook/global.ent164
-rw-r--r--docs/docbook/manpages/nmbd.8.sgml98
-rw-r--r--docs/docbook/manpages/nmblookup.1.sgml54
-rw-r--r--docs/docbook/manpages/pdbedit.8.sgml3
-rw-r--r--docs/docbook/manpages/profiles.1.sgml1
-rw-r--r--docs/docbook/manpages/rpcclient.1.sgml87
-rw-r--r--docs/docbook/manpages/smbcacls.1.sgml7
-rw-r--r--docs/docbook/manpages/smbclient.1.sgml167
-rw-r--r--docs/docbook/manpages/smbd.8.sgml64
-rw-r--r--docs/docbook/manpages/smbstatus.1.sgml26
-rw-r--r--docs/docbook/manpages/smbtree.1.sgml2
-rw-r--r--docs/docbook/manpages/swat.8.sgml11
-rw-r--r--docs/docbook/manpages/testparm.1.sgml14
-rw-r--r--docs/docbook/manpages/vfstest.1.sgml3
-rw-r--r--docs/docbook/manpages/wbinfo.1.sgml6
-rw-r--r--docs/docbook/manpages/winbindd.8.sgml20
16 files changed, 220 insertions, 507 deletions
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 @@
<!-- Misc -->
<!ENTITY samba.pub.cvshost 'pserver.samba.org'>
-<!ENTITY stdarg.debuglevel '
+<!ENTITY stdarg.debug '
<varlistentry>
<term>-d|--debug=debuglevel</term>
<listitem>
@@ -59,13 +59,6 @@ level</ulink> parameter in the <ulink url="smb.conf.5.html">
</listitem>
</varlistentry>'>
-<!ENTITY stdarg.help '
-<varlistentry>
-<term>-h|--help</term>
-<listitem><para>Print a summary of command line options.
-</para></listitem>
-</varlistentry>'>
-
<!ENTITY stdarg.configfile '
<varlistentry>
<term>-s &lt;configuration file&gt;</term>
@@ -82,7 +75,160 @@ compile time.</para></listitem>
<!ENTITY stdarg.version '
<varlistentry>
-<term>-v</term>
+<term>-V</term>
<listitem><para>Prints the version number for
<command>smbd</command>.</para></listitem>
</varlistentry>'>
+
+<!ENTITY stdarg.logfile '
+<varlistentry>
+<term>-l|--logfile=logbasename</term>
+<listitem><para>File name for log/debug files. The extension
+<constant>".client"</constant> will be appended. The log file is
+never removed by the client.
+</para></listitem>
+</varlistentry>'>
+
+<!ENTITY popt.common.samba '
+&stdarg.version;
+&stdarg.configfile;
+&stdarg.debug;
+&stdarg.logfile;
+'>
+
+<!ENTITY stdarg.netbios.name '
+<varlistentry>
+<term>-n &lt;primary NetBIOS name&gt;</term>
+<listitem><para>This option allows you to override
+the NetBIOS name that Samba uses for itself. This is identical
+to setting the <ulink url="smb.conf.5.html#netbiosname"><parameter>NetBIOS
+name</parameter></ulink> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
+<manvolnum>5</manvolnum></citerefentry> file. However, a command
+line setting will take precedence over settings in
+<citerefentry><refentrytitle>smb.conf</refentrytitle>
+<manvolnum>5</manvolnum></citerefentry>.</para></listitem>
+</varlistentry>'>
+
+
+
+<!ENTITY stdarg.scope '
+<varlistentry>
+<term>-i &lt;scope&gt;</term>
+<listitem><para>This specifies a NetBIOS scope that
+<command>nmblookup</command> 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
+<emphasis>very</emphasis> rarely used, only set this parameter
+if you are the system administrator in charge of all the
+NetBIOS systems you communicate with.</para></listitem>
+</varlistentry>'>
+
+<!ENTITY stdarg.workgroup '
+<varlistentry>
+<term>-W|--workgroup=domain</term>
+<listitem><para>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). </para></listitem>
+</varlistentry>'>
+
+<!ENTITY stdarg.socket.options '
+<varlistentry>
+<term>-O socket options</term>
+<listitem><para>TCP socket options to set on the client
+socket. See the socket options parameter in
+the <citerefentry><refentrytitle>smb.conf</refentrytitle>
+<manvolnum>5</manvolnum></citerefentry> manual page for the list of valid
+options. </para></listitem>
+</varlistentry>
+'>
+
+<!ENTITY popt.common.connection '
+&stdarg.netbios.name;
+&stdarg.scope;
+&stdarg.workgroup;
+&stdarg.socket.options;
+'>
+
+<!ENTITY stdarg.nopass '
+<varlistentry>
+<term>-N</term>
+<listitem><para>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. </para>
+
+<para>Unless a password is specified on the command line or
+this parameter is specified, the client will request a
+password.</para></listitem>
+</varlistentry>'>
+
+<!ENTITY stdarg.username '
+<varlistentry>
+<term>-U|--user=username[&%;password]</term>
+<listitem><para>Sets the SMB username or username and password. </para>
+
+<para>If &%;password is not specified, the user will be prompted. The
+client will first check the <envar>USER</envar> environment variable, then the
+<envar>LOGNAME</envar> variable and if either exists, the
+string is uppercased. If these environmental variables are not
+found, the username <constant>GUEST</constant> is used. </para>
+
+<para>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
+<parameter>-A</parameter> for more details. </para>
+
+<para>Be cautious about including passwords in scripts. Also, on
+many systems the command line of a running process may be seen
+via the <command>ps</command> command. To be safe always allow
+<command>rpcclient</command> to prompt for a password and type
+it in directly. </para></listitem>
+</varlistentry>
+'>
+
+<!ENTITY stdarg.authfile '
+<varlistentry>
+<term>-A|--authfile=filename</term>
+<listitem><para>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
+</para>
+
+<para><programlisting>
+username = &lt;value&gt;
+password = &lt;value&gt;
+domain = &lt;value&gt;
+</programlisting></para>
+
+<para>Make certain that the permissions on the file restrict
+access from unwanted users. </para></listitem>
+</varlistentry>'>
+
+<!ENTITY stdarg.kerberos '
+<varlistentry>
+<term>-k</term>
+<listitem><para>
+Try to authenticate with kerberos. Only useful in
+an Active Directory environment.
+</para></listitem>
+</varlistentry>
+'>
+
+
+<!ENTITY stdarg.help '
+<varlistentry>
+<term>-h|--help</term>
+<listitem><para>Print a summary of command line options.
+</para></listitem>
+</varlistentry>'>
+
+<!ENTITY popt.common.credentials '
+&stdarg.nopass;
+&stdarg.kerberos;
+&stdarg.authfile;
+&stdarg.username;
+'>
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 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
<refentry id="nmbd.8">
<refmeta>
@@ -112,13 +114,6 @@
</varlistentry>
<varlistentry>
- <term>-a</term>
- <listitem><para>If this parameter is specified, each new
- connection will append log messages to the log file.
- This is the default.</para></listitem>
- </varlistentry>
-
- <varlistentry>
<term>-i</term>
<listitem><para>If this parameter is specified it causes the
server to run "interactively", not as a daemon, even if the
@@ -129,19 +124,7 @@
given. </para></listitem>
</varlistentry>
- <varlistentry>
- <term>-o</term>
- <listitem><para>If this parameter is specified, the
- log files will be overwritten when opened. By default,
- <command>smbd</command> will append entries to the log
- files.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-h</term>
- <listitem><para>Prints the help information (usage)
- for <command>nmbd</command>.</para></listitem>
- </varlistentry>
+ &stdarg.help;
<varlistentry>
<term>-H &lt;filename&gt;</term>
@@ -165,67 +148,10 @@
<manvolnum>5</manvolnum></citerefentry> man page for details on the contents of this file.</para></listitem>
</varlistentry>
- <varlistentry>
- <term>-V</term>
- <listitem><para>Prints the version number for
- <command>nmbd</command>.</para></listitem>
- </varlistentry>
+ &popt.common.samba;
+ &popt.common.connection;
<varlistentry>
- <term>-d &lt;debug level&gt;</term>
- <listitem><para>debuglevel is an integer
- from 0 to 10. The default value if this parameter is
- not specified is zero.</para>
-
- <para>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.</para>
-
- <para>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.</para>
-
- <para>Note that specifying this parameter here will override
- the <ulink url="smb.conf.5.html#loglevel"><parameter>log level</parameter></ulink>
- parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry> file.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-l &lt;log directory&gt;</term>
- <listitem><para>The -l parameter specifies a directory
- into which the "log.nmbd" log file will be created
- for operational data from the running <command>nmbd</command>
- server. The default log directory is compiled into Samba
- as part of the build process. Common defaults are <filename>
- /usr/local/samba/var/log.nmb</filename>, <filename>
- /usr/samba/var/log.nmb</filename> or
- <filename>/var/log/log.nmb</filename>. <emphasis>Beware:</emphasis>
- If the directory specified does not exist, <command>nmbd</command>
- will log to the default debug log location defined at compile time.
- </para></listitem>
- </varlistentry>
-
-
- <varlistentry>
- <term>-n &lt;primary NetBIOS name&gt;</term>
- <listitem><para>This option allows you to override
- the NetBIOS name that Samba uses for itself. This is identical
- to setting the <ulink url="smb.conf.5.html#netbiosname"><parameter>NetBIOS
- name</parameter></ulink> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry> file. However, a command
- line setting will take precedence over settings in
- <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry>.</para></listitem>
- </varlistentry>
-
-
- <varlistentry>
<term>-p &lt;UDP port number&gt;</term>
<listitem><para>UDP port number is a positive integer value.
This option changes the default UDP port number (normally 137)
@@ -234,18 +160,6 @@
won't need help!</para></listitem>
</varlistentry>
- <varlistentry>
- <term>-s &lt;configuration file&gt;</term>
- <listitem><para>The default configuration file name
- is set at build time, typically as <filename>
- /usr/local/samba/lib/smb.conf</filename>, but
- this may be changed when Samba is autoconfigured.</para>
-
- <para>The file specified contains the configuration details
- required by the server. See <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry> for more information.
- </para></listitem>
- </varlistentry>
</variablelist>
</refsect1>
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 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
<refentry id="nmblookup">
<refmeta>
@@ -101,12 +103,8 @@
- <varlistentry>
- <term>-h</term>
- <listitem><para>Print a help (usage) message.</para></listitem>
- </varlistentry>
-
-
+ &popt.common.connection;
+ &stdarg.help;
<varlistentry>
<term>-B &lt;broadcast address&gt;</term>
@@ -131,48 +129,8 @@
</varlistentry>
- <varlistentry>
- <term>-d &lt;debuglevel&gt;</term>
- <listitem><para>debuglevel is an integer from 0 to 10.</para>
+ &popt.common.samba;
- <para>The default value if this parameter is not specified
- is zero.</para>
-
- <para>The higher this value, the more detail will be logged
- about the activities of <command>nmblookup</command>. At level
- 0, only critical errors and serious warnings will be logged.</para>
-
- <para>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.</para>
-
- <para>Note that specifying this parameter here will override
- the <ulink url="smb.conf.5.html#LOGLEVEL"><parameter>
- log level</parameter></ulink> parameter in the <filename>
- smb.conf(5)</filename> file.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-s &lt;smb.conf&gt;</term>
- <listitem><para>This parameter specifies the pathname to
- the Samba configuration file, <ulink url="smb.conf.5.html">
- smb.conf(5)</ulink>. This file controls all aspects of
- the Samba setup on the machine.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-i &lt;scope&gt;</term>
- <listitem><para>This specifies a NetBIOS scope that
- <command>nmblookup</command> 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
- <emphasis>very</emphasis> rarely used, only set this parameter
- if you are the system administrator in charge of all the
- NetBIOS systems you communicate with.</para></listitem>
- </varlistentry>
-
-
<varlistentry>
<term>-T</term>
<listitem><para>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
</listitem>
</varlistentry>
- &stdarg.debuglevel;
&stdarg.help;
- &stdarg.configfile;
+ &popt.common.samba;
</variablelist>
</refsect1>
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 @@
</para></listitem>
</varlistentry>
+ &stdarg.help;
<varlistentry>
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
@@ -62,32 +62,11 @@
<varlistentry>
- <term>-A|--authfile=filename</term>
- <listitem><para>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
- </para>
-
-<para><programlisting>
-username = &lt;value&gt;
-password = &lt;value&gt;
-domain = &lt;value&gt;
-</programlisting></para>
-
- <para>Make certain that the permissions on the file restrict
- access from unwanted users. </para></listitem>
- </varlistentry>
-
-
-
- <varlistentry>
<term>-c|--command='command string'</term>
<listitem><para>execute semicolon separated commands (listed
below)) </para></listitem>
</varlistentry>
- &stdarg.help;
- &stdarg.debuglevel;
<varlistentry>
<term>-I IP-address</term>
@@ -107,68 +86,10 @@ domain = &lt;value&gt;
above. </para></listitem>
</varlistentry>
-
- <varlistentry>
- <term>-l|--logfile=logbasename</term>
- <listitem><para>File name for log/debug files. The extension
- <constant>'.client'</constant> will be appended. The log file is
- never removed by the client.
- </para></listitem>
- </varlistentry>
-
-
-
- <varlistentry>
- <term>-N|--nopass</term>
- <listitem><para>instruct <command>rpcclient</command> not to ask
- for a password. By default, <command>rpcclient</command> will
- prompt for a password. See also the <parameter>-U</parameter>
- option.</para></listitem>
- </varlistentry>
-
-
- <varlistentry>
- <term>-s|--conf=smb.conf</term>
- <listitem><para>Specifies the location of the all-important
- <filename>smb.conf</filename> file. </para></listitem>
- </varlistentry>
-
-
-
- <varlistentry>
- <term>-U|--user=username[%password]</term>
- <listitem><para>Sets the SMB username or username and password. </para>
-
- <para>If %password is not specified, the user will be prompted. The
- client will first check the <envar>USER</envar> environment variable, then the
- <envar>LOGNAME</envar> variable and if either exists, the
- string is uppercased. If these environmental variables are not
- found, the username <constant>GUEST</constant> is used. </para>
-
- <para>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
- <parameter>-A</parameter> for more details. </para>
-
- <para>Be cautious about including passwords in scripts. Also, on
- many systems the command line of a running process may be seen
- via the <command>ps</command> command. To be safe always allow
- <command>rpcclient</command> to prompt for a password and type
- it in directly. </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-W|--workgroup=domain</term>
- <listitem><para>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). </para></listitem>
- </varlistentry>
-
+ &popt.common.samba;
+ &popt.common.credentials;
+ &popt.common.connection;
+ &stdarg.help;
</variablelist>
</refsect1>
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 @@
</para></listitem>
</varlistentry>
- <varlistentry>
- <term>-h</term>
- <listitem><para>Print usage information on the <command>smbcacls
- </command> program.</para></listitem>
- </varlistentry>
+ &stdarg.help;
+ &popt.common.samba.small;
</variablelist>
</refsect1>
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 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
<refentry id="smbclient.1">
<refmeta>
@@ -116,23 +118,6 @@
</varlistentry>
<varlistentry>
- <term>-s smb.conf</term>
- <listitem><para>Specifies the location of the all
- important <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry> file. </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-O socket options</term>
- <listitem><para>TCP socket options to set on the client
- socket. See the socket options parameter in
- the <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry> manual page for the list of valid
- options. </para></listitem>
- </varlistentry>
-
-
- <varlistentry>
<term>-R &lt;name resolve order&gt;</term>
<listitem><para>This option is used by the programs in the Samba
suite to determine what naming services and in what order to resolve
@@ -225,70 +210,6 @@
</varlistentry>
<varlistentry>
- <term>-i scope</term>
- <listitem><para>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 <filename>rfc1001.txt</filename>
- and <filename>rfc1002.txt</filename>.
- NetBIOS scopes are <emphasis>very</emphasis> rarely used, only set
- this parameter if you are the system administrator in charge of all
- the NetBIOS systems you communicate with. </para></listitem>
- </varlistentry>
-
-
- <varlistentry>
- <term>-N</term>
- <listitem><para>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. </para>
-
- <para>Unless a password is specified on the command line or
- this parameter is specified, the client will request a
- password.</para></listitem>
- </varlistentry>
-
-
-
- <varlistentry>
- <term>-n NetBIOS name</term>
- <listitem><para>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. </para></listitem>
- </varlistentry>
-
-
- <varlistentry>
- <term>-d debuglevel</term>
- <listitem><para><replaceable>debuglevel</replaceable> is an integer from 0 to 10, or
- the letter 'A'. </para>
-
- <para>The default value if this parameter is not specified
- is zero. </para>
-
- <para>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. </para>
-
- <para>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 <replaceable>debuglevel</replaceable> is set to the letter 'A', then <emphasis>all
- </emphasis> debug messages will be printed. This setting
- is for developers only (and people who <emphasis>really</emphasis> want
- to know how the code works internally). </para>
-
- <para>Note that specifying this parameter here will override
- the log level parameter in the <filename>smb.conf (5)</filename>
- file. </para></listitem>
- </varlistentry>
-
-
- <varlistentry>
<term>-p port</term>
<listitem><para>This number is the TCP port number that will be used
when making connections to the server. The standard (well-known)
@@ -314,13 +235,7 @@
</varlistentry>
-
- <varlistentry>
- <term>-h</term><listitem>
- <para>Print the usage message for the client. </para></listitem>
- </varlistentry>
-
-
+ &stdarg.help;
<varlistentry>
<term>-I IP-address</term>
@@ -354,59 +269,6 @@
<varlistentry>
- <term>-U username[%pass]</term>
- <listitem><para>Sets the SMB username or username and password.
- If %pass is not specified, The user will be prompted. The client
- will first check the <envar>USER</envar> environment variable, then the
- <envar>LOGNAME</envar> 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 <constant>GUEST</constant>
- is used. </para>
-
- <para>If the password is not included in these environment
- variables (using the %pass syntax), <command>smbclient</command> will look for
- a <envar>PASSWD</envar> environment variable from which
- to read the password. </para>
-
- <para>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
- <parameter>-A</parameter> for more details. </para>
-
- <para>Be cautious about including passwords in scripts or in
- the <envar>PASSWD</envar> environment variable. Also, on
- many systems the command line of a running process may be seen
- via the <command>ps</command> command to be safe always allow
- <command>smbclient</command> to prompt for a password and type
- it in directly. </para></listitem>
- </varlistentry>
-
-
- <varlistentry>
- <term>-A filename</term><listitem><para>This 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
- </para>
-
-<para><programlisting>
-username = &lt;value&gt;
-password = &lt;value&gt;
-domain = &lt;value&gt;
-</programlisting></para>
-
-
- <para>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. </para></listitem>
- </varlistentry>
-
-
-
- <varlistentry>
<term>-L</term>
<listitem><para>This option allows you to look at what services
are available on a server. You use it as <command>smbclient -L
@@ -443,16 +305,9 @@ domain = &lt;value&gt;
</para></listitem>
</varlistentry>
-
-
- <varlistentry>
- <term>-W WORKGROUP</term>
- <listitem><para>Override the default workgroup (domain) specified
- in the workgroup parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry> file for this connection. This may be
- needed to connect to some servers. </para></listitem>
- </varlistentry>
-
+ &popt.common.samba;
+ &popt.common.credentials;
+ &popt.common.connection;
<varlistentry>
<term>-T tar options</term>
@@ -588,14 +443,6 @@ domain = &lt;value&gt;
<para>This is particularly useful in scripts and for printing stdin
to the server, e.g. <command>-c 'print -'</command>. </para></listitem>
</varlistentry>
-
- <varlistentry>
- <term>-k</term>
- <listitem><para>
- Try to authenticate with kerberos. Only useful in
- an Active Directory environment.
- </para></listitem>
- </varlistentry>
</variablelist>
</refsect1>
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 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
<refentry id="smbd.8">
<refmeta>
@@ -122,17 +124,8 @@
</para></listitem>
</varlistentry>
- <varlistentry>
- <term>-h</term>
- <listitem><para>Prints the help information (usage)
- for <command>smbd</command>.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-V</term>
- <listitem><para>Prints the version number for
- <command>smbd</command>.</para></listitem>
- </varlistentry>
+ &popt.common.samba;
+ &stdarg.help;
<varlistentry>
<term>-b</term>
@@ -141,32 +134,6 @@
</varlistentry>
<varlistentry>
- <term>-d &lt;debug level&gt;</term>
- <listitem><para><replaceable>debuglevel</replaceable> is an integer
- from 0 to 10. The default value if this parameter is
- not specified is zero.</para>
-
- <para>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.</para>
-
- <para>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.</para>
-
- <para>Note that specifying this parameter here will
- override the <ulink url="smb.conf.5.html#loglevel"><parameter>log
- level</parameter></ulink> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry> file.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term>-l &lt;log directory&gt;</term>
<listitem><para>If specified,
<replaceable>log directory</replaceable>
@@ -187,14 +154,6 @@
</varlistentry>
<varlistentry>
- <term>-O &lt;socket options&gt;</term>
- <listitem><para>See the <ulink
- url="smb.conf.5.html#socketoptions"><parameter>socket options</parameter></ulink>
- parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry> file for details.</para></listitem>
- </varlistentry>
-
- <varlistentry>
<term>-p &lt;port number&gt;</term>
<listitem><para><replaceable>port number</replaceable> is a positive integer
value. The default value if this parameter is not
@@ -218,19 +177,6 @@
<para>This parameter is not normally specified except
in the above situation.</para></listitem>
</varlistentry>
-
- <varlistentry>
- <term>-s &lt;configuration file&gt;</term>
- <listitem><para>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 <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry> for more information.
- The default configuration file name is determined at
- compile time.</para></listitem>
- </varlistentry>
</variablelist>
</refsect1>
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 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
+
<refentry id="smbstatus.1">
<refmeta>
@@ -54,13 +57,7 @@
<listitem><para>gives brief output.</para></listitem>
</varlistentry>
-
- <varlistentry>
- <term>-d|--debug=&lt;debuglevel&gt;</term>
- <listitem><para>sets debugging to specified level</para>
- </listitem>
- </varlistentry>
-
+ &popt.common.samba;
<varlistentry>
<term>-v|--verbose</term>
@@ -96,18 +93,7 @@
</listitem>
</varlistentry>
-
-
- <varlistentry>
- <term>-s|--conf=&lt;configuration file&gt;</term>
- <listitem><para>The default configuration file name is
- determined at compile time. The file specified contains the
- configuration details required by the server. See <citerefentry>
- <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
- </citerefentry> for more information.</para>
- </listitem>
- </varlistentry>
-
+ &stdarg.help;
<varlistentry>
<term>-u|--user=&lt;username&gt;</term>
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 @@
</para></listitem>
</varlistentry>
+ &popt.common.samba;
+ &popt.common.credentials;
&stdarg.help;
</variablelist>
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 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
<refentry id="swat.8">
<refmeta>
@@ -67,10 +69,9 @@
server. </emphasis></para></listitem>
</varlistentry>
- <varlistentry>
- <term>-V</term>
- <listitem><para>Print version number of samba suite</para></listitem>
- </varlistentry>
+ &popt.common.samba;
+ &stdarg.help;
+
</variablelist>
</refsect1>
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 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
<refentry id="testparm.1">
<refmeta>
@@ -65,13 +67,9 @@
will prompt for a carriage return after printing the service
names and before dumping the service definitions.</para></listitem>
</varlistentry>
-
-
- <varlistentry>
- <term>-h</term>
- <listitem><para>Print usage message </para></listitem>
- </varlistentry>
-
+
+ &stdarg.help;
+ &stdarg.version;
<varlistentry>
<term>-L servername</term>
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 @@
</para> </listitem>
</varlistentry>
- &stdarg.debuglevel;
&stdarg.help;
<varlistentry>
@@ -61,6 +60,8 @@
</para></listitem>
</varlistentry>
+ &popt.common.samba;
+
</variablelist>
</refsect1>
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 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
<refentry id="wbinfo.1">
<refmeta>
@@ -226,6 +228,8 @@
</para></listitem>
</varlistentry>
+ &stdarg.version;
+ &stdarg.help;
</variablelist>
</refsect1>
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 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
+]>
<refentry id="winbindd.8">
<refmeta>
@@ -128,13 +130,9 @@ group: files winbind
than a file.</para></listitem>
</varlistentry>
- <varlistentry>
- <term>-d debuglevel</term>
- <listitem><para>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). </para></listitem>
- </varlistentry>
+ &popt.common.samba;
+ &popt.common.connection;
+ &stdarg.help;
<varlistentry>
<term>-i</term>
@@ -168,12 +166,6 @@ group: files winbind
</para></listitem>
</varlistentry>
- <varlistentry>
- <term>-s|--conf=smb.conf</term>
- <listitem><para>Specifies the location of the all-important
- <citerefentry><refentrytitle>smb.conf</refentrytitle>
- <manvolnum>5</manvolnum></citerefentry> file. </para></listitem>
- </varlistentry>
</variablelist>
</refsect1>