Document common arguments with entities

(This used to be commit adafcbb9af4a22db0fefb70966564d8591b5baed)

1 files changed, 155 insertions, 9 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;
+'>