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=DEBUGLEVEL</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=DEBUGLEVEL</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
 252         <term>--debug-stdout</term>
 253         <listitem>
 254                 <para>
 255                         This will redirect debug output to STDOUT. By default
 256                         server daemons are logging to a log file.
 257                 </para>
 258         </listitem>
 259 </varlistentry>
 260 '>
 261
 262 <!ENTITY cmdline.common.option '
 263 <varlistentry>
 264         <term>--option=&lt;name&gt;=&lt;value&gt;</term>
 265         <listitem>
 266                 <para>
 267                         Set the
 268                         <citerefentry><refentrytitle>smb.conf</refentrytitle>
 269                         <manvolnum>5</manvolnum></citerefentry> option
 270                         "&lt;name&gt;" to value "&lt;value&gt;" from the
 271                         command line. This overrides compiled-in defaults and
 272                         options read from the configuration file. If a name or
 273                         a value includes a space, wrap whole
 274                         --option=name=value into quotes.
 275                 </para>
 276         </listitem>
 277 </varlistentry>
 278 '>
 279
 280 <!ENTITY cmdline.common.config.client '
 281 <varlistentry>
 282         <term>--configfile=&lt;configuration file&gt;</term>
 283         <listitem>
 284                 <para>
 285                         The file specified contains the configuration details
 286                         required by the client. The information in this file
 287                         can be general for client and server or only provide
 288                         client specific like options such as
 289                         <smbconfoption name="client smb encrypt" />. See
 290                         &smb.conf; for more information.  The default
 291                         configuration file name is determined at compile time.
 292                 </para>
 293         </listitem>
 294 </varlistentry>
 295 '>
 296
 297 <!ENTITY cmdline.common.config.server '
 298 <varlistentry>
 299         <term>--configfile=CONFIGFILE</term>
 300         <listitem>
 301                 <para>
 302                         The file specified contains the configuration details
 303                         required by the server.  The information in this file
 304                         includes server-specific information such as what
 305                         printcap file to use, as well as descriptions of all
 306                         the services that the server is to provide. See
 307                         &smb.conf; for more information.  The default
 308                         configuration file name is determined at compile
 309                         time.
 310                 </para>
 311         </listitem>
 312 </varlistentry>
 313 '>
 314
 315 <!ENTITY cmdline.version '
 316 <varlistentry>
 317         <term>-V|--version</term>
 318         <listitem>
 319                 <para>
 320                         Prints the program version number.
 321                 </para>
 322         </listitem>
 323 </varlistentry>
 324 '>
 325
 326 <!ENTITY cmdline.common.samba.logbasename '
 327 <varlistentry>
 328         <term>-l|--log-basename=logdirectory</term>
 329         <listitem>
 330                 <para>
 331                         Base directory name for log/debug files. The extension
 332                         <constant>".progname"</constant> will be appended (e.g.
 333                         log.smbclient, log.smbd, etc...). The log file is never
 334                         removed by the client.
 335                 </para>
 336         </listitem>
 337 </varlistentry>
 338 '>
 339
 340 <!ENTITY cmdline.common.samba.leakreport '
 341 <varlistentry>
 342         <term>--leak-report</term>
 343         <listitem>
 344                 <para>
 345                         Enable talloc leak reporting on exit.
 346                 </para>
 347         </listitem>
 348 </varlistentry>
 349 '>
 350
 351 <!ENTITY cmdline.common.samba.leakreportfull '
 352 <varlistentry>
 353         <term>--leak-report-full</term>
 354         <listitem>
 355                 <para>
 356                         Enable full talloc leak reporting on exit.
 357                 </para>
 358         </listitem>
 359 </varlistentry>
 360 '>
 361
 362 <!ENTITY cmdline.common.samba.client '
 363 &cmdline.common.debug.client;
 364 &cmdline.common.config.client;
 365 &cmdline.common.option;
 366 &cmdline.common.samba.logbasename;
 367 &cmdline.common.samba.leakreport;
 368 &cmdline.common.samba.leakreportfull;
 369 &cmdline.version;
 370 '>
 371
 372 <!ENTITY cmdline.common.samba.server '
 373 &cmdline.common.debug.server;
 374 &cmdline.common.config.server;
 375 &cmdline.common.option;
 376 &cmdline.common.samba.logbasename;
 377 &cmdline.common.samba.leakreport;
 378 &cmdline.common.samba.leakreportfull;
 379 &cmdline.version;
 380 '>
 381
 382 <!ENTITY cmdline.common.connection.nameresolve '
 383 <varlistentry>
 384         <term>-R|--name-resolve=NAME-RESOLVE-ORDER</term>
 385         <listitem>
 386                 <para>
 387                         This option is used to determine what naming services
 388                         and in what order to resolve host names to IP
 389                         addresses. The option takes a space-separated string of
 390                         different name resolution options. The best is to wrap
 391                         the whole --name-resolve=NAME-RESOLVE-ORDER into
 392                         quotes.
 393                 </para>
 394
 395                 <para>
 396                         The options are: "lmhosts", "host", "wins" and "bcast".
 397                         They cause names to be resolved as follows:
 398                 </para>
 399
 400                 <itemizedlist>
 401                         <listitem>
 402                                 <para>
 403                                         <constant>lmhosts</constant>: Lookup an
 404                                         IP address in the Samba lmhosts file.
 405                                         If the line in lmhosts has no name type
 406                                         attached to the NetBIOS name (see the
 407                                         <citerefentry><refentrytitle>lmhosts</refentrytitle>
 408                                         <manvolnum>5</manvolnum></citerefentry>
 409                                         for details) then any name type matches
 410                                         for lookup.
 411                                 </para>
 412                         </listitem>
 413
 414                         <listitem>
 415                                 <para>
 416                                         <constant>host</constant>: Do a
 417                                         standard host name to IP address
 418                                         resolution, using the system
 419                                         <filename>/etc/hosts</filename>, NIS,
 420                                         or DNS lookups. This method of name
 421                                         resolution is operating system
 422                                         dependent, for instance on IRIX or
 423                                         Solaris this may be controlled by the
 424                                         <filename>/etc/nsswitch.conf
 425                                         </filename> file).  Note that this
 426                                         method is only used if the NetBIOS name
 427                                         type being queried is the 0x20 (server)
 428                                         name type, otherwise it is ignored.
 429                                 </para>
 430                         </listitem>
 431
 432                         <listitem>
 433                                 <para>
 434                                         <constant>wins</constant>: Query a name
 435                                         with the IP address listed in the
 436                                         <parameter>wins server</parameter>
 437                                         parameter.  If no WINS server has been
 438                                         specified this method will be ignored.
 439                                 </para>
 440                         </listitem>
 441
 442                         <listitem>
 443                                 <para>
 444                                         <constant>bcast</constant>: Do a
 445                                         broadcast on each of the known local
 446                                         interfaces listed in the
 447                                         <parameter>interfaces</parameter>
 448                                         parameter. This is the least reliable
 449                                         of the name resolution methods as it
 450                                         depends on the target host being on a
 451                                         locally connected subnet.
 452                                 </para>
 453                         </listitem>
 454                 </itemizedlist>
 455
 456                 <para>
 457                         If this parameter is not set then the name resolve
 458                         order defined in the &smb.conf; file parameter
 459                         (<smbconfoption name="name resolve order" />) will be
 460                         used.
 461                 </para>
 462
 463                 <para>
 464                         The default order is lmhosts, host, wins, bcast.
 465                         Without this parameter or any entry in the
 466                         <smbconfoption name="name resolve order" /> parameter
 467                         of the &smb.conf; file, the name resolution methods
 468                         will be attempted in this order.
 469                 </para>
 470         </listitem>
 471 </varlistentry>
 472 '>
 473
 474 <!ENTITY cmdline.common.connection.socketoptions '
 475 <varlistentry>
 476         <term>-O|--socket-options=SOCKETOPTIONS</term>
 477         <listitem>
 478                 <para>
 479                         TCP socket options to set on the client socket. See the
 480                         socket options parameter in the &smb.conf; manual page
 481                         for the list of valid options.
 482                 </para>
 483         </listitem>
 484 </varlistentry>
 485 '>
 486
 487 <!ENTITY cmdline.common.connection.netbiosname '
 488 <varlistentry>
 489         <term>-n|--netbiosname=NETBIOSNAME</term>
 490         <listitem>
 491                 <para>
 492                         This option allows you to override the NetBIOS name
 493                         that Samba uses for itself. This is identical to
 494                         setting the <smbconfoption name="netbios name" />
 495                         parameter in the &smb.conf; file.  However, a command
 496                         line setting will take precedence over settings in
 497                         &smb.conf;.
 498                 </para>
 499         </listitem>
 500 </varlistentry>
 501 '>
 502
 503 <!ENTITY cmdline.common.connection.workgroup '
 504 <varlistentry>
 505         <term>-W|--workgroup=WORKGROUP</term>
 506         <listitem>
 507                 <para>
 508                         Set the SMB domain of the username.   This overrides
 509                         the default domain which is the domain defined in
 510                         smb.conf.  If the domain specified is the same as the
 511                         servers NetBIOS name, it causes the client to log on
 512                         using the servers local SAM (as opposed to the Domain
 513                         SAM).
 514                 </para>
 515
 516                 <para>
 517                         Note that specifying this parameter here will override
 518                         the <smbconfoption name="workgroup" /> parameter in the
 519                         &smb.conf; file.
 520                 </para>
 521         </listitem>
 522 </varlistentry>
 523 '>
 524
 525 <!ENTITY cmdline.common.connection.realm '
 526 <varlistentry>
 527         <term>-r|--realm=REALM</term>
 528         <listitem>
 529                 <para>
 530                         Set the realm for the domain.
 531                 </para>
 532
 533                 <para>
 534                         Note that specifying this parameter here will override
 535                         the <smbconfoption name="realm" /> parameter in the
 536                         &smb.conf; file.
 537                 </para>
 538         </listitem>
 539 </varlistentry>'>
 540
 541 <!ENTITY cmdline.common.connection.netbiosscope '
 542 <varlistentry>
 543         <term>--netbios-scope=SCOPE</term>
 544         <listitem>
 545                 <para>
 546                         This specifies a NetBIOS scope that
 547                         <command>nmblookup</command> will use to communicate
 548                         with when generating NetBIOS names. For details on the
 549                         use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt.
 550                         NetBIOS scopes are <emphasis>very</emphasis> rarely
 551                         used, only set this parameter if you are the system
 552                         administrator in charge of all the NetBIOS systems you
 553                         communicate with.
 554                 </para>
 555         </listitem>
 556 </varlistentry>
 557 '>
 558
 559 <!ENTITY cmdline.common.connection.max-protocol '
 560 <varlistentry>
 561         <term>-m|--max-protocol=MAXPROTOCOL</term>
 562         <listitem>
 563                 <para>
 564                         The value of the parameter (a string) is the highest
 565                         protocol level that will be supported by the client.
 566                 </para>
 567
 568                 <para>
 569                         Note that specifying this parameter here will override
 570                         the <smbconfoption name="client max protocol" />
 571                         parameter in the &smb.conf; file.
 572                 </para>
 573         </listitem>
 574 </varlistentry>
 575 '>
 576
 577 <!ENTITY cmdline.common.connection '
 578 &cmdline.common.connection.nameresolve;
 579 &cmdline.common.connection.socketoptions;
 580 &cmdline.common.connection.max-protocol;
 581 &cmdline.common.connection.netbiosname;
 582 &cmdline.common.connection.netbiosscope;
 583 &cmdline.common.connection.workgroup;
 584 &cmdline.common.connection.realm;
 585 '>
 586
 587 <!ENTITY pct "&#37;">
 588
 589 <!ENTITY cmdline.common.credentials.user '
 590 <varlistentry>
 591         <term>-U|--user=[DOMAIN\]USERNAME[&pct;PASSWORD]</term>
 592         <listitem>
 593                 <para>
 594                         Sets the SMB username or username and password.
 595                 </para>
 596
 597                 <para>
 598                         If &pct;PASSWORD is not specified, the user will be
 599                         prompted. The client will first check the
 600                         <envar>USER</envar> environment variable
 601                         (which is also permitted to also contain the
 602                         password separated by a &pct;), then the
 603                         <envar>LOGNAME</envar> variable (which is not
 604                         permitted to contain a password) and if either exists,
 605                         the value is used. If these environmental
 606                         variables are not found, the username
 607                         found in a Kerberos Credentials cache may be used.
 608                 </para>
 609
 610                 <para>
 611                         A third option is to use a credentials file which
 612                         contains the plaintext of the username and password.
 613                         This option is mainly provided for scripts where the
 614                         admin does not wish to pass the credentials on the
 615                         command line or via environment variables. If this
 616                         method is used, make certain that the permissions on
 617                         the file restrict access from unwanted users.  See the
 618                         <parameter>-A</parameter> for more details.
 619                 </para>
 620
 621                 <para>
 622                         Be cautious about including passwords in scripts
 623                         or passing user-supplied values onto the command line. For
 624                         security it is better to let the Samba client tool ask for the
 625                         password if needed, or obtain the password once with <command>kinit</command>.
 626                 </para>
 627                 <para>
 628                         While Samba will attempt to scrub the password
 629                         from the process title (as seen in ps), this
 630                         is after startup and so is subject to a race.
 631                 </para>
 632         </listitem>
 633 </varlistentry>
 634 '>
 635
 636 <!ENTITY cmdline.common.credentials.nopass '
 637 <varlistentry>
 638         <term>-N|--no-pass</term>
 639         <listitem>
 640                 <para>
 641                         If specified, this parameter suppresses the normal
 642                         password prompt from the client to the user. This is
 643                         useful when accessing a service that does not require a
 644                         password.
 645                 </para>
 646
 647                 <para>
 648                         Unless a password is specified on the command line or
 649                         this parameter is specified, the client will request a
 650                         password.
 651                 </para>
 652
 653                 <para>
 654                         If a password is specified on the command line and this
 655                         option is also defined the password on the command line
 656                         will be silently ignored and no password will be
 657                         used.
 658                 </para>
 659         </listitem>
 660 </varlistentry>
 661 '>
 662
 663 <!ENTITY cmdline.common.credentials.password '
 664 <varlistentry>
 665         <term>--password</term>
 666         <listitem>
 667                 <para>
 668                         Specify the password on the commandline.
 669                 </para>
 670
 671                 <para> Be cautious about including passwords in
 672                         scripts or passing user-supplied values onto
 673                         the command line. For security it is better to
 674                         let the Samba client tool ask for the password
 675                         if needed, or obtain the password once with
 676                         <command>kinit</command>.
 677                 </para>
 678
 679                 <para> If --password is not specified,
 680                        the tool will check the <envar>PASSWD</envar>
 681                        environment variable, followed by <envar>PASSWD_FD</envar>
 682                        which is expected to contain an open
 683                        file descriptor (FD) number.
 684                 </para>
 685                 <para>
 686                        Finally it will check <envar>PASSWD_FILE</envar> (containing
 687                        a file path to be opened). The file should only
 688                        contain the password. Make certain that the
 689                        permissions on the file restrict
 690                        access from unwanted users!
 691                 </para>
 692                 <para>
 693                         While Samba will attempt to scrub the password
 694                         from the process title (as seen in ps), this
 695                         is after startup and so is subject to a race.
 696                 </para>
 697         </listitem>
 698 </varlistentry>
 699 '>
 700
 701 <!ENTITY cmdline.common.credentials.pwnthash '
 702 <varlistentry>
 703         <term>--pw-nt-hash</term>
 704         <listitem>
 705                 <para>
 706                         The supplied password is the NT hash.
 707                 </para>
 708         </listitem>
 709 </varlistentry>
 710 '>
 711
 712 <!ENTITY cmdline.common.credentials.authenticationfile '
 713 <varlistentry>
 714         <term>-A|--authentication-file=filename</term>
 715         <listitem>
 716                 <para>
 717                         This option allows you to specify a file from which to
 718                         read the username and password used in the connection.
 719                         The format of the file is:
 720                 </para>
 721
 722                 <para>
 723                         <programlisting>
 724                                 username = &lt;value&gt;
 725                                 password = &lt;value&gt;
 726                                 domain   = &lt;value&gt;
 727                         </programlisting>
 728                 </para>
 729
 730                 <para>
 731                         Make certain that the permissions on the file restrict
 732                         access from unwanted users!
 733                 </para>
 734         </listitem>
 735 </varlistentry>
 736 '>
 737
 738 <!ENTITY cmdline.common.credentials.machinepass '
 739 <varlistentry>
 740         <term>-P|--machine-pass</term>
 741         <listitem>
 742                 <para>
 743                         Use stored machine account password.
 744                 </para>
 745         </listitem>
 746 </varlistentry>
 747 '>
 748
 749 <!ENTITY cmdline.common.credentials.simplebinddn '
 750 <varlistentry>
 751         <term>--simple-bind-dn=DN</term>
 752         <listitem>
 753                 <para>
 754                         DN to use for a simple bind.
 755                 </para>
 756         </listitem>
 757 </varlistentry>
 758 '>
 759
 760 <!ENTITY cmdline.common.credentials.usekerberos '
 761 <varlistentry>
 762         <term>--use-kerberos=desired|required|off</term>
 763         <listitem>
 764                 <para>
 765                          This parameter determines whether Samba client tools
 766                          will try to authenticate using Kerberos. For Kerberos
 767                          authentication you need to use dns names instead of IP
 768                          addresses when connecting to a service.
 769                 </para>
 770
 771                 <para>
 772                         Note that specifying this parameter here will override
 773                         the <smbconfoption name="client use kerberos" />
 774                         parameter in the &smb.conf; file.
 775                 </para>
 776         </listitem>
 777 </varlistentry>
 778 '>
 779
 780 <!ENTITY cmdline.common.credentials.usekrb5ccache '
 781 <varlistentry>
 782         <term>--use-krb5-ccache=CCACHE</term>
 783         <listitem>
 784                 <para>
 785                         Specifies the credential cache location for Kerberos
 786                         authentication.
 787                 </para>
 788
 789                 <para>
 790                         This will set --use-kerberos=required too.
 791                 </para>
 792         </listitem>
 793 </varlistentry>
 794 '>
 795
 796 <!ENTITY cmdline.common.credentials.usewinbindccache '
 797 <varlistentry>
 798         <term>--use-winbind-ccache</term>
 799         <listitem>
 800                 <para>
 801                         Try to use the credential cache by winbind.
 802                 </para>
 803         </listitem>
 804 </varlistentry>
 805 '>
 806
 807 <!ENTITY cmdline.common.credentials.clientprotection '
 808 <varlistentry>
 809         <term>--client-protection=sign|encrypt|off</term>
 810         <listitem>
 811                 <para>
 812                         Sets the connection protection the client tool should
 813                         use.
 814                 </para>
 815
 816                 <para>
 817                         Note that specifying this parameter here will override
 818                         the <smbconfoption name="client protection" />
 819                         parameter in the &smb.conf; file.
 820                 </para>
 821
 822                 <para>
 823                         In case you need more fine grained control you can use:
 824                         <command>--option=clientsmbencrypt=OPTION</command>,
 825                         <command>--option=clientipcsigning=OPTION</command>,
 826                         <command>--option=clientsigning=OPTION</command>.
 827                 </para>
 828         </listitem>
 829 </varlistentry>
 830 '>
 831
 832 <!ENTITY cmdline.common.credentials '
 833 &cmdline.common.credentials.user;
 834 &cmdline.common.credentials.nopass;
 835 &cmdline.common.credentials.password;
 836 &cmdline.common.credentials.pwnthash;
 837 &cmdline.common.credentials.authenticationfile;
 838 &cmdline.common.credentials.machinepass;
 839 &cmdline.common.credentials.simplebinddn;
 840 &cmdline.common.credentials.usekerberos;
 841 &cmdline.common.credentials.usekrb5ccache;
 842 &cmdline.common.credentials.usewinbindccache;
 843 &cmdline.common.credentials.clientprotection;
 844 '>
 845
 846 <!ENTITY cmdline.legacy.kerberos.s3 '
 847 <varlistentry>
 848         <term>-k|--kerberos</term>
 849         <listitem>
 850                 <para>
 851                         Use kerberos authentication. This option is deprecated.
 852                         Migrate to --use-kerberos!
 853                 </para>
 854         </listitem>
 855 </varlistentry>
 856 '>
 857
 858 <!ENTITY cmdline.legacy.kerberos.s4 '
 859 <varlistentry>
 860         <term>-k|--kerberos=yes|no</term>
 861         <listitem>
 862                 <para>
 863                         Whether to use kerberos authentication. This option is
 864                         deprecated. Migrate to --use-kerberos!
 865                 </para>
 866         </listitem>
 867 </varlistentry>
 868 '>
 869
 870
 871
 872
 873 <!ENTITY stdarg.help '
 874 <varlistentry>
 875 <term>-?|--help</term>
 876 <listitem><para>Print a summary of command line options.
 877 </para></listitem>
 878 </varlistentry>
 879 '>
 880
 881 <!ENTITY stdarg.usage '
 882 <varlistentry>
 883 <term>--usage</term>
 884 <listitem><para>Display brief usage message.
 885 </para></listitem>
 886 </varlistentry>
 887 '>
 888
 889 <!ENTITY popt.autohelp '
 890 &stdarg.help;
 891 &stdarg.usage;
 892 '>
 893
 894 <!-- Entities for the various programs -->
 895 <!ENTITY OL '<application>OpenLDAP</application>'>
 896 <!ENTITY smbd '<application>smbd</application>'>
 897 <!ENTITY nmbd '<application>nmbd</application>'>
 898 <!ENTITY testparm '<application>testparm</application>'>
 899 <!ENTITY smb.conf '<filename>&pathconfig.CONFIGFILE;</filename>'>
 900 <!ENTITY smbclient '<application>smbclient</application>'>
 901 <!ENTITY winbindd '<application>winbindd</application>'>
 902 <!ENTITY net '<application>net</application>'>
 903
 904 <!ENTITY not.implemented "<note><para>Currently NOT implemented.</para></note>">
 905 <!ENTITY rootprompt "<prompt>root# </prompt>">
 906 <!ENTITY prompt "<prompt>$ </prompt>">
 907 <!ENTITY dosprompt "<prompt>C:\&gt; </prompt>">
 908
 909 <!ENTITY example.workgroup "MIDEARTH">
 910 <!ENTITY example.server.samba "GANDALF">
 911 <!ENTITY example.server.windows "SARUMAN">
 912 <!ENTITY example.workstation.windows "FRODO">
 913 <!ENTITY example.workstation.samba "BILBO">
 914 <!ENTITY example.pdc.samba "SAURON">
 915 <!ENTITY example.server.wins "noldor">
 916
 917 <!ENTITY smbmdash "<?latex --- ?>">