1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smb.conf</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="smb.conf"><a name="smb.conf.5"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smb.conf — The configuration file for the Samba suite</p></div><div class="refsect1" title="SYNOPSIS"><a name="id2528887"></a><h2>SYNOPSIS</h2><p>
The <code class="filename">smb.conf</code> file is a configuration file for the Samba suite. <code class="filename">smb.conf</code> contains runtime configuration information for the Samba programs. The
<code class="filename">smb.conf</code> file is designed to be configured and administered by the
<a class="citerefentry" href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a> program. The
complete description of the file format and possible parameters held within are here for reference purposes.
</p></div><div class="refsect1" title="FILE FORMAT"><a name="FILEFORMATSECT"></a><h2>FILE FORMAT</h2><p>
The file consists of sections and parameters. A section begins with the name of the section in square brackets
and continues until the next section begins. Sections contain parameters of the form:
</p><pre class="programlisting">
<em class="replaceable"><code>name</code></em> = <em class="replaceable"><code>value </code></em>
</pre><p>
</p><p>
The file is line-based - that is, each newline-terminated line represents either a comment, a section name or
a parameter.
</p><p>Section and parameter names are not case sensitive.</p><p>
Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is
discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading
and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is
retained verbatim.
</p><p>
Any line beginning with a semicolon (<span class="quote">“<span class="quote">;</span>”</span>) or a hash (<span class="quote">“<span class="quote">#</span>”</span>)
character is ignored, as are lines containing only whitespace.
</p><p>
Any line ending in a <span class="quote">“<span class="quote"><code class="literal">\</code></span>”</span> is continued on the next line in the customary UNIX fashion.
</p><p>
The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean,
which may be given as yes/no, 1/0 or true/false. Case is not significant in boolean values, but is preserved
in string values. Some items such as create masks are numeric.
</p></div><div class="refsect1" title="SECTION DESCRIPTIONS"><a name="id2489374"></a><h2>SECTION DESCRIPTIONS</h2><p>
Each section in the configuration file (except for the [global] section) describes a shared resource (known as
a <span class="quote">“<span class="quote">share</span>”</span>). The section name is the name of the shared resource and the parameters within the
section define the shares attributes.
</p><p>
There are three special sections, [global], [homes] and [printers], which are described under
<span class="emphasis"><em>special sections</em></span>. The following notes apply to ordinary section descriptions.
</p><p>
A share consists of a directory to which access is being given plus a description of the access rights
which are granted to the user of the service. Some housekeeping options are also specifiable.
</p><p>
Sections are either file share services (used by the client as an extension of their native file systems)
or printable services (used by the client to access print services on the host running the server).
</p><p>
Sections may be designated <span class="emphasis"><em>guest</em></span> services, in which case no password is required to
access them. A specified UNIX <span class="emphasis"><em>guest account</em></span> is used to define access privileges in this
case.
</p><p>
Sections other than guest services will require a password to access them. The client provides the
username. As older clients only provide passwords and not usernames, you may specify a list of usernames to
check against the password using the <code class="literal">user =</code> option in the share definition. For modern clients
such as Windows 95/98/ME/NT/2000, this should not be necessary.
</p><p>
The access rights granted by the server are masked by the access rights granted to the specified or guest
UNIX user by the host system. The server does not grant more access than the host system grants.
</p><p>
The following sample section defines a file space share. The user has write access to the path <code class="filename">/home/bar</code>. The share is accessed via the share name <code class="literal">foo</code>:
</p><pre class="programlisting">
<em class="parameter"><code>[foo]</code></em>
<a class="link" href="smb.conf.5.html#PATH" target="_top">path = /home/bar</a>
<a class="link" href="smb.conf.5.html#READONLY" target="_top">read only = no</a>
</pre><p>
</p><p>
The following sample section defines a printable share. The share is read-only, but printable. That is,
the only write access permitted is via calls to open, write to and close a spool file. The <span class="emphasis"><em>guest
ok</em></span> parameter means access will be permitted as the default guest user (specified elsewhere):
</p><pre class="programlisting">
<em class="parameter"><code>[aprinter]</code></em>
<a class="link" href="smb.conf.5.html#PATH" target="_top">path = /usr/spool/public</a>
<a class="link" href="smb.conf.5.html#READONLY" target="_top">read only = yes</a>
<a class="link" href="smb.conf.5.html#PRINTABLE" target="_top">printable = yes</a>
<a class="link" href="smb.conf.5.html#GUESTOK" target="_top">guest ok = yes</a>
</pre><p>
</p></div><div class="refsect1" title="SPECIAL SECTIONS"><a name="id2487452"></a><h2>SPECIAL SECTIONS</h2><div class="refsect2" title="The [global] section"><a name="id2487457"></a><h3>The [global] section</h3><p>
Parameters in this section apply to the server as a whole, or are defaults for sections that do not
specifically define certain items. See the notes under PARAMETERS for more information.
</p></div><div class="refsect2" title="The [homes] section"><a name="HOMESECT"></a><h3>The [homes] section</h3><p>
If a section called [homes] is included in the configuration file, services connecting clients
to their home directories can be created on the fly by the server.
</p><p>
When the connection request is made, the existing sections are scanned. If a match is found, it is
used. If no match is found, the requested section name is treated as a username and looked up in the local
password file. If the name exists and the correct password has been given, a share is created by cloning the
[homes] section.
</p><p>
Some modifications are then made to the newly created share:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
The share name is changed from homes to the located username.
</p></li><li class="listitem"><p>
If no path was given, the path is set to the user's home directory.
</p></li></ul></div><p>
If you decide to use a <span class="emphasis"><em>path =</em></span> line in your [homes] section, it may be useful
to use the %S macro. For example:
</p><pre class="programlisting">
<strong class="userinput"><code>path = /data/pchome/%S</code></strong>
</pre><p>
is useful if you have different home directories for your PCs than for UNIX access.
</p><p>
This is a fast and simple way to give a large number of clients access to their home directories with a minimum
of fuss.
</p><p>
A similar process occurs if the requested section name is <span class="quote">“<span class="quote">homes</span>”</span>, except that the share
name is not changed to that of the requesting user. This method of using the [homes] section works well if
different users share a client PC.
</p><p>
The [homes] section can specify all the parameters a normal service section can specify, though some make more sense
than others. The following is a typical and suitable [homes] section:
</p><pre class="programlisting">
<em class="parameter"><code>[homes]</code></em>
<a class="link" href="smb.conf.5.html#READONLY" target="_top">read only = no</a>
</pre><p>
</p><p>
An important point is that if guest access is specified in the [homes] section, all home directories will be
visible to all clients <span class="emphasis"><em>without a password</em></span>. In the very unlikely event that this is actually
desirable, it is wise to also specify <span class="emphasis"><em>read only access</em></span>.
</p><p>
The <span class="emphasis"><em>browseable</em></span> flag for auto home directories will be inherited from the global browseable
flag, not the [homes] browseable flag. This is useful as it means setting <span class="emphasis"><em>browseable = no</em></span> in
the [homes] section will hide the [homes] share but make any auto home directories visible.
</p></div><div class="refsect2" title="The [printers] section"><a name="PRINTERSSECT"></a><h3>The [printers] section</h3><p>
This section works like [homes], but for printers.
</p><p>
If a [printers] section occurs in the configuration file, users are able to connect to any printer
specified in the local host's printcap file.
</p><p>
When a connection request is made, the existing sections are scanned. If a match is found, it is used.
If no match is found, but a [homes] section exists, it is used as described above. Otherwise, the requested
section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested
section name is a valid printer share name. If a match is found, a new printer share is created by cloning the
[printers] section.
</p><p>
A few modifications are then made to the newly created share:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>The share name is set to the located printer name</p></li><li class="listitem"><p>If no printer name was given, the printer name is set to the located printer name</p></li><li class="listitem"><p>If the share does not permit guest access and no username was given, the username is set
to the located printer name.</p></li></ul></div><p>
The [printers] service MUST be printable - if you specify otherwise, the server will refuse
to load the configuration file.
</p><p>
Typically the path specified is that of a world-writeable spool directory with the sticky bit set on
it. A typical [printers] entry looks like this:
</p><pre class="programlisting">
<em class="parameter"><code>[printers]</code></em>
<a class="link" href="smb.conf.5.html#PATH" target="_top">path = /usr/spool/public</a>
<a class="link" href="smb.conf.5.html#GUESTOK" target="_top">guest ok = yes</a>
<a class="link" href="smb.conf.5.html#PRINTABLE" target="_top">printable = yes</a>
</pre><p>
</p><p>
All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned.
If your printing subsystem doesn't work like that, you will have to set up a pseudo-printcap. This is a file
consisting of one or more lines like this:
</p><pre class="programlisting">
alias|alias|alias|alias...
</pre><p>
</p><p>
Each alias should be an acceptable printer name for your printing subsystem. In the [global] section,
specify the new file as your printcap. The server will only recognize names found in your pseudo-printcap,
which of course can contain whatever aliases you like. The same technique could be used simply to limit access
to a subset of your local printers.
</p><p>
An alias, by the way, is defined as any component of the first entry of a printcap record. Records are separated by newlines,
components (if there are more than one) are separated by vertical bar symbols (<code class="literal">|</code>).
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use
<code class="literal">printcap name = lpstat</code> to automatically obtain a list of printers. See the
<code class="literal">printcap name</code> option for more details.
</p></div></div></div><div class="refsect1" title="USERSHARES"><a name="id2487774"></a><h2>USERSHARES</h2><p>Starting with Samba version 3.0.23 the capability for non-root users to add, modify, and delete
their own share definitions has been added. This capability is called <span class="emphasis"><em>usershares</em></span> and
is controlled by a set of parameters in the [global] section of the smb.conf.
The relevant parameters are :
</p><div class="variablelist"><dl><dt><span class="term">usershare allow guests</span></dt><dd><p>Controls if usershares can permit guest access.</p></dd><dt><span class="term">usershare max shares</span></dt><dd><p>Maximum number of user defined shares allowed.</p></dd><dt><span class="term">usershare owner only</span></dt><dd><p>If set only directories owned by the sharing user can be shared.</p></dd><dt><span class="term">usershare path</span></dt><dd><p>Points to the directory containing the user defined share definitions.
The filesystem permissions on this directory control who can create user defined shares.</p></dd><dt><span class="term">usershare prefix allow list</span></dt><dd><p>Comma-separated list of absolute pathnames restricting what directories
can be shared. Only directories below the pathnames in this list are permitted.</p></dd><dt><span class="term">usershare prefix deny list</span></dt><dd><p>Comma-separated list of absolute pathnames restricting what directories
can be shared. Directories below the pathnames in this list are prohibited.</p></dd><dt><span class="term">usershare template share</span></dt><dd><p>Names a pre-existing share used as a template for creating new usershares.
All other share parameters not specified in the user defined share definition
are copied from this named share.</p></dd></dl></div><p>To allow members of the UNIX group <code class="literal">foo</code> to create user defined
shares, create the directory to contain the share definitions as follows:
</p><p>Become root:</p><pre class="programlisting">
mkdir /usr/local/samba/lib/usershares
chgrp foo /usr/local/samba/lib/usershares
chmod 1770 /usr/local/samba/lib/usershares
</pre><p>Then add the parameters
</p><pre class="programlisting">
<a class="link" href="smb.conf.5.html#USERSHAREPATH" target="_top">usershare path = /usr/local/samba/lib/usershares</a>
<a class="link" href="smb.conf.5.html#USERSHAREMAXSHARES" target="_top">usershare max shares = 10</a> # (or the desired number of shares)
</pre><p>
to the global
section of your <code class="filename">smb.conf</code>. Members of the group foo may then manipulate the user defined shares
using the following commands.</p><div class="variablelist"><dl><dt><span class="term">net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]</span></dt><dd><p>To create or modify (overwrite) a user defined share.</p></dd><dt><span class="term">net usershare delete sharename</span></dt><dd><p>To delete a user defined share.</p></dd><dt><span class="term">net usershare list wildcard-sharename</span></dt><dd><p>To list user defined shares.</p></dd><dt><span class="term">net usershare info wildcard-sharename</span></dt><dd><p>To print information about user defined shares.</p></dd></dl></div></div><div class="refsect1" title="PARAMETERS"><a name="id2488001"></a><h2>PARAMETERS</h2><p>Parameters define the specific attributes of sections.</p><p>
Some parameters are specific to the [global] section (e.g., <span class="emphasis"><em>security</em></span>). Some parameters
are usable in all sections (e.g., <span class="emphasis"><em>create mask</em></span>). All others are permissible only in normal
sections. For the purposes of the following descriptions the [homes] and [printers] sections will be
considered normal. The letter <span class="emphasis"><em>G</em></span> in parentheses indicates that a parameter is specific to
the [global] section. The letter <span class="emphasis"><em>S</em></span> indicates that a parameter can be specified in a
service specific section. All <span class="emphasis"><em>S</em></span> parameters can also be specified in the [global] section
- in which case they will define the default behavior for all services.
</p><p>
Parameters are arranged here in alphabetical order - this may not create best bedfellows, but at least you can
find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred
synonym.
</p></div><div class="refsect1" title="VARIABLE SUBSTITUTIONS"><a name="id2538515"></a><h2>VARIABLE SUBSTITUTIONS</h2><p>
Many of the strings that are settable in the config file can take substitutions. For example the option
<span class="quote">“<span class="quote">path = /tmp/%u</span>”</span> is interpreted as <span class="quote">“<span class="quote">path = /tmp/john</span>”</span> if the user connected with the
username john.
</p><p>
These substitutions are mostly noted in the descriptions below, but there are some general substitutions
which apply whenever they might be relevant. These are:
</p><div class="variablelist"><dl><dt><span class="term">%U</span></dt><dd><p>session username (the username that the client wanted, not
necessarily the same as the one they got).</p></dd><dt><span class="term">%G</span></dt><dd><p>primary group name of %U.</p></dd><dt><span class="term">%h</span></dt><dd><p>the Internet hostname that Samba is running on.</p></dd><dt><span class="term">%m</span></dt><dd><p>the NetBIOS name of the client machine (very useful).</p><p>This parameter is not available when Samba listens on port 445, as clients no longer
send this information. If you use this macro in an include statement on a domain that has
a Samba domain controller be sure to set in the [global] section <em class="parameter"><code>smb ports =
139</code></em>. This will cause Samba to not listen on port 445 and will permit include
functionality to function as it did with Samba 2.x.
</p></dd><dt><span class="term">%L</span></dt><dd><p>the NetBIOS name of the server. This allows you to change your config based on what
the client calls you. Your server can have a <span class="quote">“<span class="quote">dual personality</span>”</span>.
</p></dd><dt><span class="term">%M</span></dt><dd><p>the Internet name of the client machine.
</p></dd><dt><span class="term">%R</span></dt><dd><p>the selected protocol level after protocol negotiation. It can be one of CORE, COREPLUS,
LANMAN1, LANMAN2 or NT1.</p></dd><dt><span class="term">%d</span></dt><dd><p>the process id of the current server
process.</p></dd><dt><span class="term">%a</span></dt><dd><p>
The architecture of the remote
machine. It currently recognizes Samba (<code class="constant">Samba</code>),
the Linux CIFS file system (<code class="constant">CIFSFS</code>), OS/2, (<code class="constant">OS2</code>),
Windows for Workgroups (<code class="constant">WfWg</code>), Windows 9x/ME
(<code class="constant">Win95</code>), Windows NT (<code class="constant">WinNT</code>),
Windows 2000 (<code class="constant">Win2K</code>),
Windows XP (<code class="constant">WinXP</code>),
Windows XP 64-bit(<code class="constant">WinXP64</code>),
Windows 2003 including
2003R2 (<code class="constant">Win2K3</code>), and Windows
Vista (<code class="constant">Vista</code>). Anything else will be known as
<code class="constant">UNKNOWN</code>.</p></dd><dt><span class="term">%I</span></dt><dd><p>the IP address of the client machine.</p></dd><dt><span class="term">%i</span></dt><dd><p>the local IP address to which a client connected.</p></dd><dt><span class="term">%T</span></dt><dd><p>the current date and time.</p></dd><dt><span class="term">%D</span></dt><dd><p>name of the domain or workgroup of the current user.</p></dd><dt><span class="term">%w</span></dt><dd><p>the winbind separator.</p></dd><dt><span class="term">%$(<em class="replaceable"><code>envvar</code></em>)</span></dt><dd><p>the value of the environment variable
<em class="replaceable"><code>envar</code></em>.</p></dd></dl></div><p>
The following substitutes apply only to some configuration options (only those that are
used when a connection has been established):
</p><div class="variablelist"><dl><dt><span class="term">%S</span></dt><dd><p>the name of the current service, if any.</p></dd><dt><span class="term">%P</span></dt><dd><p>the root directory of the current service, if any.</p></dd><dt><span class="term">%u</span></dt><dd><p>username of the current service, if any.</p></dd><dt><span class="term">%g</span></dt><dd><p>primary group name of %u.</p></dd><dt><span class="term">%H</span></dt><dd><p>the home directory of the user given by %u.</p></dd><dt><span class="term">%N</span></dt><dd><p>
the name of your NIS home directory server. This is obtained from your NIS auto.map entry.
If you have not compiled Samba with the <span class="emphasis"><em>--with-automount</em></span> option, this
value will be the same as %L.</p></dd><dt><span class="term">%p</span></dt><dd><p>
the path of the service's home directory, obtained from your NIS auto.map entry. The NIS
auto.map entry is split up as <code class="literal">%N:%p</code>.</p></dd></dl></div><p>
There are some quite creative things that can be done with these substitutions and other
<code class="filename">smb.conf</code> options.
</p></div><div class="refsect1" title="NAME MANGLING"><a name="NAMEMANGLINGSECT"></a><h2>NAME MANGLING</h2><p>
Samba supports <code class="literal">name mangling</code> so that DOS and Windows clients can use files that don't
conform to the 8.3 format. It can also be set to adjust the case of 8.3 format filenames.
</p><p>
There are several options that control the way mangling is performed, and they are grouped here rather
than listed separately. For the defaults look at the output of the testparm program.
</p><p>
These options can be set separately for each service.
</p><p>
The options are:
</p><div class="variablelist"><dl><dt><span class="term">case sensitive = yes/no/auto</span></dt><dd><p>
controls whether filenames are case sensitive. If they aren't, Samba must do a filename search and match on
passed names. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS
and smbclient 3.0.5 and above currently) to tell the Samba server on a per-packet basis that they wish to
access the file system in a case-sensitive manner (to support UNIX case sensitive semantics). No Windows or
DOS system supports case-sensitive filename so setting this option to auto is that same as setting it to no
for them. Default <span class="emphasis"><em>auto</em></span>.
</p></dd><dt><span class="term">default case = upper/lower</span></dt><dd><p>
controls what the default case is for new filenames (ie. files that don't currently exist in the filesystem).
Default <span class="emphasis"><em>lower</em></span>. IMPORTANT NOTE: This option will be used to modify the case of
<span class="emphasis"><em>all</em></span> incoming client filenames, not just new filenames if the options <a class="link" href="smb.conf.5.html#CASESENSITIVE" target="_top">case sensitive = yes</a>, <a class="link" href="smb.conf.5.html#PRESERVECASE" target="_top">preserve case = No</a>,
<a class="link" href="smb.conf.5.html#SHORTPRESERVECASE" target="_top">short preserve case = No</a> are set. This change is needed as part of the
optimisations for directories containing large numbers of files.
</p></dd><dt><span class="term">preserve case = yes/no</span></dt><dd><p>
controls whether new files (ie. files that don't currently exist in the filesystem) are created with the case
that the client passes, or if they are forced to be the <code class="literal">default</code> case. Default
<span class="emphasis"><em>yes</em></span>.
</p></dd><dt><span class="term">short preserve case = yes/no</span></dt><dd><p>
controls if new files (ie. files that don't currently exist in the filesystem) which conform to 8.3 syntax,
that is all in upper case and of suitable length, are created upper case, or if they are forced to be the
<code class="literal">default</code> case. This option can be used with <code class="literal">preserve case = yes</code> to permit
long filenames to retain their case, while short names are lowercased. Default <span class="emphasis"><em>yes</em></span>.
</p></dd></dl></div><p>
By default, Samba 3.0 has the same semantics as a Windows NT server, in that it is case insensitive
but case preserving. As a special case for directories with large numbers of files, if the case
options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no"
then the "default case" option will be applied and will modify all filenames sent from the client
when accessing this share.
</p></div><div class="refsect1" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION"><a name="VALIDATIONSECT"></a><h2>NOTE ABOUT USERNAME/PASSWORD VALIDATION</h2><p>
There are a number of ways in which a user can connect to a service. The server uses the following steps
in determining if it will allow a connection to a specified service. If all the steps fail, the connection
request is rejected. However, if one of the steps succeeds, the following steps are not checked.
</p><p>
If the service is marked <span class="quote">“<span class="quote">guest only = yes</span>”</span> and the server is running with share-level
security (<span class="quote">“<span class="quote">security = share</span>”</span>, steps 1 to 5 are skipped.
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>
If the client has passed a username/password pair and that username/password pair is validated by the UNIX
system's password programs, the connection is made as that username. This includes the
<code class="literal">\\server\service</code>%<em class="replaceable"><code>username</code></em> method of passing a username.
</p></li><li class="listitem"><p>
If the client has previously registered a username with the system and now supplies a correct password for that
username, the connection is allowed.
</p></li><li class="listitem"><p>
The client's NetBIOS name and any previously used usernames are checked against the supplied password. If
they match, the connection is allowed as the corresponding user.
</p></li><li class="listitem"><p>
If the client has previously validated a username/password pair with the server and the client has passed
the validation token, that username is used.
</p></li><li class="listitem"><p>
If a <code class="literal">user = </code> field is given in the <code class="filename">smb.conf</code> file for the
service and the client has supplied a password, and that password matches (according to the UNIX system's
password checking) with one of the usernames from the <code class="literal">user =</code> field, the connection is made as
the username in the <code class="literal">user =</code> line. If one of the usernames in the <code class="literal">user =</code> list
begins with a <code class="literal">@</code>, that name expands to a list of names in the group of the same name.
</p></li><li class="listitem"><p>
If the service is a guest service, a connection is made as the username given in the <code class="literal">guest account
=</code> for the service, irrespective of the supplied password.
</p></li></ol></div></div><div class="refsect1" title="REGISTRY-BASED CONFIGURATION"><a name="id2539216"></a><h2>REGISTRY-BASED CONFIGURATION</h2><p>
Starting with Samba version 3.2.0, the capability to
store Samba configuration in the registry is available.
The configuration is stored in the registry key
<span class="emphasis"><em><code class="literal">HKLM\Software\Samba\smbconf</code></em></span>.
There are two levels of registry configuration:
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>Share definitions stored in registry are used.
This is triggered by setting the global
parameter <em class="parameter"><code>registry shares</code></em>
to <span class="quote">“<span class="quote">yes</span>”</span> in <span class="emphasis"><em>smb.conf</em></span>.
</p><p>The registry shares are loaded not at startup but
on demand at runtime by <span class="emphasis"><em>smbd</em></span>.
Shares defined in <span class="emphasis"><em>smb.conf</em></span> take
priority over shares of the same name defined in
registry.</p></li><li class="listitem"><p>Global <span class="emphasis"><em>smb.conf</em></span>
options stored in registry are used. This can be activated
in two different ways:</p><p>Firstly, a registry only configuration is triggered
by setting
<a class="link" href="smb.conf.5.html#CONFIGBACKEND" target="_top">config backend = registry</a>
in the [global] section of <span class="emphasis"><em>smb.conf</em></span>.
This resets everything that has been read from config files
to this point and reads the content of the global configuration
section from the registry.
This is the recommended method of using registry based
configuration.</p><p>Secondly, a mixed configuration can be activated
by a special new meaning of the parameter
<a class="link" href="smb.conf.5.html#INCLUDE" target="_top">include = registry</a>
in the [global] section of <span class="emphasis"><em>smb.conf</em></span>.
This reads the global options from registry with the same
priorities as for an include of a text file.
This may be especially useful in cases where an initial
configuration is needed to access the registry.</p><p>Activation of global registry options automatically
activates registry shares. So in the registry only case,
shares are loaded on demand only.</p></li></ol></div><p>
Note: To make registry-based configurations foolproof
at least to a certain extent, the use
of <em class="parameter"><code>lock directory</code></em> and
<em class="parameter"><code>config backend</code></em>
inside the registry configuration has been disabled:
Especially by changing the
<em class="parameter"><code>lock directory</code></em> inside the registry
configuration, one would create a broken setup where the daemons
do not see the configuration they loaded once it is active.
</p><p>
The registry configuration can be accessed with
tools like <span class="emphasis"><em>regedit</em></span> or <span class="emphasis"><em>net (rpc)
registry</em></span> in the key
<span class="emphasis"><em><code class="literal">HKLM\Software\Samba\smbconf</code></em></span>.
More conveniently, the <span class="emphasis"><em>conf</em></span> subcommand of the
<a class="citerefentry" href="net.8.html"><span class="citerefentry"><span class="refentrytitle">net</span>(8)</span></a> utility
offers a dedicated interface to read and write the
registry based configuration locally, i.e. directly
accessing the database file, circumventing the
server.
</p></div><div class="refsect1" title="EXPLANATION OF EACH PARAMETER"><a name="id2539391"></a><h2>EXPLANATION OF EACH PARAMETER</h2><div class="section"><div class="titlepage"></div><div class="section" title="abort shutdown script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2539402"></a>
abort shutdown script (G)
</h3></div></div></div><a class="indexterm" name="id2539403"></a><a name="ABORTSHUTDOWNSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This a full path name to a script called by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> that
should stop a shutdown procedure issued by the <a class="link" href="smb.conf.5.html#SHUTDOWNSCRIPT" target="_top">shutdown script</a>.</p><p>If the connected user posseses the <code class="constant">SeRemoteShutdownPrivilege</code>,
right, this command will be run as root.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>abort shutdown script</code></em> = <code class="literal">""</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>abort shutdown script</code></em> = <code class="literal">/sbin/shutdown -c</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="access based share enum (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2539481"></a>
access based share enum (S)
</h3></div></div></div><a class="indexterm" name="id2539482"></a><a name="ACCESSBASEDSHAREENUM"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is <code class="constant">yes</code> for a
service, then the share hosted by the service will only be visible
to users who have read or write access to the share during share
enumeration (for example net view \\sambaserver). This has
parallels to access based enumeration, the main difference being
that only share permissions are evaluated, and security
descriptors on files contained on the share are not used in
computing enumeration access rights.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>access based share enum</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="acl check permissions (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2539530"></a>
acl check permissions (S)
</h3></div></div></div><a class="indexterm" name="id2539531"></a><a name="ACLCHECKPERMISSIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls what <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>does on receiving a protocol request of "open for delete"
from a Windows client. If a Windows client doesn't have permissions to delete a file then they
expect this to be denied at open time. POSIX systems normally only detect restrictions on delete by
actually attempting to delete the file or directory. As Windows clients can (and do) "back out" a
delete request by unsetting the "delete on close" bit Samba cannot delete the file immediately
on "open for delete" request as we cannot restore such a deleted file. With this parameter set to
true (the default) then smbd checks the file system permissions directly on "open for delete" and denies the
request without actually deleting the file if the file system permissions would seem to deny it.
This is not perfect, as it's possible a user could have deleted a file without Samba being able to
check the permissions correctly, but it is close enough to Windows semantics for mostly correct
behaviour. Samba will correctly check POSIX ACL semantics in this case.
</p><p>If this parameter is set to "false" Samba doesn't check permissions on "open for delete"
and allows the open. If the user doesn't have permission to delete the file this will only be
discovered at close time, which is too late for the Windows user tools to display an error message
to the user. The symptom of this is files that appear to have been deleted "magically" re-appearing
on a Windows explorer refresh. This is an extremely advanced protocol option which should not
need to be changed. This parameter was introduced in its final form in 3.0.21, an earlier version
with slightly different semantics was introduced in 3.0.20. That older version is not documented here.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl check permissions</code></em> = <code class="literal">True</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="acl compatibility (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2539626"></a>
acl compatibility (G)
</h3></div></div></div><a class="indexterm" name="id2539627"></a><a name="ACLCOMPATIBILITY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies what OS ACL semantics should
be compatible with. Possible values are <span class="emphasis"><em>winnt</em></span> for Windows NT 4,
<span class="emphasis"><em>win2k</em></span> for Windows 2000 and above and <span class="emphasis"><em>auto</em></span>.
If you specify <span class="emphasis"><em>auto</em></span>, the value for this parameter
will be based upon the version of the client. There should
be no reason to change this parameter from the default.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl compatibility</code></em> = <code class="literal">Auto</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>acl compatibility</code></em> = <code class="literal">win2k</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="acl group control (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2539696"></a>
acl group control (S)
</h3></div></div></div><a class="indexterm" name="id2539697"></a><a name="ACLGROUPCONTROL"></a><div class="variablelist"><dl><dt></dt><dd><p>
In a POSIX filesystem, only the owner of a file or directory and the superuser can modify the permissions
and ACLs on a file. If this parameter is set, then Samba overrides this restriction, and also allows the
<span class="emphasis"><em>primary group owner</em></span> of a file or directory to modify the permissions and ACLs
on that file.
</p><p>
On a Windows server, groups may be the owner of a file or directory - thus allowing anyone in
that group to modify the permissions on it. This allows the delegation of security controls
on a point in the filesystem to the group owner of a directory and anything below it also owned
by that group. This means there are multiple people with permissions to modify ACLs on a file
or directory, easing managability.
</p><p>
This parameter allows Samba to also permit delegation of the control over a point in the exported
directory hierarchy in much the same way as Windows. This allows all members of a UNIX group to
control the permissions on a file or directory they have group ownership on.
</p><p>
This parameter is best used with the <a class="link" href="smb.conf.5.html#INHERITOWNER" target="_top">inherit owner</a> option and also
on on a share containing directories with the UNIX <span class="emphasis"><em>setgid bit</em></span> set
on them, which causes new files and directories created within it to inherit the group
ownership from the containing directory.
</p><p>
This is parameter has been was deprecated in Samba 3.0.23, but re-activated in
Samba 3.0.31 and above, as it now only controls permission changes if the user
is in the owning primary group. It is now no longer equivalent to the
<em class="parameter"><code>dos filemode</code></em> option.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl group control</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="acl map full control (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2539792"></a>
acl map full control (S)
</h3></div></div></div><a class="indexterm" name="id2539793"></a><a name="ACLMAPFULLCONTROL"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean parameter controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum
allowed POSIX permission set, into a Windows ACL of "FULL CONTROL". If this parameter is set to true any POSIX
ACE entry of "rwx" will be returned in a Windows ACL as "FULL CONTROL", is this parameter is set to false any
POSIX ACE entry of "rwx" will be returned as the specific Windows ACL bits representing read, write and
execute.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl map full control</code></em> = <code class="literal">True</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="add group script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2539843"></a>
add group script (G)
</h3></div></div></div><a class="indexterm" name="id2539844"></a><a name="ADDGROUPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is the full pathname to a script that will be run <span class="emphasis"><em>AS ROOT</em></span> by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a new group is requested. It
will expand any <em class="parameter"><code>%g</code></em> to the group name passed. This script is only useful
for installations using the Windows NT domain administration tools. The script is free to create a group with
an arbitrary name to circumvent unix group name restrictions. In that case the script must print the numeric
gid of the created group on stdout.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add group script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add group script</code></em> = <code class="literal">/usr/sbin/groupadd %g</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="add machine script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2539918"></a>
add machine script (G)
</h3></div></div></div><a class="indexterm" name="id2539919"></a><a name="ADDMACHINESCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is the full pathname to a script that will be run by
<a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a machine is
added to Samba's domain and a Unix account matching the machine's name appended with a "$" does not
already exist.
</p><p>This option is very similar to the <a class="link" href="smb.conf.5.html#ADDUSERSCRIPT" target="_top">add user script</a>, and likewise uses the %u
substitution for the account name. Do not use the %m
substitution. </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add machine script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add machine script</code></em> = <code class="literal">/usr/sbin/adduser -n -g machines -c Machine -d /var/lib/nobody -s /bin/false %u</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="add port command (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2539997"></a>
add port command (G)
</h3></div></div></div><a class="indexterm" name="id2539998"></a><a name="ADDPORTCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>Samba 3.0.23 introduced support for adding printer ports
remotely using the Windows "Add Standard TCP/IP Port Wizard".
This option defines an external program to be executed when
smbd receives a request to add a new Port to the system.
The script is passed two parameters:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>port name</code></em></p></li><li class="listitem"><p><em class="parameter"><code>device URI</code></em></p></li></ul></div><p>The deviceURI is in the for of socket://<hostname>[:<portnumber>]
or lpd://<hostname>/<queuename>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add port command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add port command</code></em> = <code class="literal">/etc/samba/scripts/addport.sh</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="addprinter command (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2540082"></a>
addprinter command (G)
</h3></div></div></div><a class="indexterm" name="id2540083"></a><a name="ADDPRINTERCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>With the introduction of MS-RPC based printing
support for Windows NT/2000 clients in Samba 2.2, The MS Add
Printer Wizard (APW) icon is now also available in the
"Printers..." folder displayed a share listing. The APW
allows for printers to be add remotely to a Samba or Windows
NT/2000 print server.</p><p>For a Samba host this means that the printer must be
physically added to the underlying printing system.
The <em class="parameter"><code>addprinter command</code></em>
defines a script to be run which
will perform the necessary operations for adding the printer
to the print system and to add the appropriate service definition
to the <code class="filename">smb.conf</code> file in order that it can be
shared by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>.</p><p>The <em class="parameter"><code>addprinter command</code></em> is
automatically invoked with the following parameter (in
order):</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>printer name</code></em></p></li><li class="listitem"><p><em class="parameter"><code>share name</code></em></p></li><li class="listitem"><p><em class="parameter"><code>port name</code></em></p></li><li class="listitem"><p><em class="parameter"><code>driver name</code></em></p></li><li class="listitem"><p><em class="parameter"><code>location</code></em></p></li><li class="listitem"><p><em class="parameter"><code>Windows 9x driver location</code></em></p></li></ul></div><p>All parameters are filled in from the PRINTER_INFO_2 structure sent
by the Windows NT/2000 client with one exception. The "Windows 9x
driver location" parameter is included for backwards compatibility
only. The remaining fields in the structure are generated from answers
to the APW questions.</p><p>Once the <em class="parameter"><code>addprinter command</code></em> has
been executed, <code class="literal">smbd</code> will reparse the <code class="filename">
smb.conf</code> to determine if the share defined by the APW
exists. If the sharename is still invalid, then <code class="literal">smbd
</code> will return an ACCESS_DENIED error to the client.</p><p>
The <em class="parameter"><code>addprinter command</code></em> program
can output a single line of text,
which Samba will set as the port the new printer is connected to.
If this line isn't output, Samba won't reload its printer shares.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>addprinter command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>addprinter command</code></em> = <code class="literal">/usr/bin/addprinter</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="add share command (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2540270"></a>
add share command (G)
</h3></div></div></div><a class="indexterm" name="id2540271"></a><a name="ADDSHARECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>
Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
Manager. The <em class="parameter"><code>add share command</code></em> is used to define an external program
or script which will add a new service definition to
<code class="filename">smb.conf</code>.
</p><p>
In order to successfully execute the
<em class="parameter"><code>add share command</code></em>,
<code class="literal">smbd</code> requires that the administrator
connects using a root account (i.e. uid == 0) or has the
<code class="literal">SeDiskOperatorPrivilege</code>.
Scripts defined in the <em class="parameter"><code>add share command</code></em>
parameter are executed as root.
</p><p>
When executed, <code class="literal">smbd</code> will automatically invoke the
<em class="parameter"><code>add share command</code></em> with five parameters.
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>configFile</code></em> - the location of the global <code class="filename">smb.conf</code> file.
</p></li><li class="listitem"><p><em class="parameter"><code>shareName</code></em> - the name of the new share.
</p></li><li class="listitem"><p><em class="parameter"><code>pathName</code></em> - path to an **existing**
directory on disk.
</p></li><li class="listitem"><p><em class="parameter"><code>comment</code></em> - comment string to associate with the new
share.
</p></li><li class="listitem"><p><em class="parameter"><code>max
connections</code></em>
Number of maximum simultaneous connections to this
share.
</p></li></ul></div><p>
This parameter is only used to add file shares. To add printer shares, see the <a class="link" href="smb.conf.5.html#ADDPRINTERCOMMAND" target="_top">addprinter command</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add share command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add share command</code></em> = <code class="literal">/usr/local/bin/addshare</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="add user script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2540455"></a>
add user script (G)
</h3></div></div></div><a class="indexterm" name="id2540456"></a><a name="ADDUSERSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is the full pathname to a script that will be run <span class="emphasis"><em>AS ROOT</em></span> by
<a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
under special circumstances described below.
</p><p>
Normally, a Samba server requires that UNIX users are created for all users accessing
files on this server. For sites that use Windows NT account databases as their primary
user database creating these users and keeping the user list in sync with the Windows
NT PDC is an onerous task. This option allows smbd to create the required UNIX users
<span class="emphasis"><em>ON DEMAND</em></span> when a user accesses the Samba server.
</p><p>
In order to use this option, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> must <span class="emphasis"><em>NOT</em></span> be set to
<a class="link" href="smb.conf.5.html#SECURITY" target="_top">security = share</a> and <a class="link" href="smb.conf.5.html#ADDUSERSCRIPT" target="_top">add user script</a>
must be set to a full pathname for a script that will create a UNIX user given one argument of
<em class="parameter"><code>%u</code></em>, which expands into the UNIX user name to create.
</p><p>
When the Windows user attempts to access the Samba server, at login (session setup in
the SMB protocol) time, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> contacts the <a class="link" href="smb.conf.5.html#PASSWORDSERVER" target="_top">password server</a>
and attempts to authenticate the given user with the given password. If the authentication
succeeds then <code class="literal">smbd</code> attempts to find a UNIX user in the UNIX
password database to map the Windows user into. If this lookup fails, and
<a class="link" href="smb.conf.5.html#ADDUSERSCRIPT" target="_top">add user script</a> is set then <code class="literal">smbd</code> will
call the specified script <span class="emphasis"><em>AS ROOT</em></span>, expanding any
<em class="parameter"><code>%u</code></em> argument to be the user name to create.
</p><p>
If this script successfully creates the user then <code class="literal">smbd</code> will
continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to
match existing Windows NT accounts.
</p><p>
See also <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security</a>, <a class="link" href="smb.conf.5.html#PASSWORDSERVER" target="_top">password server</a>,
<a class="link" href="smb.conf.5.html#DELETEUSERSCRIPT" target="_top">delete user script</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add user script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add user script</code></em> = <code class="literal">/usr/local/samba/bin/add_user %u</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="add user to group script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2540666"></a>
add user to group script (G)
</h3></div></div></div><a class="indexterm" name="id2540667"></a><a name="ADDUSERTOGROUPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
Full path to the script that will be called when a user is added to a group using the Windows NT domain administration
tools. It will be run by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
<span class="emphasis"><em>AS ROOT</em></span>. Any <em class="parameter"><code>%g</code></em> will be replaced with the group name and
any <em class="parameter"><code>%u</code></em> will be replaced with the user name.
</p><p>
Note that the <code class="literal">adduser</code> command used in the example below does
not support the used syntax on all systems.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add user to group script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add user to group script</code></em> = <code class="literal">/usr/sbin/adduser %u %g</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="administrative share (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2540753"></a>
administrative share (S)
</h3></div></div></div><a class="indexterm" name="id2540754"></a><a name="ADMINISTRATIVESHARE"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is set to <code class="constant">yes</code> for
a share, then the share will be an administrative share. The Administrative
Shares are the default network shares created by all Windows NT-based
operating systems. These are shares like C$, D$ or ADMIN$. The type of these
shares is STYPE_DISKTREE_HIDDEN.</p><p>See the section below on <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security</a> for more
information about this option.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>administrative share</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="admin users (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2540811"></a>
admin users (S)
</h3></div></div></div><a class="indexterm" name="id2540812"></a><a name="ADMINUSERS"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of users who will be granted
administrative privileges on the share. This means that they
will do all file operations as the super-user (root).</p><p>You should use this option very carefully, as any user in
this list will be able to do anything they like on the share,
irrespective of file permissions.</p><p>This parameter will not work with the <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security = share</a> in
Samba 3.0. This is by design.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>admin users</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>admin users</code></em> = <code class="literal">jason</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="afs share (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2540883"></a>
afs share (S)
</h3></div></div></div><a class="indexterm" name="id2540884"></a><a name="AFSSHARE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether special AFS features are enabled
for this share. If enabled, it assumes that the directory exported via
the <em class="parameter"><code>path</code></em> parameter is a local AFS import. The
special AFS features include the attempt to hand-craft an AFS token
if you enabled --with-fake-kaserver in configure.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>afs share</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="afs username map (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2540931"></a>
afs username map (G)
</h3></div></div></div><a class="indexterm" name="id2540932"></a><a name="AFSUSERNAMEMAP"></a><div class="variablelist"><dl><dt></dt><dd><p>If you are using the fake kaserver AFS feature, you might
want to hand-craft the usernames you are creating tokens for.
For example this is necessary if you have users from several domain
in your AFS Protection Database. One possible scheme to code users
as DOMAIN+User as it is done by winbind with the + as a separator.
</p><p>The mapped user name must contain the cell name to log into,
so without setting this parameter there will be no token.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>afs username map</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>afs username map</code></em> = <code class="literal">%u@afs.samba.org</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="aio read size (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2540993"></a>
aio read size (S)
</h3></div></div></div><a class="indexterm" name="id2540994"></a><a name="AIOREADSIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>If Samba has been built with asynchronous I/O support and this
integer parameter is set to non-zero value,
Samba will read from file asynchronously when size of request is bigger
than this value. Note that it happens only for non-chained and non-chaining
reads and when not using write cache.</p><p>Current implementation of asynchronous I/O in Samba 3.0 does support
only up to 10 outstanding asynchronous requests, read and write combined.</p><p>Related command: <a class="link" href="smb.conf.5.html#WRITECACHESIZE" target="_top">write cache size</a></p><p>Related command: <a class="link" href="smb.conf.5.html#AIOWRITESIZE" target="_top">aio write size</a></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>aio read size</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>aio read size</code></em> = <code class="literal">16384
# Use asynchronous I/O for reads bigger than 16KB
request size</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="aio write behind (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2541080"></a>
aio write behind (S)
</h3></div></div></div><a class="indexterm" name="id2541081"></a><a name="AIOWRITEBEHIND"></a><div class="variablelist"><dl><dt></dt><dd><p>If Samba has been built with asynchronous I/O support,
Samba will not wait until write requests are finished before returning
the result to the client for files listed in this parameter.
Instead, Samba will immediately return that the write
request has been finished successfully, no matter if the
operation will succeed or not. This might speed up clients without
aio support, but is really dangerous, because data could be lost
and files could be damaged.
</p><p>
The syntax is identical to the <a class="link" href="smb.conf.5.html#VETOFILES" target="_top">veto files</a>
parameter.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>aio write behind</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>aio write behind</code></em> = <code class="literal">/*.tmp/</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="aio write size (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2541159"></a>
aio write size (S)
</h3></div></div></div><a class="indexterm" name="id2541160"></a><a name="AIOWRITESIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>If Samba has been built with asynchronous I/O support and this
integer parameter is set to non-zero value,
Samba will write to file asynchronously when size of request is bigger
than this value. Note that it happens only for non-chained and non-chaining
reads and when not using write cache.</p><p>Current implementation of asynchronous I/O in Samba 3.0 does support
only up to 10 outstanding asynchronous requests, read and write combined.</p><p>Related command: <a class="link" href="smb.conf.5.html#WRITECACHESIZE" target="_top">write cache size</a></p><p>Related command: <a class="link" href="smb.conf.5.html#AIOREADSIZE" target="_top">aio read size</a></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>aio write size</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>aio write size</code></em> = <code class="literal">16384
# Use asynchronous I/O for writes bigger than 16KB
request size</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="algorithmic rid base (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2541245"></a>
algorithmic rid base (G)
</h3></div></div></div><a class="indexterm" name="id2541246"></a><a name="ALGORITHMICRIDBASE"></a><div class="variablelist"><dl><dt></dt><dd><p>This determines how Samba will use its
algorithmic mapping from uids/gid to the RIDs needed to construct
NT Security Identifiers.
</p><p>Setting this option to a larger value could be useful to sites
transitioning from WinNT and Win2k, as existing user and
group rids would otherwise clash with sytem users etc.
</p><p>All UIDs and GIDs must be able to be resolved into SIDs for
the correct operation of ACLs on the server. As such the algorithmic
mapping can't be 'turned off', but pushing it 'out of the way' should
resolve the issues. Users and groups can then be assigned 'low' RIDs
in arbitrary-rid supporting backends.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>algorithmic rid base</code></em> = <code class="literal">1000</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>algorithmic rid base</code></em> = <code class="literal">100000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="allocation roundup size (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2541315"></a>
allocation roundup size (S)
</h3></div></div></div><a class="indexterm" name="id2541316"></a><a name="ALLOCATIONROUNDUPSIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter allows an administrator to tune the
allocation size reported to Windows clients. The default
size of 1Mb generally results in improved Windows client
performance. However, rounding the allocation size may cause
difficulties for some applications, e.g. MS Visual Studio.
If the MS Visual Studio compiler starts to crash with an
internal error, set this parameter to zero for this share.
</p><p>The integer parameter specifies the roundup size in bytes.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>allocation roundup size</code></em> = <code class="literal">1048576</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>allocation roundup size</code></em> = <code class="literal">0
# (to disable roundups)</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="allow trusted domains (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2541379"></a>
allow trusted domains (G)
</h3></div></div></div><a class="indexterm" name="id2541380"></a><a name="ALLOWTRUSTEDDOMAINS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option only takes effect when the <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security</a> option is set to
<code class="constant">server</code>, <code class="constant">domain</code> or <code class="constant">ads</code>.
If it is set to no, then attempts to connect to a resource from
a domain or workgroup other than the one which smbd is running
in will fail, even if that domain is trusted by the remote server
doing the authentication.</p><p>This is useful if you only want your Samba server to
serve resources to users in the domain it is a member of. As
an example, suppose that there are two domains DOMA and DOMB. DOMB
is trusted by DOMA, which contains the Samba server. Under normal
circumstances, a user with an account in DOMB can then access the
resources of a UNIX account with the same account name on the
Samba server even if they do not have an account in DOMA. This
can make implementing a security boundary difficult.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>allow trusted domains</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="announce as (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2541452"></a>
announce as (G)
</h3></div></div></div><a class="indexterm" name="id2541453"></a><a name="ANNOUNCEAS"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies what type of server <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will announce itself as, to a network neighborhood browse
list. By default this is set to Windows NT. The valid options
are : "NT Server" (which can also be written as "NT"),
"NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
Windows NT Workstation, Windows 95 and Windows for Workgroups
respectively. Do not change this parameter unless you have a
specific need to stop Samba appearing as an NT server as this
may prevent Samba servers from participating as browser servers
correctly.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>announce as</code></em> = <code class="literal">NT Server</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>announce as</code></em> = <code class="literal">Win95</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="announce version (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2541521"></a>
announce version (G)
</h3></div></div></div><a class="indexterm" name="id2541522"></a><a name="ANNOUNCEVERSION"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies the major and minor version numbers
that nmbd will use when announcing itself as a server. The default
is 4.9. Do not change this parameter unless you have a specific
need to set a Samba server to be a downlevel server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>announce version</code></em> = <code class="literal">4.9</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>announce version</code></em> = <code class="literal">2.0</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="auth methods (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2541578"></a>
auth methods (G)
</h3></div></div></div><a class="indexterm" name="id2541579"></a><a name="AUTHMETHODS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option allows the administrator to chose what authentication methods <code class="literal">smbd</code>
will use when authenticating a user. This option defaults to sensible values based on <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security</a>.
This should be considered a developer option and used only in rare circumstances. In the majority (if not all)
of production servers, the default setting should be adequate.
</p><p>
Each entry in the list attempts to authenticate the user in turn, until
the user authenticates. In practice only one method will ever actually
be able to complete the authentication.
</p><p>
Possible options include <code class="constant">guest</code> (anonymous access),
<code class="constant">sam</code> (lookups in local list of accounts based on netbios
name or domain name), <code class="constant">winbind</code> (relay authentication requests
for remote users through winbindd), <code class="constant">ntdomain</code> (pre-winbindd
method of authentication for remote domain users; deprecated in favour of winbind method),
<code class="constant">trustdomain</code> (authenticate trusted users by contacting the
remote DC directly from smbd; deprecated in favour of winbind method).
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>auth methods</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>auth methods</code></em> = <code class="literal">guest sam winbind</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="available (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2541684"></a>
available (S)
</h3></div></div></div><a class="indexterm" name="id2541685"></a><a name="AVAILABLE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter lets you "turn off" a service. If
<em class="parameter"><code>available = no</code></em>, then <span class="emphasis"><em>ALL</em></span>
attempts to connect to the service will fail. Such failures are
logged.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>available</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="bind interfaces only (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2541731"></a>
bind interfaces only (G)
</h3></div></div></div><a class="indexterm" name="id2541732"></a><a name="BINDINTERFACESONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>This global parameter allows the Samba admin
to limit what interfaces on a machine will serve SMB requests. It
affects file service <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and name service <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> in a slightly different ways.</p><p>
For name service it causes <code class="literal">nmbd</code> to bind to ports 137 and 138 on the
interfaces listed in the <a class="link" href="smb.conf.5.html#INTERFACES" target="_top">interfaces</a> parameter. <code class="literal">nmbd</code>
also binds to the "all addresses" interface (0.0.0.0) on ports 137 and 138 for the purposes of
reading broadcast messages. If this option is not set then <code class="literal">nmbd</code> will
service name requests on all of these sockets. If <a class="link" href="smb.conf.5.html#BINDINTERFACESONLY" target="_top">bind interfaces only</a> is set then
<code class="literal">nmbd</code> will check the source address of any packets coming in on the
broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the
<a class="link" href="smb.conf.5.html#INTERFACES" target="_top">interfaces</a> parameter list. As unicast packets are received on the other sockets it
allows <code class="literal">nmbd</code> to refuse to serve names to machines that send packets that
arrive through any interfaces not listed in the <a class="link" href="smb.conf.5.html#INTERFACES" target="_top">interfaces</a> list. IP Source address
spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
<code class="literal">nmbd</code>.
</p><p>
For file service it causes <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to bind only to the interface list given in the <a class="link" href="smb.conf.5.html#INTERFACES" target="_top">interfaces</a> parameter. This restricts the networks that <code class="literal">smbd</code> will
serve, to packets coming in on those interfaces. Note that you should not use this parameter for machines that
are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with
non-permanent interfaces.
</p><p>
If <a class="link" href="smb.conf.5.html#BINDINTERFACESONLY" target="_top">bind interfaces only</a> is set and the network address
<span class="emphasis"><em>127.0.0.1</em></span> is not added to the <a class="link" href="smb.conf.5.html#INTERFACES" target="_top">interfaces</a> parameter list
<a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> and
<a class="citerefentry" href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a> may not work as
expected due to the reasons covered below.
</p><p>
To change a users SMB password, the <code class="literal">smbpasswd</code> by default connects to the
<span class="emphasis"><em>localhost - 127.0.0.1</em></span> address as an SMB client to issue the password change request. If
<a class="link" href="smb.conf.5.html#BINDINTERFACESONLY" target="_top">bind interfaces only</a> is set then unless the network address
<span class="emphasis"><em>127.0.0.1</em></span> is added to the <a class="link" href="smb.conf.5.html#INTERFACES" target="_top">interfaces</a> parameter list then <code class="literal"> smbpasswd</code> will fail to connect in it's default mode. <code class="literal">smbpasswd</code> can be forced to use the primary IP interface of the local host by using
its <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> <em class="parameter"><code>-r <em class="replaceable"><code>remote machine</code></em></code></em> parameter, with <em class="replaceable"><code>remote
machine</code></em> set to the IP name of the primary interface of the local host.
</p><p>
The <code class="literal">swat</code> status page tries to connect with <code class="literal">smbd</code> and <code class="literal">nmbd</code> at the address
<span class="emphasis"><em>127.0.0.1</em></span> to determine if they are running. Not adding <span class="emphasis"><em>127.0.0.1</em></span>
will cause <code class="literal"> smbd</code> and <code class="literal">nmbd</code> to always show
"not running" even if they really are. This can prevent <code class="literal"> swat</code>
from starting/stopping/restarting <code class="literal">smbd</code> and <code class="literal">nmbd</code>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>bind interfaces only</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="blocking locks (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542058"></a>
blocking locks (S)
</h3></div></div></div><a class="indexterm" name="id2542059"></a><a name="BLOCKINGLOCKS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls the behavior
of <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when given a request by a client
to obtain a byte range lock on a region of an open file, and the
request has a time limit associated with it.</p><p>If this parameter is set and the lock range requested
cannot be immediately satisfied, samba will internally
queue the lock request, and periodically attempt to obtain
the lock until the timeout period expires.</p><p>If this parameter is set to <code class="constant">no</code>, then
samba will behave as previous versions of Samba would and
will fail the lock request immediately if the lock range
cannot be obtained.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>blocking locks</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="block size (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542122"></a>
block size (S)
</h3></div></div></div><a class="indexterm" name="id2542124"></a><a name="BLOCKSIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls the behavior of <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when reporting disk free
sizes. By default, this reports a disk block size of 1024 bytes.
</p><p>Changing this parameter may have some effect on the
efficiency of client writes, this is not yet confirmed. This
parameter was added to allow advanced administrators to change
it (usually to a higher value) and test the effect it has on
client write performance without re-compiling the code. As this
is an experimental option it may be removed in a future release.
</p><p>Changing this option does not change the disk free reporting
size, just the block size unit reported to the client.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>block size</code></em> = <code class="literal">1024</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>block size</code></em> = <code class="literal">4096</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="browsable"><div class="titlepage"><div><div><h3 class="title"><a name="id2542200"></a>
<a name="BROWSABLE"></a>browsable
</h3></div></div></div><a class="indexterm" name="id2542202"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#BROWSEABLE">browseable</a>.</p></dd></dl></div></div><div class="section" title="browseable (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542227"></a>
browseable (S)
</h3></div></div></div><a class="indexterm" name="id2542228"></a><a name="BROWSEABLE"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether this share is seen in
the list of available shares in a net view and in the browse list.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>browseable</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="browse list (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542266"></a>
browse list (G)
</h3></div></div></div><a class="indexterm" name="id2542267"></a><a name="BROWSELIST"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will serve a browse list to
a client doing a <code class="literal">NetServerEnum</code> call. Normally
set to <code class="constant">yes</code>. You should never need to change
this.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>browse list</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="cache directory (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542321"></a>
cache directory (G)
</h3></div></div></div><a class="indexterm" name="id2542322"></a><a name="CACHEDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>Usually, most of the TDB files are stored in the <em class="parameter"><code>lock directory</code></em>. Since Samba 3.4.0, it is
possible to differentiate between TDB files with persistent data and
TDB files with non-persistent data using the
<em class="parameter"><code>state directory</code></em> and the
<em class="parameter"><code>cache directory</code></em> options.
</p><p> This option specifies the directory where TDB files containing
non-persistent data will be stored.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>cache directory</code></em> = <code class="literal">${prefix}/var/locks</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cache directory</code></em> = <code class="literal">/var/run/samba/locks/cache</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="casesignames"><div class="titlepage"><div><div><h3 class="title"><a name="id2542397"></a>
<a name="CASESIGNAMES"></a>casesignames
</h3></div></div></div><a class="indexterm" name="id2542398"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#CASESENSITIVE">case sensitive</a>.</p></dd></dl></div></div><div class="section" title="case sensitive (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542424"></a>
case sensitive (S)
</h3></div></div></div><a class="indexterm" name="id2542425"></a><a name="CASESENSITIVE"></a><div class="variablelist"><dl><dt></dt><dd><p>See the discussion in the section <a class="link" href="smb.conf.5.html#NAMEMANGLING" target="_top">name mangling</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>case sensitive</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="change notify (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542471"></a>
change notify (S)
</h3></div></div></div><a class="indexterm" name="id2542472"></a><a name="CHANGENOTIFY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether Samba should reply
to a client's file change notify requests.
</p><p>You should never need to change this parameter</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>change notify</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="change share command (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542514"></a>
change share command (G)
</h3></div></div></div><a class="indexterm" name="id2542515"></a><a name="CHANGESHARECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>
Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
Manager. The <em class="parameter"><code>change share command</code></em> is used to define an external
program or script which will modify an existing service definition in <code class="filename">smb.conf</code>.
</p><p>
In order to successfully execute the
<em class="parameter"><code>change share command</code></em>,
<code class="literal">smbd</code> requires that the administrator
connects using a root account (i.e. uid == 0) or has the
<code class="literal">SeDiskOperatorPrivilege</code>.
Scripts defined in the <em class="parameter"><code>change share command</code></em>
parameter are executed as root.
</p><p>
When executed, <code class="literal">smbd</code> will automatically invoke the
<em class="parameter"><code>change share command</code></em> with five parameters.
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>configFile</code></em> - the location
of the global <code class="filename">smb.conf</code> file.
</p></li><li class="listitem"><p><em class="parameter"><code>shareName</code></em> - the name of the new
share.
</p></li><li class="listitem"><p><em class="parameter"><code>pathName</code></em> - path to an **existing**
directory on disk.
</p></li><li class="listitem"><p><em class="parameter"><code>comment</code></em> - comment string to associate
with the new share.
</p></li><li class="listitem"><p><em class="parameter"><code>max
connections</code></em>
Number of maximum simultaneous connections to this
share.
</p></li></ul></div><p>
This parameter is only used to modify existing file share definitions.
To modify printer shares, use the "Printers..." folder as seen
when browsing the Samba host.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>change share command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>change share command</code></em> = <code class="literal">/usr/local/bin/changeshare</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="check password script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542692"></a>
check password script (G)
</h3></div></div></div><a class="indexterm" name="id2542693"></a><a name="CHECKPASSWORDSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>The name of a program that can be used to check password
complexity. The password is sent to the program's standard input.</p><p>The program must return 0 on a good password, or any other value
if the password is bad.
In case the password is considered weak (the program does not return 0) the
user will be notified and the password change will fail.</p><p>Note: In the example directory is a sample program called <code class="literal">crackcheck</code>
that uses cracklib to check the password quality.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>check password script</code></em> = <code class="literal">Disabled</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>check password script</code></em> = <code class="literal">/usr/local/sbin/crackcheck</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="client lanman auth (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542766"></a>
client lanman auth (G)
</h3></div></div></div><a class="indexterm" name="id2542767"></a><a name="CLIENTLANMANAUTH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines whether or not <a class="citerefentry" href="smbclient.8.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(8)</span></a> and other samba client
tools will attempt to authenticate itself to servers using the
weaker LANMAN password hash. If disabled, only server which support NT
password hashes (e.g. Windows NT/2000, Samba, etc... but not
Windows 95/98) will be able to be connected from the Samba client.</p><p>The LANMAN encrypted response is easily broken, due to its
case-insensitive nature, and the choice of algorithm. Clients
without Windows 95/98 servers are advised to disable
this option. </p><p>Disabling this option will also disable the <code class="literal">client plaintext auth</code> option.</p><p>Likewise, if the <code class="literal">client ntlmv2
auth</code> parameter is enabled, then only NTLMv2 logins will be
attempted.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client lanman auth</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="client ldap sasl wrapping (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542842"></a>
client ldap sasl wrapping (G)
</h3></div></div></div><a class="indexterm" name="id2542843"></a><a name="CLIENTLDAPSASLWRAPPING"></a><div class="variablelist"><dl><dt></dt><dd><p>
The <a class="link" href="smb.conf.5.html#CLIENTLDAPSASLWRAPPING" target="_top">client ldap sasl wrapping</a> defines whether
ldap traffic will be signed or signed and encrypted (sealed).
Possible values are <span class="emphasis"><em>plain</em></span>, <span class="emphasis"><em>sign</em></span>
and <span class="emphasis"><em>seal</em></span>.
</p><p>
The values <span class="emphasis"><em>sign</em></span> and <span class="emphasis"><em>seal</em></span> are
only available if Samba has been compiled against a modern
OpenLDAP version (2.3.x or higher).
</p><p>
This option is needed in the case of Domain Controllers enforcing
the usage of signed LDAP connections (e.g. Windows 2000 SP3 or higher).
LDAP sign and seal can be controlled with the registry key
"<code class="literal">HKLM\System\CurrentControlSet\Services\</code>
<code class="literal">NTDS\Parameters\LDAPServerIntegrity</code>"
on the Windows server side.
</p><p>
Depending on the used KRB5 library (MIT and older Heimdal versions)
it is possible that the message "integrity only" is not supported.
In this case, <span class="emphasis"><em>sign</em></span> is just an alias for
<span class="emphasis"><em>seal</em></span>.
</p><p>
The default value is <span class="emphasis"><em>plain</em></span> which is not irritable
to KRB5 clock skew errors. That implies synchronizing the time
with the KDC in the case of using <span class="emphasis"><em>sign</em></span> or
<span class="emphasis"><em>seal</em></span>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client ldap sasl wrapping</code></em> = <code class="literal">plain</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="client ntlmv2 auth (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2542957"></a>
client ntlmv2 auth (G)
</h3></div></div></div><a class="indexterm" name="id2542958"></a><a name="CLIENTNTLMV2AUTH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines whether or not <a class="citerefentry" href="smbclient.8.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(8)</span></a> will attempt to
authenticate itself to servers using the NTLMv2 encrypted password
response.</p><p>If enabled, only an NTLMv2 and LMv2 response (both much more
secure than earlier versions) will be sent. Many servers
(including NT4 < SP4, Win9x and Samba 2.2) are not compatible with
NTLMv2. </p><p>Similarly, if enabled, NTLMv1, <code class="literal">client lanman auth</code> and <code class="literal">client plaintext auth</code>
authentication will be disabled. This also disables share-level
authentication. </p><p>If disabled, an NTLM response (and possibly a LANMAN response)
will be sent by the client, depending on the value of <code class="literal">client lanman auth</code>. </p><p>Note that some sites (particularly
those following 'best practice' security polices) only allow NTLMv2
responses, and not the weaker LM or NTLM.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client ntlmv2 auth</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="client plaintext auth (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543045"></a>
client plaintext auth (G)
</h3></div></div></div><a class="indexterm" name="id2543046"></a><a name="CLIENTPLAINTEXTAUTH"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies whether a client should send a plaintext
password if the server does not support encrypted passwords.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client plaintext auth</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="client schannel (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543084"></a>
client schannel (G)
</h3></div></div></div><a class="indexterm" name="id2543085"></a><a name="CLIENTSCHANNEL"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls whether the client offers or even demands the use of the netlogon schannel.
<a class="link" href="smb.conf.5.html#CLIENTSCHANNEL" target="_top">client schannel = no</a> does not offer the schannel,
<a class="link" href="smb.conf.5.html#CLIENTSCHANNEL" target="_top">client schannel = auto</a> offers the schannel but does not
enforce it, and <a class="link" href="smb.conf.5.html#CLIENTSCHANNEL" target="_top">client schannel = yes</a> denies access
if the server is not able to speak netlogon schannel.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client schannel</code></em> = <code class="literal">auto</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>client schannel</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="client signing (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543168"></a>
client signing (G)
</h3></div></div></div><a class="indexterm" name="id2543169"></a><a name="CLIENTSIGNING"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether the client is allowed or required to use SMB signing. Possible values
are <span class="emphasis"><em>auto</em></span>, <span class="emphasis"><em>mandatory</em></span>
and <span class="emphasis"><em>disabled</em></span>.
</p><p>When set to auto, SMB signing is offered, but not enforced.
When set to mandatory, SMB signing is required and if set
to disabled, SMB signing is not offered either.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client signing</code></em> = <code class="literal">auto</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="client use spnego (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543222"></a>
client use spnego (G)
</h3></div></div></div><a class="indexterm" name="id2543224"></a><a name="CLIENTUSESPNEGO"></a><div class="variablelist"><dl><dt></dt><dd><p> This variable controls whether Samba clients will try
to use Simple and Protected NEGOciation (as specified by rfc2478) with
supporting servers (including WindowsXP, Windows2000 and Samba
3.0) to agree upon an authentication
mechanism. This enables Kerberos authentication in particular.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client use spnego</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="cluster addresses (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543264"></a>
cluster addresses (G)
</h3></div></div></div><a class="indexterm" name="id2543266"></a><a name="CLUSTERADDRESSES"></a><div class="variablelist"><dl><dt></dt><dd><p>With this parameter you can add additional addresses
nmbd will register with a WINS server. These addresses are not
necessarily present on all nodes simultaneously, but they will
be registered with the WINS server so that clients can contact
any of the nodes.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>cluster addresses</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cluster addresses</code></em> = <code class="literal">10.0.0.1 10.0.0.2 10.0.0.3</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="clustering (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543320"></a>
clustering (G)
</h3></div></div></div><a class="indexterm" name="id2543322"></a><a name="CLUSTERING"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether Samba should contact
ctdb for accessing its tdb files and use ctdb as a backend
for its messaging backend.
</p><p>Set this parameter to <code class="literal">yes</code> only if
you have a cluster setup with ctdb running.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>clustering</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="comment (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543369"></a>
comment (S)
</h3></div></div></div><a class="indexterm" name="id2543370"></a><a name="COMMENT"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a text field that is seen next to a share
when a client does a queries the server, either via the network
neighborhood or via <code class="literal">net view</code> to list what shares
are available.</p><p>If you want to set the string that is displayed next to the
machine name then see the <a class="link" href="smb.conf.5.html#SERVERSTRING" target="_top">server string</a> parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>comment</code></em> = <code class="literal">
# No comment</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>comment</code></em> = <code class="literal">Fred's Files</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="config backend (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543444"></a>
config backend (G)
</h3></div></div></div><a class="indexterm" name="id2543445"></a><a name="CONFIGBACKEND"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls the backend for storing the configuration.
Possible values are <span class="emphasis"><em>file</em></span> (the default)
and <span class="emphasis"><em>registry</em></span>.
When <a class="link" href="smb.conf.5.html#CONFIGBACKEND" target="_top">config backend = registry</a>
is encountered while loading <span class="emphasis"><em>smb.conf</em></span>,
the configuration read so far is dropped and the global
options are read from registry instead. So this triggers a
registry only configuration. Share definitions are not read
immediately but instead <em class="parameter"><code>registry
shares</code></em> is set to <span class="emphasis"><em>yes</em></span>.
</p><p>
Note: This option can not be set inside the registry
configuration itself.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>config backend</code></em> = <code class="literal">file</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>config backend</code></em> = <code class="literal">registry</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="config file (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543533"></a>
config file (G)
</h3></div></div></div><a class="indexterm" name="id2543534"></a><a name="CONFIGFILE"></a><div class="variablelist"><dl><dt></dt><dd><p>This allows you to override the config file
to use, instead of the default (usually <code class="filename">smb.conf</code>).
There is a chicken and egg problem here as this option is set
in the config file!</p><p>For this reason, if the name of the config file has changed
when the parameters are loaded then it will reload them from
the new config file.</p><p>This option takes the usual substitutions, which can
be very useful.</p><p>If the config file doesn't exist then it won't be loaded
(allowing you to special case the config files of just a few
clients).</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>config file</code></em> = <code class="literal">/usr/local/samba/lib/smb.conf.%m</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="copy (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543598"></a>
copy (S)
</h3></div></div></div><a class="indexterm" name="id2543599"></a><a name="COPY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter allows you to "clone" service
entries. The specified service is simply duplicated under the
current service's name. Any parameters specified in the current
section will override those in the section being copied.</p><p>This feature lets you set up a 'template' service and
create similar services easily. Note that the service being
copied must occur earlier in the configuration file than the
service doing the copying.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>copy</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>copy</code></em> = <code class="literal">otherservice</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="create mode"><div class="titlepage"><div><div><h3 class="title"><a name="id2543660"></a>
<a name="CREATEMODE"></a>create mode
</h3></div></div></div><a class="indexterm" name="id2543662"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#CREATEMASK">create mask</a>.</p></dd></dl></div></div><div class="section" title="create mask (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543687"></a>
create mask (S)
</h3></div></div></div><a class="indexterm" name="id2543688"></a><a name="CREATEMASK"></a><div class="variablelist"><dl><dt></dt><dd><p>
When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to
UNIX permissions, and the resulting UNIX mode is then bit-wise 'AND'ed with this parameter. This parameter may
be thought of as a bit-wise MASK for the UNIX modes of a file. Any bit <span class="emphasis"><em>not</em></span> set here will
be removed from the modes set on a file when it is created.
</p><p>
The default value of this parameter removes the <code class="literal">group</code> and <code class="literal">other</code>
write and execute bits from the UNIX modes.
</p><p>
Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the
<a class="link" href="smb.conf.5.html#FORCECREATEMODE" target="_top">force create mode</a> parameter which is set to 000 by default.
</p><p>
This parameter does not affect directory masks. See the parameter <a class="link" href="smb.conf.5.html#DIRECTORYMASK" target="_top">directory mask</a>
for details.
</p><p>
Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the
administrator wishes to enforce a mask on access control lists also, they need to set the <a class="link" href="smb.conf.5.html#SECURITYMASK" target="_top">security mask</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>create mask</code></em> = <code class="literal">0744</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>create mask</code></em> = <code class="literal">0775</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="csc policy (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543809"></a>
csc policy (S)
</h3></div></div></div><a class="indexterm" name="id2543810"></a><a name="CSCPOLICY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This stands for <span class="emphasis"><em>client-side caching policy</em></span>, and specifies how clients capable of offline
caching will cache the files in the share. The valid values are: manual, documents, programs, disable.
</p><p>
These values correspond to those used on Windows servers.
</p><p>
For example, shares containing roaming profiles can have offline caching disabled using
<a class="link" href="smb.conf.5.html#CSCPOLICY" target="_top">csc policy = disable</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>csc policy</code></em> = <code class="literal">manual</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>csc policy</code></em> = <code class="literal">programs</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ctdbd socket (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543884"></a>
ctdbd socket (G)
</h3></div></div></div><a class="indexterm" name="id2543885"></a><a name="CTDBDSOCKET"></a><div class="variablelist"><dl><dt></dt><dd><p>If you set <code class="literal">clustering=yes</code>,
you need to tell Samba where ctdbd listens on its unix domain
socket. The default path as of ctdb 1.0 is /tmp/ctdb.socket which
you have to explicitly set for Samba in smb.conf.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ctdbd socket</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ctdbd socket</code></em> = <code class="literal">/tmp/ctdb.socket</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="cups connection timeout (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2543944"></a>
cups connection timeout (G)
</h3></div></div></div><a class="indexterm" name="id2543945"></a><a name="CUPSCONNECTIONTIMEOUT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter is only applicable if <a class="link" href="smb.conf.5.html#PRINTING" target="_top">printing</a> is set to <code class="constant">cups</code>.
</p><p>
If set, this option specifies the number of seconds that smbd will wait
whilst trying to contact to the CUPS server. The connection will fail
if it takes longer than this number of seconds.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>cups connection timeout</code></em> = <code class="literal">30</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cups connection timeout</code></em> = <code class="literal">60</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="cups options (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544016"></a>
cups options (S)
</h3></div></div></div><a class="indexterm" name="id2544017"></a><a name="CUPSOPTIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter is only applicable if <a class="link" href="smb.conf.5.html#PRINTING" target="_top">printing</a> is
set to <code class="constant">cups</code>. Its value is a free form string of options
passed directly to the cups library.
</p><p>
You can pass any generic print option known to CUPS (as listed
in the CUPS "Software Users' Manual"). You can also pass any printer
specific option (as listed in "lpoptions -d printername -l")
valid for the target queue.
Multiple parameters should be space-delimited name/value pairs according to
the PAPI text option ABNF specification. Collection values
("name={a=... b=... c=...}") are stored with the curley brackets intact.
</p><p>
You should set this parameter to <code class="constant">raw</code> if your CUPS server
<code class="filename">error_log</code> file contains messages such as
"Unsupported format 'application/octet-stream'" when printing from a Windows client
through Samba. It is no longer necessary to enable
system wide raw printing in <code class="filename">/etc/cups/mime.{convs,types}</code>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>cups options</code></em> = <code class="literal">""</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cups options</code></em> = <code class="literal">"raw media=a4"</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="cups server (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2487373"></a>
cups server (G)
</h3></div></div></div><a class="indexterm" name="id2487374"></a><a name="CUPSSERVER"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter is only applicable if <a class="link" href="smb.conf.5.html#PRINTING" target="_top">printing</a> is set to <code class="constant">cups</code>.
</p><p>
If set, this option overrides the ServerName option in the CUPS <code class="filename">client.conf</code>. This is
necessary if you have virtual samba servers that connect to different CUPS daemons.
</p><p>Optionally, a port can be specified by separating the server name
and port number with a colon. If no port was specified,
the default port for IPP (631) will be used.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>cups server</code></em> = <code class="literal">""</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cups server</code></em> = <code class="literal">mycupsserver</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cups server</code></em> = <code class="literal">mycupsserver:1631</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="deadtime (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544360"></a>
deadtime (G)
</h3></div></div></div><a class="indexterm" name="id2544361"></a><a name="DEADTIME"></a><div class="variablelist"><dl><dt></dt><dd><p>The value of the parameter (a decimal integer)
represents the number of minutes of inactivity before a connection
is considered dead, and it is disconnected. The deadtime only takes
effect if the number of open files is zero.</p><p>This is useful to stop a server's resources being
exhausted by a large number of inactive connections.</p><p>Most clients have an auto-reconnect feature when a
connection is broken so in most cases this parameter should be
transparent to users.</p><p>Using this parameter with a timeout of a few minutes
is recommended for most systems.</p><p>A deadtime of zero indicates that no auto-disconnection
should be performed.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>deadtime</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>deadtime</code></em> = <code class="literal">15</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="debug class (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544437"></a>
debug class (G)
</h3></div></div></div><a class="indexterm" name="id2544438"></a><a name="DEBUGCLASS"></a><div class="variablelist"><dl><dt></dt><dd><p>
With this boolean parameter enabled, the debug class (DBGC_CLASS)
will be displayed in the debug header.
</p><p>
For more information about currently available debug classes, see
section about <a class="link" href="smb.conf.5.html#LOGLEVEL" target="_top">log level</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug class</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="debug hires timestamp (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544488"></a>
debug hires timestamp (G)
</h3></div></div></div><a class="indexterm" name="id2544489"></a><a name="DEBUGHIRESTIMESTAMP"></a><div class="variablelist"><dl><dt></dt><dd><p>
Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this
boolean parameter adds microsecond resolution to the timestamp message header when turned on.
</p><p>
Note that the parameter <a class="link" href="smb.conf.5.html#DEBUGTIMESTAMP" target="_top">debug timestamp</a> must be on for this to have an effect.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug hires timestamp</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="debug pid (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544543"></a>
debug pid (G)
</h3></div></div></div><a class="indexterm" name="id2544544"></a><a name="DEBUGPID"></a><div class="variablelist"><dl><dt></dt><dd><p>
When using only one log file for more then one forked <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>-process there may be hard to follow which process outputs which
message. This boolean parameter is adds the process-id to the timestamp message headers in the
logfile when turned on.
</p><p>
Note that the parameter <a class="link" href="smb.conf.5.html#DEBUGTIMESTAMP" target="_top">debug timestamp</a> must be on for this to have an effect.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug pid</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="debug prefix timestamp (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544605"></a>
debug prefix timestamp (G)
</h3></div></div></div><a class="indexterm" name="id2544606"></a><a name="DEBUGPREFIXTIMESTAMP"></a><div class="variablelist"><dl><dt></dt><dd><p>
With this option enabled, the timestamp message header is prefixed to the debug message without the
filename and function information that is included with the <a class="link" href="smb.conf.5.html#DEBUGTIMESTAMP" target="_top">debug timestamp</a>
parameter. This gives timestamps to the messages without adding an additional line.
</p><p>
Note that this parameter overrides the <a class="link" href="smb.conf.5.html#DEBUGTIMESTAMP" target="_top">debug timestamp</a> parameter.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug prefix timestamp</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="timestamp logs"><div class="titlepage"><div><div><h3 class="title"><a name="id2544668"></a>
<a name="TIMESTAMPLOGS"></a>timestamp logs
</h3></div></div></div><a class="indexterm" name="id2544669"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#DEBUGTIMESTAMP">debug timestamp</a>.</p></dd></dl></div></div><div class="section" title="debug timestamp (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544695"></a>
debug timestamp (G)
</h3></div></div></div><a class="indexterm" name="id2544696"></a><a name="DEBUGTIMESTAMP"></a><div class="variablelist"><dl><dt></dt><dd><p>
Samba debug log messages are timestamped by default. If you are running at a high
<a class="link" href="smb.conf.5.html#DEBUGLEVEL" target="_top">debug level</a> these timestamps can be distracting. This
boolean parameter allows timestamping to be turned off.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug timestamp</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="debug uid (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544743"></a>
debug uid (G)
</h3></div></div></div><a class="indexterm" name="id2544744"></a><a name="DEBUGUID"></a><div class="variablelist"><dl><dt></dt><dd><p>
Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the
current euid, egid, uid and gid to the timestamp message headers in the log file if turned on.
</p><p>
Note that the parameter <a class="link" href="smb.conf.5.html#DEBUGTIMESTAMP" target="_top">debug timestamp</a> must be on for this to have an effect.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug uid</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="dedicated keytab file (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544797"></a>
dedicated keytab file (G)
</h3></div></div></div><a class="indexterm" name="id2544798"></a><a name="DEDICATEDKEYTABFILE"></a><div class="variablelist"><dl><dt></dt><dd><p>
Specifies the path to the kerberos keytab file when
<a class="link" href="smb.conf.5.html#KERBEROSMETHOD" target="_top">kerberos method</a> is set to "dedicated
keytab".
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dedicated keytab file</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>dedicated keytab file</code></em> = <code class="literal">/usr/local/etc/krb5.keytab</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="default case (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544860"></a>
default case (S)
</h3></div></div></div><a class="indexterm" name="id2544861"></a><a name="DEFAULTCASE"></a><div class="variablelist"><dl><dt></dt><dd><p>See the section on <a class="link" href="smb.conf.5.html#NAMEMANGLING" target="_top">name mangling</a>.
Also note the <a class="link" href="smb.conf.5.html#SHORTPRESERVECASE" target="_top">short preserve case</a> parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>default case</code></em> = <code class="literal">lower</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="default devmode (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544914"></a>
default devmode (S)
</h3></div></div></div><a class="indexterm" name="id2544915"></a><a name="DEFAULTDEVMODE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is only applicable to <a class="link" href="smb.conf.5.html#PRINTABLE" target="_top">printable</a> services.
When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba
server has a Device Mode which defines things such as paper size and
orientation and duplex settings. The device mode can only correctly be
generated by the printer driver itself (which can only be executed on a
Win32 platform). Because smbd is unable to execute the driver code
to generate the device mode, the default behavior is to set this field
to NULL.
</p><p>Most problems with serving printer drivers to Windows NT/2k/XP clients
can be traced to a problem with the generated device mode. Certain drivers
will do things such as crashing the client's Explorer.exe with a NULL devmode.
However, other printer drivers can cause the client's spooler service
(spoolsv.exe) to die if the devmode was not created by the driver itself
(i.e. smbd generates a default devmode).
</p><p>This parameter should be used with care and tested with the printer
driver in question. It is better to leave the device mode to NULL
and let the Windows client set the correct values. Because drivers do not
do this all the time, setting <code class="literal">default devmode = yes</code>
will instruct smbd to generate a default one.
</p><p>For more information on Windows NT/2k printing and Device Modes,
see the <a class="ulink" href="http://msdn.microsoft.com/" target="_top">MSDN documentation</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>default devmode</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="default"><div class="titlepage"><div><div><h3 class="title"><a name="id2545002"></a>
<a name="DEFAULT"></a>default
</h3></div></div></div><a class="indexterm" name="id2545003"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#DEFAULTSERVICE">default service</a>.</p></dd></dl></div></div><div class="section" title="default service (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545029"></a>
default service (G)
</h3></div></div></div><a class="indexterm" name="id2545030"></a><a name="DEFAULTSERVICE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the name of a service
which will be connected to if the service actually requested cannot
be found. Note that the square brackets are <span class="emphasis"><em>NOT</em></span>
given in the parameter value (see example below).</p><p>There is no default value for this parameter. If this
parameter is not given, attempting to connect to a nonexistent
service results in an error.</p><p>
Typically the default service would be a <a class="link" href="smb.conf.5.html#GUESTOK" target="_top">guest ok</a>, <a class="link" href="smb.conf.5.html#READ-ONLY" target="_top">read-only</a> service.</p><p>Also note that the apparent service name will be changed to equal
that of the requested service, this is very useful as it allows you to use macros like <em class="parameter"><code>%S</code></em> to make a wildcard service.
</p><p>Note also that any "_" characters in the name of the service
used in the default service will get mapped to a "/". This allows for
interesting things.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>default service</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>default service</code></em> = <code class="literal">pub</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="defer sharing violations (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545130"></a>
defer sharing violations (G)
</h3></div></div></div><a class="indexterm" name="id2545131"></a><a name="DEFERSHARINGVIOLATIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>
Windows allows specifying how a file will be shared with
other processes when it is opened. Sharing violations occur when
a file is opened by a different process using options that violate
the share settings specified by other processes. This parameter causes
smbd to act as a Windows server does, and defer returning a "sharing
violation" error message for up to one second, allowing the client
to close the file causing the violation in the meantime.
</p><p>UNIX by default does not have this behaviour.</p><p>
There should be no reason to turn off this parameter, as it is
designed to enable Samba to more correctly emulate Windows.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>defer sharing violations</code></em> = <code class="literal">True</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="delete group script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545185"></a>
delete group script (G)
</h3></div></div></div><a class="indexterm" name="id2545186"></a><a name="DELETEGROUPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This is the full pathname to a script that will
be run <span class="emphasis"><em>AS ROOT</em></span> <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a group is requested to be deleted.
It will expand any <em class="parameter"><code>%g</code></em> to the group name passed.
This script is only useful for installations using the Windows NT domain administration tools.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete group script</code></em> = <code class="literal"></code>
</em></span>
</p></dd></dl></div></div><div class="section" title="deleteprinter command (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545241"></a>
deleteprinter command (G)
</h3></div></div></div><a class="indexterm" name="id2545242"></a><a name="DELETEPRINTERCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>With the introduction of MS-RPC based printer
support for Windows NT/2000 clients in Samba 2.2, it is now
possible to delete a printer at run time by issuing the
DeletePrinter() RPC call.</p><p>For a Samba host this means that the printer must be
physically deleted from the underlying printing system. The
<a class="link" href="smb.conf.5.html#DELETEPRINTERCOMMAND" target="_top">deleteprinter command</a> defines a script to be run which
will perform the necessary operations for removing the printer
from the print system and from <code class="filename">smb.conf</code>.
</p><p>The <a class="link" href="smb.conf.5.html#DELETEPRINTERCOMMAND" target="_top">deleteprinter command</a> is
automatically called with only one parameter: <a class="link" href="smb.conf.5.html#PRINTERNAME" target="_top">printer name</a>.
</p><p>Once the <a class="link" href="smb.conf.5.html#DELETEPRINTERCOMMAND" target="_top">deleteprinter command</a> has
been executed, <code class="literal">smbd</code> will reparse the <code class="filename">
smb.conf</code> to check that the associated printer no longer exists.
If the sharename is still valid, then <code class="literal">smbd
</code> will return an ACCESS_DENIED error to the client.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>deleteprinter command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>deleteprinter command</code></em> = <code class="literal">/usr/bin/removeprinter</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="delete readonly (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545369"></a>
delete readonly (S)
</h3></div></div></div><a class="indexterm" name="id2545370"></a><a name="DELETEREADONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter allows readonly files to be deleted.
This is not normal DOS semantics, but is allowed by UNIX.</p><p>This option may be useful for running applications such
as rcs, where UNIX file ownership prevents changing file
permissions, and DOS semantics prevent deletion of a read only file.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete readonly</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="delete share command (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545414"></a>
delete share command (G)
</h3></div></div></div><a class="indexterm" name="id2545415"></a><a name="DELETESHARECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>
Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
Manager. The <em class="parameter"><code>delete share command</code></em> is used to define an external
program or script which will remove an existing service definition from
<code class="filename">smb.conf</code>.
</p><p>In order to successfully execute the
<em class="parameter"><code>delete share command</code></em>,
<code class="literal">smbd</code> requires that the administrator
connects using a root account (i.e. uid == 0) or has the
<code class="literal">SeDiskOperatorPrivilege</code>.
Scripts defined in the <em class="parameter"><code>delete share command</code></em>
parameter are executed as root.
</p><p>
When executed, <code class="literal">smbd</code> will automatically invoke the
<em class="parameter"><code>delete share command</code></em> with two parameters.
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>configFile</code></em> - the location
of the global <code class="filename">smb.conf</code> file.
</p></li><li class="listitem"><p><em class="parameter"><code>shareName</code></em> - the name of
the existing service.
</p></li></ul></div><p>
This parameter is only used to remove file shares. To delete printer shares,
see the <a class="link" href="smb.conf.5.html#DELETEPRINTERCOMMAND" target="_top">deleteprinter command</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete share command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>delete share command</code></em> = <code class="literal">/usr/local/bin/delshare</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="delete user from group script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545566"></a>
delete user from group script (G)
</h3></div></div></div><a class="indexterm" name="id2545567"></a><a name="DELETEUSERFROMGROUPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>Full path to the script that will be called when
a user is removed from a group using the Windows NT domain administration
tools. It will be run by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> <span class="emphasis"><em>AS ROOT</em></span>.
Any <em class="parameter"><code>%g</code></em> will be replaced with the group name and
any <em class="parameter"><code>%u</code></em> will be replaced with the user name.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete user from group script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>delete user from group script</code></em> = <code class="literal">/usr/sbin/deluser %u %g</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="delete user script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545645"></a>
delete user script (G)
</h3></div></div></div><a class="indexterm" name="id2545646"></a><a name="DELETEUSERSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This is the full pathname to a script that will
be run by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when managing users
with remote RPC (NT) tools.
</p><p>This script is called when a remote client removes a user
from the server, normally using 'User Manager for Domains' or
<code class="literal">rpcclient</code>.</p><p>This script should delete the given UNIX username.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete user script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>delete user script</code></em> = <code class="literal">/usr/local/samba/bin/del_user %u</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="delete veto files (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545722"></a>
delete veto files (S)
</h3></div></div></div><a class="indexterm" name="id2545723"></a><a name="DELETEVETOFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>This option is used when Samba is attempting to
delete a directory that contains one or more vetoed directories
(see the <a class="link" href="smb.conf.5.html#VETOFILES" target="_top">veto files</a>
option). If this option is set to <code class="constant">no</code> (the default) then if a vetoed
directory contains any non-vetoed files or directories then the
directory delete will fail. This is usually what you want.</p><p>If this option is set to <code class="constant">yes</code>, then Samba
will attempt to recursively delete any files and directories within
the vetoed directory. This can be useful for integration with file
serving systems such as NetAtalk which create meta-files within
directories you might normally veto DOS/Windows users from seeing
(e.g. <code class="filename">.AppleDouble</code>)</p><p>Setting <a class="link" href="smb.conf.5.html#DELETEVETOFILES" target="_top">delete veto files = yes</a> allows these
directories to be transparently deleted when the parent directory
is deleted (so long as the user has permissions to do so).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete veto files</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="dfree cache time (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545807"></a>
dfree cache time (S)
</h3></div></div></div><a class="indexterm" name="id2545808"></a><a name="DFREECACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>
The <em class="parameter"><code>dfree cache time</code></em> should only be used on systems where a problem
occurs with the internal disk space calculations. This has been known to happen with Ultrix, but may occur
with other operating systems. The symptom that was seen was an error of "Abort Retry Ignore" at the
end of each directory listing.
</p><p>
This is a new parameter introduced in Samba version 3.0.21. It specifies in seconds the time that smbd will
cache the output of a disk free query. If set to zero (the default) no caching is done. This allows a heavily
loaded server to prevent rapid spawning of <a class="link" href="smb.conf.5.html#DFREECOMMAND" target="_top">dfree command</a> scripts increasing the load.
</p><p>
By default this parameter is zero, meaning no caching will be done.
</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>dfree cache time</code></em> = <code class="literal">dfree cache time = 60</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="dfree command (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2545880"></a>
dfree command (S)
</h3></div></div></div><a class="indexterm" name="id2545881"></a><a name="DFREECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>
The <em class="parameter"><code>dfree command</code></em> setting should only be used on systems where a
problem occurs with the internal disk space calculations. This has been known to happen with Ultrix, but may
occur with other operating systems. The symptom that was seen was an error of "Abort Retry Ignore"
at the end of each directory listing.
</p><p>
This setting allows the replacement of the internal routines to calculate the total disk space and amount
available with an external routine. The example below gives a possible script that might fulfill this
function.
</p><p>
In Samba version 3.0.21 this parameter has been changed to be a per-share parameter, and in addition the
parameter <a class="link" href="smb.conf.5.html#DFREECACHETIME" target="_top">dfree cache time</a> was added to allow the output of this script to be cached
for systems under heavy load.
</p><p>
The external program will be passed a single parameter indicating a directory in the filesystem being queried.
This will typically consist of the string <code class="filename">./</code>. The script should return
two integers in ASCII. The first should be the total disk space in blocks, and the second should be the number
of available blocks. An optional third return value can give the block size in bytes. The default blocksize is
1024 bytes.
</p><p>
Note: Your script should <span class="emphasis"><em>NOT</em></span> be setuid or setgid and should be owned by (and writeable
only by) root!
</p><p>
Where the script dfree (which must be made executable) could be:
</p><pre class="programlisting">
#!/bin/sh
df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</pre><p>
or perhaps (on Sys V based systems):
</p><pre class="programlisting">
#!/bin/sh
/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
</pre><p>
Note that you may have to replace the command names with full path names on some systems.
</p><p>
By default internal routines for determining the disk capacity and remaining space will be used.
</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>dfree command</code></em> = <code class="literal">/usr/local/samba/bin/dfree</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="directory mode"><div class="titlepage"><div><div><h3 class="title"><a name="id2546001"></a>
<a name="DIRECTORYMODE"></a>directory mode
</h3></div></div></div><a class="indexterm" name="id2546002"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#DIRECTORYMASK">directory mask</a>.</p></dd></dl></div></div><div class="section" title="directory mask (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546028"></a>
directory mask (S)
</h3></div></div></div><a class="indexterm" name="id2546029"></a><a name="DIRECTORYMASK"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is the octal modes which are
used when converting DOS modes to UNIX modes when creating UNIX
directories.</p><p>When a directory is created, the necessary permissions are
calculated according to the mapping from DOS modes to UNIX permissions,
and the resulting UNIX mode is then bit-wise 'AND'ed with this
parameter. This parameter may be thought of as a bit-wise MASK for
the UNIX modes of a directory. Any bit <span class="emphasis"><em>not</em></span> set
here will be removed from the modes set on a directory when it is
created.</p><p>The default value of this parameter removes the 'group'
and 'other' write bits from the UNIX mode, allowing only the
user who owns the directory to modify it.</p><p>Following this Samba will bit-wise 'OR' the UNIX mode
created from this parameter with the value of the <a class="link" href="smb.conf.5.html#FORCEDIRECTORYMODE" target="_top">force directory mode</a> parameter.
This parameter is set to 000 by default (i.e. no extra mode bits are added).</p><p>Note that this parameter does not apply to permissions
set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
a mask on access control lists also, they need to set the <a class="link" href="smb.conf.5.html#DIRECTORYSECURITYMASK" target="_top">directory security mask</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>directory mask</code></em> = <code class="literal">0755</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>directory mask</code></em> = <code class="literal">0775</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="directory name cache size (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546134"></a>
directory name cache size (S)
</h3></div></div></div><a class="indexterm" name="id2546135"></a><a name="DIRECTORYNAMECACHESIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the the size of the directory name cache.
It will be needed to turn this off for *BSD systems.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>directory name cache size</code></em> = <code class="literal">100</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="directory security mask (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546173"></a>
directory security mask (S)
</h3></div></div></div><a class="indexterm" name="id2546174"></a><a name="DIRECTORYSECURITYMASK"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls what UNIX permission bits
will be set when a Windows NT client is manipulating the UNIX
permission on a directory using the native NT security dialog
box.</p><p>
This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus resetting
any bits not in this mask. Make sure not to mix up this parameter with <a class="link" href="smb.conf.5.html#FORCEDIRECTORYSECURITYMODE" target="_top">force directory security mode</a>, which works similar like this one but uses logical OR instead of AND.
Essentially, zero bits in this mask are a set of bits that will always be set to zero.
</p><p>
Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the
file permissions regardless of the previous status of this bits on the file.
</p><p>If not set explicitly this parameter is set to 0777
meaning a user is allowed to set all the user/group/world
permissions on a directory.</p><p><span class="emphasis"><em>Note</em></span> that users who can access the
Samba server through other means can easily bypass this restriction,
so it is primarily useful for standalone "appliance" systems.
Administrators of most normal systems will probably want to leave
it as the default of <code class="constant">0777</code>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>directory security mask</code></em> = <code class="literal">0777</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>directory security mask</code></em> = <code class="literal">0700</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="disable netbios (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546274"></a>
disable netbios (G)
</h3></div></div></div><a class="indexterm" name="id2546275"></a><a name="DISABLENETBIOS"></a><div class="variablelist"><dl><dt></dt><dd><p>Enabling this parameter will disable netbios support
in Samba. Netbios is the only available form of browsing in
all windows versions except for 2000 and XP. </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Clients that only support netbios won't be able to
see your samba server when netbios support is disabled.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>disable netbios</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="disable spoolss (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546320"></a>
disable spoolss (G)
</h3></div></div></div><a class="indexterm" name="id2546321"></a><a name="DISABLESPOOLSS"></a><div class="variablelist"><dl><dt></dt><dd><p>Enabling this parameter will disable Samba's support
for the SPOOLSS set of MS-RPC's and will yield identical behavior
as Samba 2.0.x. Windows NT/2000 clients will downgrade to using
Lanman style printing commands. Windows 9x/ME will be unaffected by
the parameter. However, this will also disable the ability to upload
printer drivers to a Samba server via the Windows NT Add Printer
Wizard or by using the NT printer properties dialog window. It will
also disable the capability of Windows NT/2000 clients to download
print drivers from the Samba host upon demand.
<span class="emphasis"><em>Be very careful about enabling this parameter.</em></span>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>disable spoolss</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="display charset (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546371"></a>
display charset (G)
</h3></div></div></div><a class="indexterm" name="id2546372"></a><a name="DISPLAYCHARSET"></a><div class="variablelist"><dl><dt></dt><dd><p>
Specifies the charset that samba will use to print messages to stdout and stderr.
The default value is "LOCALE", which means automatically set, depending on the
current locale. The value should generally be the same as the value of the parameter
<a class="link" href="smb.conf.5.html#UNIXCHARSET" target="_top">unix charset</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>display charset</code></em> = <code class="literal">"LOCALE" or "ASCII" (depending on the system)</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>display charset</code></em> = <code class="literal">UTF8</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="dmapi support (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546437"></a>
dmapi support (S)
</h3></div></div></div><a class="indexterm" name="id2546438"></a><a name="DMAPISUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether Samba should use DMAPI to
determine whether a file is offline or not. This would typically
be used in conjunction with a hierarchical storage system that
automatically migrates files to tape.
</p><p>Note that Samba infers the status of a file by examining the
events that a DMAPI application has registered interest in. This
heuristic is satisfactory for a number of hierarchical storage
systems, but there may be system for which it will fail. In this
case, Samba may erroneously report files to be offline.
</p><p>This parameter is only available if a supported DMAPI
implementation was found at compilation time. It will only be used
if DMAPI is found to enabled on the system at run time.
</p><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dmapi support</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="dns proxy (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546496"></a>
dns proxy (G)
</h3></div></div></div><a class="indexterm" name="id2546497"></a><a name="DNSPROXY"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies that <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> when acting as a WINS server and
finding that a NetBIOS name has not been registered, should treat the
NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server
for that name on behalf of the name-querying client.</p><p>Note that the maximum length for a NetBIOS name is 15
characters, so the DNS name (or DNS alias) can likewise only be
15 characters, maximum.</p><p><code class="literal">nmbd</code> spawns a second copy of itself to do the
DNS name lookup requests, as doing a name lookup is a blocking
action.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dns proxy</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="domain logons (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546560"></a>
domain logons (G)
</h3></div></div></div><a class="indexterm" name="id2546561"></a><a name="DOMAINLOGONS"></a><div class="variablelist"><dl><dt></dt><dd><p>
If set to <code class="constant">yes</code>, the Samba server will
provide the netlogon service for Windows 9X network logons for the
<a class="link" href="smb.conf.5.html#WORKGROUP" target="_top">workgroup</a> it is in.
This will also cause the Samba server to act as a domain
controller for NT4 style domain services. For more details on
setting up this feature see the Domain Control chapter of the
Samba HOWTO Collection.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>domain logons</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="domain master (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546613"></a>
domain master (G)
</h3></div></div></div><a class="indexterm" name="id2546614"></a><a name="DOMAINMASTER"></a><div class="variablelist"><dl><dt></dt><dd><p>
Tell <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to enable
WAN-wide browse list collation. Setting this option causes <code class="literal">nmbd</code> to claim a
special domain specific NetBIOS name that identifies it as a domain master browser for its given
<a class="link" href="smb.conf.5.html#WORKGROUP" target="_top">workgroup</a>. Local master browsers in the same <a class="link" href="smb.conf.5.html#WORKGROUP" target="_top">workgroup</a> on
broadcast-isolated subnets will give this <code class="literal">nmbd</code> their local browse lists,
and then ask <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> for a
complete copy of the browse list for the whole wide area network. Browser clients will then contact their
local master browser, and will receive the domain-wide browse list, instead of just the list for their
broadcast-isolated subnet.
</p><p>
Note that Windows NT Primary Domain Controllers expect to be able to claim this <a class="link" href="smb.conf.5.html#WORKGROUP" target="_top">workgroup</a> specific special NetBIOS name that identifies them as domain master browsers for that
<a class="link" href="smb.conf.5.html#WORKGROUP" target="_top">workgroup</a> by default (i.e. there is no way to prevent a Windows NT PDC from attempting
to do this). This means that if this parameter is set and <code class="literal">nmbd</code> claims the
special name for a <a class="link" href="smb.conf.5.html#WORKGROUP" target="_top">workgroup</a> before a Windows NT PDC is able to do so then cross
subnet browsing will behave strangely and may fail.
</p><p>
If <a class="link" href="smb.conf.5.html#DOMAINLOGONS" target="_top">domain logons = yes</a>, then the default behavior is to enable the
<a class="link" href="smb.conf.5.html#DOMAINMASTER" target="_top">domain master</a> parameter. If <a class="link" href="smb.conf.5.html#DOMAINLOGONS" target="_top">domain logons</a> is not enabled (the
default setting), then neither will <a class="link" href="smb.conf.5.html#DOMAINMASTER" target="_top">domain master</a> be enabled by default.
</p><p>
When <a class="link" href="smb.conf.5.html#DOMAINLOGONS" target="_top">domain logons = Yes</a> the default setting for this parameter is
Yes, with the result that Samba will be a PDC. If <a class="link" href="smb.conf.5.html#DOMAINMASTER" target="_top">domain master = No</a>,
Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>domain master</code></em> = <code class="literal">auto</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="dont descend (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546804"></a>
dont descend (S)
</h3></div></div></div><a class="indexterm" name="id2546805"></a><a name="DONTDESCEND"></a><div class="variablelist"><dl><dt></dt><dd><p>There are certain directories on some systems
(e.g., the <code class="filename">/proc</code> tree under Linux) that are either not
of interest to clients or are infinitely deep (recursive). This
parameter allows you to specify a comma-delimited list of directories
that the server should always show as empty.</p><p>Note that Samba can be very fussy about the exact format
of the "dont descend" entries. For example you may need <code class="filename">
./proc</code> instead of just <code class="filename">/proc</code>.
Experimentation is the best policy :-) </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dont descend</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>dont descend</code></em> = <code class="literal">/proc,/dev</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="dos charset (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546882"></a>
dos charset (G)
</h3></div></div></div><a class="indexterm" name="id2546883"></a><a name="DOSCHARSET"></a><div class="variablelist"><dl><dt></dt><dd><p>DOS SMB clients assume the server has
the same charset as they do. This option specifies which
charset Samba should talk to DOS clients.
</p><p>The default depends on which charsets you have installed.
Samba tries to use charset 850 but falls back to ASCII in
case it is not available. Run <a class="citerefentry" href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> to check the default on your system.</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" title="dos filemode (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546924"></a>
dos filemode (S)
</h3></div></div></div><a class="indexterm" name="id2546925"></a><a name="DOSFILEMODE"></a><div class="variablelist"><dl><dt></dt><dd><p> The default behavior in Samba is to provide
UNIX-like behavior where only the owner of a file/directory is
able to change the permissions on it. However, this behavior
is often confusing to DOS/Windows users. Enabling this parameter
allows a user who has write access to the file (by whatever
means, including an ACL permission) to modify the permissions
(including ACL) on it. Note that a user belonging to the group
owning the file will not be allowed to change permissions if
the group is only granted read access. Ownership of the
file/directory may also be changed.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dos filemode</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="dos filetime resolution (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2546970"></a>
dos filetime resolution (S)
</h3></div></div></div><a class="indexterm" name="id2546971"></a><a name="DOSFILETIMERESOLUTION"></a><div class="variablelist"><dl><dt></dt><dd><p>Under the DOS and Windows FAT filesystem, the finest
granularity on time resolution is two seconds. Setting this parameter
for a share causes Samba to round the reported time down to the
nearest two second boundary when a query call that requires one second
resolution is made to <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>.</p><p>This option is mainly used as a compatibility option for Visual
C++ when used against Samba shares. If oplocks are enabled on a
share, Visual C++ uses two different time reading calls to check if a
file has changed since it was last read. One of these calls uses a
one-second granularity, the other uses a two second granularity. As
the two second call rounds any odd second down, then if the file has a
timestamp of an odd number of seconds then the two timestamps will not
match and Visual C++ will keep reporting the file has changed. Setting
this option causes the two timestamps to match, and Visual C++ is
happy.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dos filetime resolution</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="dos filetimes (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547034"></a>
dos filetimes (S)
</h3></div></div></div><a class="indexterm" name="id2547035"></a><a name="DOSFILETIMES"></a><div class="variablelist"><dl><dt></dt><dd><p>Under DOS and Windows, if a user can write to a
file they can change the timestamp on it. Under POSIX semantics,
only the owner of the file or root may change the timestamp. By
default, Samba runs with POSIX semantics and refuses to change the
timestamp on a file if the user <code class="literal">smbd</code> is acting
on behalf of is not the file owner. Setting this option to <code class="constant">
yes</code> allows DOS semantics and <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will change the file
timestamp as DOS requires. Due to changes in Microsoft Office 2000 and beyond,
the default for this parameter has been changed from "no" to "yes" in Samba 3.0.14
and above. Microsoft Excel will display dialog box warnings about the file being
changed by another user if this parameter is not set to "yes" and files are being
shared between users.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dos filetimes</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ea support (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547099"></a>
ea support (S)
</h3></div></div></div><a class="indexterm" name="id2547100"></a><a name="EASUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will allow clients to attempt to store OS/2 style Extended
attributes on a share. In order to enable this parameter the underlying filesystem exported by
the share must support extended attributes (such as provided on XFS and EXT3 on Linux, with the
correct kernel patches). On Linux the filesystem must have been mounted with the mount
option user_xattr in order for extended attributes to work, also
extended attributes must be compiled into the Linux kernel.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ea support</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="enable asu support (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547161"></a>
enable asu support (G)
</h3></div></div></div><a class="indexterm" name="id2547162"></a><a name="ENABLEASUSUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>Hosts running the "Advanced Server for Unix (ASU)" product
require some special accomodations such as creating a builtin [ADMIN$]
share that only supports IPC connections. The has been the default
behavior in smbd for many years. However, certain Microsoft applications
such as the Print Migrator tool require that the remote server support
an [ADMIN$} file share. Disabling this parameter allows for creating
an [ADMIN$] file share in smb.conf.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enable asu support</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="enable core files (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547205"></a>
enable core files (G)
</h3></div></div></div><a class="indexterm" name="id2547206"></a><a name="ENABLECOREFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether core dumps should be written
on internal exits. Normally set to <code class="constant">yes</code>.
You should never need to change this.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enable core files</code></em> = <code class="literal">yes</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>enable core files</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="enable privileges (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547264"></a>
enable privileges (G)
</h3></div></div></div><a class="indexterm" name="id2547265"></a><a name="ENABLEPRIVILEGES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either
<code class="literal">net rpc rights</code> or one of the Windows user and group manager tools. This parameter is
enabled by default. It can be disabled to prevent members of the Domain Admins group from being able to
assign privileges to users or groups which can then result in certain smbd operations running as root that
would normally run under the context of the connected user.
</p><p>
An example of how privileges can be used is to assign the right to join clients to a Samba controlled
domain without providing root access to the server via smbd.
</p><p>
Please read the extended description provided in the Samba HOWTO documentation.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enable privileges</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="enable spoolss (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547324"></a>
enable spoolss (G)
</h3></div></div></div><a class="indexterm" name="id2547325"></a><a name="ENABLESPOOLSS"></a><div class="variablelist"><dl><dt></dt><dd><p>Inverted synonym for <a class="link" href="smb.conf.5.html#DISABLESPOOLSS" target="_top">disable spoolss</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enable spoolss</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="encrypt passwords (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547370"></a>
encrypt passwords (G)
</h3></div></div></div><a class="indexterm" name="id2547371"></a><a name="ENCRYPTPASSWORDS"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean controls whether encrypted passwords
will be negotiated with the client. Note that Windows NT 4.0 SP3 and
above and also Windows 98 will by default expect encrypted passwords
unless a registry entry is changed. To use encrypted passwords in
Samba see the chapter "User Database" in the Samba HOWTO Collection.
</p><p>
MS Windows clients that expect Microsoft encrypted passwords and that
do not have plain text password support enabled will be able to
connect only to a Samba server that has encrypted password support
enabled and for which the user accounts have a valid encrypted password.
Refer to the smbpasswd command man page for information regarding the
creation of encrypted passwords for user accounts.
</p><p>
The use of plain text passwords is NOT advised as support for this feature
is no longer maintained in Microsoft Windows products. If you want to use
plain text passwords you must set this parameter to no.
</p><p>In order for encrypted passwords to work correctly
<a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> must either
have access to a local <a class="citerefentry" href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> file (see the <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> program for information on how to set up
and maintain this file), or set the <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security = [server|domain|ads]</a> parameter which
causes <code class="literal">smbd</code> to authenticate against another
server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>encrypt passwords</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="enhanced browsing (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547474"></a>
enhanced browsing (G)
</h3></div></div></div><a class="indexterm" name="id2547475"></a><a name="ENHANCEDBROWSING"></a><div class="variablelist"><dl><dt></dt><dd><p>This option enables a couple of enhancements to
cross-subnet browse propagation that have been added in Samba
but which are not standard in Microsoft implementations.
</p><p>The first enhancement to browse propagation consists of a regular
wildcard query to a Samba WINS server for all Domain Master Browsers,
followed by a browse synchronization with each of the returned
DMBs. The second enhancement consists of a regular randomised browse
synchronization with all currently known DMBs.</p><p>You may wish to disable this option if you have a problem with empty
workgroups not disappearing from browse lists. Due to the restrictions
of the browse protocols, these enhancements can cause a empty workgroup
to stay around forever which can be annoying.</p><p>In general you should leave this option enabled as it makes
cross-subnet browse propagation much more reliable.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enhanced browsing</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="enumports command (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547535"></a>
enumports command (G)
</h3></div></div></div><a class="indexterm" name="id2547536"></a><a name="ENUMPORTSCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>The concept of a "port" is fairly foreign
to UNIX hosts. Under Windows NT/2000 print servers, a port
is associated with a port monitor and generally takes the form of
a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
(i.e. LPD Port Monitor, etc...). By default, Samba has only one
port defined--<code class="constant">"Samba Printer Port"</code>. Under
Windows NT/2000, all printers must have a valid port name.
If you wish to have a list of ports displayed (<code class="literal">smbd
</code> does not use a port name for anything) other than
the default <code class="constant">"Samba Printer Port"</code>, you
can define <em class="parameter"><code>enumports command</code></em> to point to
a program which should generate a list of ports, one per line,
to standard output. This listing will then be used in response
to the level 1 and 2 EnumPorts() RPC.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enumports command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>enumports command</code></em> = <code class="literal">/usr/bin/listports</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="eventlog list (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547616"></a>
eventlog list (G)
</h3></div></div></div><a class="indexterm" name="id2547617"></a><a name="EVENTLOGLIST"></a><div class="variablelist"><dl><dt></dt><dd><p>This option defines a list of log names that Samba will
report to the Microsoft EventViewer utility. The listed
eventlogs will be associated with tdb file on disk in the
<code class="filename">$(lockdir)/eventlog</code>.
</p><p>
The administrator must use an external process to parse the normal
Unix logs such as <code class="filename">/var/log/messages</code>
and write then entries to the eventlog tdb files. Refer to the
eventlogadm(8) utility for how to write eventlog entries.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>eventlog list</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>eventlog list</code></em> = <code class="literal">Security Application Syslog Apache</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="fake directory create times (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547689"></a>
fake directory create times (S)
</h3></div></div></div><a class="indexterm" name="id2547690"></a><a name="FAKEDIRECTORYCREATETIMES"></a><div class="variablelist"><dl><dt></dt><dd><p>NTFS and Windows VFAT file systems keep a create
time for all files and directories. This is not the same as the
ctime - status change time - that Unix keeps, so Samba by default
reports the earliest of the various times Unix does keep. Setting
this parameter for a share causes Samba to always report midnight
1-1-1980 as the create time for directories.</p><p>This option is mainly used as a compatibility option for
Visual C++ when used against Samba shares. Visual C++ generated
makefiles have the object directory as a dependency for each object
file, and a make rule to create the directory. Also, when NMAKE
compares timestamps it uses the creation time when examining a
directory. Thus the object directory will be created if it does not
exist, but once it does exist it will always have an earlier
timestamp than the object files it contains.</p><p>However, Unix time semantics mean that the create time
reported by Samba will be updated whenever a file is created or
or deleted in the directory. NMAKE finds all object files in
the object directory. The timestamp of the last one built is then
compared to the timestamp of the object directory. If the
directory's timestamp if newer, then all object files
will be rebuilt. Enabling this option
ensures directories always predate their contents and an NMAKE build
will proceed as expected.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>fake directory create times</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="fake oplocks (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547756"></a>
fake oplocks (S)
</h3></div></div></div><a class="indexterm" name="id2547758"></a><a name="FAKEOPLOCKS"></a><div class="variablelist"><dl><dt></dt><dd><p>Oplocks are the way that SMB clients get permission
from a server to locally cache file operations. If a server grants
an oplock (opportunistic lock) then the client is free to assume
that it is the only one accessing the file and it will aggressively
cache file data. With some oplock types the client may even cache
file open/close operations. This can give enormous performance benefits.
</p><p>When you set <code class="literal">fake oplocks = yes</code>, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will
always grant oplock requests no matter how many clients are using the file.</p><p>It is generally much better to use the real <a class="link" href="smb.conf.5.html#OPLOCKS" target="_top">oplocks</a> support rather
than this parameter.</p><p>If you enable this option on all read-only shares or
shares that you know will only be accessed from one client at a
time such as physically read-only media like CDROMs, you will see
a big performance improvement on many operations. If you enable
this option on shares where multiple clients may be accessing the
files read-write at the same time you can get data corruption. Use
this option carefully!</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>fake oplocks</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="follow symlinks (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547846"></a>
follow symlinks (S)
</h3></div></div></div><a class="indexterm" name="id2547847"></a><a name="FOLLOWSYMLINKS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter allows the Samba administrator to stop <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> from following symbolic links in a particular share. Setting this
parameter to <code class="constant">no</code> prevents any file or directory that is a symbolic link from being
followed (the user will get an error). This option is very useful to stop users from adding a symbolic
link to <code class="filename">/etc/passwd</code> in their home directory for instance. However
it will slow filename lookups down slightly.
</p><p>
This option is enabled (i.e. <code class="literal">smbd</code> will follow symbolic links) by default.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>follow symlinks</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="force create mode (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2547921"></a>
force create mode (S)
</h3></div></div></div><a class="indexterm" name="id2547922"></a><a name="FORCECREATEMODE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies a set of UNIX mode bit
permissions that will <span class="emphasis"><em>always</em></span> be set on a
file created by Samba. This is done by bitwise 'OR'ing these bits onto
the mode bits of a file that is being created. The default for this parameter is (in octal)
000. The modes in this parameter are bitwise 'OR'ed onto the file
mode after the mask set in the <em class="parameter"><code>create mask</code></em>
parameter is applied.</p><p>The example below would force all newly created files to have read and execute
permissions set for 'group' and 'other' as well as the
read/write/execute bits set for the 'user'.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force create mode</code></em> = <code class="literal">000</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force create mode</code></em> = <code class="literal">0755</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="force directory mode (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2548002"></a>
force directory mode (S)
</h3></div></div></div><a class="indexterm" name="id2548003"></a><a name="FORCEDIRECTORYMODE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies a set of UNIX mode bit
permissions that will <span class="emphasis"><em>always</em></span> be set on a directory
created by Samba. This is done by bitwise 'OR'ing these bits onto the
mode bits of a directory that is being created. The default for this
parameter is (in octal) 0000 which will not add any extra permission
bits to a created directory. This operation is done after the mode
mask in the parameter <em class="parameter"><code>directory mask</code></em> is
applied.</p><p>The example below would force all created directories to have read and execute
permissions set for 'group' and 'other' as well as the
read/write/execute bits set for the 'user'.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force directory mode</code></em> = <code class="literal">000</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force directory mode</code></em> = <code class="literal">0755</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="force directory security mode (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2548083"></a>
force directory security mode (S)
</h3></div></div></div><a class="indexterm" name="id2548084"></a><a name="FORCEDIRECTORYSECURITYMODE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating
the UNIX permission on a directory using the native NT security dialog box.
</p><p>
This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this
mask that the user may have modified to be on. Make sure not to mix up this parameter with <a class="link" href="smb.conf.5.html#DIRECTORYSECURITYMASK" target="_top">directory security mask</a>, which works in a similar manner to this one, but uses a logical AND instead
of an OR.
</p><p>
Essentially, this mask may be treated as a set of bits that, when modifying security on a directory,
to will enable (1) any flags that are off (0) but which the mask has set to on (1).
</p><p>
If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world
permissions on a directory without restrictions.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
Users who can access the Samba server through other means can easily bypass this restriction, so it is
primarily useful for standalone "appliance" systems. Administrators of most normal systems will
probably want to leave it set as 0000.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>force directory security mode</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force directory security mode</code></em> = <code class="literal">700</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="group"><div class="titlepage"><div><div><h3 class="title"><a name="id2548187"></a>
<a name="GROUP"></a>group
</h3></div></div></div><a class="indexterm" name="id2548188"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#FORCEGROUP">force group</a>.</p></dd></dl></div></div><div class="section" title="force group (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2548220"></a>
force group (S)
</h3></div></div></div><a class="indexterm" name="id2548221"></a><a name="FORCEGROUP"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies a UNIX group name that will be
assigned as the default primary group for all users connecting
to this service. This is useful for sharing files by ensuring
that all access to files on service will use the named group for
their permissions checking. Thus, by assigning permissions for this
group to the files and directories within this service the Samba
administrator can restrict or allow sharing of these files.</p><p>In Samba 2.0.5 and above this parameter has extended
functionality in the following way. If the group name listed here
has a '+' character prepended to it then the current user accessing
the share only has the primary group default assigned to this group
if they are already assigned as a member of that group. This allows
an administrator to decide that only users who are already in a
particular group will create files with group ownership set to that
group. This gives a finer granularity of ownership assignment. For
example, the setting <code class="filename">force group = +sys</code> means
that only users who are already in group sys will have their default
primary group assigned to sys when accessing this Samba share. All
other users will retain their ordinary primary group.</p><p>
If the <a class="link" href="smb.conf.5.html#FORCEUSER" target="_top">force user</a> parameter is also set the group specified in
<em class="parameter"><code>force group</code></em> will override the primary group
set in <em class="parameter"><code>force user</code></em>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force group</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force group</code></em> = <code class="literal">agroup</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="force printername (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544133"></a>
force printername (S)
</h3></div></div></div><a class="indexterm" name="id2544134"></a><a name="FORCEPRINTERNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>When printing from Windows NT (or later),
each printer in <code class="filename">smb.conf</code> has two
associated names which can be used by the client. The first
is the sharename (or shortname) defined in smb.conf. This
is the only printername available for use by Windows 9x clients.
The second name associated with a printer can be seen when
browsing to the "Printers" (or "Printers and Faxes") folder
on the Samba server. This is referred to simply as the printername
(not to be confused with the <em class="parameter"><code>printer name</code></em> option).
</p><p>When assigning a new driver to a printer on a remote
Windows compatible print server such as Samba, the Windows client
will rename the printer to match the driver name just uploaded.
This can result in confusion for users when multiple
printers are bound to the same driver. To prevent Samba from
allowing the printer's printername to differ from the sharename
defined in smb.conf, set <em class="parameter"><code>force printername = yes</code></em>.
</p><p>Be aware that enabling this parameter may affect migrating
printers from a Windows server to Samba since Windows has no way to
force the sharename and printername to match.</p><p>It is recommended that this parameter's value not be changed
once the printer is in use by clients as this could cause a user
not be able to delete printer connections from their local Printers
folder.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force printername</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="force security mode (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544224"></a>
force security mode (S)
</h3></div></div></div><a class="indexterm" name="id2544225"></a><a name="FORCESECURITYMODE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating
the UNIX permission on a file using the native NT security dialog box.
</p><p>
This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this
mask that the user may have modified to be on. Make sure not to mix up this parameter with <a class="link" href="smb.conf.5.html#SECURITYMASK" target="_top">security mask</a>, which works similar like this one but uses logical AND instead of OR.
</p><p>
Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file,
the user has always set to be on.
</p><p>
If not set explicitly this parameter is set to 0, and allows a user to modify all the user/group/world
permissions on a file, with no restrictions.
</p><p><span class="emphasis"><em>
Note</em></span> that users who can access the Samba server through other means can easily bypass this
restriction, so it is primarily useful for standalone "appliance" systems. Administrators of most
normal systems will probably want to leave this set to 0000.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force security mode</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force security mode</code></em> = <code class="literal">700</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="force unknown acl user (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2544326"></a>
force unknown acl user (S)
</h3></div></div></div><a class="indexterm" name="id2544327"></a><a name="FORCEUNKNOWNACLUSER"></a><div class="variablelist"><dl><dt></dt><dd><p>
If this parameter is set, a Windows NT ACL that contains an unknown SID (security descriptor, or
representation of a user or group id) as the owner or group owner of the file will be silently
mapped into the current UNIX uid or gid of the currently connected user.
</p><p>
This is designed to allow Windows NT clients to copy files and folders containing ACLs that were
created locally on the client machine and contain users local to that machine only (no domain
users) to be copied to a Samba server (usually with XCOPY /O) and have the unknown userid and
groupid of the file owner map to the current connected user. This can only be fixed correctly
when winbindd allows arbitrary mapping from any Windows NT SID to a UNIX uid or gid.
</p><p>
Try using this parameter when XCOPY /O gives an ACCESS_DENIED error.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force unknown acl user</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="force user (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2548864"></a>
force user (S)
</h3></div></div></div><a class="indexterm" name="id2548865"></a><a name="FORCEUSER"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies a UNIX user name that will be
assigned as the default user for all users connecting to this service.
This is useful for sharing files. You should also use it carefully
as using it incorrectly can cause security problems.</p><p>This user name only gets used once a connection is established.
Thus clients still need to connect as a valid user and supply a
valid password. Once connected, all file operations will be performed
as the "forced user", no matter what username the client connected
as. This can be very useful.</p><p>In Samba 2.0.5 and above this parameter also causes the
primary group of the forced user to be used as the primary group
for all file activity. Prior to 2.0.5 the primary group was left
as the primary group of the connecting user (this was a bug).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force user</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force user</code></em> = <code class="literal">auser</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="fstype (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2548940"></a>
fstype (S)
</h3></div></div></div><a class="indexterm" name="id2548941"></a><a name="FSTYPE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter allows the administrator to configure the string that specifies the type of filesystem a share
is using that is reported by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
when a client queries the filesystem type for a share. The default type is <code class="constant">NTFS</code> for compatibility
with Windows NT but this can be changed to other strings such as <code class="constant">Samba</code> or <code class="constant">FAT</code>
if required.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>fstype</code></em> = <code class="literal">NTFS</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>fstype</code></em> = <code class="literal">Samba</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="get quota command (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549022"></a>
get quota command (G)
</h3></div></div></div><a class="indexterm" name="id2549023"></a><a name="GETQUOTACOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>The <code class="literal">get quota command</code> should only be used
whenever there is no operating system API available from the OS that
samba can use.</p><p>This option is only available you have compiled Samba with the
<code class="literal">--with-sys-quotas</code> option or on Linux with
<code class="literal">--with-quotas</code> and a working quota api
was found in the system.</p><p>This parameter should specify the path to a script that
queries the quota information for the specified
user/group for the partition that
the specified directory is on.</p><p>Such a script should take 3 arguments:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>directory</p></li><li class="listitem"><p>type of query</p></li><li class="listitem"><p>uid of user or gid of group</p></li></ul></div><p>The type of query can be one of :</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>1 - user quotas</p></li><li class="listitem"><p>2 - user default quotas (uid = -1)</p></li><li class="listitem"><p>3 - group quotas</p></li><li class="listitem"><p>4 - group default quotas (gid = -1)</p></li></ul></div><p>This script should print one line as output with spaces between the arguments. The arguments are:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Arg 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)</p></li><li class="listitem"><p>Arg 2 - number of currently used blocks</p></li><li class="listitem"><p>Arg 3 - the softlimit number of blocks</p></li><li class="listitem"><p>Arg 4 - the hardlimit number of blocks</p></li><li class="listitem"><p>Arg 5 - currently used number of inodes</p></li><li class="listitem"><p>Arg 6 - the softlimit number of inodes</p></li><li class="listitem"><p>Arg 7 - the hardlimit number of inodes</p></li><li class="listitem"><p>Arg 8(optional) - the number of bytes in a block(default is 1024)</p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>get quota command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>get quota command</code></em> = <code class="literal">/usr/local/sbin/query_quota</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="getwd cache (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549208"></a>
getwd cache (G)
</h3></div></div></div><a class="indexterm" name="id2549210"></a><a name="GETWDCACHE"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a tuning option. When this is enabled a
caching algorithm will be used to reduce the time taken for getwd()
calls. This can have a significant impact on performance, especially
when the <a class="link" href="smb.conf.5.html#WIDESMBCONFOPTIONS" target="_top">wide smbconfoptions</a> parameter is set to <code class="constant">no</code>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>getwd cache</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="guest account (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549269"></a>
guest account (G)
</h3></div></div></div><a class="indexterm" name="id2549270"></a><a name="GUESTACCOUNT"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a username which will be used for access
to services which are specified as <a class="link" href="smb.conf.5.html#GUESTOK" target="_top">guest ok</a> (see below). Whatever privileges this
user has will be available to any client connecting to the guest service.
This user must exist in the password file, but does not require
a valid login. The user account "ftp" is often a good choice
for this parameter.
</p><p>On some systems the default guest account "nobody" may not
be able to print. Use another account in this case. You should test
this by trying to log in as your guest user (perhaps by using the
<code class="literal">su -</code> command) and trying to print using the
system print command such as <code class="literal">lpr(1)</code> or <code class="literal">
lp(1)</code>.</p><p>This parameter does not accept % macros, because
many parts of the system require this value to be
constant for correct operation.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>guest account</code></em> = <code class="literal">nobody
# default can be changed at compile-time</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>guest account</code></em> = <code class="literal">ftp</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="public"><div class="titlepage"><div><div><h3 class="title"><a name="id2549377"></a>
<a name="PUBLIC"></a>public
</h3></div></div></div><a class="indexterm" name="id2549378"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#GUESTOK">guest ok</a>.</p></dd></dl></div></div><div class="section" title="guest ok (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549408"></a>
guest ok (S)
</h3></div></div></div><a class="indexterm" name="id2549409"></a><a name="GUESTOK"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is <code class="constant">yes</code> for
a service, then no password is required to connect to the service.
Privileges will be those of the <a class="link" href="smb.conf.5.html#GUESTACCOUNT" target="_top">guest account</a>.</p><p>This paramater nullifies the benifits of setting
<a class="link" href="smb.conf.5.html#RESTRICTANONYMOUS" target="_top">restrict anonymous = 2</a>
</p><p>See the section below on <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security</a> for more information about this option.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>guest ok</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="only guest"><div class="titlepage"><div><div><h3 class="title"><a name="id2549496"></a>
<a name="ONLYGUEST"></a>only guest
</h3></div></div></div><a class="indexterm" name="id2549497"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#GUESTONLY">guest only</a>.</p></dd></dl></div></div><div class="section" title="guest only (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549529"></a>
guest only (S)
</h3></div></div></div><a class="indexterm" name="id2549530"></a><a name="GUESTONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is <code class="constant">yes</code> for
a service, then only guest connections to the service are permitted.
This parameter will have no effect if <a class="link" href="smb.conf.5.html#GUESTOK" target="_top">guest ok</a> is not set for the service.</p><p>See the section below on <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security</a> for more information about this option.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>guest only</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="hide dot files (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549601"></a>
hide dot files (S)
</h3></div></div></div><a class="indexterm" name="id2549602"></a><a name="HIDEDOTFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a boolean parameter that controls whether
files starting with a dot appear as hidden files.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide dot files</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="hide files (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549644"></a>
hide files (S)
</h3></div></div></div><a class="indexterm" name="id2549645"></a><a name="HIDEFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of files or directories that are not
visible but are accessible. The DOS 'hidden' attribute is applied
to any files or directories that match.</p><p>Each entry in the list must be separated by a '/',
which allows spaces to be included in the entry. '*'
and '?' can be used to specify multiple files or directories
as in DOS wildcards.</p><p>Each entry must be a Unix path, not a DOS path and must
not include the Unix directory separator '/'.</p><p>Note that the case sensitivity option is applicable
in hiding files.</p><p>Setting this parameter will affect the performance of Samba,
as it will be forced to check all files and directories for a match
as they are scanned.</p><p>
The example shown above is based on files that the Macintosh
SMB client (DAVE) available from <a class="ulink" href="http://www.thursby.com" target="_top">
Thursby</a> creates for internal use, and also still hides
all files beginning with a dot.
</p><p>
An example of us of this parameter is:
</p><pre class="programlisting">
hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide files</code></em> = <code class="literal">
# no file are hidden</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="hide special files (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549733"></a>
hide special files (S)
</h3></div></div></div><a class="indexterm" name="id2549734"></a><a name="HIDESPECIALFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter prevents clients from seeing special files such as sockets, devices and
fifo's in directory listings.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide special files</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="hide unreadable (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549776"></a>
hide unreadable (S)
</h3></div></div></div><a class="indexterm" name="id2549777"></a><a name="HIDEUNREADABLE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter prevents clients from seeing the
existance of files that cannot be read. Defaults to off.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide unreadable</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="hide unwriteable files (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549818"></a>
hide unwriteable files (S)
</h3></div></div></div><a class="indexterm" name="id2549819"></a><a name="HIDEUNWRITEABLEFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter prevents clients from seeing the existance of files that cannot be written to.
Defaults to off. Note that unwriteable directories are shown as usual.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide unwriteable files</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="homedir map (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549863"></a>
homedir map (G)
</h3></div></div></div><a class="indexterm" name="id2549864"></a><a name="HOMEDIRMAP"></a><div class="variablelist"><dl><dt></dt><dd><p>
If <a class="link" href="smb.conf.5.html#NISHOMEDIR" target="_top">nis homedir</a> is <code class="constant">yes</code>, and <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> is also acting as a Win95/98 <em class="parameter"><code>logon server</code></em>
then this parameter specifies the NIS (or YP) map from which the server for the user's home directory should be extracted.
At present, only the Sun auto.home map format is understood. The form of the map is:
</p><pre class="programlisting">
<code class="literal">username server:/some/file/system</code>
</pre><p>
and the program will extract the servername from before the first ':'. There should probably be a better parsing system
that copes with different map formats and also Amd (another automounter) maps.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
A working NIS client is required on the system for this option to work.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>homedir map</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>homedir map</code></em> = <code class="literal">amd.homedir</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="host msdfs (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2549976"></a>
host msdfs (G)
</h3></div></div></div><a class="indexterm" name="id2549977"></a><a name="HOSTMSDFS"></a><div class="variablelist"><dl><dt></dt><dd><p>
If set to <code class="constant">yes</code>, Samba will act as a Dfs server, and allow Dfs-aware clients to browse
Dfs trees hosted on the server.
</p><p>
See also the <a class="link" href="smb.conf.5.html#MSDFSROOT" target="_top">msdfs root</a> share level parameter. For more information on
setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3-HOWTO.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>host msdfs</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="hostname lookups (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2550040"></a>
hostname lookups (G)
</h3></div></div></div><a class="indexterm" name="id2550041"></a><a name="HOSTNAMELOOKUPS"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies whether samba should use (expensive)
hostname lookups or use the ip addresses instead. An example place
where hostname lookups are currently used is when checking
the <code class="literal">hosts deny</code> and <code class="literal">hosts allow</code>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hostname lookups</code></em> = <code class="literal">no</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>hostname lookups</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="allow hosts"><div class="titlepage"><div><div><h3 class="title"><a name="id2550114"></a>
<a name="ALLOWHOSTS"></a>allow hosts
</h3></div></div></div><a class="indexterm" name="id2550115"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#HOSTSALLOW">hosts allow</a>.</p></dd></dl></div></div><div class="section" title="hosts allow (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2550146"></a>
hosts allow (S)
</h3></div></div></div><a class="indexterm" name="id2550147"></a><a name="HOSTSALLOW"></a><div class="variablelist"><dl><dt></dt><dd><p>A synonym for this parameter is <a class="link" href="smb.conf.5.html#ALLOWHOSTS" target="_top">allow hosts</a>.</p><p>This parameter is a comma, space, or tab delimited
set of hosts which are permitted to access a service.</p><p>If specified in the [global] section then it will
apply to all services, regardless of whether the individual
service has a different setting.</p><p>You can specify the hosts by name or IP number. For
example, you could restrict access to only the hosts on a
Class C subnet with something like <code class="literal">allow hosts = 150.203.5.</code>.
The full syntax of the list is described in the man
page <code class="filename">hosts_access(5)</code>. Note that this man
page may not be present on your system, so a brief description will
be given here also.</p><p>Note that the localhost address 127.0.0.1 will always
be allowed access unless specifically denied by a <a class="link" href="smb.conf.5.html#HOSTSDENY" target="_top">hosts deny</a> option.</p><p>You can also specify hosts by network/netmask pairs and
by netgroup names if your system supports netgroups. The
<span class="emphasis"><em>EXCEPT</em></span> keyword can also be used to limit a
wildcard list. The following examples may provide some help:</p><p>Example 1: allow all IPs in 150.203.*.*; except one</p><p><code class="literal">hosts allow = 150.203. EXCEPT 150.203.6.66</code></p><p>Example 2: allow hosts that match the given network/netmask</p><p><code class="literal">hosts allow = 150.203.15.0/255.255.255.0</code></p><p>Example 3: allow a couple of hosts</p><p><code class="literal">hosts allow = lapland, arvidsjaur</code></p><p>Example 4: allow only hosts in NIS netgroup "foonet", but
deny access from one particular host</p><p><code class="literal">hosts allow = @foonet</code></p><p><code class="literal">hosts deny = pirate</code></p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Note that access still requires suitable user-level passwords.</p></div><p>See <a class="citerefentry" href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> for a way of testing your host access
to see if it does what you expect.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hosts allow</code></em> = <code class="literal">
# none (i.e., all hosts permitted access)</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>hosts allow</code></em> = <code class="literal">150.203.5. myhost.mynet.edu.au</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="deny hosts"><div class="titlepage"><div><div><h3 class="title"><a name="id2550348"></a>
<a name="DENYHOSTS"></a>deny hosts
</h3></div></div></div><a class="indexterm" name="id2550349"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#HOSTSDENY">hosts deny</a>.</p></dd></dl></div></div><div class="section" title="hosts deny (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2550379"></a>
hosts deny (S)
</h3></div></div></div><a class="indexterm" name="id2550380"></a><a name="HOSTSDENY"></a><div class="variablelist"><dl><dt></dt><dd><p>The opposite of <em class="parameter"><code>hosts allow</code></em>
- hosts listed here are <span class="emphasis"><em>NOT</em></span> permitted access to
services unless the specific services have their own lists to override
this one. Where the lists conflict, the <em class="parameter"><code>allow</code></em>
list takes precedence.</p><p>
In the event that it is necessary to deny all by default, use the keyword
ALL (or the netmask <code class="literal">0.0.0.0/0</code>) and then explicitly specify
to the <a class="link" href="smb.conf.5.html#HOSTSALLOW" target="_top">hosts allow = hosts allow</a> parameter those hosts
that should be permitted access.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hosts deny</code></em> = <code class="literal">
# none (i.e., no hosts specifically excluded)</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>hosts deny</code></em> = <code class="literal">150.203.4. badhost.mynet.edu.au</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="idmap alloc backend (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2550481"></a>
idmap alloc backend (G)
</h3></div></div></div><a class="indexterm" name="id2550482"></a><a name="IDMAPALLOCBACKEND"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap alloc backend provides a plugin interface for Winbind to use
when allocating Unix uids/gids for Windows SIDs. This option refers
to the name of the idmap module which will provide the id allocation
functionality. Please refer to the man page for each idmap plugin to
determine whether or not the module implements the allocation feature.
The most common plugins are the tdb (<a class="citerefentry" href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>)
and ldap (<a class="citerefentry" href="idmap_ldap.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ldap</span>(8)</span></a>) libraries.
</p><p>
This parameter defaults to the value <a class="link" href="smb.conf.5.html#IDMAPBACKEND" target="_top">idmap backend</a> was set to, so by default winbind will allocate Unix IDs
from the default backend. You will only need to set this parameter
explicitly if you have an external source for Unix IDs, like a central
database service somewhere in your company.
</p><p>
Also refer to the <a class="link" href="smb.conf.5.html#IDMAPALLOCCONFIG" target="_top">idmap alloc config</a> option.
</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap alloc backend</code></em> = <code class="literal">tdb</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="idmap alloc config (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2550587"></a>
idmap alloc config (G)
</h3></div></div></div><a class="indexterm" name="id2550588"></a><a name="IDMAPALLOCCONFIG"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap alloc config prefix provides a means of managing settings
for the backend defined by the <a class="link" href="smb.conf.5.html#IDMAPALLOCBACKEND" target="_top">idmap alloc backend</a>
parameter. Refer to the man page for each idmap plugin regarding
specific configuration details.
</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" title="idmap backend (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2550631"></a>
idmap backend (G)
</h3></div></div></div><a class="indexterm" name="id2550632"></a><a name="IDMAPBACKEND"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap backend provides a plugin interface for Winbind to use
varying backends to store SID/uid/gid mapping tables.
</p><p>
This option specifies the default backend that is used when no special
configuration set by <a class="link" href="smb.conf.5.html#IDMAPCONFIG" target="_top">idmap config</a> matches the
specific request.
</p><p>
This default backend also specifies the place where winbind-generated
idmap entries will be stored. So it is highly recommended that you
specify a writable backend like <a class="citerefentry" href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a> or <a class="citerefentry" href="idmap_ldap.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ldap</span>(8)</span></a> as the idmap backend. The <a class="citerefentry" href="idmap_rid.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_rid</span>(8)</span></a> and <a class="citerefentry" href="idmap_ad.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ad</span>(8)</span></a> backends are not writable and thus will generate
unexpected results if set as idmap backend.
</p><p>
To use the rid and ad backends, please specify them via the
<a class="link" href="smb.conf.5.html#IDMAPCONFIG" target="_top">idmap config</a> parameter, possibly also for the
domain your machine is member of, specified by <a class="link" href="smb.conf.5.html#WORKGROUP" target="_top">workgroup</a>.
</p><p>Examples of SID/uid/gid backends include tdb (<a class="citerefentry" href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>),
ldap (<a class="citerefentry" href="idmap_ldap.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ldap</span>(8)</span></a>), rid (<a class="citerefentry" href="idmap_rid.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_rid</span>(8)</span></a>),
and ad (<a class="citerefentry" href="idmap_ad.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ad</span>(8)</span></a>).
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap backend</code></em> = <code class="literal">tdb</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="idmap cache time (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2550803"></a>
idmap cache time (G)
</h3></div></div></div><a class="indexterm" name="id2550804"></a><a name="IDMAPCACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the number of seconds that Winbind's
idmap interface will cache positive SID/uid/gid query results.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap cache time</code></em> = <code class="literal">604800 (one week)</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="idmap config (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2550847"></a>
idmap config (G)
</h3></div></div></div><a class="indexterm" name="id2550848"></a><a name="IDMAPCONFIG"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap config prefix provides a means of managing each trusted
domain separately. The idmap config prefix should be followed by the
name of the domain, a colon, and a setting specific to the chosen
backend. There are three options available for all domains:
</p><div class="variablelist"><dl><dt><span class="term">backend = backend_name</span></dt><dd><p>
Specifies the name of the idmap plugin to use as the
SID/uid/gid backend for this domain.
</p></dd><dt><span class="term">range = low - high</span></dt><dd><p>
Defines the available matching uid and gid range for which the
backend is authoritative. Note that the range commonly
matches the allocation range due to the fact that the same
backend will store and retrieve SID/uid/gid mapping entries.
</p><p>
winbind uses this parameter to find the backend that is
authoritative for a unix ID to SID mapping, so it must be set
for each individually configured domain, and it must be
disjoint from the ranges set via <a class="link" href="smb.conf.5.html#IDMAPUID" target="_top">idmap uid</a> and <a class="link" href="smb.conf.5.html#IDMAPGID" target="_top">idmap gid</a>.
</p></dd></dl></div><p>
The following example illustrates how to configure the <a class="citerefentry" href="idmap_ad.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ad</span>(8)</span></a> for the CORP domain and the
<a class="citerefentry" href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a> backend for all other
domains. This configuration assumes that the admin of CORP assigns
unix ids below 1000000 via the SFU extensions, and winbind is supposed
to use the next million entries for its own mappings from trusted
domains and for local groups for example.
</p><pre class="programlisting">
idmap backend = tdb
idmap uid = 1000000-1999999
idmap gid = 1000000-1999999
idmap config CORP : backend = ad
idmap config CORP : range = 1000-999999
</pre><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" title="winbind gid"><div class="titlepage"><div><div><h3 class="title"><a name="id2550980"></a>
<a name="WINBINDGID"></a>winbind gid
</h3></div></div></div><a class="indexterm" name="id2550981"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#IDMAPGID">idmap gid</a>.</p></dd></dl></div></div><div class="section" title="idmap gid (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551012"></a>
idmap gid (G)
</h3></div></div></div><a class="indexterm" name="id2551013"></a><a name="IDMAPGID"></a><div class="variablelist"><dl><dt></dt><dd><p>The idmap gid parameter specifies the range of group ids
that are allocated for the purpose of mapping UNX groups to NT group
SIDs. This range of group ids should have no
existing local or NIS groups within it as strange conflicts can
occur otherwise.</p><p>See also the <a class="link" href="smb.conf.5.html#IDMAPBACKEND" target="_top">idmap backend</a>, and
<a class="link" href="smb.conf.5.html#IDMAPCONFIG" target="_top">idmap config</a> options.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap gid</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap gid</code></em> = <code class="literal">10000-20000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="idmap negative cache time (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551098"></a>
idmap negative cache time (G)
</h3></div></div></div><a class="indexterm" name="id2551099"></a><a name="IDMAPNEGATIVECACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the number of seconds that Winbind's
idmap interface will cache negative SID/uid/gid query results.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap negative cache time</code></em> = <code class="literal">120</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind uid"><div class="titlepage"><div><div><h3 class="title"><a name="id2551142"></a>
<a name="WINBINDUID"></a>winbind uid
</h3></div></div></div><a class="indexterm" name="id2551143"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#IDMAPUID">idmap uid</a>.</p></dd></dl></div></div><div class="section" title="idmap uid (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551173"></a>
idmap uid (G)
</h3></div></div></div><a class="indexterm" name="id2551174"></a><a name="IDMAPUID"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap uid parameter specifies the range of user ids that are
allocated for use in mapping UNIX users to NT user SIDs. This
range of ids should have no existing local
or NIS users within it as strange conflicts can occur otherwise.</p><p>See also the <a class="link" href="smb.conf.5.html#IDMAPBACKEND" target="_top">idmap backend</a> and
<a class="link" href="smb.conf.5.html#IDMAPCONFIG" target="_top">idmap config</a> options.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap uid</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap uid</code></em> = <code class="literal">10000-20000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="include (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551260"></a>
include (G)
</h3></div></div></div><a class="indexterm" name="id2551261"></a><a name="INCLUDE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This allows you to include one config file inside another. The file is included literally, as though typed
in place.
</p><p>
It takes the standard substitutions, except <em class="parameter"><code>%u</code></em>,
<em class="parameter"><code>%P</code></em> and <em class="parameter"><code>%S</code></em>.
</p><p>
The parameter <em class="parameter"><code>include = registry</code></em> has
a special meaning: It does <span class="emphasis"><em>not</em></span> include
a file named <span class="emphasis"><em>registry</em></span> from the current working
directory, but instead reads the global configuration options
from the registry. See the section on registry-based
configuration for details. Note that this option
automatically activates registry shares.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>include</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>include</code></em> = <code class="literal">/usr/local/samba/lib/admin_smb.conf</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="inherit acls (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551360"></a>
inherit acls (S)
</h3></div></div></div><a class="indexterm" name="id2551362"></a><a name="INHERITACLS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter can be used to ensure that if default acls
exist on parent directories, they are always honored when creating a
new file or subdirectory in these parent directories. The default
behavior is to use the unix mode specified when creating the directory.
Enabling this option sets the unix mode to 0777, thus guaranteeing that
default directory acls are propagated.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>inherit acls</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="inherit owner (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551407"></a>
inherit owner (S)
</h3></div></div></div><a class="indexterm" name="id2551408"></a><a name="INHERITOWNER"></a><div class="variablelist"><dl><dt></dt><dd><p>The ownership of new files and directories
is normally governed by effective uid of the connected user.
This option allows the Samba administrator to specify that
the ownership for new files and directories should be controlled
by the ownership of the parent directory.</p><p>Common scenarios where this behavior is useful is in
implementing drop-boxes where users can create and edit files but not
delete them and to ensure that newly create files in a user's
roaming profile directory are actually owner by the user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>inherit owner</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="inherit permissions (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551461"></a>
inherit permissions (S)
</h3></div></div></div><a class="indexterm" name="id2551462"></a><a name="INHERITPERMISSIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>
The permissions on new files and directories are normally governed by <a class="link" href="smb.conf.5.html#CREATEMASK" target="_top">create mask</a>,
<a class="link" href="smb.conf.5.html#DIRECTORYMASK" target="_top">directory mask</a>, <a class="link" href="smb.conf.5.html#FORCECREATEMODE" target="_top">force create mode</a> and <a class="link" href="smb.conf.5.html#FORCEDIRECTORYMODE" target="_top">force directory mode</a> but the boolean inherit permissions parameter overrides this.
</p><p>New directories inherit the mode of the parent directory,
including bits such as setgid.</p><p>
New files inherit their read/write bits from the parent directory. Their execute bits continue to be
determined by <a class="link" href="smb.conf.5.html#MAPARCHIVE" target="_top">map archive</a>, <a class="link" href="smb.conf.5.html#MAPHIDDEN" target="_top">map hidden</a> and <a class="link" href="smb.conf.5.html#MAPSYSTEM" target="_top">map system</a> as usual.
</p><p>Note that the setuid bit is <span class="emphasis"><em>never</em></span> set via
inheritance (the code explicitly prohibits this).</p><p>This can be particularly useful on large systems with
many users, perhaps several thousand, to allow a single [homes]
share to be used flexibly by each user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>inherit permissions</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="init logon delayed hosts (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551610"></a>
init logon delayed hosts (G)
</h3></div></div></div><a class="indexterm" name="id2551611"></a><a name="INITLOGONDELAYEDHOSTS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter takes a list of host names, addresses or networks for
which the initial samlogon reply should be delayed (so other DCs get
preferred by XP workstations if there are any).
</p><p>
The length of the delay can be specified with the
<a class="link" href="smb.conf.5.html#INITLOGONDELAY" target="_top">init logon delay</a> parameter.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>init logon delayed hosts</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>init logon delayed hosts</code></em> = <code class="literal">150.203.5. myhost.mynet.de</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="init logon delay (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551688"></a>
init logon delay (G)
</h3></div></div></div><a class="indexterm" name="id2551689"></a><a name="INITLOGONDELAY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies a delay in milliseconds for the hosts configured
for delayed initial samlogon with
<a class="link" href="smb.conf.5.html#INITLOGONDELAYEDHOSTS" target="_top">init logon delayed hosts</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>init logon delay</code></em> = <code class="literal">100</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="interfaces (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551742"></a>
interfaces (G)
</h3></div></div></div><a class="indexterm" name="id2551743"></a><a name="INTERFACES"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows you to override the default
network interfaces list that Samba will use for browsing, name
registration and other NetBIOS over TCP/IP (NBT) traffic. By default Samba will query
the kernel for the list of all active interfaces and use any
interfaces except 127.0.0.1 that are broadcast capable.</p><p>The option takes a list of interface strings. Each string
can be in any of the following forms:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>a network interface name (such as eth0).
This may include shell-like wildcards so eth* will match
any interface starting with the substring "eth"</p></li><li class="listitem"><p>an IP address. In this case the netmask is
determined from the list of interfaces obtained from the
kernel</p></li><li class="listitem"><p>an IP/mask pair. </p></li><li class="listitem"><p>a broadcast/mask pair.</p></li></ul></div><p>The "mask" parameters can either be a bit length (such
as 24 for a C class network) or a full netmask in dotted
decimal form.</p><p>The "IP" parameters above can either be a full dotted
decimal IP address or a hostname which will be looked up via
the OS's normal hostname resolution mechanisms.</p><p>
By default Samba enables all active interfaces that are broadcast capable
except the loopback adaptor (IP address 127.0.0.1).
</p><p>
The example below configures three network interfaces corresponding
to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
The netmasks of the latter two interfaces would be set to 255.255.255.0.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>interfaces</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>interfaces</code></em> = <code class="literal">eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="invalid users (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551859"></a>
invalid users (S)
</h3></div></div></div><a class="indexterm" name="id2551860"></a><a name="INVALIDUSERS"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of users that should not be allowed
to login to this service. This is really a <span class="emphasis"><em>paranoid</em></span>
check to absolutely ensure an improper setting does not breach
your security.</p><p>A name starting with a '@' is interpreted as an NIS
netgroup first (if your system supports NIS), and then as a UNIX
group if the name was not found in the NIS netgroup database.</p><p>A name starting with '+' is interpreted only
by looking in the UNIX group database via the NSS getgrnam() interface. A name starting with
'&' is interpreted only by looking in the NIS netgroup database
(this requires NIS to be working on your system). The characters
'+' and '&' may be used at the start of the name in either order
so the value <em class="parameter"><code>+&group</code></em> means check the
UNIX group database, followed by the NIS netgroup database, and
the value <em class="parameter"><code>&+group</code></em> means check the NIS
netgroup database, followed by the UNIX group database (the
same as the '@' prefix).</p><p>The current servicename is substituted for <em class="parameter"><code>%S</code></em>.
This is useful in the [homes] section.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>invalid users</code></em> = <code class="literal">
# no invalid users</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>invalid users</code></em> = <code class="literal">root fred admin @wheel</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="iprint server (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2551973"></a>
iprint server (G)
</h3></div></div></div><a class="indexterm" name="id2551974"></a><a name="IPRINTSERVER"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter is only applicable if <a class="link" href="smb.conf.5.html#PRINTING" target="_top">printing</a> is set to <code class="constant">iprint</code>.
</p><p>
If set, this option overrides the ServerName option in the CUPS <code class="filename">client.conf</code>. This is
necessary if you have virtual samba servers that connect to different CUPS daemons.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>iprint server</code></em> = <code class="literal">""</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>iprint server</code></em> = <code class="literal">MYCUPSSERVER</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="keepalive (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552060"></a>
keepalive (G)
</h3></div></div></div><a class="indexterm" name="id2552061"></a><a name="KEEPALIVE"></a><div class="variablelist"><dl><dt></dt><dd><p>The value of the parameter (an integer) represents
the number of seconds between <em class="parameter"><code>keepalive</code></em>
packets. If this parameter is zero, no keepalive packets will be
sent. Keepalive packets, if sent, allow the server to tell whether
a client is still present and responding.</p><p>Keepalives should, in general, not be needed if the socket
has the SO_KEEPALIVE attribute set on it by default. (see <a class="link" href="smb.conf.5.html#SOCKETOPTIONS" target="_top">socket options</a>).
Basically you should only use this option if you strike difficulties.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>keepalive</code></em> = <code class="literal">300</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>keepalive</code></em> = <code class="literal">600</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="kerberos method (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552147"></a>
kerberos method (G)
</h3></div></div></div><a class="indexterm" name="id2552148"></a><a name="KERBEROSMETHOD"></a><div class="variablelist"><dl><dt></dt><dd><p>
Controls how kerberos tickets are verified.
</p><p>Valid options are:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>secrets only - use only the secrets.tdb for
ticket verification (default)</p></li><li class="listitem"><p>system keytab - use only the system keytab
for ticket verification</p></li><li class="listitem"><p>dedicated keytab - use a dedicated keytab
for ticket verification</p></li><li class="listitem"><p>secrets and keytab - use the secrets.tdb
first, then the system keytab</p></li></ul></div><p>
The major difference between "system keytab" and "dedicated
keytab" is that the latter method relies on kerberos to find the
correct keytab entry instead of filtering based on expected
principals.
</p><p>
When the kerberos method is in "dedicated keytab" mode,
<a class="link" href="smb.conf.5.html#DEDICATEDKEYTABFILE" target="_top">dedicated keytab file</a> must be set to
specify the location of the keytab file.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>kerberos method</code></em> = <code class="literal">secrets only</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="kernel change notify (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552243"></a>
kernel change notify (S)
</h3></div></div></div><a class="indexterm" name="id2552244"></a><a name="KERNELCHANGENOTIFY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether Samba should ask the
kernel for change notifications in directories so that
SMB clients can refresh whenever the data on the server changes.
</p><p>This parameter is only used when your kernel supports
change notification to user programs using the inotify interface.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>kernel change notify</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="kernel oplocks (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552293"></a>
kernel oplocks (G)
</h3></div></div></div><a class="indexterm" name="id2552294"></a><a name="KERNELOPLOCKS"></a><div class="variablelist"><dl><dt></dt><dd><p>For UNIXes that support kernel based <a class="link" href="smb.conf.5.html#OPLOCKS" target="_top">oplocks</a>
(currently only IRIX and the Linux 2.4 kernel), this parameter
allows the use of them to be turned on or off.</p><p>Kernel oplocks support allows Samba <em class="parameter"><code>oplocks
</code></em> to be broken whenever a local UNIX process or NFS operation
accesses a file that <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> has oplocked. This allows complete
data consistency between SMB/CIFS, NFS and local file access (and is
a <span class="emphasis"><em>very</em></span> cool feature :-).</p><p>This parameter defaults to <code class="constant">on</code>, but is translated
to a no-op on systems that no not have the necessary kernel support.
You should never need to touch this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>kernel oplocks</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="lanman auth (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552382"></a>
lanman auth (G)
</h3></div></div></div><a class="indexterm" name="id2552383"></a><a name="LANMANAUTH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines whether or not <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to
authenticate users or permit password changes
using the LANMAN password hash. If disabled, only clients which support NT
password hashes (e.g. Windows NT/2000 clients, smbclient, but not
Windows 95/98 or the MS DOS network client) will be able to
connect to the Samba host.</p><p>The LANMAN encrypted response is easily broken, due to its
case-insensitive nature, and the choice of algorithm. Servers
without Windows 95/98/ME or MS DOS clients are advised to disable
this option. </p><p>Unlike the <code class="literal">encrypt
passwords</code> option, this parameter cannot alter client
behaviour, and the LANMAN response will still be sent over the
network. See the <code class="literal">client lanman
auth</code> to disable this for Samba's clients (such as smbclient)</p><p>If this option, and <code class="literal">ntlm
auth</code> are both disabled, then only NTLMv2 logins will be
permited. Not all clients support NTLMv2, and most will require
special configuration to use it.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lanman auth</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="large readwrite (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552474"></a>
large readwrite (G)
</h3></div></div></div><a class="indexterm" name="id2552475"></a><a name="LARGEREADWRITE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines whether or not
<a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> supports the new 64k
streaming read and write varient SMB requests introduced with
Windows 2000. Note that due to Windows 2000 client redirector bugs
this requires Samba to be running on a 64-bit capable operating
system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve
performance by 10% with Windows 2000 clients. Defaults to on. Not as
tested as some other Samba code paths.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>large readwrite</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap admin dn (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552531"></a>
ldap admin dn (G)
</h3></div></div></div><a class="indexterm" name="id2552532"></a><a name="LDAPADMINDN"></a><div class="variablelist"><dl><dt></dt><dd><p>
The <a class="link" href="smb.conf.5.html#LDAPADMINDN" target="_top">ldap admin dn</a> defines the Distinguished Name (DN) name used by Samba to contact
the ldap server when retreiving user account information. The <a class="link" href="smb.conf.5.html#LDAPADMINDN" target="_top">ldap admin dn</a> is used
in conjunction with the admin dn password stored in the <code class="filename">private/secrets.tdb</code>
file. See the <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>
man page for more information on how to accomplish this.
</p><p>
The <a class="link" href="smb.conf.5.html#LDAPADMINDN" target="_top">ldap admin dn</a> requires a fully specified DN. The <a class="link" href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a> is not appended to the <a class="link" href="smb.conf.5.html#LDAPADMINDN" target="_top">ldap admin dn</a>.
</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" title="ldap connection timeout (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552640"></a>
ldap connection timeout (G)
</h3></div></div></div><a class="indexterm" name="id2552641"></a><a name="LDAPCONNECTIONTIMEOUT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter tells the LDAP library calls which timeout in seconds
they should honor during initial connection establishments to LDAP servers.
It is very useful in failover scenarios in particular. If one or more LDAP
servers are not reachable at all, we do not have to wait until TCP
timeouts are over. This feature must be supported by your LDAP library.
</p><p>
This parameter is different from <a class="link" href="smb.conf.5.html#LDAPTIMEOUT" target="_top">ldap timeout</a>
which affects operations on LDAP servers using an existing connection
and not establishing an initial connection.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap connection timeout</code></em> = <code class="literal">2</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap debug level (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552705"></a>
ldap debug level (G)
</h3></div></div></div><a class="indexterm" name="id2552706"></a><a name="LDAPDEBUGLEVEL"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls the debug level of the LDAP library
calls. In the case of OpenLDAP, it is the same
bit-field as understood by the server and documented in the
<a class="citerefentry" href="slapd.conf.5.html"><span class="citerefentry"><span class="refentrytitle">slapd.conf</span>(5)</span></a>
manpage.
A typical useful value will be
<span class="emphasis"><em>1</em></span> for tracing function calls.
</p><p>
The debug ouput from the LDAP libraries appears with the
prefix [LDAP] in Samba's logging output.
The level at which LDAP logging is printed is controlled by the
parameter <em class="parameter"><code>ldap debug threshold</code></em>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap debug level</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap debug level</code></em> = <code class="literal">1</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap debug threshold (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552793"></a>
ldap debug threshold (G)
</h3></div></div></div><a class="indexterm" name="id2552794"></a><a name="LDAPDEBUGTHRESHOLD"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls the Samba debug level at which
the ldap library debug output is
printed in the Samba logs. See the description of
<em class="parameter"><code>ldap debug level</code></em> for details.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap debug threshold</code></em> = <code class="literal">10</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap debug threshold</code></em> = <code class="literal">5</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap delete dn (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552861"></a>
ldap delete dn (G)
</h3></div></div></div><a class="indexterm" name="id2552862"></a><a name="LDAPDELETEDN"></a><div class="variablelist"><dl><dt></dt><dd><p> This parameter specifies whether a delete
operation in the ldapsam deletes the complete entry or only the attributes
specific to Samba.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap delete dn</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap group suffix (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552905"></a>
ldap group suffix (G)
</h3></div></div></div><a class="indexterm" name="id2552906"></a><a name="LDAPGROUPSUFFIX"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the suffix that is
used for groups when these are added to the LDAP directory.
If this parameter is unset, the value of <a class="link" href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a> will be used instead. The suffix string is pre-pended to the
<a class="link" href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a> string so use a partial DN.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap group suffix</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap group suffix</code></em> = <code class="literal">ou=Groups</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap idmap suffix (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2552988"></a>
ldap idmap suffix (G)
</h3></div></div></div><a class="indexterm" name="id2552990"></a><a name="LDAPIDMAPSUFFIX"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameters specifies the suffix that is used when storing idmap mappings. If this parameter
is unset, the value of <a class="link" href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a> will be used instead. The suffix
string is pre-pended to the <a class="link" href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a> string so use a partial DN.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap idmap suffix</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap idmap suffix</code></em> = <code class="literal">ou=Idmap</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap machine suffix (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2553071"></a>
ldap machine suffix (G)
</h3></div></div></div><a class="indexterm" name="id2553072"></a><a name="LDAPMACHINESUFFIX"></a><div class="variablelist"><dl><dt></dt><dd><p>
It specifies where machines should be added to the ldap tree. If this parameter is unset, the value of
<a class="link" href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a> will be used instead. The suffix string is pre-pended to the
<a class="link" href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a> string so use a partial DN.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap machine suffix</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap machine suffix</code></em> = <code class="literal">ou=Computers</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap page size (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2553153"></a>
ldap page size (G)
</h3></div></div></div><a class="indexterm" name="id2553154"></a><a name="LDAPPAGESIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the number of entries per page.
</p><p>If the LDAP server supports paged results, clients can
request subsets of search results (pages) instead of the entire list.
This parameter specifies the size of these pages.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap page size</code></em> = <code class="literal">1024</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap page size</code></em> = <code class="literal">512</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap passwd sync (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2553220"></a>
ldap passwd sync (G)
</h3></div></div></div><a class="indexterm" name="id2553221"></a><a name="LDAPPASSWDSYNC"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option is used to define whether or not Samba should sync the LDAP password with the NT
and LM hashes for normal accounts (NOT for workstation, server or domain trusts) on a password
change via SAMBA.
</p><p>
The <a class="link" href="smb.conf.5.html#LDAPPASSWDSYNC" target="_top">ldap passwd sync</a> can be set to one of three values:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>Yes</code></em> = Try
to update the LDAP, NT and LM passwords and update the pwdLastSet time.</p></li><li class="listitem"><p><em class="parameter"><code>No</code></em> = Update NT and
LM passwords and update the pwdLastSet time.</p></li><li class="listitem"><p><em class="parameter"><code>Only</code></em> = Only update
the LDAP password and let the LDAP server do the rest.</p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap passwd sync</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap replication sleep (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2553321"></a>
ldap replication sleep (G)
</h3></div></div></div><a class="indexterm" name="id2553322"></a><a name="LDAPREPLICATIONSLEEP"></a><div class="variablelist"><dl><dt></dt><dd><p>
When Samba is asked to write to a read-only LDAP replica, we are redirected to talk to the read-write master server.
This server then replicates our changes back to the 'local' server, however the replication might take some seconds,
especially over slow links. Certain client activities, particularly domain joins, can become confused by the 'success'
that does not immediately change the LDAP back-end's data.
</p><p>
This option simply causes Samba to wait a short time, to allow the LDAP server to catch up. If you have a particularly
high-latency network, you may wish to time the LDAP replication with a network sniffer, and increase this value accordingly.
Be aware that no checking is performed that the data has actually replicated.
</p><p>
The value is specified in milliseconds, the maximum value is 5000 (5 seconds).
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap replication sleep</code></em> = <code class="literal">1000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldapsam:editposix (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2553385"></a>
ldapsam:editposix (G)
</h3></div></div></div><a class="indexterm" name="id2553386"></a><a name="LDAPSAM:EDITPOSIX"></a><div class="variablelist"><dl><dt></dt><dd><p>
Editposix is an option that leverages ldapsam:trusted to make it simpler to manage a domain controller
eliminating the need to set up custom scripts to add and manage the posix users and groups. This option
will instead directly manipulate the ldap tree to create, remove and modify user and group entries.
This option also requires a running winbindd as it is used to allocate new uids/gids on user/group
creation. The allocation range must be therefore configured.
</p><p>
To use this option, a basic ldap tree must be provided and the ldap suffix parameters must be properly
configured. On virgin servers the default users and groups (Administrator, Guest, Domain Users,
Domain Admins, Domain Guests) can be precreated with the command <code class="literal">net sam
provision</code>. To run this command the ldap server must be running, Winindd must be running and
the smb.conf ldap options must be properly configured.
The typical ldap setup used with the <a class="link" href="smb.conf.5.html#LDAPSAM:TRUSTED" target="_top">ldapsam:trusted = yes</a> option
is usually sufficient to use <a class="link" href="smb.conf.5.html#LDAPSAM:EDITPOSIX" target="_top">ldapsam:editposix = yes</a> as well.
</p><p>
An example configuration can be the following:
</p><pre class="programlisting">
encrypt passwords = true
passdb backend = ldapsam
ldapsam:trusted=yes
ldapsam:editposix=yes
ldap admin dn = cn=admin,dc=samba,dc=org
ldap delete dn = yes
ldap group suffix = ou=groups
ldap idmap suffix = ou=idmap
ldap machine suffix = ou=computers
ldap user suffix = ou=users
ldap suffix = dc=samba,dc=org
idmap backend = ldap:"ldap://localhost"
idmap uid = 5000-50000
idmap gid = 5000-50000
</pre><p>
This configuration assumes a directory layout like described in the following ldif:
</p><pre class="programlisting">
dn: dc=samba,dc=org
objectClass: top
objectClass: dcObject
objectClass: organization
o: samba.org
dc: samba
dn: cn=admin,dc=samba,dc=org
objectClass: simpleSecurityObject
objectClass: organizationalRole
cn: admin
description: LDAP administrator
userPassword: secret
dn: ou=users,dc=samba,dc=org
objectClass: top
objectClass: organizationalUnit
ou: users
dn: ou=groups,dc=samba,dc=org
objectClass: top
objectClass: organizationalUnit
ou: groups
dn: ou=idmap,dc=samba,dc=org
objectClass: top
objectClass: organizationalUnit
ou: idmap
dn: ou=computers,dc=samba,dc=org
objectClass: top
objectClass: organizationalUnit
ou: computers
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldapsam:editposix</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldapsam:trusted (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2553510"></a>
ldapsam:trusted (G)
</h3></div></div></div><a class="indexterm" name="id2553512"></a><a name="LDAPSAM:TRUSTED"></a><div class="variablelist"><dl><dt></dt><dd><p>
By default, Samba as a Domain Controller with an LDAP backend needs to use the Unix-style NSS subsystem to
access user and group information. Due to the way Unix stores user information in /etc/passwd and /etc/group
this inevitably leads to inefficiencies. One important question a user needs to know is the list of groups he
is member of. The plain UNIX model involves a complete enumeration of the file /etc/group and its NSS
counterparts in LDAP. UNIX has optimized functions to enumerate group membership. Sadly, other functions that
are used to deal with user and group attributes lack such optimization.
</p><p>
To make Samba scale well in large environments, the <a class="link" href="smb.conf.5.html#LDAPSAM:TRUSTED" target="_top">ldapsam:trusted = yes</a>
option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the
standard posixAccount/posixGroup attributes. It further assumes that the Samba auxiliary object classes are
stored together with the POSIX data in the same LDAP object. If these assumptions are met,
<a class="link" href="smb.conf.5.html#LDAPSAM:TRUSTED" target="_top">ldapsam:trusted = yes</a> can be activated and Samba can bypass the
NSS system to query user group memberships. Optimized LDAP queries can greatly speed up domain logon and
administration tasks. Depending on the size of the LDAP database a factor of 100 or more for common queries
is easily achieved.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldapsam:trusted</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap ssl ads (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2553599"></a>
ldap ssl ads (G)
</h3></div></div></div><a class="indexterm" name="id2553600"></a><a name="LDAPSSLADS"></a><div class="variablelist"><dl><dt></dt><dd><p>This option is used to define whether or not Samba should
use SSL when connecting to the ldap server using
<span class="emphasis"><em>ads</em></span> methods.
Rpc methods are not affected by this parameter. Please note, that
this parameter won't have any effect if <a class="link" href="smb.conf.5.html#LDAPSSL" target="_top">ldap ssl</a>
is set to <em class="parameter"><code>no</code></em>.
</p><p>See <span class="refentrytitle">smb.conf</span>(5)
for more information on <a class="link" href="smb.conf.5.html#LDAPSSL" target="_top">ldap ssl</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap ssl ads</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap ssl (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2553685"></a>
ldap ssl (G)
</h3></div></div></div><a class="indexterm" name="id2553686"></a><a name="LDAPSSL"></a><div class="variablelist"><dl><dt></dt><dd><p>This option is used to define whether or not Samba should
use SSL when connecting to the ldap server
This is <span class="emphasis"><em>NOT</em></span> related to
Samba's previous SSL support which was enabled by specifying the
<code class="literal">--with-ssl</code> option to the
<code class="filename">configure</code>
script.</p><p>LDAP connections should be secured where possible. This may be
done setting <span class="emphasis"><em>either</em></span> this parameter to
<em class="parameter"><code>Start_tls</code></em>
<span class="emphasis"><em>or</em></span> by specifying <em class="parameter"><code>ldaps://</code></em> in
the URL argument of <a class="link" href="smb.conf.5.html#PASSDBBACKEND" target="_top">passdb backend</a>.</p><p>The <a class="link" href="smb.conf.5.html#LDAPSSL" target="_top">ldap ssl</a> can be set to one of
two values:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>Off</code></em> = Never
use SSL when querying the directory.</p></li><li class="listitem"><p><em class="parameter"><code>start tls</code></em> = Use
the LDAPv3 StartTLS extended operation (RFC2830) for
communicating with the directory server.</p></li></ul></div><p>
Please note that this parameter does only affect <span class="emphasis"><em>rpc</em></span>
methods. To enable the LDAPv3 StartTLS extended operation (RFC2830) for
<span class="emphasis"><em>ads</em></span>, set
<a class="link" href="smb.conf.5.html#LDAPSSL" target="_top">ldap ssl = yes</a>
<span class="emphasis"><em>and</em></span>
<a class="link" href="smb.conf.5.html#LDAPSSLADS" target="_top">ldap ssl ads = yes</a>.
See <span class="refentrytitle">smb.conf</span>(5)
for more information on <a class="link" href="smb.conf.5.html#LDAPSSLADS" target="_top">ldap ssl ads</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap ssl</code></em> = <code class="literal">start tls</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap suffix (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2553878"></a>
ldap suffix (G)
</h3></div></div></div><a class="indexterm" name="id2553879"></a><a name="LDAPSUFFIX"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies the base for all ldap suffixes and for storing the sambaDomain object.</p><p>
The ldap suffix will be appended to the values specified for the <a class="link" href="smb.conf.5.html#LDAPUSERSUFFIX" target="_top">ldap user suffix</a>,
<a class="link" href="smb.conf.5.html#LDAPGROUPSUFFIX" target="_top">ldap group suffix</a>, <a class="link" href="smb.conf.5.html#LDAPMACHINESUFFIX" target="_top">ldap machine suffix</a>, and the
<a class="link" href="smb.conf.5.html#LDAPIDMAPSUFFIX" target="_top">ldap idmap suffix</a>. Each of these should be given only a DN relative to the
<a class="link" href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap suffix</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap suffix</code></em> = <code class="literal">dc=samba,dc=org</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap timeout (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554001"></a>
ldap timeout (G)
</h3></div></div></div><a class="indexterm" name="id2554002"></a><a name="LDAPTIMEOUT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter defines the number of seconds that Samba should use as timeout for LDAP operations.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap timeout</code></em> = <code class="literal">15</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ldap user suffix (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554043"></a>
ldap user suffix (G)
</h3></div></div></div><a class="indexterm" name="id2554044"></a><a name="LDAPUSERSUFFIX"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies where users are added to the tree. If this parameter is unset,
the value of <a class="link" href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a> will be used instead. The suffix
string is pre-pended to the <a class="link" href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a> string so use a partial DN.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap user suffix</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap user suffix</code></em> = <code class="literal">ou=people</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="level2 oplocks (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554125"></a>
level2 oplocks (S)
</h3></div></div></div><a class="indexterm" name="id2554126"></a><a name="LEVEL2OPLOCKS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether Samba supports
level2 (read-only) oplocks on a share.</p><p>Level2, or read-only oplocks allow Windows NT clients
that have an oplock on a file to downgrade from a read-write oplock
to a read-only oplock once a second client opens the file (instead
of releasing all oplocks on a second open, as in traditional,
exclusive oplocks). This allows all openers of the file that
support level2 oplocks to cache the file for read-ahead only (ie.
they may not cache writes or lock requests) and increases performance
for many accesses of files that are not commonly written (such as
application .EXE files).</p><p>Once one of the clients which have a read-only oplock
writes to the file all clients are notified (no reply is needed
or waited for) and told to break their oplocks to "none" and
delete any read-ahead caches.</p><p>It is recommended that this parameter be turned on to
speed access to shared executables.</p><p>For more discussions on level2 oplocks see the CIFS spec.</p><p>
Currently, if <a class="link" href="smb.conf.5.html#KERNELOPLOCKS" target="_top">kernel oplocks</a> are supported then
level2 oplocks are not granted (even if this parameter is set to
<code class="constant">yes</code>). Note also, the <a class="link" href="smb.conf.5.html#OPLOCKS" target="_top">oplocks</a>
parameter must be set to <code class="constant">yes</code> on this share in order for
this parameter to have any effect.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>level2 oplocks</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="lm announce (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554232"></a>
lm announce (G)
</h3></div></div></div><a class="indexterm" name="id2554233"></a><a name="LMANNOUNCE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines if <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will produce Lanman announce
broadcasts that are needed by OS/2 clients in order for them to see
the Samba server in their browse list. This parameter can have three
values, <code class="constant">yes</code>, <code class="constant">no</code>, or
<code class="constant">auto</code>. The default is <code class="constant">auto</code>.
If set to <code class="constant">no</code> Samba will never produce these
broadcasts. If set to <code class="constant">yes</code> Samba will produce
Lanman announce broadcasts at a frequency set by the parameter
<a class="link" href="smb.conf.5.html#LMINTERVAL" target="_top">lm interval</a>. If set to <code class="constant">auto</code>
Samba will not send Lanman announce broadcasts by default but will
listen for them. If it hears such a broadcast on the wire it will
then start sending them at a frequency set by the parameter
<a class="link" href="smb.conf.5.html#LMINTERVAL" target="_top">lm interval</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lm announce</code></em> = <code class="literal">auto</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lm announce</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="lm interval (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554354"></a>
lm interval (G)
</h3></div></div></div><a class="indexterm" name="id2554355"></a><a name="LMINTERVAL"></a><div class="variablelist"><dl><dt></dt><dd><p>If Samba is set to produce Lanman announce
broadcasts needed by OS/2 clients (see the
<a class="link" href="smb.conf.5.html#LMANNOUNCE" target="_top">lm announce</a> parameter) then this
parameter defines the frequency in seconds with which they will be
made. If this is set to zero then no Lanman announcements will be
made despite the setting of the <a class="link" href="smb.conf.5.html#LMANNOUNCE" target="_top">lm announce</a>
parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lm interval</code></em> = <code class="literal">60</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lm interval</code></em> = <code class="literal">120</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="load printers (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554438"></a>
load printers (G)
</h3></div></div></div><a class="indexterm" name="id2554439"></a><a name="LOADPRINTERS"></a><div class="variablelist"><dl><dt></dt><dd><p>A boolean variable that controls whether all
printers in the printcap will be loaded for browsing by default.
See the <a class="link" href="smb.conf.5.html#PRINTERS" target="_top">printers</a> section for
more details.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>load printers</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="local master (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554494"></a>
local master (G)
</h3></div></div></div><a class="indexterm" name="id2554495"></a><a name="LOCALMASTER"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> to try and become a local master browser
on a subnet. If set to <code class="constant">no</code> then <code class="literal">
nmbd</code> will not attempt to become a local master browser
on a subnet and will also lose in all browsing elections. By
default this value is set to <code class="constant">yes</code>. Setting this value to
<code class="constant">yes</code> doesn't mean that Samba will <span class="emphasis"><em>become</em></span> the
local master browser on a subnet, just that <code class="literal">nmbd</code>
will <span class="emphasis"><em>participate</em></span> in elections for local master browser.</p><p>Setting this value to <code class="constant">no</code> will cause <code class="literal">nmbd</code> <span class="emphasis"><em>never</em></span> to become a local
master browser.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>local master</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="lock dir"><div class="titlepage"><div><div><h3 class="title"><a name="id2554594"></a>
<a name="LOCKDIR"></a>lock dir
</h3></div></div></div><a class="indexterm" name="id2554595"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#LOCKDIRECTORY">lock directory</a>.</p></dd></dl></div></div><div class="section" title="lock directory (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554626"></a>
lock directory (G)
</h3></div></div></div><a class="indexterm" name="id2554627"></a><a name="LOCKDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>This option specifies the directory where lock
files will be placed. The lock files are used to implement the
<a class="link" href="smb.conf.5.html#MAXCONNECTIONS" target="_top">max connections</a> option.
</p><p>
Note: This option can not be set inside registry
configurations.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lock directory</code></em> = <code class="literal">${prefix}/var/locks</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lock directory</code></em> = <code class="literal">/var/run/samba/locks</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="locking (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554705"></a>
locking (S)
</h3></div></div></div><a class="indexterm" name="id2554706"></a><a name="LOCKING"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether or not locking will be
performed by the server in response to lock requests from the
client.</p><p>If <code class="literal">locking = no</code>, all lock and unlock
requests will appear to succeed and all lock queries will report
that the file in question is available for locking.</p><p>If <code class="literal">locking = yes</code>, real locking will be performed
by the server.</p><p>This option <span class="emphasis"><em>may</em></span> be useful for read-only
filesystems which <span class="emphasis"><em>may</em></span> not need locking (such as
CDROM drives), although setting this parameter of <code class="constant">no</code>
is not really recommended even in this case.</p><p>Be careful about disabling locking either globally or in a
specific service, as lack of locking may result in data corruption.
You should never need to set this parameter.</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" title="lock spin count (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554780"></a>
lock spin count (G)
</h3></div></div></div><a class="indexterm" name="id2554781"></a><a name="LOCKSPINCOUNT"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter has been made inoperative in Samba 3.0.24.
The functionality it contolled is now controlled by the parameter
<a class="link" href="smb.conf.5.html#LOCKSPINTIME" target="_top">lock spin time</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lock spin count</code></em> = <code class="literal">0</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="lock spin time (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554836"></a>
lock spin time (G)
</h3></div></div></div><a class="indexterm" name="id2554837"></a><a name="LOCKSPINTIME"></a><div class="variablelist"><dl><dt></dt><dd><p>The time in microseconds that smbd should
keep waiting to see if a failed lock request can
be granted. This parameter has changed in default
value from Samba 3.0.23 from 10 to 200. The associated
<a class="link" href="smb.conf.5.html#LOCKSPINCOUNT" target="_top">lock spin count</a> parameter is
no longer used in Samba 3.0.24. You should not need
to change the value of this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lock spin time</code></em> = <code class="literal">200</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="log file (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554894"></a>
log file (G)
</h3></div></div></div><a class="indexterm" name="id2554895"></a><a name="LOGFILE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option allows you to override the name of the Samba log file (also known as the debug file).
</p><p>
This option takes the standard substitutions, allowing you to have separate log files for each user or machine.
</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>log file</code></em> = <code class="literal">/usr/local/samba/var/log.%m</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="debuglevel"><div class="titlepage"><div><div><h3 class="title"><a name="id2554947"></a>
<a name="DEBUGLEVEL"></a>debuglevel
</h3></div></div></div><a class="indexterm" name="id2554948"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#LOGLEVEL">log level</a>.</p></dd></dl></div></div><div class="section" title="log level (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2554978"></a>
log level (G)
</h3></div></div></div><a class="indexterm" name="id2554979"></a><a name="LOGLEVEL"></a><div class="variablelist"><dl><dt></dt><dd><p>
The value of the parameter (a astring) allows the debug level (logging level) to be specified in the
<code class="filename">smb.conf</code> file.
</p><p>This parameter has been extended since the 2.2.x
series, now it allows to specify the debug level for multiple
debug classes. This is to give greater flexibility in the configuration
of the system. The following debug classes are currently implemented:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>all</code></em></p></li><li class="listitem"><p><em class="parameter"><code>tdb</code></em></p></li><li class="listitem"><p><em class="parameter"><code>printdrivers</code></em></p></li><li class="listitem"><p><em class="parameter"><code>lanman</code></em></p></li><li class="listitem"><p><em class="parameter"><code>smb</code></em></p></li><li class="listitem"><p><em class="parameter"><code>rpc_parse</code></em></p></li><li class="listitem"><p><em class="parameter"><code>rpc_srv</code></em></p></li><li class="listitem"><p><em class="parameter"><code>rpc_cli</code></em></p></li><li class="listitem"><p><em class="parameter"><code>passdb</code></em></p></li><li class="listitem"><p><em class="parameter"><code>sam</code></em></p></li><li class="listitem"><p><em class="parameter"><code>auth</code></em></p></li><li class="listitem"><p><em class="parameter"><code>winbind</code></em></p></li><li class="listitem"><p><em class="parameter"><code>vfs</code></em></p></li><li class="listitem"><p><em class="parameter"><code>idmap</code></em></p></li><li class="listitem"><p><em class="parameter"><code>quota</code></em></p></li><li class="listitem"><p><em class="parameter"><code>acls</code></em></p></li><li class="listitem"><p><em class="parameter"><code>locking</code></em></p></li><li class="listitem"><p><em class="parameter"><code>msdfs</code></em></p></li><li class="listitem"><p><em class="parameter"><code>dmapi</code></em></p></li><li class="listitem"><p><em class="parameter"><code>registry</code></em></p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>log level</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>log level</code></em> = <code class="literal">3 passdb:5 auth:10 winbind:2</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="logon drive (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2555211"></a>
logon drive (G)
</h3></div></div></div><a class="indexterm" name="id2555212"></a><a name="LOGONDRIVE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the local path to which the home directory will be
connected (see <a class="link" href="smb.conf.5.html#LOGONHOME" target="_top">logon home</a>) and is only used by NT
Workstations.
</p><p>
Note that this option is only useful if Samba is set up as a logon server.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>logon drive</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>logon drive</code></em> = <code class="literal">h:</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="logon home (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2555286"></a>
logon home (G)
</h3></div></div></div><a class="indexterm" name="id2555287"></a><a name="LOGONHOME"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC.
It allows you to do
</p><p>
<code class="prompt">C:\></code><strong class="userinput"><code>NET USE H: /HOME</code></strong>
</p><p>
from a command prompt, for example.
</p><p>
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine.
</p><p>
This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a
subdirectory of the user's home directory. This is done in the following way:
</p><p>
<code class="literal">logon home = \\%N\%U\profile</code>
</p><p>
This tells Samba to return the above string, with substitutions made when a client requests the info, generally
in a NetUserGetInfo request. Win9X clients truncate the info to \\server\share when a user does
<code class="literal">net use /home</code> but use the whole string when dealing with profiles.
</p><p>
Note that in prior versions of Samba, the <a class="link" href="smb.conf.5.html#LOGONPATH" target="_top">logon path</a> was returned rather than
<em class="parameter"><code>logon home</code></em>. This broke <code class="literal">net use /home</code>
but allowed profiles outside the home directory. The current implementation is correct, and can be used for
profiles if you use the above trick.
</p><p>
Disable this feature by setting <a class="link" href="smb.conf.5.html#LOGONHOME" target="_top">logon home = ""</a> - using the empty string.
</p><p>
This option is only useful if Samba is set up as a logon server.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>logon home</code></em> = <code class="literal">\\%N\%U</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>logon home</code></em> = <code class="literal">\\remote_smb_server\%U</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="logon path (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2555451"></a>
logon path (G)
</h3></div></div></div><a class="indexterm" name="id2555452"></a><a name="LOGONPATH"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the directory where roaming profiles (Desktop, NTuser.dat, etc) are
stored. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming
profiles. To find out how to handle roaming profiles for Win 9X system, see the
<a class="link" href="smb.conf.5.html#LOGONHOME" target="_top">logon home</a> parameter.
</p><p>
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or
machine. It also specifies the directory from which the "Application Data", <code class="filename">desktop</code>, <code class="filename">start menu</code>, <code class="filename">network neighborhood</code>, <code class="filename">programs</code> and other
folders, and their contents, are loaded and displayed on your Windows NT client.
</p><p>
The share and the path must be readable by the user for the preferences and directories to be loaded onto the
Windows NT client. The share must be writeable when the user logs in for the first time, in order that the
Windows NT client can create the NTuser.dat and other directories.
Thereafter, the directories and any of the contents can, if required, be made read-only. It is not advisable
that the NTuser.dat file be made read-only - rename it to NTuser.man to achieve the desired effect (a
<span class="emphasis"><em>MAN</em></span>datory profile).
</p><p>
Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged
in. Therefore, it is vital that the logon path does not include a reference to the homes share (i.e. setting
this parameter to \\%N\homes\profile_path will cause problems).
</p><p>
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine.
</p><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>
Do not quote the value. Setting this as <span class="quote">“<span class="quote">\\%N\profile\%U</span>”</span>
will break profile handling. Where the tdbsam or ldapsam passdb backend
is used, at the time the user account is created the value configured
for this parameter is written to the passdb backend and that value will
over-ride the parameter value present in the smb.conf file. Any error
present in the passdb backend account record must be editted using the
appropriate tool (pdbedit on the command-line, or any other locally
provided system tool).
</p></div><p>Note that this option is only useful if Samba is set up as a domain controller.</p><p>
Disable the use of roaming profiles by setting the value of this parameter to the empty string. For
example, <a class="link" href="smb.conf.5.html#LOGONPATH" target="_top">logon path = ""</a>. Take note that even if the default setting
in the smb.conf file is the empty string, any value specified in the user account settings in the passdb
backend will over-ride the effect of setting this parameter to null. Disabling of all roaming profile use
requires that the user account settings must also be blank.
</p><p>
An example of use is:
</p><pre class="programlisting">
logon path = \\PROFILESERVER\PROFILE\%U
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>logon path</code></em> = <code class="literal">\\%N\%U\profile</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="logon script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2555620"></a>
logon script (G)
</h3></div></div></div><a class="indexterm" name="id2555621"></a><a name="LOGONSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the batch file (<code class="filename">.bat</code>) or NT command file
(<code class="filename">.cmd</code>) to be downloaded and run on a machine when a user successfully logs in. The file
must contain the DOS style CR/LF line endings. Using a DOS-style editor to create the file is recommended.
</p><p>
The script must be a relative path to the <em class="parameter"><code>[netlogon]</code></em> service. If the [netlogon]
service specifies a <a class="link" href="smb.conf.5.html#PATH" target="_top">path</a> of <code class="filename">/usr/local/samba/netlogon</code>, and <a class="link" href="smb.conf.5.html#LOGONSCRIPT" target="_top">logon script = STARTUP.BAT</a>, then the file that will be downloaded is:
</p><pre class="programlisting">
/usr/local/samba/netlogon/STARTUP.BAT
</pre><p>
</p><p>
The contents of the batch file are entirely your choice. A suggested command would be to add <code class="literal">NET TIME \\SERVER /SET /YES</code>, to force every machine to synchronize clocks with the
same time server. Another use would be to add <code class="literal">NET USE U: \\SERVER\UTILS</code>
for commonly used utilities, or
</p><pre class="programlisting">
<strong class="userinput"><code>NET USE Q: \\SERVER\ISO9001_QA</code></strong>
</pre><p>
for example.
</p><p>
Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users
write permission on the batch files in a secure environment, as this would allow the batch files to be
arbitrarily modified and security to be breached.
</p><p>
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or
machine.
</p><p>
This option is only useful if Samba is set up as a logon server.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>logon script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>logon script</code></em> = <code class="literal">scripts\%U.bat</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="lppause command (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2555789"></a>
lppause command (S)
</h3></div></div></div><a class="indexterm" name="id2555790"></a><a name="LPPAUSECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to stop printing or spooling
a specific print job.</p><p>This command should be a program or script which takes
a printer name and job number to pause the print job. One way
of implementing this is by using job priorities, where jobs
having a too low priority won't be sent to the printer.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name
is put in its place. A <em class="parameter"><code>%j</code></em> is replaced with
the job number (an integer). On HPUX (see <em class="parameter"><code>printing=hpux
</code></em>), if the <em class="parameter"><code>-p%p</code></em> option is added
to the lpq command, the job will show up with the correct status, i.e.
if the job priority is lower than the set fence priority it will
have the PAUSED status, whereas if the priority is equal or higher it
will have the SPOOLED or PRINTING status.</p><p>Note that it is good practice to include the absolute path
in the lppause command as the PATH may not be available to the server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lppause command</code></em> = <code class="literal">
# Currently no default value is given to
this string, unless the value of the <a class="link" href="smb.conf.5.html#PRINTING" target="_top">printing</a>
parameter is <code class="constant">SYSV</code>, in which case the default is :
<code class="literal">lp -i %p-%j -H hold</code> or if the value of the
<em class="parameter"><code>printing</code></em> parameter is
<code class="constant">SOFTQ</code>, then the default is:
<code class="literal">qstat -s -j%j -h</code>. </code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lppause command</code></em> = <code class="literal">/usr/bin/lpalt %p-%j -p0</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="lpq cache time (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2555937"></a>
lpq cache time (G)
</h3></div></div></div><a class="indexterm" name="id2555938"></a><a name="LPQCACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls how long lpq info will be cached
for to prevent the <code class="literal">lpq</code> command being called too
often. A separate cache is kept for each variation of the <code class="literal">
lpq</code> command used by the system, so if you use different
<code class="literal">lpq</code> commands for different users then they won't
share cache information.</p><p>The cache files are stored in <code class="filename">/tmp/lpq.xxxx</code>
where xxxx is a hash of the <code class="literal">lpq</code> command in use.</p><p>The default is 30 seconds, meaning that the cached results
of a previous identical <code class="literal">lpq</code> command will be used
if the cached data is less than 30 seconds old. A large value may
be advisable if your <code class="literal">lpq</code> command is very slow.</p><p>A value of 0 will disable caching completely.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lpq cache time</code></em> = <code class="literal">30</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lpq cache time</code></em> = <code class="literal">10</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="lpq command (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2556056"></a>
lpq command (S)
</h3></div></div></div><a class="indexterm" name="id2556057"></a><a name="LPQCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to obtain <code class="literal">lpq
</code>-style printer status information.</p><p>This command should be a program or script which
takes a printer name as its only parameter and outputs printer
status information.</p><p>Currently nine styles of printer status information
are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ.
This covers most UNIX systems. You control which type is expected
using the <em class="parameter"><code>printing =</code></em> option.</p><p>Some clients (notably Windows for Workgroups) may not
correctly send the connection number for the printer they are
requesting status information about. To get around this, the
server reports on the first printer service connected to by the
client. This only happens if the connection number sent is invalid.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name
is put in its place. Otherwise it is placed at the end of the
command.</p><p>Note that it is good practice to include the absolute path
in the <em class="parameter"><code>lpq command</code></em> as the <code class="envar">$PATH
</code> may not be available to the server. When compiled with
the CUPS libraries, no <em class="parameter"><code>lpq command</code></em> is
needed because smbd will make a library call to obtain the
print queue listing.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lpq command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lpq command</code></em> = <code class="literal">/usr/bin/lpq -P%p</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="lpresume command (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2556182"></a>
lpresume command (S)
</h3></div></div></div><a class="indexterm" name="id2556183"></a><a name="LPRESUMECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to restart or continue
printing or spooling a specific print job.</p><p>This command should be a program or script which takes
a printer name and job number to resume the print job. See
also the <a class="link" href="smb.conf.5.html#LPPAUSECOMMAND" target="_top">lppause command</a> parameter.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name
is put in its place. A <em class="parameter"><code>%j</code></em> is replaced with
the job number (an integer).</p><p>Note that it is good practice to include the absolute path
in the <em class="parameter"><code>lpresume command</code></em> as the PATH may not
be available to the server.</p><p>See also the <a class="link" href="smb.conf.5.html#PRINTING" target="_top">printing</a> parameter.</p><p>Default: Currently no default value is given
to this string, unless the value of the <em class="parameter"><code>printing</code></em>
parameter is <code class="constant">SYSV</code>, in which case the default is:</p><p><code class="literal">lp -i %p-%j -H resume</code></p><p>or if the value of the <em class="parameter"><code>printing</code></em> parameter
is <code class="constant">SOFTQ</code>, then the default is:</p><p><code class="literal">qstat -s -j%j -r</code></p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lpresume command</code></em> = <code class="literal">/usr/bin/lpalt %p-%j -p2</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="lprm command (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2556335"></a>
lprm command (S)
</h3></div></div></div><a class="indexterm" name="id2556336"></a><a name="LPRMCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to delete a print job.</p><p>This command should be a program or script which takes
a printer name and job number, and deletes the print job.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name
is put in its place. A <em class="parameter"><code>%j</code></em> is replaced with
the job number (an integer).</p><p>Note that it is good practice to include the absolute
path in the <em class="parameter"><code>lprm command</code></em> as the PATH may not be
available to the server.</p><p>
Examples of use are:
</p><pre class="programlisting">
lprm command = /usr/bin/lprm -P%p %j
or
lprm command = /usr/bin/cancel %p-%j
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lprm command</code></em> = <code class="literal"> determined by printing parameter</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="machine password timeout (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2556423"></a>
machine password timeout (G)
</h3></div></div></div><a class="indexterm" name="id2556424"></a><a name="MACHINEPASSWORDTIMEOUT"></a><div class="variablelist"><dl><dt></dt><dd><p>
If a Samba server is a member of a Windows NT Domain (see the <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security = domain</a> parameter) then periodically a running smbd process will try and change
the MACHINE ACCOUNT PASSWORD stored in the TDB called <code class="filename">private/secrets.tdb
</code>. This parameter specifies how often this password will be changed, in seconds. The default is one
week (expressed in seconds), the same as a Windows NT Domain member server.
</p><p>
See also <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>,
and the <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security = domain</a> parameter.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>machine password timeout</code></em> = <code class="literal">604800</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="magic output (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2556510"></a>
magic output (S)
</h3></div></div></div><a class="indexterm" name="id2556512"></a><a name="MAGICOUTPUT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the name of a file which will contain output created by a magic script (see the
<a class="link" href="smb.conf.5.html#MAGICSCRIPT" target="_top">magic script</a> parameter below).
</p><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>If two clients use the same <em class="parameter"><code>magic script
</code></em> in the same directory the output file content is undefined.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>magic output</code></em> = <code class="literal"><magic script name>.out</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>magic output</code></em> = <code class="literal">myfile.txt</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="magic script (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2556594"></a>
magic script (S)
</h3></div></div></div><a class="indexterm" name="id2556596"></a><a name="MAGICSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the name of a file which,
if opened, will be executed by the server when the file is closed.
This allows a UNIX script to be sent to the Samba host and
executed on behalf of the connected user.</p><p>Scripts executed in this way will be deleted upon
completion assuming that the user has the appropriate level
of privilege and the file permissions allow the deletion.</p><p>If the script generates output, output will be sent to
the file specified by the <a class="link" href="smb.conf.5.html#MAGICOUTPUT" target="_top">magic output</a>
parameter (see above).</p><p>Note that some shells are unable to interpret scripts
containing CR/LF instead of CR as
the end-of-line marker. Magic scripts must be executable
<span class="emphasis"><em>as is</em></span> on the host, which for some hosts and
some shells will require filtering at the DOS end.</p><p>Magic scripts are <span class="emphasis"><em>EXPERIMENTAL</em></span> and
should <span class="emphasis"><em>NOT</em></span> be relied upon.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>magic script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>magic script</code></em> = <code class="literal">user.csh</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="mangled names (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2556700"></a>
mangled names (S)
</h3></div></div></div><a class="indexterm" name="id2556701"></a><a name="MANGLEDNAMES"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether non-DOS names under UNIX
should be mapped to DOS-compatible names ("mangled") and made visible,
or whether non-DOS names should simply be ignored.</p><p>See the section on <a class="link" href="smb.conf.5.html#NAMEMANGLING" target="_top">name mangling</a> for
details on how to control the mangling process.</p><p>If mangling is used then the mangling method is as follows:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>The first (up to) five alphanumeric characters
before the rightmost dot of the filename are preserved, forced
to upper case, and appear as the first (up to) five characters
of the mangled name.</p></li><li class="listitem"><p>A tilde "~" is appended to the first part of the mangled
name, followed by a two-character unique sequence, based on the
original root name (i.e., the original filename minus its final
extension). The final extension is included in the hash calculation
only if it contains any upper case characters or is longer than three
characters.</p><p>Note that the character to use may be specified using
the <a class="link" href="smb.conf.5.html#MANGLINGCHAR" target="_top">mangling char</a>
option, if you don't like '~'.</p></li><li class="listitem"><p>Files whose UNIX name begins with a dot will be
presented as DOS hidden files. The mangled name will be created as
for other filenames, but with the leading dot removed and "___" as
its extension regardless of actual original extension (that's three
underscores).</p></li></ul></div><p>The two-digit hash value consists of upper case alphanumeric characters.</p><p>This algorithm can cause name collisions only if files
in a directory share the same first five alphanumeric characters.
The probability of such a clash is 1/1300.</p><p>The name mangling (if enabled) allows a file to be
copied between UNIX directories from Windows/DOS while retaining
the long UNIX filename. UNIX files can be renamed to a new extension
from Windows/DOS and will retain the same basename. Mangled names
do not change between sessions.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangled names</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="mangle prefix (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2556837"></a>
mangle prefix (G)
</h3></div></div></div><a class="indexterm" name="id2556838"></a><a name="MANGLEPREFIX"></a><div class="variablelist"><dl><dt></dt><dd><p> controls the number of prefix
characters from the original name used when generating
the mangled names. A larger value will give a weaker
hash and therefore more name collisions. The minimum
value is 1 and the maximum value is 6.</p><p>
mangle prefix is effective only when mangling method is hash2.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangle prefix</code></em> = <code class="literal">1</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangle prefix</code></em> = <code class="literal">4</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="mangling char (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2556904"></a>
mangling char (S)
</h3></div></div></div><a class="indexterm" name="id2556905"></a><a name="MANGLINGCHAR"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls what character is used as
the <span class="emphasis"><em>magic</em></span> character in <a class="link" href="smb.conf.5.html#NAMEMANGLING" target="_top">name mangling</a>. The
default is a '~' but this may interfere with some software. Use this option to set
it to whatever you prefer. This is effective only when mangling method is hash.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangling char</code></em> = <code class="literal">~</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangling char</code></em> = <code class="literal">^</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="mangling method (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2556981"></a>
mangling method (G)
</h3></div></div></div><a class="indexterm" name="id2556982"></a><a name="MANGLINGMETHOD"></a><div class="variablelist"><dl><dt></dt><dd><p> controls the algorithm used for the generating
the mangled names. Can take two different values, "hash" and
"hash2". "hash" is the algorithm that was used
used in Samba for many years and was the default in Samba 2.2.x "hash2" is
now the default and is newer and considered a better algorithm (generates less collisions) in
the names. Many Win32 applications store the mangled names and so
changing to algorithms must not be done lightly as these applications
may break unless reinstalled.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangling method</code></em> = <code class="literal">hash2</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangling method</code></em> = <code class="literal">hash</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="map acl inherit (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2557048"></a>
map acl inherit (S)
</h3></div></div></div><a class="indexterm" name="id2557049"></a><a name="MAPACLINHERIT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to map the 'inherit' and 'protected'
access control entry flags stored in Windows ACLs into an extended attribute
called user.SAMBA_PAI. This parameter only takes effect if Samba is being run
on a platform that supports extended attributes (Linux and IRIX so far) and
allows the Windows 2000 ACL editor to correctly use inheritance with the Samba
POSIX ACL mapping code.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map acl inherit</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="map archive (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2557105"></a>
map archive (S)
</h3></div></div></div><a class="indexterm" name="id2557106"></a><a name="MAPARCHIVE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls whether the DOS archive attribute
should be mapped to the UNIX owner execute bit. The DOS archive bit
is set when a file has been modified since its last backup. One
motivation for this option is to keep Samba/your PC from making
any file it touches from becoming executable under UNIX. This can
be quite annoying for shared source code, documents, etc...
</p><p>
Note that this requires the <a class="link" href="smb.conf.5.html#CREATEMASK" target="_top">create mask</a> parameter to be set such that owner
execute bit is not masked out (i.e. it must include 100). See the parameter
<a class="link" href="smb.conf.5.html#CREATEMASK" target="_top">create mask</a> for details.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map archive</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="map hidden (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2557181"></a>
map hidden (S)
</h3></div></div></div><a class="indexterm" name="id2557182"></a><a name="MAPHIDDEN"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls whether DOS style hidden files should be mapped to the UNIX world execute bit.
</p><p>
Note that this requires the <a class="link" href="smb.conf.5.html#CREATEMASK" target="_top">create mask</a> to be set such that the world execute
bit is not masked out (i.e. it must include 001). See the parameter <a class="link" href="smb.conf.5.html#CREATEMASK" target="_top">create mask</a>
for details.
</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" title="map read only (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2557238"></a>
map read only (S)
</h3></div></div></div><a class="indexterm" name="id2557239"></a><a name="MAPREADONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls how the DOS read only attribute should be mapped from a UNIX filesystem.
</p><p>
This parameter can take three different values, which tell <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> how to display the read only attribute on files, where either
<a class="link" href="smb.conf.5.html#STOREDOSATTRIBUTES" target="_top">store dos attributes</a> is set to <code class="constant">No</code>, or no extended attribute is
present. If <a class="link" href="smb.conf.5.html#STOREDOSATTRIBUTES" target="_top">store dos attributes</a> is set to <code class="constant">yes</code> then this
parameter is <span class="emphasis"><em>ignored</em></span>. This is a new parameter introduced in Samba version 3.0.21.
</p><p>The three settings are :</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
<code class="constant">Yes</code> - The read only DOS attribute is mapped to the inverse of the user
or owner write bit in the unix permission mode set. If the owner write bit is not set, the
read only attribute is reported as being set on the file.
If the read only DOS attribute is set, Samba sets the owner, group and
others write bits to zero. Write bits set in an ACL are ignored by Samba.
If the read only DOS attribute is unset, Samba simply sets the write bit of the
owner to one.
</p></li><li class="listitem"><p>
<code class="constant">Permissions</code> - The read only DOS attribute is mapped to the effective permissions of
the connecting user, as evaluated by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> by reading the unix permissions and POSIX ACL (if present).
If the connecting user does not have permission to modify the file, the read only attribute
is reported as being set on the file.
</p></li><li class="listitem"><p>
<code class="constant">No</code> - The read only DOS attribute is unaffected by permissions, and can only be set by
the <a class="link" href="smb.conf.5.html#STOREDOSATTRIBUTES" target="_top">store dos attributes</a> method. This may be useful for exporting mounted CDs.
</p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>map read only</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="map system (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2557395"></a>
map system (S)
</h3></div></div></div><a class="indexterm" name="id2557396"></a><a name="MAPSYSTEM"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls whether DOS style system files should be mapped to the UNIX group execute bit.
</p><p>
Note that this requires the <a class="link" href="smb.conf.5.html#CREATEMASK" target="_top">create mask</a> to be set such that the group
execute bit is not masked out (i.e. it must include 010). See the parameter
<a class="link" href="smb.conf.5.html#CREATEMASK" target="_top">create mask</a> for details.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map system</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="map to guest (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2557464"></a>
map to guest (G)
</h3></div></div></div><a class="indexterm" name="id2557465"></a><a name="MAPTOGUEST"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is only useful in <a class="link" href="smb.conf.5.html#SECURITY" target="_top">SECURITY =
security</a> modes other than <em class="parameter"><code>security = share</code></em>
and <em class="parameter"><code>security = server</code></em>
- i.e. <code class="constant">user</code>, and <code class="constant">domain</code>.</p><p>This parameter can take four different values, which tell
<a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> what to do with user
login requests that don't match a valid UNIX user in some way.</p><p>The four settings are :</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="constant">Never</code> - Means user login
requests with an invalid password are rejected. This is the
default.</p></li><li class="listitem"><p><code class="constant">Bad User</code> - Means user
logins with an invalid password are rejected, unless the username
does not exist, in which case it is treated as a guest login and
mapped into the <a class="link" href="smb.conf.5.html#GUESTACCOUNT" target="_top">guest account</a>.</p></li><li class="listitem"><p><code class="constant">Bad Password</code> - Means user logins
with an invalid password are treated as a guest login and mapped
into the <a class="link" href="smb.conf.5.html#GUESTACCOUNT" target="_top">guest account</a>. Note that
this can cause problems as it means that any user incorrectly typing
their password will be silently logged on as "guest" - and
will not know the reason they cannot access files they think
they should - there will have been no message given to them
that they got their password wrong. Helpdesk services will
<span class="emphasis"><em>hate</em></span> you if you set the <em class="parameter"><code>map to
guest</code></em> parameter this way :-).</p></li><li class="listitem"><p><code class="constant">Bad Uid</code> - Is only applicable when Samba is configured
in some type of domain mode security (security = {domain|ads}) and means that
user logins which are successfully authenticated but which have no valid Unix
user account (and smbd is unable to create one) should be mapped to the defined
guest account. This was the default behavior of Samba 2.x releases. Note that
if a member server is running winbindd, this option should never be required
because the nss_winbind library will export the Windows domain users and groups
to the underlying OS via the Name Service Switch interface.</p></li></ul></div><p>Note that this parameter is needed to set up "Guest"
share services when using <em class="parameter"><code>security</code></em> modes other than
share and server. This is because in these modes the name of the resource being
requested is <span class="emphasis"><em>not</em></span> sent to the server until after
the server has successfully authenticated the client so the server
cannot make authentication decisions at the correct time (connection
to the share) for "Guest" shares. This parameter is not useful with
<em class="parameter"><code>security = server</code></em> as in this security mode
no information is returned about whether a user logon failed due to
a bad username or bad password, the same error is returned from a modern server
in both cases.</p><p>For people familiar with the older Samba releases, this
parameter maps to the old compile-time setting of the <code class="constant">
GUEST_SESSSETUP</code> value in local.h.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map to guest</code></em> = <code class="literal">Never</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>map to guest</code></em> = <code class="literal">Bad User</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="map untrusted to domain (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2557704"></a>
map untrusted to domain (G)
</h3></div></div></div><a class="indexterm" name="id2557705"></a><a name="MAPUNTRUSTEDTODOMAIN"></a><div class="variablelist"><dl><dt></dt><dd><p>
If a client connects to smbd using an untrusted domain name, such as
BOGUS\user, smbd replaces the BOGUS domain with it's SAM name before
attempting to authenticate that user. In the case where smbd is acting as
a PDC this will be DOMAIN\user. In the case where smbd is acting as a
domain member server or a standalone server this will be WORKSTATION\user.
</p><p>
In previous versions of Samba (pre 3.4), if smbd was acting as a domain
member server, the BOGUS domain name would instead be replaced by the
primary domain which smbd was a member of. In this case authentication
would be deferred off to a DC using the credentials DOMAIN\user.
</p><p>
When this parameter is set to <code class="constant">yes</code> smbd provides the
legacy behavior of mapping untrusted domain names to the primary domain.
When smbd is not acting as a domain member server, this parameter has no
effect.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map untrusted to domain</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max connections (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2557771"></a>
max connections (S)
</h3></div></div></div><a class="indexterm" name="id2557772"></a><a name="MAXCONNECTIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows the number of simultaneous connections to a service to be limited.
If <em class="parameter"><code>max connections</code></em> is greater than 0 then connections
will be refused if this number of connections to the service are already open. A value
of zero mean an unlimited number of connections may be made.</p><p>Record lock files are used to implement this feature. The lock files will be stored in
the directory specified by the <a class="link" href="smb.conf.5.html#LOCKDIRECTORY" target="_top">lock directory</a> option.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max connections</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max connections</code></em> = <code class="literal">10</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max disk size (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2557857"></a>
max disk size (G)
</h3></div></div></div><a class="indexterm" name="id2557858"></a><a name="MAXDISKSIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows you to put an upper limit
on the apparent size of disks. If you set this option to 100
then all shares will appear to be not larger than 100 MB in
size.</p><p>Note that this option does not limit the amount of
data you can put on the disk. In the above case you could still
store much more than 100 MB on the disk, but if a client ever asks
for the amount of free disk space or the total disk size then the
result will be bounded by the amount specified in <em class="parameter"><code>max
disk size</code></em>.</p><p>This option is primarily useful to work around bugs
in some pieces of software that can't handle very large disks,
particularly disks over 1GB in size.</p><p>A <em class="parameter"><code>max disk size</code></em> of 0 means no limit.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max disk size</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max disk size</code></em> = <code class="literal">1000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max log size (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2557949"></a>
max log size (G)
</h3></div></div></div><a class="indexterm" name="id2557950"></a><a name="MAXLOGSIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option (an integer in kilobytes) specifies the max size the log file should grow to.
Samba periodically checks the size and if it is exceeded it will rename the file, adding
a <code class="filename">.old</code> extension.
</p><p>A size of 0 means no limit.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max log size</code></em> = <code class="literal">5000</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max log size</code></em> = <code class="literal">1000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max mux (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558020"></a>
max mux (G)
</h3></div></div></div><a class="indexterm" name="id2558021"></a><a name="MAXMUX"></a><div class="variablelist"><dl><dt></dt><dd><p>This option controls the maximum number of
outstanding simultaneous SMB operations that Samba tells the client
it will allow. You should never need to set this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max mux</code></em> = <code class="literal">50</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max open files (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558063"></a>
max open files (G)
</h3></div></div></div><a class="indexterm" name="id2558064"></a><a name="MAXOPENFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter limits the maximum number of
open files that one <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> file
serving process may have open for a client at any one time. The
default for this parameter is set very high (10,000) as Samba uses
only one bit per unopened file.</p><p>The limit of the number of open files is usually set
by the UNIX per-process file descriptor limit rather than
this parameter so you should never need to touch this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max open files</code></em> = <code class="literal">10000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max print jobs (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558123"></a>
max print jobs (S)
</h3></div></div></div><a class="indexterm" name="id2558124"></a><a name="MAXPRINTJOBS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter limits the maximum number of
jobs allowable in a Samba printer queue at any given moment.
If this number is exceeded, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will remote "Out of Space" to the client.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max print jobs</code></em> = <code class="literal">1000</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max print jobs</code></em> = <code class="literal">5000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="protocol"><div class="titlepage"><div><div><h3 class="title"><a name="id2558193"></a>
<a name="PROTOCOL"></a>protocol
</h3></div></div></div><a class="indexterm" name="id2558194"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#MAXPROTOCOL">max protocol</a>.</p></dd></dl></div></div><div class="section" title="max protocol (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558226"></a>
max protocol (G)
</h3></div></div></div><a class="indexterm" name="id2558227"></a><a name="MAXPROTOCOL"></a><div class="variablelist"><dl><dt></dt><dd><p>The value of the parameter (a string) is the highest
protocol level that will be supported by the server.</p><p>Possible values are :</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="constant">CORE</code>: Earliest version. No
concept of user names.</p></li><li class="listitem"><p><code class="constant">COREPLUS</code>: Slight improvements on
CORE for efficiency.</p></li><li class="listitem"><p><code class="constant">LANMAN1</code>: First <span class="emphasis"><em>
modern</em></span> version of the protocol. Long filename
support.</p></li><li class="listitem"><p><code class="constant">LANMAN2</code>: Updates to Lanman1 protocol.</p></li><li class="listitem"><p><code class="constant">NT1</code>: Current up to date version of the protocol.
Used by Windows NT. Known as CIFS.</p></li></ul></div><p>Normally this option should not be set as the automatic
negotiation phase in the SMB protocol takes care of choosing
the appropriate protocol.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max protocol</code></em> = <code class="literal">NT1</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max protocol</code></em> = <code class="literal">LANMAN1</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max reported print jobs (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558351"></a>
max reported print jobs (S)
</h3></div></div></div><a class="indexterm" name="id2558352"></a><a name="MAXREPORTEDPRINTJOBS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter limits the maximum number of jobs displayed in a port monitor for
Samba printer queue at any given moment. If this number is exceeded, the excess
jobs will not be shown. A value of zero means there is no limit on the number of
print jobs reported.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max reported print jobs</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max reported print jobs</code></em> = <code class="literal">1000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max smbd processes (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558415"></a>
max smbd processes (G)
</h3></div></div></div><a class="indexterm" name="id2558416"></a><a name="MAXSMBDPROCESSES"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter limits the maximum number of <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> processes concurrently running on a system and is intended
as a stopgap to prevent degrading service to clients in the event that the server has insufficient
resources to handle more than this number of connections. Remember that under normal operating
conditions, each user will have an <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> associated with him or her to handle connections to all
shares from a given host.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max smbd processes</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max smbd processes</code></em> = <code class="literal">1000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max stat cache size (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558497"></a>
max stat cache size (G)
</h3></div></div></div><a class="indexterm" name="id2558498"></a><a name="MAXSTATCACHESIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter limits the size in memory of any
<em class="parameter"><code>stat cache</code></em> being used
to speed up case insensitive name mappings. It represents
the number of kilobyte (1024) units the stat cache can use.
A value of zero, meaning unlimited, is not advisable due to
increased memory useage. You should not need to change this
parameter.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max stat cache size</code></em> = <code class="literal">256</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max stat cache size</code></em> = <code class="literal">100</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max ttl (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558566"></a>
max ttl (G)
</h3></div></div></div><a class="indexterm" name="id2558567"></a><a name="MAXTTL"></a><div class="variablelist"><dl><dt></dt><dd><p>This option tells <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> what the default 'time to live'
of NetBIOS names should be (in seconds) when <code class="literal">nmbd</code> is
requesting a name using either a broadcast packet or from a WINS server. You should
never need to change this parameter. The default is 3 days.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max ttl</code></em> = <code class="literal">259200</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max wins ttl (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558625"></a>
max wins ttl (G)
</h3></div></div></div><a class="indexterm" name="id2558626"></a><a name="MAXWINSTTL"></a><div class="variablelist"><dl><dt></dt><dd><p>This option tells <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when acting as a WINS server
(<a class="link" href="smb.conf.5.html#WINSSUPPORT" target="_top">wins support = yes</a>) what the maximum
'time to live' of NetBIOS names that <code class="literal">nmbd</code>
will grant will be (in seconds). You should never need to change this
parameter. The default is 6 days (518400 seconds).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max wins ttl</code></em> = <code class="literal">518400</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="max xmit (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558696"></a>
max xmit (G)
</h3></div></div></div><a class="indexterm" name="id2558697"></a><a name="MAXXMIT"></a><div class="variablelist"><dl><dt></dt><dd><p>This option controls the maximum packet size
that will be negotiated by Samba. The default is 16644, which
matches the behavior of Windows 2000. A value below 2048 is likely to cause problems.
You should never need to change this parameter from its default value.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max xmit</code></em> = <code class="literal">16644</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max xmit</code></em> = <code class="literal">8192</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="message command (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558759"></a>
message command (G)
</h3></div></div></div><a class="indexterm" name="id2558760"></a><a name="MESSAGECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies what command to run when the
server receives a WinPopup style message.</p><p>This would normally be a command that would
deliver the message somehow. How this is to be done is
up to your imagination.</p><p>An example is:
</p><pre class="programlisting">
<code class="literal">message command = csh -c 'xedit %s;rm %s' &</code>
</pre><p>
</p><p>This delivers the message using <code class="literal">xedit</code>, then
removes it afterwards. <span class="emphasis"><em>NOTE THAT IT IS VERY IMPORTANT
THAT THIS COMMAND RETURN IMMEDIATELY</em></span>. That's why I
have the '&' on the end. If it doesn't return immediately then
your PCs may freeze when sending messages (they should recover
after 30 seconds, hopefully).</p><p>All messages are delivered as the global guest user.
The command takes the standard substitutions, although <em class="parameter"><code>
%u</code></em> won't work (<em class="parameter"><code>%U</code></em> may be better
in this case).</p><p>Apart from the standard substitutions, some additional
ones apply. In particular:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>%s</code></em> = the filename containing
the message.</p></li><li class="listitem"><p><em class="parameter"><code>%t</code></em> = the destination that
the message was sent to (probably the server name).</p></li><li class="listitem"><p><em class="parameter"><code>%f</code></em> = who the message
is from.</p></li></ul></div><p>You could make this command send mail, or whatever else
takes your fancy. Please let us know of any really interesting
ideas you have.</p><p>
Here's a way of sending the messages as mail to root:
</p><pre class="programlisting">
<code class="literal">message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s</code>
</pre><p>
</p><p>If you don't have a message command then the message
won't be delivered and Samba will tell the sender there was
an error. Unfortunately WfWg totally ignores the error code
and carries on regardless, saying that the message was delivered.
</p><p>
If you want to silently delete it then try:
</p><pre class="programlisting">
<code class="literal">message command = rm %s</code>
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>message command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>message command</code></em> = <code class="literal">csh -c 'xedit %s; rm %s' &</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="min print space (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2558969"></a>
min print space (S)
</h3></div></div></div><a class="indexterm" name="id2558970"></a><a name="MINPRINTSPACE"></a><div class="variablelist"><dl><dt></dt><dd><p>This sets the minimum amount of free disk
space that must be available before a user will be able to spool
a print job. It is specified in kilobytes. The default is 0, which
means a user can always spool a print job.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min print space</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>min print space</code></em> = <code class="literal">2000</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="min protocol (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559032"></a>
min protocol (G)
</h3></div></div></div><a class="indexterm" name="id2559033"></a><a name="MINPROTOCOL"></a><div class="variablelist"><dl><dt></dt><dd><p>The value of the parameter (a string) is the
lowest SMB protocol dialect than Samba will support. Please refer
to the <a class="link" href="smb.conf.5.html#MAXPROTOCOL" target="_top">max protocol</a>
parameter for a list of valid protocol names and a brief description
of each. You may also wish to refer to the C source code in
<code class="filename">source/smbd/negprot.c</code> for a listing of known protocol
dialects supported by clients.</p><p>If you are viewing this parameter as a security measure, you should
also refer to the <a class="link" href="smb.conf.5.html#LANMANAUTH" target="_top">lanman auth</a> parameter. Otherwise, you should never need
to change this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min protocol</code></em> = <code class="literal">CORE</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>min protocol</code></em> = <code class="literal">NT1</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="min receivefile size (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559130"></a>
min receivefile size (G)
</h3></div></div></div><a class="indexterm" name="id2559132"></a><a name="MINRECEIVEFILESIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>This option changes the behavior of <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when processing SMBwriteX calls. Any incoming
SMBwriteX call on a non-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will
be passed to any underlying kernel recvfile or splice system call (if there is no such
call Samba will emulate in user space). This allows zero-copy writes directly from network
socket buffers into the filesystem buffer cache, if available. It may improve performance
but user testing is recommended. If set to zero Samba processes SMBwriteX calls in the
normal way. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be
nonzero. The maximum value is 128k. Values greater than 128k will be silently set to 128k.</p><p>Note this option will have NO EFFECT if set on a SMB signed connection.</p><p>The default is zero, which diables this option.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min receivefile size</code></em> = <code class="literal">0</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="min wins ttl (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559200"></a>
min wins ttl (G)
</h3></div></div></div><a class="indexterm" name="id2559201"></a><a name="MINWINSTTL"></a><div class="variablelist"><dl><dt></dt><dd><p>This option tells <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>
when acting as a WINS server (<a class="link" href="smb.conf.5.html#WINSSUPPORT" target="_top">wins support = yes</a>) what the minimum 'time to live'
of NetBIOS names that <code class="literal">nmbd</code> will grant will be (in
seconds). You should never need to change this parameter. The default
is 6 hours (21600 seconds).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min wins ttl</code></em> = <code class="literal">21600</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="msdfs proxy (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559270"></a>
msdfs proxy (S)
</h3></div></div></div><a class="indexterm" name="id2559271"></a><a name="MSDFSPROXY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter indicates that the share is a
stand-in for another CIFS share whose location is specified by
the value of the parameter. When clients attempt to connect to
this share, they are redirected to the proxied share using
the SMB-Dfs protocol.</p><p>Only Dfs roots can act as proxy shares. Take a look at the
<a class="link" href="smb.conf.5.html#MSDFSROOT" target="_top">msdfs root</a> and <a class="link" href="smb.conf.5.html#HOSTMSDFS" target="_top">host msdfs</a>
options to find out how to set up a Dfs root share.</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>msdfs proxy</code></em> = <code class="literal">\otherserver\someshare</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="msdfs root (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559348"></a>
msdfs root (S)
</h3></div></div></div><a class="indexterm" name="id2559349"></a><a name="MSDFSROOT"></a><div class="variablelist"><dl><dt></dt><dd><p>If set to <code class="constant">yes</code>, Samba treats the
share as a Dfs root and allows clients to browse the
distributed file system tree rooted at the share directory.
Dfs links are specified in the share directory by symbolic
links of the form <code class="filename">msdfs:serverA\\shareA,serverB\\shareB</code>
and so on. For more information on setting up a Dfs tree on
Samba, refer to the MSDFS chapter in the Samba3-HOWTO book.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>msdfs root</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="name cache timeout (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559404"></a>
name cache timeout (G)
</h3></div></div></div><a class="indexterm" name="id2559405"></a><a name="NAMECACHETIMEOUT"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies the number of seconds it takes before
entries in samba's hostname resolve cache time out. If
the timeout is set to 0. the caching is disabled.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>name cache timeout</code></em> = <code class="literal">660</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>name cache timeout</code></em> = <code class="literal">0</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="name resolve order (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559465"></a>
name resolve order (G)
</h3></div></div></div><a class="indexterm" name="id2559466"></a><a name="NAMERESOLVEORDER"></a><div class="variablelist"><dl><dt></dt><dd><p>This option is used by the programs in the Samba
suite to determine what naming services to use and in what order
to resolve host names to IP addresses. Its main purpose to is to
control how netbios name resolution is performed. The option takes a space
separated string of name resolution options.</p><p>The options are: "lmhosts", "host",
"wins" and "bcast". They cause names to be
resolved as follows:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
<code class="constant">lmhosts</code> : Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has
no name type attached to the NetBIOS name (see the manpage for lmhosts for details) then
any name type matches for lookup.
</p></li><li class="listitem"><p>
<code class="constant">host</code> : Do a standard host name to IP address resolution, using the system
<code class="filename">/etc/hosts </code>, NIS, or DNS lookups. This method of name resolution is
operating system depended for instance on IRIX or Solaris this may be controlled by the <code class="filename">/etc/nsswitch.conf</code> file. Note that this method is used only if the NetBIOS name
type being queried is the 0x20 (server) name type or 0x1c (domain controllers). The latter case is only
useful for active directory domains and results in a DNS query for the SRV RR entry matching
_ldap._tcp.domain.
</p></li><li class="listitem"><p><code class="constant">wins</code> : Query a name with
the IP address listed in the <a class="link" href="smb.conf.5.html#WINSSERVER" target="_top">WINSSERVER</a> parameter. If no WINS server has
been specified this method will be ignored.</p></li><li class="listitem"><p><code class="constant">bcast</code> : Do a broadcast on
each of the known local interfaces listed in the <a class="link" href="smb.conf.5.html#INTERFACES" target="_top">interfaces</a>
parameter. This is the least reliable of the name resolution
methods as it depends on the target host being on a locally
connected subnet.</p></li></ul></div><p>The example below will cause the local lmhosts file to be examined
first, followed by a broadcast attempt, followed by a normal
system hostname lookup.</p><p>When Samba is functioning in ADS security mode (<code class="literal">security = ads</code>)
it is advised to use following settings for <em class="parameter"><code>name resolve order</code></em>:</p><p><code class="literal">name resolve order = wins bcast</code></p><p>DC lookups will still be done via DNS, but fallbacks to netbios names will
not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>name resolve order</code></em> = <code class="literal">lmhosts host wins bcast</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>name resolve order</code></em> = <code class="literal">lmhosts bcast host</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="netbios aliases (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559667"></a>
netbios aliases (G)
</h3></div></div></div><a class="indexterm" name="id2559668"></a><a name="NETBIOSALIASES"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of NetBIOS names that nmbd will
advertise as additional names by which the Samba server is known. This allows one machine
to appear in browse lists under multiple names. If a machine is acting as a browse server
or logon server none of these names will be advertised as either browse server or logon
servers, only the primary name of the machine will be advertised with these capabilities.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>netbios aliases</code></em> = <code class="literal">
# empty string (no additional names)</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>netbios aliases</code></em> = <code class="literal">TEST TEST1 TEST2</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="netbios name (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559733"></a>
netbios name (G)
</h3></div></div></div><a class="indexterm" name="id2559734"></a><a name="NETBIOSNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>
This sets the NetBIOS name by which a Samba server is known. By default it is the same as the first component
of the host's DNS name. If a machine is a browse server or logon server this name (or the first component of
the hosts DNS name) will be the name that these services are advertised under.
</p><p>
There is a bug in Samba-3 that breaks operation of browsing and access to shares if the netbios name
is set to the literal name <code class="literal">PIPE</code>. To avoid this problem, do not name your Samba-3
server <code class="literal">PIPE</code>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>netbios name</code></em> = <code class="literal">
# machine DNS name</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>netbios name</code></em> = <code class="literal">MYNAME</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="netbios scope (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559814"></a>
netbios scope (G)
</h3></div></div></div><a class="indexterm" name="id2559816"></a><a name="NETBIOSSCOPE"></a><div class="variablelist"><dl><dt></dt><dd><p>This sets the NetBIOS scope that Samba will
operate under. This should not be set unless every machine
on your LAN also sets this value.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>netbios scope</code></em> = <code class="literal"></code>
</em></span>
</p></dd></dl></div></div><div class="section" title="nis homedir (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559857"></a>
nis homedir (G)
</h3></div></div></div><a class="indexterm" name="id2559858"></a><a name="NISHOMEDIR"></a><div class="variablelist"><dl><dt></dt><dd><p>Get the home share server from a NIS map. For
UNIX systems that use an automounter, the user's home directory
will often be mounted on a workstation on demand from a remote
server. </p><p>When the Samba logon server is not the actual home directory
server, but is mounting the home directories via NFS then two
network hops would be required to access the users home directory
if the logon server told the client to use itself as the SMB server
for home directories (one over SMB and one over NFS). This can
be very slow.</p><p>This option allows Samba to return the home share as
being on a different server to the logon server and as
long as a Samba daemon is running on the home directory server,
it will be mounted on the Samba client directly from the directory
server. When Samba is returning the home share to the client, it
will consult the NIS map specified in
<a class="link" href="smb.conf.5.html#HOMEDIRMAP" target="_top">homedir map</a> and return the server
listed there.</p><p>Note that for this option to work there must be a working
NIS system and the Samba server with this option must also
be a logon server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nis homedir</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="nt acl support (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559943"></a>
nt acl support (S)
</h3></div></div></div><a class="indexterm" name="id2559944"></a><a name="NTACLSUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to map
UNIX permissions into Windows NT access control lists. The UNIX
permissions considered are the the traditional UNIX owner and
group permissions, as well as POSIX ACLs set on any files or
directories. This parameter was formally a global parameter in
releases prior to 2.2.2.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nt acl support</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="ntlm auth (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2559998"></a>
ntlm auth (G)
</h3></div></div></div><a class="indexterm" name="id2559999"></a><a name="NTLMAUTH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines whether or not <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to
authenticate users using the NTLM encrypted password response.
If disabled, either the lanman password hash or an NTLMv2 response
will need to be sent by the client.</p><p>If this option, and <code class="literal">lanman
auth</code> are both disabled, then only NTLMv2 logins will be
permited. Not all clients support NTLMv2, and most will require
special configuration to use it.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ntlm auth</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="nt pipe support (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560062"></a>
nt pipe support (G)
</h3></div></div></div><a class="indexterm" name="id2560063"></a><a name="NTPIPESUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether
<a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will allow Windows NT
clients to connect to the NT SMB specific <code class="constant">IPC$</code>
pipes. This is a developer debugging option and can be left
alone.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nt pipe support</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="nt status support (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560118"></a>
nt status support (G)
</h3></div></div></div><a class="indexterm" name="id2560119"></a><a name="NTSTATUSSUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will negotiate NT specific status
support with Windows NT/2k/XP clients. This is a developer debugging option and should be left alone.
If this option is set to <code class="constant">no</code> then Samba offers
exactly the same DOS error codes that versions prior to Samba 2.2.3
reported.</p><p>You should not need to ever disable this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nt status support</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="null passwords (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560179"></a>
null passwords (G)
</h3></div></div></div><a class="indexterm" name="id2560180"></a><a name="NULLPASSWORDS"></a><div class="variablelist"><dl><dt></dt><dd><p>Allow or disallow client access to accounts that have null passwords. </p><p>See also <a class="citerefentry" href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>null passwords</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="obey pam restrictions (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560233"></a>
obey pam restrictions (G)
</h3></div></div></div><a class="indexterm" name="id2560234"></a><a name="OBEYPAMRESTRICTIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>When Samba 3.0 is configured to enable PAM support
(i.e. --with-pam), this parameter will control whether or not Samba
should obey PAM's account and session management directives. The
default behavior is to use PAM for clear text authentication only
and to ignore any account or session management. Note that Samba
always ignores PAM for authentication in the case of <a class="link" href="smb.conf.5.html#ENCRYPTPASSWORDS" target="_top">encrypt passwords = yes</a>. The reason
is that PAM modules cannot support the challenge/response
authentication mechanism needed in the presence of SMB password encryption.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>obey pam restrictions</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="only user (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560297"></a>
only user (S)
</h3></div></div></div><a class="indexterm" name="id2560298"></a><a name="ONLYUSER"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a boolean option that controls whether
connections with usernames not in the <em class="parameter"><code>user</code></em>
list will be allowed. By default this option is disabled so that a
client can supply a username to be used by the server. Enabling
this parameter will force the server to only use the login
names from the <em class="parameter"><code>user</code></em> list and is only really
useful in <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security = share</a> level security.</p><p>Note that this also means Samba won't try to deduce
usernames from the service name. This can be annoying for
the [homes] section. To get around this you could use <code class="literal">user =
%S</code> which means your <em class="parameter"><code>user</code></em> list
will be just the service name, which for home directories is the
name of the user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>only user</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="oplock break wait time (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560386"></a>
oplock break wait time (G)
</h3></div></div></div><a class="indexterm" name="id2560387"></a><a name="OPLOCKBREAKWAITTIME"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a tuning parameter added due to bugs in both Windows 9x and WinNT. If Samba responds to a client too
quickly when that client issues an SMB that can cause an oplock break request, then the network client can
fail and not respond to the break request. This tuning parameter (which is set in milliseconds) is the amount
of time Samba will wait before sending an oplock break request to such (broken) clients.
</p><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>
DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>oplock break wait time</code></em> = <code class="literal">0</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="oplock contention limit (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560441"></a>
oplock contention limit (S)
</h3></div></div></div><a class="indexterm" name="id2560442"></a><a name="OPLOCKCONTENTIONLIMIT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a <span class="emphasis"><em>very</em></span> advanced <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> tuning option to improve the efficiency of the
granting of oplocks under multiple client contention for the same file.
</p><p>
In brief it specifies a number, which causes <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>not to grant an oplock even when requested if the
approximate number of clients contending for an oplock on the same file goes over this
limit. This causes <code class="literal">smbd</code> to behave in a similar
way to Windows NT.
</p><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>
DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>oplock contention limit</code></em> = <code class="literal">2</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="oplocks (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560523"></a>
oplocks (S)
</h3></div></div></div><a class="indexterm" name="id2560524"></a><a name="OPLOCKS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean option tells <code class="literal">smbd</code> whether to
issue oplocks (opportunistic locks) to file open requests on this
share. The oplock code can dramatically (approx. 30% or more) improve
the speed of access to files on Samba servers. It allows the clients
to aggressively cache files locally and you may want to disable this
option for unreliable network environments (it is turned on by
default in Windows NT Servers).
</p><p>
Oplocks may be selectively turned off on certain files with a share. See
the <a class="link" href="smb.conf.5.html#VETOOPLOCKFILES" target="_top">veto oplock files</a> parameter. On some systems
oplocks are recognized by the underlying operating system. This
allows data synchronization between all access to oplocked files,
whether it be via Samba or NFS or a local UNIX process. See the
<a class="link" href="smb.conf.5.html#KERNELOPLOCKS" target="_top">kernel oplocks</a> parameter for details.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>oplocks</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="os2 driver map (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560609"></a>
os2 driver map (G)
</h3></div></div></div><a class="indexterm" name="id2560610"></a><a name="OS2DRIVERMAP"></a><div class="variablelist"><dl><dt></dt><dd><p>The parameter is used to define the absolute
path to a file containing a mapping of Windows NT printer driver
names to OS/2 printer driver names. The format is:</p><p><nt driver name> = <os2 driver name>.<device name></p><p>For example, a valid entry using the HP LaserJet 5
printer driver would appear as <code class="literal">HP LaserJet 5L = LASERJET.HP
LaserJet 5L</code>.</p><p>
The need for the file is due to the printer driver namespace problem described in
the chapter on Classical Printing in the Samba3-HOWTO book. For more
details on OS/2 clients, please refer to chapter on other clients in the Samba3-HOWTO book.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>os2 driver map</code></em> = <code class="literal"></code>
</em></span>
</p></dd></dl></div></div><div class="section" title="os level (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560676"></a>
os level (G)
</h3></div></div></div><a class="indexterm" name="id2560677"></a><a name="OSLEVEL"></a><div class="variablelist"><dl><dt></dt><dd><p>
This integer value controls what level Samba advertises itself as for browse elections. The value of this
parameter determines whether <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> has a chance of becoming a local master browser for the <a class="link" href="smb.conf.5.html#WORKGROUP" target="_top">workgroup</a> in the local broadcast area.
</p><p><span class="emphasis"><em>
Note:</em></span> By default, Samba will win a local master browsing election over all Microsoft operating
systems except a Windows NT 4.0/2000 Domain Controller. This means that a misconfigured Samba host can
effectively isolate a subnet for browsing purposes. This parameter is largely auto-configured in the Samba-3
release series and it is seldom necessary to manually override the default setting. Please refer to
the chapter on Network Browsing in the Samba-3 HOWTO document for further information regarding the use
of this parameter.
<span class="emphasis"><em>Note:</em></span> The maximum value for this parameter is 255. If you use higher values, counting
will start at 0!
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>os level</code></em> = <code class="literal">20</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>os level</code></em> = <code class="literal">65</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="pam password change (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560776"></a>
pam password change (G)
</h3></div></div></div><a class="indexterm" name="id2560777"></a><a name="PAMPASSWORDCHANGE"></a><div class="variablelist"><dl><dt></dt><dd><p>With the addition of better PAM support in Samba 2.2,
this parameter, it is possible to use PAM's password change control
flag for Samba. If enabled, then PAM will be used for password
changes when requested by an SMB client instead of the program listed in
<a class="link" href="smb.conf.5.html#PASSWDPROGRAM" target="_top">passwd program</a>.
It should be possible to enable this without changing your
<a class="link" href="smb.conf.5.html#PASSWDCHAT" target="_top">passwd chat</a> parameter for most setups.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>pam password change</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="panic action (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560848"></a>
panic action (G)
</h3></div></div></div><a class="indexterm" name="id2560850"></a><a name="PANICACTION"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a Samba developer option that allows a
system command to be called when either <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> or <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> crashes. This is usually used to
draw attention to the fact that a problem occurred.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>panic action</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>panic action</code></em> = <code class="literal">"/bin/sleep 90000"</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="paranoid server security (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560924"></a>
paranoid server security (G)
</h3></div></div></div><a class="indexterm" name="id2560925"></a><a name="PARANOIDSERVERSECURITY"></a><div class="variablelist"><dl><dt></dt><dd><p>Some version of NT 4.x allow non-guest
users with a bad passowrd. When this option is enabled, samba will not
use a broken NT 4.x server as password server, but instead complain
to the logs and exit.
</p><p>Disabling this option prevents Samba from making
this check, which involves deliberatly attempting a
bad logon to the remote server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>paranoid server security</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="passdb backend (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2560976"></a>
passdb backend (G)
</h3></div></div></div><a class="indexterm" name="id2560977"></a><a name="PASSDBBACKEND"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows the administrator to chose which backend
will be used for storing user and possibly group information. This allows
you to swap between different storage mechanisms without recompile. </p><p>The parameter value is divided into two parts, the backend's name, and a 'location'
string that has meaning only to that particular backed. These are separated
by a : character.</p><p>Available backends can include:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="literal">smbpasswd</code> - The old plaintext passdb
backend. Some Samba features will not work if this passdb
backend is used. Takes a path to the smbpasswd file as an
optional argument.
</p></li><li class="listitem"><p><code class="literal">tdbsam</code> - The TDB based password storage
backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
in the <a class="link" href="smb.conf.5.html#PRIVATEDIR" target="_top">private dir</a> directory.</p></li><li class="listitem"><p><code class="literal">ldapsam</code> - The LDAP based passdb
backend. Takes an LDAP URL as an optional argument (defaults to
<code class="literal">ldap://localhost</code>)</p><p>LDAP connections should be secured where possible. This may be done using either
Start-TLS (see <a class="link" href="smb.conf.5.html#LDAPSSL" target="_top">ldap ssl</a>) or by
specifying <em class="parameter"><code>ldaps://</code></em> in
the URL argument. </p><p>Multiple servers may also be specified in double-quotes.
Whether multiple servers are supported or not and the exact
syntax depends on the LDAP library you use.
</p></li></ul></div><p>
</p>
Examples of use are:
<pre class="programlisting">
passdb backend = tdbsam:/etc/samba/private/passdb.tdb
or multi server LDAP URL with OpenLDAP library:
passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
or multi server LDAP URL with Netscape based LDAP library:
passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com"
</pre><p>Default: <span class="emphasis"><em><em class="parameter"><code>passdb backend</code></em> = <code class="literal">tdbsam</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="passdb expand explicit (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2561134"></a>
passdb expand explicit (G)
</h3></div></div></div><a class="indexterm" name="id2561135"></a><a name="PASSDBEXPANDEXPLICIT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls whether Samba substitutes %-macros in the passdb fields if they are explicitly set. We
used to expand macros here, but this turned out to be a bug because the Windows client can expand a variable
%G_osver% in which %G would have been substituted by the user's primary group.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passdb expand explicit</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="passwd chat debug (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2561181"></a>
passwd chat debug (G)
</h3></div></div></div><a class="indexterm" name="id2561182"></a><a name="PASSWDCHATDEBUG"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean specifies if the passwd chat script
parameter is run in <span class="emphasis"><em>debug</em></span> mode. In this mode the
strings passed to and received from the passwd chat are printed
in the <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> log with a
<a class="link" href="smb.conf.5.html#DEBUGLEVEL" target="_top">debug level</a>
of 100. This is a dangerous option as it will allow plaintext passwords
to be seen in the <code class="literal">smbd</code> log. It is available to help
Samba admins debug their <em class="parameter"><code>passwd chat</code></em> scripts
when calling the <em class="parameter"><code>passwd program</code></em> and should
be turned off after this has been done. This option has no effect if the
<a class="link" href="smb.conf.5.html#PAMPASSWORDCHANGE" target="_top">pam password change</a>
parameter is set. This parameter is off by default.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat debug</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="passwd chat timeout (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2561284"></a>
passwd chat timeout (G)
</h3></div></div></div><a class="indexterm" name="id2561286"></a><a name="PASSWDCHATTIMEOUT"></a><div class="variablelist"><dl><dt></dt><dd><p>This integer specifies the number of seconds smbd will wait for an initial
answer from a passwd chat script being run. Once the initial answer is received
the subsequent answers must be received in one tenth of this time. The default it
two seconds.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat timeout</code></em> = <code class="literal">2</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="passwd chat (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2561330"></a>
passwd chat (G)
</h3></div></div></div><a class="indexterm" name="id2561331"></a><a name="PASSWDCHAT"></a><div class="variablelist"><dl><dt></dt><dd><p>This string controls the <span class="emphasis"><em>"chat"</em></span>
conversation that takes places between <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and the local password changing
program to change the user's password. The string describes a
sequence of response-receive pairs that <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> uses to determine what to send to the
<a class="link" href="smb.conf.5.html#PASSWDPROGRAM" target="_top">passwd program</a> and what to expect back. If the expected output is not
received then the password is not changed.</p><p>This chat sequence is often quite site specific, depending
on what local methods are used for password control (such as NIS
etc).</p><p>Note that this parameter only is used if the <a class="link" href="smb.conf.5.html#UNIXPASSWORDSYNC" target="_top">unix password sync</a> parameter is set to <code class="constant">yes</code>. This sequence is
then called <span class="emphasis"><em>AS ROOT</em></span> when the SMB password in the
smbpasswd file is being changed, without access to the old password
cleartext. This means that root must be able to reset the user's password without
knowing the text of the previous password. In the presence of
NIS/YP, this means that the <a class="link" href="smb.conf.5.html#PASSWDPROGRAM" target="_top">passwd program</a> must
be executed on the NIS master.
</p><p>The string can contain the macro <em class="parameter"><code>%n</code></em> which is substituted
for the new password. The old passsword (<em class="parameter"><code>%o</code></em>) is only available when
<a class="link" href="smb.conf.5.html#ENCRYPTPASSWORDS" target="_top">encrypt passwords</a> has been disabled.
The chat sequence can also contain the standard macros
\n, \r, \t and \s to give line-feed, carriage-return, tab
and space. The chat sequence string can also contain
a '*' which matches any sequence of characters. Double quotes can
be used to collect strings with spaces in them into a single
string.</p><p>If the send string in any part of the chat sequence is a full
stop ".", then no string is sent. Similarly, if the
expect string is a full stop then no string is expected.</p><p>If the <a class="link" href="smb.conf.5.html#PAMPASSWORDCHANGE" target="_top">pam password change</a> parameter is set to <code class="constant">yes</code>, the
chat pairs may be matched in any order, and success is determined by the PAM result, not any particular
output. The \n macro is ignored for PAM conversions.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat</code></em> = <code class="literal">*new*password* %n\n*new*password* %n\n *changed*</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>passwd chat</code></em> = <code class="literal">"*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password changed*"</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="passwd program (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2561534"></a>
passwd program (G)
</h3></div></div></div><a class="indexterm" name="id2561535"></a><a name="PASSWDPROGRAM"></a><div class="variablelist"><dl><dt></dt><dd><p>The name of a program that can be used to set
UNIX user passwords. Any occurrences of <em class="parameter"><code>%u</code></em>
will be replaced with the user name. The user name is checked for
existence before calling the password changing program.</p><p>Also note that many passwd programs insist in <span class="emphasis"><em>reasonable
</em></span> passwords, such as a minimum length, or the inclusion
of mixed case chars and digits. This can pose a problem as some clients
(such as Windows for Workgroups) uppercase the password before sending
it.</p><p><span class="emphasis"><em>Note</em></span> that if the <em class="parameter"><code>unix
password sync</code></em> parameter is set to <code class="constant">yes
</code> then this program is called <span class="emphasis"><em>AS ROOT</em></span>
before the SMB password in the smbpasswd
file is changed. If this UNIX password change fails, then
<code class="literal">smbd</code> will fail to change the SMB password also
(this is by design).</p><p>If the <em class="parameter"><code>unix password sync</code></em> parameter
is set this parameter <span class="emphasis"><em>MUST USE ABSOLUTE PATHS</em></span>
for <span class="emphasis"><em>ALL</em></span> programs called, and must be examined
for security implications. Note that by default <em class="parameter"><code>unix
password sync</code></em> is set to <code class="constant">no</code>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd program</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>passwd program</code></em> = <code class="literal">/bin/passwd %u</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="password level (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2561670"></a>
password level (G)
</h3></div></div></div><a class="indexterm" name="id2561671"></a><a name="PASSWORDLEVEL"></a><div class="variablelist"><dl><dt></dt><dd><p>Some client/server combinations have difficulty
with mixed-case passwords. One offending client is Windows for
Workgroups, which for some reason forces passwords to upper
case when using the LANMAN1 protocol, but leaves them alone when
using COREPLUS! Another problem child is the Windows 95/98
family of operating systems. These clients upper case clear
text passwords even when NT LM 0.12 selected by the protocol
negotiation request/response.</p><p>This parameter defines the maximum number of characters
that may be upper case in passwords.</p><p>For example, say the password given was "FRED". If <em class="parameter"><code>
password level</code></em> is set to 1, the following combinations
would be tried if "FRED" failed:</p><p>"Fred", "fred", "fRed", "frEd","freD"</p><p>If <em class="parameter"><code>password level</code></em> was set to 2,
the following combinations would also be tried: </p><p>"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..</p><p>And so on.</p><p>The higher value this parameter is set to the more likely
it is that a mixed case password will be matched against a single
case password. However, you should be aware that use of this
parameter reduces security and increases the time taken to
process a new connection.</p><p>A value of zero will cause only two attempts to be
made - the password as is and the password in all-lower case.</p><p>This parameter is used only when using plain-text passwords. It is
not at all used when encrypted passwords as in use (that is the default
since samba-3.0.0). Use this only when <a class="link" href="smb.conf.5.html#ENCRYPTPASSWORDS" target="_top">encrypt passwords = No</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>password level</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>password level</code></em> = <code class="literal">4</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="password server (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2561807"></a>
password server (G)
</h3></div></div></div><a class="indexterm" name="id2561808"></a><a name="PASSWORDSERVER"></a><div class="variablelist"><dl><dt></dt><dd><p>By specifying the name of another SMB server
or Active Directory domain controller with this option,
and using <code class="literal">security = [ads|domain|server]</code>
it is possible to get Samba
to do all its username/password validation using a specific remote server.</p><p>This option sets the name or IP address of the password server to use.
New syntax has been added to support defining the port to use when connecting
to the server the case of an ADS realm. To define a port other than the
default LDAP port of 389, add the port number using a colon after the
name or IP address (e.g. 192.168.1.100:389). If you do not specify a port,
Samba will use the standard LDAP port of tcp/389. Note that port numbers
have no effect on password servers for Windows NT 4.0 domains or netbios
connections.</p><p>If parameter is a name, it is looked up using the
parameter <a class="link" href="smb.conf.5.html#NAMERESOLVEORDER" target="_top">name resolve order</a> and so may resolved
by any method and order described in that parameter.</p><p>The password server must be a machine capable of using
the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
user level security mode.</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Using a password server means your UNIX box (running
Samba) is only as secure as your password server. <span class="emphasis"><em>DO NOT
CHOOSE A PASSWORD SERVER THAT YOU DON'T COMPLETELY TRUST</em></span>.
</p></div><p>Never point a Samba server at itself for password serving.
This will cause a loop and could lock up your Samba server!</p><p>The name of the password server takes the standard
substitutions, but probably the only useful one is <em class="parameter"><code>%m
</code></em>, which means the Samba server will use the incoming
client as the password server. If you use this then you better
trust your clients, and you had better restrict them with hosts allow!</p><p>If the <em class="parameter"><code>security</code></em> parameter is set to
<code class="constant">domain</code> or <code class="constant">ads</code>, then the list of machines in this
option must be a list of Primary or Backup Domain controllers for the
Domain or the character '*', as the Samba server is effectively
in that domain, and will use cryptographically authenticated RPC calls
to authenticate the user logging on. The advantage of using <code class="literal">
security = domain</code> is that if you list several hosts in the
<em class="parameter"><code>password server</code></em> option then <code class="literal">smbd
</code> will try each in turn till it finds one that responds. This
is useful in case your primary server goes down.</p><p>If the <em class="parameter"><code>password server</code></em> option is set
to the character '*', then Samba will attempt to auto-locate the
Primary or Backup Domain controllers to authenticate against by
doing a query for the name <code class="constant">WORKGROUP<1C></code>
and then contacting each server returned in the list of IP
addresses from the name resolution source. </p><p>If the list of servers contains both names/IP's and the '*'
character, the list is treated as a list of preferred
domain controllers, but an auto lookup of all remaining DC's
will be added to the list as well. Samba will not attempt to optimize
this list by locating the closest DC.</p><p>If the <em class="parameter"><code>security</code></em> parameter is
set to <code class="constant">server</code>, then there are different
restrictions that <code class="literal">security = domain</code> doesn't
suffer from:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>You may list several password servers in
the <em class="parameter"><code>password server</code></em> parameter, however if an
<code class="literal">smbd</code> makes a connection to a password server,
and then the password server fails, no more users will be able
to be authenticated from this <code class="literal">smbd</code>. This is a
restriction of the SMB/CIFS protocol when in <code class="literal">security = server
</code> mode and cannot be fixed in Samba.</p></li><li class="listitem"><p>If you are using a Windows NT server as your
password server then you will have to ensure that your users
are able to login from the Samba server, as when in <code class="literal">
security = server</code> mode the network logon will appear to
come from there rather than from the users workstation.</p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>password server</code></em> = <code class="literal">*</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>password server</code></em> = <code class="literal">NT-PDC, NT-BDC1, NT-BDC2, *</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>password server</code></em> = <code class="literal">windc.mydomain.com:389 192.168.1.101 *</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="directory"><div class="titlepage"><div><div><h3 class="title"><a name="id2562106"></a>
<a name="DIRECTORY"></a>directory
</h3></div></div></div><a class="indexterm" name="id2562107"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PATH">path</a>.</p></dd></dl></div></div><div class="section" title="path (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562137"></a>
path (S)
</h3></div></div></div><a class="indexterm" name="id2562138"></a><a name="PATH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies a directory to which
the user of the service is to be given access. In the case of
printable services, this is where print data will spool prior to
being submitted to the host for printing.</p><p>For a printable service offering guest access, the service
should be readonly and the path should be world-writeable and
have the sticky bit set. This is not mandatory of course, but
you probably won't get the results you expect if you do
otherwise.</p><p>Any occurrences of <em class="parameter"><code>%u</code></em> in the path
will be replaced with the UNIX username that the client is using
on this connection. Any occurrences of <em class="parameter"><code>%m</code></em>
will be replaced by the NetBIOS name of the machine they are
connecting from. These replacements are very useful for setting
up pseudo home directories for users.</p><p>Note that this path will be based on <a class="link" href="smb.conf.5.html#ROOTDIR" target="_top">root dir</a>
if one was specified.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>path</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>path</code></em> = <code class="literal">/home/fred</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="perfcount module (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562241"></a>
perfcount module (G)
</h3></div></div></div><a class="indexterm" name="id2562242"></a><a name="PERFCOUNTMODULE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the perfcount backend to be used when monitoring SMB
operations. Only one perfcount module may be used, and it must implement all of the
apis contained in the smb_perfcount_handler structure defined in smb.h.
</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" title="pid directory (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562274"></a>
pid directory (G)
</h3></div></div></div><a class="indexterm" name="id2562276"></a><a name="PIDDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option specifies the directory where pid files will be placed.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>pid directory</code></em> = <code class="literal">${prefix}/var/locks</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>pid directory</code></em> = <code class="literal">pid directory = /var/run/</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="posix locking (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562334"></a>
posix locking (S)
</h3></div></div></div><a class="indexterm" name="id2562335"></a><a name="POSIXLOCKING"></a><div class="variablelist"><dl><dt></dt><dd><p>
The <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
daemon maintains an database of file locks obtained by SMB clients. The default behavior is
to map this internal database to POSIX locks. This means that file locks obtained by SMB clients are
consistent with those seen by POSIX compliant applications accessing the files via a non-SMB
method (e.g. NFS or local file access). You should never need to disable this parameter.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>posix locking</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="postexec (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562390"></a>
postexec (S)
</h3></div></div></div><a class="indexterm" name="id2562391"></a><a name="POSTEXEC"></a><div class="variablelist"><dl><dt></dt><dd><p>This option specifies a command to be run
whenever the service is disconnected. It takes the usual
substitutions. The command may be run as the root on some
systems.</p><p>An interesting example may be to unmount server
resources:</p><p><code class="literal">postexec = /etc/umount /cdrom</code></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>postexec</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>postexec</code></em> = <code class="literal">echo \"%u disconnected from %S from %m (%I)\" >> /tmp/log</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="preexec close (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562462"></a>
preexec close (S)
</h3></div></div></div><a class="indexterm" name="id2562464"></a><a name="PREEXECCLOSE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean option controls whether a non-zero return code from <a class="link" href="smb.conf.5.html#PREEXEC" target="_top">preexec</a>
should close the service being connected to.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preexec close</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="exec"><div class="titlepage"><div><div><h3 class="title"><a name="id2562518"></a>
<a name="EXEC"></a>exec
</h3></div></div></div><a class="indexterm" name="id2562519"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PREEXEC">preexec</a>.</p></dd></dl></div></div><div class="section" title="preexec (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562549"></a>
preexec (S)
</h3></div></div></div><a class="indexterm" name="id2562550"></a><a name="PREEXEC"></a><div class="variablelist"><dl><dt></dt><dd><p>This option specifies a command to be run whenever
the service is connected to. It takes the usual substitutions.</p><p>An interesting example is to send the users a welcome
message every time they log in. Maybe a message of the day? Here
is an example:</p><p>
<code class="literal">preexec = csh -c 'echo \"Welcome to %S!\" |
/usr/local/samba/bin/smbclient -M %m -I %I' & </code>
</p><p>Of course, this could get annoying after a while :-)</p><p>
See also <a class="link" href="smb.conf.5.html#PREEXECCLOSE" target="_top">preexec close</a> and <a class="link" href="smb.conf.5.html#POSTEXEC" target="_top">postexec</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preexec</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>preexec</code></em> = <code class="literal">echo \"%u connected to %S from %m (%I)\" >> /tmp/log</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="prefered master"><div class="titlepage"><div><div><h3 class="title"><a name="id2562657"></a>
<a name="PREFEREDMASTER"></a>prefered master
</h3></div></div></div><a class="indexterm" name="id2562658"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PREFERREDMASTER">preferred master</a>.</p></dd></dl></div></div><div class="section" title="preferred master (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562691"></a>
preferred master (G)
</h3></div></div></div><a class="indexterm" name="id2562692"></a><a name="PREFERREDMASTER"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean parameter controls if <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> is a preferred master browser for its workgroup.
</p><p>
If this is set to <code class="constant">yes</code>, on startup, <code class="literal">nmbd</code> will force
an election, and it will have a slight advantage in winning the election. It is recommended that this
parameter is used in conjunction with <a class="link" href="smb.conf.5.html#DOMAINMASTER" target="_top">domain master = yes</a>, so that
<code class="literal">nmbd</code> can guarantee becoming a domain master.
</p><p>
Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT)
that are preferred master browsers on the same subnet, they will each periodically and continuously attempt
to become the local master browser. This will result in unnecessary broadcast traffic and reduced browsing
capabilities.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preferred master</code></em> = <code class="literal">auto</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="preload modules (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562784"></a>
preload modules (G)
</h3></div></div></div><a class="indexterm" name="id2562785"></a><a name="PRELOADMODULES"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of paths to modules that should
be loaded into smbd before a client connects. This improves
the speed of smbd when reacting to new connections somewhat. </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preload modules</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>preload modules</code></em> = <code class="literal">/usr/lib/samba/passdb/mysql.so</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="auto services"><div class="titlepage"><div><div><h3 class="title"><a name="id2562845"></a>
<a name="AUTOSERVICES"></a>auto services
</h3></div></div></div><a class="indexterm" name="id2562846"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PRELOAD">preload</a>.</p></dd></dl></div></div><div class="section" title="preload (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562878"></a>
preload (G)
</h3></div></div></div><a class="indexterm" name="id2562879"></a><a name="PRELOAD"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of services that you want to be
automatically added to the browse lists. This is most useful
for homes and printers services that would otherwise not be
visible.</p><p>
Note that if you just want all printers in your
printcap file loaded then the <a class="link" href="smb.conf.5.html#LOADPRINTERS" target="_top">load printers</a>
option is easier.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preload</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>preload</code></em> = <code class="literal">fred lp colorlp</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="preserve case (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2562956"></a>
preserve case (S)
</h3></div></div></div><a class="indexterm" name="id2562957"></a><a name="PRESERVECASE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls if new filenames are created with the case that the client passes, or if
they are forced to be the <a class="link" href="smb.conf.5.html#DEFAULTCASE" target="_top">default case</a>.
</p><p>
See the section on <a class="link" href="#NAMEMANGLINGSECT" title="NAME MANGLING">NAME MANGLING</a> for a fuller discussion.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preserve case</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="print ok"><div class="titlepage"><div><div><h3 class="title"><a name="id2563022"></a>
<a name="PRINTOK"></a>print ok
</h3></div></div></div><a class="indexterm" name="id2563023"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PRINTABLE">printable</a>.</p></dd></dl></div></div><div class="section" title="printable (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2563053"></a>
printable (S)
</h3></div></div></div><a class="indexterm" name="id2563054"></a><a name="PRINTABLE"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is <code class="constant">yes</code>, then
clients may open, write to and submit spool files on the directory
specified for the service. </p><p>Note that a printable service will ALWAYS allow writing
to the service path (user privileges permitting) via the spooling
of print data. The <a class="link" href="smb.conf.5.html#READONLY" target="_top">read only</a> parameter controls only non-printing access to
the resource.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printable</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="printcap cache time (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2563116"></a>
printcap cache time (G)
</h3></div></div></div><a class="indexterm" name="id2563118"></a><a name="PRINTCAPCACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>This option specifies the number of seconds before the printing
subsystem is again asked for the known printers. If the value
is greater than 60 the initial waiting time is set to 60 seconds
to allow an earlier first rescan of the printing subsystem.
</p><p>Setting this parameter to 0 disables any rescanning for new
or removed printers after the initial startup.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printcap cache time</code></em> = <code class="literal">750</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printcap cache time</code></em> = <code class="literal">600</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="printcap"><div class="titlepage"><div><div><h3 class="title"><a name="id2563185"></a>
<a name="PRINTCAP"></a>printcap
</h3></div></div></div><a class="indexterm" name="id2563186"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PRINTCAPNAME">printcap name</a>.</p></dd></dl></div></div><div class="section" title="printcap name (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2563218"></a>
printcap name (G)
</h3></div></div></div><a class="indexterm" name="id2563219"></a><a name="PRINTCAPNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter may be used to override the compiled-in default printcap name used by the server (usually
<code class="filename"> /etc/printcap</code>). See the discussion of the <a class="link" href="#PRINTERSSECT" title="The [printers] section">[printers]</a> section above for reasons why you might want to do this.
</p><p>
To use the CUPS printing interface set <code class="literal">printcap name = cups </code>. This should
be supplemented by an addtional setting <a class="link" href="smb.conf.5.html#PRINTING" target="_top">printing = cups</a> in the [global]
section. <code class="literal">printcap name = cups</code> will use the "dummy" printcap
created by CUPS, as specified in your CUPS configuration file.
</p><p>
On System V systems that use <code class="literal">lpstat</code> to
list available printers you can use <code class="literal">printcap name = lpstat
</code> to automatically obtain lists of available printers. This
is the default for systems that define SYSV at configure time in
Samba (this includes most System V based systems). If <em class="parameter"><code>
printcap name</code></em> is set to <code class="literal">lpstat</code> on
these systems then Samba will launch <code class="literal">lpstat -v</code> and
attempt to parse the output to obtain a printer list.
</p><p>
A minimal printcap file would look something like this:
</p><pre class="programlisting">
print1|My Printer 1
print2|My Printer 2
print3|My Printer 3
print4|My Printer 4
print5|My Printer 5
</pre><p>
where the '|' separates aliases of a printer. The fact that the second alias has a space in
it gives a hint to Samba that it's a comment.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
Under AIX the default printcap name is <code class="filename">/etc/qconfig</code>. Samba will
assume the file is in AIX <code class="filename">qconfig</code> format if the string <code class="filename">qconfig</code> appears in the printcap filename.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>printcap name</code></em> = <code class="literal">/etc/printcap</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printcap name</code></em> = <code class="literal">/etc/myprintcap</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="print command (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2563403"></a>
print command (S)
</h3></div></div></div><a class="indexterm" name="id2563404"></a><a name="PRINTCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>After a print job has finished spooling to
a service, this command will be used via a <code class="literal">system()</code>
call to process the spool file. Typically the command specified will
submit the spool file to the host's printing subsystem, but there
is no requirement that this be the case. The server will not remove
the spool file, so whatever command you specify should remove the
spool file when it has been processed, otherwise you will need to
manually remove old spool files.</p><p>The print command is simply a text string. It will be used
verbatim after macro substitutions have been made:</p><p>%s, %f - the path to the spool
file name</p><p>%p - the appropriate printer
name</p><p>%J - the job
name as transmitted by the client.</p><p>%c - The number of printed pages
of the spooled job (if known).</p><p>%z - the size of the spooled
print job (in bytes)</p><p>The print command <span class="emphasis"><em>MUST</em></span> contain at least
one occurrence of <em class="parameter"><code>%s</code></em> or <em class="parameter"><code>%f
</code></em> - the <em class="parameter"><code>%p</code></em> is optional. At the time
a job is submitted, if no printer name is supplied the <em class="parameter"><code>%p
</code></em> will be silently removed from the printer command.</p><p>If specified in the [global] section, the print command given
will be used for any printable service that does not have its own
print command specified.</p><p>If there is neither a specified print command for a
printable service nor a global print command, spool files will
be created but not processed and (most importantly) not removed.</p><p>Note that printing may fail on some UNIXes from the
<code class="constant">nobody</code> account. If this happens then create
an alternative guest account that can print and set the <a class="link" href="smb.conf.5.html#GUESTACCOUNT" target="_top">guest account</a>
in the [global] section.</p><p>You can form quite complex print commands by realizing
that they are just passed to a shell. For example the following
will log a print job, print the file, then remove it. Note that
';' is the usual separator for command in shell scripts.</p><p><code class="literal">print command = echo Printing %s >>
/tmp/print.log; lpr -P %p %s; rm %s</code></p><p>You may have to vary this command considerably depending
on how you normally print files on your system. The default for
the parameter varies depending on the setting of the <a class="link" href="smb.conf.5.html#PRINTING" target="_top">printing</a>
parameter.</p><p>Default: For <code class="literal">printing = BSD, AIX, QNX, LPRNG
or PLP :</code></p><p><code class="literal">print command = lpr -r -P%p %s</code></p><p>For <code class="literal">printing = SYSV or HPUX :</code></p><p><code class="literal">print command = lp -c -d%p %s; rm %s</code></p><p>For <code class="literal">printing = SOFTQ :</code></p><p><code class="literal">print command = lp -d%p -s %s; rm %s</code></p><p>For printing = CUPS : If SAMBA is compiled against
libcups, then <a class="link" href="smb.conf.5.html#PRINTCAP" target="_top">printcap = cups</a>
uses the CUPS API to
submit jobs, etc. Otherwise it maps to the System V
commands with the -oraw option for printing, i.e. it
uses <code class="literal">lp -c -d%p -oraw; rm %s</code>.
With <code class="literal">printing = cups</code>,
and if SAMBA is compiled against libcups, any manually
set print command will be ignored.</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>print command</code></em> = <code class="literal">/usr/local/samba/bin/myprintscript %p %s</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="printer admin (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2563672"></a>
printer admin (S)
</h3></div></div></div><a class="indexterm" name="id2563674"></a><a name="PRINTERADMIN"></a><div class="variablelist"><dl><dt></dt><dd><p>
This lists users who can do anything to printers
via the remote administration interfaces offered
by MS-RPC (usually using a NT workstation).
This parameter can be set per-share or globally.
Note: The root user always has admin rights. Use
caution with use in the global stanza as this can
cause side effects.
</p><p>
This parameter has been marked deprecated in favor
of using the SePrintOperatorPrivilege and individual
print security descriptors. It will be removed in a future release.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printer admin</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printer admin</code></em> = <code class="literal">admin, @staff</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="printer"><div class="titlepage"><div><div><h3 class="title"><a name="id2563742"></a>
<a name="PRINTER"></a>printer
</h3></div></div></div><a class="indexterm" name="id2563743"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PRINTERNAME">printer name</a>.</p></dd></dl></div></div><div class="section" title="printer name (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2563773"></a>
printer name (S)
</h3></div></div></div><a class="indexterm" name="id2563774"></a><a name="PRINTERNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the name of the printer to which print jobs spooled through a printable service
will be sent.
</p><p>
If specified in the [global] section, the printer name given will be used for any printable service that
does not have its own printer name specified.
</p><p>
The default value of the <a class="link" href="smb.conf.5.html#PRINTERNAME" target="_top">printer name</a> may be <code class="literal">lp</code> on many
systems.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printer name</code></em> = <code class="literal">none</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printer name</code></em> = <code class="literal">laserwriter</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="printing (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2563861"></a>
printing (S)
</h3></div></div></div><a class="indexterm" name="id2563862"></a><a name="PRINTING"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameters controls how printer status information is
interpreted on your system. It also affects the default values for
the <em class="parameter"><code>print command</code></em>, <em class="parameter"><code>lpq command</code></em>, <em class="parameter"><code>lppause command </code></em>, <em class="parameter"><code>lpresume command</code></em>, and <em class="parameter"><code>lprm command</code></em> if specified in the
[global] section.</p><p>Currently nine printing styles are supported. They are
<code class="constant">BSD</code>, <code class="constant">AIX</code>,
<code class="constant">LPRNG</code>, <code class="constant">PLP</code>,
<code class="constant">SYSV</code>, <code class="constant">HPUX</code>,
<code class="constant">QNX</code>, <code class="constant">SOFTQ</code>,
and <code class="constant">CUPS</code>.</p><p>To see what the defaults are for the other print
commands when using the various options use the <a class="citerefentry" href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> program.</p><p>This option can be set on a per printer basis. Please be
aware however, that you must place any of the various printing
commands (e.g. print command, lpq command, etc...) after defining
the value for the <em class="parameter"><code>printing</code></em> option since it will
reset the printing commands to default values.</p><p>See also the discussion in the <a class="link" href="#PRINTERSSECT" title="The [printers] section">
[printers]</a> section.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printing</code></em> = <code class="literal">Depends on the operating system, see
<code class="literal">testparm -v.</code></code>
</em></span>
</p></dd></dl></div></div><div class="section" title="printjob username (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564014"></a>
printjob username (S)
</h3></div></div></div><a class="indexterm" name="id2564015"></a><a name="PRINTJOBUSERNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies which user information will be
passed to the printing system. Usually, the username is sent,
but in some cases, e.g. the domain prefix is useful, too.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printjob username</code></em> = <code class="literal">%U</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printjob username</code></em> = <code class="literal">%D\%U</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="private dir (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564076"></a>
private dir (G)
</h3></div></div></div><a class="indexterm" name="id2564077"></a><a name="PRIVATEDIR"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameters defines the directory
smbd will use for storing such files as <code class="filename">smbpasswd</code>
and <code class="filename">secrets.tdb</code>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>private dir</code></em> = <code class="literal">${prefix}/private</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="profile acls (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564130"></a>
profile acls (S)
</h3></div></div></div><a class="indexterm" name="id2564131"></a><a name="PROFILEACLS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean parameter was added to fix the problems that people have been
having with storing user profiles on Samba shares from Windows 2000 or
Windows XP clients. New versions of Windows 2000 or Windows XP service
packs do security ACL checking on the owner and ability to write of the
profile directory stored on a local workstation when copied from a Samba
share.
</p><p>
When not in domain mode with winbindd then the security info copied
onto the local workstation has no meaning to the logged in user (SID) on
that workstation so the profile storing fails. Adding this parameter
onto a share used for profile storage changes two things about the
returned Windows ACL. Firstly it changes the owner and group owner
of all reported files and directories to be BUILTIN\\Administrators,
BUILTIN\\Users respectively (SIDs S-1-5-32-544, S-1-5-32-545). Secondly
it adds an ACE entry of "Full Control" to the SID BUILTIN\\Users to
every returned ACL. This will allow any Windows 2000 or XP workstation
user to access the profile.
</p><p>
Note that if you have multiple users logging
on to a workstation then in order to prevent them from being able to access
each others profiles you must remove the "Bypass traverse checking" advanced
user right. This will prevent access to other users profile directories as
the top level profile directory (named after the user) is created by the
workstation profile code and has an ACL restricting entry to the directory
tree to the owning user.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>profile acls</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="queuepause command (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564202"></a>
queuepause command (S)
</h3></div></div></div><a class="indexterm" name="id2564204"></a><a name="QUEUEPAUSECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to pause the printer queue.</p><p>This command should be a program or script which takes
a printer name as its only parameter and stops the printer queue,
such that no longer jobs are submitted to the printer.</p><p>This command is not supported by Windows for Workgroups,
but can be issued from the Printers window under Windows 95
and NT.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name
is put in its place. Otherwise it is placed at the end of the command.
</p><p>Note that it is good practice to include the absolute
path in the command as the PATH may not be available to the
server.</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>queuepause command</code></em> = <code class="literal">disable %p</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="queueresume command (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564279"></a>
queueresume command (S)
</h3></div></div></div><a class="indexterm" name="id2564280"></a><a name="QUEUERESUMECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to resume the printer queue. It
is the command to undo the behavior that is caused by the
previous parameter (<a class="link" href="smb.conf.5.html#QUEUEPAUSECOMMAND" target="_top">queuepause command</a>).</p><p>This command should be a program or script which takes
a printer name as its only parameter and resumes the printer queue,
such that queued jobs are resubmitted to the printer.</p><p>This command is not supported by Windows for Workgroups,
but can be issued from the Printers window under Windows 95
and NT.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name
is put in its place. Otherwise it is placed at the end of the
command.</p><p>Note that it is good practice to include the absolute
path in the command as the PATH may not be available to the
server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>queueresume command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>queueresume command</code></em> = <code class="literal">enable %p</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="read list (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564382"></a>
read list (S)
</h3></div></div></div><a class="indexterm" name="id2564383"></a><a name="READLIST"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a list of users that are given read-only access to a service. If the connecting user is in this list
then they will not be given write access, no matter what the <a class="link" href="smb.conf.5.html#READONLY" target="_top">read only</a> option is set
to. The list can include group names using the syntax described in the <a class="link" href="smb.conf.5.html#INVALIDUSERS" target="_top">invalid users</a>
parameter.
</p><p>This parameter will not work with the <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security = share</a> in
Samba 3.0. This is by design.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>read list</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>read list</code></em> = <code class="literal">mary, @students</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="read only (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564482"></a>
read only (S)
</h3></div></div></div><a class="indexterm" name="id2564483"></a><a name="READONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>An inverted synonym is <a class="link" href="smb.conf.5.html#WRITEABLE" target="_top">writeable</a>.</p><p>If this parameter is <code class="constant">yes</code>, then users
of a service may not create or modify files in the service's
directory.</p><p>Note that a printable service (<code class="literal">printable = yes</code>)
will <span class="emphasis"><em>ALWAYS</em></span> allow writing to the directory
(user privileges permitting), but only via spooling operations.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>read only</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="read raw (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564559"></a>
read raw (G)
</h3></div></div></div><a class="indexterm" name="id2564560"></a><a name="READRAW"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether or not the server
will support the raw read SMB requests when transferring data
to clients.</p><p>If enabled, raw reads allow reads of 65535 bytes in
one packet. This typically provides a major performance benefit.
</p><p>However, some clients either negotiate the allowable
block size incorrectly or are incapable of supporting larger block
sizes, and for these clients you may need to disable raw reads.</p><p>In general this parameter should be viewed as a system tuning
tool and left severely alone.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>read raw</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="realm (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564619"></a>
realm (G)
</h3></div></div></div><a class="indexterm" name="id2564620"></a><a name="REALM"></a><div class="variablelist"><dl><dt></dt><dd><p>This option specifies the kerberos realm to use. The realm is
used as the ADS equivalent of the NT4 <code class="literal">domain</code>. It
is usually set to the DNS name of the kerberos server.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>realm</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>realm</code></em> = <code class="literal">mysambabox.mycompany.com</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="registry shares (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564684"></a>
registry shares (G)
</h3></div></div></div><a class="indexterm" name="id2564685"></a><a name="REGISTRYSHARES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This turns on or off support for share definitions read from
registry. Shares defined in <span class="emphasis"><em>smb.conf</em></span> take
precedence over shares with the same name defined in
registry. See the section on registry-based configuration
for details.
</p><p>
Note that this parameter defaults to <span class="emphasis"><em>no</em></span>,
but it is set to <span class="emphasis"><em>yes</em></span> when
<em class="parameter"><code>config backend</code></em> is set
to <span class="emphasis"><em>registry</em></span>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>registry shares</code></em> = <code class="literal">no</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>registry shares</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="remote announce (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564770"></a>
remote announce (G)
</h3></div></div></div><a class="indexterm" name="id2564771"></a><a name="REMOTEANNOUNCE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option allows you to setup <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> to periodically announce itself
to arbitrary IP addresses with an arbitrary workgroup name.
</p><p>
This is useful if you want your Samba server to appear in a remote workgroup for
which the normal browse propagation rules don't work. The remote workgroup can be
anywhere that you can send IP packets to.
</p><p>
For example:
</p><pre class="programlisting">
<code class="literal">remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF</code>
</pre><p>
the above line would cause <code class="literal">nmbd</code> to announce itself
to the two given IP addresses using the given workgroup names. If you leave out the
workgroup name, then the one given in the <a class="link" href="smb.conf.5.html#WORKGROUP" target="_top">workgroup</a> parameter
is used instead.
</p><p>
The IP addresses you choose would normally be the broadcast addresses of the remote
networks, but can also be the IP addresses of known browse masters if your network
config is that stable.
</p><p>
See the chapter on Network Browsing in the Samba-HOWTO book.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>remote announce</code></em> = <code class="literal"></code>
</em></span>
</p></dd></dl></div></div><div class="section" title="remote browse sync (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564875"></a>
remote browse sync (G)
</h3></div></div></div><a class="indexterm" name="id2564876"></a><a name="REMOTEBROWSESYNC"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option allows you to setup <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> to periodically request
synchronization of browse lists with the master browser of a Samba
server that is on a remote segment. This option will allow you to
gain browse lists for multiple workgroups across routed networks. This
is done in a manner that does not work with any non-Samba servers.
</p><p>
This is useful if you want your Samba server and all local
clients to appear in a remote workgroup for which the normal browse
propagation rules don't work. The remote workgroup can be anywhere
that you can send IP packets to.
</p><p>
For example:
</p><pre class="programlisting">
<em class="parameter"><code>remote browse sync = 192.168.2.255 192.168.4.255</code></em>
</pre><p>
the above line would cause <code class="literal">nmbd</code> to request the master browser on the
specified subnets or addresses to synchronize their browse lists with
the local server.
</p><p>
The IP addresses you choose would normally be the broadcast
addresses of the remote networks, but can also be the IP addresses
of known browse masters if your network config is that stable. If
a machine IP address is given Samba makes NO attempt to validate
that the remote machine is available, is listening, nor that it
is in fact the browse master on its segment.
</p><p>
The <a class="link" href="smb.conf.5.html#REMOTEBROWSESYNC" target="_top">remote browse sync</a> may be used on networks
where there is no WINS server, and may be used on disjoint networks where
each network has its own WINS server.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>remote browse sync</code></em> = <code class="literal"></code>
</em></span>
</p></dd></dl></div></div><div class="section" title="rename user script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2564993"></a>
rename user script (G)
</h3></div></div></div><a class="indexterm" name="id2564994"></a><a name="RENAMEUSERSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is the full pathname to a script that will be run as root by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> under special circumstances described below.
</p><p>
When a user with admin authority or SeAddUserPrivilege rights renames a user (e.g.: from the NT4 User Manager
for Domains), this script will be run to rename the POSIX user. Two variables, <code class="literal">%uold</code> and
<code class="literal">%unew</code>, will be substituted with the old and new usernames, respectively. The script should
return 0 upon successful completion, and nonzero otherwise.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
The script has all responsibility to rename all the necessary data that is accessible in this posix method.
This can mean different requirements for different backends. The tdbsam and smbpasswd backends will take care
of the contents of their respective files, so the script is responsible only for changing the POSIX username, and
other data that may required for your circumstances, such as home directory. Please also consider whether or
not you need to rename the actual home directories themselves. The ldapsam backend will not make any changes,
because of the potential issues with renaming the LDAP naming attribute. In this case the script is
responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that
needs to change for other applications using the same directory.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>rename user script</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="reset on zero vc (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2565083"></a>
reset on zero vc (G)
</h3></div></div></div><a class="indexterm" name="id2565084"></a><a name="RESETONZEROVC"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean option controls whether an incoming session setup
should kill other connections coming from the same IP. This matches
the default Windows 2003 behaviour.
Setting this parameter to yes becomes necessary when you have a flaky
network and windows decides to reconnect while the old connection
still has files with share modes open. These files become inaccessible
over the new connection.
The client sends a zero VC on the new connection, and Windows 2003
kills all other connections coming from the same IP. This way the
locked files are accessible again.
Please be aware that enabling this option will kill connections behind
a masquerading router.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>reset on zero vc</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="restrict anonymous (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2565148"></a>
restrict anonymous (G)
</h3></div></div></div><a class="indexterm" name="id2565149"></a><a name="RESTRICTANONYMOUS"></a><div class="variablelist"><dl><dt></dt><dd><p>The setting of this parameter determines whether user and
group list information is returned for an anonymous connection.
and mirrors the effects of the
</p><pre class="programlisting">
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
Control\LSA\RestrictAnonymous
</pre><p>
registry key in Windows 2000 and Windows NT. When set to 0, user
and group list information is returned to anyone who asks. When set
to 1, only an authenticated user can retrive user and
group list information. For the value 2, supported by
Windows 2000/XP and Samba, no anonymous connections are allowed at
all. This can break third party and Microsoft
applications which expect to be allowed to perform
operations anonymously.</p><p>
The security advantage of using restrict anonymous = 1 is dubious,
as user and group list information can be obtained using other
means.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
The security advantage of using restrict anonymous = 2 is removed
by setting <a class="link" href="smb.conf.5.html#GUESTOK" target="_top">guest ok = yes</a> on any share.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>restrict anonymous</code></em> = <code class="literal">0</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="root"><div class="titlepage"><div><div><h3 class="title"><a name="id2565232"></a>
<a name="ROOT"></a>root
</h3></div></div></div><a class="indexterm" name="id2565233"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#ROOTDIRECTORY">root directory</a>.</p></dd></dl></div></div><div class="section" title="root dir"><div class="titlepage"><div><div><h3 class="title"><a name="id2565265"></a>
<a name="ROOTDIR"></a>root dir
</h3></div></div></div><a class="indexterm" name="id2565266"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#ROOTDIRECTORY">root directory</a>.</p></dd></dl></div></div><div class="section" title="root directory (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2565296"></a>
root directory (G)
</h3></div></div></div><a class="indexterm" name="id2565297"></a><a name="ROOTDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>The server will <code class="literal">chroot()</code> (i.e.
Change its root directory) to this directory on startup. This is
not strictly necessary for secure operation. Even without it the
server will deny access to files not in one of the service entries.
It may also check for, and deny access to, soft links to other
parts of the filesystem, or attempts to use ".." in file names
to access other directories (depending on the setting of the
<a class="link" href="smb.conf.5.html#WIDESMBCONFOPTIONS" target="_top">wide smbconfoptions</a> parameter).
</p><p>Adding a <em class="parameter"><code>root directory</code></em> entry other
than "/" adds an extra level of security, but at a price. It
absolutely ensures that no access is given to files not in the
sub-tree specified in the <em class="parameter"><code>root directory</code></em>
option, <span class="emphasis"><em>including</em></span> some files needed for
complete operation of the server. To maintain full operability
of the server you will need to mirror some system files
into the <em class="parameter"><code>root directory</code></em> tree. In particular
you will need to mirror <code class="filename">/etc/passwd</code> (or a
subset of it), and any binaries or configuration files needed for
printing (if required). The set of files that must be mirrored is
operating system dependent.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root directory</code></em> = <code class="literal">/</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>root directory</code></em> = <code class="literal">/homes/smb</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="root postexec (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2565420"></a>
root postexec (S)
</h3></div></div></div><a class="indexterm" name="id2565421"></a><a name="ROOTPOSTEXEC"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is the same as the <em class="parameter"><code>postexec</code></em>
parameter except that the command is run as root. This is useful for
unmounting filesystems (such as CDROMs) after a connection is closed.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root postexec</code></em> = <code class="literal"></code>
</em></span>
</p></dd></dl></div></div><div class="section" title="root preexec close (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2565469"></a>
root preexec close (S)
</h3></div></div></div><a class="indexterm" name="id2565470"></a><a name="ROOTPREEXECCLOSE"></a><div class="variablelist"><dl><dt></dt><dd><p>This is the same as the <em class="parameter"><code>preexec close
</code></em> parameter except that the command is run as root.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root preexec close</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="root preexec (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2565517"></a>
root preexec (S)
</h3></div></div></div><a class="indexterm" name="id2565518"></a><a name="ROOTPREEXEC"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is the same as the <em class="parameter"><code>preexec</code></em>
parameter except that the command is run as root. This is useful for
mounting filesystems (such as CDROMs) when a connection is opened.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root preexec</code></em> = <code class="literal"></code>
</em></span>
</p></dd></dl></div></div><div class="section" title="security mask (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2565566"></a>
security mask (S)
</h3></div></div></div><a class="indexterm" name="id2565567"></a><a name="SECURITYMASK"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls what UNIX permission bits will be set when a Windows NT client is manipulating the
UNIX permission on a file using the native NT security dialog box.
</p><p>
This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus resetting
any bits not in this mask. Make sure not to mix up this parameter with <a class="link" href="smb.conf.5.html#FORCESECURITYMODE" target="_top">force security mode</a>, which works in a manner similar to this one but uses a logical OR instead of an AND.
</p><p>
Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the
file permissions regardless of the previous status of this bits on the file.
</p><p>
If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file.
</p><p><span class="emphasis"><em>
Note</em></span> that users who can access the Samba server through other means can easily bypass this
restriction, so it is primarily useful for standalone "appliance" systems. Administrators of
most normal systems will probably want to leave it set to <code class="constant">0777</code>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>security mask</code></em> = <code class="literal">0777</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>security mask</code></em> = <code class="literal">0770</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="security (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2565672"></a>
security (G)
</h3></div></div></div><a class="indexterm" name="id2565673"></a><a name="SECURITY"></a><div class="variablelist"><dl><dt></dt><dd><p>This option affects how clients respond to
Samba and is one of the most important settings in the <code class="filename">
smb.conf</code> file.</p><p>The option sets the "security mode bit" in replies to
protocol negotiations with <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to turn share level security on or off. Clients decide
based on this bit whether (and how) to transfer user and password
information to the server.</p><p>The default is <code class="literal">security = user</code>, as this is
the most common setting needed when talking to Windows 98 and
Windows NT.</p><p>The alternatives are <code class="literal">security = share</code>,
<code class="literal">security = server</code> or <code class="literal">security = domain
</code>.</p><p>In versions of Samba prior to 2.0.0, the default was
<code class="literal">security = share</code> mainly because that was
the only option at one stage.</p><p>There is a bug in WfWg that has relevance to this
setting. When in user or server level security a WfWg client
will totally ignore the username and password you type in the "connect
drive" dialog box. This makes it very difficult (if not impossible)
to connect to a Samba service as anyone except the user that
you are logged into WfWg as.</p><p>If your PCs use usernames that are the same as their
usernames on the UNIX machine then you will want to use
<code class="literal">security = user</code>. If you mostly use usernames
that don't exist on the UNIX box then use <code class="literal">security =
share</code>.</p><p>You should also use <code class="literal">security = share</code> if you
want to mainly setup shares without a password (guest shares). This
is commonly used for a shared printer server. It is more difficult
to setup guest shares with <code class="literal">security = user</code>, see
the <a class="link" href="smb.conf.5.html#MAPTOGUEST" target="_top">map to guest</a> parameter for details.</p><p>It is possible to use <code class="literal">smbd</code> in a <span class="emphasis"><em>
hybrid mode</em></span> where it is offers both user and share
level security under different <a class="link" href="smb.conf.5.html#NETBIOSALIASES" target="_top">NetBIOS aliases</a>. </p><p>The different settings will now be explained.</p><p><a name="SECURITYEQUALSSHARE"></a><span class="emphasis"><em>SECURITY = SHARE</em></span></p><p>When clients connect to a share level security server, they
need not log onto the server with a valid username and password before
attempting to connect to a shared resource (although modern clients
such as Windows 95/98 and Windows NT will send a logon request with
a username but no password when talking to a <code class="literal">security = share
</code> server). Instead, the clients send authentication information
(passwords) on a per-share basis, at the time they attempt to connect
to that share.</p><p>Note that <code class="literal">smbd</code> <span class="emphasis"><em>ALWAYS</em></span>
uses a valid UNIX user to act on behalf of the client, even in
<code class="literal">security = share</code> level security.</p><p>As clients are not required to send a username to the server
in share level security, <code class="literal">smbd</code> uses several
techniques to determine the correct UNIX user to use on behalf
of the client.</p><p>A list of possible UNIX usernames to match with the given
client password is constructed using the following methods :</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>If the <a class="link" href="smb.conf.5.html#GUESTONLY" target="_top">guest only</a> parameter is set, then all the other
stages are missed and only the <a class="link" href="smb.conf.5.html#GUESTACCOUNT" target="_top">guest account</a> username is checked.
</p></li><li class="listitem"><p>Is a username is sent with the share connection
request, then this username (after mapping - see <a class="link" href="smb.conf.5.html#USERNAMEMAP" target="_top">username map</a>),
is added as a potential username.
</p></li><li class="listitem"><p>If the client did a previous <span class="emphasis"><em>logon
</em></span> request (the SessionSetup SMB call) then the
username sent in this SMB will be added as a potential username.
</p></li><li class="listitem"><p>The name of the service the client requested is
added as a potential username.
</p></li><li class="listitem"><p>The NetBIOS name of the client is added to
the list as a potential username.
</p></li><li class="listitem"><p>Any users on the <a class="link" href="smb.conf.5.html#USER" target="_top">user</a> list are added as potential usernames.
</p></li></ul></div><p>If the <em class="parameter"><code>guest only</code></em> parameter is
not set, then this list is then tried with the supplied password.
The first user for whom the password matches will be used as the
UNIX user.</p><p>If the <em class="parameter"><code>guest only</code></em> parameter is
set, or no username can be determined then if the share is marked
as available to the <em class="parameter"><code>guest account</code></em>, then this
guest user will be used, otherwise access is denied.</p><p>Note that it can be <span class="emphasis"><em>very</em></span> confusing
in share-level security as to which UNIX username will eventually
be used in granting access.</p><p>See also the section <a class="link" href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">
NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p><a name="SECURITYEQUALSUSER"></a><span class="emphasis"><em>SECURITY = USER</em></span></p><p>This is the default security setting in Samba 3.0.
With user-level security a client must first "log-on" with a
valid username and password (which can be mapped using the <a class="link" href="smb.conf.5.html#USERNAMEMAP" target="_top">username map</a>
parameter). Encrypted passwords (see the <a class="link" href="smb.conf.5.html#ENCRYPTEDPASSWORDS" target="_top">encrypted passwords</a> parameter) can also
be used in this security mode. Parameters such as <a class="link" href="smb.conf.5.html#USER" target="_top">user</a> and <a class="link" href="smb.conf.5.html#GUESTONLY" target="_top">guest only</a> if set are then applied and
may change the UNIX user to use on this connection, but only after
the user has been successfully authenticated.</p><p><span class="emphasis"><em>Note</em></span> that the name of the resource being
requested is <span class="emphasis"><em>not</em></span> sent to the server until after
the server has successfully authenticated the client. This is why
guest shares don't work in user level security without allowing
the server to automatically map unknown users into the <a class="link" href="smb.conf.5.html#GUESTACCOUNT" target="_top">guest account</a>.
See the <a class="link" href="smb.conf.5.html#MAPTOGUEST" target="_top">map to guest</a> parameter for details on doing this.</p><p>See also the section <a class="link" href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p><a name="SECURITYEQUALSDOMAIN"></a><span class="emphasis"><em>SECURITY = DOMAIN</em></span></p><p>This mode will only work correctly if <a class="citerefentry" href="net.8.html"><span class="citerefentry"><span class="refentrytitle">net</span>(8)</span></a> has been used to add this
machine into a Windows NT Domain. It expects the <a class="link" href="smb.conf.5.html#ENCRYPTEDPASSWORDS" target="_top">encrypted passwords</a>
parameter to be set to <code class="constant">yes</code>. In this
mode Samba will try to validate the username/password by passing
it to a Windows NT Primary or Backup Domain Controller, in exactly
the same way that a Windows NT Server would do.</p><p><span class="emphasis"><em>Note</em></span> that a valid UNIX user must still
exist as well as the account on the Domain Controller to allow
Samba to have a valid UNIX account to map file access to.</p><p><span class="emphasis"><em>Note</em></span> that from the client's point
of view <code class="literal">security = domain</code> is the same
as <code class="literal">security = user</code>. It only
affects how the server deals with the authentication,
it does not in any way affect what the client sees.</p><p><span class="emphasis"><em>Note</em></span> that the name of the resource being
requested is <span class="emphasis"><em>not</em></span> sent to the server until after
the server has successfully authenticated the client. This is why
guest shares don't work in user level security without allowing
the server to automatically map unknown users into the <a class="link" href="smb.conf.5.html#GUESTACCOUNT" target="_top">guest account</a>.
See the <a class="link" href="smb.conf.5.html#MAPTOGUEST" target="_top">map to guest</a> parameter for details on doing this.</p><p>See also the section <a class="link" href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">
NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p>See also the <a class="link" href="smb.conf.5.html#PASSWORDSERVER" target="_top">password server</a> parameter and
the <a class="link" href="smb.conf.5.html#ENCRYPTEDPASSWORDS" target="_top">encrypted passwords</a> parameter.</p><p><a name="SECURITYEQUALSSERVER"></a><span class="emphasis"><em>SECURITY = SERVER</em></span></p><p>
In this mode Samba will try to validate the username/password by passing it to another SMB server, such as an
NT box. If this fails it will revert to <code class="literal">security = user</code>. It expects the
<a class="link" href="smb.conf.5.html#ENCRYPTEDPASSWORDS" target="_top">encrypted passwords</a> parameter to be set to <code class="constant">yes</code>, unless the remote
server does not support them. However note that if encrypted passwords have been negotiated then Samba cannot
revert back to checking the UNIX password file, it must have a valid <code class="filename">smbpasswd</code> file to check users against. See the chapter about the User Database in
the Samba HOWTO Collection for details on how to set this up.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This mode of operation has
significant pitfalls since it is more vulnerable to
man-in-the-middle attacks and server impersonation. In particular,
this mode of operation can cause significant resource consuption on
the PDC, as it must maintain an active connection for the duration
of the user's session. Furthermore, if this connection is lost,
there is no way to reestablish it, and futher authentications to the
Samba server may fail (from a single client, till it disconnects).
</p></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>From the client's point of
view, <code class="literal">security = server</code> is the
same as <code class="literal">security = user</code>. It
only affects how the server deals with the authentication, it does
not in any way affect what the client sees.</p></div><p><span class="emphasis"><em>Note</em></span> that the name of the resource being
requested is <span class="emphasis"><em>not</em></span> sent to the server until after
the server has successfully authenticated the client. This is why
guest shares don't work in user level security without allowing
the server to automatically map unknown users into the <a class="link" href="smb.conf.5.html#GUESTACCOUNT" target="_top">guest account</a>.
See the <a class="link" href="smb.conf.5.html#MAPTOGUEST" target="_top">map to guest</a> parameter for details on doing this.</p><p>See also the section <a class="link" href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">
NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p>See also the <a class="link" href="smb.conf.5.html#PASSWORDSERVER" target="_top">password server</a> parameter and the
<a class="link" href="smb.conf.5.html#ENCRYPTEDPASSWORDS" target="_top">encrypted passwords</a> parameter.</p><p><a name="SECURITYEQUALSADS"></a><span class="emphasis"><em>SECURITY = ADS</em></span></p><p>In this mode, Samba will act as a domain member in an ADS realm. To operate
in this mode, the machine running Samba will need to have Kerberos installed
and configured and Samba will need to be joined to the ADS realm using the
net utility. </p><p>Note that this mode does NOT make Samba operate as a Active Directory Domain
Controller. </p><p>Read the chapter about Domain Membership in the HOWTO for details.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>security</code></em> = <code class="literal">USER</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>security</code></em> = <code class="literal">DOMAIN</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="server schannel (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2566551"></a>
server schannel (G)
</h3></div></div></div><a class="indexterm" name="id2566552"></a><a name="SERVERSCHANNEL"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls whether the server offers or even demands the use of the netlogon schannel.
<a class="link" href="smb.conf.5.html#SERVERSCHANNEL" target="_top">server schannel = no</a> does not offer the schannel, <a class="link" href="smb.conf.5.html#SERVERSCHANNEL" target="_top">server schannel = auto</a> offers the schannel but does not enforce it, and <a class="link" href="smb.conf.5.html#SERVERSCHANNEL" target="_top">server schannel = yes</a> denies access if the client is not able to speak netlogon schannel.
This is only the case for Windows NT4 before SP4.
</p><p>
Please note that with this set to <code class="literal">no</code>, you will have to apply the WindowsXP
<code class="filename">WinXP_SignOrSeal.reg</code> registry patch found in the docs/registry subdirectory of the Samba distribution tarball.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>server schannel</code></em> = <code class="literal">auto</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>server schannel</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="server signing (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2566667"></a>
server signing (G)
</h3></div></div></div><a class="indexterm" name="id2566668"></a><a name="SERVERSIGNING"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether the client is allowed or required to use SMB signing. Possible values
are <span class="emphasis"><em>auto</em></span>, <span class="emphasis"><em>mandatory</em></span>
and <span class="emphasis"><em>disabled</em></span>.
</p><p>When set to auto, SMB signing is offered, but not enforced.
When set to mandatory, SMB signing is required and if set
to disabled, SMB signing is not offered either.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>server signing</code></em> = <code class="literal">Disabled</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="server string (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2566728"></a>
server string (G)
</h3></div></div></div><a class="indexterm" name="id2566729"></a><a name="SERVERSTRING"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls what string will show up in the printer comment box in print
manager and next to the IPC connection in <code class="literal">net view</code>. It
can be any string that you wish to show to your users.</p><p>It also sets what will appear in browse lists next
to the machine name.</p><p>A <em class="parameter"><code>%v</code></em> will be replaced with the Samba
version number.</p><p>A <em class="parameter"><code>%h</code></em> will be replaced with the
hostname.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>server string</code></em> = <code class="literal">Samba %v</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>server string</code></em> = <code class="literal">University of GNUs Samba Server</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="set directory (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2566819"></a>
set directory (S)
</h3></div></div></div><a class="indexterm" name="id2566820"></a><a name="SETDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>
If <code class="literal">set directory = no</code>, then users of the
service may not use the setdir command to change directory.
</p><p>
The <code class="literal">setdir</code> command is only implemented
in the Digital Pathworks client. See the Pathworks documentation
for details.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>set directory</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="set primary group script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2566879"></a>
set primary group script (G)
</h3></div></div></div><a class="indexterm" name="id2566880"></a><a name="SETPRIMARYGROUPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>Thanks to the Posix subsystem in NT a Windows User has a
primary group in addition to the auxiliary groups. This script
sets the primary group in the unix userdatase when an
administrator sets the primary group from the windows user
manager or when fetching a SAM with <code class="literal">net rpc
vampire</code>. <em class="parameter"><code>%u</code></em> will be replaced
with the user whose primary group is to be set.
<em class="parameter"><code>%g</code></em> will be replaced with the group to
set.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>set primary group script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>set primary group script</code></em> = <code class="literal">/usr/sbin/usermod -g '%g' '%u'</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="set quota command (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2566961"></a>
set quota command (G)
</h3></div></div></div><a class="indexterm" name="id2566962"></a><a name="SETQUOTACOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>The <code class="literal">set quota command</code> should only be used
whenever there is no operating system API available from the OS that
samba can use.</p><p>This option is only available if Samba was configured with the argument <code class="literal">--with-sys-quotas</code> or
on linux when <code class="literal">./configure --with-quotas</code> was used and a working quota api
was found in the system. Most packages are configured with these options already.</p><p>This parameter should specify the path to a script that
can set quota for the specified arguments.</p><p>The specified script should take the following arguments:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>1 - quota type
</p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"><p>1 - user quotas</p></li><li class="listitem"><p>2 - user default quotas (uid = -1)</p></li><li class="listitem"><p>3 - group quotas</p></li><li class="listitem"><p>4 - group default quotas (gid = -1)</p></li></ul></div></li><li class="listitem"><p>2 - id (uid for user, gid for group, -1 if N/A)</p></li><li class="listitem"><p>3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</p></li><li class="listitem"><p>4 - block softlimit</p></li><li class="listitem"><p>5 - block hardlimit</p></li><li class="listitem"><p>6 - inode softlimit</p></li><li class="listitem"><p>7 - inode hardlimit</p></li><li class="listitem"><p>8(optional) - block size, defaults to 1024</p></li></ul></div><p>The script should output at least one line of data on success. And nothing on failure.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>set quota command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>set quota command</code></em> = <code class="literal">/usr/local/sbin/set_quota</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="share:fake_fscaps (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2567124"></a>
share:fake_fscaps (G)
</h3></div></div></div><a class="indexterm" name="id2567126"></a><a name="SHARE:FAKE_FSCAPS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is needed to support some special application that makes
QFSINFO calls to check whether we set the SPARSE_FILES bit
(0x40). If this bit is not set that particular application
refuses to work against
Samba. With <a class="link" href="smb.conf.5.html#SHARE:FAKE_FSCAPS" target="_top">share:fake_fscaps = 64</a>
the SPARSE_FILES file system capability flag is set. Use other
decimal values to specify the bitmask you need to fake.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>share:fake_fscaps</code></em> = <code class="literal">0</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="share modes (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2567184"></a>
share modes (S)
</h3></div></div></div><a class="indexterm" name="id2567185"></a><a name="SHAREMODES"></a><div class="variablelist"><dl><dt></dt><dd><p>This enables or disables the honoring of
the <em class="parameter"><code>share modes</code></em> during a file open. These
modes are used by clients to gain exclusive read or write access
to a file.</p><p>This is a deprecated option from old versions of
Samba, and will be removed in the next major release.
</p><p>These open modes are not directly supported by UNIX, so
they are simulated using shared memory.</p><p>The share modes that are enabled by this option are
the standard Windows share modes.
</p><p>This option gives full share compatibility and is enabled
by default.</p><p>You should <span class="emphasis"><em>NEVER</em></span> turn this parameter
off as many Windows applications will break if you do so.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>share modes</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="short preserve case (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2567261"></a>
short preserve case (S)
</h3></div></div></div><a class="indexterm" name="id2567262"></a><a name="SHORTPRESERVECASE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean parameter controls if new files which conform to 8.3 syntax, that is all in upper case and of
suitable length, are created upper case, or if they are forced to be the <a class="link" href="smb.conf.5.html#DEFAULTCASE" target="_top">default case</a>.
This option can be use with <a class="link" href="smb.conf.5.html#PRESERVECASE" target="_top">preserve case = yes</a> to permit long filenames
to retain their case, while short names are lowered.
</p><p>See the section on <a class="link" href="#NAMEMANGLINGSECT" title="NAME MANGLING">NAME MANGLING</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>short preserve case</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="show add printer wizard (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2567340"></a>
show add printer wizard (G)
</h3></div></div></div><a class="indexterm" name="id2567341"></a><a name="SHOWADDPRINTERWIZARD"></a><div class="variablelist"><dl><dt></dt><dd><p>With the introduction of MS-RPC based printing support
for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
appear on Samba hosts in the share listing. Normally this folder will
contain an icon for the MS Add Printer Wizard (APW). However, it is
possible to disable this feature regardless of the level of privilege
of the connected user.</p><p>Under normal circumstances, the Windows NT/2000 client will
open a handle on the printer server with OpenPrinterEx() asking for
Administrator privileges. If the user does not have administrative
access on the print server (i.e is not root or a member of the
<em class="parameter"><code>printer admin</code></em> group), the OpenPrinterEx()
call fails and the client makes another open call with a request for
a lower privilege level. This should succeed, however the APW
icon will not be displayed.</p><p>Disabling the <em class="parameter"><code>show add printer wizard</code></em>
parameter will always cause the OpenPrinterEx() on the server
to fail. Thus the APW icon will never be displayed.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This does not prevent the same user from having
administrative privilege on an individual printer.</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>show add printer wizard</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="shutdown script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2567423"></a>
shutdown script (G)
</h3></div></div></div><a class="indexterm" name="id2567424"></a><a name="SHUTDOWNSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This a full path name to a script called by
<a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> that should
start a shutdown procedure.</p><p>If the connected user posseses the <code class="constant">SeRemoteShutdownPrivilege</code>,
right, this command will be run as root.</p><p>The %z %t %r %f variables are expanded as follows:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>%z</code></em> will be substituted with the
shutdown message sent to the server.</p></li><li class="listitem"><p><em class="parameter"><code>%t</code></em> will be substituted with the
number of seconds to wait before effectively starting the
shutdown procedure.</p></li><li class="listitem"><p><em class="parameter"><code>%r</code></em> will be substituted with the
switch <span class="emphasis"><em>-r</em></span>. It means reboot after shutdown
for NT.</p></li><li class="listitem"><p><em class="parameter"><code>%f</code></em> will be substituted with the
switch <span class="emphasis"><em>-f</em></span>. It means force the shutdown
even if applications do not respond for NT.</p></li></ul></div><p>Shutdown script example:
</p><pre class="programlisting">
#!/bin/bash
$time=0
let "time/60"
let "time++"
/sbin/shutdown $3 $4 +$time $1 &
</pre><p>
Shutdown does not return so we need to launch it in background.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>shutdown script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>shutdown script</code></em> = <code class="literal">/usr/local/samba/sbin/shutdown %m %t %r %f</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="smb encrypt (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2567577"></a>
smb encrypt (S)
</h3></div></div></div><a class="indexterm" name="id2567578"></a><a name="SMBENCRYPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a new feature introduced with Samba 3.2 and above. It is an
extension to the SMB/CIFS protocol negotiated as part of the UNIX extensions.
SMB encryption uses the GSSAPI (SSPI on Windows) ability to encrypt
and sign every request/response in a SMB protocol stream. When
enabled it provides a secure method of SMB/CIFS communication,
similar to an ssh protected session, but using SMB/CIFS authentication
to negotiate encryption and signing keys. Currently this is only
supported by Samba 3.2 smbclient, and hopefully soon Linux CIFSFS
and MacOS/X clients. Windows clients do not support this feature.
</p><p>This controls whether the remote client is allowed or required to use SMB encryption. Possible values
are <span class="emphasis"><em>auto</em></span>, <span class="emphasis"><em>mandatory</em></span>
and <span class="emphasis"><em>disabled</em></span>. This may be set on a per-share
basis, but clients may chose to encrypt the entire session, not
just traffic to a specific share. If this is set to mandatory
then all traffic to a share <span class="emphasis"><em>must</em></span> must
be encrypted once the connection has been made to the share.
The server would return "access denied" to all non-encrypted
requests on such a share. Selecting encrypted traffic reduces
throughput as smaller packet sizes must be used (no huge UNIX
style read/writes allowed) as well as the overhead of encrypting
and signing all the data.
</p><p>If SMB encryption is selected, Windows style SMB signing (see
the <a class="link" href="smb.conf.5.html#SERVERSIGNING" target="_top">server signing</a> option) is no longer necessary,
as the GSSAPI flags use select both signing and sealing of the data.
</p><p>When set to auto, SMB encryption is offered, but not enforced.
When set to mandatory, SMB encryption is required and if set
to disabled, SMB encryption can not be negotiated.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>smb encrypt</code></em> = <code class="literal">auto</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="smb passwd file (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2567683"></a>
smb passwd file (G)
</h3></div></div></div><a class="indexterm" name="id2567684"></a><a name="SMBPASSWDFILE"></a><div class="variablelist"><dl><dt></dt><dd><p>This option sets the path to the encrypted smbpasswd file. By
default the path to the smbpasswd file is compiled into Samba.</p><p>
An example of use is:
</p><pre class="programlisting">
smb passwd file = /etc/samba/smbpasswd
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>smb passwd file</code></em> = <code class="literal">${prefix}/private/smbpasswd</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="smb ports (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2567736"></a>
smb ports (G)
</h3></div></div></div><a class="indexterm" name="id2567737"></a><a name="SMBPORTS"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies which ports the server should listen on for SMB traffic.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>smb ports</code></em> = <code class="literal">445 139</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="socket address (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2567778"></a>
socket address (G)
</h3></div></div></div><a class="indexterm" name="id2567779"></a><a name="SOCKETADDRESS"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows you to control what
address Samba will listen for connections on. This is used to
support multiple virtual interfaces on the one server, each
with a different configuration.</p><p>Setting this option should never be necessary on usual Samba
servers running only one nmbd.</p><p>By default Samba will accept connections on any
address.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>socket address</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>socket address</code></em> = <code class="literal">192.168.2.20</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="socket options (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2567848"></a>
socket options (G)
</h3></div></div></div><a class="indexterm" name="id2567849"></a><a name="SOCKETOPTIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows you to set socket options
to be used when talking with the client.</p><p>Socket options are controls on the networking layer
of the operating systems which allow the connection to be
tuned.</p><p>This option will typically be used to tune your Samba server
for optimal performance for your local network. There is no way
that Samba can know what the optimal parameters are for your net,
so you must experiment and choose them yourself. We strongly
suggest you read the appropriate documentation for your operating
system first (perhaps <code class="literal">man
setsockopt</code> will help).</p><p>You may find that on some systems Samba will say
"Unknown socket option" when you supply an option. This means you
either incorrectly typed it or you need to add an include file
to includes.h for your OS. If the latter is the case please
send the patch to <a class="ulink" href="mailto:samba-technical@samba.org" target="_top">
samba-technical@samba.org</a>.</p><p>Any of the supported socket options may be combined
in any way you like, as long as your OS allows it.</p><p>This is the list of socket options currently settable
using this option:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>SO_KEEPALIVE</p></li><li class="listitem"><p>SO_REUSEADDR</p></li><li class="listitem"><p>SO_BROADCAST</p></li><li class="listitem"><p>TCP_NODELAY</p></li><li class="listitem"><p>IPTOS_LOWDELAY</p></li><li class="listitem"><p>IPTOS_THROUGHPUT</p></li><li class="listitem"><p>SO_SNDBUF *</p></li><li class="listitem"><p>SO_RCVBUF *</p></li><li class="listitem"><p>SO_SNDLOWAT *</p></li><li class="listitem"><p>SO_RCVLOWAT *</p></li></ul></div><p>Those marked with a <span class="emphasis"><em>'*'</em></span> take an integer
argument. The others can optionally take a 1 or 0 argument to enable
or disable the option, by default they will be enabled if you
don't specify 1 or 0.</p><p>To specify an argument use the syntax SOME_OPTION = VALUE
for example <code class="literal">SO_SNDBUF = 8192</code>. Note that you must
not have any spaces before or after the = sign.</p><p>If you are on a local network then a sensible option
might be:</p><p><code class="literal">socket options = IPTOS_LOWDELAY</code></p><p>If you have a local network then you could try:</p><p><code class="literal">socket options = IPTOS_LOWDELAY TCP_NODELAY</code></p><p>If you are on a wide area network then perhaps try
setting IPTOS_THROUGHPUT. </p><p>Note that several of the options may cause your Samba
server to fail completely. Use these options with caution!</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>socket options</code></em> = <code class="literal">TCP_NODELAY</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>socket options</code></em> = <code class="literal">IPTOS_LOWDELAY</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="stat cache (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568059"></a>
stat cache (G)
</h3></div></div></div><a class="indexterm" name="id2568060"></a><a name="STATCACHE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines if <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will use a cache in order to
speed up case insensitive name mappings. You should never need
to change this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>stat cache</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="state directory (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568110"></a>
state directory (G)
</h3></div></div></div><a class="indexterm" name="id2568111"></a><a name="STATEDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>Usually, most of the TDB files are stored in the
<em class="parameter"><code>lock directory</code></em>. Since
Samba 3.4.0, it is possible to differentiate between TDB files
with persistent data and TDB files with non-persistent data using
the <em class="parameter"><code>state directory</code></em> and the
<em class="parameter"><code>cache directory</code></em> options.
</p><p> This option specifies the directory where TDB files containing
persistent data will be stored.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>state directory</code></em> = <code class="literal">${prefix}/var/locks</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>state directory</code></em> = <code class="literal">/var/run/samba/locks/state</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="store dos attributes (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568196"></a>
store dos attributes (S)
</h3></div></div></div><a class="indexterm" name="id2568197"></a><a name="STOREDOSATTRIBUTES"></a><div class="variablelist"><dl><dt></dt><dd><p>
If this parameter is set Samba attempts to first read DOS attributes (SYSTEM, HIDDEN, ARCHIVE or
READ-ONLY) from a filesystem extended attribute, before mapping DOS attributes to UNIX permission bits (such
as occurs with <a class="link" href="smb.conf.5.html#MAPHIDDEN" target="_top">map hidden</a> and <a class="link" href="smb.conf.5.html#MAPREADONLY" target="_top">map readonly</a>). When set, DOS
attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or
directory. For no other mapping to occur as a fall-back, the parameters <a class="link" href="smb.conf.5.html#MAPHIDDEN" target="_top">map hidden</a>,
<a class="link" href="smb.conf.5.html#MAPSYSTEM" target="_top">map system</a>, <a class="link" href="smb.conf.5.html#MAPARCHIVE" target="_top">map archive</a> and <a class="link" href="smb.conf.5.html#MAPREADONLY" target="_top">map readonly</a> must be set to off. This parameter writes the DOS attributes as a string into the extended
attribute named "user.DOSATTRIB". This extended attribute is explicitly hidden from smbd clients requesting an
EA list. On Linux the filesystem must have been mounted with the mount option user_xattr in order for
extended attributes to work, also extended attributes must be compiled into the Linux kernel.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>store dos attributes</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="strict allocate (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568318"></a>
strict allocate (S)
</h3></div></div></div><a class="indexterm" name="id2568319"></a><a name="STRICTALLOCATE"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a boolean that controls the handling of
disk space allocation in the server. When this is set to <code class="constant">yes</code>
the server will change from UNIX behaviour of not committing real
disk storage blocks when a file is extended to the Windows behaviour
of actually forcing the disk system to allocate real storage blocks
when a file is created or extended to be a given size. In UNIX
terminology this means that Samba will stop creating sparse files.
This can be slow on some systems.</p><p>When strict allocate is <code class="constant">no</code> the server does sparse
disk block allocation when a file is extended.</p><p>Setting this to <code class="constant">yes</code> can help Samba return
out of quota messages on systems that are restricting the disk quota
of users.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>strict allocate</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="strict locking (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568388"></a>
strict locking (S)
</h3></div></div></div><a class="indexterm" name="id2568389"></a><a name="STRICTLOCKING"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is an enumerated type that controls the handling of file locking in the server. When this is set to <code class="constant">yes</code>,
the server will check every read and write access for file locks, and deny access if locks exist. This can be slow on
some systems.
</p><p>
When strict locking is set to Auto (the default), the server performs file lock checks only on non-oplocked files.
As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for
improved performance.
</p><p>
When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them.
</p><p>
Well-behaved clients always ask for lock checks when it is important. So in the vast majority of cases,
<code class="literal">strict locking = Auto</code> or
<code class="literal">strict locking = no</code> is acceptable.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>strict locking</code></em> = <code class="literal">Auto</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="strict sync (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568467"></a>
strict sync (S)
</h3></div></div></div><a class="indexterm" name="id2568468"></a><a name="STRICTSYNC"></a><div class="variablelist"><dl><dt></dt><dd><p>Many Windows applications (including the Windows 98 explorer
shell) seem to confuse flushing buffer contents to disk with doing
a sync to disk. Under UNIX, a sync call forces the process to be
suspended until the kernel has ensured that all outstanding data in
kernel disk buffers has been safely stored onto stable storage.
This is very slow and should only be done rarely. Setting this
parameter to <code class="constant">no</code> (the default) means that
<a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> ignores the Windows
applications requests for a sync call. There is only a possibility
of losing data if the operating system itself that Samba is running
on crashes, so there is little danger in this default setting. In
addition, this fixes many performance problems that people have
reported with the new Windows98 explorer shell file copies.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>strict sync</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="svcctl list (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568532"></a>
svcctl list (G)
</h3></div></div></div><a class="indexterm" name="id2568533"></a><a name="SVCCTLLIST"></a><div class="variablelist"><dl><dt></dt><dd><p>This option defines a list of init scripts that smbd
will use for starting and stopping Unix services via the Win32
ServiceControl API. This allows Windows administrators to
utilize the MS Management Console plug-ins to manage a
Unix server running Samba.</p><p>The administrator must create a directory
name <code class="filename">svcctl</code> in Samba's $(libdir)
and create symbolic links to the init scripts in
<code class="filename">/etc/init.d/</code>. The name of the links
must match the names given as part of the <em class="parameter"><code>svcctl list</code></em>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>svcctl list</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>svcctl list</code></em> = <code class="literal">cups postfix portmap httpd</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="sync always (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568618"></a>
sync always (S)
</h3></div></div></div><a class="indexterm" name="id2568619"></a><a name="SYNCALWAYS"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a boolean parameter that controls
whether writes will always be written to stable storage before
the write call returns. If this is <code class="constant">no</code> then the server will be
guided by the client's request in each write call (clients can
set a bit indicating that a particular write should be synchronous).
If this is <code class="constant">yes</code> then every write will be followed by a <code class="literal">fsync()
</code> call to ensure the data is written to disk. Note that
the <em class="parameter"><code>strict sync</code></em> parameter must be set to
<code class="constant">yes</code> in order for this parameter to have
any effect.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>sync always</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="syslog only (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568689"></a>
syslog only (G)
</h3></div></div></div><a class="indexterm" name="id2568690"></a><a name="SYSLOGONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>
If this parameter is set then Samba debug messages are logged into the system
syslog only, and not to the debug log files. There still will be some
logging to log.[sn]mbd even if <span class="emphasis"><em>syslog only</em></span> is enabled.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>syslog only</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="syslog (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568736"></a>
syslog (G)
</h3></div></div></div><a class="indexterm" name="id2568738"></a><a name="SYSLOG"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter maps how Samba debug messages are logged onto the system syslog logging levels.
Samba debug level zero maps onto syslog <code class="constant">LOG_ERR</code>, debug level one maps onto
<code class="constant">LOG_WARNING</code>, debug level two maps onto <code class="constant">LOG_NOTICE</code>,
debug level three maps onto LOG_INFO. All higher levels are mapped to <code class="constant">LOG_DEBUG</code>.
</p><p>
This parameter sets the threshold for sending messages to syslog. Only messages with debug
level less than this value will be sent to syslog. There still will be some
logging to log.[sn]mbd even if <span class="emphasis"><em>syslog only</em></span> is enabled.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>syslog</code></em> = <code class="literal">1</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="template homedir (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568807"></a>
template homedir (G)
</h3></div></div></div><a class="indexterm" name="id2568808"></a><a name="TEMPLATEHOMEDIR"></a><div class="variablelist"><dl><dt></dt><dd><p>When filling out the user information for a Windows NT
user, the <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon uses this
parameter to fill in the home directory for that user. If the
string <em class="parameter"><code>%D</code></em> is present it
is substituted with the user's Windows NT domain name. If the
string <em class="parameter"><code>%U</code></em> is present it
is substituted with the user's Windows NT user name.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>template homedir</code></em> = <code class="literal">/home/%D/%U</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="template shell (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568873"></a>
template shell (G)
</h3></div></div></div><a class="indexterm" name="id2568874"></a><a name="TEMPLATESHELL"></a><div class="variablelist"><dl><dt></dt><dd><p>When filling out the user information for a Windows NT
user, the <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon uses this
parameter to fill in the login shell for that user.</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" title="time offset (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568912"></a>
time offset (G)
</h3></div></div></div><a class="indexterm" name="id2568913"></a><a name="TIMEOFFSET"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a setting in minutes to add
to the normal GMT to local time conversion. This is useful if
you are serving a lot of PCs that have incorrect daylight
saving time handling.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>time offset</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>time offset</code></em> = <code class="literal">60</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="time server (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2568972"></a>
time server (G)
</h3></div></div></div><a class="indexterm" name="id2568973"></a><a name="TIMESERVER"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines if <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> advertises itself as a time server to Windows
clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>time server</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="unix charset (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2569022"></a>
unix charset (G)
</h3></div></div></div><a class="indexterm" name="id2569023"></a><a name="UNIXCHARSET"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies the charset the unix machine
Samba runs on uses. Samba needs to know this in order to be able to
convert text to the charsets other SMB clients use.
</p><p>This is also the charset Samba will use when specifying arguments
to scripts that it invokes.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>unix charset</code></em> = <code class="literal">UTF8</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>unix charset</code></em> = <code class="literal">ASCII</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="unix extensions (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2569088"></a>
unix extensions (G)
</h3></div></div></div><a class="indexterm" name="id2569089"></a><a name="UNIXEXTENSIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether Samba
implements the CIFS UNIX extensions, as defined by HP.
These extensions enable Samba to better serve UNIX CIFS clients
by supporting features such as symbolic links, hard links, etc...
These extensions require a similarly enabled client, and are of
no current use to Windows clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>unix extensions</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="unix password sync (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2569136"></a>
unix password sync (G)
</h3></div></div></div><a class="indexterm" name="id2569137"></a><a name="UNIXPASSWORDSYNC"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether Samba
attempts to synchronize the UNIX password with the SMB password
when the encrypted SMB password in the smbpasswd file is changed.
If this is set to <code class="constant">yes</code> the program specified in the <em class="parameter"><code>passwd
program</code></em> parameter is called <span class="emphasis"><em>AS ROOT</em></span> -
to allow the new UNIX password to be set without access to the
old UNIX password (as the SMB password change code has no
access to the old password cleartext, only the new).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>unix password sync</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="update encrypted (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2569197"></a>
update encrypted (G)
</h3></div></div></div><a class="indexterm" name="id2569198"></a><a name="UPDATEENCRYPTED"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean parameter allows a user logging on with a plaintext password to have their encrypted (hashed)
password in the smbpasswd file to be updated automatically as they log on. This option allows a site to
migrate from plaintext password authentication (users authenticate with plaintext password over the
wire, and are checked against a UNIX account database) to encrypted password authentication (the SMB
challenge/response authentication mechanism) without forcing all users to re-enter their passwords via
smbpasswd at the time the change is made. This is a convenience option to allow the change over to encrypted
passwords to be made over a longer period. Once all users have encrypted representations of their passwords
in the smbpasswd file this parameter should be set to <code class="constant">no</code>.
</p><p>
In order for this parameter to be operative the <a class="link" href="smb.conf.5.html#ENCRYPTPASSWORDS" target="_top">encrypt passwords</a> parameter must
be set to <code class="constant">no</code>. The default value of <a class="link" href="smb.conf.5.html#ENCRYPTPASSWORDS" target="_top">encrypt passwords = Yes</a>. Note: This must be set to <code class="constant">no</code> for this <a class="link" href="smb.conf.5.html#UPDATEENCRYPTED" target="_top">update encrypted</a> to work.
</p><p>
Note that even when this parameter is set, a user authenticating to <code class="literal">smbd</code>
must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd)
passwords.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>update encrypted</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="use client driver (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2569315"></a>
use client driver (S)
</h3></div></div></div><a class="indexterm" name="id2569316"></a><a name="USECLIENTDRIVER"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter applies only to Windows NT/2000
clients. It has no effect on Windows 95/98/ME clients. When
serving a printer to Windows NT/2000 clients without first installing
a valid printer driver on the Samba host, the client will be required
to install a local printer driver. From this point on, the client
will treat the print as a local printer and not a network printer
connection. This is much the same behavior that will occur
when <code class="literal">disable spoolss = yes</code>.
</p><p>The differentiating factor is that under normal
circumstances, the NT/2000 client will attempt to open the network
printer using MS-RPC. The problem is that because the client
considers the printer to be local, it will attempt to issue the
OpenPrinterEx() call requesting access rights associated with the
logged on user. If the user possesses local administator rights but
not root privilege on the Samba host (often the case), the
OpenPrinterEx() call will fail. The result is that the client will
now display an "Access Denied; Unable to connect" message
in the printer queue window (even though jobs may successfully be
printed). </p><p>If this parameter is enabled for a printer, then any attempt
to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
call to succeed. <span class="emphasis"><em>This parameter MUST not be enabled
on a print share which has valid print driver installed on the Samba
server.</em></span></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use client driver</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="use mmap (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2569396"></a>
use mmap (G)
</h3></div></div></div><a class="indexterm" name="id2569397"></a><a name="USEMMAP"></a><div class="variablelist"><dl><dt></dt><dd><p>This global parameter determines if the tdb internals of Samba can
depend on mmap working correctly on the running system. Samba requires a coherent
mmap/read-write system memory cache. Currently only HPUX does not have such a
coherent cache, and so this parameter is set to <code class="constant">no</code> by
default on HPUX. On all other systems this parameter should be left alone. This
parameter is provided to help the Samba developers track down problems with
the tdb internal code.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use mmap</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="username level (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2569448"></a>
username level (G)
</h3></div></div></div><a class="indexterm" name="id2569449"></a><a name="USERNAMELEVEL"></a><div class="variablelist"><dl><dt></dt><dd><p>This option helps Samba to try and 'guess' at
the real UNIX username, as many DOS clients send an all-uppercase
username. By default Samba tries all lowercase, followed by the
username with the first letter capitalized, and fails if the
username is not found on the UNIX machine.</p><p>If this parameter is set to non-zero the behavior changes.
This parameter is a number that specifies the number of uppercase
combinations to try while trying to determine the UNIX user name. The
higher the number the more combinations will be tried, but the slower
the discovery of usernames will be. Use this parameter when you have
strange usernames on your UNIX machine, such as <code class="constant">AstrangeUser
</code>.</p><p>This parameter is needed only on UNIX systems that have case
sensitive usernames.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username level</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username level</code></em> = <code class="literal">5</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="username map script (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2569530"></a>
username map script (G)
</h3></div></div></div><a class="indexterm" name="id2569531"></a><a name="USERNAMEMAPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This script is a mutually exclusive alternative to the
<a class="link" href="smb.conf.5.html#USERNAMEMAP" target="_top">username map</a> parameter. This parameter
specifies and external program or script that must accept a single
command line option (the username transmitted in the authentication
request) and return a line line on standard output (the name to which
the account should mapped). In this way, it is possible to store
username map tables in an LDAP or NIS directory services.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username map script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username map script</code></em> = <code class="literal">/etc/samba/scripts/mapusers.sh</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="username map (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2569607"></a>
username map (G)
</h3></div></div></div><a class="indexterm" name="id2569608"></a><a name="USERNAMEMAP"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option allows you to specify a file containing a mapping of usernames from the clients to the server.
This can be used for several purposes. The most common is to map usernames that users use on DOS or Windows
machines to those that the UNIX box uses. The other is to map multiple users to a single username so that they
can more easily share files.
</p><p>
Please note that for user or share mode security, the username map is applied prior to validating the user
credentials. Domain member servers (domain or ads) apply the username map after the user has been
successfully authenticated by the domain controller and require fully qualified enties in the map table (e.g.
biddle = <code class="literal">DOMAIN\foo</code>).
</p><p>
The map file is parsed line by line. Each line should contain a single UNIX username on the left then a '='
followed by a list of usernames on the right. The list of usernames on the right may contain names of the form
@group in which case they will match any UNIX username in that group. The special client name '*' is a
wildcard and matches any name. Each line of the map file may be up to 1023 characters long.
</p><p>
The file is processed on each line by taking the supplied username and comparing it with each username on the
right hand side of the '=' signs. If the supplied name matches any of the names on the right hand side then it
is replaced with the name on the left. Processing then continues with the next line.
</p><p>
If any line begins with a '#' or a ';' then it is ignored.
</p><p>
If any line begins with an '!' then the processing will stop after that line if a mapping was done by the
line. Otherwise mapping continues with every line being processed. Using '!' is most useful when you have a
wildcard mapping line later in the file.
</p><p>
For example to map from the name <code class="constant">admin</code> or <code class="constant">administrator</code> to the UNIX
name <code class="constant"> root</code> you would use:
</p><pre class="programlisting">
<code class="literal">root = admin administrator</code>
</pre><p>
Or to map anyone in the UNIX group <code class="constant">system</code> to the UNIX name <code class="constant">sys</code> you would use:
</p><pre class="programlisting">
<code class="literal">sys = @system</code>
</pre><p>
</p><p>
You can have as many mappings as you like in a username map file.
</p><p>
If your system supports the NIS NETGROUP option then the netgroup database is checked before the <code class="filename">/etc/group </code> database for matching groups.
</p><p>
You can map Windows usernames that have spaces in them by using double quotes around the name. For example:
</p><pre class="programlisting">
<code class="literal">tridge = "Andrew Tridgell"</code>
</pre><p>
would map the windows username "Andrew Tridgell" to the unix username "tridge".
</p><p>
The following example would map mary and fred to the unix user sys, and map the rest to guest. Note the use of the
'!' to tell Samba to stop processing if it gets a match on that line:
</p><pre class="programlisting">
!sys = mary fred
guest = *
</pre><p>
</p><p>
Note that the remapping is applied to all occurrences of usernames. Thus if you connect to \\server\fred and
<code class="constant">fred</code> is remapped to <code class="constant">mary</code> then you will actually be connecting to
\\server\mary and will need to supply a password suitable for <code class="constant">mary</code> not
<code class="constant">fred</code>. The only exception to this is the username passed to the <a class="link" href="smb.conf.5.html#PASSWORDSERVER" target="_top">password server</a> (if you have one). The password server will receive whatever username the client
supplies without modification.
</p><p>
Also note that no reverse mapping is done. The main effect this has is with printing. Users who have been
mapped may have trouble deleting print jobs as PrintManager under WfWg will think they don't own the print
job.
</p><p>
Samba versions prior to 3.0.8 would only support reading the fully qualified username
(e.g.: <code class="literal">DOMAIN\user</code>) from
the username map when performing a kerberos login from a client. However, when looking up a map entry for a
user authenticated by NTLM[SSP], only the login name would be used for matches. This resulted in inconsistent
behavior sometimes even on the same server.
</p><p>
The following functionality is obeyed in version 3.0.8 and later:
</p><p>
When performing local authentication, the username map is applied to the login name before attempting to authenticate
the connection.
</p><p>
When relying upon a external domain controller for validating authentication requests, smbd will apply the username map
to the fully qualified username (i.e. <code class="literal">DOMAIN\user</code>) only after the user has been successfully authenticated.
</p><p>
An example of use is:
</p><pre class="programlisting">
username map = /usr/local/samba/lib/users.map
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username map</code></em> = <code class="literal">
# no username map</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="user"><div class="titlepage"><div><div><h3 class="title"><a name="id2569892"></a>
<a name="USER"></a>user
</h3></div></div></div><a class="indexterm" name="id2569893"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#USERNAME">username</a>.</p></dd></dl></div></div><div class="section" title="users"><div class="titlepage"><div><div><h3 class="title"><a name="id2569924"></a>
<a name="USERS"></a>users
</h3></div></div></div><a class="indexterm" name="id2569925"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#USERNAME">username</a>.</p></dd></dl></div></div><div class="section" title="username (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2569956"></a>
username (S)
</h3></div></div></div><a class="indexterm" name="id2569957"></a><a name="USERNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>Multiple users may be specified in a comma-delimited
list, in which case the supplied password will be tested against
each username in turn (left to right).</p><p>The <em class="parameter"><code>username</code></em> line is needed only when
the PC is unable to supply its own username. This is the case
for the COREPLUS protocol or where your users have different WfWg
usernames to UNIX usernames. In both these cases you may also be
better using the \\server\share%user syntax instead.</p><p>The <em class="parameter"><code>username</code></em> line is not a great
solution in many cases as it means Samba will try to validate
the supplied password against each of the usernames in the
<em class="parameter"><code>username</code></em> line in turn. This is slow and
a bad idea for lots of users in case of duplicate passwords.
You may get timeouts or security breaches using this parameter
unwisely.</p><p>Samba relies on the underlying UNIX security. This
parameter does not restrict who can login, it just offers hints
to the Samba server as to what usernames might correspond to the
supplied password. Users can login as whoever they please and
they will be able to do no more damage than if they started a
telnet session. The daemon runs as the user that they log in as,
so they cannot do anything that user cannot do.</p><p>To restrict a service to a particular set of users you
can use the <a class="link" href="smb.conf.5.html#VALIDUSERS" target="_top">valid users</a> parameter.</p><p>If any of the usernames begin with a '@' then the name
will be looked up first in the NIS netgroups list (if Samba
is compiled with netgroup support), followed by a lookup in
the UNIX groups database and will expand to a list of all users
in the group of that name.</p><p>If any of the usernames begin with a '+' then the name
will be looked up only in the UNIX groups database and will
expand to a list of all users in the group of that name.</p><p>If any of the usernames begin with a '&' then the name
will be looked up only in the NIS netgroups database (if Samba
is compiled with netgroup support) and will expand to a list
of all users in the netgroup group of that name.</p><p>Note that searching though a groups database can take
quite some time, and some clients may time out during the
search.</p><p>See the section <a class="link" href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">NOTE ABOUT
USERNAME/PASSWORD VALIDATION</a> for more information on how
this parameter determines access to the services.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username</code></em> = <code class="literal">
# The guest account if a guest service,
else <empty string>.</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username</code></em> = <code class="literal">fred, mary, jack, jane, @users, @pcgroup</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="usershare allow guests (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570126"></a>
usershare allow guests (G)
</h3></div></div></div><a class="indexterm" name="id2570127"></a><a name="USERSHAREALLOWGUESTS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether user defined shares are allowed
to be accessed by non-authenticated users or not. It is the equivalent
of allowing people who can create a share the option of setting
<em class="parameter"><code>guest ok = yes</code></em> in a share
definition. Due to its security sensitive nature, the default
is set to off.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare allow guests</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="usershare max shares (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570179"></a>
usershare max shares (G)
</h3></div></div></div><a class="indexterm" name="id2570180"></a><a name="USERSHAREMAXSHARES"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the number of user defined shares
that are allowed to be created by users belonging to the group owning the
usershare directory. If set to zero (the default) user defined shares are ignored.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare max shares</code></em> = <code class="literal">0</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="usershare owner only (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570224"></a>
usershare owner only (G)
</h3></div></div></div><a class="indexterm" name="id2570225"></a><a name="USERSHAREOWNERONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether the pathname exported by
a user defined shares must be owned by the user creating the
user defined share or not. If set to True (the default) then
smbd checks that the directory path being shared is owned by
the user who owns the usershare file defining this share and
refuses to create the share if not. If set to False then no
such check is performed and any directory path may be exported
regardless of who owns it.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare owner only</code></em> = <code class="literal">True</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="usershare path (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570274"></a>
usershare path (G)
</h3></div></div></div><a class="indexterm" name="id2570275"></a><a name="USERSHAREPATH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the absolute path of the directory on the
filesystem used to store the user defined share definition files.
This directory must be owned by root, and have no access for
other, and be writable only by the group owner. In addition the
"sticky" bit must also be set, restricting rename and delete to
owners of a file (in the same way the /tmp directory is usually configured).
Members of the group owner of this directory are the users allowed to create
usershares. If this parameter is undefined then no user defined
shares are allowed.
</p><p>
For example, a valid usershare directory might be /usr/local/samba/lib/usershares,
set up as follows.
</p><p>
</p><pre class="programlisting">
ls -ld /usr/local/samba/lib/usershares/
drwxrwx--T 2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/
</pre><p>
</p><p>
In this case, only members of the group "power_users" can create user defined shares.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare path</code></em> = <code class="literal">NULL</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="usershare prefix allow list (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570345"></a>
usershare prefix allow list (G)
</h3></div></div></div><a class="indexterm" name="id2570346"></a><a name="USERSHAREPREFIXALLOWLIST"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies a list of absolute pathnames
the root of which are allowed to be exported by user defined share definitions.
If the pathname to be exported doesn't start with one of the strings in this
list, the user defined share will not be allowed. This allows the Samba
administrator to restrict the directories on the system that can be
exported by user defined shares.
</p><p>
If there is a "usershare prefix deny list" and also a
"usershare prefix allow list" the deny list is processed
first, followed by the allow list, thus leading to the most
restrictive interpretation.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare prefix allow list</code></em> = <code class="literal">NULL</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>usershare prefix allow list</code></em> = <code class="literal">/home /data /space</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="usershare prefix deny list (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570418"></a>
usershare prefix deny list (G)
</h3></div></div></div><a class="indexterm" name="id2570419"></a><a name="USERSHAREPREFIXDENYLIST"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies a list of absolute pathnames
the root of which are NOT allowed to be exported by user defined share definitions.
If the pathname exported starts with one of the strings in this
list the user defined share will not be allowed. Any pathname not
starting with one of these strings will be allowed to be exported
as a usershare. This allows the Samba administrator to restrict the
directories on the system that can be exported by user defined shares.
</p><p>
If there is a "usershare prefix deny list" and also a
"usershare prefix allow list" the deny list is processed
first, followed by the allow list, thus leading to the most
restrictive interpretation.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare prefix deny list</code></em> = <code class="literal">NULL</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>usershare prefix deny list</code></em> = <code class="literal">/etc /dev /private</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="usershare template share (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570492"></a>
usershare template share (G)
</h3></div></div></div><a class="indexterm" name="id2570493"></a><a name="USERSHARETEMPLATESHARE"></a><div class="variablelist"><dl><dt></dt><dd><p>User defined shares only have limited possible parameters
such as path, guest ok, etc. This parameter allows usershares to
"cloned" from an existing share. If "usershare template share"
is set to the name of an existing share, then all usershares
created have their defaults set from the parameters set on this
share.
</p><p>
The target share may be set to be invalid for real file
sharing by setting the parameter "-valid = False" on the template
share definition. This causes it not to be seen as a real exported
share but to be able to be used as a template for usershares.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare template share</code></em> = <code class="literal">NULL</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>usershare template share</code></em> = <code class="literal">template_share</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="use sendfile (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570565"></a>
use sendfile (S)
</h3></div></div></div><a class="indexterm" name="id2570566"></a><a name="USESENDFILE"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is <code class="constant">yes</code>, and the <code class="constant">sendfile()</code>
system call is supported by the underlying operating system, then some SMB read calls
(mainly ReadAndX and ReadRaw) will use the more efficient sendfile system call for files that
are exclusively oplocked. This may make more efficient use of the system CPU's
and cause Samba to be faster. Samba automatically turns this off for clients
that use protocol levels lower than NT LM 0.12 and when it detects a client is
Windows 9x (using sendfile from Linux will cause these clients to fail).
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use sendfile</code></em> = <code class="literal">false</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="use spnego (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570623"></a>
use spnego (G)
</h3></div></div></div><a class="indexterm" name="id2570624"></a><a name="USESPNEGO"></a><div class="variablelist"><dl><dt></dt><dd><p>This variable controls controls whether samba will try
to use Simple and Protected NEGOciation (as specified by rfc2478) with
WindowsXP and Windows2000 clients to agree upon an authentication mechanism.
</p><p>
Unless further issues are discovered with our SPNEGO
implementation, there is no reason this should ever be
disabled.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use spnego</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="utmp directory (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570672"></a>
utmp directory (G)
</h3></div></div></div><a class="indexterm" name="id2570673"></a><a name="UTMPDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is only available if Samba has
been configured and compiled with the option <code class="literal">
--with-utmp</code>. It specifies a directory pathname that is
used to store the utmp or utmpx files (depending on the UNIX system) that
record user connections to a Samba server. By default this is
not set, meaning the system will use whatever utmp file the
native system is set to use (usually
<code class="filename">/var/run/utmp</code> on Linux).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>utmp directory</code></em> = <code class="literal">
# Determined automatically</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>utmp directory</code></em> = <code class="literal">/var/run/utmp</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="utmp (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570750"></a>
utmp (G)
</h3></div></div></div><a class="indexterm" name="id2570751"></a><a name="UTMP"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean parameter is only available if Samba has been configured and compiled
with the option <code class="literal">--with-utmp</code>. If set to
<code class="constant">yes</code> then Samba will attempt to add utmp or utmpx records
(depending on the UNIX system) whenever a connection is made to a Samba server.
Sites may use this to record the user connecting to a Samba share.
</p><p>
Due to the requirements of the utmp record, we are required to create a unique
identifier for the incoming user. Enabling this option creates an n^2 algorithm
to find this number. This may impede performance on large installations.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>utmp</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="valid users (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570813"></a>
valid users (S)
</h3></div></div></div><a class="indexterm" name="id2570814"></a><a name="VALIDUSERS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a list of users that should be allowed to login to this service. Names starting with
'@', '+' and '&' are interpreted using the same rules as described in the
<em class="parameter"><code>invalid users</code></em> parameter.
</p><p>
If this is empty (the default) then any user can login. If a username is in both this list
and the <em class="parameter"><code>invalid users</code></em> list then access is denied
for that user.
</p><p>
The current servicename is substituted for <em class="parameter"><code>%S</code></em>.
This is useful in the [homes] section.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>valid users</code></em> = <code class="literal">
# No valid users list (anyone can login) </code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>valid users</code></em> = <code class="literal">greg, @pcusers</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="-valid (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570904"></a>
-valid (S)
</h3></div></div></div><a class="indexterm" name="id2570905"></a><a name="-VALID"></a><div class="variablelist"><dl><dt></dt><dd><p> This parameter indicates whether a share is
valid and thus can be used. When this parameter is set to false,
the share will be in no way visible nor accessible.
</p><p>
This option should not be
used by regular users but might be of help to developers.
Samba uses this option internally to mark shares as deleted.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>-valid</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="veto files (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2570954"></a>
veto files (S)
</h3></div></div></div><a class="indexterm" name="id2570955"></a><a name="VETOFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a list of files and directories that are neither visible nor accessible. Each entry in
the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?'
can be used to specify multiple files or directories as in DOS wildcards.
</p><p>
Each entry must be a unix path, not a DOS path and must <span class="emphasis"><em>not</em></span> include the
unix directory separator '/'.
</p><p>
Note that the <a class="link" href="smb.conf.5.html#CASESENSITIVE" target="_top">case sensitive</a> option is applicable in vetoing files.
</p><p>
One feature of the veto files parameter that it is important to be aware of is Samba's behaviour when
trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this
deletion will <span class="emphasis"><em>fail</em></span> unless you also set the <a class="link" href="smb.conf.5.html#DELETEVETOFILES" target="_top">delete veto files</a>
parameter to <em class="parameter"><code>yes</code></em>.
</p><p>
Setting this parameter will affect the performance of Samba, as it will be forced to check all files
and directories for a match as they are scanned.
</p><p>
Examples of use include:
</p><pre class="programlisting">
; Veto any files containing the word Security,
; any ending in .tmp, and any directory containing the
; word root.
veto files = /*Security*/*.tmp/*root*/
; Veto the Apple specific files that a NetAtalk server
; creates.
veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>veto files</code></em> = <code class="literal">No files or directories are vetoed.</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="veto oplock files (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571073"></a>
veto oplock files (S)
</h3></div></div></div><a class="indexterm" name="id2571074"></a><a name="VETOOPLOCKFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter is only valid when the <a class="link" href="smb.conf.5.html#OPLOCKS" target="_top">oplocks</a>
parameter is turned on for a share. It allows the Samba administrator
to selectively turn off the granting of oplocks on selected files that
match a wildcarded list, similar to the wildcarded list used in the
<a class="link" href="smb.conf.5.html#VETOFILES" target="_top">veto files</a> parameter.
</p><p>
You might want to do this on files that you know will be heavily contended
for by clients. A good example of this is in the NetBench SMB benchmark
program, which causes heavy client contention for files ending in
<code class="filename">.SEM</code>. To cause Samba not to grant
oplocks on these files you would use the line (either in the [global]
section or in the section for the particular NetBench share.
</p><p>
An example of use is:
</p><pre class="programlisting">
veto oplock files = /.*SEM/
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>veto oplock files</code></em> = <code class="literal">
# No files are vetoed for oplock grants</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="vfs object"><div class="titlepage"><div><div><h3 class="title"><a name="id2571166"></a>
<a name="VFSOBJECT"></a>vfs object
</h3></div></div></div><a class="indexterm" name="id2571167"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#VFSOBJECTS">vfs objects</a>.</p></dd></dl></div></div><div class="section" title="vfs objects (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571198"></a>
vfs objects (S)
</h3></div></div></div><a class="indexterm" name="id2571199"></a><a name="VFSOBJECTS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the backend names which
are used for Samba VFS I/O operations. By default, normal
disk I/O operations are used but these can be overloaded
with one or more VFS objects. </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>vfs objects</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>vfs objects</code></em> = <code class="literal">extd_audit recycle</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="volume (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571258"></a>
volume (S)
</h3></div></div></div><a class="indexterm" name="id2571259"></a><a name="VOLUME"></a><div class="variablelist"><dl><dt></dt><dd><p>This allows you to override the volume label
returned for a share. Useful for CDROMs with installation programs
that insist on a particular volume label.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>volume</code></em> = <code class="literal">
# the name of the share</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="wide links (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571301"></a>
wide links (S)
</h3></div></div></div><a class="indexterm" name="id2571302"></a><a name="WIDELINKS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether or not links
in the UNIX file system may be followed by the server. Links
that point to areas within the directory tree exported by the
server are always allowed; this parameter controls access only
to areas that are outside the directory tree being exported.</p><p>Note that setting this parameter can have a negative
effect on your server performance due to the extra system calls
that Samba has to do in order to perform the link checks.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wide links</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind cache time (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571354"></a>
winbind cache time (G)
</h3></div></div></div><a class="indexterm" name="id2571355"></a><a name="WINBINDCACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the number of
seconds the <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon will cache
user and group information before querying a Windows NT server
again.</p><p>
This does not apply to authentication requests, these are always
evaluated in real time unless the <a class="link" href="smb.conf.5.html#WINBINDOFFLINELOGON" target="_top">winbind offline logon</a> option has been enabled.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind cache time</code></em> = <code class="literal">300</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind enum groups (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571425"></a>
winbind enum groups (G)
</h3></div></div></div><a class="indexterm" name="id2571426"></a><a name="WINBINDENUMGROUPS"></a><div class="variablelist"><dl><dt></dt><dd><p>On large installations using <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> it may be necessary to suppress
the enumeration of groups through the <code class="literal">setgrent()</code>,
<code class="literal">getgrent()</code> and
<code class="literal">endgrent()</code> group of system calls. If
the <em class="parameter"><code>winbind enum groups</code></em> parameter is
<code class="constant">no</code>, calls to the <code class="literal">getgrent()</code> system
call will not return any data. </p><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Turning off group enumeration may cause some programs to behave oddly. </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind enum groups</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind enum users (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571516"></a>
winbind enum users (G)
</h3></div></div></div><a class="indexterm" name="id2571517"></a><a name="WINBINDENUMUSERS"></a><div class="variablelist"><dl><dt></dt><dd><p>On large installations using <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> it may be
necessary to suppress the enumeration of users through the <code class="literal">setpwent()</code>,
<code class="literal">getpwent()</code> and
<code class="literal">endpwent()</code> group of system calls. If
the <em class="parameter"><code>winbind enum users</code></em> parameter is
<code class="constant">no</code>, calls to the <code class="literal">getpwent</code> system call
will not return any data. </p><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Turning off user
enumeration may cause some programs to behave oddly. For
example, the finger program relies on having access to the
full user list when searching for matching
usernames. </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind enum users</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind expand groups (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571609"></a>
winbind expand groups (G)
</h3></div></div></div><a class="indexterm" name="id2571610"></a><a name="WINBINDEXPANDGROUPS"></a><div class="variablelist"><dl><dt></dt><dd><p>This option controls the maximum depth that winbindd
will traverse when flattening nested group memberships
of Windows domain groups. This is different from the
<a class="link" href="smb.conf.5.html#WINBINDNESTEDGROUPS" target="_top">winbind nested groups</a> option
which implements the Windows NT4 model of local group
nesting. The "winbind expand groups"
parameter specifically applies to the membership of
domain groups.</p><p>Be aware that a high value for this parameter can
result in system slowdown as the main parent winbindd daemon
must perform the group unrolling and will be unable to answer
incoming NSS or authentication requests during this time.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind expand groups</code></em> = <code class="literal">1</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind nested groups (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571678"></a>
winbind nested groups (G)
</h3></div></div></div><a class="indexterm" name="id2571679"></a><a name="WINBINDNESTEDGROUPS"></a><div class="variablelist"><dl><dt></dt><dd><p>If set to yes, this parameter activates the support for nested
groups. Nested groups are also called local groups or
aliases. They work like their counterparts in Windows: Nested
groups are defined locally on any machine (they are shared
between DC's through their SAM) and can contain users and
global groups from any trusted SAM. To be able to use nested
groups, you need to run nss_winbind.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind nested groups</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind normalize names (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571736"></a>
winbind normalize names (G)
</h3></div></div></div><a class="indexterm" name="id2571738"></a><a name="WINBINDNORMALIZENAMES"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether winbindd will replace
whitespace in user and group names with an underscore (_) character.
For example, whether the name "Space Kadet" should be
replaced with the string "space_kadet".
Frequently Unix shell scripts will have difficulty with usernames
contains whitespace due to the default field separator in the shell.
If your domain possesses names containing the underscore character,
this option may cause problems unless the name aliasing feature
is supported by your nss_info plugin.
</p><p>This feature also enables the name aliasing API which can
be used to make domain user and group names to a non-qualified
version. Please refer to the manpage for the configured
idmap and nss_info plugin for the specifics on how to configure
name aliasing for a specific configuration. Name aliasing takes
precendence (and is mutually exclusive) over the whitespace
replacement mechanism discussed previsouly.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind normalize names</code></em> = <code class="literal">no</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind normalize names</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind nss info (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571814"></a>
winbind nss info (G)
</h3></div></div></div><a class="indexterm" name="id2571815"></a><a name="WINBINDNSSINFO"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is designed to control how Winbind retrieves Name
Service Information to construct a user's home directory and login shell.
Currently the following settings are available:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><em class="parameter"><code>template</code></em>
- The default, using the parameters of <em class="parameter"><code>template
shell</code></em> and <em class="parameter"><code>template homedir</code></em>)
</p></li><li class="listitem"><p><em class="parameter"><code><sfu | rfc2307 ></code></em>
- When Samba is running in security = ads and your Active Directory
Domain Controller does support the Microsoft "Services for Unix" (SFU)
LDAP schema, winbind can retrieve the login shell and the home
directory attributes directly from your Directory Server. Note that
retrieving UID and GID from your ADS-Server requires to
use <em class="parameter"><code>idmap backend</code></em> = ad
or <em class="parameter"><code>idmap config DOMAIN:backend</code></em> = ad
as well.
</p></li></ul></div><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind nss info</code></em> = <code class="literal">template</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind nss info</code></em> = <code class="literal">template sfu</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind offline logon (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2571934"></a>
winbind offline logon (G)
</h3></div></div></div><a class="indexterm" name="id2571935"></a><a name="WINBINDOFFLINELOGON"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is designed to control whether Winbind should
allow to login with the <em class="parameter"><code>pam_winbind</code></em>
module using Cached Credentials. If enabled, winbindd will store user credentials
from successful logins encrypted in a local cache.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind offline logon</code></em> = <code class="literal">false</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind offline logon</code></em> = <code class="literal">true</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind reconnect delay (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572003"></a>
winbind reconnect delay (G)
</h3></div></div></div><a class="indexterm" name="id2572004"></a><a name="WINBINDRECONNECTDELAY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the number of
seconds the <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon will wait between
attempts to contact a Domain controller for a domain that is
determined to be down or not contactable.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind reconnect delay</code></em> = <code class="literal">30</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind refresh tickets (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572056"></a>
winbind refresh tickets (G)
</h3></div></div></div><a class="indexterm" name="id2572057"></a><a name="WINBINDREFRESHTICKETS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is designed to control whether Winbind should refresh Kerberos Tickets
retrieved using the <em class="parameter"><code>pam_winbind</code></em> module.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind refresh tickets</code></em> = <code class="literal">false</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind refresh tickets</code></em> = <code class="literal">true</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind rpc only (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572123"></a>
winbind rpc only (G)
</h3></div></div></div><a class="indexterm" name="id2572124"></a><a name="WINBINDRPCONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>
Setting this parameter to <code class="literal">yes</code> forces
winbindd to use RPC instead of LDAP to retrieve information from Domain
Controllers.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind rpc only</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind separator (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572172"></a>
winbind separator (G)
</h3></div></div></div><a class="indexterm" name="id2572173"></a><a name="WINBINDSEPARATOR"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter allows an admin to define the character
used when listing a username of the form of <em class="replaceable"><code>DOMAIN
</code></em>\<em class="replaceable"><code>user</code></em>. This parameter
is only applicable when using the <code class="filename">pam_winbind.so</code>
and <code class="filename">nss_winbind.so</code> modules for UNIX services.
</p><p>Please note that setting this parameter to + causes problems
with group membership at least on glibc systems, as the character +
is used as a special character for NIS in /etc/group.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind separator</code></em> = <code class="literal">'\'</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind separator</code></em> = <code class="literal">+</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind trusted domains only (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572259"></a>
winbind trusted domains only (G)
</h3></div></div></div><a class="indexterm" name="id2572260"></a><a name="WINBINDTRUSTEDDOMAINSONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter is designed to allow Samba servers that are members
of a Samba controlled domain to use UNIX accounts distributed via NIS,
rsync, or LDAP as the uid's for winbindd users in the hosts primary domain.
Therefore, the user <code class="literal">DOMAIN\user1</code> would be mapped to
the account user1 in /etc/passwd instead of allocating a new uid for him or her.
</p><p>
This parameter is now deprecated in favor of the newer idmap_nss backend.
Refer to the <a class="citerefentry" href="idmap_nss.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_nss</span>(8)</span></a> man page for more information.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind trusted domains only</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="winbind use default domain (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572326"></a>
winbind use default domain (G)
</h3></div></div></div><a class="indexterm" name="id2572328"></a><a name="WINBINDUSEDEFAULTDOMAIN"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether the
<a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon should operate on users
without domain component in their username. Users without a domain
component are treated as is part of the winbindd server's own
domain. While this does not benifit Windows users, it makes SSH, FTP and
e-mail function in a way much closer to the way they
would in a native unix system.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind use default domain</code></em> = <code class="literal">no</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind use default domain</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="wins hook (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572399"></a>
wins hook (G)
</h3></div></div></div><a class="indexterm" name="id2572400"></a><a name="WINSHOOK"></a><div class="variablelist"><dl><dt></dt><dd><p>When Samba is running as a WINS server this
allows you to call an external program for all changes to the
WINS database. The primary use for this option is to allow the
dynamic update of external name resolution databases such as
dynamic DNS.</p><p>The wins hook parameter specifies the name of a script
or executable that will be called as follows:</p><p><code class="literal">wins_hook operation name nametype ttl IP_list</code></p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>The first argument is the operation and is
one of "add", "delete", or
"refresh". In most cases the operation
can be ignored as the rest of the parameters
provide sufficient information. Note that
"refresh" may sometimes be called when
the name has not previously been added, in that
case it should be treated as an add.</p></li><li class="listitem"><p>The second argument is the NetBIOS name. If the
name is not a legal name then the wins hook is not called.
Legal names contain only letters, digits, hyphens, underscores
and periods.</p></li><li class="listitem"><p>The third argument is the NetBIOS name
type as a 2 digit hexadecimal number. </p></li><li class="listitem"><p>The fourth argument is the TTL (time to live)
for the name in seconds.</p></li><li class="listitem"><p>The fifth and subsequent arguments are the IP
addresses currently registered for that name. If this list is
empty then the name should be deleted.</p></li></ul></div><p>An example script that calls the BIND dynamic DNS update
program <code class="literal">nsupdate</code> is provided in the examples
directory of the Samba source code. </p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" title="wins proxy (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572506"></a>
wins proxy (G)
</h3></div></div></div><a class="indexterm" name="id2572507"></a><a name="WINSPROXY"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a boolean that controls if <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will respond to broadcast name
queries on behalf of other hosts. You may need to set this
to <code class="constant">yes</code> for some older clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wins proxy</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="wins server (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572560"></a>
wins server (G)
</h3></div></div></div><a class="indexterm" name="id2572562"></a><a name="WINSSERVER"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies the IP address (or DNS name: IP
address for preference) of the WINS server that <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> should register with. If you have a WINS server on
your network then you should set this to the WINS server's IP.</p><p>You should point this at your WINS server if you have a
multi-subnetted network.</p><p>If you want to work in multiple namespaces, you can
give every wins server a 'tag'. For each tag, only one
(working) server will be queried for a name. The tag should be
separated from the ip address by a colon.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>You need to set up Samba to point
to a WINS server if you have multiple subnets and wish cross-subnet
browsing to work correctly.</p></div><p>See the chapter in the Samba3-HOWTO on Network Browsing.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wins server</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>wins server</code></em> = <code class="literal">mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61
# For this example when querying a certain name, 192.19.200.1 will
be asked first and if that doesn't respond 192.168.2.61. If either
of those doesn't know the name 192.168.3.199 will be queried.</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>wins server</code></em> = <code class="literal">192.9.200.1 192.168.2.61</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="wins support (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572671"></a>
wins support (G)
</h3></div></div></div><a class="indexterm" name="id2572672"></a><a name="WINSSUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean controls if the <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> process in Samba will act as a WINS server. You should
not set this to <code class="constant">yes</code> unless you have a multi-subnetted network and
you wish a particular <code class="literal">nmbd</code> to be your WINS server.
Note that you should <span class="emphasis"><em>NEVER</em></span> set this to <code class="constant">yes</code>
on more than one machine in your network.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wins support</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="workgroup (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572740"></a>
workgroup (G)
</h3></div></div></div><a class="indexterm" name="id2572741"></a><a name="WORKGROUP"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls what workgroup your server will
appear to be in when queried by clients. Note that this parameter
also controls the Domain name used with
the <a class="link" href="smb.conf.5.html#SECURITY" target="_top">security = domain</a>
setting.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>workgroup</code></em> = <code class="literal">WORKGROUP</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>workgroup</code></em> = <code class="literal">MYGROUP</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="writable"><div class="titlepage"><div><div><h3 class="title"><a name="id2572812"></a>
<a name="WRITABLE"></a>writable
</h3></div></div></div><a class="indexterm" name="id2572813"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#WRITEABLE">writeable</a>.</p></dd></dl></div></div><div class="section" title="writeable (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572843"></a>
writeable (S)
</h3></div></div></div><a class="indexterm" name="id2572844"></a><a name="WRITEABLE"></a><div class="variablelist"><dl><dt></dt><dd><p>Inverted synonym for <a class="link" href="smb.conf.5.html#READONLY" target="_top">read only</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>writeable</code></em> = <code class="literal">no</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="write cache size (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572895"></a>
write cache size (S)
</h3></div></div></div><a class="indexterm" name="id2572896"></a><a name="WRITECACHESIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>If this integer parameter is set to non-zero value,
Samba will create an in-memory cache for each oplocked file
(it does <span class="emphasis"><em>not</em></span> do this for
non-oplocked files). All writes that the client does not request
to be flushed directly to disk will be stored in this cache if possible.
The cache is flushed onto disk when a write comes in whose offset
would not fit into the cache or when the file is closed by the client.
Reads for the file are also served from this cache if the data is stored
within it.</p><p>This cache allows Samba to batch client writes into a more
efficient write size for RAID disks (i.e. writes may be tuned to
be the RAID stripe size) and can improve performance on systems
where the disk subsystem is a bottleneck but there is free
memory for userspace programs.</p><p>The integer parameter specifies the size of this cache
(per oplocked file) in bytes.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>write cache size</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>write cache size</code></em> = <code class="literal">262144
# for a 256k cache size per file</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="write list (S)"><div class="titlepage"><div><div><h3 class="title"><a name="id2572979"></a>
write list (S)
</h3></div></div></div><a class="indexterm" name="id2572980"></a><a name="WRITELIST"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a list of users that are given read-write access to a service. If the
connecting user is in this list then they will be given write access, no matter
what the <a class="link" href="smb.conf.5.html#READONLY" target="_top">read only</a> option is set to. The list can
include group names using the @group syntax.
</p><p>
Note that if a user is in both the read list and the write list then they will be
given write access.
</p><p>
By design, this parameter will not work with the
<a class="link" href="smb.conf.5.html#SECURITY" target="_top">security = share</a> in Samba 3.0.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>write list</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>write list</code></em> = <code class="literal">admin, root, @staff</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="write raw (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2573072"></a>
write raw (G)
</h3></div></div></div><a class="indexterm" name="id2573073"></a><a name="WRITERAW"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether or not the server
will support raw write SMB's when transferring data from clients.
You should never need to change this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>write raw</code></em> = <code class="literal">yes</code>
</em></span>
</p></dd></dl></div></div><div class="section" title="wtmp directory (G)"><div class="titlepage"><div><div><h3 class="title"><a name="id2573116"></a>
wtmp directory (G)
</h3></div></div></div><a class="indexterm" name="id2573117"></a><a name="WTMPDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter is only available if Samba has been configured and compiled with the option <code class="literal">
--with-utmp</code>. It specifies a directory pathname that is used to store the wtmp or wtmpx files (depending on
the UNIX system) that record user connections to a Samba server. The difference with the utmp directory is the fact
that user info is kept after a user has logged out.
</p><p>
By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually
<code class="filename">/var/run/wtmp</code> on Linux).
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wtmp directory</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>wtmp directory</code></em> = <code class="literal">/var/log/wtmp</code>
</em></span>
</p></dd></dl></div></div></div></div><div class="refsect1" title="WARNINGS"><a name="id2573200"></a><h2>WARNINGS</h2><p>
Although the configuration file permits service names to contain spaces, your client software may not.
Spaces will be ignored in comparisons anyway, so it shouldn't be a problem - but be aware of the possibility.
</p><p>
On a similar note, many clients - especially DOS clients - limit service names to eight characters.
<a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> has no such
limitation, but attempts to connect from such clients will fail if they truncate the service names. For this
reason you should probably keep your service names down to eight characters in length.
</p><p>
Use of the <code class="literal">[homes]</code> and <code class="literal">[printers]</code> special sections make life
for an administrator easy, but the various combinations of default attributes can be tricky. Take extreme
care when designing these sections. In particular, ensure that the permissions on spool directories are
correct.
</p></div><div class="refsect1" title="VERSION"><a name="id2573250"></a><h2>VERSION</h2><p>This man page is correct for version 3 of the Samba suite.</p></div><div class="refsect1" title="SEE ALSO"><a name="id2573260"></a><h2>SEE ALSO</h2><p>
<a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a>, <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>, <a class="citerefentry" href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a>, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>, <a class="citerefentry" href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, <a class="citerefentry" href="nmblookup.1.html"><span class="citerefentry"><span class="refentrytitle">nmblookup</span>(1)</span></a>, <a class="citerefentry" href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a>, <a class="citerefentry" href="testprns.1.html"><span class="citerefentry"><span class="refentrytitle">testprns</span>(1)</span></a>.</p></div><div class="refsect1" title="AUTHOR"><a name="id2573340"></a><h2>AUTHOR</h2><p>
The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
</p><p>
The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <a class="ulink" href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 release by Jeremy Allison. The conversion
to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by
Alexander Bokovoy.
</p></div></div></body></html>
|
