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>
96 <!ENTITY author.eroseme '
98 <firstname>Eric
</firstname><surname>Roseme
</surname>
100 <orgname>HP Oplocks Usage Recommendations Whitepaper
</orgname>
101 <address><email>eric.roseme@hp.com
</email></address>
107 <!ENTITY url.samba.cvsinfo 'http://pserver.samba.org/samba/cvs.html'
>
108 <!ENTITY url.pdc-howto.local 'samba-pdc-howto.html'
>
109 <!ENTITY url.samba-tng 'http://www.samba-tng.org'
>
110 <!ENTITY url.samba.doc 'http://bioserve.latrobe.edu.au/samba/'
>
111 <!ENTITY url.ultraedit 'http://www.ultraedit.com'
>
112 <!ENTITY url.vi-windows 'http://home.snafu.de/ramo/WinViEn.htm'
>
113 <!ENTITY url.pfe 'http://www.lancs.ac.uk/people/cpaap/pfe/'
>
114 <!ENTITY url.server-tools.win95 'ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE'
>
115 <!ENTITY url.server-tools.winnt 'ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE'
>
116 <!ENTITY url.tcpdump 'http://www.tcpdump.org/'
>
117 <!ENTITY url.samba 'http://samba.org'
>
118 <!ENTITY url.samba-ldap-howto 'http://www.unav.es/cti/ldap-smb-howto.html'
>
119 <!ENTITY url.samba-tng.home 'http://www.kneschke.de/projekte/samba_tng/'
>
120 <!ENTITY url.samba.mailinglist.ntdom 'http://lists.samba.org/mailman/samba-ntdom'
>
121 <!ENTITY url.samba.cifs 'http://samba.org/cifs/'
>
122 <!ENTITY url.ntdomains-for-unix 'http://mailhost.cb1.com/~lkcl/ntdom/'
>
123 <!ENTITY url.samba.specs.old 'ftp://ftp.microsoft.com/developr/drg/CIFS/'
>
124 <!ENTITY url.rfc
.1001 'http://ds.internic.net/rfc/rfc1001.txt'
>
125 <!ENTITY url.rfc
.1002 'http://ds.internic.net/rfc/rfc1002.txt'
>
128 <!ENTITY samba.pub.cvshost 'pserver.samba.org'
>
130 <!ENTITY stdarg.debug '
132 <term>-d|--debug=debuglevel
</term>
134 <para><replaceable>debuglevel
</replaceable> is an integer
135 from
0 to
10. The default value if this parameter is
136 not specified is zero.
</para>
138 <para>The higher this value, the more detail will be
139 logged to the log files about the activities of the
140 server. At level
0, only critical errors and serious
141 warnings will be logged. Level
1 is a reasonable level for
142 day to day running - it generates a small amount of
143 information about operations carried out.
</para>
145 <para>Levels above
1 will generate considerable
146 amounts of log data, and should only be used when
147 investigating a problem. Levels above
3 are designed for
148 use only by developers and generate HUGE amounts of log
149 data, most of which is extremely cryptic.
</para>
151 <para>Note that specifying this parameter here will
152 override the
<ulink url=
"smb.conf.5.html#loglevel">log
153 level
</ulink> parameter in the
<ulink url=
"smb.conf.5.html">
154 <filename>smb.conf(
5)
</filename></ulink> file.
</para>
158 <!ENTITY stdarg.configfile '
160 <term>-s
<configuration file
></term>
161 <listitem><para>The file specified contains the
162 configuration details required by the server. The
163 information in this file includes server-specific
164 information such as what printcap file to use, as well
165 as descriptions of all the services that the server is
166 to provide. See
<ulink url=
"smb.conf.5.html"><filename>
167 smb.conf(
5)
</filename></ulink> for more information.
168 The default configuration file name is determined at
169 compile time.
</para></listitem>
172 <!ENTITY stdarg.version '
175 <listitem><para>Prints the version number for
176 <command>smbd
</command>.
</para></listitem>
179 <!ENTITY stdarg.logfile '
181 <term>-l|--logfile=logbasename
</term>
182 <listitem><para>File name for log/debug files. The extension
183 <constant>".client"</constant> will be appended. The log file is
184 never removed by the client.
188 <!ENTITY popt.common.samba '
195 <!ENTITY stdarg.resolve.order '
197 <term>-R
<name resolve order
></term>
198 <listitem><para>This option is used to determine what naming
199 services and in what order to resolve
200 host names to IP addresses. The option takes a space-separated
201 string of different name resolution options.
</para>
203 <para>The options are:
"lmhosts",
"host",
"wins" and
"bcast".
204 They cause names to be resolved as follows :
</para>
207 <listitem><para><constant>lmhosts
</constant>:
208 Lookup an IP address in the Samba lmhosts file. If the
209 line in lmhosts has no name type attached to the
211 (see the
<citerefentry><refentrytitle>lmhosts
</refentrytitle>
212 <manvolnum>5</manvolnum></citerefentry> for details)
213 then any name type matches for lookup.
216 <listitem><para><constant>host
</constant>:
217 Do a standard host name to IP address resolution, using
218 the system
<filename>/etc/hosts
</filename>, NIS, or DNS
219 lookups. This method of name resolution is operating
220 system dependent, for instance on IRIX or Solaris this
221 may be controlled by the
<filename>/etc/nsswitch.conf
222 </filename> file). Note that this method is only used
223 if the NetBIOS name type being queried is the
0x20
224 (server) name type, otherwise it is ignored.
227 <listitem><para><constant>wins
</constant>:
228 Query a name with the IP address listed in the
229 <parameter>wins server
</parameter> parameter. If no
230 WINS server has been specified this method will be
234 <listitem><para><constant>bcast
</constant>:
235 Do a broadcast on each of the known local interfaces
236 listed in the
<parameter>interfaces
</parameter>
237 parameter. This is the least reliable of the name
238 resolution methods as it depends on the target host
239 being on a locally connected subnet.
243 <para>If this parameter is not set then the name resolve order
244 defined in the
<citerefentry><refentrytitle>smb.conf
</refentrytitle>
245 <manvolnum>5</manvolnum></citerefentry> file parameter
246 (
<parameter>name resolve order
</parameter>) will be used.
</para>
248 <para>The default order is lmhosts, host, wins, bcast. Without
249 this parameter or any entry in the
<parameter>name resolve order
250 </parameter> parameter of the
<citerefentry><refentrytitle>smb.conf
</refentrytitle>
251 <manvolnum>5</manvolnum></citerefentry> file, the name resolution methods
252 will be attempted in this order.
</para></listitem>
255 <!ENTITY stdarg.netbios.name '
257 <term>-n
<primary NetBIOS name
></term>
258 <listitem><para>This option allows you to override
259 the NetBIOS name that Samba uses for itself. This is identical
260 to setting the
<ulink url=
"smb.conf.5.html#netbiosname"><parameter>NetBIOS
261 name
</parameter></ulink> parameter in the
<citerefentry><refentrytitle>smb.conf
</refentrytitle>
262 <manvolnum>5</manvolnum></citerefentry> file. However, a command
263 line setting will take precedence over settings in
264 <citerefentry><refentrytitle>smb.conf
</refentrytitle>
265 <manvolnum>5</manvolnum></citerefentry>.
</para></listitem>
268 <!ENTITY stdarg.scope '
270 <term>-i
<scope
></term>
271 <listitem><para>This specifies a NetBIOS scope that
272 <command>nmblookup
</command> will use to communicate with when
273 generating NetBIOS names. For details on the use of NetBIOS
274 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
275 <emphasis>very
</emphasis> rarely used, only set this parameter
276 if you are the system administrator in charge of all the
277 NetBIOS systems you communicate with.
</para></listitem>
280 <!ENTITY stdarg.workgroup '
282 <term>-W|--workgroup=domain
</term>
283 <listitem><para>Set the SMB domain of the username. This
284 overrides the default domain which is the domain defined in
285 smb.conf. If the domain specified is the same as the servers
286 NetBIOS name, it causes the client to log on using the servers local
287 SAM (as opposed to the Domain SAM).
</para></listitem>
290 <!ENTITY stdarg.socket.options '
292 <term>-O socket options
</term>
293 <listitem><para>TCP socket options to set on the client
294 socket. See the socket options parameter in
295 the
<citerefentry><refentrytitle>smb.conf
</refentrytitle>
296 <manvolnum>5</manvolnum></citerefentry> manual page for the list of valid
297 options.
</para></listitem>
301 <!ENTITY popt.common.connection '
302 &stdarg.netbios.name;
305 &stdarg.socket.options;
308 <!ENTITY stdarg.nopass '
311 <listitem><para>If specified, this parameter suppresses the normal
312 password prompt from the client to the user. This is useful when
313 accessing a service that does not require a password.
</para>
315 <para>Unless a password is specified on the command line or
316 this parameter is specified, the client will request a
317 password.
</para></listitem>
320 <!ENTITY stdarg.username '
322 <term>-U|--user=username[
%password]
</term>
323 <listitem><para>Sets the SMB username or username and password.
</para>
325 <para>If
%password is not specified, the user will be prompted. The
326 client will first check the
<envar>USER
</envar> environment variable, then the
327 <envar>LOGNAME
</envar> variable and if either exists, the
328 string is uppercased. If these environmental variables are not
329 found, the username
<constant>GUEST
</constant> is used.
</para>
331 <para>A third option is to use a credentials file which
332 contains the plaintext of the username and password. This
333 option is mainly provided for scripts where the admin does not
334 wish to pass the credentials on the command line or via environment
335 variables. If this method is used, make certain that the permissions
336 on the file restrict access from unwanted users. See the
337 <parameter>-A
</parameter> for more details.
</para>
339 <para>Be cautious about including passwords in scripts. Also, on
340 many systems the command line of a running process may be seen
341 via the
<command>ps
</command> command. To be safe always allow
342 <command>rpcclient
</command> to prompt for a password and type
343 it in directly.
</para></listitem>
347 <!ENTITY stdarg.authfile '
349 <term>-A|--authfile=filename
</term>
350 <listitem><para>This option allows
351 you to specify a file from which to read the username and
352 password used in the connection. The format of the file is
355 <para><programlisting>
356 username =
<value
>
357 password =
<value
>
358 domain =
<value
>
359 </programlisting></para>
361 <para>Make certain that the permissions on the file restrict
362 access from unwanted users.
</para></listitem>
365 <!ENTITY stdarg.kerberos '
369 Try to authenticate with kerberos. Only useful in
370 an Active Directory environment.
376 <!ENTITY stdarg.help '
378 <term>-h|--help
</term>
379 <listitem><para>Print a summary of command line options.
383 <!ENTITY popt.common.credentials '
390 <!-- Entities for the various programs -->
391 <!ENTITY smbd '
<application>smbd
</application>'
>
392 <!ENTITY nmbd '
<application>nmbd
</application>'
>
393 <!ENTITY testparm '
<application>testparm
</application>'
>
394 <!ENTITY smb.conf '
<filename>smb.conf
</filename>'
>
395 <!ENTITY smbclient '
<application>smbclient
</application>'
>
396 <!ENTITY winbindd '
<application>winbindd
</application>'
>
397 <!ENTITY net '
<application>net
</application>'
>
399 <!-- We only need this for SGML, and not for XML... -->
400 <!-- <!ENTITY percnt '%'> -->
402 <!-- IDs for various Samba documentation sections -->
404 <!ENTITY ID-UNIX-INSTALL SYSTEM
"install">
405 <!ENTITY ID-ENCRYPTION SYSTEM
"pwencrypt">
406 <!ENTITY ID-MS-Dfs-Setup SYSTEM
"msdfs">
407 <!ENTITY ID-PRINTER-DRIVER2 SYSTEM
"printing">
408 <!ENTITY ID-DOMAIN-MEMBER SYSTEM
"domain-security">
409 <!ENTITY ID-WINBIND SYSTEM
"winbind">
410 <!ENTITY ID-NT-Security SYSTEM
"unix-permissions">
411 <!ENTITY ID-Samba-PDC-HOWTO SYSTEM
"samba-pdc">
412 <!ENTITY ID-Samba-BDC-HOWTO SYSTEM
"samba-bdc">
413 <!ENTITY ID-CVS-Access SYSTEM
"cvs-access">
414 <!ENTITY ID-IntegratingWithWindows SYSTEM
"integrate-ms-networks">
415 <!ENTITY ID-Samba-PAM SYSTEM
"pam">
416 <!ENTITY ID-Samba-LDAP SYSTEM
"samba-ldap-howto">
417 <!ENTITY ID-Diagnosis SYSTEM
"diagnosis">
418 <!ENTITY ID-BUGS SYSTEM
"bugreport">
419 <!ENTITY ID-StandAloneServer SYSTEM
"standaloneserver">
420 <!ENTITY ID-SPEED SYSTEM
"speed">
421 <!ENTITY ID-NetworkBrowsing SYSTEM
"network-browsing">
422 <!ENTITY ID-GROUP-MAPPING-HOWTO SYSTEM
"groupmapping">
423 <!ENTITY ID-Portability SYSTEM
"Portability">
424 <!ENTITY ID-Other-Clients SYSTEM
"Other-Clients">
425 <!ENTITY ID-pdb-mysql SYSTEM
"pdb-mysql">
426 <!ENTITY ID-pdb-xml SYSTEM
"pdb-xml">
427 <!ENTITY ID-VFS SYSTEM
"VFS">
428 <!ENTITY ID-Further-Resources SYSTEM
"further-resources">
430 <!ENTITY MANUALPAGES SYSTEM
"manpages/manuals.xml">
431 <!ENTITY MAN-FINDSMB SYSTEM
"manpages/findsmb.1.xml">
432 <!ENTITY MAN-NMBLOOKUP SYSTEM
"manpages/nmblookup.1.xml">
433 <!ENTITY MAN-RPCCLIENT SYSTEM
"manpages/rpcclient.1.xml">
434 <!ENTITY MAN-SMBCACLS SYSTEM
"manpages/smbcacls.1.xml">
435 <!ENTITY MAN-SMBCLIENT SYSTEM
"manpages/smbclient.1.xml">
436 <!ENTITY MAN-SMBCONTROL SYSTEM
"manpages/smbcontrol.1.xml">
437 <!ENTITY MAN-LMHOSTS SYSTEM
"manpages/lmhosts.5.xml">
438 <!ENTITY MAN-SMBCONF SYSTEM
"smbdotconf/smb.conf.5.expanded.xml">
439 <!ENTITY MAN-SAMBA SYSTEM
"manpages/samba.7.xml">
440 <!ENTITY MAN-NET SYSTEM
"manpages/net.8.xml">
441 <!ENTITY MAN-NMBD SYSTEM
"manpages/nmbd.8.xml">
442 <!ENTITY MAN-PDBEDIT SYSTEM
"manpages/pdbedit.8.xml">
443 <!ENTITY MAN-SMBD SYSTEM
"manpages/smbd.8.xml">
444 <!ENTITY MAN-SMBGROUPEDIT SYSTEM
"manpages/smbgroupedit.8.xml">
445 <!ENTITY MAN-SMBMOUNT SYSTEM
"manpages/smbmount.8.xml">
446 <!ENTITY MAN-SMBMNT SYSTEM
"manpages/smbmnt.8.xml">
447 <!ENTITY MAN-SMBPASSWDCONF SYSTEM
"manpages/smbpasswd.5.xml">
448 <!ENTITY MAN-SMBPASSWD SYSTEM
"manpages/smbpasswd.8.xml">
449 <!ENTITY MAN-SMBSH SYSTEM
"manpages/smbsh.1.xml">
450 <!ENTITY MAN-SMBTAR SYSTEM
"manpages/smbtar.1.xml">
451 <!ENTITY MAN-SMBSPOOL SYSTEM
"manpages/smbspool.8.xml">
452 <!ENTITY MAN-SMBSTATUS SYSTEM
"manpages/smbstatus.1.xml">
453 <!ENTITY MAN-SMBUMOUNT SYSTEM
"manpages/smbumount.8.xml">
454 <!ENTITY MAN-SWAT SYSTEM
"manpages/swat.8.xml">
455 <!ENTITY MAN-TDBBACKUP SYSTEM
"manpages/tdbbackup.8.xml">
456 <!ENTITY MAN-TESTPARM SYSTEM
"manpages/testparm.1.xml">
457 <!ENTITY MAN-TESTPRNS SYSTEM
"manpages/testprns.1.xml">
458 <!ENTITY MAN-VFSTEST SYSTEM
"manpages/vfstest.1.xml">
459 <!ENTITY MAN-WBINFO SYSTEM
"manpages/wbinfo.1.xml">
460 <!ENTITY MAN-WINBINDD SYSTEM
"manpages/winbindd.8.xml">
463 <!ENTITY AccessControls SYSTEM
"projdoc/AccessControls.xml">
464 <!ENTITY AdvancedNetworkAdmin SYSTEM
"projdoc/AdvancedNetworkAdmin.xml">
465 <!ENTITY BUGS SYSTEM
"projdoc/Bugs.xml">
466 <!ENTITY CUPS SYSTEM
"projdoc/CUPS-printing.xml">
467 <!ENTITY CVS-Access SYSTEM
"projdoc/CVS-Access.xml">
468 <!ENTITY Compiling SYSTEM
"projdoc/Compiling.xml">
469 <!ENTITY DOMAIN-MEMBER SYSTEM
"projdoc/DOMAIN_MEMBER.xml">
470 <!ENTITY Diagnosis SYSTEM
"projdoc/Diagnosis.xml">
471 <!ENTITY ENCRYPTION SYSTEM
"projdoc/ENCRYPTION.xml">
472 <!ENTITY Further-Resources SYSTEM
"projdoc/Further-Resources.xml">
473 <!ENTITY GROUP-MAPPING-HOWTO SYSTEM
"projdoc/GROUP-MAPPING-HOWTO.xml">
474 <!ENTITY IntegratingWithWindows SYSTEM
"projdoc/Integrating-with-Windows.xml">
475 <!ENTITY IntroSMB SYSTEM
"projdoc/IntroSMB.xml">
476 <!ENTITY MS-Dfs-Setup SYSTEM
"projdoc/msdfs_setup.xml">
477 <!ENTITY NT4Migration SYSTEM
"projdoc/NT4Migration.xml">
478 <!ENTITY NetworkBrowsing SYSTEM
"projdoc/NetworkBrowsing.xml">
479 <!ENTITY Other-Clients SYSTEM
"projdoc/Other-Clients.xml">
480 <!ENTITY PRINTER-DRIVER2 SYSTEM
"projdoc/printer_driver2.xml">
481 <!ENTITY Passdb SYSTEM
"projdoc/passdb.xml">
482 <!ENTITY PolicyMgmt SYSTEM
"projdoc/PolicyMgmt.xml">
483 <!ENTITY Portability SYSTEM
"projdoc/Portability.xml">
484 <!ENTITY ProfileMgmt SYSTEM
"projdoc/ProfileMgmt.xml">
485 <!ENTITY SPEED SYSTEM
"projdoc/Speed.xml">
486 <!ENTITY SWAT SYSTEM
"projdoc/SWAT.xml">
487 <!ENTITY Samba-BDC-HOWTO SYSTEM
"projdoc/Samba-BDC-HOWTO.xml">
488 <!ENTITY Samba-LDAP SYSTEM
"projdoc/Samba-LDAP-HOWTO.xml">
489 <!ENTITY Samba-PAM SYSTEM
"projdoc/PAM-Authentication-And-Samba.xml">
490 <!ENTITY Samba-PDC-HOWTO SYSTEM
"projdoc/Samba-PDC-HOWTO.xml">
491 <!ENTITY SecuringSamba SYSTEM
"projdoc/securing-samba.xml">
492 <!ENTITY ServerType SYSTEM
"projdoc/ServerType.xml">
493 <!ENTITY StandAloneServer SYSTEM
"projdoc/StandAloneServer.xml">
494 <!ENTITY Trusts SYSTEM
"projdoc/InterdomainTrusts.xml">
495 <!ENTITY UNIX-INSTALL SYSTEM
"projdoc/UNIX_INSTALL.xml">
496 <!ENTITY VFS SYSTEM
"projdoc/VFS.xml">
497 <!ENTITY WINBIND SYSTEM
"projdoc/winbind.xml">
498 <!ENTITY locking SYSTEM
"projdoc/locking.xml">
499 <!ENTITY pdb-mysql SYSTEM
"projdoc/pdb_mysql.xml">
500 <!ENTITY pdb.xml SYSTEM
"projdoc/pdb.xml.xml">
501 <!ENTITY problems SYSTEM
"projdoc/Problems.xml">
502 <!ENTITY unicode SYSTEM
"projdoc/unicode.xml">
503 <!ENTITY Further-Resources SYSTEM
"projdoc/Further-Resources.xml">
505 <!ENTITY not.implemented
"<note><para>Currently NOT implemented.</para></note>">