Remove remaining references to "password level" in the tree
[samba.git] / docs-xml / using_samba / appc.xml
1 <appendix label="C" id="SAMBA-AP-C">
2 <title>Samba Configuration Option Quick Reference</title>
3
4
5
6
7 <para>The following pages list each of the Samba configuration
8 options. If an option is applicable only to the global section,
9 "[global]" will appear before its name. Any lists mentioned are space
10 separated, except where noted. A glossary of terms follows the
11 options.</para>
12
13
14
15
16
17
18
19
20
21
22
23 <sect1 role="" label="C.1" id="appc-SECT-1">
24 <title>Configuration Options</title>
25
26
27 <refentry id="appc-refentry-1">
28 <refmeta>
29 <refmiscinfo class="allowable values">user list</refmiscinfo>
30 <refmiscinfo class="default">NULL</refmiscinfo>
31 </refmeta>
32 <refnamediv>
33 <refname>admin users = user list</refname>
34 </refnamediv>
35 <refsynopsisdiv>
36 <para>List of users who will be granted root permissions on the share by Samba.</para>
37
38 </refsynopsisdiv>
39 </refentry>
40
41 <refentry id="appc-refentry-2">
42 <refmeta>
43 <refmiscinfo class="allowable values">any</refmiscinfo>
44 <refmiscinfo class="default">NULL</refmiscinfo>
45 </refmeta>
46 <refnamediv>
47 <refname>allow hosts = host list</refname>
48 </refnamediv>
49 <refsynopsisdiv>
50 <para>Synonym for <literal>hosts allow</literal>. List of machines that may connect to a share.</para>
51
52 </refsynopsisdiv>
53 </refentry>
54
55 <refentry id="appc-refentry-3">
56 <refmeta>
57 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
58 <refmiscinfo class="default">NO</refmiscinfo>
59 </refmeta>
60 <refnamediv>
61 <refname>alternate permissions = boolean</refname>
62 </refnamediv>
63 <refsynopsisdiv>
64 <para>Obsolete. Has no effect in Samba 2. Files will be shown as read-only if the owner can't write them. In Samba 1.9 and earlier, setting this option would set the DOS filesystem read-only attribute on any file the user couldn't read. This in turn required the <literal>delete readonly</literal> option.</para>
65
66 </refsynopsisdiv>
67 </refentry>
68
69 <refentry id="appc-refentry-6">
70 <refmeta>
71 <refmiscinfo class="allowable values">any shares</refmiscinfo>
72 <refmiscinfo class="default">NULL</refmiscinfo>
73 </refmeta>
74 <refnamediv>
75 <refname>[global] auto services = share list</refname>
76 </refnamediv>
77 <refsynopsisdiv>
78 <para>List of shares that will always appear in browse lists. A synonym is <literal>preload</literal>.</para>
79
80 </refsynopsisdiv>
81 </refentry>
82
83 <refentry id="appc-refentry-7">
84 <refmeta>
85 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
86 <refmiscinfo class="default">YES</refmiscinfo>
87 </refmeta>
88 <refnamediv>
89 <refname>available = boolean</refname>
90 </refnamediv>
91 <refsynopsisdiv>
92 <para>If set to NO, denies access to a share. Doesn't affect browsing.</para>
93
94 </refsynopsisdiv>
95 </refentry>
96
97 <refentry id="appc-refentry-8">
98 <refmeta>
99 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
100 <refmiscinfo class="default">NO</refmiscinfo>
101 </refmeta>
102 <refnamediv>
103 <refname>[global] bind interfaces only = boolean</refname>
104 </refnamediv>
105 <refsynopsisdiv>
106 <para>If set to YES, shares and browsing will be provided only on interfaces in an interfaces list (see <literal>interfaces</literal>). New in Samba 1.9.18. If you set this option to YES, be sure to add 127.0.0.1 to the interfaces list to allow <emphasis>smbpasswd</emphasis> to connect to the local machine to change passwords. This is a convienence option; it does not improve security.</para>
107
108 </refsynopsisdiv>
109 </refentry>
110
111 <refentry id="appc-refentry-9">
112 <refmeta>
113 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
114 <refmiscinfo class="default">YES</refmiscinfo>
115 </refmeta>
116 <refnamediv>
117 <refname>browsable = boolean</refname>
118 </refnamediv>
119 <refsynopsisdiv>
120 <para>Allows a share to be announced in browse lists.</para>
121
122 </refsynopsisdiv>
123 </refentry>
124
125 <refentry id="appc-refentry-10">
126 <refmeta>
127 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
128 <refmiscinfo class="default">YES</refmiscinfo>
129 </refmeta>
130 <refnamediv>
131 <refname>blocking locks = boolean</refname>
132 </refnamediv>
133 <refsynopsisdiv>
134 <para>If YES, honors byte range lock requests with time limits for queuing the request and retrying it until the time period expires. New in Samba 2.0.</para>
135
136 </refsynopsisdiv>
137 </refentry>
138
139 <refentry id="appc-refentry-11">
140 <refmeta>
141 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
142 <refmiscinfo class="default">YES</refmiscinfo>
143 </refmeta>
144 <refnamediv>
145 <refname>[global] browse list = boolean</refname>
146 </refnamediv>
147 <refsynopsisdiv>
148 <para>Turns on/off <literal>browse</literal> <literal>list</literal> from this server. Avoid changing.</para>
149
150 </refsynopsisdiv>
151 </refentry>
152
153 <refentry id="appc-refentry-12">
154 <refmeta>
155 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
156 <refmiscinfo class="default">NO</refmiscinfo>
157 </refmeta>
158 <refnamediv>
159 <refname>[global] case sensitive = boolean</refname>
160 </refnamediv>
161 <refsynopsisdiv>
162 <para>If YES, uses exactly the case the client supplied when trying to resolve a filename. If NO, matches either upper- or lowercase name. Avoid changing.</para>
163
164 </refsynopsisdiv>
165 </refentry>
166
167 <refentry id="appc-refentry-13">
168 <refmeta>
169 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
170 <refmiscinfo class="default">NO</refmiscinfo>
171 </refmeta>
172 <refnamediv>
173 <refname>[global] case sig names = boolean</refname>
174 </refnamediv>
175 <refsynopsisdiv>
176 <para>Synonym for <literal>case sensitive</literal>.</para>
177
178 </refsynopsisdiv>
179 </refentry>
180
181 <refentry id="appc-refentry-14">
182 <refmeta>
183 <refmiscinfo class="allowable values">positive number</refmiscinfo>
184 <refmiscinfo class="default">60</refmiscinfo>
185 </refmeta>
186 <refnamediv>
187 <refname>[global] change notify timeout = number</refname>
188 </refnamediv>
189 <refsynopsisdiv>
190 <para>Sets the number of seconds between checks when a client asks for notification of changes in a directory. Introduced in Samba 2.0 to limit the performance cost of the checks. Avoid lowering.</para>
191
192 </refsynopsisdiv>
193 </refentry>
194
195 <refentry id="appc-refentry-15">
196 <refmeta>
197 <refmiscinfo class="allowable values">ISO8859-1, ISO8859-2, ISO8859-5, KOI8-R</refmiscinfo>
198 <refmiscinfo class="default">NULL</refmiscinfo>
199 </refmeta>
200 <refnamediv>
201 <refname>character set = name</refname>
202 </refnamediv>
203 <refsynopsisdiv>
204 <para>If set, translates from DOS code pages to the Western European (ISO8859-1), Eastern European (ISO8859-2), Russian Cyrillic (ISO8859-5), or Alternate Russian (KOI8-R) character set. The <literal>client code page</literal> must be set to 850.</para>
205
206 </refsynopsisdiv>
207 </refentry>
208
209 <refentry id="appc-refentry-16">
210 <refmeta>
211 <refmiscinfo class="allowable values">See <link linkend="ch08-20815">Table 8.4</link></refmiscinfo>
212 <refmiscinfo class="default">437 (US MS-DOS)</refmiscinfo>
213 </refmeta>
214 <refnamediv>
215 <refname>client code page = name</refname>
216 </refnamediv>
217 <refsynopsisdiv>
218 <para>Sets the DOS code page explicitly, overriding any previous <literal>valid chars</literal> settings. Examples of values are 850 for European, 437 is the US standard, and 932 for Japanese Shift-JIS. Introduced in Samba 1.9.19.</para>
219
220 </refsynopsisdiv>
221 </refentry>
222
223 <refentry id="appc-refentry-17">
224 <refmeta>
225 <refmiscinfo class="allowable values">euc, cap, hex, hexN, sjis, j8bb, j8bj, jis8, j8bh, j8@b, j8@j, j8@h, j7bb, j7bj, jis7, j7bh, j7@b, j7@j, j7@h, jubb, jubj, junet, jubh, ju@b, ju@j, ju@h</refmiscinfo>
226 <refmiscinfo class="default">NULL</refmiscinfo>
227 </refmeta>
228 <refnamediv>
229 <refname>coding system = code</refname>
230 </refnamediv>
231 <refsynopsisdiv>
232 <para>Sets the coding system used, notably for Kanji. This is employed for filenames and should  correspond to the code page in use. The <literal>client code page</literal> option must be set to 932 (Japanese Shift-JIS). Introduced in Samba 2.0.</para>
233
234 </refsynopsisdiv>
235 </refentry>
236
237 <refentry id="appc-refentry-18">
238 <refmeta>
239 <refmiscinfo class="allowable values">a text string or NULL</refmiscinfo>
240 <refmiscinfo class="default">NULL</refmiscinfo>
241 </refmeta>
242 <refnamediv>
243 <refname>comment = text</refname>
244 </refnamediv>
245 <refsynopsisdiv>
246 <para>Sets the comment that appears beside a share in a NET VIEW or the details list of a Microsoft directory window. See also the <literal>server string</literal> configuration option.</para>
247
248 </refsynopsisdiv>
249 </refentry>
250
251 <refentry id="appc-refentry-19">
252 <refmeta>
253 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
254 <refmiscinfo class="default">NULL</refmiscinfo>
255 </refmeta>
256 <refnamediv>
257 <refname>[global] config file = pathname</refname>
258 </refnamediv>
259 <refsynopsisdiv>
260 <para>Selects an additional Samba configuration file to read instead of the current one. Used to relocate the configuration file, or used with %-variables to select custom configuration files for some users or machines.</para>
261
262 </refsynopsisdiv>
263 </refentry>
264
265 <refentry id="appc-refentry-20">
266 <refmeta>
267 <refmiscinfo class="allowable values">existing section's name</refmiscinfo>
268 <refmiscinfo class="default">NULL</refmiscinfo>
269 </refmeta>
270 <refnamediv>
271 <refname>copy = section name</refname>
272 </refnamediv>
273 <refsynopsisdiv>
274 <para>Copies the configuration of a previously seen share into the share where it appears. Used with %-variables to select custom configurations for machines, architectures and users. The copied section must be earlier in the configuration file. Copied options are of lesser priority than those explicitly listed in the section.</para>
275
276 </refsynopsisdiv>
277 </refentry>
278
279 <refentry id="appc-refentry-21">
280 <refmeta>
281 <refmiscinfo class="allowable values">octal permission bits, 0-0777</refmiscinfo>
282 <refmiscinfo class="default">0744</refmiscinfo>
283 </refmeta>
284 <refnamediv>
285 <refname>create mask = octal value</refname>
286 </refnamediv>
287 <refsynopsisdiv>
288 <para>Also called <literal>create mode</literal>. Sets the maximum allowable permissions for new files (e.g., 0755). See also <literal>directory mask</literal>. To require certain permissions to be set, see <literal>force create mask/force directory mask</literal>. This option stopped affecting directories in Samba 1.9.17, and the default value changed in Samba 2.0.</para>
289
290 </refsynopsisdiv>
291 </refentry>
292
293 <refentry id="appc-refentry-22">
294 <refmeta>
295 <refmiscinfo class="allowable values">octal permission bits, 0-0777</refmiscinfo>
296 <refmiscinfo class="default">0744</refmiscinfo>
297 </refmeta>
298 <refnamediv>
299 <refname>create mode = octal permission bits</refname>
300 </refnamediv>
301 <refsynopsisdiv>
302 <para>Synonym for <literal>create mask</literal>.</para>
303
304 </refsynopsisdiv>
305 </refentry>
306
307 <refentry id="appc-refentry-23">
308 <refmeta>
309 <refmiscinfo class="allowable values">minutes</refmiscinfo>
310 <refmiscinfo class="default">0 </refmiscinfo>
311 </refmeta>
312 <refnamediv>
313 <refname>[global] deadtime = minutes</refname>
314 </refnamediv>
315 <refsynopsisdiv>
316 <para>The time in minutes before an unused connection will be terminated. Zero means forever. Used to keep clients from tying up server resources forever. If used, clients will have to auto-reconnect after minutes of inactivity. See also <literal>keepalive</literal>.</para>
317
318 </refsynopsisdiv>
319 </refentry>
320
321 <refentry id="appc-refentry-24">
322 <refmeta>
323 <refmiscinfo class="allowable values">number</refmiscinfo>
324 <refmiscinfo class="default">0</refmiscinfo>
325 </refmeta>
326 <refnamediv>
327 <refname>[global] debug level = number</refname>
328 </refnamediv>
329 <refsynopsisdiv>
330 <para>Sets the logging level used. Values of 3 or more slow Samba noticeably. A synonym is <literal>log level</literal>. Recommended value: 1.</para>
331
332 </refsynopsisdiv>
333 </refentry>
334
335 <refentry id="appc-refentry-25">
336 <refmeta>
337 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
338 <refmiscinfo class="default">YES</refmiscinfo>
339 </refmeta>
340 <refnamediv>
341 <refname>[global] debug timestamp = boolean</refname>
342 </refnamediv>
343 <refsynopsisdiv>
344 <para>Timestamps all log messages. Can be turned off when it's not useful (e.g., in debugging). New in Samba 2.0.</para>
345
346 </refsynopsisdiv>
347 </refentry>
348
349 <refentry id="appc-refentry-26">
350 <refmeta>
351 <refmiscinfo class="allowable values">share name</refmiscinfo>
352 <refmiscinfo class="default">NULL</refmiscinfo>
353 </refmeta>
354 <refnamediv>
355 <refname>[global] default = name</refname>
356 </refnamediv>
357 <refsynopsisdiv>
358 <para>Also called <literal>default service</literal>. The name of a service (share) to provide if someone requests a service they don't have permission to use or which doesn't exist. As of Samba 1.9.14, the path will be set from the name the client specified, with any "_" characters changed to "/" characters, allowing access to any directory on the Samba server. Use is strongly discouraged.</para>
359
360 </refsynopsisdiv>
361 </refentry>
362
363 <refentry id="appc-refentry-27">
364 <refmeta>
365 <refmiscinfo class="allowable values">LOWER, UPPER</refmiscinfo>
366 <refmiscinfo class="default">LOWER</refmiscinfo>
367 </refmeta>
368 <refnamediv>
369 <refname>default case = case</refname>
370 </refnamediv>
371 <refsynopsisdiv>
372 <para>Sets the case in which to store new filenames. LOWER indicates mixed case, UPPER indicates uppercase letters.</para>
373
374 </refsynopsisdiv>
375 </refentry>
376
377 <refentry id="appc-refentry-28">
378 <refmeta>
379 <refmiscinfo class="allowable values">share name</refmiscinfo>
380 <refmiscinfo class="default">NULL</refmiscinfo>
381 </refmeta>
382 <refnamediv>
383 <refname>[global] default service = share name</refname>
384 </refnamediv>
385 <refsynopsisdiv>
386 <para>Synonym for <literal>default</literal>.</para>
387
388 </refsynopsisdiv>
389 </refentry>
390
391 <refentry id="appc-refentry-29">
392 <refmeta>
393 <refmiscinfo class="allowable values">NO, YES</refmiscinfo>
394 <refmiscinfo class="default">NO</refmiscinfo>
395 </refmeta>
396 <refnamediv>
397 <refname>delete readonly = boolean</refname>
398 </refnamediv>
399 <refsynopsisdiv>
400 <para>Allow delete requests to remove read-only files. This is not allowed in DOS/Windows, but is normal in Unix, which has separate directory permissions. Used with programs like RCS, or with the older <literal>alternate permissions</literal> option.</para>
401
402 </refsynopsisdiv>
403 </refentry>
404
405 <refentry id="appc-refentry-30">
406 <refmeta>
407 <refmiscinfo class="allowable values">NO, YES</refmiscinfo>
408 <refmiscinfo class="default">NO</refmiscinfo>
409 </refmeta>
410 <refnamediv>
411 <refname>delete veto files = boolean</refname>
412 </refnamediv>
413 <refsynopsisdiv>
414 <para>Allow delete requests for a directory containing files or subdirectories the user can't see due to the <literal>veto files</literal> option. If set to NO, the directory will not be deleted and will still contain invisible files.</para>
415
416 </refsynopsisdiv>
417 </refentry>
418
419 <refentry id="appc-refentry-31">
420 <refmeta>
421 <refmiscinfo class="allowable values">host list</refmiscinfo>
422 <refmiscinfo class="default">NULL</refmiscinfo>
423 </refmeta>
424 <refnamediv>
425 <refname>deny hosts = host list</refname>
426 </refnamediv>
427 <refsynopsisdiv>
428 <para>A synonym is <literal>hosts deny</literal>. Specifies a list of machines from which to refuse connections or shares.</para>
429
430 </refsynopsisdiv>
431 </refentry>
432
433 <refentry id="appc-refentry-32">
434 <refmeta>
435 <refmiscinfo class="allowable values">shell command</refmiscinfo>
436 <refmiscinfo class="default">varies</refmiscinfo>
437 </refmeta>
438 <refnamediv>
439 <refname>[global] dfree command = command</refname>
440 </refnamediv>
441 <refsynopsisdiv>
442 <para>A command to run on the server to return disk free space. Not needed unless the OS command does not work properly.</para>
443
444 </refsynopsisdiv>
445 </refentry>
446
447 <refentry id="appc-refentry-33">
448 <refmeta>
449 <refmiscinfo class="allowable values">pathname</refmiscinfo>
450 <refmiscinfo class="default">NULL</refmiscinfo>
451 </refmeta>
452 <refnamediv>
453 <refname>directory = pathname</refname>
454 </refnamediv>
455 <refsynopsisdiv>
456 <para>Synonym for <literal>path</literal>. A directory provided by a file share, or used by a printer share. Set automatically in the <literal>[homes]</literal> share to user's home directory, otherwise defaults to<filename> /tmp</filename>.</para>
457
458 </refsynopsisdiv>
459 </refentry>
460
461 <refentry id="appc-refentry-34">
462 <refmeta>
463 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
464 <refmiscinfo class="default">0755</refmiscinfo>
465 </refmeta>
466 <refnamediv>
467 <refname>directory mask = octal permission bits</refname>
468 </refnamediv>
469 <refsynopsisdiv>
470 <para>Also called <literal>directory mode</literal>. Sets the maximum allowable permissions for newly created directories. To require certain permissions be set, see the <literal>force create mask</literal> and <literal>force directory mask</literal> options.</para>
471
472 </refsynopsisdiv>
473 </refentry>
474
475 <refentry id="appc-refentry-35">
476 <refmeta>
477 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
478 <refmiscinfo class="default">0755</refmiscinfo>
479 </refmeta>
480 <refnamediv>
481 <refname>directory mode = octal permission bits</refname>
482 </refnamediv>
483 <refsynopsisdiv>
484 <para>Synonym for <literal>directory mask</literal>.</para>
485
486 </refsynopsisdiv>
487 </refentry>
488
489 <refentry id="appc-refentry-36">
490 <refmeta>
491 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
492 <refmiscinfo class="default">YES</refmiscinfo>
493 </refmeta>
494 <refnamediv>
495 <refname>[global] dns proxy = boolean</refname>
496 </refnamediv>
497 <refsynopsisdiv>
498 <para>If set to YES, and if <literal>wins server = YES</literal>, look up hostnames in DNS if they are not found using WINS.</para>
499
500 </refsynopsisdiv>
501 </refentry>
502
503 <refentry id="appc-refentry-37">
504 <refmeta>
505 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
506 <refmiscinfo class="default">NO</refmiscinfo>
507 </refmeta>
508 <refnamediv>
509 <refname>[global] domain logons = boolean</refname>
510 </refnamediv>
511 <refsynopsisdiv>
512 <para>Allow Windows 95/98 or NT clients to log on to an NT-like domain.</para>
513
514 </refsynopsisdiv>
515 </refentry>
516
517 <refentry id="appc-refentry-38">
518 <refmeta>
519 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
520 <refmiscinfo class="default">NO</refmiscinfo>
521 </refmeta>
522 <refnamediv>
523 <refname>[global] domain master = boolean</refname>
524 </refnamediv>
525 <refsynopsisdiv>
526 <para>Become a domain master browser list collector if possible for the entire workgroup/domain.</para>
527
528 </refsynopsisdiv>
529 </refentry>
530
531 <refentry id="appc-refentry-39">
532 <refmeta>
533 <refmiscinfo class="allowable values">comma-separated list of paths</refmiscinfo>
534 <refmiscinfo class="default">NULL</refmiscinfo>
535 </refmeta>
536 <refnamediv>
537 <refname>dont descend = comma-list</refname>
538 </refnamediv>
539 <refsynopsisdiv>
540 <para>Does not allow a change directory or search in the directories specified. This is a browsing convenience option; it doesn't provide any extra security.</para>
541
542 </refsynopsisdiv>
543 </refentry>
544
545 <refentry id="appc-refentry-40">
546 <refmeta>
547 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
548 <refmiscinfo class="default">NO</refmiscinfo>
549 </refmeta>
550 <refnamediv>
551 <refname>dos filetimes = boolean</refname>
552 </refnamediv>
553 <refsynopsisdiv>
554 <para>Allow non-owners to change file times if they can write to the file. See also <literal>dos filetime resolution</literal>.</para>
555
556 </refsynopsisdiv>
557 </refentry>
558
559 <refentry id="appc-refentry-41">
560 <refmeta>
561 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
562 <refmiscinfo class="default">NO</refmiscinfo>
563 </refmeta>
564 <refnamediv>
565 <refname>dos filetime resolution = boolean</refname>
566 </refnamediv>
567 <refsynopsisdiv>
568 <para>Set file times on Unix to match DOS standards (round to next even second). Recommended if using Visual C++ or a PC <emphasis>make</emphasis> program to avoid remaking the programs unnecesarily. Use with the <literal>dos filetimes</literal> option.</para>
569
570 </refsynopsisdiv>
571 </refentry>
572
573 <refentry id="appc-refentry-42">
574 <refmeta>
575 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
576 <refmiscinfo class="default">NO</refmiscinfo>
577 </refmeta>
578 <refnamediv>
579 <refname>[global] encrypt passwords = boolean</refname>
580 </refnamediv>
581 <refsynopsisdiv>
582 <para>Uses Windows NT-style password encryption. Requires an <filename>smbpasswd</filename> on the Samba server.</para>
583
584 </refsynopsisdiv>
585 </refentry>
586
587 <refentry id="appc-refentry-43">
588 <refmeta>
589 <refmiscinfo class="allowable values">shell command</refmiscinfo>
590 <refmiscinfo class="default">NULL</refmiscinfo>
591 </refmeta>
592 <refnamediv>
593 <refname>exec = command</refname>
594 </refnamediv>
595 <refsynopsisdiv>
596 <para>Synonym of <literal>preexec</literal>, a command to run as the user just before connecting to the share.</para>
597
598 </refsynopsisdiv>
599 </refentry>
600
601 <refentry id="appc-refentry-44">
602 <refmeta>
603 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
604 <refmiscinfo class="default">NO</refmiscinfo>
605 </refmeta>
606 <refnamediv>
607 <refname>fake directory create times = boolean</refname>
608 </refnamediv>
609 <refsynopsisdiv>
610 <para>Bug fix for users of Microsoft <emphasis>nmake</emphasis>. If set, Samba will set directory create times such that <emphasis>nmake</emphasis> won't remake all files every time.</para>
611
612 </refsynopsisdiv>
613 </refentry>
614
615 <refentry id="appc-refentry-45">
616 <refmeta>
617 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
618 <refmiscinfo class="default">NO</refmiscinfo>
619 </refmeta>
620 <refnamediv>
621 <refname>fake oplocks = boolean</refname>
622 </refnamediv>
623 <refsynopsisdiv>
624 <para>Return YES whenever a client asks if it can lock a file and cache it locally, but does not enforce lock on the server. Use only for read-only disks, as Samba now supports real <literal>oplocks</literal> and has per-file overrides. See also <literal>oplocks</literal> and <literal>veto oplock files</literal>.</para>
625
626 </refsynopsisdiv>
627 </refentry>
628
629 <refentry id="appc-refentry-46">
630 <refmeta>
631 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
632 <refmiscinfo class="default">YES</refmiscinfo>
633 </refmeta>
634 <refnamediv>
635 <refname>follow symlinks = boolean</refname>
636 </refnamediv>
637 <refsynopsisdiv>
638 <para>If YES, Samba will follow symlinks in a file share or shares. See the <literal>wide links</literal> option if you want to restrict symlinks to just the current share.</para>
639
640 </refsynopsisdiv>
641 </refentry>
642
643 <refentry id="appc-refentry-47">
644 <refmeta>
645 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
646 <refmiscinfo class="default">0</refmiscinfo>
647 </refmeta>
648 <refnamediv>
649 <refname>force create mask = octal permission bits</refname>
650 </refnamediv>
651 <refsynopsisdiv>
652 <para>Provides bits that will be <literal>OR</literal>ed into the permissions of newly created files. Used with the <literal>create mode</literal> configuration option.</para>
653
654 </refsynopsisdiv>
655 </refentry>
656
657 <refentry id="appc-refentry-48">
658 <refmeta>
659 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
660 <refmiscinfo class="default">0</refmiscinfo>
661 </refmeta>
662 <refnamediv>
663 <refname>force create mode = octal permission bits</refname>
664 </refnamediv>
665 <refsynopsisdiv>
666 <para>Synonym for <literal>force create mask</literal>.</para>
667
668 </refsynopsisdiv>
669 </refentry>
670
671 <refentry id="appc-refentry-49">
672 <refmeta>
673 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
674 <refmiscinfo class="default">0</refmiscinfo>
675 </refmeta>
676 <refnamediv>
677 <refname>force directory mask = octal permission bits</refname>
678 </refnamediv>
679 <refsynopsisdiv>
680 <para>Provides bits that will be <literal>OR</literal>ed into the permissions of newly created directories, forcing those bits to be set. Used with <literal>directory mode</literal>.</para>
681
682 </refsynopsisdiv>
683 </refentry>
684
685 <refentry id="appc-refentry-50">
686 <refmeta>
687 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
688 <refmiscinfo class="default">0</refmiscinfo>
689 </refmeta>
690 <refnamediv>
691 <refname>force directory mode = octal permission bits</refname>
692 </refnamediv>
693 <refsynopsisdiv>
694 <para>Synonym for <literal>force</literal> <literal>directory</literal> <literal>mask</literal>.</para>
695
696 </refsynopsisdiv>
697 </refentry>
698
699 <refentry id="appc-refentry-51">
700 <refmeta>
701 <refmiscinfo class="allowable values">group</refmiscinfo>
702 <refmiscinfo class="default">NULL</refmiscinfo>
703 </refmeta>
704 <refnamediv>
705 <refname>force group = unix group</refname>
706 </refnamediv>
707 <refsynopsisdiv>
708 <para>Sets the effective group name assigned to all users accessing a share. Used to override user's normal groups.</para>
709
710 </refsynopsisdiv>
711 </refentry>
712
713 <refentry id="appc-refentry-52">
714 <refmeta>
715 <refmiscinfo class="allowable values">username</refmiscinfo>
716 <refmiscinfo class="default">NULL</refmiscinfo>
717 </refmeta>
718 <refnamediv>
719 <refname>force user = name</refname>
720 </refnamediv>
721 <refsynopsisdiv>
722 <para>Sets the effective username assigned to all users accessing a share. Discouraged.</para>
723
724 </refsynopsisdiv>
725 </refentry>
726
727 <refentry id="appc-refentry-53">
728 <refmeta>
729 <refmiscinfo class="allowable values">NTFS, FAT, Samba</refmiscinfo>
730 <refmiscinfo class="default">NTFS</refmiscinfo>
731 </refmeta>
732 <refnamediv>
733 <refname>fstype = string</refname>
734 </refnamediv>
735 <refsynopsisdiv>
736 <para>Sets the filesystem type reported to the client.</para>
737
738 </refsynopsisdiv>
739 </refentry>
740
741 <refentry id="appc-refentry-54">
742 <refmeta>
743 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
744 <refmiscinfo class="default">NO</refmiscinfo>
745 </refmeta>
746 <refnamediv>
747 <refname>[global] getwd cache = boolean</refname>
748 </refnamediv>
749 <refsynopsisdiv>
750 <para>Cache current directory for performance. Recommended with the <literal>wide links</literal> option.</para>
751
752 </refsynopsisdiv>
753 </refentry>
754
755 <refentry id="appc-refentry-55">
756 <refmeta>
757 <refmiscinfo class="allowable values">unix group</refmiscinfo>
758 <refmiscinfo class="default">NULL</refmiscinfo>
759 </refmeta>
760 <refnamediv>
761 <refname>group = group</refname>
762 </refnamediv>
763 <refsynopsisdiv>
764 <para>An obsolete form of <literal>force group</literal>.</para>
765
766 </refsynopsisdiv>
767 </refentry>
768
769 <refentry id="appc-refentry-56">
770 <refmeta>
771 <refmiscinfo class="allowable values">username</refmiscinfo>
772 <refmiscinfo class="default">NULL</refmiscinfo>
773 </refmeta>
774 <refnamediv>
775 <refname>guest account = user</refname>
776 </refnamediv>
777 <refsynopsisdiv>
778 <para>Sets the name of the unprivileged Unix account to use for tasks like printing and for accessing shares marked with <literal>guest ok</literal>.</para>
779
780 </refsynopsisdiv>
781 </refentry>
782
783 <refentry id="appc-refentry-57">
784 <refmeta>
785 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
786 <refmiscinfo class="default">NO</refmiscinfo>
787 </refmeta>
788 <refnamediv>
789 <refname>guest ok = boolean</refname>
790 </refnamediv>
791 <refsynopsisdiv>
792 <para>If YES, passwords are not needed for this share. Synonym of <literal>public</literal>.</para>
793
794 </refsynopsisdiv>
795 </refentry>
796
797 <refentry id="appc-refentry-58">
798 <refmeta>
799 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
800 <refmiscinfo class="default">NO</refmiscinfo>
801 </refmeta>
802 <refnamediv>
803 <refname>guest only = boolean</refname>
804 </refnamediv>
805 <refsynopsisdiv>
806 <para>Forces user of a share to do so as the guest account. Requires <literal>guest</literal> <literal>ok</literal> or <literal>public</literal> to be <literal>yes</literal>.</para>
807
808 </refsynopsisdiv>
809 </refentry>
810
811 <refentry id="appc-refentry-59">
812 <refmeta>
813 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
814 <refmiscinfo class="default">YES</refmiscinfo>
815 </refmeta>
816 <refnamediv>
817 <refname>hide dot files = boolean</refname>
818 </refnamediv>
819 <refsynopsisdiv>
820 <para>Treats files beginning with a dot in a share as if they had the DOS/Windows hidden attribute set.</para>
821
822 </refsynopsisdiv>
823 </refentry>
824
825 <refentry id="appc-refentry-60">
826 <refmeta>
827 <refmiscinfo class="allowable values">list of patterns, separated by <literal>/</literal> characters</refmiscinfo>
828 <refmiscinfo class="default">NULL</refmiscinfo>
829 </refmeta>
830 <refnamediv>
831 <refname>hide files = slash-separated list</refname>
832 </refnamediv>
833 <refsynopsisdiv>
834 <para>List of file or directory names to set the DOS hidden attribute on. Names may contain <literal>?</literal> or <literal>*</literal> pattern-characters and <literal>%</literal>-variables. See also <literal>hide</literal> <literal>dot</literal> <literal>files</literal> and <literal>veto</literal> <literal>files</literal>.</para>
835
836 </refsynopsisdiv>
837 </refentry>
838
839 <refentry id="appc-refentry-61">
840 <refmeta>
841 <refmiscinfo class="allowable values">NIS map name</refmiscinfo>
842 <refmiscinfo class="default">auto.home</refmiscinfo>
843 </refmeta>
844 <refnamediv>
845 <refname>[global] homedir map = NIS map name</refname>
846 </refnamediv>
847 <refsynopsisdiv>
848 <para>Used with <literal>nis homedir</literal> to locate user's Unix home directory from Sun NIS (not NIS+).</para>
849
850 </refsynopsisdiv>
851 </refentry>
852
853 <refentry id="appc-refentry-62">
854 <refmeta>
855 <refmiscinfo class="allowable values">list of hostnames</refmiscinfo>
856 <refmiscinfo class="default">NULL</refmiscinfo>
857 </refmeta>
858 <refnamediv>
859 <refname>hosts allow = host list</refname>
860 </refnamediv>
861 <refsynopsisdiv>
862 <para>Synonym of <literal>allow hosts</literal>, a list of machines that can access a share or shares. If NULL (the default) any machine can access the share unless there is a <literal>hosts deny</literal> option.</para>
863
864 </refsynopsisdiv>
865 </refentry>
866
867 <refentry id="appc-refentry-63">
868 <refmeta>
869 <refmiscinfo class="allowable values">list of hostnames</refmiscinfo>
870 <refmiscinfo class="default">NULL</refmiscinfo>
871 </refmeta>
872 <refnamediv>
873 <refname>hosts deny = host list</refname>
874 </refnamediv>
875 <refsynopsisdiv>
876 <para>Synonym of <literal>deny hosts</literal>, a list of machines that cannot connect to a share or shares.</para>
877
878 </refsynopsisdiv>
879 </refentry>
880
881 <refentry id="appc-refentry-64">
882 <refmeta>
883 <refmiscinfo class="allowable values">pathname</refmiscinfo>
884 <refmiscinfo class="default">NULL</refmiscinfo>
885 </refmeta>
886 <refnamediv>
887 <refname>[global] hosts equiv = pathname</refname>
888 </refnamediv>
889 <refsynopsisdiv>
890 <para>Path to a file of trusted machines from which password-less logins are allowed. Strongly discouraged, because Windows/NT users can always override the user name, the only security in this scheme.</para>
891
892 </refsynopsisdiv>
893 </refentry>
894
895 <refentry id="appc-refentry-65">
896 <refmeta>
897 <refmiscinfo class="allowable values">pathname</refmiscinfo>
898 <refmiscinfo class="default">NULL</refmiscinfo>
899 </refmeta>
900 <refnamediv>
901 <refname>include = pathname</refname>
902 </refnamediv>
903 <refsynopsisdiv>
904 <para>Include the named file in <filename>smb.conf</filename> at the line where it appears. This option does not understand the variables <literal>%u</literal> (user), <literal>%P</literal> (current share's root directory), or <literal>%S</literal> (current share name), because they are not set at the time the file is read.</para>
905
906 </refsynopsisdiv>
907 </refentry>
908
909 <refentry id="appc-refentry-66">
910 <refmeta>
911 <refmiscinfo class="allowable values">IP addresses separated by spaces</refmiscinfo>
912 <refmiscinfo class="default">NULL</refmiscinfo>
913 </refmeta>
914 <refnamediv>
915 <refname>[global] interfaces = interface list</refname>
916 </refnamediv>
917 <refsynopsisdiv>
918 <para>Sets the interfaces to which Samba will respond. The default is the machine's primary interface only. Recommended on multihomed machines or to override erroneous addresses and netmasks.</para>
919
920 </refsynopsisdiv>
921 </refentry>
922
923 <refentry id="appc-refentry-67">
924 <refmeta>
925 <refmiscinfo class="allowable values">list of users</refmiscinfo>
926 <refmiscinfo class="default">NULL</refmiscinfo>
927 </refmeta>
928 <refnamediv>
929 <refname>invalid users = user list</refname>
930 </refnamediv>
931 <refsynopsisdiv>
932 <para>List of users that will not be permitted access to a share or shares.</para>
933
934 </refsynopsisdiv>
935 </refentry>
936
937 <refentry id="appc-refentry-68">
938 <refmeta>
939 <refmiscinfo class="allowable values">number of seconds</refmiscinfo>
940 <refmiscinfo class="default">0</refmiscinfo>
941 </refmeta>
942 <refnamediv>
943 <refname>[global] keepalive = number</refname>
944 </refnamediv>
945 <refsynopsisdiv>
946 <para>Number of seconds between checks for a crashed client. The default of 0 causes no checks to be performed. Recommended if you want checks more often than every four hours. 3600 (10 minutes) is reasonable. See also <literal>socket options</literal> for another approach.</para>
947
948 </refsynopsisdiv>
949 </refentry>
950
951 <refentry id="appc-refentry-69">
952 <refmeta>
953 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
954 <refmiscinfo class="default">automatic</refmiscinfo>
955 </refmeta>
956 <refnamediv>
957 <refname>[global] kernel oplocks = boolean</refname>
958 </refnamediv>
959 <refsynopsisdiv>
960 <para>Break oplock when a Unix process accesses an <emphasis>oplocked</emphasis> file, preventing corruption. Set to YES on operating systems supporting this, otherwise set to NO. New in Samba 2.0; supported on SGI, and hopefully soon on Linux and BSD. Avoid changing.</para>
961
962 </refsynopsisdiv>
963 </refentry>
964
965 <refentry id="appc-refentry-70">
966 <refmeta>
967 <refmiscinfo class="allowable values">various</refmiscinfo>
968 <refmiscinfo class="default">varies</refmiscinfo>
969 </refmeta>
970 <refnamediv>
971 <refname>[global] ldap filter = various</refname>
972 </refnamediv>
973 <refsynopsisdiv>
974 <para>Options beginning with <literal>ldap</literal> are part of an experimental (circa Samba 2.0) use of the Lightweight Directory Access Protocol (LDAP) general directory/distributed database for user, name, and host information. This option is reserved for future use.</para>
975
976 </refsynopsisdiv>
977 </refentry>
978
979 <refentry id="appc-refentry-71">
980 <refmeta>
981 <refmiscinfo class="allowable values">various</refmiscinfo>
982 <refmiscinfo class="default">various</refmiscinfo>
983 </refmeta>
984 <refnamediv>
985 <refname>[global] ldap port = various</refname>
986 </refnamediv>
987 <refsynopsisdiv>
988 <para>Options beginning with <literal>ldap</literal> are part of an experimental (circa Samba 2.0) use of the Lightweight Directory Access Protocol (LDAP) general directory/distributed database for user, name, and host information. This option is reserved for future use.</para>
989
990 </refsynopsisdiv>
991 </refentry>
992
993 <refentry id="appc-refentry-72">
994 <refmeta>
995 <refmiscinfo class="allowable values">various</refmiscinfo>
996 <refmiscinfo class="default">various</refmiscinfo>
997 </refmeta>
998 <refnamediv>
999 <refname>[global] ldap root = various</refname>
1000 </refnamediv>
1001 <refsynopsisdiv>
1002 <para>Options beginning with <literal>ldap</literal> are part of an experimental (circa Samba 2.0) use of the Lightweight Directory Access Protocol (LDAP) general directory/distributed database for user, name, and host information. This option is reserved for future use.</para>
1003
1004 </refsynopsisdiv>
1005 </refentry>
1006
1007 <refentry id="appc-refentry-73">
1008 <refmeta>
1009 <refmiscinfo class="allowable values">various</refmiscinfo>
1010 <refmiscinfo class="default">various</refmiscinfo>
1011 </refmeta>
1012 <refnamediv>
1013 <refname>[global] ldap server = various</refname>
1014 </refnamediv>
1015 <refsynopsisdiv>
1016 <para>Options beginning with <literal>ldap</literal> are part of an experimental (circa Samba 2.0) use of the Lightweight Directory Access Protocol (LDAP) general directory/distributed database for user, name, and host information. This option is reserved for future use.</para>
1017
1018 </refsynopsisdiv>
1019 </refentry>
1020
1021 <refentry id="appc-refentry-74">
1022 <refmeta>
1023 <refmiscinfo class="allowable values">various</refmiscinfo>
1024 <refmiscinfo class="default">various</refmiscinfo>
1025 </refmeta>
1026 <refnamediv>
1027 <refname>[global] ldap suffix = various</refname>
1028 </refnamediv>
1029 <refsynopsisdiv>
1030 <para>Options beginning with <literal>ldap</literal> are part of an experimental (circa Samba 2.0) use of the Lightweight Directory Access Protocol (LDAP) general directory/distributed database for user, name, and host information. This option is reserved for future use.</para>
1031
1032 </refsynopsisdiv>
1033 </refentry>
1034
1035 <refentry id="appc-refentry-75">
1036 <refmeta>
1037 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1038 <refmiscinfo class="default">YES</refmiscinfo>
1039 </refmeta>
1040 <refnamediv>
1041 <refname>[global] load printers = boolean</refname>
1042 </refnamediv>
1043 <refsynopsisdiv>
1044 <para>Load all printer names from the system printer capabilities into browse list. Uses configuration options from the <literal>[printers]</literal> section.</para>
1045
1046 </refsynopsisdiv>
1047 </refentry>
1048
1049 <refentry id="appc-refentry-76">
1050 <refmeta>
1051 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1052 <refmiscinfo class="default">YES</refmiscinfo>
1053 </refmeta>
1054 <refnamediv>
1055 <refname>[global] local master = boolean</refname>
1056 </refnamediv>
1057 <refsynopsisdiv>
1058 <para>Stands for election as the local master browser. See also <literal>domain master</literal> and <literal>os level</literal>.</para>
1059
1060 </refsynopsisdiv>
1061 </refentry>
1062
1063 <refentry id="appc-refentry-77">
1064 <refmeta>
1065 <refmiscinfo class="allowable values">AUTO, YES, NO</refmiscinfo>
1066 <refmiscinfo class="default">AUTO</refmiscinfo>
1067 </refmeta>
1068 <refnamediv>
1069 <refname>[global] lm announce = value</refname>
1070 </refnamediv>
1071 <refsynopsisdiv>
1072 <para>Produce OS/2 SMB broadcasts at an interval specified by the <literal>lm interval</literal> option. YES/NO turns them on/off unconditionally. AUTO causes the Samba server to wait for a LAN Manager announcement from another client before sending one out. Required for OS/2 client browsing.</para>
1073
1074 </refsynopsisdiv>
1075 </refentry>
1076
1077 <refentry id="appc-refentry-78">
1078 <refmeta>
1079 <refmiscinfo class="allowable values">number</refmiscinfo>
1080 <refmiscinfo class="default">60</refmiscinfo>
1081 </refmeta>
1082 <refnamediv>
1083 <refname>[global] lm interval = seconds</refname>
1084 </refnamediv>
1085 <refsynopsisdiv>
1086 <para>Sets the time period, in seconds, between OS/2 SMB broadcast announcements.</para>
1087
1088 </refsynopsisdiv>
1089 </refentry>
1090
1091 <refentry id="appc-refentry-79">
1092 <refmeta>
1093 <refmiscinfo class="allowable values">pathname</refmiscinfo>
1094 <refmiscinfo class="default"><emphasis>/usr/local/samba/var/locks</emphasis></refmiscinfo>
1095 </refmeta>
1096 <refnamediv>
1097 <refname>[global] lock directory = pathname</refname>
1098 </refnamediv>
1099 <refsynopsisdiv>
1100 <para>Set a directory to keep lock files in. The directory must be writable by Samba, readable by everyone.</para>
1101
1102 </refsynopsisdiv>
1103 </refentry>
1104
1105 <refentry id="appc-refentry-80">
1106 <refmeta>
1107 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1108 <refmiscinfo class="default">YES</refmiscinfo>
1109 </refmeta>
1110 <refnamediv>
1111 <refname>locking = boolean</refname>
1112 </refnamediv>
1113 <refsynopsisdiv>
1114 <para>Perform file locking. If set to NO, Samba will accept lock requests but will not actually lock resources. Recommended only for read-only file systems.</para>
1115
1116 </refsynopsisdiv>
1117 </refentry>
1118
1119 <refentry id="appc-refentry-81">
1120 <refmeta>
1121 <refmiscinfo class="allowable values">pathname</refmiscinfo>
1122 <refmiscinfo class="default">varies</refmiscinfo>
1123 </refmeta>
1124 <refnamediv>
1125 <refname>[global] log file = pathname</refname>
1126 </refnamediv>
1127 <refsynopsisdiv>
1128 <para>Set name and location of the log file. Allows all %-variables.</para>
1129
1130 </refsynopsisdiv>
1131 </refentry>
1132
1133 <refentry id="appc-refentry-82">
1134 <refmeta>
1135 <refmiscinfo class="allowable values">number</refmiscinfo>
1136 <refmiscinfo class="default">0</refmiscinfo>
1137 </refmeta>
1138 <refnamediv>
1139 <refname>[global] log level = number</refname>
1140 </refnamediv>
1141 <refsynopsisdiv>
1142 <para>A synonym of <literal>debug level</literal>. Sets the logging level used. Values of 3 or more slow the system noticeably.</para>
1143
1144 </refsynopsisdiv>
1145 </refentry>
1146
1147 <refentry id="appc-refentry-83">
1148 <refmeta>
1149 <refmiscinfo class="allowable values">DOS drive name</refmiscinfo>
1150 <refmiscinfo class="default">None</refmiscinfo>
1151 </refmeta>
1152 <refnamediv>
1153 <refname>[global] logon drive = drive</refname>
1154 </refnamediv>
1155 <refsynopsisdiv>
1156 <para>Sets the drive on Windows NT (only) of the <literal>logon path</literal>.</para>
1157
1158 </refsynopsisdiv>
1159 </refentry>
1160
1161 <refentry id="appc-refentry-84">
1162 <refmeta>
1163 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
1164 <refmiscinfo class="default"><emphasis>\\</emphasis><replaceable>%N </replaceable><emphasis>\</emphasis><replaceable>%U</replaceable></refmiscinfo>
1165 </refmeta>
1166 <refnamediv>
1167 <refname>[global] logon home = path</refname>
1168 </refnamediv>
1169 <refsynopsisdiv>
1170 <para>Sets the home directory of a Windows 95/98 or NT Workstation user. Allows <literal>NET</literal> <literal>USE</literal> <literal>H:/HOME</literal> from the command prompt.</para>
1171
1172 </refsynopsisdiv>
1173 </refentry>
1174
1175 <refentry id="appc-refentry-85">
1176 <refmeta>
1177 <refmiscinfo class="allowable values">Windows pathname</refmiscinfo>
1178 <refmiscinfo class="default"><emphasis>\\</emphasis><replaceable>%N </replaceable><emphasis>\</emphasis><replaceable>%U </replaceable><emphasis>\profile</emphasis></refmiscinfo>
1179 </refmeta>
1180 <refnamediv>
1181 <refname>[global] logon path = pathname</refname>
1182 </refnamediv>
1183 <refsynopsisdiv>
1184 <para>Sets path to Windows profile directory. This contains <emphasis>USER.MAN</emphasis> and/or <emphasis>USER.DAT</emphasis> profile files and the Windows 95 Desktop, Start Menu, Network Neighborhood, and programs folders.</para>
1185
1186 </refsynopsisdiv>
1187 </refentry>
1188
1189 <refentry id="appc-refentry-86">
1190 <refmeta>
1191 <refmiscinfo class="allowable values">pathname</refmiscinfo>
1192 <refmiscinfo class="default">NULL</refmiscinfo>
1193 </refmeta>
1194 <refnamediv>
1195 <refname>[global] logon script = pathname</refname>
1196 </refnamediv>
1197 <refsynopsisdiv>
1198 <para>Sets pathname relative to <literal>[netlogin]</literal> share of a DOS/NT script to run on the client at login time. Allows all %-variables.</para>
1199
1200 </refsynopsisdiv>
1201 </refentry>
1202
1203 <refentry id="appc-refentry-87">
1204 <refmeta>
1205 <refmiscinfo class="allowable values">fully-qualfied Unix shell command</refmiscinfo>
1206 <refmiscinfo class="default">varies</refmiscinfo>
1207 </refmeta>
1208 <refnamediv>
1209 <refname>lppause command = /absolute_ path/command</refname>
1210 </refnamediv>
1211 <refsynopsisdiv>
1212 <para>Sets the command to pause a print job. Honors the <literal>%p</literal> (printer name) and <literal>%j</literal> (job number) variables.</para>
1213
1214 </refsynopsisdiv>
1215 </refentry>
1216
1217 <refentry id="appc-refentry-88">
1218 <refmeta>
1219 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
1220 <refmiscinfo class="default">varies</refmiscinfo>
1221 </refmeta>
1222 <refnamediv>
1223 <refname>lpresume command = /absolute_ path/command</refname>
1224 </refnamediv>
1225 <refsynopsisdiv>
1226 <para>Sets the command to resume a paused print job. Honors the <literal>%p</literal> (printer name) and <literal>%j</literal> ( job number) variables.</para>
1227
1228 </refsynopsisdiv>
1229 </refentry>
1230
1231 <refentry id="appc-refentry-89">
1232 <refmeta>
1233 <refmiscinfo class="allowable values">number of seconds</refmiscinfo>
1234 <refmiscinfo class="default">10</refmiscinfo>
1235 </refmeta>
1236 <refnamediv>
1237 <refname>[global] lpq cache time = seconds</refname>
1238 </refnamediv>
1239 <refsynopsisdiv>
1240 <para>Sets how long to keep print queue (<literal>lpq  </literal>) status is cached, in seconds.</para>
1241
1242 </refsynopsisdiv>
1243 </refentry>
1244
1245 <refentry id="appc-refentry-90">
1246 <refmeta>
1247 <refmiscinfo class="allowable values">fully-qualfied Unix shell command</refmiscinfo>
1248 <refmiscinfo class="default">varies</refmiscinfo>
1249 </refmeta>
1250 <refnamediv>
1251 <refname>lpq command = /absolute_ path/command</refname>
1252 </refnamediv>
1253 <refsynopsisdiv>
1254 <para>Sets the command used to get printer status. Usually initialized to a default value by the <literal>printing</literal> option. Honors the <literal>%p</literal> (printer name) variable.</para>
1255
1256 </refsynopsisdiv>
1257 </refentry>
1258
1259 <refentry id="appc-refentry-91">
1260 <refmeta>
1261 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
1262 <refmiscinfo class="default">varies</refmiscinfo>
1263 </refmeta>
1264 <refnamediv>
1265 <refname>lprm command = /absolute_ path/command</refname>
1266 </refnamediv>
1267 <refsynopsisdiv>
1268 <para>Sets the command to delete a print job. Usually initialized to a default value by the <literal>printing</literal> option. Honors the <literal>%p</literal> (printer name) and <literal>%j</literal> (job number) variables.</para>
1269
1270 </refsynopsisdiv>
1271 </refentry>
1272
1273 <refentry id="appc-refentry-92">
1274 <refmeta>
1275 <refmiscinfo class="allowable values">number of seconds</refmiscinfo>
1276 <refmiscinfo class="default">604,800</refmiscinfo>
1277 </refmeta>
1278 <refnamediv>
1279 <refname>machine password timeout = seconds</refname>
1280 </refnamediv>
1281 <refsynopsisdiv>
1282 <para>Sets the period between (NT domain) machine password changes. Default is 1 week, or 604,800 seconds.</para>
1283
1284 </refsynopsisdiv>
1285 </refentry>
1286
1287 <refentry id="appc-refentry-93">
1288 <refmeta>
1289 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
1290 <refmiscinfo class="default"><emphasis>script.out</emphasis></refmiscinfo>
1291 </refmeta>
1292 <refnamediv>
1293 <refname>magic output = pathname</refname>
1294 </refnamediv>
1295 <refsynopsisdiv>
1296 <para>Sets the output file for the discouraged <literal>magic scripts</literal> option. Default is the script name, followed by the extension <emphasis>.out</emphasis>.</para>
1297
1298 </refsynopsisdiv>
1299 </refentry>
1300
1301 <refentry id="appc-refentry-94">
1302 <refmeta>
1303 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
1304 <refmiscinfo class="default">NULL</refmiscinfo>
1305 </refmeta>
1306 <refnamediv>
1307 <refname>magic script = pathname</refname>
1308 </refnamediv>
1309 <refsynopsisdiv>
1310 <para>Sets a filename for execution via a shell whenever the file is closed from the client, to allow clients to run commands on the server.</para>
1311
1312 </refsynopsisdiv>
1313 </refentry>
1314
1315 <refentry id="appc-refentry-95">
1316 <refmeta>
1317 <refmiscinfo class="allowable values"><emphasis>allowable values:</emphasis> YES, NO</refmiscinfo>
1318 <refmiscinfo class="default">NO</refmiscinfo>
1319 </refmeta>
1320 <refnamediv>
1321 <refname>mangle case = boolean</refname>
1322 </refnamediv>
1323 <refsynopsisdiv>
1324 <para>Mangle a name if it is in mixed case.</para>
1325
1326 </refsynopsisdiv>
1327 </refentry>
1328
1329 <refentry id="appc-refentry-96">
1330 <refmeta>
1331 <refmiscinfo class="allowable values">list of to-from pairs</refmiscinfo>
1332 <refmiscinfo class="default">NULL</refmiscinfo>
1333 </refmeta>
1334 <refnamediv>
1335 <refname>mangled map = map list</refname>
1336 </refnamediv>
1337 <refsynopsisdiv>
1338 <para>Set up a table of names to remap (e.g., <emphasis>.html</emphasis> to <emphasis>.htm</emphasis>).</para>
1339
1340 </refsynopsisdiv>
1341 </refentry>
1342
1343 <refentry id="appc-refentry-97">
1344 <refmeta>
1345 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1346 <refmiscinfo class="default">YES</refmiscinfo>
1347 </refmeta>
1348 <refnamediv>
1349 <refname>mangled names = boolean</refname>
1350 </refnamediv>
1351 <refsynopsisdiv>
1352 <para>Sets Samba to abbreviate names that are too long or have unsupported characters to the DOS 8.3 style.</para>
1353
1354 </refsynopsisdiv>
1355 </refentry>
1356
1357 <refentry id="appc-refentry-98">
1358 <refmeta>
1359 <refmiscinfo class="allowable values">character</refmiscinfo>
1360 <refmiscinfo class="default">~</refmiscinfo>
1361 </refmeta>
1362 <refnamediv>
1363 <refname>mangling char = character</refname>
1364 </refnamediv>
1365 <refsynopsisdiv>
1366 <para>Sets the unique mangling character used in all mangled names.</para>
1367
1368 </refsynopsisdiv>
1369 </refentry>
1370
1371 <refentry id="appc-refentry-99">
1372 <refmeta>
1373 <refmiscinfo class="allowable values">number</refmiscinfo>
1374 <refmiscinfo class="default">50</refmiscinfo>
1375 </refmeta>
1376 <refnamediv>
1377 <refname>[global] mangled stack = number</refname>
1378 </refnamediv>
1379 <refsynopsisdiv>
1380 <para>Sets the size of a cache of recently-mangled filenames.</para>
1381
1382 </refsynopsisdiv>
1383 </refentry>
1384
1385 <refentry id="appc-refentry-100">
1386 <refmeta>
1387 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
1388 <refmiscinfo class="default">NULL</refmiscinfo>
1389 </refmeta>
1390 <refnamediv>
1391 <refname>map aliasname = pathname</refname>
1392 </refnamediv>
1393 <refsynopsisdiv>
1394 <para>Points to a file of Unix group/NT group pairs, one per line. This is used to map NT aliases to Unix group names. See also the configuration options <literal>username</literal> <literal>map</literal> and <literal>map</literal> <literal>groupname</literal>. Introduced in Samba 2.0.</para>
1395
1396 </refsynopsisdiv>
1397 </refentry>
1398
1399 <refentry id="appc-refentry-101">
1400 <refmeta>
1401 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1402 <refmiscinfo class="default">YES</refmiscinfo>
1403 </refmeta>
1404 <refnamediv>
1405 <refname>map archive = boolean</refname>
1406 </refnamediv>
1407 <refsynopsisdiv>
1408 <para>If YES, Samba sets the executable-by-user (0100) bit on Unix files if the DOS archive attribute is set. Recommended: if used, the <literal>create mask</literal> must contain the 0100 bit.</para>
1409
1410 </refsynopsisdiv>
1411 </refentry>
1412
1413 <refentry id="appc-refentry-102">
1414 <refmeta>
1415 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1416 <refmiscinfo class="default">NO</refmiscinfo>
1417 </refmeta>
1418 <refnamediv>
1419 <refname>map hidden = boolean</refname>
1420 </refnamediv>
1421 <refsynopsisdiv>
1422 <para>If YES, sets executable-by-other (0001) bit on Unix files if the DOS hidden attribute is set. If used, the <literal>create mask</literal> option must contain the  0001 bit.</para>
1423
1424 </refsynopsisdiv>
1425 </refentry>
1426
1427 <refentry id="appc-refentry-103">
1428 <refmeta>
1429 <refmiscinfo class="allowable values">pathname</refmiscinfo>
1430 <refmiscinfo class="default">NULL</refmiscinfo>
1431 </refmeta>
1432 <refnamediv>
1433 <refname>map groupname = pathname</refname>
1434 </refnamediv>
1435 <refsynopsisdiv>
1436 <para>Points to a file of Unix group/NT group, one per line. This is used to map NT group names to Unix group names. See also the configuration options <literal>username</literal> <literal>map</literal> and <literal>map</literal> <literal>aliasname</literal>. Introduced in Samba 2.0.</para>
1437
1438 </refsynopsisdiv>
1439 </refentry>
1440
1441 <refentry id="appc-refentry-104">
1442 <refmeta>
1443 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1444 <refmiscinfo class="default">NO</refmiscinfo>
1445 </refmeta>
1446 <refnamediv>
1447 <refname>map system = boolean</refname>
1448 </refnamediv>
1449 <refsynopsisdiv>
1450 <para>If YES, Samba sets the executable-by-group (0010) bit on Unix files if the DOS system attribute is set. If used, the <literal>create mask</literal> must contain the  0010 bit.</para>
1451
1452 </refsynopsisdiv>
1453 </refentry>
1454
1455 <refentry id="appc-refentry-105">
1456 <refmeta>
1457 <refmiscinfo class="allowable values">number</refmiscinfo>
1458 <refmiscinfo class="default">0 (infinity)</refmiscinfo>
1459 </refmeta>
1460 <refnamediv>
1461 <refname>max connections = number</refname>
1462 </refnamediv>
1463 <refsynopsisdiv>
1464 <para>Set maximum number of connections allowed to a share from each individual client machine.</para>
1465
1466 </refsynopsisdiv>
1467 </refentry>
1468
1469 <refentry id="appc-refentry-106">
1470 <refmeta>
1471 <refmiscinfo class="allowable values">size in MB</refmiscinfo>
1472 <refmiscinfo class="default">0 (unchanged)</refmiscinfo>
1473 </refmeta>
1474 <refnamediv>
1475 <refname>[global] max disk size = number</refname>
1476 </refnamediv>
1477 <refsynopsisdiv>
1478 <para>Sets maximum disk size/free-space size (in megabytes) to return to client. Some clients or applications can't understand large maximum disk sizes.</para>
1479
1480 </refsynopsisdiv>
1481 </refentry>
1482
1483 <refentry id="appc-refentry-107">
1484 <refmeta>
1485 <refmiscinfo class="allowable values">size in KB</refmiscinfo>
1486 <refmiscinfo class="default">5000</refmiscinfo>
1487 </refmeta>
1488 <refnamediv>
1489 <refname>[global] max log size = number</refname>
1490 </refnamediv>
1491 <refsynopsisdiv>
1492 <para>Sets the size (in kilobytes) at which Samba will start a new log file. The current log file will be renamed with an <emphasis>.old</emphasis> extension, replacing any previous file with that name.</para>
1493
1494 </refsynopsisdiv>
1495 </refentry>
1496
1497 <refentry id="appc-refentry-108">
1498 <refmeta>
1499 <refmiscinfo class="allowable values">number</refmiscinfo>
1500 <refmiscinfo class="default">50</refmiscinfo>
1501 </refmeta>
1502 <refnamediv>
1503 <refname>[global] max mux = number</refname>
1504 </refnamediv>
1505 <refsynopsisdiv>
1506 <para>Sets the number of simultaneous operations that Samba clients may make. Avoid changing.</para>
1507
1508 </refsynopsisdiv>
1509 </refentry>
1510
1511 <refentry id="appc-refentry-109">
1512 <refmeta>
1513 <refmiscinfo class="allowable values">number</refmiscinfo>
1514 <refmiscinfo class="default">N/A</refmiscinfo>
1515 </refmeta>
1516 <refnamediv>
1517 <refname>[global] max packet = number</refname>
1518 </refnamediv>
1519 <refsynopsisdiv>
1520 <para>Synonym for <literal>packet size</literal>. Obsolete as of Samba 1.7. Use <literal>max xmit</literal> instead.</para>
1521
1522 </refsynopsisdiv>
1523 </refentry>
1524
1525 <refentry id="appc-refentry-110">
1526 <refmeta>
1527 <refmiscinfo class="allowable values">number</refmiscinfo>
1528 <refmiscinfo class="default">10,000</refmiscinfo>
1529 </refmeta>
1530 <refnamediv>
1531 <refname>[global] max open files = number</refname>
1532 </refnamediv>
1533 <refsynopsisdiv>
1534 <para>Limits the number of files a Samba process will try to keep open at one time. Samba allows you to set this to less than the Unix maximum. This option is a workaround for a separate problem. Avoid changing. This option was introduced in Samba 2.0.</para>
1535
1536 </refsynopsisdiv>
1537 </refentry>
1538
1539 <refentry id="appc-refentry-111">
1540 <refmeta>
1541 <refmiscinfo class="allowable values">time in seconds</refmiscinfo>
1542 <refmiscinfo class="default">14400 (4 hrs)</refmiscinfo>
1543 </refmeta>
1544 <refnamediv>
1545 <refname>[global] max ttl = seconds</refname>
1546 </refnamediv>
1547 <refsynopsisdiv>
1548 <para>Sets the time to keep NetBIOS names in <emphasis>nmbd</emphasis> cache while trying to perform a lookup on it. Avoid changing.</para>
1549
1550 </refsynopsisdiv>
1551 </refentry>
1552
1553 <refentry id="appc-refentry-112">
1554 <refmeta>
1555 <refmiscinfo class="allowable values">time in seconds</refmiscinfo>
1556 <refmiscinfo class="default">259200 (3 days)</refmiscinfo>
1557 </refmeta>
1558 <refnamediv>
1559 <refname>[global] max wins ttl = seconds</refname>
1560 </refnamediv>
1561 <refsynopsisdiv>
1562 <para>Limits time-to-live of a NetBIOS name in <emphasis>nmbd</emphasis> WINS cache, in seconds. Avoid changing.</para>
1563
1564 </refsynopsisdiv>
1565 </refentry>
1566
1567 <refentry id="appc-refentry-113">
1568 <refmeta>
1569 <refmiscinfo class="allowable values">size in bytes</refmiscinfo>
1570 <refmiscinfo class="default">65535</refmiscinfo>
1571 </refmeta>
1572 <refnamediv>
1573 <refname>[global] max xmit = bytes</refname>
1574 </refnamediv>
1575 <refsynopsisdiv>
1576 <para>Sets maximum packet size that will be negotiated by Samba. Tuning parameter for slow links and older client bugs. Values less than 2048 are discouraged.</para>
1577
1578 </refsynopsisdiv>
1579 </refentry>
1580
1581 <refentry id="appc-refentry-114">
1582 <refmeta>
1583 <refmiscinfo class="allowable values">shell command</refmiscinfo>
1584 <refmiscinfo class="default">NULL</refmiscinfo>
1585 </refmeta>
1586 <refnamediv>
1587 <refname>[global] message command = /absolute_ path/command</refname>
1588 </refnamediv>
1589 <refsynopsisdiv>
1590 <para>Sets the command on the server to run when a WinPopup message arrives from a client. The command must end in "<literal>&amp;</literal>" to allow immediate return. Honors all %-variables except <literal>%u</literal> (user), and supports the extra variables <literal>%s</literal> (filename the message is in), <literal>%t</literal> (destination machine), and <literal>%f</literal> (from).</para>
1591
1592 </refsynopsisdiv>
1593 </refentry>
1594
1595 <refentry id="appc-refentry-115">
1596 <refmeta>
1597 <refmiscinfo class="allowable values">space in KB</refmiscinfo>
1598 <refmiscinfo class="default">0 (unlimited)</refmiscinfo>
1599 </refmeta>
1600 <refnamediv>
1601 <refname>min print space = kilobytes</refname>
1602 </refnamediv>
1603 <refsynopsisdiv>
1604 <para>Sets minimum spool space required before accepting a print request.</para>
1605
1606 </refsynopsisdiv>
1607 </refentry>
1608
1609 <refentry id="appc-refentry-116">
1610 <refmeta>
1611 <refmiscinfo class="allowable values">time in seconds</refmiscinfo>
1612 <refmiscinfo class="default">21600 (6 hrs)</refmiscinfo>
1613 </refmeta>
1614 <refnamediv>
1615 <refname>[global] min wins ttl = seconds</refname>
1616 </refnamediv>
1617 <refsynopsisdiv>
1618 <para>Sets minimum time-to-live of a NetBIOS name in <emphasis>nmbd</emphasis> WINS cache, in seconds. Avoid changing.</para>
1619
1620 </refsynopsisdiv>
1621 </refentry>
1622
1623 <refentry id="appc-refentry-117">
1624 <refmeta>
1625 <refmiscinfo class="allowable values">list of lmhosts, wins, hosts and bcast</refmiscinfo>
1626 <refmiscinfo class="default">lmhosts wins hosts bcast</refmiscinfo>
1627 </refmeta>
1628 <refnamediv>
1629 <refname>name resolve order = list</refname>
1630 </refnamediv>
1631 <refsynopsisdiv>
1632 <para>Sets order of lookup when trying to get IP address from names. The <literal>hosts</literal> parameter carrries out a regular name look up using the server's normal sources: <emphasis>/etc/hosts</emphasis>, DNS, NIS, or a combination of them. Introduced in Samba 1.9.18p4.</para>
1633
1634 </refsynopsisdiv>
1635 </refentry>
1636
1637 <refentry id="appc-refentry-118">
1638 <refmeta>
1639 <refmiscinfo class="allowable values">list of netbios names</refmiscinfo>
1640 <refmiscinfo class="default">NULL</refmiscinfo>
1641 </refmeta>
1642 <refnamediv>
1643 <refname>[global] netbios aliases = list</refname>
1644 </refnamediv>
1645 <refsynopsisdiv>
1646 <para>Adds additional NetBIOS names by which a Samba server will advertise itself.</para>
1647
1648 </refsynopsisdiv>
1649 </refentry>
1650
1651 <refentry id="appc-refentry-119">
1652 <refmeta>
1653 <refmiscinfo class="allowable values">host name</refmiscinfo>
1654 <refmiscinfo class="default">varies</refmiscinfo>
1655 </refmeta>
1656 <refnamediv>
1657 <refname>netbios name = hostname</refname>
1658 </refnamediv>
1659 <refsynopsisdiv>
1660 <para>Sets the NetBIOS name by which a Samba server is known, or primary name if NetBIOS aliases exist.</para>
1661
1662 </refsynopsisdiv>
1663 </refentry>
1664
1665 <refentry id="appc-refentry-120">
1666 <refmeta>
1667 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1668 <refmiscinfo class="default">YES</refmiscinfo>
1669 </refmeta>
1670 <refnamediv>
1671 <refname>[global] networkstation user login = boolean</refname>
1672 </refnamediv>
1673 <refsynopsisdiv>
1674 <para>If set to NO, clients will not do a full login when <literal>security = server</literal>. Avoid changing. Turning it off is a temporary workaround (introduced in Samba 1.9.18p3) for NT trusted domains bug. Automatic correction was introduced in Samba 1.9.18p10; the parameter may eventually be removed.</para>
1675
1676 </refsynopsisdiv>
1677 </refentry>
1678
1679 <refentry id="appc-refentry-121">
1680 <refmeta>
1681 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1682 <refmiscinfo class="default">NO</refmiscinfo>
1683 </refmeta>
1684 <refnamediv>
1685 <refname>[global] nis homedir = boolean</refname>
1686 </refnamediv>
1687 <refsynopsisdiv>
1688 <para>If YES, the <literal>homedir map</literal> will be used to look up the user's home-directory server name and return it to the client. The client will contact that machine to connect to the share. This avoids mounting from a machine that doesn't actually have the disk. The machine with the home directories must be an SMB server.</para>
1689
1690 </refsynopsisdiv>
1691 </refentry>
1692
1693 <refentry id="appc-refentry-122">
1694 <refmeta>
1695 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1696 <refmiscinfo class="default">YES</refmiscinfo>
1697 </refmeta>
1698 <refnamediv>
1699 <refname>[global] nt pipe support = boolean</refname>
1700 </refnamediv>
1701 <refsynopsisdiv>
1702 <para>Allows turning off NT-specific pipe calls. This is a developer/benchmarking option and may be removed in the future. Avoid changing.</para>
1703
1704 </refsynopsisdiv>
1705 </refentry>
1706
1707 <refentry id="appc-refentry-123">
1708 <refmeta>
1709 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1710 <refmiscinfo class="default">YES</refmiscinfo>
1711 </refmeta>
1712 <refnamediv>
1713 <refname>[global] nt smb support = boolean</refname>
1714 </refnamediv>
1715 <refsynopsisdiv>
1716 <para>If YES, allow NT-specific SMBs to be used. This is a developer/benchmarking option and may be removed in the future. Avoid changing.</para>
1717
1718 </refsynopsisdiv>
1719 </refentry>
1720
1721 <refentry id="appc-refentry-124">
1722 <refmeta>
1723 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1724 <refmiscinfo class="default">NO</refmiscinfo>
1725 </refmeta>
1726 <refnamediv>
1727 <refname>[global] null passwords = boolean</refname>
1728 </refnamediv>
1729 <refsynopsisdiv>
1730 <para>If YES, allows access to accounts that have null passwords. Strongly discouraged.</para>
1731
1732 </refsynopsisdiv>
1733 </refentry>
1734
1735 <refentry id="appc-refentry-125">
1736 <refmeta>
1737 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1738 <refmiscinfo class="default">YES</refmiscinfo>
1739 </refmeta>
1740 <refnamediv>
1741 <refname>ole locking compatibility = boolean</refname>
1742 </refnamediv>
1743 <refsynopsisdiv>
1744 <para>If YES, locking ranges will be mapped to avoid Unix locks crashing when Windows uses locks above 32KB. You should avoid changing this option. Introduced in Samba 1.9.18p10.</para>
1745
1746 </refsynopsisdiv>
1747 </refentry>
1748
1749 <refentry id="appc-refentry-126">
1750 <refmeta>
1751 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1752 <refmiscinfo class="default">NO</refmiscinfo>
1753 </refmeta>
1754 <refnamediv>
1755 <refname>only guest = boolean</refname>
1756 </refnamediv>
1757 <refsynopsisdiv>
1758 <para>A synonym for <literal>guest only</literal>. Forces user of a share to login as the guest account.</para>
1759
1760 </refsynopsisdiv>
1761 </refentry>
1762
1763 <refentry id="appc-refentry-127">
1764 <refmeta>
1765 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1766 <refmiscinfo class="default">NO</refmiscinfo>
1767 </refmeta>
1768 <refnamediv>
1769 <refname>only user = boolean</refname>
1770 </refnamediv>
1771 <refsynopsisdiv>
1772 <para>Requires that users of the share be on a <literal>username =</literal> list.</para>
1773
1774 </refsynopsisdiv>
1775 </refentry>
1776
1777 <refentry id="appc-refentry-128">
1778 <refmeta>
1779 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1780 <refmiscinfo class="default">YES</refmiscinfo>
1781 </refmeta>
1782 <refnamediv>
1783 <refname>oplocks = boolean</refname>
1784 </refnamediv>
1785 <refsynopsisdiv>
1786 <para>If YES, support local caching of <emphasis>opportunistic</emphasis> locked files on client. This option is recommended because it improves performance by about 30%. See also <literal>fake</literal> <literal>oplocks</literal> and <literal>veto</literal> <literal>oplock</literal> <literal>files</literal>.</para>
1787
1788 </refsynopsisdiv>
1789 </refentry>
1790
1791 <refentry id="appc-refentry-129">
1792 <refmeta>
1793 <refmiscinfo class="allowable values">number</refmiscinfo>
1794 <refmiscinfo class="default">0</refmiscinfo>
1795 </refmeta>
1796 <refnamediv>
1797 <refname>[global] os level = number</refname>
1798 </refnamediv>
1799 <refsynopsisdiv>
1800 <para>Sets the candidacy of the server when electing a browse master. Used with the <literal>domain</literal> <literal>master</literal> or <literal>local</literal> <literal>master</literal> options. You can set a higher value than a competing operating system if you want Samba to win. Windows for Workgroups and Windows 95 use 1, Windows NT client uses 17, and Windows NT Server uses 33.</para>
1801
1802 </refsynopsisdiv>
1803 </refentry>
1804
1805 <refentry id="appc-refentry-130">
1806 <refmeta>
1807 <refmiscinfo class="allowable values">number in bytes</refmiscinfo>
1808 <refmiscinfo class="default">65535</refmiscinfo>
1809 </refmeta>
1810 <refnamediv>
1811 <refname>[global] packet size = bytes</refname>
1812 </refnamediv>
1813 <refsynopsisdiv>
1814 <para>Obsolete. Discouraged synonym of <literal>max packet</literal>. See <literal>max xmit</literal>.</para>
1815
1816 </refsynopsisdiv>
1817 </refentry>
1818
1819 <refentry id="appc-refentry-131">
1820 <refmeta>
1821 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1822 <refmiscinfo class="default">NO</refmiscinfo>
1823 </refmeta>
1824 <refnamediv>
1825 <refname>[global] passwd chat debug = boolean</refname>
1826 </refnamediv>
1827 <refsynopsisdiv>
1828 <para>Logs an entire password chat, including passwords passed, with a log level of 100. For debugging only. Introduced in Samba 1.9.18p5.</para>
1829
1830 </refsynopsisdiv>
1831 </refentry>
1832
1833 <refentry id="appc-refentry-132">
1834 <refmeta>
1835 <refmiscinfo class="allowable values">Unix server commands</refmiscinfo>
1836 <refmiscinfo class="default">compiled-in value</refmiscinfo>
1837 </refmeta>
1838 <refnamediv>
1839 <refname>[global] passwd chat = command sequence</refname>
1840 </refnamediv>
1841 <refsynopsisdiv>
1842 <para>Sets the command used to change passwords on the server. Supports the variables <literal>%o</literal> (old password) and <literal>%n</literal> (new password) and allows <literal>\r</literal> <literal>\n</literal> <literal>\t</literal> and <literal>\s</literal> (space) escapes in the sequence.</para>
1843
1844 </refsynopsisdiv>
1845 </refentry>
1846
1847 <refentry id="appc-refentry-133">
1848 <refmeta>
1849 <refmiscinfo class="allowable values">Unix server program</refmiscinfo>
1850 <refmiscinfo class="default">NULL</refmiscinfo>
1851 </refmeta>
1852 <refnamediv>
1853 <refname>[global] passwd program = program</refname>
1854 </refnamediv>
1855 <refsynopsisdiv>
1856 <para>Sets the command used to change user's password. Will be run as <literal>root</literal>. Supports <literal>%u</literal> (user).</para>
1857
1858 </refsynopsisdiv>
1859 </refentry>
1860
1861 <refentry id="appc-refentry-135">
1862 <refmeta>
1863 <refmiscinfo class="allowable values">list of NetBIOS names</refmiscinfo>
1864 <refmiscinfo class="default">NULL</refmiscinfo>
1865 </refmeta>
1866 <refnamediv>
1867 <refname>[global] password server = netbios names</refname>
1868 </refnamediv>
1869 <refsynopsisdiv>
1870 <para>A list of SMB servers that will validate passwords for you. Used with an NT password server (PDC or BDC) and the <literal>security</literal> <literal>=</literal> <literal>server</literal> or <literal>security</literal> <literal>=</literal> <literal>domain</literal> configuration options. Caution: an NT password server must allow logins from the Samba server.</para>
1871
1872 </refsynopsisdiv>
1873 </refentry>
1874
1875 <refentry id="appc-refentry-136">
1876 <refmeta>
1877 <refmiscinfo class="allowable values">fully-qualfied Unix shell command</refmiscinfo>
1878 <refmiscinfo class="default">NULL</refmiscinfo>
1879 </refmeta>
1880 <refnamediv>
1881 <refname>panic action = /absolute_ path/command</refname>
1882 </refnamediv>
1883 <refsynopsisdiv>
1884 <para>Sets the command to run when Samba panics. For Samba developers and testers, <literal>/usr/bin/X11/xterm -display :0 -e gdb /samba/bin/smbd %d</literal> is a possible value.</para>
1885
1886 </refsynopsisdiv>
1887 </refentry>
1888
1889 <refentry id="appc-refentry-137">
1890 <refmeta>
1891 <refmiscinfo class="allowable values">pathname</refmiscinfo>
1892 <refmiscinfo class="default">varies</refmiscinfo>
1893 </refmeta>
1894 <refnamediv>
1895 <refname>path = pathname</refname>
1896 </refnamediv>
1897 <refsynopsisdiv>
1898 <para>Sets the path to the directory provided by a file share or used by a printer share. Set automatically in <literal>[homes]</literal> share to user's home directory, otherwise defaults to<filename> /tmp</filename>. Honors the <literal>%u</literal> (user) and <literal>%m</literal> (machine) variables.</para>
1899
1900 </refsynopsisdiv>
1901 </refentry>
1902
1903 <refentry id="appc-refentry-138">
1904 <refmeta>
1905 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
1906 <refmiscinfo class="default">NULL</refmiscinfo>
1907 </refmeta>
1908 <refnamediv>
1909 <refname>postexec = /absolute_  path/command</refname>
1910 </refnamediv>
1911 <refsynopsisdiv>
1912 <para>Sets a command to run as the user after disconnecting from the share. See also the options <literal>preexec</literal>, <literal>root preexec</literal>, and <literal>root postexec</literal>.</para>
1913
1914 </refsynopsisdiv>
1915 </refentry>
1916
1917 <refentry id="appc-refentry-139">
1918 <refmeta>
1919 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1920 <refmiscinfo class="default">NO</refmiscinfo>
1921 </refmeta>
1922 <refnamediv>
1923 <refname>postscript = boolean</refname>
1924 </refnamediv>
1925 <refsynopsisdiv>
1926 <para>Flags a printer as PostScript to avoid a Windows bug by inserting <literal>%!</literal> as the first line. Works only if printer actually is PostScript compatible.</para>
1927
1928 </refsynopsisdiv>
1929 </refentry>
1930
1931 <refentry id="appc-refentry-140">
1932 <refmeta>
1933 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
1934 <refmiscinfo class="default">NULL</refmiscinfo>
1935 </refmeta>
1936 <refnamediv>
1937 <refname>preexec = /absolute_ path/command</refname>
1938 </refnamediv>
1939 <refsynopsisdiv>
1940 <para>Sets a command to run as the user before connecting to the share. See also the options <literal>postexec</literal>, <literal>root preexec</literal>, and <literal>root postexec</literal>.</para>
1941
1942 </refsynopsisdiv>
1943 </refentry>
1944
1945 <refentry id="appc-refentry-141">
1946 <refmeta>
1947 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1948 <refmiscinfo class="default">NO</refmiscinfo>
1949 </refmeta>
1950 <refnamediv>
1951 <refname>[global] preferred master = boolean</refname>
1952 </refnamediv>
1953 <refsynopsisdiv>
1954 <para>If YES, Samba is preferred to become the master browser. Causes Samba to call a browsing election when it comes online.</para>
1955
1956 </refsynopsisdiv>
1957 </refentry>
1958
1959 <refentry id="appc-refentry-142">
1960 <refmeta>
1961 <refmiscinfo class="allowable values">list of services</refmiscinfo>
1962 <refmiscinfo class="default">NULL</refmiscinfo>
1963 </refmeta>
1964 <refnamediv>
1965 <refname>preload = share list</refname>
1966 </refnamediv>
1967 <refsynopsisdiv>
1968 <para>Synonym of <literal>auto</literal> <literal>services</literal>. Specifies a list of shares that will always appear in browse lists.</para>
1969
1970 </refsynopsisdiv>
1971 </refentry>
1972
1973 <refentry id="appc-refentry-143">
1974 <refmeta>
1975 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1976 <refmiscinfo class="default">NO</refmiscinfo>
1977 </refmeta>
1978 <refnamediv>
1979 <refname>preserve case = boolean</refname>
1980 </refnamediv>
1981 <refsynopsisdiv>
1982 <para>If set to YES, this option leaves filenames in the case sent by client. If no, it forces filenames to the case specified by the <literal>default</literal> <literal>case</literal> option. See also <literal>short preserve case</literal>.</para>
1983
1984 </refsynopsisdiv>
1985 </refentry>
1986
1987 <refentry id="appc-refentry-144">
1988 <refmeta>
1989 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
1990 <refmiscinfo class="default">varies</refmiscinfo>
1991 </refmeta>
1992 <refnamediv>
1993 <refname>print command = /absolute_ path/command</refname>
1994 </refnamediv>
1995 <refsynopsisdiv>
1996 <para>Sets the command used to send a spooled file to the printer. Usually initialized to a default value by the <literal>printing</literal> option. This option honors the <literal>%p</literal> (printer name), <literal>%s</literal> (spool file) and <literal>%f</literal> (spool file as a relative path) variables. Note that the command in the value of the option must include file deletion of the spool file.</para>
1997
1998 </refsynopsisdiv>
1999 </refentry>
2000
2001 <refentry id="appc-refentry-145">
2002 <refmeta>
2003 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2004 <refmiscinfo class="default">NO</refmiscinfo>
2005 </refmeta>
2006 <refnamediv>
2007 <refname>print ok = boolean</refname>
2008 </refnamediv>
2009 <refsynopsisdiv>
2010 <para>Synonym of <literal>printable</literal>.</para>
2011
2012 </refsynopsisdiv>
2013 </refentry>
2014
2015 <refentry id="appc-refentry-146">
2016 <refmeta>
2017 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2018 <refmiscinfo class="default">NO</refmiscinfo>
2019 </refmeta>
2020 <refnamediv>
2021 <refname>printable = boolean</refname>
2022 </refnamediv>
2023 <refsynopsisdiv>
2024 <para>Sets a share to be a print share. Required for all printers.</para>
2025
2026 </refsynopsisdiv>
2027 </refentry>
2028
2029 <refentry id="appc-refentry-147">
2030 <refmeta>
2031 <refmiscinfo class="allowable values">pathname</refmiscinfo>
2032 <refmiscinfo class="default"><emphasis>/etc/printcap</emphasis></refmiscinfo>
2033 </refmeta>
2034 <refnamediv>
2035 <refname>[global] printcap name = pathname</refname>
2036 </refnamediv>
2037 <refsynopsisdiv>
2038 <para>Sets the path to the printer capabilities file used by the <literal>[printers]</literal> share. The default value changes to <filename>/etc/qconfig</filename> under AIX and <filename>lpstat</filename> on System V.</para>
2039
2040 </refsynopsisdiv>
2041 </refentry>
2042
2043 <refentry id="appc-refentry-148">
2044 <refmeta>
2045 <refmiscinfo class="allowable values">printer name</refmiscinfo>
2046 <refmiscinfo class="default"><literal>lp</literal></refmiscinfo>
2047 </refmeta>
2048 <refnamediv>
2049 <refname>printer = name</refname>
2050 </refnamediv>
2051 <refsynopsisdiv>
2052 <para>Sets the name of the Unix printer.</para>
2053
2054 </refsynopsisdiv>
2055 </refentry>
2056
2057 <refentry id="appc-refentry-149">
2058 <refmeta>
2059 <refmiscinfo class="allowable values">exact printer driver string used by Windows</refmiscinfo>
2060 <refmiscinfo class="default">NULL</refmiscinfo>
2061 </refmeta>
2062 <refnamediv>
2063 <refname>printer driver = printer driver name</refname>
2064 </refnamediv>
2065 <refsynopsisdiv>
2066 <para>Sets the string to pass to Windows when asked what driver to use to prepare files for a printer share. Note that the value is case sensitive.</para>
2067
2068 </refsynopsisdiv>
2069 </refentry>
2070
2071 <refentry id="appc-refentry-150">
2072 <refmeta>
2073 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
2074 <refmiscinfo class="default"><emphasis>samba-lib/printers.def</emphasis></refmiscinfo>
2075 </refmeta>
2076 <refnamediv>
2077 <refname>[global] printer driver file = path</refname>
2078 </refnamediv>
2079 <refsynopsisdiv>
2080 <para>Sets the location of a <emphasis>msprint.def</emphasis> file, usable by Windows 95/98.</para>
2081
2082 </refsynopsisdiv>
2083 </refentry>
2084
2085 <refentry id="appc-refentry-151">
2086 <refmeta>
2087 <refmiscinfo class="allowable values">Windows network path</refmiscinfo>
2088 <refmiscinfo class="default"><emphasis>\\</emphasis><replaceable>server</replaceable><emphasis>\PRINTER$</emphasis></refmiscinfo>
2089 </refmeta>
2090 <refnamediv>
2091 <refname>printer driver location = path</refname>
2092 </refnamediv>
2093 <refsynopsisdiv>
2094 <para>Sets the location of the driver for a particular printer. The value is a pathname for a share that stores the printer driver files.</para>
2095
2096 </refsynopsisdiv>
2097 </refentry>
2098
2099 <refentry id="appc-refentry-152">
2100 <refmeta>
2101 <refmiscinfo class="allowable values">name</refmiscinfo>
2102 <refmiscinfo class="default">NULL</refmiscinfo>
2103 </refmeta>
2104 <refnamediv>
2105 <refname>printer name = name</refname>
2106 </refnamediv>
2107 <refsynopsisdiv>
2108 <para>Synonym of <literal>printer</literal>.</para>
2109
2110 </refsynopsisdiv>
2111 </refentry>
2112
2113 <refentry id="appc-refentry-153">
2114 <refmeta>
2115 <refmiscinfo class="allowable values">bsd, sysv, hpux, aix, qnx, plp, lprng</refmiscinfo>
2116 <refmiscinfo class="default">bsd</refmiscinfo>
2117 </refmeta>
2118 <refnamediv>
2119 <refname>printing = style</refname>
2120 </refnamediv>
2121 <refsynopsisdiv>
2122 <para>Sets printing style to one of the above, instead of the compiled-in value. This sets initial values of at least the <literal>print</literal> <literal>command </literal>, <literal>print</literal> <literal>command </literal>, <literal>lpq</literal> <literal>command </literal>, and <literal>lprm</literal> <literal>command</literal>.</para>
2123
2124 </refsynopsisdiv>
2125 </refentry>
2126
2127 <refentry id="appc-refentry-154">
2128 <refmeta>
2129 <refmiscinfo class="allowable values">NT1, LANMAN2, LANMAN1, COREPLUS, CORE</refmiscinfo>
2130 <refmiscinfo class="default">NT1</refmiscinfo>
2131 </refmeta>
2132 <refnamediv>
2133 <refname>[global] protocol = protocol</refname>
2134 </refnamediv>
2135 <refsynopsisdiv>
2136 <para>Sets SMB protocol version to one of the allowable
2137 values. Resetting is highly discouraged. Only for backwards
2138 compatibility with older-client bugs.</para>
2139
2140 </refsynopsisdiv>
2141 </refentry>
2142
2143 <refentry id="appc-refentry-155">
2144 <refmeta>
2145 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2146 <refmiscinfo class="default">NO</refmiscinfo>
2147 </refmeta>
2148 <refnamediv>
2149 <refname>public = boolean</refname>
2150 </refnamediv>
2151 <refsynopsisdiv>
2152 <para>If YES, passwords are not needed for this share. A synonym is <literal>guest ok</literal>.</para>
2153
2154 </refsynopsisdiv>
2155 </refentry>
2156
2157 <refentry id="appc-refentry-156">
2158 <refmeta>
2159 <refmiscinfo class="allowable values">valid Unix command</refmiscinfo>
2160 <refmiscinfo class="default">varies</refmiscinfo>
2161 </refmeta>
2162 <refnamediv>
2163 <refname>queuepause command = /absolute_ path/command</refname>
2164 </refnamediv>
2165 <refsynopsisdiv>
2166 <para>Sets the command used to pause a print queue. Usually initialized to a default value by the <literal>printing</literal> option. Introduced in Samba 1.9.18p10.</para>
2167
2168 </refsynopsisdiv>
2169 </refentry>
2170
2171 <refentry id="appc-refentry-157">
2172 <refmeta>
2173 <refmiscinfo class="allowable values">valid Unix command</refmiscinfo>
2174 <refmiscinfo class="default">varies</refmiscinfo>
2175 </refmeta>
2176 <refnamediv>
2177 <refname>queueresume command = /absolute_ path/command</refname>
2178 </refnamediv>
2179 <refsynopsisdiv>
2180 <para>Sets the command used to resume a print queue. Usually initialized to a default value by the <literal>printing</literal> option. Introduced in Samba 1.9.18p10.</para>
2181
2182 </refsynopsisdiv>
2183 </refentry>
2184
2185 <refentry id="appc-refentry-158">
2186 <refmeta>
2187 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2188 <refmiscinfo class="default">NO</refmiscinfo>
2189 </refmeta>
2190 <refnamediv>
2191 <refname>read bmpx = boolean</refname>
2192 </refnamediv>
2193 <refsynopsisdiv>
2194 <para>Obsolete. Do not change.</para>
2195
2196 </refsynopsisdiv>
2197 </refentry>
2198
2199 <refentry id="appc-refentry-159">
2200 <refmeta>
2201 <refmiscinfo class="allowable values">comma-separated list of users</refmiscinfo>
2202 <refmiscinfo class="default">NULL</refmiscinfo>
2203 </refmeta>
2204 <refnamediv>
2205 <refname>read list = comma-separated list</refname>
2206 </refnamediv>
2207 <refsynopsisdiv>
2208 <para>Specifies a list of users given read-only access to a writeable share.</para>
2209
2210 </refsynopsisdiv>
2211 </refentry>
2212
2213 <refentry id="appc-refentry-160">
2214 <refmeta>
2215 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2216 <refmiscinfo class="default">NO</refmiscinfo>
2217 </refmeta>
2218 <refnamediv>
2219 <refname>read only = boolean</refname>
2220 </refnamediv>
2221 <refsynopsisdiv>
2222 <para>Sets a share to read-only. Antonym of <literal>writable</literal> and <literal>write ok</literal>.</para>
2223
2224 </refsynopsisdiv>
2225 </refentry>
2226
2227 <refentry id="appc-refentry-161">
2228 <refmeta>
2229 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2230 <refmiscinfo class="default">NO</refmiscinfo>
2231 </refmeta>
2232 <refnamediv>
2233 <refname>[global] read prediction = boolean</refname>
2234 </refnamediv>
2235 <refsynopsisdiv>
2236 <para>Reads ahead data for read-only files. Obsolete; removed in Samba 2.0.</para>
2237
2238 </refsynopsisdiv>
2239 </refentry>
2240
2241 <refentry id="appc-refentry-162">
2242 <refmeta>
2243 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2244 <refmiscinfo class="default">YES</refmiscinfo>
2245 </refmeta>
2246 <refnamediv>
2247 <refname>[global] read raw = boolean</refname>
2248 </refnamediv>
2249 <refsynopsisdiv>
2250 <para>Allows fast streaming reads over TCP using 64K buffers. Recommended.</para>
2251
2252 </refsynopsisdiv>
2253 </refentry>
2254
2255 <refentry id="appc-refentry-163">
2256 <refmeta>
2257 <refmiscinfo class="allowable values">size in bytes</refmiscinfo>
2258 <refmiscinfo class="default">2048</refmiscinfo>
2259 </refmeta>
2260 <refnamediv>
2261 <refname>[global] read size = bytes</refname>
2262 </refnamediv>
2263 <refsynopsisdiv>
2264 <para>Sets a buffering option for servers with mismatched disk and network speeds. Requires experimentation. Avoid changing. Should not exceed 65536.</para>
2265
2266 </refsynopsisdiv>
2267 </refentry>
2268
2269 <refentry id="appc-refentry-164">
2270 <refmeta>
2271 <refmiscinfo class="allowable values">list of remote addresses</refmiscinfo>
2272 <refmiscinfo class="default">NULL</refmiscinfo>
2273 </refmeta>
2274 <refnamediv>
2275 <refname>[global] remote announce = remote list</refname>
2276 </refnamediv>
2277 <refsynopsisdiv>
2278 <para>Adds workgroups to the list on which the Samba server will announce itself. Specified as IP address/workgroup (for instance, 192.168.220.215/SIMPLE) with multiple groups separated by spaces. Allows directed broadcasts. The server will appear on those workgroup's browse lists. Does not require WINS.</para>
2279
2280 </refsynopsisdiv>
2281 </refentry>
2282
2283 <refentry id="appc-refentry-165">
2284 <refmeta>
2285 <refmiscinfo class="allowable values">IP-address list</refmiscinfo>
2286 <refmiscinfo class="default">NULL</refmiscinfo>
2287 </refmeta>
2288 <refnamediv>
2289 <refname>[global] remote browse sync = address list</refname>
2290 </refnamediv>
2291 <refsynopsisdiv>
2292 <para>Enables Samba-only browse list synchronization with other Samba local master browsers. Addresses can be specific addresses or directed broadcasts (i.e., ###.###.###.255). The latter will cause Samba to hunt down the local master.</para>
2293
2294 </refsynopsisdiv>
2295 </refentry>
2296
2297 <refentry id="appc-refentry-166">
2298 <refmeta>
2299 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2300 <refmiscinfo class="default">NO</refmiscinfo>
2301 </refmeta>
2302 <refnamediv>
2303 <refname>revalidate = boolean</refname>
2304 </refnamediv>
2305 <refsynopsisdiv>
2306 <para>If set to YES, requires users to re-enter passwords even after a successful initial logon to a share with a password.</para>
2307
2308 </refsynopsisdiv>
2309 </refentry>
2310
2311 <refentry id="appc-refentry-167">
2312 <refmeta>
2313 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
2314 <refmiscinfo class="default">NULL</refmiscinfo>
2315 </refmeta>
2316 <refnamediv>
2317 <refname>[global] root = pathname</refname>
2318 </refnamediv>
2319 <refsynopsisdiv>
2320 <para>Synonym for <literal>root directory</literal>.</para>
2321
2322 </refsynopsisdiv>
2323 </refentry>
2324
2325 <refentry id="appc-refentry-168">
2326 <refmeta>
2327 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
2328 <refmiscinfo class="default">NULL</refmiscinfo>
2329 </refmeta>
2330 <refnamediv>
2331 <refname>[global] root dir = pathname</refname>
2332 </refnamediv>
2333 <refsynopsisdiv>
2334 <para>Synonym for <literal>root directory</literal>.</para>
2335
2336 </refsynopsisdiv>
2337 </refentry>
2338
2339 <refentry id="appc-refentry-169">
2340 <refmeta>
2341 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
2342 <refmiscinfo class="default">NULL</refmiscinfo>
2343 </refmeta>
2344 <refnamediv>
2345 <refname>[global] root directory = pathname</refname>
2346 </refnamediv>
2347 <refsynopsisdiv>
2348 <para>Specifies a directory to <literal>chroot()</literal> to before starting daemons. Prevents any access below that directory tree. See also the <literal>wide links</literal> configuration option.</para>
2349
2350 </refsynopsisdiv>
2351 </refentry>
2352
2353 <refentry id="appc-refentry-170">
2354 <refmeta>
2355 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
2356 <refmiscinfo class="default">NULL</refmiscinfo>
2357 </refmeta>
2358 <refnamediv>
2359 <refname>root postexec = /absolute_ path/command</refname>
2360 </refnamediv>
2361 <refsynopsisdiv>
2362 <para>Sets a command to run as root after disconnecting from the share. See also <literal>preexec</literal>, <literal>postexec</literal>, and <literal>root</literal> <literal>preexec</literal> configuration options. Runs after the user's <literal>postexec</literal> command. Use with caution.</para>
2363
2364 </refsynopsisdiv>
2365 </refentry>
2366
2367 <refentry id="appc-refentry-171">
2368 <refmeta>
2369 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
2370 <refmiscinfo class="default">NULL</refmiscinfo>
2371 </refmeta>
2372 <refnamediv>
2373 <refname>root preexec = /absolute_ path/command</refname>
2374 </refnamediv>
2375 <refsynopsisdiv>
2376 <para>Sets a command to run as root before connecting to the share. See also <literal>preexec</literal>, <literal>postexec</literal>, and <literal>root</literal> <literal>postexec</literal> configuration options. Runs before the user's <literal>preexec</literal> command. Use with caution.</para>
2377
2378 </refsynopsisdiv>
2379 </refentry>
2380
2381 <refentry id="appc-refentry-172">
2382 <refmeta>
2383 <refmiscinfo class="allowable values">share, user, server, domain</refmiscinfo>
2384 <refmiscinfo class="default">share in Samba 1.0, user in 2.0</refmiscinfo>
2385 </refmeta>
2386 <refnamediv>
2387 <refname>[global] security = value</refname>
2388 </refnamediv>
2389 <refsynopsisdiv>
2390 <para>Sets password-security policy. If <literal>security</literal> <literal>=</literal> <literal>share</literal>, services have a shared password, available to everyone. If <literal>security</literal> <literal>=</literal> <literal>user</literal>, users have (Unix) accounts and passwords. If <literal>security</literal> <literal>=</literal> <literal>server</literal>, users have accounts and passwords and a separate machine authenticates them for Samba. If <literal>security</literal> <literal>=</literal> <literal>domain</literal>, full NT-domain authentication is done. See also the <literal>password server</literal> and <literal>encrypted passwords</literal> configuration options.</para>
2391
2392 </refsynopsisdiv>
2393 </refentry>
2394
2395 <refentry id="appc-refentry-173">
2396 <refmeta>
2397 <refmiscinfo class="allowable values">string</refmiscinfo>
2398 <refmiscinfo class="default">Samba <literal>%v</literal> in 2.0</refmiscinfo>
2399 </refmeta>
2400 <refnamediv>
2401 <refname>[global] server string = text</refname>
2402 </refnamediv>
2403 <refsynopsisdiv>
2404 <para>Sets the name that appears beside a server in browse lists. Honors the <literal>%v</literal> (Samba version number) and <literal>%h</literal> (hostname) variables.</para>
2405
2406 </refsynopsisdiv>
2407 </refentry>
2408
2409 <refentry id="appc-refentry-174">
2410 <refmeta>
2411 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2412 <refmiscinfo class="default">NO</refmiscinfo>
2413 </refmeta>
2414 <refnamediv>
2415 <refname>set directory = boolean</refname>
2416 </refnamediv>
2417 <refsynopsisdiv>
2418 <para>Allows DEC Pathworks client to use the <emphasis>set dir</emphasis> command.</para>
2419
2420 </refsynopsisdiv>
2421 </refentry>
2422
2423 <refentry id="appc-refentry-175">
2424 <refmeta>
2425 <refmiscinfo class="allowable values">number</refmiscinfo>
2426 <refmiscinfo class="default">113</refmiscinfo>
2427 </refmeta>
2428 <refnamediv>
2429 <refname>[global] shared file entries = number</refname>
2430 </refnamediv>
2431 <refsynopsisdiv>
2432 <para>Obsolete; do not use.</para>
2433
2434 </refsynopsisdiv>
2435 </refentry>
2436
2437 <refentry id="appc-refentry-176">
2438 <refmeta>
2439 <refmiscinfo class="allowable values">size in bytes</refmiscinfo>
2440 <refmiscinfo class="default">102400</refmiscinfo>
2441 </refmeta>
2442 <refnamediv>
2443 <refname>shared mem size = bytes</refname>
2444 </refnamediv>
2445 <refsynopsisdiv>
2446 <para>If compiled with FAST_SHARE_MODES (mmap), sets the shared memory size in bytes. Avoid changing.</para>
2447
2448 </refsynopsisdiv>
2449 </refentry>
2450
2451 <refentry id="appc-refentry-177">
2452 <refmeta>
2453 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
2454 <refmiscinfo class="default"><filename>/usr/local/samba/private/smbpasswd</filename></refmiscinfo>
2455 </refmeta>
2456 <refnamediv>
2457 <refname>[global] smb passwd file = path</refname>
2458 </refnamediv>
2459 <refsynopsisdiv>
2460 <para>Overrides compiled-in path to password file if <literal>encrypted passwords</literal> <literal>=</literal> <literal>yes</literal>.</para>
2461
2462 </refsynopsisdiv>
2463 </refentry>
2464
2465 <refentry id="appc-refentry-178">
2466 <refmeta>
2467 <refmiscinfo class="allowable values">smbrun command</refmiscinfo>
2468 <refmiscinfo class="default">compiled-in value</refmiscinfo>
2469 </refmeta>
2470 <refnamediv>
2471 <refname>[global] smbrun = /absolute_ path/command</refname>
2472 </refnamediv>
2473 <refsynopsisdiv>
2474 <para>Overrides compiled-in path to <filename>smbrun</filename> binary. Avoid changing.</para>
2475
2476 </refsynopsisdiv>
2477 </refentry>
2478
2479 <refentry id="appc-refentry-180">
2480 <refmeta>
2481 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2482 <refmiscinfo class="default">NO</refmiscinfo>
2483 </refmeta>
2484 <refnamediv>
2485 <refname>short preserve case = boolean</refname>
2486 </refnamediv>
2487 <refsynopsisdiv>
2488 <para>If set to YES, leaves mangled 8.3-style filenames in the case sent by client. If no, it forces the case to that specified by the <literal>default case</literal> option. See also <literal>preserve case</literal>.</para>
2489
2490 </refsynopsisdiv>
2491 </refentry>
2492
2493 <refentry id="appc-refentry-181">
2494 <refmeta>
2495 <refmiscinfo class="allowable values">IP address</refmiscinfo>
2496 <refmiscinfo class="default">NULL</refmiscinfo>
2497 </refmeta>
2498 <refnamediv>
2499 <refname>[global] socket address = IP address</refname>
2500 </refnamediv>
2501 <refsynopsisdiv>
2502 <para>Sets address on which to listen for connections. Default is to listen to all addresses. Used to support multiple virtual interfaces on one server. Highly discouraged.</para>
2503
2504 </refsynopsisdiv>
2505 </refentry>
2506
2507 <refentry id="appc-refentry-182">
2508 <refmeta>
2509 <refmiscinfo class="allowable values">list</refmiscinfo>
2510 <refmiscinfo class="default">NULL</refmiscinfo>
2511 </refmeta>
2512 <refnamediv>
2513 <refname>[global] socket options = socket option list</refname>
2514 </refnamediv>
2515 <refsynopsisdiv>
2516 <para>Sets OS-specific socket options. <literal>SO_KEEPALIVE</literal> has TCP check clients every 4 hours to see if they are still accessible. <literal>TCP_NODELAY</literal> sends even tiny packets to keep delay low. Recommended wherever the operating system supports them. See <link linkend="SAMBA-AP-B">Appendix B</link>, for more information.</para>
2517
2518 </refsynopsisdiv>
2519 </refentry>
2520
2521 <refentry id="appc-refentry-183">
2522 <refmeta>
2523 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2524 <refmiscinfo class="default">YES</refmiscinfo>
2525 </refmeta>
2526 <refnamediv>
2527 <refname>[global] status = boolean</refname>
2528 </refnamediv>
2529 <refsynopsisdiv>
2530 <para>If YES, logs connections to a file (or shared memory) accessible to <filename>smbstatus</filename>.</para>
2531
2532 </refsynopsisdiv>
2533 </refentry>
2534
2535 <refentry id="appc-refentry-184">
2536 <refmeta>
2537 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2538 <refmiscinfo class="default">NO</refmiscinfo>
2539 </refmeta>
2540 <refnamediv>
2541 <refname>strict sync = boolean</refname>
2542 </refnamediv>
2543 <refsynopsisdiv>
2544 <para>If set to YES, Samba will synchronize to disk whenever the client sets the sync bit in a packet. If set to NO, Samba flushes data to disk whenever buffers fill. Defaults to NO because Windows 98 Explorer sets the bit (incorrectly) in all packets. Introduced in Samba 1.9.18p10.</para>
2545
2546 </refsynopsisdiv>
2547 </refentry>
2548
2549 <refentry id="appc-refentry-185">
2550 <refmeta>
2551 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2552 <refmiscinfo class="default">NO</refmiscinfo>
2553 </refmeta>
2554 <refnamediv>
2555 <refname>strict locking = boolean</refname>
2556 </refnamediv>
2557 <refsynopsisdiv>
2558 <para>If set to YES, Samba checks locks on every access, not just on demand and at open time. Not recommended.</para>
2559
2560 </refsynopsisdiv>
2561 </refentry>
2562
2563 <refentry id="appc-refentry-186">
2564 <refmeta>
2565 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2566 <refmiscinfo class="default">NO</refmiscinfo>
2567 </refmeta>
2568 <refnamediv>
2569 <refname>[global] strip dot = boolean</refname>
2570 </refnamediv>
2571 <refsynopsisdiv>
2572 <para>Removes trailing dots from filenames. Use <literal>mangled map</literal> instead.</para>
2573
2574 </refsynopsisdiv>
2575 </refentry>
2576
2577 <refentry id="appc-refentry-187">
2578 <refmeta>
2579 <refmiscinfo class="allowable values">number</refmiscinfo>
2580 <refmiscinfo class="default">1</refmiscinfo>
2581 </refmeta>
2582 <refnamediv>
2583 <refname>[global] syslog = number</refname>
2584 </refnamediv>
2585 <refsynopsisdiv>
2586 <para>Sets number of Samba log messages to send to <filename>syslog</filename>. Higher is more verbose. The <filename>syslog.conf</filename> file must have suitable logging enabled.</para>
2587
2588 </refsynopsisdiv>
2589 </refentry>
2590
2591 <refentry id="appc-refentry-188">
2592 <refmeta>
2593 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2594 <refmiscinfo class="default">NO</refmiscinfo>
2595 </refmeta>
2596 <refnamediv>
2597 <refname>[global] syslog only = boolean</refname>
2598 </refnamediv>
2599 <refsynopsisdiv>
2600 <para>If set to YES, log only to <emphasis>syslog,</emphasis> not standard Samba log files.</para>
2601
2602 </refsynopsisdiv>
2603 </refentry>
2604
2605 <refentry id="appc-refentry-189">
2606 <refmeta>
2607 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2608 <refmiscinfo class="default">NO</refmiscinfo>
2609 </refmeta>
2610 <refnamediv>
2611 <refname>sync always = boolean</refname>
2612 </refnamediv>
2613 <refsynopsisdiv>
2614 <para>If set to YES, Samba calls <emphasis>fsync</emphasis>(3) after every write. Avoid except for debugging crashing servers.</para>
2615
2616 </refsynopsisdiv>
2617 </refentry>
2618
2619 <refentry id="appc-refentry-190">
2620 <refmeta>
2621 <refmiscinfo class="allowable values">minutes</refmiscinfo>
2622 <refmiscinfo class="default">0</refmiscinfo>
2623 </refmeta>
2624 <refnamediv>
2625 <refname>[global] time offset = minutes</refname>
2626 </refnamediv>
2627 <refsynopsisdiv>
2628 <para>Sets number of minutes to add to system time zone calculation. Provided to fix a client daylight-savings bug; not recommended.</para>
2629
2630 </refsynopsisdiv>
2631 </refentry>
2632
2633 <refentry id="appc-refentry-191">
2634 <refmeta>
2635 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2636 <refmiscinfo class="default">NO</refmiscinfo>
2637 </refmeta>
2638 <refnamediv>
2639 <refname>[global] time server = boolean</refname>
2640 </refnamediv>
2641 <refsynopsisdiv>
2642 <para>If YES, <emphasis>nmbd</emphasis> will provide time service to its clients.</para>
2643
2644 </refsynopsisdiv>
2645 </refentry>
2646
2647 <refentry id="appc-refentry-192">
2648 <refmeta>
2649 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2650 <refmiscinfo class="default">NO</refmiscinfo>
2651 </refmeta>
2652 <refnamediv>
2653 <refname>unix password sync = boolean</refname>
2654 </refnamediv>
2655 <refsynopsisdiv>
2656 <para>If set, will attempt to change the user's Unix password whenever the user changes his or her SMB password. Used to ease synchronization of Unix and Microsoft password databases. Added in Samba 1.9.18p4. See also <literal>passwd chat</literal>.</para>
2657
2658 </refsynopsisdiv>
2659 </refentry>
2660
2661 <refentry id="appc-refentry-193">
2662 <refmeta>
2663 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2664 <refmiscinfo class="default">NO</refmiscinfo>
2665 </refmeta>
2666 <refnamediv>
2667 <refname>unix realname = boolean</refname>
2668 </refnamediv>
2669 <refsynopsisdiv>
2670 <para>If set, will provide the GCOS field of <filename>/etc/passwd</filename> to the client as the user's full name.</para>
2671
2672 </refsynopsisdiv>
2673 </refentry>
2674
2675 <refentry id="appc-refentry-195">
2676 <refmeta>
2677 <refmiscinfo class="allowable values">comma-separated list of user names</refmiscinfo>
2678 <refmiscinfo class="default">NULL</refmiscinfo>
2679 </refmeta>
2680 <refnamediv>
2681 <refname>user = comma-separated list</refname>
2682 </refnamediv>
2683 <refsynopsisdiv>
2684 <para>Synonym for <literal>username</literal>.</para>
2685
2686 </refsynopsisdiv>
2687 </refentry>
2688
2689 <refentry id="appc-refentry-196">
2690 <refmeta>
2691 <refmiscinfo class="allowable values">comma-separated list of user names</refmiscinfo>
2692 <refmiscinfo class="default">NULL</refmiscinfo>
2693 </refmeta>
2694 <refnamediv>
2695 <refname>username = comma-separated list</refname>
2696 </refnamediv>
2697 <refsynopsisdiv>
2698 <para>Sets a list of users to try to log in as for a share or shares with share-level security. Synonyms are <literal>user</literal> and <literal>users</literal>. Discouraged. Use <literal>NET USE \\</literal><replaceable>server</replaceable><literal>\</literal><replaceable>share </replaceable><literal>%</literal><replaceable>user</replaceable> from the client instead.</para>
2699
2700 </refsynopsisdiv>
2701 </refentry>
2702
2703 <refentry id="appc-refentry-197">
2704 <refmeta>
2705 <refmiscinfo class="allowable values">number</refmiscinfo>
2706 <refmiscinfo class="default">0</refmiscinfo>
2707 </refmeta>
2708 <refnamediv>
2709 <refname>username level = number</refname>
2710 </refnamediv>
2711 <refsynopsisdiv>
2712 <para>Number of uppercase letter permutations allowed to match Unix usernames. Workaround for Windows feature (single-case usernames). Use is discouraged.</para>
2713
2714 </refsynopsisdiv>
2715 </refentry>
2716
2717 <refentry id="appc-refentry-198">
2718 <refmeta>
2719 <refmiscinfo class="allowable values">pathname</refmiscinfo>
2720 <refmiscinfo class="default">NULL</refmiscinfo>
2721 </refmeta>
2722 <refnamediv>
2723 <refname>[global] username map = pathname</refname>
2724 </refnamediv>
2725 <refsynopsisdiv>
2726 <para>Names a file of Unix-to-Windows name pairs; used to map different spellings of account names and those Windows usernames longer than eight characters.</para>
2727
2728 </refsynopsisdiv>
2729 </refentry>
2730
2731 <refentry id="appc-refentry-199">
2732 <refmeta>
2733 <refmiscinfo class="allowable values">list of numeric values</refmiscinfo>
2734 <refmiscinfo class="default">NULL</refmiscinfo>
2735 </refmeta>
2736 <refnamediv>
2737 <refname>valid chars = list</refname>
2738 </refnamediv>
2739 <refsynopsisdiv>
2740 <para>Semi-obsolete. Adds national characters to a character set map. Overridden by <literal>client code page</literal>.</para>
2741
2742 </refsynopsisdiv>
2743 </refentry>
2744
2745 <refentry id="appc-refentry-200">
2746 <refmeta>
2747 <refmiscinfo class="allowable values">list of users</refmiscinfo>
2748 <refmiscinfo class="default">NULL (everyone)</refmiscinfo>
2749 </refmeta>
2750 <refnamediv>
2751 <refname>valid users = user list</refname>
2752 </refnamediv>
2753 <refsynopsisdiv>
2754 <para>List of users that can log in to a share.</para>
2755
2756 </refsynopsisdiv>
2757 </refentry>
2758
2759 <refentry id="appc-refentry-201">
2760 <refmeta>
2761 <refmiscinfo class="allowable values">slash-separated list of filenames</refmiscinfo>
2762 <refmiscinfo class="default">NULL</refmiscinfo>
2763 </refmeta>
2764 <refnamediv>
2765 <refname>veto files = slash-list</refname>
2766 </refnamediv>
2767 <refsynopsisdiv>
2768 <para>List of files not to allow the client to see when listing a directory's contents. See also <literal>delete veto files</literal>.</para>
2769
2770 </refsynopsisdiv>
2771 </refentry>
2772
2773 <refentry id="appc-refentry-202">
2774 <refmeta>
2775 <refmiscinfo class="allowable values">slash-separated list of filenames</refmiscinfo>
2776 <refmiscinfo class="default">NULL</refmiscinfo>
2777 </refmeta>
2778 <refnamediv>
2779 <refname>veto oplock files = slash-list</refname>
2780 </refnamediv>
2781 <refsynopsisdiv>
2782 <para>List of files not to oplock (and cache on clients). See also <literal>oplocks</literal> and <literal>fake oplocks</literal>.</para>
2783
2784 </refsynopsisdiv>
2785 </refentry>
2786
2787 <refentry id="appc-refentry-203">
2788 <refmeta>
2789 <refmiscinfo class="allowable values">string</refmiscinfo>
2790 <refmiscinfo class="default">NULL</refmiscinfo>
2791 </refmeta>
2792 <refnamediv>
2793 <refname>volume = share name</refname>
2794 </refnamediv>
2795 <refsynopsisdiv>
2796 <para>Sets the volume label of a disk share, notably a CD-ROM.</para>
2797
2798 </refsynopsisdiv>
2799 </refentry>
2800
2801 <refentry id="appc-refentry-204">
2802 <refmeta>
2803 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2804 <refmiscinfo class="default">YES</refmiscinfo>
2805 </refmeta>
2806 <refnamediv>
2807 <refname>wide links = boolean</refname>
2808 </refnamediv>
2809 <refsynopsisdiv>
2810 <para>If set to YES, Samba will follow symlinks out of the current disk share(s). See also the <literal>root dir</literal> and <literal>follow symlinks</literal> options.</para>
2811
2812 </refsynopsisdiv>
2813 </refentry>
2814
2815 <refentry id="appc-refentry-205">
2816 <refmeta>
2817 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2818 <refmiscinfo class="default">NO</refmiscinfo>
2819 </refmeta>
2820 <refnamediv>
2821 <refname>[global] wins proxy = boolean</refname>
2822 </refnamediv>
2823 <refsynopsisdiv>
2824 <para>If set to YES, <emphasis>nmbd</emphasis> will proxy resolution requests to WINS servers on behalf of old clients, which use broadcasts. WINS server is typically on another subnet.</para>
2825
2826 </refsynopsisdiv>
2827 </refentry>
2828
2829 <refentry id="appc-refentry-206">
2830 <refmeta>
2831 <refmiscinfo class="allowable values">hostname</refmiscinfo>
2832 <refmiscinfo class="default">NULL</refmiscinfo>
2833 </refmeta>
2834 <refnamediv>
2835 <refname>[global] wins server = host</refname>
2836 </refnamediv>
2837 <refsynopsisdiv>
2838 <para>Sets the DNS name or IP address of the WINS server.</para>
2839
2840 </refsynopsisdiv>
2841 </refentry>
2842
2843 <refentry id="appc-refentry-207">
2844 <refmeta>
2845 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2846 <refmiscinfo class="default">NO</refmiscinfo>
2847 </refmeta>
2848 <refnamediv>
2849 <refname>[global] wins support = boolean</refname>
2850 </refnamediv>
2851 <refsynopsisdiv>
2852 <para>If set to YES, Samba activates WINS service. The <literal>wins server</literal> option must not be set if <literal>wins support = yes</literal>.</para>
2853
2854 </refsynopsisdiv>
2855 </refentry>
2856
2857 <refentry id="appc-refentry-208">
2858 <refmeta>
2859 <refmiscinfo class="allowable values">workgroup name</refmiscinfo>
2860 <refmiscinfo class="default">compiled-in</refmiscinfo>
2861 </refmeta>
2862 <refnamediv>
2863 <refname>[global] workgroup = name</refname>
2864 </refnamediv>
2865 <refsynopsisdiv>
2866 <para>Sets the workgroup to which things will be served. Overrides compiled-in value. Choosing a name other than <literal>WORKGROUP</literal> is strongly recommended.</para>
2867
2868 </refsynopsisdiv>
2869 </refentry>
2870
2871 <refentry id="appc-refentry-209">
2872 <refmeta>
2873 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2874 <refmiscinfo class="default">YES</refmiscinfo>
2875 </refmeta>
2876 <refnamediv>
2877 <refname>writable = boolean</refname>
2878 </refnamediv>
2879 <refsynopsisdiv>
2880 <para>Antonym for <literal>read only</literal>; synonym of <literal>write ok</literal>.</para>
2881
2882 </refsynopsisdiv>
2883 </refentry>
2884
2885 <refentry id="appc-refentry-210">
2886 <refmeta>
2887 <refmiscinfo class="allowable values">comma-separated list of users</refmiscinfo>
2888 <refmiscinfo class="default">NULL (everyone)</refmiscinfo>
2889 </refmeta>
2890 <refnamediv>
2891 <refname>write list = comma-separated list</refname>
2892 </refnamediv>
2893 <refsynopsisdiv>
2894 <para>List of users that are given read-write access to a read-only share. See also <literal>read list</literal>.</para>
2895
2896 </refsynopsisdiv>
2897 </refentry>
2898
2899 <refentry id="appc-refentry-211">
2900 <refmeta>
2901 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2902 <refmiscinfo class="default">YES</refmiscinfo>
2903 </refmeta>
2904 <refnamediv>
2905 <refname>write ok = boolean</refname>
2906 </refnamediv>
2907 <refsynopsisdiv>
2908 <para>Synonym of the <literal>writable</literal> configuration option.</para>
2909
2910 </refsynopsisdiv>
2911 </refentry>
2912
2913 <refentry id="appc-refentry-212">
2914 <refmeta>
2915 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2916 <refmiscinfo class="default">YES</refmiscinfo>
2917 </refmeta>
2918 <refnamediv>
2919 <refname>[global] write raw = boolean</refname>
2920 </refnamediv>
2921 <refsynopsisdiv>
2922 <para>Allows fast streaming writes over TCP, using 64KB buffers. Recommended.</para>
2923
2924 </refsynopsisdiv>
2925 </refentry>
2926 </sect1>
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936 <sect1 role="" label="C.2" id="appc-SECT-2">
2937 <title>Glossary of Configuration Values</title>
2938
2939
2940 <variablelist>
2941 <varlistentry><term>
2942 <indexterm id="appc-idx-990655-0"><primary>glossary</primary></indexterm>Address list</term>
2943 <listitem><para>A space-separated list of IP addresses in ###.###.###.### format.</para></listitem>
2944 </varlistentry>
2945
2946
2947 <varlistentry><term>Comma-separated list</term>
2948 <listitem><para>A list of items separated by commas.</para></listitem>
2949 </varlistentry>
2950
2951
2952 <varlistentry><term>Command</term>
2953 <listitem><para>A Unix command, with full path and parameters.</para></listitem>
2954 </varlistentry>
2955
2956
2957 <varlistentry><term>Host list</term>
2958 <listitem><para>A space-separated list of hosts. Allows IP addresses, address masks, domain names, ALL, and EXCEPT</para></listitem>
2959 </varlistentry>
2960
2961
2962 <varlistentry><term>Interface list</term>
2963 <listitem><para>A space-separated list of interfaces, in either address/netmask or address/n-bits format. For example, 192.168.2.10/24 or 192.168.2.10/255.255.255.0</para></listitem>
2964 </varlistentry>
2965
2966
2967 <varlistentry><term>Map list</term>
2968 <listitem><para>A space-separated list of file-remapping strings such as <literal>(*.html</literal> <literal>*.htm)</literal>.</para></listitem>
2969 </varlistentry>
2970
2971
2972 <varlistentry><term>Remote list</term>
2973 <listitem><para>A space-separated list of subnet-broadcast-address/workgroup pairs. For example, 192.168.2.255/SERVERS 192.168.4.255/STAFF.</para></listitem>
2974 </varlistentry>
2975
2976
2977 <varlistentry><term>Service (share) list</term>
2978 <listitem><para>A space-separated list of share names, without the enclosing square brackets.</para></listitem>
2979 </varlistentry>
2980
2981
2982 <varlistentry><term>Slash-list</term>
2983 <listitem><para>A list of filenames, separated by "/" characters to allow embedded spaces. For example, <literal>/.*/fred</literal> <literal>flintstone/*.frk/</literal>.</para></listitem>
2984 </varlistentry>
2985
2986
2987 <varlistentry><term>Text</term>
2988 <listitem><para>One line of text.</para></listitem>
2989 </varlistentry>
2990
2991
2992 <varlistentry><term>User list</term>
2993 <listitem><para>A space-separated list of usernames. In Samba 1.9, <literal>@group-name</literal> will include everyone in Unix group <literal>group-name</literal>. In Samba 2.0, <literal>@group-name</literal> includes whomever is in the NIS netgroup <literal>group_name</literal> if one exists, otherwise whomever is in the Unix group <literal>group_name</literal>. In addition, +<literal>group_name</literal> is a Unix group, &amp;<literal>group_name</literal> is an NIS netgroup, and &amp;+ and +&amp; cause an ordered search of both Unix and NIS groups.</para></listitem>
2994 </varlistentry>
2995 </variablelist>
2996 </sect1>
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006 <sect1 role="" label="C.3" id="appc-SECT-3">
3007 <title>Configuration File Variables</title>
3008
3009
3010 <para><link linkend="appc-88529">Table 3.1</link> lists of Samba configuration file variables.</para>
3011
3012
3013 <table label="C.1" id="appc-88529">
3014 <title>Variables in Alphabetic Order </title>
3015
3016 <tgroup cols="2">
3017 <colspec colnum="1" colname="col1"/>
3018 <colspec colnum="2" colname="col2"/>
3019 <thead>
3020 <row>
3021
3022 <entry colname="col1"><para>Name</para></entry>
3023
3024 <entry colname="col2"><para>Meaning</para></entry>
3025
3026 </row>
3027
3028 </thead>
3029
3030 <tbody>
3031 <row>
3032
3033 <entry colname="col1"><para><literal>%a</literal></para></entry>
3034
3035 <entry colname="col2"><para>Client's architecture (one of Samba, WfWg, WinNT, Win95, or UNKNOWN)</para></entry>
3036
3037 </row>
3038
3039 <row>
3040
3041 <entry colname="col1"><para><literal>%d</literal></para></entry>
3042
3043 <entry colname="col2"><para>Current server process's processID</para></entry>
3044
3045 </row>
3046
3047 <row>
3048
3049 <entry colname="col1"><para><literal>%f</literal></para></entry>
3050
3051 <entry colname="col2"><para>Print-spool file as a relative path (printing only)</para></entry>
3052
3053 </row>
3054
3055 <row>
3056
3057 <entry colname="col1"><para><literal>%f</literal></para></entry>
3058
3059 <entry colname="col2"><para>User from which a message was sent (messages only)</para></entry>
3060
3061 </row>
3062
3063 <row>
3064
3065 <entry colname="col1"><para><literal>%G</literal></para></entry>
3066
3067 <entry colname="col2"><para>Primary group name of <literal>%U</literal> (requested username)</para></entry>
3068
3069 </row>
3070
3071 <row>
3072
3073 <entry colname="col1"><para><literal>%g</literal></para></entry>
3074
3075 <entry colname="col2"><para>Primary group name of <literal>%u</literal> (actual username)</para></entry>
3076
3077 </row>
3078
3079 <row>
3080
3081 <entry colname="col1"><para><literal>%H</literal></para></entry>
3082
3083 <entry colname="col2"><para>Home directory of <literal>%u</literal> (actual username)</para></entry>
3084
3085 </row>
3086
3087 <row>
3088
3089 <entry colname="col1"><para><literal>%h</literal></para></entry>
3090
3091 <entry colname="col2"><para>Samba server's (Internet) hostname</para></entry>
3092
3093 </row>
3094
3095 <row>
3096
3097 <entry colname="col1"><para><literal>%I</literal></para></entry>
3098
3099 <entry colname="col2"><para>Client's IP address</para></entry>
3100
3101 </row>
3102
3103 <row>
3104
3105 <entry colname="col1"><para><literal>%j</literal></para></entry>
3106
3107 <entry colname="col2"><para>Print job number (printing only)</para></entry>
3108
3109 </row>
3110
3111 <row>
3112
3113 <entry colname="col1"><para><literal>%L</literal></para></entry>
3114
3115 <entry colname="col2"><para>Samba server's NetBIOS name (virtual servers have multiple names)</para></entry>
3116
3117 </row>
3118
3119 <row>
3120
3121 <entry colname="col1"><para><literal>%M</literal></para></entry>
3122
3123 <entry colname="col2"><para>Client's (Internet) hostname</para></entry>
3124
3125 </row>
3126
3127 <row>
3128
3129 <entry colname="col1"><para><literal>%m</literal></para></entry>
3130
3131 <entry colname="col2"><para>Client's NetBIOS name</para></entry>
3132
3133 </row>
3134
3135 <row>
3136
3137 <entry colname="col1"><para><literal>%n</literal></para></entry>
3138
3139 <entry colname="col2"><para>New password (password change only)</para></entry>
3140
3141 </row>
3142
3143 <row>
3144
3145 <entry colname="col1"><para><literal>%N</literal></para></entry>
3146
3147 <entry colname="col2"><para>Name of the NIS home directory server (without NIS, same as <literal>%L</literal>)</para></entry>
3148
3149 </row>
3150
3151 <row>
3152
3153 <entry colname="col1"><para><literal>%o</literal></para></entry>
3154
3155 <entry colname="col2"><para>Old password (password change only)</para></entry>
3156
3157 </row>
3158
3159 <row>
3160
3161 <entry colname="col1"><para><literal>%P</literal></para></entry>
3162
3163 <entry colname="col2"><para>Current share's root directory (actual)</para></entry>
3164
3165 </row>
3166
3167 <row>
3168
3169 <entry colname="col1"><para><literal>%p</literal></para></entry>
3170
3171 <entry colname="col2"><para>Current share's root directory (in an NIS homedir map)</para></entry>
3172
3173 </row>
3174
3175 <row>
3176
3177 <entry colname="col1"><para><literal>%p</literal></para></entry>
3178
3179 <entry colname="col2"><para>Print filename (printing only)</para></entry>
3180
3181 </row>
3182
3183 <row>
3184
3185 <entry colname="col1"><para><literal>%R</literal></para></entry>
3186
3187 <entry colname="col2"><para>Protocol level in use (one of CORE, COREPLUS, LANMAN1, LANMAN2, or NT1)</para></entry>
3188
3189 </row>
3190
3191 <row>
3192
3193 <entry colname="col1"><para><literal>%S</literal></para></entry>
3194
3195 <entry colname="col2"><para>Current share's name</para></entry>
3196
3197 </row>
3198
3199 <row>
3200
3201 <entry colname="col1"><para><literal>%s</literal></para></entry>
3202
3203 <entry colname="col2"><para>Filename the message is in (messages only)</para></entry>
3204
3205 </row>
3206
3207 <row>
3208
3209 <entry colname="col1"><para><literal>%s</literal></para></entry>
3210
3211 <entry colname="col2"><para>Print-spool file name (printing only)</para></entry>
3212
3213 </row>
3214
3215 <row>
3216
3217 <entry colname="col1"><para><literal>%T</literal></para></entry>
3218
3219 <entry colname="col2"><para>Current date and time</para></entry>
3220
3221 </row>
3222
3223 <row>
3224
3225 <entry colname="col1"><para><literal>%t</literal></para></entry>
3226
3227 <entry colname="col2"><para>Destination machine (messages only)</para></entry>
3228
3229 </row>
3230
3231 <row>
3232
3233 <entry colname="col1"><para><literal>%u</literal></para></entry>
3234
3235 <entry colname="col2"><para>Current share's username</para></entry>
3236
3237 </row>
3238
3239 <row>
3240
3241 <entry colname="col1"><para><literal>%U</literal></para></entry>
3242
3243 <entry colname="col2"><para>Requested username for current share</para></entry>
3244
3245 </row>
3246
3247 <row>
3248
3249 <entry colname="col1"><para><literal>%v</literal></para></entry>
3250
3251 <entry colname="col2"><para>Samba version</para></entry>
3252
3253 </row>
3254
3255 </tbody>
3256 </tgroup>
3257 </table>
3258 </sect1>
3259
3260
3261
3262
3263
3264
3265
3266
3267 </appendix>