docs-xml/build/DTD/samba.entities

   1 <!--
   2         vim:ft=dtd
   3 -->
   4
   5 <!-- Email Address' -->
   6 <!ENTITY email.dbannon 'D.Bannon@latrobe.edu.au'>
   7 <!ENTITY email.jerry   'jerry@samba.org'>
   8 <!ENTITY email.patches 'samba-patches@samba.org'>
   9 <!ENTITY email.jelmer  'jelmer@samba.org'>
  10 <!ENTITY email.jht     'jht@samba.org'>
  11 <!ENTITY email.ghenry  'ghenry@suretecsystems.com'>
  12
  13 <!-- Author entities -->
  14 <!ENTITY person.jelmer '
  15 <firstname>Jelmer</firstname><othername>R.</othername><surname>Vernooij</surname><othername>R.</othername>
  16 <affiliation>
  17         <orgname>The Samba Team</orgname>
  18         <address><email>jelmer@samba.org</email></address>
  19 </affiliation>'>
  20
  21 <!ENTITY author.jelmer '<author>&person.jelmer;</author>'>
  22
  23 <!ENTITY person.jerry '
  24 <firstname>Gerald</firstname><surname>Carter</surname><othername>(Jerry)</othername>
  25 <affiliation>
  26         <orgname>Samba Team</orgname>
  27         <address><email>jerry@samba.org</email></address>
  28 </affiliation>'>
  29
  30 <!ENTITY author.jerry '<author>&person.jerry;</author>'>
  31
  32 <!ENTITY author.jeremy '
  33 <author>
  34         <firstname>Jeremy</firstname><surname>Allison</surname>
  35         <affiliation>
  36                 <orgname>Samba Team</orgname>
  37                 <address><email>jra@samba.org</email></address>
  38         </affiliation>
  39 </author>'>
  40
  41 <!ENTITY person.jht '
  42 <firstname>John</firstname><surname>Terpstra</surname><othername>H.</othername>
  43 <affiliation>
  44         <orgname>Samba Team</orgname>
  45         <address><email>jht@samba.org</email></address>
  46 </affiliation>'>
  47
  48 <!ENTITY author.jht '<author>&person.jht;</author>'>
  49
  50 <!ENTITY person.gd '
  51 <firstname>Guenther</firstname><surname>Deschner</surname>
  52 <affiliation>
  53         <orgname>Samba Team</orgname>
  54         <address><email>gd@samba.org</email></address>
  55 </affiliation>'>
  56
  57 <!ENTITY author.gd '<author>&person.gd;</author>'>
  58
  59 <!ENTITY person.kauer '
  60 <firstname>Karl</firstname><surname>Auer</surname>
  61 <affiliation>
  62         <orgname>Samba Team</orgname>
  63         <address><email>kauer@biplane.com.au</email></address>
  64 </affiliation>
  65 '>
  66
  67 <!ENTITY author.kauer '<author>&person.kauer;</author>'>
  68
  69 <!ENTITY person.danshearer '
  70 <firstname>Dan</firstname><surname>Shearer</surname>
  71 <affiliation>
  72         <orgname>Samba Team</orgname>
  73         <address><email>dan@samba.org</email></address>
  74 </affiliation>
  75 '>
  76
  77 <!ENTITY author.danshearer '<author>&person.danshearer;</author>'>
  78
  79 <!ENTITY person.tpot '
  80 <firstname>Tim</firstname><surname>Potter</surname>
  81 <affiliation>
  82         <orgname>Samba Team</orgname>
  83         <address><email>tpot@samba.org</email></address>
  84 </affiliation>
  85 '>
  86
  87 <!ENTITY author.tpot '<author>&person.tpot;</author>'>
  88
  89 <!ENTITY author.tridge '
  90 <author>
  91         <firstname>Andrew</firstname><surname>Tridgell</surname>
  92         <affiliation>
  93                 <orgname>Samba Team</orgname>
  94                 <address><email>tridge@samba.org</email></address>
  95         </affiliation>
  96 </author>'>
  97
  98 <!ENTITY person.jmcd '
  99         <firstname>Jim</firstname><surname>McDonough</surname>
 100         <affiliation>
 101                 <orgname>IBM</orgname>
 102                 <address><email>jmcd@us.ibm.com</email></address>
 103         </affiliation>'>
 104
 105 <!ENTITY author.jmcd '<author>&person.jmcd;</author>'>
 106
 107 <!ENTITY person.vl '
 108 <firstname>Volker</firstname><surname>Lendecke</surname>
 109 <affiliation>
 110                 <orgname>Samba Team</orgname>
 111                 <address><email>Volker.Lendecke@SerNet.DE</email></address>
 112 </affiliation>'>
 113
 114 <!ENTITY author.vl '<author>&person.vl;</author>'>
 115
 116 <!ENTITY author.dbannon '
 117 <author>
 118         <firstname>David</firstname><surname>Bannon</surname>
 119         <affiliation>
 120                 <orgname>Samba Team</orgname>
 121                 <address><email>dbannon@samba.org</email></address>
 122         </affiliation>
 123 </author>'>
 124
 125 <!ENTITY author.mimir '
 126 <author>
 127         <firstname>Rafal</firstname><surname>Szczesniak</surname>
 128         <affiliation>
 129                 <orgname>Samba Team</orgname>
 130                 <address><email>mimir@samba.org</email></address>
 131         </affiliation>
 132 </author>'>
 133
 134 <!ENTITY author.dlechnyr '
 135 <author>
 136         <firstname>David</firstname><surname>Lechnyr</surname>
 137         <affiliation>
 138                 <orgname>Unofficial HOWTO</orgname>
 139                 <address><email>david@lechnyr.com</email></address>
 140         </affiliation>
 141 </author>'>
 142
 143 <!ENTITY author.eroseme '
 144 <author>
 145         <firstname>Eric</firstname><surname>Roseme</surname>
 146         <affiliation>
 147                 <orgname>HP Oplocks Usage Recommendations Whitepaper</orgname>
 148                 <address><email>eric.roseme@hp.com</email></address>
 149         </affiliation>
 150 </author>'>
 151
 152 <!ENTITY author.ghenry '
 153 <author>
 154         <firstname>Gavin</firstname><surname>Henry</surname>
 155         <affiliation>
 156                 <orgname>Suretec Systems Limited, UK</orgname>
 157                 <address><email>ghenry@suretecsystems.com</email></address>
 158         </affiliation>
 159 </author>'>
 160
 161 <!ENTITY stdarg.server.debug '
 162 <varlistentry>
 163 <term>-d|--debuglevel=level</term>
 164 <listitem>
 165 <para><replaceable>level</replaceable> is an integer
 166 from 0 to 10. The default value if this parameter is
 167 not specified is 0.</para>
 168
 169 <para>The higher this value, the more detail will be
 170 logged to the log files about the activities of the
 171 server. At level 0, only critical errors and serious
 172 warnings will be logged. Level 1 is a reasonable level for
 173 day-to-day running - it generates a small amount of
 174 information about operations carried out.</para>
 175
 176 <para>Levels above 1 will generate considerable
 177 amounts of log data, and should only be used when
 178 investigating a problem. Levels above 3 are designed for
 179 use only by developers and generate HUGE amounts of log
 180 data, most of which is extremely cryptic.</para>
 181
 182 <para>Note that specifying this parameter here will
 183 override the <smbconfoption name="log level" /> parameter
 184 in the &smb.conf; file.</para>
 185 </listitem>
 186 </varlistentry>'>
 187
 188 <!ENTITY stdarg.client.debug '
 189 <varlistentry>
 190 <term>-d|--debuglevel=level</term>
 191 <listitem>
 192 <para><replaceable>level</replaceable> is an integer
 193 from 0 to 10. The default value if this parameter is
 194 not specified is 1.</para>
 195
 196 <para>The higher this value, the more detail will be
 197 logged to the log files about the activities of the
 198 server. At level 0, only critical errors and serious
 199 warnings will be logged. Level 1 is a reasonable level for
 200 day-to-day running - it generates a small amount of
 201 information about operations carried out.</para>
 202
 203 <para>Levels above 1 will generate considerable
 204 amounts of log data, and should only be used when
 205 investigating a problem. Levels above 3 are designed for
 206 use only by developers and generate HUGE amounts of log
 207 data, most of which is extremely cryptic.</para>
 208
 209 <para>Note that specifying this parameter here will
 210 override the <smbconfoption name="log level" /> parameter
 211 in the &smb.conf; file.</para>
 212 </listitem>
 213 </varlistentry>'>
 214
 215 <!ENTITY stdarg.configfile '
 216 <varlistentry>
 217 <term>-s|--configfile &lt;configuration file&gt;</term>
 218 <listitem><para>The file specified contains the
 219 configuration details required by the server.  The
 220 information in this file includes server-specific
 221 information such as what printcap file to use, as well
 222 as descriptions of all the services that the server is
 223 to provide. See &smb.conf; for more information.
 224 The default configuration file name is determined at
 225 compile time.</para></listitem>
 226 </varlistentry>'>
 227
 228 <!ENTITY stdarg.version '
 229 <varlistentry>
 230 <term>-V|--version</term>
 231 <listitem><para>Prints the program version number.
 232 </para></listitem>
 233 </varlistentry>'>
 234
 235 <!ENTITY stdarg.log-basename '
 236 <varlistentry>
 237 <term>-l|--log-basename=logdirectory</term>
 238 <listitem><para>Base directory name for log/debug files. The extension
 239 <constant>".progname"</constant> will be appended (e.g. log.smbclient,
 240 log.smbd, etc...). The log file is never removed by the client.
 241 </para></listitem>
 242 </varlistentry>'>
 243
 244 <!ENTITY popt.common.samba '
 245 &stdarg.version;
 246 &stdarg.configfile;
 247 &stdarg.log-basename;
 248 '>
 249
 250 <!ENTITY stdarg.resolve.order '
 251 <varlistentry>
 252 <term>-R|--name-resolve &lt;name resolve order&gt;</term>
 253 <listitem><para>This option is used to determine what naming
 254 services and in what order to resolve
 255 host names to IP addresses. The option takes a space-separated
 256 string of different name resolution options.</para>
 257
 258 <para>The options are: "lmhosts", "host", "wins" and "bcast".
 259 They cause names to be resolved as follows :</para>
 260
 261 <itemizedlist>
 262 <listitem><para><constant>lmhosts</constant>:
 263 Lookup an IP address in the Samba lmhosts file. If the
 264 line in lmhosts has no name type attached to the
 265 NetBIOS name
 266 (see the <citerefentry><refentrytitle>lmhosts</refentrytitle>
 267  <manvolnum>5</manvolnum></citerefentry>        for details)
 268 then any name type matches for lookup.
 269 </para></listitem>
 270
 271 <listitem><para><constant>host</constant>:
 272 Do a standard host name to IP address resolution, using
 273 the system <filename>/etc/hosts</filename>, NIS, or DNS
 274 lookups. This method of name resolution is operating
 275 system dependent, for instance on IRIX or Solaris this
 276 may be controlled by the <filename>/etc/nsswitch.conf
 277 </filename> file).  Note that this method is only used
 278 if the NetBIOS name type being queried is the 0x20
 279 (server) name type, otherwise it is ignored.
 280 </para></listitem>
 281
 282 <listitem><para><constant>wins</constant>:
 283 Query a name with the IP address listed in the
 284 <parameter>wins server</parameter> parameter.  If no
 285 WINS server has been specified this method will be
 286 ignored.
 287 </para></listitem>
 288
 289 <listitem><para><constant>bcast</constant>:
 290 Do a broadcast on each of the known local interfaces
 291 listed in the <parameter>interfaces</parameter>
 292 parameter. This is the least reliable of the name
 293 resolution methods as it depends on the target host
 294 being on a locally connected subnet.
 295 </para></listitem>
 296 </itemizedlist>
 297
 298 <para>If this parameter is not set then the name resolve order
 299 defined in the &smb.conf; file parameter
 300 (<smbconfoption name="name resolve order" />) will be used.
 301 </para>
 302
 303 <para>The default order is lmhosts, host, wins, bcast. Without
 304 this parameter or any entry in the
 305 <smbconfoption name="name resolve order" /> parameter of
 306 the &smb.conf; file, the name
 307 resolution methods will be attempted in this order. </para></listitem>
 308 </varlistentry>'>
 309
 310 <!ENTITY stdarg.netbios.name '
 311 <varlistentry>
 312 <term>-n|--netbiosname &lt;primary NetBIOS name&gt;</term>
 313 <listitem><para>This option allows you to override
 314 the NetBIOS name that Samba uses for itself. This is identical
 315 to setting the <smbconfoption name="netbios name" /> parameter in
 316 the &smb.conf; file.
 317 However, a command
 318 line setting will take precedence over settings in
 319 &smb.conf;.</para></listitem>
 320 </varlistentry>'>
 321
 322 <!ENTITY stdarg.scope '
 323 <varlistentry>
 324 <term>-i|--scope &lt;scope&gt;</term>
 325 <listitem><para>This specifies a NetBIOS scope that
 326 <command>nmblookup</command> will use to communicate with when
 327 generating NetBIOS names. For details on the use of NetBIOS
 328 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
 329 <emphasis>very</emphasis> rarely used, only set this parameter
 330 if you are the system administrator in charge of all the
 331 NetBIOS systems you communicate with.</para></listitem>
 332 </varlistentry>'>
 333
 334 <!ENTITY stdarg.workgroup '
 335 <varlistentry>
 336 <term>-W|--workgroup=domain</term>
 337 <listitem><para>Set the SMB domain of the username.   This
 338 overrides the default domain which is the domain defined in
 339 smb.conf.  If the domain specified is the same as the servers
 340 NetBIOS name, it causes the client to log on using the servers local
 341 SAM (as opposed to the Domain SAM). </para></listitem>
 342 </varlistentry>'>
 343
 344 <!ENTITY stdarg.socket.options '
 345 <varlistentry>
 346 <term>-O|--socket-options socket options</term>
 347 <listitem><para>TCP socket options to set on the client
 348 socket. See the socket options parameter in
 349 the &smb.conf; manual page for the list of valid
 350 options. </para></listitem>
 351 </varlistentry>
 352 '>
 353
 354 <!ENTITY popt.common.connection '
 355 &stdarg.netbios.name;
 356 &stdarg.scope;
 357 &stdarg.workgroup;
 358 &stdarg.socket.options;
 359 '>
 360
 361 <!ENTITY stdarg.nopass '
 362 <varlistentry>
 363 <term>-N|--no-pass</term>
 364 <listitem><para>If specified, this parameter suppresses the normal
 365 password prompt from the client to the user. This is useful when
 366 accessing a service that does not require a password. </para>
 367
 368 <para>Unless a password is specified on the command line or
 369 this parameter is specified, the client will request a
 370 password.</para>
 371
 372 <para>If a password is specified on the command line and this
 373 option is also defined the password on the command line will
 374 be silently ingnored and no password will be used.</para></listitem>
 375 </varlistentry>'>
 376
 377 <!ENTITY pct "&#37;">
 378
 379 <!ENTITY stdarg.username '
 380 <varlistentry>
 381 <term>-U|--user=username[&pct;password]</term>
 382 <listitem><para>Sets the SMB username or username and password. </para>
 383
 384 <para>If &pct;password is not specified, the user will be prompted. The
 385 client will first check the <envar>USER</envar> environment variable, then the
 386 <envar>LOGNAME</envar> variable and if either exists, the
 387 string is uppercased. If these environmental variables are not
 388 found, the username <constant>GUEST</constant> is used. </para>
 389
 390 <para>A third option is to use a credentials file which
 391 contains the plaintext of the username and password.  This
 392 option is mainly provided for scripts where the admin does not
 393 wish to pass the credentials on the command line or via environment
 394 variables. If this method is used, make certain that the permissions
 395 on the file restrict access from unwanted users.  See the
 396 <parameter>-A</parameter> for more details. </para>
 397
 398 <para>Be cautious about including passwords in scripts. Also, on
 399 many systems the command line of a running process may be seen
 400 via the <command>ps</command> command.  To be safe always allow
 401 <command>rpcclient</command> to prompt for a password and type
 402 it in directly. </para></listitem>
 403 </varlistentry>
 404 '>
 405
 406 <!ENTITY stdarg.authfile '
 407 <varlistentry>
 408 <term>-A|--authentication-file=filename</term>
 409 <listitem><para>This option allows
 410 you to specify a file from which to read the username and
 411 password used in the connection.  The format of the file is
 412 </para>
 413
 414 <para><programlisting>
 415 username = &lt;value&gt;
 416 password = &lt;value&gt;
 417 domain   = &lt;value&gt;
 418 </programlisting></para>
 419
 420 <para>Make certain that the permissions on the file restrict
 421 access from unwanted users. </para></listitem>
 422 </varlistentry>'>
 423
 424 <!ENTITY stdarg.kerberos '
 425 <varlistentry>
 426 <term>-k|--kerberos</term>
 427 <listitem><para>
 428 Try to authenticate with kerberos. Only useful in
 429 an Active Directory environment.
 430 </para></listitem>
 431 </varlistentry>
 432 '>
 433
 434 <!ENTITY stdarg.useccache '
 435 <varlistentry>
 436 <term>-C|--use-ccache</term>
 437 <listitem><para>
 438 Try to use the credentials cached by winbind.
 439 </para></listitem>
 440 </varlistentry>
 441 '>
 442
 443
 444 <!ENTITY stdarg.help '
 445 <varlistentry>
 446 <term>-?|--help</term>
 447 <listitem><para>Print a summary of command line options.
 448 </para></listitem>
 449 </varlistentry>'>
 450
 451 <!ENTITY popt.common.credentials '
 452 &stdarg.nopass;
 453 &stdarg.kerberos;
 454 &stdarg.useccache;
 455 &stdarg.authfile;
 456 &stdarg.username;
 457 '>
 458
 459 <!-- Entities for the various programs -->
 460 <!ENTITY OL '<application>OpenLDAP</application>'>
 461 <!ENTITY smbd '<application>smbd</application>'>
 462 <!ENTITY nmbd '<application>nmbd</application>'>
 463 <!ENTITY testparm '<application>testparm</application>'>
 464 <!ENTITY smb.conf '<filename>smb.conf</filename>'>
 465 <!ENTITY smbclient '<application>smbclient</application>'>
 466 <!ENTITY winbindd '<application>winbindd</application>'>
 467 <!ENTITY net '<application>net</application>'>
 468
 469 <!ENTITY not.implemented "<note><para>Currently NOT implemented.</para></note>">
 470 <!ENTITY rootprompt "<prompt>root# </prompt>">
 471 <!ENTITY prompt "<prompt>$ </prompt>">
 472 <!ENTITY dosprompt "<prompt>C:\&gt; </prompt>">
 473
 474 <!ENTITY example.workgroup "MIDEARTH">
 475 <!ENTITY example.server.samba "GANDALF">
 476 <!ENTITY example.server.windows "SARUMAN">
 477 <!ENTITY example.workstation.windows "FRODO">
 478 <!ENTITY example.workstation.samba "BILBO">
 479 <!ENTITY example.pdc.samba "SAURON">
 480 <!ENTITY example.server.wins "noldor">
 481
 482 <!ENTITY smbmdash "<?latex --- ?>">