1 <appendix label="C" id="SAMBA-AP-C">
2 <title>Samba Configuration Option Quick Reference</title>
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
23 <sect1 role="" label="C.1" id="appc-SECT-1">
24 <title>Configuration Options</title>
27 <refentry id="appc-refentry-1">
29 <refmiscinfo class="allowable values">user list</refmiscinfo>
30 <refmiscinfo class="default">NULL</refmiscinfo>
33 <refname>admin users = user list</refname>
36 <para>List of users who will be granted root permissions on the share by Samba.</para>
41 <refentry id="appc-refentry-2">
43 <refmiscinfo class="allowable values">any</refmiscinfo>
44 <refmiscinfo class="default">NULL</refmiscinfo>
47 <refname>allow hosts = host list</refname>
50 <para>Synonym for <literal>hosts allow</literal>. List of machines that may connect to a share.</para>
55 <refentry id="appc-refentry-3">
57 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
58 <refmiscinfo class="default">NO</refmiscinfo>
61 <refname>alternate permissions = boolean</refname>
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>
69 <refentry id="appc-refentry-6">
71 <refmiscinfo class="allowable values">any shares</refmiscinfo>
72 <refmiscinfo class="default">NULL</refmiscinfo>
75 <refname>[global] auto services = share list</refname>
78 <para>List of shares that will always appear in browse lists. A synonym is <literal>preload</literal>.</para>
83 <refentry id="appc-refentry-7">
85 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
86 <refmiscinfo class="default">YES</refmiscinfo>
89 <refname>available = boolean</refname>
92 <para>If set to NO, denies access to a share. Doesn't affect browsing.</para>
97 <refentry id="appc-refentry-8">
99 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
100 <refmiscinfo class="default">NO</refmiscinfo>
103 <refname>[global] bind interfaces only = boolean</refname>
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>
111 <refentry id="appc-refentry-9">
113 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
114 <refmiscinfo class="default">YES</refmiscinfo>
117 <refname>browsable = boolean</refname>
120 <para>Allows a share to be announced in browse lists.</para>
125 <refentry id="appc-refentry-10">
127 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
128 <refmiscinfo class="default">YES</refmiscinfo>
131 <refname>blocking locks = boolean</refname>
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>
139 <refentry id="appc-refentry-11">
141 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
142 <refmiscinfo class="default">YES</refmiscinfo>
145 <refname>[global] browse list = boolean</refname>
148 <para>Turns on/off <literal>browse</literal> <literal>list</literal> from this server. Avoid changing.</para>
153 <refentry id="appc-refentry-12">
155 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
156 <refmiscinfo class="default">NO</refmiscinfo>
159 <refname>[global] case sensitive = boolean</refname>
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>
167 <refentry id="appc-refentry-13">
169 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
170 <refmiscinfo class="default">NO</refmiscinfo>
173 <refname>[global] case sig names = boolean</refname>
176 <para>Synonym for <literal>case sensitive</literal>.</para>
181 <refentry id="appc-refentry-14">
183 <refmiscinfo class="allowable values">positive number</refmiscinfo>
184 <refmiscinfo class="default">60</refmiscinfo>
187 <refname>[global] change notify timeout = number</refname>
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>
195 <refentry id="appc-refentry-15">
197 <refmiscinfo class="allowable values">ISO8859-1, ISO8859-2, ISO8859-5, KOI8-R</refmiscinfo>
198 <refmiscinfo class="default">NULL</refmiscinfo>
201 <refname>character set = name</refname>
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>
209 <refentry id="appc-refentry-16">
211 <refmiscinfo class="allowable values">See <link linkend="ch08-20815">Table 8.4</link></refmiscinfo>
212 <refmiscinfo class="default">437 (US MS-DOS)</refmiscinfo>
215 <refname>client code page = name</refname>
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>
223 <refentry id="appc-refentry-17">
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>
229 <refname>coding system = code</refname>
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>
237 <refentry id="appc-refentry-18">
239 <refmiscinfo class="allowable values">a text string or NULL</refmiscinfo>
240 <refmiscinfo class="default">NULL</refmiscinfo>
243 <refname>comment = text</refname>
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>
251 <refentry id="appc-refentry-19">
253 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
254 <refmiscinfo class="default">NULL</refmiscinfo>
257 <refname>[global] config file = pathname</refname>
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>
265 <refentry id="appc-refentry-20">
267 <refmiscinfo class="allowable values">existing section's name</refmiscinfo>
268 <refmiscinfo class="default">NULL</refmiscinfo>
271 <refname>copy = section name</refname>
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>
279 <refentry id="appc-refentry-21">
281 <refmiscinfo class="allowable values">octal permission bits, 0-0777</refmiscinfo>
282 <refmiscinfo class="default">0744</refmiscinfo>
285 <refname>create mask = octal value</refname>
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>
293 <refentry id="appc-refentry-22">
295 <refmiscinfo class="allowable values">octal permission bits, 0-0777</refmiscinfo>
296 <refmiscinfo class="default">0744</refmiscinfo>
299 <refname>create mode = octal permission bits</refname>
302 <para>Synonym for <literal>create mask</literal>.</para>
307 <refentry id="appc-refentry-23">
309 <refmiscinfo class="allowable values">minutes</refmiscinfo>
310 <refmiscinfo class="default">0 </refmiscinfo>
313 <refname>[global] deadtime = minutes</refname>
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>
321 <refentry id="appc-refentry-24">
323 <refmiscinfo class="allowable values">number</refmiscinfo>
324 <refmiscinfo class="default">0</refmiscinfo>
327 <refname>[global] debug level = number</refname>
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>
335 <refentry id="appc-refentry-25">
337 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
338 <refmiscinfo class="default">YES</refmiscinfo>
341 <refname>[global] debug timestamp = boolean</refname>
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>
349 <refentry id="appc-refentry-26">
351 <refmiscinfo class="allowable values">share name</refmiscinfo>
352 <refmiscinfo class="default">NULL</refmiscinfo>
355 <refname>[global] default = name</refname>
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>
363 <refentry id="appc-refentry-27">
365 <refmiscinfo class="allowable values">LOWER, UPPER</refmiscinfo>
366 <refmiscinfo class="default">LOWER</refmiscinfo>
369 <refname>default case = case</refname>
372 <para>Sets the case in which to store new filenames. LOWER indicates mixed case, UPPER indicates uppercase letters.</para>
377 <refentry id="appc-refentry-28">
379 <refmiscinfo class="allowable values">share name</refmiscinfo>
380 <refmiscinfo class="default">NULL</refmiscinfo>
383 <refname>[global] default service = share name</refname>
386 <para>Synonym for <literal>default</literal>.</para>
391 <refentry id="appc-refentry-29">
393 <refmiscinfo class="allowable values">NO, YES</refmiscinfo>
394 <refmiscinfo class="default">NO</refmiscinfo>
397 <refname>delete readonly = boolean</refname>
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>
405 <refentry id="appc-refentry-30">
407 <refmiscinfo class="allowable values">NO, YES</refmiscinfo>
408 <refmiscinfo class="default">NO</refmiscinfo>
411 <refname>delete veto files = boolean</refname>
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>
419 <refentry id="appc-refentry-31">
421 <refmiscinfo class="allowable values">host list</refmiscinfo>
422 <refmiscinfo class="default">NULL</refmiscinfo>
425 <refname>deny hosts = host list</refname>
428 <para>A synonym is <literal>hosts deny</literal>. Specifies a list of machines from which to refuse connections or shares.</para>
433 <refentry id="appc-refentry-32">
435 <refmiscinfo class="allowable values">shell command</refmiscinfo>
436 <refmiscinfo class="default">varies</refmiscinfo>
439 <refname>[global] dfree command = command</refname>
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>
447 <refentry id="appc-refentry-33">
449 <refmiscinfo class="allowable values">pathname</refmiscinfo>
450 <refmiscinfo class="default">NULL</refmiscinfo>
453 <refname>directory = pathname</refname>
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>
461 <refentry id="appc-refentry-34">
463 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
464 <refmiscinfo class="default">0755</refmiscinfo>
467 <refname>directory mask = octal permission bits</refname>
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>
475 <refentry id="appc-refentry-35">
477 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
478 <refmiscinfo class="default">0755</refmiscinfo>
481 <refname>directory mode = octal permission bits</refname>
484 <para>Synonym for <literal>directory mask</literal>.</para>
489 <refentry id="appc-refentry-36">
491 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
492 <refmiscinfo class="default">YES</refmiscinfo>
495 <refname>[global] dns proxy = boolean</refname>
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>
503 <refentry id="appc-refentry-37">
505 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
506 <refmiscinfo class="default">NO</refmiscinfo>
509 <refname>[global] domain logons = boolean</refname>
512 <para>Allow Windows 95/98 or NT clients to log on to an NT-like domain.</para>
517 <refentry id="appc-refentry-38">
519 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
520 <refmiscinfo class="default">NO</refmiscinfo>
523 <refname>[global] domain master = boolean</refname>
526 <para>Become a domain master browser list collector if possible for the entire workgroup/domain.</para>
531 <refentry id="appc-refentry-39">
533 <refmiscinfo class="allowable values">comma-separated list of paths</refmiscinfo>
534 <refmiscinfo class="default">NULL</refmiscinfo>
537 <refname>dont descend = comma-list</refname>
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>
545 <refentry id="appc-refentry-40">
547 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
548 <refmiscinfo class="default">NO</refmiscinfo>
551 <refname>dos filetimes = boolean</refname>
554 <para>Allow non-owners to change file times if they can write to the file. See also <literal>dos filetime resolution</literal>.</para>
559 <refentry id="appc-refentry-41">
561 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
562 <refmiscinfo class="default">NO</refmiscinfo>
565 <refname>dos filetime resolution = boolean</refname>
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>
573 <refentry id="appc-refentry-42">
575 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
576 <refmiscinfo class="default">NO</refmiscinfo>
579 <refname>[global] encrypt passwords = boolean</refname>
582 <para>Uses Windows NT-style password encryption. Requires an <filename>smbpasswd</filename> on the Samba server.</para>
587 <refentry id="appc-refentry-43">
589 <refmiscinfo class="allowable values">shell command</refmiscinfo>
590 <refmiscinfo class="default">NULL</refmiscinfo>
593 <refname>exec = command</refname>
596 <para>Synonym of <literal>preexec</literal>, a command to run as the user just before connecting to the share.</para>
601 <refentry id="appc-refentry-44">
603 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
604 <refmiscinfo class="default">NO</refmiscinfo>
607 <refname>fake directory create times = boolean</refname>
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>
615 <refentry id="appc-refentry-45">
617 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
618 <refmiscinfo class="default">NO</refmiscinfo>
621 <refname>fake oplocks = boolean</refname>
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>
629 <refentry id="appc-refentry-46">
631 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
632 <refmiscinfo class="default">YES</refmiscinfo>
635 <refname>follow symlinks = boolean</refname>
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>
643 <refentry id="appc-refentry-47">
645 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
646 <refmiscinfo class="default">0</refmiscinfo>
649 <refname>force create mask = octal permission bits</refname>
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>
657 <refentry id="appc-refentry-48">
659 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
660 <refmiscinfo class="default">0</refmiscinfo>
663 <refname>force create mode = octal permission bits</refname>
666 <para>Synonym for <literal>force create mask</literal>.</para>
671 <refentry id="appc-refentry-49">
673 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
674 <refmiscinfo class="default">0</refmiscinfo>
677 <refname>force directory mask = octal permission bits</refname>
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>
685 <refentry id="appc-refentry-50">
687 <refmiscinfo class="allowable values">octal value from 0 to 0777</refmiscinfo>
688 <refmiscinfo class="default">0</refmiscinfo>
691 <refname>force directory mode = octal permission bits</refname>
694 <para>Synonym for <literal>force</literal> <literal>directory</literal> <literal>mask</literal>.</para>
699 <refentry id="appc-refentry-51">
701 <refmiscinfo class="allowable values">group</refmiscinfo>
702 <refmiscinfo class="default">NULL</refmiscinfo>
705 <refname>force group = unix group</refname>
708 <para>Sets the effective group name assigned to all users accessing a share. Used to override user's normal groups.</para>
713 <refentry id="appc-refentry-52">
715 <refmiscinfo class="allowable values">username</refmiscinfo>
716 <refmiscinfo class="default">NULL</refmiscinfo>
719 <refname>force user = name</refname>
722 <para>Sets the effective username assigned to all users accessing a share. Discouraged.</para>
727 <refentry id="appc-refentry-53">
729 <refmiscinfo class="allowable values">NTFS, FAT, Samba</refmiscinfo>
730 <refmiscinfo class="default">NTFS</refmiscinfo>
733 <refname>fstype = string</refname>
736 <para>Sets the filesystem type reported to the client.</para>
741 <refentry id="appc-refentry-54">
743 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
744 <refmiscinfo class="default">NO</refmiscinfo>
747 <refname>[global] getwd cache = boolean</refname>
750 <para>Cache current directory for performance. Recommended with the <literal>wide links</literal> option.</para>
755 <refentry id="appc-refentry-55">
757 <refmiscinfo class="allowable values">unix group</refmiscinfo>
758 <refmiscinfo class="default">NULL</refmiscinfo>
761 <refname>group = group</refname>
764 <para>An obsolete form of <literal>force group</literal>.</para>
769 <refentry id="appc-refentry-56">
771 <refmiscinfo class="allowable values">username</refmiscinfo>
772 <refmiscinfo class="default">NULL</refmiscinfo>
775 <refname>guest account = user</refname>
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>
783 <refentry id="appc-refentry-57">
785 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
786 <refmiscinfo class="default">NO</refmiscinfo>
789 <refname>guest ok = boolean</refname>
792 <para>If YES, passwords are not needed for this share. Synonym of <literal>public</literal>.</para>
797 <refentry id="appc-refentry-58">
799 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
800 <refmiscinfo class="default">NO</refmiscinfo>
803 <refname>guest only = boolean</refname>
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>
811 <refentry id="appc-refentry-59">
813 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
814 <refmiscinfo class="default">YES</refmiscinfo>
817 <refname>hide dot files = boolean</refname>
820 <para>Treats files beginning with a dot in a share as if they had the DOS/Windows hidden attribute set.</para>
825 <refentry id="appc-refentry-60">
827 <refmiscinfo class="allowable values">list of patterns, separated by <literal>/</literal> characters</refmiscinfo>
828 <refmiscinfo class="default">NULL</refmiscinfo>
831 <refname>hide files = slash-separated list</refname>
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>
839 <refentry id="appc-refentry-61">
841 <refmiscinfo class="allowable values">NIS map name</refmiscinfo>
842 <refmiscinfo class="default">auto.home</refmiscinfo>
845 <refname>[global] homedir map = NIS map name</refname>
848 <para>Used with <literal>nis homedir</literal> to locate user's Unix home directory from Sun NIS (not NIS+).</para>
853 <refentry id="appc-refentry-62">
855 <refmiscinfo class="allowable values">list of hostnames</refmiscinfo>
856 <refmiscinfo class="default">NULL</refmiscinfo>
859 <refname>hosts allow = host list</refname>
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>
867 <refentry id="appc-refentry-63">
869 <refmiscinfo class="allowable values">list of hostnames</refmiscinfo>
870 <refmiscinfo class="default">NULL</refmiscinfo>
873 <refname>hosts deny = host list</refname>
876 <para>Synonym of <literal>deny hosts</literal>, a list of machines that cannot connect to a share or shares.</para>
881 <refentry id="appc-refentry-64">
883 <refmiscinfo class="allowable values">pathname</refmiscinfo>
884 <refmiscinfo class="default">NULL</refmiscinfo>
887 <refname>[global] hosts equiv = pathname</refname>
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>
895 <refentry id="appc-refentry-65">
897 <refmiscinfo class="allowable values">pathname</refmiscinfo>
898 <refmiscinfo class="default">NULL</refmiscinfo>
901 <refname>include = pathname</refname>
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>
909 <refentry id="appc-refentry-66">
911 <refmiscinfo class="allowable values">IP addresses separated by spaces</refmiscinfo>
912 <refmiscinfo class="default">NULL</refmiscinfo>
915 <refname>[global] interfaces = interface list</refname>
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>
923 <refentry id="appc-refentry-67">
925 <refmiscinfo class="allowable values">list of users</refmiscinfo>
926 <refmiscinfo class="default">NULL</refmiscinfo>
929 <refname>invalid users = user list</refname>
932 <para>List of users that will not be permitted access to a share or shares.</para>
937 <refentry id="appc-refentry-68">
939 <refmiscinfo class="allowable values">number of seconds</refmiscinfo>
940 <refmiscinfo class="default">0</refmiscinfo>
943 <refname>[global] keepalive = number</refname>
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>
951 <refentry id="appc-refentry-69">
953 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
954 <refmiscinfo class="default">automatic</refmiscinfo>
957 <refname>[global] kernel oplocks = boolean</refname>
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>
965 <refentry id="appc-refentry-70">
967 <refmiscinfo class="allowable values">various</refmiscinfo>
968 <refmiscinfo class="default">varies</refmiscinfo>
971 <refname>[global] ldap filter = various</refname>
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>
979 <refentry id="appc-refentry-71">
981 <refmiscinfo class="allowable values">various</refmiscinfo>
982 <refmiscinfo class="default">various</refmiscinfo>
985 <refname>[global] ldap port = various</refname>
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>
993 <refentry id="appc-refentry-72">
995 <refmiscinfo class="allowable values">various</refmiscinfo>
996 <refmiscinfo class="default">various</refmiscinfo>
999 <refname>[global] ldap root = various</refname>
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>
1007 <refentry id="appc-refentry-73">
1009 <refmiscinfo class="allowable values">various</refmiscinfo>
1010 <refmiscinfo class="default">various</refmiscinfo>
1013 <refname>[global] ldap server = various</refname>
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>
1021 <refentry id="appc-refentry-74">
1023 <refmiscinfo class="allowable values">various</refmiscinfo>
1024 <refmiscinfo class="default">various</refmiscinfo>
1027 <refname>[global] ldap suffix = various</refname>
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>
1035 <refentry id="appc-refentry-75">
1037 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1038 <refmiscinfo class="default">YES</refmiscinfo>
1041 <refname>[global] load printers = boolean</refname>
1044 <para>Load all printer names from the system printer capabilities into browse list. Uses configuration options from the <literal>[printers]</literal> section.</para>
1049 <refentry id="appc-refentry-76">
1051 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1052 <refmiscinfo class="default">YES</refmiscinfo>
1055 <refname>[global] local master = boolean</refname>
1058 <para>Stands for election as the local master browser. See also <literal>domain master</literal> and <literal>os level</literal>.</para>
1063 <refentry id="appc-refentry-77">
1065 <refmiscinfo class="allowable values">AUTO, YES, NO</refmiscinfo>
1066 <refmiscinfo class="default">AUTO</refmiscinfo>
1069 <refname>[global] lm announce = value</refname>
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>
1077 <refentry id="appc-refentry-78">
1079 <refmiscinfo class="allowable values">number</refmiscinfo>
1080 <refmiscinfo class="default">60</refmiscinfo>
1083 <refname>[global] lm interval = seconds</refname>
1086 <para>Sets the time period, in seconds, between OS/2 SMB broadcast announcements.</para>
1091 <refentry id="appc-refentry-79">
1093 <refmiscinfo class="allowable values">pathname</refmiscinfo>
1094 <refmiscinfo class="default"><emphasis>/usr/local/samba/var/locks</emphasis></refmiscinfo>
1097 <refname>[global] lock directory = pathname</refname>
1100 <para>Set a directory to keep lock files in. The directory must be writable by Samba, readable by everyone.</para>
1105 <refentry id="appc-refentry-80">
1107 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1108 <refmiscinfo class="default">YES</refmiscinfo>
1111 <refname>locking = boolean</refname>
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>
1119 <refentry id="appc-refentry-81">
1121 <refmiscinfo class="allowable values">pathname</refmiscinfo>
1122 <refmiscinfo class="default">varies</refmiscinfo>
1125 <refname>[global] log file = pathname</refname>
1128 <para>Set name and location of the log file. Allows all %-variables.</para>
1133 <refentry id="appc-refentry-82">
1135 <refmiscinfo class="allowable values">number</refmiscinfo>
1136 <refmiscinfo class="default">0</refmiscinfo>
1139 <refname>[global] log level = number</refname>
1142 <para>A synonym of <literal>debug level</literal>. Sets the logging level used. Values of 3 or more slow the system noticeably.</para>
1147 <refentry id="appc-refentry-83">
1149 <refmiscinfo class="allowable values">DOS drive name</refmiscinfo>
1150 <refmiscinfo class="default">None</refmiscinfo>
1153 <refname>[global] logon drive = drive</refname>
1156 <para>Sets the drive on Windows NT (only) of the <literal>logon path</literal>.</para>
1161 <refentry id="appc-refentry-84">
1163 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
1164 <refmiscinfo class="default"><emphasis>\\</emphasis><replaceable>%N </replaceable><emphasis>\</emphasis><replaceable>%U</replaceable></refmiscinfo>
1167 <refname>[global] logon home = path</refname>
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>
1175 <refentry id="appc-refentry-85">
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>
1181 <refname>[global] logon path = pathname</refname>
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>
1189 <refentry id="appc-refentry-86">
1191 <refmiscinfo class="allowable values">pathname</refmiscinfo>
1192 <refmiscinfo class="default">NULL</refmiscinfo>
1195 <refname>[global] logon script = pathname</refname>
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>
1203 <refentry id="appc-refentry-87">
1205 <refmiscinfo class="allowable values">fully-qualfied Unix shell command</refmiscinfo>
1206 <refmiscinfo class="default">varies</refmiscinfo>
1209 <refname>lppause command = /absolute_ path/command</refname>
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>
1217 <refentry id="appc-refentry-88">
1219 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
1220 <refmiscinfo class="default">varies</refmiscinfo>
1223 <refname>lpresume command = /absolute_ path/command</refname>
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>
1231 <refentry id="appc-refentry-89">
1233 <refmiscinfo class="allowable values">number of seconds</refmiscinfo>
1234 <refmiscinfo class="default">10</refmiscinfo>
1237 <refname>[global] lpq cache time = seconds</refname>
1240 <para>Sets how long to keep print queue (<literal>lpq </literal>) status is cached, in seconds.</para>
1245 <refentry id="appc-refentry-90">
1247 <refmiscinfo class="allowable values">fully-qualfied Unix shell command</refmiscinfo>
1248 <refmiscinfo class="default">varies</refmiscinfo>
1251 <refname>lpq command = /absolute_ path/command</refname>
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>
1259 <refentry id="appc-refentry-91">
1261 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
1262 <refmiscinfo class="default">varies</refmiscinfo>
1265 <refname>lprm command = /absolute_ path/command</refname>
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>
1273 <refentry id="appc-refentry-92">
1275 <refmiscinfo class="allowable values">number of seconds</refmiscinfo>
1276 <refmiscinfo class="default">604,800</refmiscinfo>
1279 <refname>machine password timeout = seconds</refname>
1282 <para>Sets the period between (NT domain) machine password changes. Default is 1 week, or 604,800 seconds.</para>
1287 <refentry id="appc-refentry-93">
1289 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
1290 <refmiscinfo class="default"><emphasis>script.out</emphasis></refmiscinfo>
1293 <refname>magic output = pathname</refname>
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>
1301 <refentry id="appc-refentry-94">
1303 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
1304 <refmiscinfo class="default">NULL</refmiscinfo>
1307 <refname>magic script = pathname</refname>
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>
1315 <refentry id="appc-refentry-95">
1317 <refmiscinfo class="allowable values"><emphasis>allowable values:</emphasis> YES, NO</refmiscinfo>
1318 <refmiscinfo class="default">NO</refmiscinfo>
1321 <refname>mangle case = boolean</refname>
1324 <para>Mangle a name if it is in mixed case.</para>
1329 <refentry id="appc-refentry-96">
1331 <refmiscinfo class="allowable values">list of to-from pairs</refmiscinfo>
1332 <refmiscinfo class="default">NULL</refmiscinfo>
1335 <refname>mangled map = map list</refname>
1338 <para>Set up a table of names to remap (e.g., <emphasis>.html</emphasis> to <emphasis>.htm</emphasis>).</para>
1343 <refentry id="appc-refentry-97">
1345 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1346 <refmiscinfo class="default">YES</refmiscinfo>
1349 <refname>mangled names = boolean</refname>
1352 <para>Sets Samba to abbreviate names that are too long or have unsupported characters to the DOS 8.3 style.</para>
1357 <refentry id="appc-refentry-98">
1359 <refmiscinfo class="allowable values">character</refmiscinfo>
1360 <refmiscinfo class="default">~</refmiscinfo>
1363 <refname>mangling char = character</refname>
1366 <para>Sets the unique mangling character used in all mangled names.</para>
1371 <refentry id="appc-refentry-99">
1373 <refmiscinfo class="allowable values">number</refmiscinfo>
1374 <refmiscinfo class="default">50</refmiscinfo>
1377 <refname>[global] mangled stack = number</refname>
1380 <para>Sets the size of a cache of recently-mangled filenames.</para>
1385 <refentry id="appc-refentry-100">
1387 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
1388 <refmiscinfo class="default">NULL</refmiscinfo>
1391 <refname>map aliasname = pathname</refname>
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>
1399 <refentry id="appc-refentry-101">
1401 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1402 <refmiscinfo class="default">YES</refmiscinfo>
1405 <refname>map archive = boolean</refname>
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>
1413 <refentry id="appc-refentry-102">
1415 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1416 <refmiscinfo class="default">NO</refmiscinfo>
1419 <refname>map hidden = boolean</refname>
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>
1427 <refentry id="appc-refentry-103">
1429 <refmiscinfo class="allowable values">pathname</refmiscinfo>
1430 <refmiscinfo class="default">NULL</refmiscinfo>
1433 <refname>map groupname = pathname</refname>
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>
1441 <refentry id="appc-refentry-104">
1443 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1444 <refmiscinfo class="default">NO</refmiscinfo>
1447 <refname>map system = boolean</refname>
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>
1455 <refentry id="appc-refentry-105">
1457 <refmiscinfo class="allowable values">number</refmiscinfo>
1458 <refmiscinfo class="default">0 (infinity)</refmiscinfo>
1461 <refname>max connections = number</refname>
1464 <para>Set maximum number of connections allowed to a share from each individual client machine.</para>
1469 <refentry id="appc-refentry-106">
1471 <refmiscinfo class="allowable values">size in MB</refmiscinfo>
1472 <refmiscinfo class="default">0 (unchanged)</refmiscinfo>
1475 <refname>[global] max disk size = number</refname>
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>
1483 <refentry id="appc-refentry-107">
1485 <refmiscinfo class="allowable values">size in KB</refmiscinfo>
1486 <refmiscinfo class="default">5000</refmiscinfo>
1489 <refname>[global] max log size = number</refname>
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>
1497 <refentry id="appc-refentry-108">
1499 <refmiscinfo class="allowable values">number</refmiscinfo>
1500 <refmiscinfo class="default">50</refmiscinfo>
1503 <refname>[global] max mux = number</refname>
1506 <para>Sets the number of simultaneous operations that Samba clients may make. Avoid changing.</para>
1511 <refentry id="appc-refentry-109">
1513 <refmiscinfo class="allowable values">number</refmiscinfo>
1514 <refmiscinfo class="default">N/A</refmiscinfo>
1517 <refname>[global] max packet = number</refname>
1520 <para>Synonym for <literal>packet size</literal>. Obsolete as of Samba 1.7. Use <literal>max xmit</literal> instead.</para>
1525 <refentry id="appc-refentry-110">
1527 <refmiscinfo class="allowable values">number</refmiscinfo>
1528 <refmiscinfo class="default">10,000</refmiscinfo>
1531 <refname>[global] max open files = number</refname>
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>
1539 <refentry id="appc-refentry-111">
1541 <refmiscinfo class="allowable values">time in seconds</refmiscinfo>
1542 <refmiscinfo class="default">14400 (4 hrs)</refmiscinfo>
1545 <refname>[global] max ttl = seconds</refname>
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>
1553 <refentry id="appc-refentry-112">
1555 <refmiscinfo class="allowable values">time in seconds</refmiscinfo>
1556 <refmiscinfo class="default">259200 (3 days)</refmiscinfo>
1559 <refname>[global] max wins ttl = seconds</refname>
1562 <para>Limits time-to-live of a NetBIOS name in <emphasis>nmbd</emphasis> WINS cache, in seconds. Avoid changing.</para>
1567 <refentry id="appc-refentry-113">
1569 <refmiscinfo class="allowable values">size in bytes</refmiscinfo>
1570 <refmiscinfo class="default">65535</refmiscinfo>
1573 <refname>[global] max xmit = bytes</refname>
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>
1581 <refentry id="appc-refentry-114">
1583 <refmiscinfo class="allowable values">shell command</refmiscinfo>
1584 <refmiscinfo class="default">NULL</refmiscinfo>
1587 <refname>[global] message command = /absolute_ path/command</refname>
1590 <para>Sets the command on the server to run when a WinPopup message arrives from a client. The command must end in "<literal>&</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>
1595 <refentry id="appc-refentry-115">
1597 <refmiscinfo class="allowable values">space in KB</refmiscinfo>
1598 <refmiscinfo class="default">0 (unlimited)</refmiscinfo>
1601 <refname>min print space = kilobytes</refname>
1604 <para>Sets minimum spool space required before accepting a print request.</para>
1609 <refentry id="appc-refentry-116">
1611 <refmiscinfo class="allowable values">time in seconds</refmiscinfo>
1612 <refmiscinfo class="default">21600 (6 hrs)</refmiscinfo>
1615 <refname>[global] min wins ttl = seconds</refname>
1618 <para>Sets minimum time-to-live of a NetBIOS name in <emphasis>nmbd</emphasis> WINS cache, in seconds. Avoid changing.</para>
1623 <refentry id="appc-refentry-117">
1625 <refmiscinfo class="allowable values">list of lmhosts, wins, hosts and bcast</refmiscinfo>
1626 <refmiscinfo class="default">lmhosts wins hosts bcast</refmiscinfo>
1629 <refname>name resolve order = list</refname>
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>
1637 <refentry id="appc-refentry-118">
1639 <refmiscinfo class="allowable values">list of netbios names</refmiscinfo>
1640 <refmiscinfo class="default">NULL</refmiscinfo>
1643 <refname>[global] netbios aliases = list</refname>
1646 <para>Adds additional NetBIOS names by which a Samba server will advertise itself.</para>
1651 <refentry id="appc-refentry-119">
1653 <refmiscinfo class="allowable values">host name</refmiscinfo>
1654 <refmiscinfo class="default">varies</refmiscinfo>
1657 <refname>netbios name = hostname</refname>
1660 <para>Sets the NetBIOS name by which a Samba server is known, or primary name if NetBIOS aliases exist.</para>
1665 <refentry id="appc-refentry-120">
1667 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1668 <refmiscinfo class="default">YES</refmiscinfo>
1671 <refname>[global] networkstation user login = boolean</refname>
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>
1679 <refentry id="appc-refentry-121">
1681 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1682 <refmiscinfo class="default">NO</refmiscinfo>
1685 <refname>[global] nis homedir = boolean</refname>
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>
1693 <refentry id="appc-refentry-122">
1695 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1696 <refmiscinfo class="default">YES</refmiscinfo>
1699 <refname>[global] nt pipe support = boolean</refname>
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>
1707 <refentry id="appc-refentry-123">
1709 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1710 <refmiscinfo class="default">YES</refmiscinfo>
1713 <refname>[global] nt smb support = boolean</refname>
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>
1721 <refentry id="appc-refentry-124">
1723 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1724 <refmiscinfo class="default">NO</refmiscinfo>
1727 <refname>[global] null passwords = boolean</refname>
1730 <para>If YES, allows access to accounts that have null passwords. Strongly discouraged.</para>
1735 <refentry id="appc-refentry-125">
1737 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1738 <refmiscinfo class="default">YES</refmiscinfo>
1741 <refname>ole locking compatibility = boolean</refname>
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>
1749 <refentry id="appc-refentry-126">
1751 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1752 <refmiscinfo class="default">NO</refmiscinfo>
1755 <refname>only guest = boolean</refname>
1758 <para>A synonym for <literal>guest only</literal>. Forces user of a share to login as the guest account.</para>
1763 <refentry id="appc-refentry-127">
1765 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1766 <refmiscinfo class="default">NO</refmiscinfo>
1769 <refname>only user = boolean</refname>
1772 <para>Requires that users of the share be on a <literal>username =</literal> list.</para>
1777 <refentry id="appc-refentry-128">
1779 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1780 <refmiscinfo class="default">YES</refmiscinfo>
1783 <refname>oplocks = boolean</refname>
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>
1791 <refentry id="appc-refentry-129">
1793 <refmiscinfo class="allowable values">number</refmiscinfo>
1794 <refmiscinfo class="default">0</refmiscinfo>
1797 <refname>[global] os level = number</refname>
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>
1805 <refentry id="appc-refentry-130">
1807 <refmiscinfo class="allowable values">number in bytes</refmiscinfo>
1808 <refmiscinfo class="default">65535</refmiscinfo>
1811 <refname>[global] packet size = bytes</refname>
1814 <para>Obsolete. Discouraged synonym of <literal>max packet</literal>. See <literal>max xmit</literal>.</para>
1819 <refentry id="appc-refentry-131">
1821 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1822 <refmiscinfo class="default">NO</refmiscinfo>
1825 <refname>[global] passwd chat debug = boolean</refname>
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>
1833 <refentry id="appc-refentry-132">
1835 <refmiscinfo class="allowable values">Unix server commands</refmiscinfo>
1836 <refmiscinfo class="default">compiled-in value</refmiscinfo>
1839 <refname>[global] passwd chat = command sequence</refname>
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>
1847 <refentry id="appc-refentry-133">
1849 <refmiscinfo class="allowable values">Unix server program</refmiscinfo>
1850 <refmiscinfo class="default">NULL</refmiscinfo>
1853 <refname>[global] passwd program = program</refname>
1856 <para>Sets the command used to change user's password. Will be run as <literal>root</literal>. Supports <literal>%u</literal> (user).</para>
1861 <refentry id="appc-refentry-135">
1863 <refmiscinfo class="allowable values">list of NetBIOS names</refmiscinfo>
1864 <refmiscinfo class="default">NULL</refmiscinfo>
1867 <refname>[global] password server = netbios names</refname>
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>
1875 <refentry id="appc-refentry-136">
1877 <refmiscinfo class="allowable values">fully-qualfied Unix shell command</refmiscinfo>
1878 <refmiscinfo class="default">NULL</refmiscinfo>
1881 <refname>panic action = /absolute_ path/command</refname>
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>
1889 <refentry id="appc-refentry-137">
1891 <refmiscinfo class="allowable values">pathname</refmiscinfo>
1892 <refmiscinfo class="default">varies</refmiscinfo>
1895 <refname>path = pathname</refname>
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>
1903 <refentry id="appc-refentry-138">
1905 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
1906 <refmiscinfo class="default">NULL</refmiscinfo>
1909 <refname>postexec = /absolute_ path/command</refname>
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>
1917 <refentry id="appc-refentry-139">
1919 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1920 <refmiscinfo class="default">NO</refmiscinfo>
1923 <refname>postscript = boolean</refname>
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>
1931 <refentry id="appc-refentry-140">
1933 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
1934 <refmiscinfo class="default">NULL</refmiscinfo>
1937 <refname>preexec = /absolute_ path/command</refname>
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>
1945 <refentry id="appc-refentry-141">
1947 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1948 <refmiscinfo class="default">NO</refmiscinfo>
1951 <refname>[global] preferred master = boolean</refname>
1954 <para>If YES, Samba is preferred to become the master browser. Causes Samba to call a browsing election when it comes online.</para>
1959 <refentry id="appc-refentry-142">
1961 <refmiscinfo class="allowable values">list of services</refmiscinfo>
1962 <refmiscinfo class="default">NULL</refmiscinfo>
1965 <refname>preload = share list</refname>
1968 <para>Synonym of <literal>auto</literal> <literal>services</literal>. Specifies a list of shares that will always appear in browse lists.</para>
1973 <refentry id="appc-refentry-143">
1975 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
1976 <refmiscinfo class="default">NO</refmiscinfo>
1979 <refname>preserve case = boolean</refname>
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>
1987 <refentry id="appc-refentry-144">
1989 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
1990 <refmiscinfo class="default">varies</refmiscinfo>
1993 <refname>print command = /absolute_ path/command</refname>
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>
2001 <refentry id="appc-refentry-145">
2003 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2004 <refmiscinfo class="default">NO</refmiscinfo>
2007 <refname>print ok = boolean</refname>
2010 <para>Synonym of <literal>printable</literal>.</para>
2015 <refentry id="appc-refentry-146">
2017 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2018 <refmiscinfo class="default">NO</refmiscinfo>
2021 <refname>printable = boolean</refname>
2024 <para>Sets a share to be a print share. Required for all printers.</para>
2029 <refentry id="appc-refentry-147">
2031 <refmiscinfo class="allowable values">pathname</refmiscinfo>
2032 <refmiscinfo class="default"><emphasis>/etc/printcap</emphasis></refmiscinfo>
2035 <refname>[global] printcap name = pathname</refname>
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>
2043 <refentry id="appc-refentry-148">
2045 <refmiscinfo class="allowable values">printer name</refmiscinfo>
2046 <refmiscinfo class="default"><literal>lp</literal></refmiscinfo>
2049 <refname>printer = name</refname>
2052 <para>Sets the name of the Unix printer.</para>
2057 <refentry id="appc-refentry-149">
2059 <refmiscinfo class="allowable values">exact printer driver string used by Windows</refmiscinfo>
2060 <refmiscinfo class="default">NULL</refmiscinfo>
2063 <refname>printer driver = printer driver name</refname>
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>
2071 <refentry id="appc-refentry-150">
2073 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
2074 <refmiscinfo class="default"><emphasis>samba-lib/printers.def</emphasis></refmiscinfo>
2077 <refname>[global] printer driver file = path</refname>
2080 <para>Sets the location of a <emphasis>msprint.def</emphasis> file, usable by Windows 95/98.</para>
2085 <refentry id="appc-refentry-151">
2087 <refmiscinfo class="allowable values">Windows network path</refmiscinfo>
2088 <refmiscinfo class="default"><emphasis>\\</emphasis><replaceable>server</replaceable><emphasis>\PRINTER$</emphasis></refmiscinfo>
2091 <refname>printer driver location = path</refname>
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>
2099 <refentry id="appc-refentry-152">
2101 <refmiscinfo class="allowable values">name</refmiscinfo>
2102 <refmiscinfo class="default">NULL</refmiscinfo>
2105 <refname>printer name = name</refname>
2108 <para>Synonym of <literal>printer</literal>.</para>
2113 <refentry id="appc-refentry-153">
2115 <refmiscinfo class="allowable values">bsd, sysv, hpux, aix, qnx, plp, lprng</refmiscinfo>
2116 <refmiscinfo class="default">bsd</refmiscinfo>
2119 <refname>printing = style</refname>
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>
2127 <refentry id="appc-refentry-154">
2129 <refmiscinfo class="allowable values">NT1, LANMAN2, LANMAN1, COREPLUS, CORE</refmiscinfo>
2130 <refmiscinfo class="default">NT1</refmiscinfo>
2133 <refname>[global] protocol = protocol</refname>
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>
2143 <refentry id="appc-refentry-155">
2145 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2146 <refmiscinfo class="default">NO</refmiscinfo>
2149 <refname>public = boolean</refname>
2152 <para>If YES, passwords are not needed for this share. A synonym is <literal>guest ok</literal>.</para>
2157 <refentry id="appc-refentry-156">
2159 <refmiscinfo class="allowable values">valid Unix command</refmiscinfo>
2160 <refmiscinfo class="default">varies</refmiscinfo>
2163 <refname>queuepause command = /absolute_ path/command</refname>
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>
2171 <refentry id="appc-refentry-157">
2173 <refmiscinfo class="allowable values">valid Unix command</refmiscinfo>
2174 <refmiscinfo class="default">varies</refmiscinfo>
2177 <refname>queueresume command = /absolute_ path/command</refname>
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>
2185 <refentry id="appc-refentry-158">
2187 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2188 <refmiscinfo class="default">NO</refmiscinfo>
2191 <refname>read bmpx = boolean</refname>
2194 <para>Obsolete. Do not change.</para>
2199 <refentry id="appc-refentry-159">
2201 <refmiscinfo class="allowable values">comma-separated list of users</refmiscinfo>
2202 <refmiscinfo class="default">NULL</refmiscinfo>
2205 <refname>read list = comma-separated list</refname>
2208 <para>Specifies a list of users given read-only access to a writeable share.</para>
2213 <refentry id="appc-refentry-160">
2215 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2216 <refmiscinfo class="default">NO</refmiscinfo>
2219 <refname>read only = boolean</refname>
2222 <para>Sets a share to read-only. Antonym of <literal>writable</literal> and <literal>write ok</literal>.</para>
2227 <refentry id="appc-refentry-161">
2229 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2230 <refmiscinfo class="default">NO</refmiscinfo>
2233 <refname>[global] read prediction = boolean</refname>
2236 <para>Reads ahead data for read-only files. Obsolete; removed in Samba 2.0.</para>
2241 <refentry id="appc-refentry-162">
2243 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2244 <refmiscinfo class="default">YES</refmiscinfo>
2247 <refname>[global] read raw = boolean</refname>
2250 <para>Allows fast streaming reads over TCP using 64K buffers. Recommended.</para>
2255 <refentry id="appc-refentry-163">
2257 <refmiscinfo class="allowable values">size in bytes</refmiscinfo>
2258 <refmiscinfo class="default">2048</refmiscinfo>
2261 <refname>[global] read size = bytes</refname>
2264 <para>Sets a buffering option for servers with mismatched disk and network speeds. Requires experimentation. Avoid changing. Should not exceed 65536.</para>
2269 <refentry id="appc-refentry-164">
2271 <refmiscinfo class="allowable values">list of remote addresses</refmiscinfo>
2272 <refmiscinfo class="default">NULL</refmiscinfo>
2275 <refname>[global] remote announce = remote list</refname>
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>
2283 <refentry id="appc-refentry-165">
2285 <refmiscinfo class="allowable values">IP-address list</refmiscinfo>
2286 <refmiscinfo class="default">NULL</refmiscinfo>
2289 <refname>[global] remote browse sync = address list</refname>
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>
2297 <refentry id="appc-refentry-166">
2299 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2300 <refmiscinfo class="default">NO</refmiscinfo>
2303 <refname>revalidate = boolean</refname>
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>
2311 <refentry id="appc-refentry-167">
2313 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
2314 <refmiscinfo class="default">NULL</refmiscinfo>
2317 <refname>[global] root = pathname</refname>
2320 <para>Synonym for <literal>root directory</literal>.</para>
2325 <refentry id="appc-refentry-168">
2327 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
2328 <refmiscinfo class="default">NULL</refmiscinfo>
2331 <refname>[global] root dir = pathname</refname>
2334 <para>Synonym for <literal>root directory</literal>.</para>
2339 <refentry id="appc-refentry-169">
2341 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
2342 <refmiscinfo class="default">NULL</refmiscinfo>
2345 <refname>[global] root directory = pathname</refname>
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>
2353 <refentry id="appc-refentry-170">
2355 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
2356 <refmiscinfo class="default">NULL</refmiscinfo>
2359 <refname>root postexec = /absolute_ path/command</refname>
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>
2367 <refentry id="appc-refentry-171">
2369 <refmiscinfo class="allowable values">fully-qualified Unix shell command</refmiscinfo>
2370 <refmiscinfo class="default">NULL</refmiscinfo>
2373 <refname>root preexec = /absolute_ path/command</refname>
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>
2381 <refentry id="appc-refentry-172">
2383 <refmiscinfo class="allowable values">share, user, server, domain</refmiscinfo>
2384 <refmiscinfo class="default">share in Samba 1.0, user in 2.0</refmiscinfo>
2387 <refname>[global] security = value</refname>
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>
2395 <refentry id="appc-refentry-173">
2397 <refmiscinfo class="allowable values">string</refmiscinfo>
2398 <refmiscinfo class="default">Samba <literal>%v</literal> in 2.0</refmiscinfo>
2401 <refname>[global] server string = text</refname>
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>
2409 <refentry id="appc-refentry-174">
2411 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2412 <refmiscinfo class="default">NO</refmiscinfo>
2415 <refname>set directory = boolean</refname>
2418 <para>Allows DEC Pathworks client to use the <emphasis>set dir</emphasis> command.</para>
2423 <refentry id="appc-refentry-175">
2425 <refmiscinfo class="allowable values">number</refmiscinfo>
2426 <refmiscinfo class="default">113</refmiscinfo>
2429 <refname>[global] shared file entries = number</refname>
2432 <para>Obsolete; do not use.</para>
2437 <refentry id="appc-refentry-176">
2439 <refmiscinfo class="allowable values">size in bytes</refmiscinfo>
2440 <refmiscinfo class="default">102400</refmiscinfo>
2443 <refname>shared mem size = bytes</refname>
2446 <para>If compiled with FAST_SHARE_MODES (mmap), sets the shared memory size in bytes. Avoid changing.</para>
2451 <refentry id="appc-refentry-177">
2453 <refmiscinfo class="allowable values">Unix pathname</refmiscinfo>
2454 <refmiscinfo class="default"><filename>/usr/local/samba/private/smbpasswd</filename></refmiscinfo>
2457 <refname>[global] smb passwd file = path</refname>
2460 <para>Overrides compiled-in path to password file if <literal>encrypted passwords</literal> <literal>=</literal> <literal>yes</literal>.</para>
2465 <refentry id="appc-refentry-178">
2467 <refmiscinfo class="allowable values">smbrun command</refmiscinfo>
2468 <refmiscinfo class="default">compiled-in value</refmiscinfo>
2471 <refname>[global] smbrun = /absolute_ path/command</refname>
2474 <para>Overrides compiled-in path to <filename>smbrun</filename> binary. Avoid changing.</para>
2479 <refentry id="appc-refentry-180">
2481 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2482 <refmiscinfo class="default">NO</refmiscinfo>
2485 <refname>short preserve case = boolean</refname>
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>
2493 <refentry id="appc-refentry-181">
2495 <refmiscinfo class="allowable values">IP address</refmiscinfo>
2496 <refmiscinfo class="default">NULL</refmiscinfo>
2499 <refname>[global] socket address = IP address</refname>
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>
2507 <refentry id="appc-refentry-182">
2509 <refmiscinfo class="allowable values">list</refmiscinfo>
2510 <refmiscinfo class="default">NULL</refmiscinfo>
2513 <refname>[global] socket options = socket option list</refname>
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>
2521 <refentry id="appc-refentry-183">
2523 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2524 <refmiscinfo class="default">YES</refmiscinfo>
2527 <refname>[global] status = boolean</refname>
2530 <para>If YES, logs connections to a file (or shared memory) accessible to <filename>smbstatus</filename>.</para>
2535 <refentry id="appc-refentry-184">
2537 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2538 <refmiscinfo class="default">NO</refmiscinfo>
2541 <refname>strict sync = boolean</refname>
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>
2549 <refentry id="appc-refentry-185">
2551 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2552 <refmiscinfo class="default">NO</refmiscinfo>
2555 <refname>strict locking = boolean</refname>
2558 <para>If set to YES, Samba checks locks on every access, not just on demand and at open time. Not recommended.</para>
2563 <refentry id="appc-refentry-186">
2565 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2566 <refmiscinfo class="default">NO</refmiscinfo>
2569 <refname>[global] strip dot = boolean</refname>
2572 <para>Removes trailing dots from filenames. Use <literal>mangled map</literal> instead.</para>
2577 <refentry id="appc-refentry-187">
2579 <refmiscinfo class="allowable values">number</refmiscinfo>
2580 <refmiscinfo class="default">1</refmiscinfo>
2583 <refname>[global] syslog = number</refname>
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>
2591 <refentry id="appc-refentry-188">
2593 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2594 <refmiscinfo class="default">NO</refmiscinfo>
2597 <refname>[global] syslog only = boolean</refname>
2600 <para>If set to YES, log only to <emphasis>syslog,</emphasis> not standard Samba log files.</para>
2605 <refentry id="appc-refentry-189">
2607 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2608 <refmiscinfo class="default">NO</refmiscinfo>
2611 <refname>sync always = boolean</refname>
2614 <para>If set to YES, Samba calls <emphasis>fsync</emphasis>(3) after every write. Avoid except for debugging crashing servers.</para>
2619 <refentry id="appc-refentry-190">
2621 <refmiscinfo class="allowable values">minutes</refmiscinfo>
2622 <refmiscinfo class="default">0</refmiscinfo>
2625 <refname>[global] time offset = minutes</refname>
2628 <para>Sets number of minutes to add to system time zone calculation. Provided to fix a client daylight-savings bug; not recommended.</para>
2633 <refentry id="appc-refentry-191">
2635 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2636 <refmiscinfo class="default">NO</refmiscinfo>
2639 <refname>[global] time server = boolean</refname>
2642 <para>If YES, <emphasis>nmbd</emphasis> will provide time service to its clients.</para>
2647 <refentry id="appc-refentry-192">
2649 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2650 <refmiscinfo class="default">NO</refmiscinfo>
2653 <refname>unix password sync = boolean</refname>
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>
2661 <refentry id="appc-refentry-193">
2663 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2664 <refmiscinfo class="default">NO</refmiscinfo>
2667 <refname>unix realname = boolean</refname>
2670 <para>If set, will provide the GCOS field of <filename>/etc/passwd</filename> to the client as the user's full name.</para>
2675 <refentry id="appc-refentry-195">
2677 <refmiscinfo class="allowable values">comma-separated list of user names</refmiscinfo>
2678 <refmiscinfo class="default">NULL</refmiscinfo>
2681 <refname>user = comma-separated list</refname>
2684 <para>Synonym for <literal>username</literal>.</para>
2689 <refentry id="appc-refentry-196">
2691 <refmiscinfo class="allowable values">comma-separated list of user names</refmiscinfo>
2692 <refmiscinfo class="default">NULL</refmiscinfo>
2695 <refname>username = comma-separated list</refname>
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>
2703 <refentry id="appc-refentry-197">
2705 <refmiscinfo class="allowable values">number</refmiscinfo>
2706 <refmiscinfo class="default">0</refmiscinfo>
2709 <refname>username level = number</refname>
2712 <para>Number of uppercase letter permutations allowed to match Unix usernames. Workaround for Windows feature (single-case usernames). Use is discouraged.</para>
2717 <refentry id="appc-refentry-198">
2719 <refmiscinfo class="allowable values">pathname</refmiscinfo>
2720 <refmiscinfo class="default">NULL</refmiscinfo>
2723 <refname>[global] username map = pathname</refname>
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>
2731 <refentry id="appc-refentry-199">
2733 <refmiscinfo class="allowable values">list of numeric values</refmiscinfo>
2734 <refmiscinfo class="default">NULL</refmiscinfo>
2737 <refname>valid chars = list</refname>
2740 <para>Semi-obsolete. Adds national characters to a character set map. Overridden by <literal>client code page</literal>.</para>
2745 <refentry id="appc-refentry-200">
2747 <refmiscinfo class="allowable values">list of users</refmiscinfo>
2748 <refmiscinfo class="default">NULL (everyone)</refmiscinfo>
2751 <refname>valid users = user list</refname>
2754 <para>List of users that can log in to a share.</para>
2759 <refentry id="appc-refentry-201">
2761 <refmiscinfo class="allowable values">slash-separated list of filenames</refmiscinfo>
2762 <refmiscinfo class="default">NULL</refmiscinfo>
2765 <refname>veto files = slash-list</refname>
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>
2773 <refentry id="appc-refentry-202">
2775 <refmiscinfo class="allowable values">slash-separated list of filenames</refmiscinfo>
2776 <refmiscinfo class="default">NULL</refmiscinfo>
2779 <refname>veto oplock files = slash-list</refname>
2782 <para>List of files not to oplock (and cache on clients). See also <literal>oplocks</literal> and <literal>fake oplocks</literal>.</para>
2787 <refentry id="appc-refentry-203">
2789 <refmiscinfo class="allowable values">string</refmiscinfo>
2790 <refmiscinfo class="default">NULL</refmiscinfo>
2793 <refname>volume = share name</refname>
2796 <para>Sets the volume label of a disk share, notably a CD-ROM.</para>
2801 <refentry id="appc-refentry-204">
2803 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2804 <refmiscinfo class="default">YES</refmiscinfo>
2807 <refname>wide links = boolean</refname>
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>
2815 <refentry id="appc-refentry-205">
2817 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2818 <refmiscinfo class="default">NO</refmiscinfo>
2821 <refname>[global] wins proxy = boolean</refname>
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>
2829 <refentry id="appc-refentry-206">
2831 <refmiscinfo class="allowable values">hostname</refmiscinfo>
2832 <refmiscinfo class="default">NULL</refmiscinfo>
2835 <refname>[global] wins server = host</refname>
2838 <para>Sets the DNS name or IP address of the WINS server.</para>
2843 <refentry id="appc-refentry-207">
2845 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2846 <refmiscinfo class="default">NO</refmiscinfo>
2849 <refname>[global] wins support = boolean</refname>
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>
2857 <refentry id="appc-refentry-208">
2859 <refmiscinfo class="allowable values">workgroup name</refmiscinfo>
2860 <refmiscinfo class="default">compiled-in</refmiscinfo>
2863 <refname>[global] workgroup = name</refname>
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>
2871 <refentry id="appc-refentry-209">
2873 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2874 <refmiscinfo class="default">YES</refmiscinfo>
2877 <refname>writable = boolean</refname>
2880 <para>Antonym for <literal>read only</literal>; synonym of <literal>write ok</literal>.</para>
2885 <refentry id="appc-refentry-210">
2887 <refmiscinfo class="allowable values">comma-separated list of users</refmiscinfo>
2888 <refmiscinfo class="default">NULL (everyone)</refmiscinfo>
2891 <refname>write list = comma-separated list</refname>
2894 <para>List of users that are given read-write access to a read-only share. See also <literal>read list</literal>.</para>
2899 <refentry id="appc-refentry-211">
2901 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2902 <refmiscinfo class="default">YES</refmiscinfo>
2905 <refname>write ok = boolean</refname>
2908 <para>Synonym of the <literal>writable</literal> configuration option.</para>
2913 <refentry id="appc-refentry-212">
2915 <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
2916 <refmiscinfo class="default">YES</refmiscinfo>
2919 <refname>[global] write raw = boolean</refname>
2922 <para>Allows fast streaming writes over TCP, using 64KB buffers. Recommended.</para>
2936 <sect1 role="" label="C.2" id="appc-SECT-2">
2937 <title>Glossary of Configuration Values</title>
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>
2947 <varlistentry><term>Comma-separated list</term>
2948 <listitem><para>A list of items separated by commas.</para></listitem>
2952 <varlistentry><term>Command</term>
2953 <listitem><para>A Unix command, with full path and parameters.</para></listitem>
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>
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>
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>
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>
2977 <varlistentry><term>Service (share) list</term>
2978 <listitem><para>A space-separated list of share names, without the enclosing square brackets.</para></listitem>
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>
2987 <varlistentry><term>Text</term>
2988 <listitem><para>One line of text.</para></listitem>
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, &<literal>group_name</literal> is an NIS netgroup, and &+ and +& cause an ordered search of both Unix and NIS groups.</para></listitem>
3006 <sect1 role="" label="C.3" id="appc-SECT-3">
3007 <title>Configuration File Variables</title>
3010 <para><link linkend="appc-88529">Table 3.1</link> lists of Samba configuration file variables.</para>
3013 <table label="C.1" id="appc-88529">
3014 <title>Variables in Alphabetic Order </title>
3017 <colspec colnum="1" colname="col1"/>
3018 <colspec colnum="2" colname="col2"/>
3022 <entry colname="col1"><para>Name</para></entry>
3024 <entry colname="col2"><para>Meaning</para></entry>
3033 <entry colname="col1"><para><literal>%a</literal></para></entry>
3035 <entry colname="col2"><para>Client's architecture (one of Samba, WfWg, WinNT, Win95, or UNKNOWN)</para></entry>
3041 <entry colname="col1"><para><literal>%d</literal></para></entry>
3043 <entry colname="col2"><para>Current server process's processID</para></entry>
3049 <entry colname="col1"><para><literal>%f</literal></para></entry>
3051 <entry colname="col2"><para>Print-spool file as a relative path (printing only)</para></entry>
3057 <entry colname="col1"><para><literal>%f</literal></para></entry>
3059 <entry colname="col2"><para>User from which a message was sent (messages only)</para></entry>
3065 <entry colname="col1"><para><literal>%G</literal></para></entry>
3067 <entry colname="col2"><para>Primary group name of <literal>%U</literal> (requested username)</para></entry>
3073 <entry colname="col1"><para><literal>%g</literal></para></entry>
3075 <entry colname="col2"><para>Primary group name of <literal>%u</literal> (actual username)</para></entry>
3081 <entry colname="col1"><para><literal>%H</literal></para></entry>
3083 <entry colname="col2"><para>Home directory of <literal>%u</literal> (actual username)</para></entry>
3089 <entry colname="col1"><para><literal>%h</literal></para></entry>
3091 <entry colname="col2"><para>Samba server's (Internet) hostname</para></entry>
3097 <entry colname="col1"><para><literal>%I</literal></para></entry>
3099 <entry colname="col2"><para>Client's IP address</para></entry>
3105 <entry colname="col1"><para><literal>%j</literal></para></entry>
3107 <entry colname="col2"><para>Print job number (printing only)</para></entry>
3113 <entry colname="col1"><para><literal>%L</literal></para></entry>
3115 <entry colname="col2"><para>Samba server's NetBIOS name (virtual servers have multiple names)</para></entry>
3121 <entry colname="col1"><para><literal>%M</literal></para></entry>
3123 <entry colname="col2"><para>Client's (Internet) hostname</para></entry>
3129 <entry colname="col1"><para><literal>%m</literal></para></entry>
3131 <entry colname="col2"><para>Client's NetBIOS name</para></entry>
3137 <entry colname="col1"><para><literal>%n</literal></para></entry>
3139 <entry colname="col2"><para>New password (password change only)</para></entry>
3145 <entry colname="col1"><para><literal>%N</literal></para></entry>
3147 <entry colname="col2"><para>Name of the NIS home directory server (without NIS, same as <literal>%L</literal>)</para></entry>
3153 <entry colname="col1"><para><literal>%o</literal></para></entry>
3155 <entry colname="col2"><para>Old password (password change only)</para></entry>
3161 <entry colname="col1"><para><literal>%P</literal></para></entry>
3163 <entry colname="col2"><para>Current share's root directory (actual)</para></entry>
3169 <entry colname="col1"><para><literal>%p</literal></para></entry>
3171 <entry colname="col2"><para>Current share's root directory (in an NIS homedir map)</para></entry>
3177 <entry colname="col1"><para><literal>%p</literal></para></entry>
3179 <entry colname="col2"><para>Print filename (printing only)</para></entry>
3185 <entry colname="col1"><para><literal>%R</literal></para></entry>
3187 <entry colname="col2"><para>Protocol level in use (one of CORE, COREPLUS, LANMAN1, LANMAN2, or NT1)</para></entry>
3193 <entry colname="col1"><para><literal>%S</literal></para></entry>
3195 <entry colname="col2"><para>Current share's name</para></entry>
3201 <entry colname="col1"><para><literal>%s</literal></para></entry>
3203 <entry colname="col2"><para>Filename the message is in (messages only)</para></entry>
3209 <entry colname="col1"><para><literal>%s</literal></para></entry>
3211 <entry colname="col2"><para>Print-spool file name (printing only)</para></entry>
3217 <entry colname="col1"><para><literal>%T</literal></para></entry>
3219 <entry colname="col2"><para>Current date and time</para></entry>
3225 <entry colname="col1"><para><literal>%t</literal></para></entry>
3227 <entry colname="col2"><para>Destination machine (messages only)</para></entry>
3233 <entry colname="col1"><para><literal>%u</literal></para></entry>
3235 <entry colname="col2"><para>Current share's username</para></entry>
3241 <entry colname="col1"><para><literal>%U</literal></para></entry>
3243 <entry colname="col2"><para>Requested username for current share</para></entry>
3249 <entry colname="col1"><para><literal>%v</literal></para></entry>
3251 <entry colname="col2"><para>Samba version</para></entry>
git.samba.org / nivanova / samba-autobuild / .git / blob