1 <!-- Global Entities File -->
4 <!-- Email Address' -->
5 <!ENTITY email.dbannon 'D.Bannon@latrobe.edu.au'>
6 <!ENTITY email.jmoore 'jmoore@php.net'>
7 <!ENTITY email.jerry 'jerry@samba.org'>
8 <!ENTITY email.patches 'samba-patches@samba.org'>
9 <!ENTITY email.jelmer 'jelmer@samba.org'>
10 <!ENTITY email.jht 'jht@samba.org'>
13 <!-- Author entities -->
14 <!ENTITY person.jelmer '
15 <firstname>Jelmer</firstname><surname>Vernooij</surname><othername>R.</othername>
17 <orgname>The Samba Team</orgname>
18 <address><email>jelmer@samba.org</email></address>
21 <!ENTITY author.jelmer '<author>&person.jelmer;</author>'>
23 <!ENTITY person.jerry '
24 <firstname>Gerald</firstname><surname>Carter</surname><othername>(Jerry)</othername>
26 <orgname>Samba Team</orgname>
27 <address><email>jerry@samba.org</email></address>
30 <!ENTITY author.jerry '<author>&person.jerry;</author>'>
32 <!ENTITY author.jeremy '
34 <firstname>Jeremy</firstname><surname>Allison</surname>
36 <orgname>Samba Team</orgname>
37 <address><email>jra@samba.org</email></address>
42 <firstname>John</firstname><surname>Terpstra</surname><othername>H.</othername>
44 <orgname>Samba Team</orgname>
45 <address><email>jht@samba.org</email></address>
49 <!ENTITY author.jht '<author>&person.jht;</author>'>
51 <!ENTITY author.tridge '
53 <firstname>Andrew</firstname><surname>Tridgell</surname>
55 <orgname>Samba Team</orgname>
56 <address><email>tridge@samba.org</email></address>
60 <!ENTITY author.jmcd '
62 <firstname>Jim</firstname><surname>McDonough</surname>
64 <orgname>IBM</orgname>
65 <address><email>jmcd@us.ibm.com</email></address>
71 <firstname>Volker</firstname><surname>Lendecke</surname>
73 <orgname>Samba Team</orgname>
74 <address><email>Volker.Lendecke@SerNet.DE</email></address>
78 <!ENTITY author.mimir '
80 <firstname>Rafal</firstname><surname>Szczesniak</surname>
82 <orgname>Samba Team</orgname>
83 <address><email>mimir@samba.org</email></address>
87 <!ENTITY author.dlechnyr '
89 <firstname>David</firstname><surname>Lechnyr</surname>
91 <orgname>Unofficial HOWTO</orgname>
92 <address><email>david@lechnyr.com</email></address>
97 <!ENTITY url.samba.cvsinfo 'http://pserver.samba.org/samba/cvs.html'>
98 <!ENTITY url.pdc-howto.local 'samba-pdc-howto.html'>
99 <!ENTITY url.samba-tng 'http://www.samba-tng.org'>
100 <!ENTITY url.samba.doc 'http://bioserve.latrobe.edu.au/samba/'>
101 <!ENTITY url.ultraedit 'http://www.ultraedit.com'>
102 <!ENTITY url.vi-windows 'http://home.snafu.de/ramo/WinViEn.htm'>
103 <!ENTITY url.pfe 'http://www.lancs.ac.uk/people/cpaap/pfe/'>
104 <!ENTITY url.server-tools.win95 'ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE'>
105 <!ENTITY url.server-tools.winnt 'ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE'>
106 <!ENTITY url.tcpdump 'http://www.tcpdump.org/'>
107 <!ENTITY url.samba 'http://samba.org'>
108 <!ENTITY url.samba-ldap-howto 'http://www.unav.es/cti/ldap-smb-howto.html'>
109 <!ENTITY url.samba-tng.home 'http://www.kneschke.de/projekte/samba_tng/'>
110 <!ENTITY url.samba.mailinglist.ntdom 'http://lists.samba.org/mailman/samba-ntdom'>
111 <!ENTITY url.samba.cifs 'http://samba.org/cifs/'>
112 <!ENTITY url.ntdomains-for-unix 'http://mailhost.cb1.com/~lkcl/ntdom/'>
113 <!ENTITY url.samba.specs.old 'ftp://ftp.microsoft.com/developr/drg/CIFS/'>
114 <!ENTITY url.rfc.1001 'http://ds.internic.net/rfc/rfc1001.txt'>
115 <!ENTITY url.rfc.1002 'http://ds.internic.net/rfc/rfc1002.txt'>
118 <!ENTITY samba.pub.cvshost 'pserver.samba.org'>
120 <!ENTITY stdarg.debug '
122 <term>-d|--debug=debuglevel</term>
124 <para><replaceable>debuglevel</replaceable> is an integer
125 from 0 to 10. The default value if this parameter is
126 not specified is zero.</para>
128 <para>The higher this value, the more detail will be
129 logged to the log files about the activities of the
130 server. At level 0, only critical errors and serious
131 warnings will be logged. Level 1 is a reasonable level for
132 day to day running - it generates a small amount of
133 information about operations carried out.</para>
135 <para>Levels above 1 will generate considerable
136 amounts of log data, and should only be used when
137 investigating a problem. Levels above 3 are designed for
138 use only by developers and generate HUGE amounts of log
139 data, most of which is extremely cryptic.</para>
141 <para>Note that specifying this parameter here will
142 override the <ulink url="smb.conf.5.html#loglevel">log
143 level</ulink> parameter in the <ulink url="smb.conf.5.html">
144 <filename>smb.conf(5)</filename></ulink> file.</para>
148 <!ENTITY stdarg.configfile '
150 <term>-s <configuration file></term>
151 <listitem><para>The file specified contains the
152 configuration details required by the server. The
153 information in this file includes server-specific
154 information such as what printcap file to use, as well
155 as descriptions of all the services that the server is
156 to provide. See <ulink url="smb.conf.5.html"><filename>
157 smb.conf(5)</filename></ulink> for more information.
158 The default configuration file name is determined at
159 compile time.</para></listitem>
162 <!ENTITY stdarg.version '
165 <listitem><para>Prints the version number for
166 <command>smbd</command>.</para></listitem>
169 <!ENTITY stdarg.logfile '
171 <term>-l|--logfile=logbasename</term>
172 <listitem><para>File name for log/debug files. The extension
173 <constant>".client"</constant> will be appended. The log file is
174 never removed by the client.
178 <!ENTITY popt.common.samba '
185 <!ENTITY stdarg.resolve.order '
187 <term>-R <name resolve order></term>
188 <listitem><para>This option is used to determine what naming
189 services and in what order to resolve
190 host names to IP addresses. The option takes a space-separated
191 string of different name resolution options.</para>
193 <para>The options are: "lmhosts", "host", "wins" and "bcast".
194 They cause names to be resolved as follows :</para>
197 <listitem><para><constant>lmhosts</constant>:
198 Lookup an IP address in the Samba lmhosts file. If the
199 line in lmhosts has no name type attached to the
201 (see the <citerefentry><refentrytitle>lmhosts</refentrytitle>
202 <manvolnum>5</manvolnum></citerefentry> for details)
203 then any name type matches for lookup.
206 <listitem><para><constant>host</constant>:
207 Do a standard host name to IP address resolution, using
208 the system <filename>/etc/hosts</filename>, NIS, or DNS
209 lookups. This method of name resolution is operating
210 system dependent, for instance on IRIX or Solaris this
211 may be controlled by the <filename>/etc/nsswitch.conf
212 </filename> file). Note that this method is only used
213 if the NetBIOS name type being queried is the 0x20
214 (server) name type, otherwise it is ignored.
217 <listitem><para><constant>wins</constant>:
218 Query a name with the IP address listed in the
219 <parameter>wins server</parameter> parameter. If no
220 WINS server has been specified this method will be
224 <listitem><para><constant>bcast</constant>:
225 Do a broadcast on each of the known local interfaces
226 listed in the <parameter>interfaces</parameter>
227 parameter. This is the least reliable of the name
228 resolution methods as it depends on the target host
229 being on a locally connected subnet.
233 <para>If this parameter is not set then the name resolve order
234 defined in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
235 <manvolnum>5</manvolnum></citerefentry> file parameter
236 (<parameter>name resolve order</parameter>) will be used. </para>
238 <para>The default order is lmhosts, host, wins, bcast. Without
239 this parameter or any entry in the <parameter>name resolve order
240 </parameter> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
241 <manvolnum>5</manvolnum></citerefentry> file, the name resolution methods
242 will be attempted in this order. </para></listitem>
245 <!ENTITY stdarg.netbios.name '
247 <term>-n <primary NetBIOS name></term>
248 <listitem><para>This option allows you to override
249 the NetBIOS name that Samba uses for itself. This is identical
250 to setting the <ulink url="smb.conf.5.html#netbiosname"><parameter>NetBIOS
251 name</parameter></ulink> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
252 <manvolnum>5</manvolnum></citerefentry> file. However, a command
253 line setting will take precedence over settings in
254 <citerefentry><refentrytitle>smb.conf</refentrytitle>
255 <manvolnum>5</manvolnum></citerefentry>.</para></listitem>
258 <!ENTITY stdarg.scope '
260 <term>-i <scope></term>
261 <listitem><para>This specifies a NetBIOS scope that
262 <command>nmblookup</command> will use to communicate with when
263 generating NetBIOS names. For details on the use of NetBIOS
264 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
265 <emphasis>very</emphasis> rarely used, only set this parameter
266 if you are the system administrator in charge of all the
267 NetBIOS systems you communicate with.</para></listitem>
270 <!ENTITY stdarg.workgroup '
272 <term>-W|--workgroup=domain</term>
273 <listitem><para>Set the SMB domain of the username. This
274 overrides the default domain which is the domain defined in
275 smb.conf. If the domain specified is the same as the servers
276 NetBIOS name, it causes the client to log on using the servers local
277 SAM (as opposed to the Domain SAM). </para></listitem>
280 <!ENTITY stdarg.socket.options '
282 <term>-O socket options</term>
283 <listitem><para>TCP socket options to set on the client
284 socket. See the socket options parameter in
285 the <citerefentry><refentrytitle>smb.conf</refentrytitle>
286 <manvolnum>5</manvolnum></citerefentry> manual page for the list of valid
287 options. </para></listitem>
291 <!ENTITY popt.common.connection '
292 &stdarg.netbios.name;
295 &stdarg.socket.options;
298 <!ENTITY stdarg.nopass '
301 <listitem><para>If specified, this parameter suppresses the normal
302 password prompt from the client to the user. This is useful when
303 accessing a service that does not require a password. </para>
305 <para>Unless a password is specified on the command line or
306 this parameter is specified, the client will request a
307 password.</para></listitem>
310 <!ENTITY stdarg.username '
312 <term>-U|--user=username[%password]</term>
313 <listitem><para>Sets the SMB username or username and password. </para>
315 <para>If %password is not specified, the user will be prompted. The
316 client will first check the <envar>USER</envar> environment variable, then the
317 <envar>LOGNAME</envar> variable and if either exists, the
318 string is uppercased. If these environmental variables are not
319 found, the username <constant>GUEST</constant> is used. </para>
321 <para>A third option is to use a credentials file which
322 contains the plaintext of the username and password. This
323 option is mainly provided for scripts where the admin does not
324 wish to pass the credentials on the command line or via environment
325 variables. If this method is used, make certain that the permissions
326 on the file restrict access from unwanted users. See the
327 <parameter>-A</parameter> for more details. </para>
329 <para>Be cautious about including passwords in scripts. Also, on
330 many systems the command line of a running process may be seen
331 via the <command>ps</command> command. To be safe always allow
332 <command>rpcclient</command> to prompt for a password and type
333 it in directly. </para></listitem>
337 <!ENTITY stdarg.authfile '
339 <term>-A|--authfile=filename</term>
340 <listitem><para>This option allows
341 you to specify a file from which to read the username and
342 password used in the connection. The format of the file is
345 <para><programlisting>
346 username = <value>
347 password = <value>
348 domain = <value>
349 </programlisting></para>
351 <para>Make certain that the permissions on the file restrict
352 access from unwanted users. </para></listitem>
355 <!ENTITY stdarg.kerberos '
359 Try to authenticate with kerberos. Only useful in
360 an Active Directory environment.
366 <!ENTITY stdarg.help '
368 <term>-h|--help</term>
369 <listitem><para>Print a summary of command line options.
373 <!ENTITY popt.common.credentials '
380 <!-- Entities for the various programs -->
381 <!ENTITY smbd '<application>smbd</application>'>
382 <!ENTITY nmbd '<application>nmbd</application>'>
383 <!ENTITY testparm '<application>testparm</application>'>
384 <!ENTITY smb.conf '<filename>smb.conf</filename>'>
385 <!ENTITY smbclient '<application>smbclient</application>'>
386 <!ENTITY winbindd '<application>winbindd</application>'>
387 <!ENTITY net '<application>net</application>'>
389 <!-- We only need this for SGML, and not for XML... -->
392 <!-- IDs for various Samba documentation sections -->
394 <!ENTITY ID-UNIX-INSTALL SYSTEM "install">
395 <!ENTITY ID-ENCRYPTION SYSTEM "pwencrypt">
396 <!ENTITY ID-MS-Dfs-Setup SYSTEM "msdfs">
397 <!ENTITY ID-PRINTER-DRIVER2 SYSTEM "printing">
398 <!ENTITY ID-DOMAIN-MEMBER SYSTEM "domain-security">
399 <!ENTITY ID-WINBIND SYSTEM "winbind">
400 <!ENTITY ID-NT-Security SYSTEM "unix-permissions">
401 <!ENTITY ID-Samba-PDC-HOWTO SYSTEM "samba-pdc">
402 <!ENTITY ID-Samba-BDC-HOWTO SYSTEM "samba-bdc">
403 <!ENTITY ID-CVS-Access SYSTEM "cvs-access">
404 <!ENTITY ID-IntegratingWithWindows SYSTEM "integrate-ms-networks">
405 <!ENTITY ID-Samba-PAM SYSTEM "pam">
406 <!ENTITY ID-Samba-LDAP SYSTEM "samba-ldap-howto">
407 <!ENTITY ID-Diagnosis SYSTEM "diagnosis">
408 <!ENTITY ID-BUGS SYSTEM "bugreport">
409 <!ENTITY ID-SECURITY-LEVEL SYSTEM "securitylevels">
410 <!ENTITY ID-SPEED SYSTEM "speed">
411 <!ENTITY ID-NetworkBrowsing SYSTEM "network-browsing">
412 <!ENTITY ID-GROUP-MAPPING-HOWTO SYSTEM "groupmapping">
413 <!ENTITY ID-Portability SYSTEM "Portability">
414 <!ENTITY ID-Other-Clients SYSTEM "Other-Clients">
415 <!ENTITY ID-ADS-HOWTO SYSTEM "ADS">
416 <!ENTITY ID-pdb-mysql SYSTEM "pdb-mysql">
417 <!ENTITY ID-pdb-xml SYSTEM "pdb-xml">
418 <!ENTITY ID-VFS SYSTEM "VFS">
420 <!ENTITY MANUALPAGES SYSTEM "manpages/manuals.sgml">
421 <!ENTITY MAN-FINDSMB SYSTEM "manpages/findsmb.1.sgml">
422 <!ENTITY MAN-NMBLOOKUP SYSTEM "manpages/nmblookup.1.sgml">
423 <!ENTITY MAN-RPCCLIENT SYSTEM "manpages/rpcclient.1.sgml">
424 <!ENTITY MAN-SMBCACLS SYSTEM "manpages/smbcacls.1.sgml">
425 <!ENTITY MAN-SMBCLIENT SYSTEM "manpages/smbclient.1.sgml">
426 <!ENTITY MAN-SMBCONTROL SYSTEM "manpages/smbcontrol.1.sgml">
427 <!ENTITY MAN-LMHOSTS SYSTEM "manpages/lmhosts.5.sgml">
428 <!ENTITY MAN-SMBCONF SYSTEM "manpages/smb.conf.5.sgml">
429 <!ENTITY MAN-SAMBA SYSTEM "manpages/samba.7.sgml">
430 <!ENTITY MAN-NET SYSTEM "manpages/net.8.sgml">
431 <!ENTITY MAN-NMBD SYSTEM "manpages/nmbd.8.sgml">
432 <!ENTITY MAN-PDBEDIT SYSTEM "manpages/pdbedit.8.sgml">
433 <!ENTITY MAN-SMBD SYSTEM "manpages/smbd.8.sgml">
434 <!ENTITY MAN-SMBGROUPEDIT SYSTEM "manpages/smbgroupedit.8.sgml">
435 <!ENTITY MAN-SMBMOUNT SYSTEM "manpages/smbmount.8.sgml">
436 <!ENTITY MAN-SMBMNT SYSTEM "manpages/smbmnt.8.sgml">
437 <!ENTITY MAN-SMBPASSWDCONF SYSTEM "manpages/smbpasswd.5.sgml">
438 <!ENTITY MAN-SMBPASSWD SYSTEM "manpages/smbpasswd.8.sgml">
439 <!ENTITY MAN-SMBSH SYSTEM "manpages/smbsh.1.sgml">
440 <!ENTITY MAN-SMBTAR SYSTEM "manpages/smbtar.1.sgml">
441 <!ENTITY MAN-SMBSPOOL SYSTEM "manpages/smbspool.8.sgml">
442 <!ENTITY MAN-SMBSTATUS SYSTEM "manpages/smbstatus.1.sgml">
443 <!ENTITY MAN-SMBUMOUNT SYSTEM "manpages/smbumount.8.sgml">
444 <!ENTITY MAN-SWAT SYSTEM "manpages/swat.8.sgml">
445 <!ENTITY MAN-TDBBACKUP SYSTEM "manpages/tdbbackup.8.sgml">
446 <!ENTITY MAN-TESTPARM SYSTEM "manpages/testparm.1.sgml">
447 <!ENTITY MAN-TESTPRNS SYSTEM "manpages/testprns.1.sgml">
448 <!ENTITY MAN-VFSTEST SYSTEM "manpages/vfstest.1.sgml">
449 <!ENTITY MAN-WBINFO SYSTEM "manpages/wbinfo.1.sgml">
450 <!ENTITY MAN-WINBINDD SYSTEM "manpages/winbindd.8.sgml">
453 <!ENTITY ADS-HOWTO SYSTEM "projdoc/ADS-HOWTO.sgml">
454 <!ENTITY AdvancedNetworkAdmin SYSTEM "projdoc/AdvancedNetworkAdmin.sgml">
455 <!ENTITY NetworkBrowsing SYSTEM "projdoc/NetworkBrowsing.sgml">
456 <!ENTITY BUGS SYSTEM "projdoc/Bugs.sgml">
457 <!ENTITY CUPS SYSTEM "projdoc/CUPS-printing.sgml">
458 <!ENTITY CVS-Access SYSTEM "projdoc/CVS-Access.sgml">
459 <!ENTITY Compiling SYSTEM "projdoc/Compiling.sgml">
460 <!ENTITY DOMAIN-MEMBER SYSTEM "projdoc/DOMAIN_MEMBER.sgml">
461 <!ENTITY Diagnosis SYSTEM "projdoc/Diagnosis.sgml">
462 <!ENTITY ENCRYPTION SYSTEM "projdoc/ENCRYPTION.sgml">
463 <!ENTITY GROUP-MAPPING-HOWTO SYSTEM "projdoc/GROUP-MAPPING-HOWTO.sgml">
464 <!ENTITY IntegratingWithWindows SYSTEM "projdoc/Integrating-with-Windows.sgml">
465 <!ENTITY IntroSMB SYSTEM "projdoc/IntroSMB.sgml">
466 <!ENTITY locking SYSTEM "projdoc/locking.sgml">
467 <!ENTITY MS-Dfs-Setup SYSTEM "projdoc/msdfs_setup.sgml">
468 <!ENTITY NT-Security SYSTEM "projdoc/NT_Security.sgml">
469 <!ENTITY NT4Migration SYSTEM "projdoc/NT4Migration.sgml">
470 <!ENTITY Other-Clients SYSTEM "projdoc/Other-Clients.sgml">
471 <!ENTITY PRINTER-DRIVER2 SYSTEM "projdoc/printer_driver2.sgml">
472 <!ENTITY Passdb SYSTEM "projdoc/passdb.sgml">
473 <!ENTITY PolicyMgmt SYSTEM "projdoc/PolicyMgmt.sgml">
474 <!ENTITY Portability SYSTEM "projdoc/Portability.sgml">
475 <!ENTITY ProfileMgmt SYSTEM "projdoc/ProfileMgmt.sgml">
476 <!ENTITY SECURITY-LEVEL SYSTEM "projdoc/security_level.sgml">
477 <!ENTITY SPEED SYSTEM "projdoc/Speed.sgml">
478 <!ENTITY SWAT SYSTEM "projdoc/SWAT.sgml">
479 <!ENTITY Samba-BDC-HOWTO SYSTEM "projdoc/Samba-BDC-HOWTO.sgml">
480 <!ENTITY Samba-LDAP SYSTEM "projdoc/Samba-LDAP-HOWTO.sgml">
481 <!ENTITY Samba-PAM SYSTEM "projdoc/PAM-Authentication-And-Samba.sgml">
482 <!ENTITY Samba-PDC-HOWTO SYSTEM "projdoc/Samba-PDC-HOWTO.sgml">
483 <!ENTITY SecuringSamba SYSTEM "projdoc/securing-samba.sgml">
484 <!ENTITY ServerType SYSTEM "projdoc/ServerType.sgml">
485 <!ENTITY Trusts SYSTEM "projdoc/InterdomainTrusts.sgml">
486 <!ENTITY UNIX-INSTALL SYSTEM "projdoc/UNIX_INSTALL.sgml">
487 <!ENTITY VFS SYSTEM "projdoc/VFS.sgml">
488 <!ENTITY WINBIND SYSTEM "projdoc/winbind.sgml">
489 <!ENTITY pdb-mysql SYSTEM "projdoc/pdb_mysql.sgml">
490 <!ENTITY pdb.sgml SYSTEM "projdoc/pdb.sgml.sgml">
491 <!ENTITY problems SYSTEM "projdoc/Problems.sgml">
492 <!ENTITY unicode SYSTEM "projdoc/unicode.sgml">
494 <!ENTITY not.implemented "<note><para>Currently NOT implemented.</para></note>">