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 <!ENTITY email.jelmer  'jelmer@samba.org'>
  10
  11
  12 <!-- Author entities -->
  13 <!ENTITY person.jelmer '
  14 <firstname>Jelmer</firstname><surname>Vernooij</surname>
  15 <affiliation>
  16         <orgname>The Samba Team</orgname>
  17         <address><email>jelmer@samba.org</email></address>
  18 </affiliation>'>
  19
  20 <!ENTITY author.jelmer '<author>&person.jelmer;</author>'>
  21
  22 <!ENTITY person.jerry '
  23 <firstname>Gerald</firstname><surname>Carter</surname><othername>(Jerry)</othername>
  24 <affiliation>
  25         <orgname>Samba Team</orgname>
  26         <address><email>jerry@samba.org</email></address>
  27 </affiliation>'>
  28
  29 <!ENTITY author.jerry '<author>&person.jerry;</author>'>
  30
  31 <!ENTITY author.jeremy '
  32 <author>
  33         <firstname>Jeremy</firstname><surname>Allison</surname>
  34         <affiliation>
  35                 <orgname>Samba Team</orgname>
  36                 <address><email>jra@samba.org</email></address>
  37         </affiliation>
  38 </author>'>
  39
  40 <!ENTITY person.jht '
  41 <firstname>John H</firstname><surname>Terpstra</surname>
  42 <affiliation>
  43         <orgname>Samba Team</orgname>
  44         <address><email>jht@samba.org</email></address>
  45 </affiliation>
  46 '>
  47
  48 <!ENTITY author.jht '<author>&person.jht;</author>'>
  49
  50 <!ENTITY author.tridge '
  51 <author>
  52         <firstname>Andrew</firstname><surname>Tridgell</surname>
  53         <affiliation>
  54                 <orgname>Samba Team</orgname>
  55                 <address><email>tridge@samba.org</email></address>
  56         </affiliation>
  57 </author>'>
  58
  59 <!ENTITY author.jmcd '
  60 <author>
  61         <firstname>Jim</firstname><surname>McDonough</surname>
  62         <affiliation>
  63                 <orgname>IBM</orgname>
  64                 <address><email>jmcd@us.ibm.com</email></address>
  65         </affiliation>
  66 </author>'>
  67
  68 <!ENTITY author.vl '
  69 <author>
  70         <firstname>Volker</firstname><surname>Lendecke</surname>
  71         <affiliation>
  72                 <orgname>Samba Team</orgname>
  73                 <address><email>Volker.Lendecke@SerNet.DE</email></address>
  74         </affiliation>
  75 </author>'>
  76
  77 <!ENTITY author.mimir '
  78 <author>
  79         <firstname>Rafal</firstname><surname>Szczesniak</surname>
  80         <affiliation>
  81                 <orgname>Samba Team</orgname>
  82                 <address><email>mimir@samba.org</email></address>
  83         </affiliation>
  84 </author>'>
  85
  86 <!-- URL's -->
  87 <!ENTITY url.samba.cvsinfo 'http://pserver.samba.org/samba/cvs.html'>
  88 <!ENTITY url.pdc-howto.local 'samba-pdc-howto.html'>
  89 <!ENTITY url.samba-tng 'http://www.samba-tng.org'>
  90 <!ENTITY url.samba.doc 'http://bioserve.latrobe.edu.au/samba/'>
  91 <!ENTITY url.ultraedit 'http://www.ultraedit.com'>
  92 <!ENTITY url.vi-windows 'http://home.snafu.de/ramo/WinViEn.htm'>
  93 <!ENTITY url.pfe 'http://www.lancs.ac.uk/people/cpaap/pfe/'>
  94 <!ENTITY url.server-tools.win95 'ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE'>
  95 <!ENTITY url.server-tools.winnt 'ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE'>
  96 <!ENTITY url.tcpdump 'http://www.tcpdump.org/'>
  97 <!ENTITY url.samba 'http://samba.org'>
  98 <!ENTITY url.samba-ldap-howto 'http://www.unav.es/cti/ldap-smb-howto.html'>
  99 <!ENTITY url.samba-tng.home 'http://www.kneschke.de/projekte/samba_tng/'>
 100 <!ENTITY url.samba.mailinglist.ntdom 'http://lists.samba.org/mailman/samba-ntdom'>
 101 <!ENTITY url.samba.cifs 'http://samba.org/cifs/'>
 102 <!ENTITY url.ntdomains-for-unix 'http://mailhost.cb1.com/~lkcl/ntdom/'>
 103 <!ENTITY url.samba.specs.old 'ftp://ftp.microsoft.com/developr/drg/CIFS/'>
 104 <!ENTITY url.rfc.1001 'http://ds.internic.net/rfc/rfc1001.txt'>
 105 <!ENTITY url.rfc.1002 'http://ds.internic.net/rfc/rfc1002.txt'>
 106
 107 <!-- Misc -->
 108 <!ENTITY samba.pub.cvshost 'pserver.samba.org'>
 109
 110 <!ENTITY stdarg.debug '
 111 <varlistentry>
 112 <term>-d|--debug=debuglevel</term>
 113 <listitem>
 114 <para><replaceable>debuglevel</replaceable> is an integer
 115 from 0 to 10.  The default value if this parameter is
 116 not specified is zero.</para>
 117
 118 <para>The higher this value, the more detail will be
 119 logged to the log files about the activities of the
 120 server. At level 0, only critical errors and serious
 121 warnings will be logged. Level 1 is a reasonable level for
 122 day to day running - it generates a small amount of
 123 information about operations carried out.</para>
 124
 125 <para>Levels above 1 will generate considerable
 126 amounts of log data, and should only be used when
 127 investigating a problem. Levels above 3 are designed for
 128 use only by developers and generate HUGE amounts of log
 129 data, most of which is extremely cryptic.</para>
 130
 131 <para>Note that specifying this parameter here will
 132 override the <ulink url="smb.conf.5.html#loglevel">log
 133 level</ulink> parameter in the <ulink url="smb.conf.5.html">
 134 <filename>smb.conf(5)</filename></ulink> file.</para>
 135 </listitem>
 136 </varlistentry>'>
 137
 138 <!ENTITY stdarg.configfile '
 139 <varlistentry>
 140 <term>-s &lt;configuration file&gt;</term>
 141 <listitem><para>The file specified contains the
 142 configuration details required by the server.  The
 143 information in this file includes server-specific
 144 information such as what printcap file to use, as well
 145 as descriptions of all the services that the server is
 146 to provide. See <ulink url="smb.conf.5.html"><filename>
 147 smb.conf(5)</filename></ulink> for more information.
 148 The default configuration file name is determined at
 149 compile time.</para></listitem>
 150 </varlistentry>'>
 151
 152 <!ENTITY stdarg.version '
 153 <varlistentry>
 154 <term>-V</term>
 155 <listitem><para>Prints the version number for
 156 <command>smbd</command>.</para></listitem>
 157 </varlistentry>'>
 158
 159 <!ENTITY stdarg.logfile '
 160 <varlistentry>
 161 <term>-l|--logfile=logbasename</term>
 162 <listitem><para>File name for log/debug files. The extension
 163 <constant>".client"</constant> will be appended. The log file is
 164 never removed by the client.
 165 </para></listitem>
 166 </varlistentry>'>
 167
 168 <!ENTITY popt.common.samba '
 169 &stdarg.version;
 170 &stdarg.configfile;
 171 &stdarg.debug;
 172 &stdarg.logfile;
 173 '>
 174
 175 <!ENTITY stdarg.resolve.order '
 176 <varlistentry>
 177 <term>-R &lt;name resolve order&gt;</term>
 178 <listitem><para>This option is used to determine what naming
 179 services and in what order to resolve
 180 host names to IP addresses. The option takes a space-separated
 181 string of different name resolution options.</para>
 182
 183 <para>The options are: "lmhosts", "host", "wins" and "bcast".
 184 They cause names to be resolved as follows :</para>
 185
 186 <itemizedlist>
 187 <listitem><para><constant>lmhosts</constant>:
 188 Lookup an IP address in the Samba lmhosts file. If the
 189 line in lmhosts has no name type attached to the
 190 NetBIOS name
 191 (see the <citerefentry><refentrytitle>lmhosts</refentrytitle>
 192  <manvolnum>5</manvolnum></citerefentry>        for details)
 193 then any name type matches for lookup.
 194 </para></listitem>
 195
 196 <listitem><para><constant>host</constant>:
 197 Do a standard host name to IP address resolution, using
 198 the system <filename>/etc/hosts</filename>, NIS, or DNS
 199 lookups. This method of name resolution is operating
 200 system dependent, for instance on IRIX or Solaris this
 201 may be controlled by the <filename>/etc/nsswitch.conf
 202 </filename> file).  Note that this method is only used
 203 if the NetBIOS name type being queried is the 0x20
 204 (server) name type, otherwise it is ignored.
 205 </para></listitem>
 206
 207 <listitem><para><constant>wins</constant>:
 208 Query a name with the IP address listed in the
 209 <parameter>wins server</parameter> parameter.  If no
 210 WINS server has been specified this method will be
 211 ignored.
 212 </para></listitem>
 213
 214 <listitem><para><constant>bcast</constant>:
 215 Do a broadcast on each of the known local interfaces
 216 listed in the <parameter>interfaces</parameter>
 217 parameter. This is the least reliable of the name
 218 resolution methods as it depends on the target host
 219 being on a locally connected subnet.
 220 </para></listitem>
 221 </itemizedlist>
 222
 223 <para>If this parameter is not set then the name resolve order
 224 defined in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 225 <manvolnum>5</manvolnum></citerefentry> file parameter
 226 (<parameter>name resolve order</parameter>) will be used. </para>
 227
 228 <para>The default order is lmhosts, host, wins, bcast. Without
 229 this parameter or any entry in the <parameter>name resolve order
 230 </parameter> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 231 <manvolnum>5</manvolnum></citerefentry> file, the name resolution methods
 232 will be attempted in this order. </para></listitem>
 233 </varlistentry>'>
 234
 235 <!ENTITY stdarg.netbios.name '
 236 <varlistentry>
 237 <term>-n &lt;primary NetBIOS name&gt;</term>
 238 <listitem><para>This option allows you to override
 239 the NetBIOS name that Samba uses for itself. This is identical
 240 to setting the <ulink url="smb.conf.5.html#netbiosname"><parameter>NetBIOS
 241 name</parameter></ulink> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 242 <manvolnum>5</manvolnum></citerefentry> file.  However, a command
 243 line setting will take precedence over settings in
 244 <citerefentry><refentrytitle>smb.conf</refentrytitle>
 245 <manvolnum>5</manvolnum></citerefentry>.</para></listitem>
 246 </varlistentry>'>
 247
 248 <!ENTITY stdarg.scope '
 249 <varlistentry>
 250 <term>-i &lt;scope&gt;</term>
 251 <listitem><para>This specifies a NetBIOS scope that
 252 <command>nmblookup</command> will use to communicate with when
 253 generating NetBIOS names. For details on the use of NetBIOS
 254 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
 255 <emphasis>very</emphasis> rarely used, only set this parameter
 256 if you are the system administrator in charge of all the
 257 NetBIOS systems you communicate with.</para></listitem>
 258 </varlistentry>'>
 259
 260 <!ENTITY stdarg.workgroup '
 261 <varlistentry>
 262 <term>-W|--workgroup=domain</term>
 263 <listitem><para>Set the SMB domain of the username.   This
 264 overrides the default domain which is the domain defined in
 265 smb.conf.  If the domain specified is the same as the servers
 266 NetBIOS name, it causes the client to log on using the servers local
 267 SAM (as opposed to the Domain SAM). </para></listitem>
 268 </varlistentry>'>
 269
 270 <!ENTITY stdarg.socket.options '
 271 <varlistentry>
 272 <term>-O socket options</term>
 273 <listitem><para>TCP socket options to set on the client
 274 socket. See the socket options parameter in
 275 the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 276 <manvolnum>5</manvolnum></citerefentry> manual page for the list of valid
 277 options. </para></listitem>
 278 </varlistentry>
 279 '>
 280
 281 <!ENTITY popt.common.connection '
 282 &stdarg.netbios.name;
 283 &stdarg.scope;
 284 &stdarg.workgroup;
 285 &stdarg.socket.options;
 286 '>
 287
 288 <!ENTITY stdarg.nopass '
 289 <varlistentry>
 290 <term>-N</term>
 291 <listitem><para>If specified, this parameter suppresses the normal
 292 password prompt from the client to the user. This is useful when
 293 accessing a service that does not require a password. </para>
 294
 295 <para>Unless a password is specified on the command line or
 296 this parameter is specified, the client will request a
 297 password.</para></listitem>
 298 </varlistentry>'>
 299
 300 <!ENTITY stdarg.username '
 301 <varlistentry>
 302 <term>-U|--user=username[&percnt;password]</term>
 303 <listitem><para>Sets the SMB username or username and password. </para>
 304
 305 <para>If &percnt;password is not specified, the user will be prompted. The
 306 client will first check the <envar>USER</envar> environment variable, then the
 307 <envar>LOGNAME</envar> variable and if either exists, the
 308 string is uppercased. If these environmental variables are not
 309 found, the username <constant>GUEST</constant> is used. </para>
 310
 311 <para>A third option is to use a credentials file which
 312 contains the plaintext of the username and password.  This
 313 option is mainly provided for scripts where the admin does not
 314 wish to pass the credentials on the command line or via environment
 315 variables. If this method is used, make certain that the permissions
 316 on the file restrict access from unwanted users.  See the
 317 <parameter>-A</parameter> for more details. </para>
 318
 319 <para>Be cautious about including passwords in scripts. Also, on
 320 many systems the command line of a running process may be seen
 321 via the <command>ps</command> command.  To be safe always allow
 322 <command>rpcclient</command> to prompt for a password and type
 323 it in directly. </para></listitem>
 324 </varlistentry>
 325 '>
 326
 327 <!ENTITY stdarg.authfile '
 328 <varlistentry>
 329 <term>-A|--authfile=filename</term>
 330 <listitem><para>This option allows
 331 you to specify a file from which to read the username and
 332 password used in the connection.  The format of the file is
 333 </para>
 334
 335 <para><programlisting>
 336 username = &lt;value&gt;
 337 password = &lt;value&gt;
 338 domain   = &lt;value&gt;
 339 </programlisting></para>
 340
 341 <para>Make certain that the permissions on the file restrict
 342 access from unwanted users. </para></listitem>
 343 </varlistentry>'>
 344
 345 <!ENTITY stdarg.kerberos '
 346 <varlistentry>
 347 <term>-k</term>
 348 <listitem><para>
 349 Try to authenticate with kerberos. Only useful in
 350 an Active Directory environment.
 351 </para></listitem>
 352 </varlistentry>
 353 '>
 354
 355
 356 <!ENTITY stdarg.help '
 357 <varlistentry>
 358 <term>-h|--help</term>
 359 <listitem><para>Print a summary of command line options.
 360 </para></listitem>
 361 </varlistentry>'>
 362
 363 <!ENTITY popt.common.credentials '
 364 &stdarg.nopass;
 365 &stdarg.kerberos;
 366 &stdarg.authfile;
 367 &stdarg.username;
 368 '>
 369
 370 <!-- Entities for the various programs -->
 371 <!ENTITY smbd '<application>smbd</application>'>
 372 <!ENTITY nmbd '<application>nmbd</application>'>
 373 <!ENTITY testparm '<application>testparm</application>'>
 374 <!ENTITY smb.conf '<filename>smb.conf</filename>'>
 375 <!ENTITY smbclient '<application>smbclient</application>'>
 376 <!ENTITY winbindd '<application>winbindd</application>'>
 377 <!ENTITY smbgroupedit '<application>smbgroupedit</application>'>
 378
 379 <!-- We only need this for SGML, and not for XML... -->
 380 <!ENTITY percnt '%'>