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 stdarg.option '
 245 <varlistentry>
 246 <term>--option=&lt;name&gt;=&lt;value&gt;</term>
 247 <listitem><para>Set the
 248 <citerefentry><refentrytitle>smb.conf</refentrytitle>
 249 <manvolnum>5</manvolnum></citerefentry>
 250 option "&lt;name&gt;" to value "&lt;value&gt;" from the command line.
 251 This overrides compiled-in defaults and options read from the configuration
 252 file.
 253 </para></listitem>
 254 </varlistentry>'>
 255
 256 <!ENTITY popt.common.samba '
 257 &stdarg.version;
 258 &stdarg.configfile;
 259 &stdarg.log-basename;
 260 '>
 261
 262 <!ENTITY stdarg.resolve.order '
 263 <varlistentry>
 264 <term>-R|--name-resolve &lt;name resolve order&gt;</term>
 265 <listitem><para>This option is used to determine what naming
 266 services and in what order to resolve
 267 host names to IP addresses. The option takes a space-separated
 268 string of different name resolution options.</para>
 269
 270 <para>The options are: "lmhosts", "host", "wins" and "bcast".
 271 They cause names to be resolved as follows :</para>
 272
 273 <itemizedlist>
 274 <listitem><para><constant>lmhosts</constant>:
 275 Lookup an IP address in the Samba lmhosts file. If the
 276 line in lmhosts has no name type attached to the
 277 NetBIOS name
 278 (see the <citerefentry><refentrytitle>lmhosts</refentrytitle>
 279  <manvolnum>5</manvolnum></citerefentry>        for details)
 280 then any name type matches for lookup.
 281 </para></listitem>
 282
 283 <listitem><para><constant>host</constant>:
 284 Do a standard host name to IP address resolution, using
 285 the system <filename>/etc/hosts</filename>, NIS, or DNS
 286 lookups. This method of name resolution is operating
 287 system dependent, for instance on IRIX or Solaris this
 288 may be controlled by the <filename>/etc/nsswitch.conf
 289 </filename> file).  Note that this method is only used
 290 if the NetBIOS name type being queried is the 0x20
 291 (server) name type, otherwise it is ignored.
 292 </para></listitem>
 293
 294 <listitem><para><constant>wins</constant>:
 295 Query a name with the IP address listed in the
 296 <parameter>wins server</parameter> parameter.  If no
 297 WINS server has been specified this method will be
 298 ignored.
 299 </para></listitem>
 300
 301 <listitem><para><constant>bcast</constant>:
 302 Do a broadcast on each of the known local interfaces
 303 listed in the <parameter>interfaces</parameter>
 304 parameter. This is the least reliable of the name
 305 resolution methods as it depends on the target host
 306 being on a locally connected subnet.
 307 </para></listitem>
 308 </itemizedlist>
 309
 310 <para>If this parameter is not set then the name resolve order
 311 defined in the &smb.conf; file parameter
 312 (<smbconfoption name="name resolve order" />) will be used.
 313 </para>
 314
 315 <para>The default order is lmhosts, host, wins, bcast. Without
 316 this parameter or any entry in the
 317 <smbconfoption name="name resolve order" /> parameter of
 318 the &smb.conf; file, the name
 319 resolution methods will be attempted in this order. </para></listitem>
 320 </varlistentry>'>
 321
 322 <!ENTITY stdarg.netbios.name '
 323 <varlistentry>
 324 <term>-n|--netbiosname &lt;primary NetBIOS name&gt;</term>
 325 <listitem><para>This option allows you to override
 326 the NetBIOS name that Samba uses for itself. This is identical
 327 to setting the <smbconfoption name="netbios name" /> parameter in
 328 the &smb.conf; file.
 329 However, a command
 330 line setting will take precedence over settings in
 331 &smb.conf;.</para></listitem>
 332 </varlistentry>'>
 333
 334 <!ENTITY stdarg.scope '
 335 <varlistentry>
 336 <term>-i|--scope &lt;scope&gt;</term>
 337 <listitem><para>This specifies a NetBIOS scope that
 338 <command>nmblookup</command> will use to communicate with when
 339 generating NetBIOS names. For details on the use of NetBIOS
 340 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
 341 <emphasis>very</emphasis> rarely used, only set this parameter
 342 if you are the system administrator in charge of all the
 343 NetBIOS systems you communicate with.</para></listitem>
 344 </varlistentry>'>
 345
 346 <!ENTITY stdarg.workgroup '
 347 <varlistentry>
 348 <term>-W|--workgroup=domain</term>
 349 <listitem><para>Set the SMB domain of the username.   This
 350 overrides the default domain which is the domain defined in
 351 smb.conf.  If the domain specified is the same as the servers
 352 NetBIOS name, it causes the client to log on using the servers local
 353 SAM (as opposed to the Domain SAM). </para></listitem>
 354 </varlistentry>'>
 355
 356 <!ENTITY stdarg.socket.options '
 357 <varlistentry>
 358 <term>-O|--socket-options socket options</term>
 359 <listitem><para>TCP socket options to set on the client
 360 socket. See the socket options parameter in
 361 the &smb.conf; manual page for the list of valid
 362 options. </para></listitem>
 363 </varlistentry>
 364 '>
 365
 366 <!ENTITY popt.common.connection '
 367 &stdarg.netbios.name;
 368 &stdarg.scope;
 369 &stdarg.workgroup;
 370 &stdarg.socket.options;
 371 '>
 372
 373 <!ENTITY stdarg.nopass '
 374 <varlistentry>
 375 <term>-N|--no-pass</term>
 376 <listitem><para>If specified, this parameter suppresses the normal
 377 password prompt from the client to the user. This is useful when
 378 accessing a service that does not require a password. </para>
 379
 380 <para>Unless a password is specified on the command line or
 381 this parameter is specified, the client will request a
 382 password.</para>
 383
 384 <para>If a password is specified on the command line and this
 385 option is also defined the password on the command line will
 386 be silently ingnored and no password will be used.</para></listitem>
 387 </varlistentry>'>
 388
 389 <!ENTITY pct "&#37;">
 390
 391 <!ENTITY stdarg.username '
 392 <varlistentry>
 393 <term>-U|--user=username[&pct;password]</term>
 394 <listitem><para>Sets the SMB username or username and password. </para>
 395
 396 <para>If &pct;password is not specified, the user will be prompted. The
 397 client will first check the <envar>USER</envar> environment variable, then the
 398 <envar>LOGNAME</envar> variable and if either exists, the
 399 string is uppercased. If these environmental variables are not
 400 found, the username <constant>GUEST</constant> is used. </para>
 401
 402 <para>A third option is to use a credentials file which
 403 contains the plaintext of the username and password.  This
 404 option is mainly provided for scripts where the admin does not
 405 wish to pass the credentials on the command line or via environment
 406 variables. If this method is used, make certain that the permissions
 407 on the file restrict access from unwanted users.  See the
 408 <parameter>-A</parameter> for more details. </para>
 409
 410 <para>Be cautious about including passwords in scripts. Also, on
 411 many systems the command line of a running process may be seen
 412 via the <command>ps</command> command.  To be safe always allow
 413 <command>rpcclient</command> to prompt for a password and type
 414 it in directly. </para></listitem>
 415 </varlistentry>
 416 '>
 417
 418 <!ENTITY stdarg.authfile '
 419 <varlistentry>
 420 <term>-A|--authentication-file=filename</term>
 421 <listitem><para>This option allows
 422 you to specify a file from which to read the username and
 423 password used in the connection.  The format of the file is
 424 </para>
 425
 426 <para><programlisting>
 427 username = &lt;value&gt;
 428 password = &lt;value&gt;
 429 domain   = &lt;value&gt;
 430 </programlisting></para>
 431
 432 <para>Make certain that the permissions on the file restrict
 433 access from unwanted users. </para></listitem>
 434 </varlistentry>'>
 435
 436 <!ENTITY stdarg.kerberos '
 437 <varlistentry>
 438 <term>-k|--kerberos</term>
 439 <listitem><para>
 440 Try to authenticate with kerberos. Only useful in
 441 an Active Directory environment.
 442 </para></listitem>
 443 </varlistentry>
 444 '>
 445
 446 <!ENTITY stdarg.useccache '
 447 <varlistentry>
 448 <term>-C|--use-ccache</term>
 449 <listitem><para>
 450 Try to use the credentials cached by winbind.
 451 </para></listitem>
 452 </varlistentry>
 453 '>
 454
 455
 456 <!ENTITY stdarg.help '
 457 <varlistentry>
 458 <term>-?|--help</term>
 459 <listitem><para>Print a summary of command line options.
 460 </para></listitem>
 461 </varlistentry>'>
 462
 463 <!ENTITY popt.common.credentials '
 464 &stdarg.nopass;
 465 &stdarg.kerberos;
 466 &stdarg.useccache;
 467 &stdarg.authfile;
 468 &stdarg.username;
 469 '>
 470
 471 <!-- Entities for the various programs -->
 472 <!ENTITY OL '<application>OpenLDAP</application>'>
 473 <!ENTITY smbd '<application>smbd</application>'>
 474 <!ENTITY nmbd '<application>nmbd</application>'>
 475 <!ENTITY testparm '<application>testparm</application>'>
 476 <!ENTITY smb.conf '<filename>smb.conf</filename>'>
 477 <!ENTITY smbclient '<application>smbclient</application>'>
 478 <!ENTITY winbindd '<application>winbindd</application>'>
 479 <!ENTITY net '<application>net</application>'>
 480
 481 <!ENTITY not.implemented "<note><para>Currently NOT implemented.</para></note>">
 482 <!ENTITY rootprompt "<prompt>root# </prompt>">
 483 <!ENTITY prompt "<prompt>$ </prompt>">
 484 <!ENTITY dosprompt "<prompt>C:\&gt; </prompt>">
 485
 486 <!ENTITY example.workgroup "MIDEARTH">
 487 <!ENTITY example.server.samba "GANDALF">
 488 <!ENTITY example.server.windows "SARUMAN">
 489 <!ENTITY example.workstation.windows "FRODO">
 490 <!ENTITY example.workstation.samba "BILBO">
 491 <!ENTITY example.pdc.samba "SAURON">
 492 <!ENTITY example.server.wins "noldor">
 493
 494 <!ENTITY smbmdash "<?latex --- ?>">