summaryrefslogtreecommitdiff
path: root/docs/docbook/global.ent
diff options
context:
space:
mode:
authorJohn Terpstra <jht@samba.org>2003-04-05 07:42:29 +0000
committerJohn Terpstra <jht@samba.org>2003-04-05 07:42:29 +0000
commit50c54ae56f8e50efcdcf72b54b9aeef6201499ac (patch)
treea2fc922af925da96528a5c79485b275a04ed3116 /docs/docbook/global.ent
parentdfa7c87a189529ac77a0308a4f98e3a3a9129c44 (diff)
downloadsamba-50c54ae56f8e50efcdcf72b54b9aeef6201499ac.tar.gz
samba-50c54ae56f8e50efcdcf72b54b9aeef6201499ac.tar.bz2
samba-50c54ae56f8e50efcdcf72b54b9aeef6201499ac.zip
Merging HEAD to 3.0.0
(This used to be commit 0160a8c1ea1aefbbbaaeeccb8f3ab3487d588df2)
Diffstat (limited to 'docs/docbook/global.ent')
-rw-r--r--docs/docbook/global.ent291
1 files changed, 282 insertions, 9 deletions
diff --git a/docs/docbook/global.ent b/docs/docbook/global.ent
index 46745c2773..c71166b4d7 100644
--- a/docs/docbook/global.ent
+++ b/docs/docbook/global.ent
@@ -6,6 +6,74 @@
<!ENTITY email.jmoore 'jmoore@php.net'>
<!ENTITY email.jerry 'jerry@samba.org'>
<!ENTITY email.patches 'samba-patches@samba.org'>
+<!ENTITY email.jelmer 'jelmer@samba.org'>
+
+
+<!-- Author entities -->
+<!ENTITY person.jelmer '
+<firstname>Jelmer</firstname><surname>Vernooij</surname>
+<affiliation>
+ <orgname>The Samba Team</orgname>
+ <address><email>jelmer@samba.org</email></address>
+</affiliation>'>
+
+<!ENTITY author.jelmer '<author>&person.jelmer;</author>'>
+
+<!ENTITY person.jerry '
+<firstname>Gerald</firstname><surname>Carter</surname><othername>(Jerry)</othername>
+<affiliation>
+ <orgname>Samba Team</orgname>
+ <address><email>jerry@samba.org</email></address>
+</affiliation>'>
+
+<!ENTITY author.jerry '<author>&person.jerry;</author>'>
+
+<!ENTITY author.jeremy '
+<author>
+ <firstname>Jeremy</firstname><surname>Allison</surname>
+ <affiliation>
+ <orgname>Samba Team</orgname>
+ <address><email>jra@samba.org</email></address>
+ </affiliation>
+</author>'>
+
+<!ENTITY person.jht '
+<firstname>John H</firstname><surname>Terpstra</surname>
+<affiliation>
+ <orgname>Samba Team</orgname>
+ <address><email>jht@samba.org</email></address>
+</affiliation>
+'>
+
+<!ENTITY author.jht '<author>&person.jht;</author>'>
+
+<!ENTITY author.tridge '
+<author>
+ <firstname>Andrew</firstname><surname>Tridgell</surname>
+ <affiliation>
+ <orgname>Samba Team</orgname>
+ <address><email>tridge@samba.org</email></address>
+ </affiliation>
+</author>'>
+
+<!ENTITY author.jmcd '
+<author>
+ <firstname>Jim</firstname><surname>McDonough</surname>
+ <affiliation>
+ <orgname>IBM</orgname>
+ <address><email>jmcd@us.ibm.com</email></address>
+ </affiliation>
+</author>'>
+
+<!ENTITY author.vl '
+<author>
+ <firstname>Volker</firstname><surname>Lendecke</surname>
+ <affiliation>
+ <orgname>Samba Team</orgname>
+ <address><email>Volker.Lendecke@SerNet.DE</email></address>
+ </affiliation>
+</author>'>
+
<!-- URL's -->
<!ENTITY url.samba.cvsinfo 'http://pserver.samba.org/samba/cvs.html'>
@@ -30,8 +98,9 @@
<!-- Misc -->
<!ENTITY samba.pub.cvshost 'pserver.samba.org'>
+<!ENTITY percnt '%'>
-<!ENTITY stdarg.debuglevel '
+<!ENTITY stdarg.debug '
<varlistentry>
<term>-d|--debug=debuglevel</term>
<listitem>
@@ -59,13 +128,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 +144,218 @@ 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.resolve.order '
+<varlistentry>
+<term>-R &lt;name resolve order&gt;</term>
+<listitem><para>This option is used to determine what naming
+services and in what order to resolve
+host names to IP addresses. The option takes a space-separated
+string of different name resolution options.</para>
+
+<para>The options are: "lmhosts", "host", "wins" and "bcast".
+They cause names to be resolved as follows :</para>
+
+<itemizedlist>
+<listitem><para><constant>lmhosts</constant>:
+Lookup an IP address in the Samba lmhosts file. If the
+line in lmhosts has no name type attached to the
+NetBIOS name
+(see the <citerefentry><refentrytitle>lmhosts</refentrytitle>
+ <manvolnum>5</manvolnum></citerefentry> for details)
+then any name type matches for lookup.
+</para></listitem>
+
+<listitem><para><constant>host</constant>:
+Do a standard host name to IP address resolution, using
+the system <filename>/etc/hosts</filename>, NIS, or DNS
+lookups. This method of name resolution is operating
+system dependent, for instance on IRIX or Solaris this
+may be controlled by the <filename>/etc/nsswitch.conf
+</filename> file). Note that this method is only used
+if the NetBIOS name type being queried is the 0x20
+(server) name type, otherwise it is ignored.
+</para></listitem>
+
+<listitem><para><constant>wins</constant>:
+Query a name with the IP address listed in the
+<parameter>wins server</parameter> parameter. If no
+WINS server has been specified this method will be
+ignored.
+</para></listitem>
+
+<listitem><para><constant>bcast</constant>:
+Do a broadcast on each of the known local interfaces
+listed in the <parameter>interfaces</parameter>
+parameter. This is the least reliable of the name
+resolution methods as it depends on the target host
+being on a locally connected subnet.
+</para></listitem>
+</itemizedlist>
+
+<para>If this parameter is not set then the name resolve order
+defined in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
+<manvolnum>5</manvolnum></citerefentry> file parameter
+(<parameter>name resolve order</parameter>) will be used. </para>
+
+<para>The default order is lmhosts, host, wins, bcast. Without
+this parameter or any entry in the <parameter>name resolve order
+</parameter> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
+<manvolnum>5</manvolnum></citerefentry> file, the name resolution methods
+will be attempted in this order. </para></listitem>
+</varlistentry>'>
+
+<!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[&percnt;password]</term>
+<listitem><para>Sets the SMB username or username and password. </para>
+
+<para>If &percnt;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;
+'>