s3-docs: not working for SuSE anymore...
[ira/wip.git] / docs-xml / build / DTD / samba.entities
1 <!--
2         vim:ft=dtd 
3 -->
4
5 <!-- Email Address' -->
6 <!ENTITY email.dbannon 'D.Bannon@latrobe.edu.au'>
7 <!ENTITY email.jerry   'jerry@samba.org'>
8 <!ENTITY email.patches 'samba-patches@samba.org'>
9 <!ENTITY email.jelmer  'jelmer@samba.org'>
10 <!ENTITY email.jht     'jht@samba.org'>
11 <!ENTITY email.ghenry  'ghenry@suretecsystems.com'>
12
13 <!-- Author entities -->
14 <!ENTITY person.jelmer '
15 <firstname>Jelmer</firstname><othername>R.</othername><surname>Vernooij</surname><othername>R.</othername>
16 <affiliation>
17         <orgname>The Samba Team</orgname>
18         <address><email>jelmer@samba.org</email></address>
19 </affiliation>'>
20
21 <!ENTITY author.jelmer '<author>&person.jelmer;</author>'>
22
23 <!ENTITY person.jerry '
24 <firstname>Gerald</firstname><surname>Carter</surname><othername>(Jerry)</othername>
25 <affiliation>
26         <orgname>Samba Team</orgname>
27         <address><email>jerry@samba.org</email></address>
28 </affiliation>'>
29
30 <!ENTITY author.jerry '<author>&person.jerry;</author>'>
31
32 <!ENTITY author.jeremy '
33 <author>
34         <firstname>Jeremy</firstname><surname>Allison</surname>
35         <affiliation>
36                 <orgname>Samba Team</orgname>
37                 <address><email>jra@samba.org</email></address>
38         </affiliation>
39 </author>'>
40
41 <!ENTITY person.jht '
42 <firstname>John</firstname><surname>Terpstra</surname><othername>H.</othername>
43 <affiliation>
44         <orgname>Samba Team</orgname>
45         <address><email>jht@samba.org</email></address>
46 </affiliation>'>
47
48 <!ENTITY author.jht '<author>&person.jht;</author>'>
49
50 <!ENTITY person.gd '
51 <firstname>Guenther</firstname><surname>Deschner</surname>
52 <affiliation>
53         <orgname>Samba Team</orgname>
54         <address><email>gd@samba.org</email></address>
55 </affiliation>'>
56
57 <!ENTITY author.gd '<author>&person.gd;</author>'>
58
59 <!ENTITY person.kauer '
60 <firstname>Karl</firstname><surname>Auer</surname>
61 <affiliation>
62         <orgname>Samba Team</orgname>
63         <address><email>kauer@biplane.com.au</email></address>
64 </affiliation>
65 '>
66
67 <!ENTITY author.kauer '<author>&person.kauer;</author>'>
68
69 <!ENTITY person.danshearer '
70 <firstname>Dan</firstname><surname>Shearer</surname>
71 <affiliation>
72         <orgname>Samba Team</orgname>
73         <address><email>dan@samba.org</email></address>
74 </affiliation>
75 '>
76
77 <!ENTITY author.danshearer '<author>&person.danshearer;</author>'>
78
79 <!ENTITY person.tpot '
80 <firstname>Tim</firstname><surname>Potter</surname>
81 <affiliation>
82         <orgname>Samba Team</orgname>
83         <address><email>tpot@samba.org</email></address>
84 </affiliation>
85 '>
86
87 <!ENTITY author.tpot '<author>&person.tpot;</author>'>
88
89 <!ENTITY author.tridge '
90 <author>
91         <firstname>Andrew</firstname><surname>Tridgell</surname>
92         <affiliation>
93                 <orgname>Samba Team</orgname>
94                 <address><email>tridge@samba.org</email></address>
95         </affiliation>
96 </author>'>
97
98 <!ENTITY person.jmcd '
99         <firstname>Jim</firstname><surname>McDonough</surname>
100         <affiliation>
101                 <orgname>IBM</orgname>
102                 <address><email>jmcd@us.ibm.com</email></address>
103         </affiliation>'>
104
105 <!ENTITY author.jmcd '<author>&person.jmcd;</author>'>
106
107 <!ENTITY person.vl '
108 <firstname>Volker</firstname><surname>Lendecke</surname>
109 <affiliation>
110                 <orgname>Samba Team</orgname>
111                 <address><email>Volker.Lendecke@SerNet.DE</email></address>
112 </affiliation>'>
113
114 <!ENTITY author.vl '<author>&person.vl;</author>'>
115
116 <!ENTITY author.dbannon '
117 <author>
118         <firstname>David</firstname><surname>Bannon</surname>
119         <affiliation>
120                 <orgname>Samba Team</orgname>
121                 <address><email>dbannon@samba.org</email></address>
122         </affiliation>
123 </author>'>
124
125 <!ENTITY author.mimir '
126 <author>
127         <firstname>Rafal</firstname><surname>Szczesniak</surname>
128         <affiliation>
129                 <orgname>Samba Team</orgname>
130                 <address><email>mimir@samba.org</email></address>
131         </affiliation>
132 </author>'>
133
134 <!ENTITY author.dlechnyr '
135 <author>
136         <firstname>David</firstname><surname>Lechnyr</surname>
137         <affiliation>
138                 <orgname>Unofficial HOWTO</orgname>
139                 <address><email>david@lechnyr.com</email></address>
140         </affiliation>
141 </author>'>
142
143 <!ENTITY author.eroseme '
144 <author>
145         <firstname>Eric</firstname><surname>Roseme</surname>
146         <affiliation>
147                 <orgname>HP Oplocks Usage Recommendations Whitepaper</orgname>
148                 <address><email>eric.roseme@hp.com</email></address>
149         </affiliation>
150 </author>'>
151
152 <!ENTITY author.ghenry '
153 <author>
154         <firstname>Gavin</firstname><surname>Henry</surname>
155         <affiliation>
156                 <orgname>Suretec Systems Limited, UK</orgname>
157                 <address><email>ghenry@suretecsystems.com</email></address>
158         </affiliation>
159 </author>'>
160
161 <!ENTITY stdarg.server.debug '
162 <varlistentry>
163 <term>-d|--debuglevel=level</term>
164 <listitem>
165 <para><replaceable>level</replaceable> is an integer 
166 from 0 to 10. The default value if this parameter is 
167 not specified is 0.</para>
168
169 <para>The higher this value, the more detail will be 
170 logged to the log files about the activities of the 
171 server. At level 0, only critical errors and serious 
172 warnings will be logged. Level 1 is a reasonable level for
173 day-to-day running - it generates a small amount of 
174 information about operations carried out.</para>
175
176 <para>Levels above 1 will generate considerable 
177 amounts of log data, and should only be used when 
178 investigating a problem. Levels above 3 are designed for 
179 use only by developers and generate HUGE amounts of log
180 data, most of which is extremely cryptic.</para>
181
182 <para>Note that specifying this parameter here will 
183 override the <smbconfoption><name>log level</name></smbconfoption> parameter
184 in the &smb.conf; file.</para>
185 </listitem>
186 </varlistentry>'>
187
188 <!ENTITY stdarg.client.debug '
189 <varlistentry>
190 <term>-d|--debuglevel=level</term>
191 <listitem>
192 <para><replaceable>level</replaceable> is an integer 
193 from 0 to 10. The default value if this parameter is 
194 not specified is 1.</para>
195
196 <para>The higher this value, the more detail will be 
197 logged to the log files about the activities of the 
198 server. At level 0, only critical errors and serious 
199 warnings will be logged. Level 1 is a reasonable level for
200 day-to-day running - it generates a small amount of 
201 information about operations carried out.</para>
202
203 <para>Levels above 1 will generate considerable 
204 amounts of log data, and should only be used when 
205 investigating a problem. Levels above 3 are designed for 
206 use only by developers and generate HUGE amounts of log
207 data, most of which is extremely cryptic.</para>
208
209 <para>Note that specifying this parameter here will 
210 override the <smbconfoption><name>log level</name></smbconfoption> parameter
211 in the &smb.conf; file.</para>
212 </listitem>
213 </varlistentry>'>
214
215 <!ENTITY stdarg.configfile '
216 <varlistentry>
217 <term>-s &lt;configuration file&gt;</term>
218 <listitem><para>The file specified contains the 
219 configuration details required by the server.  The 
220 information in this file includes server-specific
221 information such as what printcap file to use, as well 
222 as descriptions of all the services that the server is 
223 to provide. See &smb.conf; for more information.
224 The default configuration file name is determined at 
225 compile time.</para></listitem>
226 </varlistentry>'>
227
228 <!ENTITY stdarg.version '
229 <varlistentry>
230 <term>-V</term>
231 <listitem><para>Prints the program version number.
232 </para></listitem>
233 </varlistentry>'>
234
235 <!ENTITY stdarg.log-basename '
236 <varlistentry>
237 <term>-l|--log-basename=logdirectory</term>
238 <listitem><para>Base directory name for log/debug files. The extension
239 <constant>".progname"</constant> will be appended (e.g. log.smbclient, 
240 log.smbd, etc...). The log file is never removed by the client.
241 </para></listitem>
242 </varlistentry>'>
243
244 <!ENTITY popt.common.samba '
245 &stdarg.version;
246 &stdarg.configfile;
247 &stdarg.log-basename;
248 '>
249
250 <!ENTITY stdarg.resolve.order '
251 <varlistentry>
252 <term>-R &lt;name resolve order&gt;</term> 
253 <listitem><para>This option is used to determine what naming 
254 services and in what order to resolve 
255 host names to IP addresses. The option takes a space-separated 
256 string of different name resolution options.</para>
257
258 <para>The options are: "lmhosts", "host", "wins" and "bcast". 
259 They cause names to be resolved as follows :</para>
260
261 <itemizedlist>
262 <listitem><para><constant>lmhosts</constant>: 
263 Lookup an IP address in the Samba lmhosts file. If the 
264 line in lmhosts has no name type attached to the 
265 NetBIOS name 
266 (see the <citerefentry><refentrytitle>lmhosts</refentrytitle>
267  <manvolnum>5</manvolnum></citerefentry>        for details) 
268 then any name type matches for lookup.
269 </para></listitem>
270
271 <listitem><para><constant>host</constant>: 
272 Do a standard host name to IP address resolution, using
273 the system <filename>/etc/hosts</filename>, NIS, or DNS
274 lookups. This method of name resolution is operating 
275 system dependent, for instance on IRIX or Solaris this 
276 may be controlled by the <filename>/etc/nsswitch.conf
277 </filename> file).  Note that this method is only used 
278 if the NetBIOS name type being queried is the 0x20 
279 (server) name type, otherwise it is ignored.
280 </para></listitem>
281
282 <listitem><para><constant>wins</constant>: 
283 Query a name with the IP address listed in the 
284 <parameter>wins server</parameter> parameter.  If no 
285 WINS server has been specified this method will be 
286 ignored.
287 </para></listitem>
288
289 <listitem><para><constant>bcast</constant>: 
290 Do a broadcast on each of the known local interfaces 
291 listed in the <parameter>interfaces</parameter>
292 parameter. This is the least reliable of the name 
293 resolution methods as it depends on the target host 
294 being on a locally connected subnet.
295 </para></listitem>
296 </itemizedlist>
297
298 <para>If this parameter is not set then the name resolve order 
299 defined in the &smb.conf; file parameter  
300 (<smbconfoption><name>name resolve order</name></smbconfoption>) will be used.
301 </para>
302
303 <para>The default order is lmhosts, host, wins, bcast. Without 
304 this parameter or any entry in the <smbconfoption><name>name resolve order</name></smbconfoption> parameter of the &smb.conf; file, the name 
305 resolution methods will be attempted in this order. </para></listitem>
306 </varlistentry>'>
307
308 <!ENTITY stdarg.netbios.name '
309 <varlistentry>
310 <term>-n &lt;primary NetBIOS name&gt;</term>
311 <listitem><para>This option allows you to override
312 the NetBIOS name that Samba uses for itself. This is identical
313 to setting the <smbconfoption><name>netbios name</name></smbconfoption> parameter in the &smb.conf; file. 
314 However, a command
315 line setting will take precedence over settings in
316 &smb.conf;.</para></listitem>
317 </varlistentry>'>
318
319 <!ENTITY stdarg.scope '
320 <varlistentry>
321 <term>-i &lt;scope&gt;</term>
322 <listitem><para>This specifies a NetBIOS scope that
323 <command>nmblookup</command> will use to communicate with when
324 generating NetBIOS names. For details on the use of NetBIOS
325 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
326 <emphasis>very</emphasis> rarely used, only set this parameter
327 if you are the system administrator in charge of all the
328 NetBIOS systems you communicate with.</para></listitem>
329 </varlistentry>'>
330
331 <!ENTITY stdarg.workgroup '
332 <varlistentry>
333 <term>-W|--workgroup=domain</term>
334 <listitem><para>Set the SMB domain of the username.   This
335 overrides the default domain which is the domain defined in
336 smb.conf.  If the domain specified is the same as the servers 
337 NetBIOS name, it causes the client to log on using the servers local 
338 SAM (as opposed to the Domain SAM). </para></listitem>
339 </varlistentry>'>
340
341 <!ENTITY stdarg.socket.options '
342 <varlistentry>
343 <term>-O socket options</term>
344 <listitem><para>TCP socket options to set on the client
345 socket. See the socket options parameter in
346 the &smb.conf; manual page for the list of valid
347 options. </para></listitem>
348 </varlistentry>
349 '>
350
351 <!ENTITY popt.common.connection '
352 &stdarg.netbios.name;
353 &stdarg.scope;
354 &stdarg.workgroup;
355 &stdarg.socket.options;
356 '>
357
358 <!ENTITY stdarg.nopass '
359 <varlistentry>
360 <term>-N</term>
361 <listitem><para>If specified, this parameter suppresses the normal
362 password prompt from the client to the user. This is useful when
363 accessing a service that does not require a password. </para>
364
365 <para>Unless a password is specified on the command line or
366 this parameter is specified, the client will request a
367 password.</para>
368
369 <para>If a password is specified on the command line and this
370 option is also defined the password on the command line will
371 be silently ingnored and no password will be used.</para></listitem>
372 </varlistentry>'>
373
374 <!ENTITY pct "&#37;">
375
376 <!ENTITY stdarg.username '
377 <varlistentry>
378 <term>-U|--user=username[&pct;password]</term>
379 <listitem><para>Sets the SMB username or username and password. </para>
380
381 <para>If &pct;password is not specified, the user will be prompted. The
382 client will first check the <envar>USER</envar> environment variable, then the
383 <envar>LOGNAME</envar> variable and if either exists, the
384 string is uppercased. If these environmental variables are not
385 found, the username <constant>GUEST</constant> is used. </para>
386
387 <para>A third option is to use a credentials file which
388 contains the plaintext of the username and password.  This
389 option is mainly provided for scripts where the admin does not
390 wish to pass the credentials on the command line or via environment
391 variables. If this method is used, make certain that the permissions
392 on the file restrict access from unwanted users.  See the
393 <parameter>-A</parameter> for more details. </para>
394
395 <para>Be cautious about including passwords in scripts. Also, on
396 many systems the command line of a running process may be seen
397 via the <command>ps</command> command.  To be safe always allow
398 <command>rpcclient</command> to prompt for a password and type
399 it in directly. </para></listitem>
400 </varlistentry>
401 '>
402
403 <!ENTITY stdarg.authfile '
404 <varlistentry>
405 <term>-A|--authentication-file=filename</term>
406 <listitem><para>This option allows
407 you to specify a file from which to read the username and
408 password used in the connection.  The format of the file is
409 </para>
410
411 <para><programlisting>
412 username = &lt;value&gt;
413 password = &lt;value&gt;
414 domain   = &lt;value&gt;
415 </programlisting></para>
416
417 <para>Make certain that the permissions on the file restrict 
418 access from unwanted users. </para></listitem>
419 </varlistentry>'>
420
421 <!ENTITY stdarg.kerberos '
422 <varlistentry>
423 <term>-k</term>
424 <listitem><para>
425 Try to authenticate with kerberos. Only useful in
426 an Active Directory environment.
427 </para></listitem>
428 </varlistentry>
429 '>
430
431
432 <!ENTITY stdarg.help '
433 <varlistentry>
434 <term>-h|--help</term>
435 <listitem><para>Print a summary of command line options.
436 </para></listitem>
437 </varlistentry>'>
438
439 <!ENTITY popt.common.credentials '
440 &stdarg.nopass;
441 &stdarg.kerberos;
442 &stdarg.authfile;
443 &stdarg.username;
444 '>
445
446 <!-- Entities for the various programs -->
447 <!ENTITY OL '<application>OpenLDAP</application>'>
448 <!ENTITY smbd '<application>smbd</application>'>
449 <!ENTITY nmbd '<application>nmbd</application>'>
450 <!ENTITY testparm '<application>testparm</application>'>
451 <!ENTITY smb.conf '<filename>smb.conf</filename>'>
452 <!ENTITY smbclient '<application>smbclient</application>'>
453 <!ENTITY winbindd '<application>winbindd</application>'>
454 <!ENTITY net '<application>net</application>'>
455
456 <!ENTITY not.implemented "<note><para>Currently NOT implemented.</para></note>">
457 <!ENTITY rootprompt "<prompt>root# </prompt>">
458 <!ENTITY prompt "<prompt>$ </prompt>">
459 <!ENTITY dosprompt "<prompt>C:\&gt; </prompt>">
460
461 <!ENTITY example.workgroup "MIDEARTH">
462 <!ENTITY example.server.samba "GANDALF">
463 <!ENTITY example.server.windows "SARUMAN">
464 <!ENTITY example.workstation.windows "FRODO">
465 <!ENTITY example.workstation.samba "BILBO">
466 <!ENTITY example.pdc.samba "SAURON">
467 <!ENTITY example.server.wins "noldor">
468
469 <!ENTITY smbmdash "<?latex --- ?>">