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 <!ENTITY email.asn     'asn@samba.org'>
  13
  14 <!-- Author entities -->
  15 <!ENTITY person.asn '
  16 <firstname>Andreas</firstname><surname>Schneider</surname>
  17 <affiliation>
  18         <orgname>The Samba Team</orgname>
  19         <address><email>asn@samba.org</email></address>
  20 </affiliation>'>
  21
  22 <!ENTITY author.asn '<author>&person.asn;</author>'>
  23
  24 <!ENTITY person.jelmer '
  25 <firstname>Jelmer</firstname><othername>R.</othername><surname>Vernooij</surname><othername>R.</othername>
  26 <affiliation>
  27         <orgname>The Samba Team</orgname>
  28         <address><email>jelmer@samba.org</email></address>
  29 </affiliation>'>
  30
  31 <!ENTITY author.jelmer '<author>&person.jelmer;</author>'>
  32
  33 <!ENTITY person.jerry '
  34 <firstname>Gerald</firstname><surname>Carter</surname><othername>(Jerry)</othername>
  35 <affiliation>
  36         <orgname>Samba Team</orgname>
  37         <address><email>jerry@samba.org</email></address>
  38 </affiliation>'>
  39
  40 <!ENTITY author.jerry '<author>&person.jerry;</author>'>
  41
  42 <!ENTITY author.jeremy '
  43 <author>
  44         <firstname>Jeremy</firstname><surname>Allison</surname>
  45         <affiliation>
  46                 <orgname>Samba Team</orgname>
  47                 <address><email>jra@samba.org</email></address>
  48         </affiliation>
  49 </author>'>
  50
  51 <!ENTITY person.jht '
  52 <firstname>John</firstname><surname>Terpstra</surname><othername>H.</othername>
  53 <affiliation>
  54         <orgname>Samba Team</orgname>
  55         <address><email>jht@samba.org</email></address>
  56 </affiliation>'>
  57
  58 <!ENTITY author.jht '<author>&person.jht;</author>'>
  59
  60 <!ENTITY person.gd '
  61 <firstname>Guenther</firstname><surname>Deschner</surname>
  62 <affiliation>
  63         <orgname>Samba Team</orgname>
  64         <address><email>gd@samba.org</email></address>
  65 </affiliation>'>
  66
  67 <!ENTITY author.gd '<author>&person.gd;</author>'>
  68
  69 <!ENTITY person.kauer '
  70 <firstname>Karl</firstname><surname>Auer</surname>
  71 <affiliation>
  72         <orgname>Samba Team</orgname>
  73         <address><email>kauer@biplane.com.au</email></address>
  74 </affiliation>
  75 '>
  76
  77 <!ENTITY author.kauer '<author>&person.kauer;</author>'>
  78
  79 <!ENTITY person.danshearer '
  80 <firstname>Dan</firstname><surname>Shearer</surname>
  81 <affiliation>
  82         <orgname>Samba Team</orgname>
  83         <address><email>dan@samba.org</email></address>
  84 </affiliation>
  85 '>
  86
  87 <!ENTITY author.danshearer '<author>&person.danshearer;</author>'>
  88
  89 <!ENTITY person.tpot '
  90 <firstname>Tim</firstname><surname>Potter</surname>
  91 <affiliation>
  92         <orgname>Samba Team</orgname>
  93         <address><email>tpot@samba.org</email></address>
  94 </affiliation>
  95 '>
  96
  97 <!ENTITY author.tpot '<author>&person.tpot;</author>'>
  98
  99 <!ENTITY author.tridge '
 100 <author>
 101         <firstname>Andrew</firstname><surname>Tridgell</surname>
 102         <affiliation>
 103                 <orgname>Samba Team</orgname>
 104                 <address><email>tridge@samba.org</email></address>
 105         </affiliation>
 106 </author>'>
 107
 108 <!ENTITY person.jmcd '
 109         <firstname>Jim</firstname><surname>McDonough</surname>
 110         <affiliation>
 111                 <orgname>IBM</orgname>
 112                 <address><email>jmcd@us.ibm.com</email></address>
 113         </affiliation>'>
 114
 115 <!ENTITY author.jmcd '<author>&person.jmcd;</author>'>
 116
 117 <!ENTITY person.vl '
 118 <firstname>Volker</firstname><surname>Lendecke</surname>
 119 <affiliation>
 120                 <orgname>Samba Team</orgname>
 121                 <address><email>Volker.Lendecke@SerNet.DE</email></address>
 122 </affiliation>'>
 123
 124 <!ENTITY author.vl '<author>&person.vl;</author>'>
 125
 126 <!ENTITY author.dbannon '
 127 <author>
 128         <firstname>David</firstname><surname>Bannon</surname>
 129         <affiliation>
 130                 <orgname>Samba Team</orgname>
 131                 <address><email>dbannon@samba.org</email></address>
 132         </affiliation>
 133 </author>'>
 134
 135 <!ENTITY author.mimir '
 136 <author>
 137         <firstname>Rafal</firstname><surname>Szczesniak</surname>
 138         <affiliation>
 139                 <orgname>Samba Team</orgname>
 140                 <address><email>mimir@samba.org</email></address>
 141         </affiliation>
 142 </author>'>
 143
 144 <!ENTITY author.dlechnyr '
 145 <author>
 146         <firstname>David</firstname><surname>Lechnyr</surname>
 147         <affiliation>
 148                 <orgname>Unofficial HOWTO</orgname>
 149                 <address><email>david@lechnyr.com</email></address>
 150         </affiliation>
 151 </author>'>
 152
 153 <!ENTITY author.eroseme '
 154 <author>
 155         <firstname>Eric</firstname><surname>Roseme</surname>
 156         <affiliation>
 157                 <orgname>HP Oplocks Usage Recommendations Whitepaper</orgname>
 158                 <address><email>eric.roseme@hp.com</email></address>
 159         </affiliation>
 160 </author>'>
 161
 162 <!ENTITY author.ghenry '
 163 <author>
 164         <firstname>Gavin</firstname><surname>Henry</surname>
 165         <affiliation>
 166                 <orgname>Suretec Systems Limited, UK</orgname>
 167                 <address><email>ghenry@suretecsystems.com</email></address>
 168         </affiliation>
 169 </author>'>
 170
 171 <!ENTITY cmdline.common.debug.client '
 172 <varlistentry>
 173         <term>-d|--debuglevel=level</term>
 174         <listitem>
 175                 <para>
 176                         <replaceable>level</replaceable> is an integer from 0
 177                         to 10. The default value if this parameter is not
 178                         specified is 1 for client applications.
 179                 </para>
 180
 181                 <para>
 182                         The higher this value, the more detail will be logged
 183                         to the log files about the activities of the server. At
 184                         level 0, only critical errors and serious warnings will
 185                         be logged. Level 1 is a reasonable level for day-to-day
 186                         running - it generates a small amount of information
 187                         about operations carried out.
 188                 </para>
 189
 190                 <para>
 191                         Levels above 1 will generate considerable amounts of
 192                         log data, and should only be used when investigating a
 193                         problem. Levels above 3 are designed for use only by
 194                         developers and generate HUGE amounts of log data, most
 195                         of which is extremely cryptic.
 196                         </para>
 197
 198                 <para>
 199                         Note that specifying this parameter here will override
 200                         the <smbconfoption name="log level" /> parameter in the
 201                         &smb.conf; file.
 202                 </para>
 203         </listitem>
 204 </varlistentry>
 205
 206 <varlistentry>
 207         <term>--debug-stdout</term>
 208         <listitem>
 209                 <para>
 210                         This will redirect debug output to STDOUT. By default
 211                         all clients are logging to STDERR.
 212                 </para>
 213         </listitem>
 214 </varlistentry>
 215 '>
 216
 217 <!ENTITY cmdline.common.debug.server '
 218 <varlistentry>
 219         <term>-d|--debuglevel=level</term>
 220
 221         <listitem>
 222                 <para>
 223                         <replaceable>level</replaceable> is an integer from 0
 224                         to 10. The default value if this parameter is not
 225                         specified is 0.
 226                 </para>
 227
 228                 <para>
 229                         The higher this value, the more detail will be logged
 230                         to the log files about the activities of the server. At
 231                         level 0, only critical errors and serious warnings will
 232                         be logged. Level 1 is a reasonable level for day-to-day
 233                         running - it generates a small amount of information
 234                         about operations carried out.
 235                 </para>
 236
 237                 <para>
 238                         Levels above 1 will generate considerable amounts of
 239                         log data, and should only be used when investigating a
 240                         problem. Levels above 3 are designed for use only by
 241                         developers and generate HUGE amounts of log data, most
 242                         of which is extremely cryptic.
 243                 </para>
 244
 245                 <para>
 246                         Note that specifying this parameter here will override
 247                         the <smbconfoption name="log level" /> parameter in the
 248                         &smb.conf; file.
 249                 </para>
 250         </listitem>
 251 </varlistentry>
 252
 253 <varlistentry>
 254         <term>--debug-stdout</term>
 255         <listitem>
 256                 <para>
 257                         This will redirect debug output to STDOUT. By default
 258                         server daemons are logging to a log file.
 259                 </para>
 260         </listitem>
 261 </varlistentry>
 262 '>
 263
 264 <!ENTITY cmdline.common.option '
 265 <varlistentry>
 266         <term>--option=&lt;name&gt;=&lt;value&gt;</term>
 267         <listitem>
 268                 <para>
 269                         Set the
 270                         <citerefentry><refentrytitle>smb.conf</refentrytitle>
 271                         <manvolnum>5</manvolnum></citerefentry> option
 272                         "&lt;name&gt;" to value "&lt;value&gt;" from the
 273                         command line. This overrides compiled-in defaults and
 274                         options read from the configuration file. If a name or
 275                         a value includes a space, wrap whole
 276                         --option=name=value into quotes.
 277                 </para>
 278         </listitem>
 279 </varlistentry>
 280 '>
 281
 282 <!ENTITY cmdline.common.config.client '
 283 <varlistentry>
 284         <term>--configfile=&lt;configuration file&gt;</term>
 285         <listitem>
 286                 <para>
 287                         The file specified contains the configuration details
 288                         required by the client. The information in this file
 289                         can be general for client and server or only provide
 290                         client specific like options such as
 291                         <smbconfoption name="client smb encrypt" />. See
 292                         &smb.conf; for more information.  The default
 293                         configuration file name is determined at compile time.
 294                 </para>
 295         </listitem>
 296 </varlistentry>
 297 '>
 298
 299 <!ENTITY cmdline.common.config.server '
 300 <varlistentry>
 301         <term>--configfile=CONFIGFILE</term>
 302         <listitem>
 303                 <para>
 304                         The file specified contains the configuration details
 305                         required by the server.  The information in this file
 306                         includes server-specific information such as what
 307                         printcap file to use, as well as descriptions of all
 308                         the services that the server is to provide. See
 309                         &smb.conf; for more information.  The default
 310                         configuration file name is determined at compile
 311                         time.
 312                 </para>
 313         </listitem>
 314 </varlistentry>
 315 '>
 316
 317 <!ENTITY cmdline.version '
 318 <varlistentry>
 319         <term>-V|--version</term>
 320         <listitem>
 321                 <para>
 322                         Prints the program version number.
 323                 </para>
 324         </listitem>
 325 </varlistentry>
 326 '>
 327
 328 <!ENTITY cmdline.common.samba.logbasename '
 329 <varlistentry>
 330         <term>-l|--log-basename=logdirectory</term>
 331         <listitem>
 332                 <para>
 333                         Base directory name for log/debug files. The extension
 334                         <constant>".progname"</constant> will be appended (e.g.
 335                         log.smbclient, log.smbd, etc...). The log file is never
 336                         removed by the client.
 337                 </para>
 338         </listitem>
 339 </varlistentry>
 340 '>
 341
 342 <!ENTITY cmdline.common.samba.leakreport '
 343 <varlistentry>
 344         <term>--leak-report</term>
 345         <listitem>
 346                 <para>
 347                         Enable talloc leak reporting on exit.
 348                 </para>
 349         </listitem>
 350 </varlistentry>
 351 '>
 352
 353 <!ENTITY cmdline.common.samba.leakreportfull '
 354 <varlistentry>
 355         <term>--leak-report-full</term>
 356         <listitem>
 357                 <para>
 358                         Enable full talloc leak reporting on exit.
 359                 </para>
 360         </listitem>
 361 </varlistentry>
 362 '>
 363
 364 <!ENTITY cmdline.common.samba.client '
 365 &cmdline.common.debug.client;
 366 &cmdline.common.config.client;
 367 &cmdline.common.option;
 368 &cmdline.common.samba.logbasename;
 369 &cmdline.common.samba.leakreport;
 370 &cmdline.common.samba.leakreportfull;
 371 &cmdline.version;
 372 '>
 373
 374 <!ENTITY cmdline.common.samba.server '
 375 &cmdline.common.debug.server;
 376 &cmdline.common.config.server;
 377 &cmdline.common.option;
 378 &cmdline.common.samba.logbasename;
 379 &cmdline.common.samba.leakreport;
 380 &cmdline.common.samba.leakreportfull;
 381 &cmdline.version;
 382 '>
 383
 384 <!ENTITY cmdline.common.connection.nameresolve '
 385 <varlistentry>
 386         <term>-R|--name-resolve=NAME-RESOLVE-ORDER</term>
 387         <listitem>
 388                 <para>
 389                         This option is used to determine what naming services
 390                         and in what order to resolve host names to IP
 391                         addresses. The option takes a space-separated string of
 392                         different name resolution options. The best is to wrap
 393                         the whole --name-resolve=NAME-RESOLVE-ORDER into
 394                         quotes.
 395                 </para>
 396
 397                 <para>
 398                         The options are: "lmhosts", "host", "wins" and "bcast".
 399                         They cause names to be resolved as follows:
 400                 </para>
 401
 402                 <itemizedlist>
 403                         <listitem>
 404                                 <para>
 405                                         <constant>lmhosts</constant>: Lookup an
 406                                         IP address in the Samba lmhosts file.
 407                                         If the line in lmhosts has no name type
 408                                         attached to the NetBIOS name (see the
 409                                         <citerefentry><refentrytitle>lmhosts</refentrytitle>
 410                                         <manvolnum>5</manvolnum></citerefentry>
 411                                         for details) then any name type matches
 412                                         for lookup.
 413                                 </para>
 414                         </listitem>
 415
 416                         <listitem>
 417                                 <para>
 418                                         <constant>host</constant>: Do a
 419                                         standard host name to IP address
 420                                         resolution, using the system
 421                                         <filename>/etc/hosts</filename>, NIS,
 422                                         or DNS lookups. This method of name
 423                                         resolution is operating system
 424                                         dependent, for instance on IRIX or
 425                                         Solaris this may be controlled by the
 426                                         <filename>/etc/nsswitch.conf
 427                                         </filename> file).  Note that this
 428                                         method is only used if the NetBIOS name
 429                                         type being queried is the 0x20 (server)
 430                                         name type, otherwise it is ignored.
 431                                 </para>
 432                         </listitem>
 433
 434                         <listitem>
 435                                 <para>
 436                                         <constant>wins</constant>: Query a name
 437                                         with the IP address listed in the
 438                                         <parameter>wins server</parameter>
 439                                         parameter.  If no WINS server has been
 440                                         specified this method will be ignored.
 441                                 </para>
 442                         </listitem>
 443
 444                         <listitem>
 445                                 <para>
 446                                         <constant>bcast</constant>: Do a
 447                                         broadcast on each of the known local
 448                                         interfaces listed in the
 449                                         <parameter>interfaces</parameter>
 450                                         parameter. This is the least reliable
 451                                         of the name resolution methods as it
 452                                         depends on the target host being on a
 453                                         locally connected subnet.
 454                                 </para>
 455                         </listitem>
 456                 </itemizedlist>
 457
 458                 <para>
 459                         If this parameter is not set then the name resolve
 460                         order defined in the &smb.conf; file parameter
 461                         (<smbconfoption name="name resolve order" />) will be
 462                         used.
 463                 </para>
 464
 465                 <para>
 466                         The default order is lmhosts, host, wins, bcast.
 467                         Without this parameter or any entry in the
 468                         <smbconfoption name="name resolve order" /> parameter
 469                         of the &smb.conf; file, the name resolution methods
 470                         will be attempted in this order.
 471                 </para>
 472         </listitem>
 473 </varlistentry>
 474 '>
 475
 476 <!ENTITY cmdline.common.connection.socketoptions '
 477 <varlistentry>
 478         <term>-O|--socket-options=SOCKETOPTIONS</term>
 479         <listitem>
 480                 <para>
 481                         TCP socket options to set on the client socket. See the
 482                         socket options parameter in the &smb.conf; manual page
 483                         for the list of valid options.
 484                 </para>
 485         </listitem>
 486 </varlistentry>
 487 '>
 488
 489 <!ENTITY cmdline.common.connection.netbiosname '
 490 <varlistentry>
 491         <term>-n|--netbiosname=NETBIOSNAME</term>
 492         <listitem>
 493                 <para>
 494                         This option allows you to override the NetBIOS name
 495                         that Samba uses for itself. This is identical to
 496                         setting the <smbconfoption name="netbios name" />
 497                         parameter in the &smb.conf; file.  However, a command
 498                         line setting will take precedence over settings in
 499                         &smb.conf;.
 500                 </para>
 501         </listitem>
 502 </varlistentry>
 503 '>
 504
 505 <!ENTITY cmdline.common.connection.workgroup '
 506 <varlistentry>
 507         <term>-W|--workgroup=WORKGROUP</term>
 508         <listitem>
 509                 <para>
 510                         Set the SMB domain of the username.   This overrides
 511                         the default domain which is the domain defined in
 512                         smb.conf.  If the domain specified is the same as the
 513                         servers NetBIOS name, it causes the client to log on
 514                         using the servers local SAM (as opposed to the Domain
 515                         SAM).
 516                 </para>
 517
 518                 <para>
 519                         Note that specifying this parameter here will override
 520                         the <smbconfoption name="workgroup" /> parameter in the
 521                         &smb.conf; file.
 522                 </para>
 523         </listitem>
 524 </varlistentry>
 525 '>
 526
 527 <!ENTITY cmdline.common.connection.realm '
 528 <varlistentry>
 529         <term>-r|--realm=REALM</term>
 530         <listitem>
 531                 <para>
 532                         Set the realm for the domain.
 533                 </para>
 534
 535                 <para>
 536                         Note that specifying this parameter here will override
 537                         the <smbconfoption name="realm" /> parameter in the
 538                         &smb.conf; file.
 539                 </para>
 540         </listitem>
 541 </varlistentry>'>
 542
 543 <!ENTITY cmdline.common.connection.netbiosscope '
 544 <varlistentry>
 545         <term>--netbios-scope=SCOPE</term>
 546         <listitem>
 547                 <para>
 548                         This specifies a NetBIOS scope that
 549                         <command>nmblookup</command> will use to communicate
 550                         with when generating NetBIOS names. For details on the
 551                         use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt.
 552                         NetBIOS scopes are <emphasis>very</emphasis> rarely
 553                         used, only set this parameter if you are the system
 554                         administrator in charge of all the NetBIOS systems you
 555                         communicate with.
 556                 </para>
 557         </listitem>
 558 </varlistentry>
 559 '>
 560
 561 <!ENTITY cmdline.common.connection.max-protocol '
 562 <varlistentry>
 563         <term>-m|--max-protocol=MAXPROTOCOL</term>
 564         <listitem>
 565                 <para>
 566                         The value of the parameter (a string) is the highest
 567                         protocol level that will be supported by the client.
 568                 </para>
 569
 570                 <para>
 571                         Note that specifying this parameter here will override
 572                         the <smbconfoption name="client max protocol" />
 573                         parameter in the &smb.conf; file.
 574                 </para>
 575         </listitem>
 576 </varlistentry>
 577 '>
 578
 579 <!ENTITY cmdline.common.connection '
 580 &cmdline.common.connection.nameresolve;
 581 &cmdline.common.connection.socketoptions;
 582 &cmdline.common.connection.max-protocol;
 583 &cmdline.common.connection.netbiosname;
 584 &cmdline.common.connection.netbiosscope;
 585 &cmdline.common.connection.workgroup;
 586 &cmdline.common.connection.realm;
 587 '>
 588
 589 <!ENTITY pct "&#37;">
 590
 591 <!ENTITY cmdline.common.credentials.user '
 592 <varlistentry>
 593         <term>-U|--user=[DOMAIN\]USERNAME[&pct;PASSWORD]</term>
 594         <listitem>
 595                 <para>
 596                         Sets the SMB username or username and password.
 597                 </para>
 598
 599                 <para>
 600                         If &pct;PASSWORD is not specified, the user will be
 601                         prompted. The client will first check the
 602                         <envar>USER</envar> environment variable
 603                         (which is also permitted to also contain the
 604                         password separated by a &pct;), then the
 605                         <envar>LOGNAME</envar> variable (which is not
 606                         permitted to contain a password) and if either exists,
 607                         the value is used. If these environmental
 608                         variables are not found, the username
 609                         found in a Kerberos Credentials cache may be used.
 610                 </para>
 611
 612                 <para>
 613                         A third option is to use a credentials file which
 614                         contains the plaintext of the username and password.
 615                         This option is mainly provided for scripts where the
 616                         admin does not wish to pass the credentials on the
 617                         command line or via environment variables. If this
 618                         method is used, make certain that the permissions on
 619                         the file restrict access from unwanted users.  See the
 620                         <parameter>-A</parameter> for more details.
 621                 </para>
 622
 623                 <para>
 624                         Be cautious about including passwords in scripts
 625                         or passing user-supplied values onto the command line. For
 626                         security it is better to let the Samba client tool ask for the
 627                         password if needed, or obtain the password once with <command>kinit</command>.
 628                 </para>
 629                 <para>
 630                         While Samba will attempt to scrub the password
 631                         from the process title (as seen in ps), this
 632                         is after startup and so is subject to a race.
 633                 </para>
 634         </listitem>
 635 </varlistentry>
 636 '>
 637
 638 <!ENTITY cmdline.common.credentials.nopass '
 639 <varlistentry>
 640         <term>-N|--no-pass</term>
 641         <listitem>
 642                 <para>
 643                         If specified, this parameter suppresses the normal
 644                         password prompt from the client to the user. This is
 645                         useful when accessing a service that does not require a
 646                         password.
 647                 </para>
 648
 649                 <para>
 650                         Unless a password is specified on the command line or
 651                         this parameter is specified, the client will request a
 652                         password.
 653                 </para>
 654
 655                 <para>
 656                         If a password is specified on the command line and this
 657                         option is also defined the password on the command line
 658                         will be silently ignored and no password will be
 659                         used.
 660                 </para>
 661         </listitem>
 662 </varlistentry>
 663 '>
 664
 665 <!ENTITY cmdline.common.credentials.password '
 666 <varlistentry>
 667         <term>--password</term>
 668         <listitem>
 669                 <para>
 670                         Specify the password on the commandline.
 671                 </para>
 672
 673                 <para> Be cautious about including passwords in
 674                         scripts or passing user-supplied values onto
 675                         the command line. For security it is better to
 676                         let the Samba client tool ask for the password
 677                         if needed, or obtain the password once with
 678                         <command>kinit</command>.
 679                 </para>
 680
 681                 <para> If --password is not specified,
 682                        the tool will check the <envar>PASSWD</envar>
 683                        environment variable, followed by <envar>PASSWD_FD</envar>
 684                        which is expected to contain an open
 685                        file descriptor (FD) number.
 686                 </para>
 687                 <para>
 688                        Finally it will check <envar>PASSWD_FILE</envar> (containing
 689                        a file path to be opened). The file should only
 690                        contain the password. Make certain that the
 691                        permissions on the file restrict
 692                        access from unwanted users!
 693                 </para>
 694                 <para>
 695                         While Samba will attempt to scrub the password
 696                         from the process title (as seen in ps), this
 697                         is after startup and so is subject to a race.
 698                 </para>
 699         </listitem>
 700 </varlistentry>
 701 '>
 702
 703 <!ENTITY cmdline.common.credentials.pwnthash '
 704 <varlistentry>
 705         <term>--pw-nt-hash</term>
 706         <listitem>
 707                 <para>
 708                         The supplied password is the NT hash.
 709                 </para>
 710         </listitem>
 711 </varlistentry>
 712 '>
 713
 714 <!ENTITY cmdline.common.credentials.authenticationfile '
 715 <varlistentry>
 716         <term>-A|--authentication-file=filename</term>
 717         <listitem>
 718                 <para>
 719                         This option allows you to specify a file from which to
 720                         read the username and password used in the connection.
 721                         The format of the file is:
 722                 </para>
 723
 724                 <para>
 725                         <programlisting>
 726                                 username = &lt;value&gt;
 727                                 password = &lt;value&gt;
 728                                 domain   = &lt;value&gt;
 729                         </programlisting>
 730                 </para>
 731
 732                 <para>
 733                         Make certain that the permissions on the file restrict
 734                         access from unwanted users!
 735                 </para>
 736         </listitem>
 737 </varlistentry>
 738 '>
 739
 740 <!ENTITY cmdline.common.credentials.machinepass '
 741 <varlistentry>
 742         <term>-P|--machine-pass</term>
 743         <listitem>
 744                 <para>
 745                         Use stored machine account password.
 746                 </para>
 747         </listitem>
 748 </varlistentry>
 749 '>
 750
 751 <!ENTITY cmdline.common.credentials.simplebinddn '
 752 <varlistentry>
 753         <term>--simple-bind-dn=DN</term>
 754         <listitem>
 755                 <para>
 756                         DN to use for a simple bind.
 757                 </para>
 758         </listitem>
 759 </varlistentry>
 760 '>
 761
 762 <!ENTITY cmdline.common.credentials.usekerberos '
 763 <varlistentry>
 764         <term>--use-kerberos=desired|required|off</term>
 765         <listitem>
 766                 <para>
 767                          This parameter determines whether Samba client tools
 768                          will try to authenticate using Kerberos. For Kerberos
 769                          authentication you need to use dns names instead of IP
 770                          addresses when connecting to a service.
 771                 </para>
 772
 773                 <para>
 774                         Note that specifying this parameter here will override
 775                         the <smbconfoption name="client use kerberos" />
 776                         parameter in the &smb.conf; file.
 777                 </para>
 778         </listitem>
 779 </varlistentry>
 780 '>
 781
 782 <!ENTITY cmdline.common.credentials.usekrb5ccache '
 783 <varlistentry>
 784         <term>--use-krb5-ccache=CCACHE</term>
 785         <listitem>
 786                 <para>
 787                         Specifies the credential cache location for Kerberos
 788                         authentication.
 789                 </para>
 790
 791                 <para>
 792                         This will set --use-kerberos=required too.
 793                 </para>
 794         </listitem>
 795 </varlistentry>
 796 '>
 797
 798 <!ENTITY cmdline.common.credentials.usewinbindccache '
 799 <varlistentry>
 800         <term>--use-winbind-ccache</term>
 801         <listitem>
 802                 <para>
 803                         Try to use the credential cache by winbind.
 804                 </para>
 805         </listitem>
 806 </varlistentry>
 807 '>
 808
 809 <!ENTITY cmdline.common.credentials.clientprotection '
 810 <varlistentry>
 811         <term>--client-protection=sign|encrypt|off</term>
 812         <listitem>
 813                 <para>
 814                         Sets the connection protection the client tool should
 815                         use.
 816                 </para>
 817
 818                 <para>
 819                         Note that specifying this parameter here will override
 820                         the <smbconfoption name="client protection" />
 821                         parameter in the &smb.conf; file.
 822                 </para>
 823
 824                 <para>
 825                         In case you need more fine grained control you can use:
 826                         <command>--option=clientsmbencrypt=OPTION</command>,
 827                         <command>--option=clientipcsigning=OPTION</command>,
 828                         <command>--option=clientsigning=OPTION</command>.
 829                 </para>
 830         </listitem>
 831 </varlistentry>
 832 '>
 833
 834 <!ENTITY cmdline.common.credentials '
 835 &cmdline.common.credentials.user;
 836 &cmdline.common.credentials.nopass;
 837 &cmdline.common.credentials.password;
 838 &cmdline.common.credentials.pwnthash;
 839 &cmdline.common.credentials.authenticationfile;
 840 &cmdline.common.credentials.machinepass;
 841 &cmdline.common.credentials.simplebinddn;
 842 &cmdline.common.credentials.usekerberos;
 843 &cmdline.common.credentials.usekrb5ccache;
 844 &cmdline.common.credentials.usewinbindccache;
 845 &cmdline.common.credentials.clientprotection;
 846 '>
 847
 848 <!ENTITY cmdline.legacy.kerberos.s3 '
 849 <varlistentry>
 850         <term>-k|--kerberos</term>
 851         <listitem>
 852                 <para>
 853                         Use kerberos authentication. This option is deprecated.
 854                         Migrate to --use-kerberos!
 855                 </para>
 856         </listitem>
 857 </varlistentry>
 858 '>
 859
 860 <!ENTITY cmdline.legacy.kerberos.s4 '
 861 <varlistentry>
 862         <term>-k|--kerberos=yes|no</term>
 863         <listitem>
 864                 <para>
 865                         Whether to use kerberos authentication. This option is
 866                         deprecated. Migrate to --use-kerberos!
 867                 </para>
 868         </listitem>
 869 </varlistentry>
 870 '>
 871
 872
 873
 874
 875 <!ENTITY stdarg.help '
 876 <varlistentry>
 877 <term>-?|--help</term>
 878 <listitem><para>Print a summary of command line options.
 879 </para></listitem>
 880 </varlistentry>
 881 '>
 882
 883 <!ENTITY stdarg.usage '
 884 <varlistentry>
 885 <term>--usage</term>
 886 <listitem><para>Display brief usage message.
 887 </para></listitem>
 888 </varlistentry>
 889 '>
 890
 891 <!ENTITY popt.autohelp '
 892 &stdarg.help;
 893 &stdarg.usage;
 894 '>
 895
 896 <!-- Entities for the various programs -->
 897 <!ENTITY OL '<application>OpenLDAP</application>'>
 898 <!ENTITY smbd '<application>smbd</application>'>
 899 <!ENTITY nmbd '<application>nmbd</application>'>
 900 <!ENTITY testparm '<application>testparm</application>'>
 901 <!ENTITY smb.conf '<filename>&pathconfig.CONFIGFILE;</filename>'>
 902 <!ENTITY smbclient '<application>smbclient</application>'>
 903 <!ENTITY winbindd '<application>winbindd</application>'>
 904 <!ENTITY net '<application>net</application>'>
 905
 906 <!ENTITY not.implemented "<note><para>Currently NOT implemented.</para></note>">
 907 <!ENTITY rootprompt "<prompt>root# </prompt>">
 908 <!ENTITY prompt "<prompt>$ </prompt>">
 909 <!ENTITY dosprompt "<prompt>C:\&gt; </prompt>">
 910
 911 <!ENTITY example.workgroup "MIDEARTH">
 912 <!ENTITY example.server.samba "GANDALF">
 913 <!ENTITY example.server.windows "SARUMAN">
 914 <!ENTITY example.workstation.windows "FRODO">
 915 <!ENTITY example.workstation.samba "BILBO">
 916 <!ENTITY example.pdc.samba "SAURON">
 917 <!ENTITY example.server.wins "noldor">
 918
 919 <!ENTITY smbmdash "<?latex --- ?>">