docs/docbook/global.ent

   1 <!-- Global Entities File -->
   2
   3
   4 <!-- Email Address' -->
   5 <!ENTITY email.dbannon 'D.Bannon@latrobe.edu.au'>
   6 <!ENTITY email.jmoore  'jmoore@php.net'>
   7 <!ENTITY email.jerry   'jerry@samba.org'>
   8 <!ENTITY email.patches 'samba-patches@samba.org'>
   9
  10 <!-- URL's -->
  11 <!ENTITY url.samba.cvsinfo 'http://pserver.samba.org/samba/cvs.html'>
  12 <!ENTITY url.pdc-howto.local 'samba-pdc-howto.html'>
  13 <!ENTITY url.samba-tng 'http://www.samba-tng.org'>
  14 <!ENTITY url.samba.doc 'http://bioserve.latrobe.edu.au/samba/'>
  15 <!ENTITY url.ultraedit 'http://www.ultraedit.com'>
  16 <!ENTITY url.vi-windows 'http://home.snafu.de/ramo/WinViEn.htm'>
  17 <!ENTITY url.pfe 'http://www.lancs.ac.uk/people/cpaap/pfe/'>
  18 <!ENTITY url.server-tools.win95 'ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE'>
  19 <!ENTITY url.server-tools.winnt 'ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE'>
  20 <!ENTITY url.tcpdump 'http://www.tcpdump.org/'>
  21 <!ENTITY url.samba 'http://samba.org'>
  22 <!ENTITY url.samba-ldap-howto 'http://www.unav.es/cti/ldap-smb-howto.html'>
  23 <!ENTITY url.samba-tng.home 'http://www.kneschke.de/projekte/samba_tng/'>
  24 <!ENTITY url.samba.mailinglist.ntdom 'http://lists.samba.org/mailman/samba-ntdom'>
  25 <!ENTITY url.samba.cifs 'http://samba.org/cifs/'>
  26 <!ENTITY url.ntdomains-for-unix 'http://mailhost.cb1.com/~lkcl/ntdom/'>
  27 <!ENTITY url.samba.specs.old 'ftp://ftp.microsoft.com/developr/drg/CIFS/'>
  28 <!ENTITY url.rfc.1001 'http://ds.internic.net/rfc/rfc1001.txt'>
  29 <!ENTITY url.rfc.1002 'http://ds.internic.net/rfc/rfc1002.txt'>
  30
  31 <!-- Misc -->
  32 <!ENTITY samba.pub.cvshost 'pserver.samba.org'>
  33
  34 <!ENTITY stdarg.debug '
  35 <varlistentry>
  36 <term>-d|--debug=debuglevel</term>
  37 <listitem>
  38 <para><replaceable>debuglevel</replaceable> is an integer
  39 from 0 to 10.  The default value if this parameter is
  40 not specified is zero.</para>
  41
  42 <para>The higher this value, the more detail will be
  43 logged to the log files about the activities of the
  44 server. At level 0, only critical errors and serious
  45 warnings will be logged. Level 1 is a reasonable level for
  46 day to day running - it generates a small amount of
  47 information about operations carried out.</para>
  48
  49 <para>Levels above 1 will generate considerable
  50 amounts of log data, and should only be used when
  51 investigating a problem. Levels above 3 are designed for
  52 use only by developers and generate HUGE amounts of log
  53 data, most of which is extremely cryptic.</para>
  54
  55 <para>Note that specifying this parameter here will
  56 override the <ulink url="smb.conf.5.html#loglevel">log
  57 level</ulink> parameter in the <ulink url="smb.conf.5.html">
  58 <filename>smb.conf(5)</filename></ulink> file.</para>
  59 </listitem>
  60 </varlistentry>'>
  61
  62 <!ENTITY stdarg.configfile '
  63 <varlistentry>
  64 <term>-s &lt;configuration file&gt;</term>
  65 <listitem><para>The file specified contains the
  66 configuration details required by the server.  The
  67 information in this file includes server-specific
  68 information such as what printcap file to use, as well
  69 as descriptions of all the services that the server is
  70 to provide. See <ulink url="smb.conf.5.html"><filename>
  71 smb.conf(5)</filename></ulink> for more information.
  72 The default configuration file name is determined at
  73 compile time.</para></listitem>
  74 </varlistentry>'>
  75
  76 <!ENTITY stdarg.version '
  77 <varlistentry>
  78 <term>-V</term>
  79 <listitem><para>Prints the version number for
  80 <command>smbd</command>.</para></listitem>
  81 </varlistentry>'>
  82
  83 <!ENTITY stdarg.logfile '
  84 <varlistentry>
  85 <term>-l|--logfile=logbasename</term>
  86 <listitem><para>File name for log/debug files. The extension
  87 <constant>".client"</constant> will be appended. The log file is
  88 never removed by the client.
  89 </para></listitem>
  90 </varlistentry>'>
  91
  92 <!ENTITY popt.common.samba '
  93 &stdarg.version;
  94 &stdarg.configfile;
  95 &stdarg.debug;
  96 &stdarg.logfile;
  97 '>
  98
  99 <!ENTITY stdarg.netbios.name '
 100 <varlistentry>
 101 <term>-n &lt;primary NetBIOS name&gt;</term>
 102 <listitem><para>This option allows you to override
 103 the NetBIOS name that Samba uses for itself. This is identical
 104 to setting the <ulink url="smb.conf.5.html#netbiosname"><parameter>NetBIOS
 105 name</parameter></ulink> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 106 <manvolnum>5</manvolnum></citerefentry> file.  However, a command
 107 line setting will take precedence over settings in
 108 <citerefentry><refentrytitle>smb.conf</refentrytitle>
 109 <manvolnum>5</manvolnum></citerefentry>.</para></listitem>
 110 </varlistentry>'>
 111
 112
 113
 114 <!ENTITY stdarg.scope '
 115 <varlistentry>
 116 <term>-i &lt;scope&gt;</term>
 117 <listitem><para>This specifies a NetBIOS scope that
 118 <command>nmblookup</command> will use to communicate with when
 119 generating NetBIOS names. For details on the use of NetBIOS
 120 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
 121 <emphasis>very</emphasis> rarely used, only set this parameter
 122 if you are the system administrator in charge of all the
 123 NetBIOS systems you communicate with.</para></listitem>
 124 </varlistentry>'>
 125
 126 <!ENTITY stdarg.workgroup '
 127 <varlistentry>
 128 <term>-W|--workgroup=domain</term>
 129 <listitem><para>Set the SMB domain of the username.   This
 130 overrides the default domain which is the domain defined in
 131 smb.conf.  If the domain specified is the same as the servers
 132 NetBIOS name, it causes the client to log on using the servers local
 133 SAM (as opposed to the Domain SAM). </para></listitem>
 134 </varlistentry>'>
 135
 136 <!ENTITY stdarg.socket.options '
 137 <varlistentry>
 138 <term>-O socket options</term>
 139 <listitem><para>TCP socket options to set on the client
 140 socket. See the socket options parameter in
 141 the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 142 <manvolnum>5</manvolnum></citerefentry> manual page for the list of valid
 143 options. </para></listitem>
 144 </varlistentry>
 145 '>
 146
 147 <!ENTITY popt.common.connection '
 148 &stdarg.netbios.name;
 149 &stdarg.scope;
 150 &stdarg.workgroup;
 151 &stdarg.socket.options;
 152 '>
 153
 154 <!ENTITY stdarg.nopass '
 155 <varlistentry>
 156 <term>-N</term>
 157 <listitem><para>If specified, this parameter suppresses the normal
 158 password prompt from the client to the user. This is useful when
 159 accessing a service that does not require a password. </para>
 160
 161 <para>Unless a password is specified on the command line or
 162 this parameter is specified, the client will request a
 163 password.</para></listitem>
 164 </varlistentry>'>
 165
 166 <!ENTITY stdarg.username '
 167 <varlistentry>
 168 <term>-U|--user=username[&%;password]</term>
 169 <listitem><para>Sets the SMB username or username and password. </para>
 170
 171 <para>If &%;password is not specified, the user will be prompted. The
 172 client will first check the <envar>USER</envar> environment variable, then the
 173 <envar>LOGNAME</envar> variable and if either exists, the
 174 string is uppercased. If these environmental variables are not
 175 found, the username <constant>GUEST</constant> is used. </para>
 176
 177 <para>A third option is to use a credentials file which
 178 contains the plaintext of the username and password.  This
 179 option is mainly provided for scripts where the admin does not
 180 wish to pass the credentials on the command line or via environment
 181 variables. If this method is used, make certain that the permissions
 182 on the file restrict access from unwanted users.  See the
 183 <parameter>-A</parameter> for more details. </para>
 184
 185 <para>Be cautious about including passwords in scripts. Also, on
 186 many systems the command line of a running process may be seen
 187 via the <command>ps</command> command.  To be safe always allow
 188 <command>rpcclient</command> to prompt for a password and type
 189 it in directly. </para></listitem>
 190 </varlistentry>
 191 '>
 192
 193 <!ENTITY stdarg.authfile '
 194 <varlistentry>
 195 <term>-A|--authfile=filename</term>
 196 <listitem><para>This option allows
 197 you to specify a file from which to read the username and
 198 password used in the connection.  The format of the file is
 199 </para>
 200
 201 <para><programlisting>
 202 username = &lt;value&gt;
 203 password = &lt;value&gt;
 204 domain   = &lt;value&gt;
 205 </programlisting></para>
 206
 207 <para>Make certain that the permissions on the file restrict
 208 access from unwanted users. </para></listitem>
 209 </varlistentry>'>
 210
 211 <!ENTITY stdarg.kerberos '
 212 <varlistentry>
 213 <term>-k</term>
 214 <listitem><para>
 215 Try to authenticate with kerberos. Only useful in
 216 an Active Directory environment.
 217 </para></listitem>
 218 </varlistentry>
 219 '>
 220
 221
 222 <!ENTITY stdarg.help '
 223 <varlistentry>
 224 <term>-h|--help</term>
 225 <listitem><para>Print a summary of command line options.
 226 </para></listitem>
 227 </varlistentry>'>
 228
 229 <!ENTITY popt.common.credentials '
 230 &stdarg.nopass;
 231 &stdarg.kerberos;
 232 &stdarg.authfile;
 233 &stdarg.username;
 234 '>