← Back to branch summary

~ubuntu-branches/ubuntu/maverick/samba/maverick-security

« back to all changes in this revision

Viewing changes to .pc/fix-manpages-warnings.patch/docs/manpages/smb.conf.5

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2010-01-29 06:16:15 UTC
  • mfrom: (0.27.9 upstream) (0.34.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100129061615-37hs6xqpsdhjq3ld
Tags: 2:3.4.5~dfsg-1ubuntu1
https://launchpad.net/bugs/462169
https://launchpad.net/bugs/493565
* Merge from debian testing.  Remaining changes:
  + debian/patches/VERSION.patch:
    - set SAMBA_VERSION_SUFFIX to Ubuntu.
  + debian/smb.conf:
    - Add "(Samba, Ubuntu)" to server string.
    - Comment out the default [homes] share, and add a comment about "valid users = %s"
      to show users how to restrict access to \\server\username to only username.
    - Set 'usershare allow guests', so that usershare admins are allowed to create
      public shares in additon to authenticated ones.
    - add map to guest = Bad user, maps bad username to gues access.
  + debian/samba-common.conf:
    - Do not change priority to high if dhclient3 is installed.
    - Use priority medium instead of high for the workgroup question.
  + debian/mksambapasswd.awk:
    - Do not add user with UID less than 1000 to smbpasswd.
  + debian/control: 
    - Make libswbclient0 replace/conflict with hardy's likewise-open.
    - Don't build against ctdb, since its not in main yet.
  + debian/rules:
    - Enable "native" PIE hardening.
    - Add BIND_NOW to maximize benefit of RELRO hardening.
  + Add ufw integration:
    - Created debian/samba.ufw.profile.
    - debian/rules, debian/samba.dirs, debian/samba.files: install
  + Add apoort hook:
    - Created debian/source_samba.py.
    - debian/rules, debian/samba.dirs, debian/samba-common-bin.files: install
  + debian/rules, debian/samba.if-up: allow "NetworkManager" as a recognized address
    family... it's obviously /not/ an address family, but it's what gets
    sent when using NM, so we'll cope for now.  (LP: #462169). Taken from karmic-proposed.
  + debian/control: Recommend keyutils for smbfs (LP: #493565)
  + Dropped patches:
    - debian/patches/security-CVE-2009-3297.patch: No longer needed
    - debian/patches/fix-too-many-open-files.patch: No longer needed

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/fix-manpages-warnings.patch/docs/manpages/smb.conf.5
1
 
.\"     Title: smb.conf
2
 
.\"    Author: [see the "AUTHOR" section]
3
 
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4
 
.\"      Date: 10/29/2009
5
 
.\"    Manual: File Formats and Conventions
6
 
.\"    Source: Samba 3.4
7
 
.\"  Language: English
8
 
.\"
9
 
.TH "SMB\&.CONF" "5" "10/29/2009" "Samba 3\&.4" "File Formats and Conventions"
10
 
.\" -----------------------------------------------------------------
11
 
.\" * (re)Define some macros
12
 
.\" -----------------------------------------------------------------
13
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14
 
.\" toupper - uppercase a string (locale-aware)
15
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16
 
.de toupper
17
 
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18
 
\\$*
19
 
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20
 
..
21
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22
 
.\" SH-xref - format a cross-reference to an SH section
23
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24
 
.de SH-xref
25
 
.ie n \{\
26
 
.\}
27
 
.toupper \\$*
28
 
.el \{\
29
 
\\$*
30
 
.\}
31
 
..
32
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33
 
.\" SH - level-one heading that works better for non-TTY output
34
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35
 
.de1 SH
36
 
.\" put an extra blank line of space above the head in non-TTY output
37
 
.if t \{\
38
 
.sp 1
39
 
.\}
40
 
.sp \\n[PD]u
41
 
.nr an-level 1
42
 
.set-an-margin
43
 
.nr an-prevailing-indent \\n[IN]
44
 
.fi
45
 
.in \\n[an-margin]u
46
 
.ti 0
47
 
.HTML-TAG ".NH \\n[an-level]"
48
 
.it 1 an-trap
49
 
.nr an-no-space-flag 1
50
 
.nr an-break-flag 1
51
 
\." make the size of the head bigger
52
 
.ps +3
53
 
.ft B
54
 
.ne (2v + 1u)
55
 
.ie n \{\
56
 
.\" if n (TTY output), use uppercase
57
 
.toupper \\$*
58
 
.\}
59
 
.el \{\
60
 
.nr an-break-flag 0
61
 
.\" if not n (not TTY), use normal case (not uppercase)
62
 
\\$1
63
 
.in \\n[an-margin]u
64
 
.ti 0
65
 
.\" if not n (not TTY), put a border/line under subheading
66
 
.sp -.6
67
 
\l'\n(.lu'
68
 
.\}
69
 
..
70
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71
 
.\" SS - level-two heading that works better for non-TTY output
72
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73
 
.de1 SS
74
 
.sp \\n[PD]u
75
 
.nr an-level 1
76
 
.set-an-margin
77
 
.nr an-prevailing-indent \\n[IN]
78
 
.fi
79
 
.in \\n[IN]u
80
 
.ti \\n[SN]u
81
 
.it 1 an-trap
82
 
.nr an-no-space-flag 1
83
 
.nr an-break-flag 1
84
 
.ps \\n[PS-SS]u
85
 
\." make the size of the head bigger
86
 
.ps +2
87
 
.ft B
88
 
.ne (2v + 1u)
89
 
.if \\n[.$] \&\\$*
90
 
..
91
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92
 
.\" BB/BE - put background/screen (filled box) around block of text
93
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94
 
.de BB
95
 
.if t \{\
96
 
.sp -.5
97
 
.br
98
 
.in +2n
99
 
.ll -2n
100
 
.gcolor red
101
 
.di BX
102
 
.\}
103
 
..
104
 
.de EB
105
 
.if t \{\
106
 
.if "\\$2"adjust-for-leading-newline" \{\
107
 
.sp -1
108
 
.\}
109
 
.br
110
 
.di
111
 
.in
112
 
.ll
113
 
.gcolor
114
 
.nr BW \\n(.lu-\\n(.i
115
 
.nr BH \\n(dn+.5v
116
 
.ne \\n(BHu+.5v
117
 
.ie "\\$2"adjust-for-leading-newline" \{\
118
 
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119
 
.\}
120
 
.el \{\
121
 
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122
 
.\}
123
 
.in 0
124
 
.sp -.5v
125
 
.nf
126
 
.BX
127
 
.in
128
 
.sp .5v
129
 
.fi
130
 
.\}
131
 
..
132
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133
 
.\" BM/EM - put colored marker in margin next to block of text
134
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135
 
.de BM
136
 
.if t \{\
137
 
.br
138
 
.ll -2n
139
 
.gcolor red
140
 
.di BX
141
 
.\}
142
 
..
143
 
.de EM
144
 
.if t \{\
145
 
.br
146
 
.di
147
 
.ll
148
 
.gcolor
149
 
.nr BH \\n(dn
150
 
.ne \\n(BHu
151
 
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152
 
.in 0
153
 
.nf
154
 
.BX
155
 
.in
156
 
.fi
157
 
.\}
158
 
..
159
 
.\" -----------------------------------------------------------------
160
 
.\" * set default formatting
161
 
.\" -----------------------------------------------------------------
162
 
.\" disable hyphenation
163
 
.nh
164
 
.\" disable justification (adjust text to left margin only)
165
 
.ad l
166
 
.\" -----------------------------------------------------------------
167
 
.\" * MAIN CONTENT STARTS HERE *
168
 
.\" -----------------------------------------------------------------
169
 
.SH "Name"
170
 
smb.conf \- The configuration file for the Samba suite
171
 
.SH "SYNOPSIS"
172
 
.PP
173
 
The
174
 
\FCsmb\&.conf\F[]
175
 
file is a configuration file for the Samba suite\&.
176
 
\FCsmb\&.conf\F[]
177
 
contains runtime configuration information for the Samba programs\&. The
178
 
\FCsmb\&.conf\F[]
179
 
file is designed to be configured and administered by the
180
 
\fBswat\fR(8)
181
 
program\&. The complete description of the file format and possible parameters held within are here for reference purposes\&.
182
 
.SH "FILE FORMAT"
183
 
.PP
184
 
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:
185
 
.sp
186
 
.if n \{\
187
 
.RS 4
188
 
.\}
189
 
.fam C
190
 
.ps -1
191
 
.nf
192
 
.if t \{\
193
 
.sp -1
194
 
.\}
195
 
.BB lightgray adjust-for-leading-newline
196
 
.sp -1
197
 
 
198
 
\fIname\fR = \fIvalue \fR
199
 
.EB lightgray adjust-for-leading-newline
200
 
.if t \{\
201
 
.sp 1
202
 
.\}
203
 
.fi
204
 
.fam
205
 
.ps +1
206
 
.if n \{\
207
 
.RE
208
 
.\}
209
 
.PP
210
 
The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\&.
211
 
.PP
212
 
Section and parameter names are not case sensitive\&.
213
 
.PP
214
 
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\&.
215
 
.PP
216
 
Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\&.
217
 
.PP
218
 
Any line ending in a
219
 
\(lq\FC\e\F[]\(rq
220
 
is continued on the next line in the customary UNIX fashion\&.
221
 
.PP
222
 
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\&.
223
 
.SH "SECTION DESCRIPTIONS"
224
 
.PP
225
 
Each section in the configuration file (except for the [global] section) describes a shared resource (known as a
226
 
\(lqshare\(rq)\&. The section name is the name of the shared resource and the parameters within the section define the shares attributes\&.
227
 
.PP
228
 
There are three special sections, [global], [homes] and [printers], which are described under
229
 
\fIspecial sections\fR\&. The following notes apply to ordinary section descriptions\&.
230
 
.PP
231
 
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\&.
232
 
.PP
233
 
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)\&.
234
 
.PP
235
 
Sections may be designated
236
 
\fIguest\fR
237
 
services, in which case no password is required to access them\&. A specified UNIX
238
 
\fIguest account\fR
239
 
is used to define access privileges in this case\&.
240
 
.PP
241
 
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
242
 
\FCuser =\F[]
243
 
option in the share definition\&. For modern clients such as Windows 95/98/ME/NT/2000, this should not be necessary\&.
244
 
.PP
245
 
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\&.
246
 
.PP
247
 
The following sample section defines a file space share\&. The user has write access to the path
248
 
\FC/home/bar\F[]\&. The share is accessed via the share name
249
 
\FCfoo\F[]:
250
 
.sp
251
 
.if n \{\
252
 
.RS 4
253
 
.\}
254
 
.fam C
255
 
.ps -1
256
 
.nf
257
 
.if t \{\
258
 
.sp -1
259
 
.\}
260
 
.BB lightgray adjust-for-leading-newline
261
 
.sp -1
262
 
 
263
 
        \fI[foo]\fR
264
 
        \m[blue]\fBpath = /home/bar\fR\m[]
265
 
        \m[blue]\fBread only = no\fR\m[]
266
 
.EB lightgray adjust-for-leading-newline
267
 
.if t \{\
268
 
.sp 1
269
 
.\}
270
 
.fi
271
 
.fam
272
 
.ps +1
273
 
.if n \{\
274
 
.RE
275
 
.\}
276
 
.PP
277
 
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
278
 
\fIguest ok\fR
279
 
parameter means access will be permitted as the default guest user (specified elsewhere):
280
 
.sp
281
 
.if n \{\
282
 
.RS 4
283
 
.\}
284
 
.fam C
285
 
.ps -1
286
 
.nf
287
 
.if t \{\
288
 
.sp -1
289
 
.\}
290
 
.BB lightgray adjust-for-leading-newline
291
 
.sp -1
292
 
 
293
 
        \fI[aprinter]\fR
294
 
        \m[blue]\fBpath = /usr/spool/public\fR\m[]
295
 
        \m[blue]\fBread only = yes\fR\m[]
296
 
        \m[blue]\fBprintable = yes\fR\m[]
297
 
        \m[blue]\fBguest ok = yes\fR\m[]
298
 
.EB lightgray adjust-for-leading-newline
299
 
.if t \{\
300
 
.sp 1
301
 
.\}
302
 
.fi
303
 
.fam
304
 
.ps +1
305
 
.if n \{\
306
 
.RE
307
 
.\}
308
 
.sp
309
 
.SH "SPECIAL SECTIONS"
310
 
.SS "The [global] section"
311
 
.PP
312
 
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\&.
313
 
.SS "The [homes] section"
314
 
.PP
315
 
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\&.
316
 
.PP
317
 
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\&.
318
 
.PP
319
 
Some modifications are then made to the newly created share:
320
 
.sp
321
 
.RS 4
322
 
.ie n \{\
323
 
\h'-04'\(bu\h'+03'\c
324
 
.\}
325
 
.el \{\
326
 
.sp -1
327
 
.IP \(bu 2.3
328
 
.\}
329
 
The share name is changed from homes to the located username\&.
330
 
.RE
331
 
.sp
332
 
.RS 4
333
 
.ie n \{\
334
 
\h'-04'\(bu\h'+03'\c
335
 
.\}
336
 
.el \{\
337
 
.sp -1
338
 
.IP \(bu 2.3
339
 
.\}
340
 
If no path was given, the path is set to the user\'s home directory\&.
341
 
.sp
342
 
.RE
343
 
.PP
344
 
If you decide to use a
345
 
\fIpath =\fR
346
 
line in your [homes] section, it may be useful to use the %S macro\&. For example:
347
 
.sp
348
 
.if n \{\
349
 
.RS 4
350
 
.\}
351
 
.fam C
352
 
.ps -1
353
 
.nf
354
 
.if t \{\
355
 
.sp -1
356
 
.\}
357
 
.BB lightgray adjust-for-leading-newline
358
 
.sp -1
359
 
 
360
 
\fBpath = /data/pchome/%S\fR
361
 
.EB lightgray adjust-for-leading-newline
362
 
.if t \{\
363
 
.sp 1
364
 
.\}
365
 
.fi
366
 
.fam
367
 
.ps +1
368
 
.if n \{\
369
 
.RE
370
 
.\}
371
 
.sp
372
 
is useful if you have different home directories for your PCs than for UNIX access\&.
373
 
.PP
374
 
This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss\&.
375
 
.PP
376
 
A similar process occurs if the requested section name is
377
 
\(lqhomes\(rq, 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\&.
378
 
.PP
379
 
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:
380
 
.sp
381
 
.if n \{\
382
 
.RS 4
383
 
.\}
384
 
.fam C
385
 
.ps -1
386
 
.nf
387
 
.if t \{\
388
 
.sp -1
389
 
.\}
390
 
.BB lightgray adjust-for-leading-newline
391
 
.sp -1
392
 
 
393
 
\fI[homes]\fR
394
 
\m[blue]\fBread only = no\fR\m[]
395
 
.EB lightgray adjust-for-leading-newline
396
 
.if t \{\
397
 
.sp 1
398
 
.\}
399
 
.fi
400
 
.fam
401
 
.ps +1
402
 
.if n \{\
403
 
.RE
404
 
.\}
405
 
.PP
406
 
An important point is that if guest access is specified in the [homes] section, all home directories will be visible to all clients
407
 
\fIwithout a password\fR\&. In the very unlikely event that this is actually desirable, it is wise to also specify
408
 
\fIread only access\fR\&.
409
 
.PP
410
 
The
411
 
\fIbrowseable\fR
412
 
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
413
 
\fIbrowseable = no\fR
414
 
in the [homes] section will hide the [homes] share but make any auto home directories visible\&.
415
 
.SS "The [printers] section"
416
 
.PP
417
 
This section works like [homes], but for printers\&.
418
 
.PP
419
 
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\&.
420
 
.PP
421
 
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\&.
422
 
.PP
423
 
A few modifications are then made to the newly created share:
424
 
.sp
425
 
.RS 4
426
 
.ie n \{\
427
 
\h'-04'\(bu\h'+03'\c
428
 
.\}
429
 
.el \{\
430
 
.sp -1
431
 
.IP \(bu 2.3
432
 
.\}
433
 
The share name is set to the located printer name
434
 
.RE
435
 
.sp
436
 
.RS 4
437
 
.ie n \{\
438
 
\h'-04'\(bu\h'+03'\c
439
 
.\}
440
 
.el \{\
441
 
.sp -1
442
 
.IP \(bu 2.3
443
 
.\}
444
 
If no printer name was given, the printer name is set to the located printer name
445
 
.RE
446
 
.sp
447
 
.RS 4
448
 
.ie n \{\
449
 
\h'-04'\(bu\h'+03'\c
450
 
.\}
451
 
.el \{\
452
 
.sp -1
453
 
.IP \(bu 2.3
454
 
.\}
455
 
If the share does not permit guest access and no username was given, the username is set to the located printer name\&.
456
 
.sp
457
 
.RE
458
 
.PP
459
 
The [printers] service MUST be printable \- if you specify otherwise, the server will refuse to load the configuration file\&.
460
 
.PP
461
 
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:
462
 
.sp
463
 
.if n \{\
464
 
.RS 4
465
 
.\}
466
 
.fam C
467
 
.ps -1
468
 
.nf
469
 
.if t \{\
470
 
.sp -1
471
 
.\}
472
 
.BB lightgray adjust-for-leading-newline
473
 
.sp -1
474
 
 
475
 
\fI[printers]\fR
476
 
\m[blue]\fBpath = /usr/spool/public\fR\m[]
477
 
\m[blue]\fBguest ok = yes\fR\m[]
478
 
\m[blue]\fBprintable = yes\fR\m[]
479
 
.EB lightgray adjust-for-leading-newline
480
 
.if t \{\
481
 
.sp 1
482
 
.\}
483
 
.fi
484
 
.fam
485
 
.ps +1
486
 
.if n \{\
487
 
.RE
488
 
.\}
489
 
.PP
490
 
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:
491
 
.sp
492
 
.if n \{\
493
 
.RS 4
494
 
.\}
495
 
.fam C
496
 
.ps -1
497
 
.nf
498
 
.if t \{\
499
 
.sp -1
500
 
.\}
501
 
.BB lightgray adjust-for-leading-newline
502
 
.sp -1
503
 
 
504
 
alias|alias|alias|alias\&.\&.\&.    
505
 
.EB lightgray adjust-for-leading-newline
506
 
.if t \{\
507
 
.sp 1
508
 
.\}
509
 
.fi
510
 
.fam
511
 
.ps +1
512
 
.if n \{\
513
 
.RE
514
 
.\}
515
 
.PP
516
 
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\&.
517
 
.PP
518
 
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 (\FC|\F[])\&.
519
 
.if n \{\
520
 
.sp
521
 
.\}
522
 
.RS 4
523
 
.BM yellow
524
 
.it 1 an-trap
525
 
.nr an-no-space-flag 1
526
 
.nr an-break-flag 1
527
 
.br
528
 
.ps +1
529
 
\fBNote\fR
530
 
.ps -1
531
 
.br
532
 
.PP
533
 
On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use
534
 
\FCprintcap name = lpstat\F[]
535
 
to automatically obtain a list of printers\&. See the
536
 
\FCprintcap name\F[]
537
 
option for more details\&.
538
 
.sp .5v
539
 
.EM yellow
540
 
.RE
541
 
.SH "USERSHARES"
542
 
.PP
543
 
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
544
 
\fIusershares\fR
545
 
and is controlled by a set of parameters in the [global] section of the smb\&.conf\&. The relevant parameters are :
546
 
.PP
547
 
usershare allow guests
548
 
.RS 4
549
 
Controls if usershares can permit guest access\&.
550
 
.RE
551
 
.PP
552
 
usershare max shares
553
 
.RS 4
554
 
Maximum number of user defined shares allowed\&.
555
 
.RE
556
 
.PP
557
 
usershare owner only
558
 
.RS 4
559
 
If set only directories owned by the sharing user can be shared\&.
560
 
.RE
561
 
.PP
562
 
usershare path
563
 
.RS 4
564
 
Points to the directory containing the user defined share definitions\&. The filesystem permissions on this directory control who can create user defined shares\&.
565
 
.RE
566
 
.PP
567
 
usershare prefix allow list
568
 
.RS 4
569
 
Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Only directories below the pathnames in this list are permitted\&.
570
 
.RE
571
 
.PP
572
 
usershare prefix deny list
573
 
.RS 4
574
 
Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Directories below the pathnames in this list are prohibited\&.
575
 
.RE
576
 
.PP
577
 
usershare template share
578
 
.RS 4
579
 
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\&.
580
 
.RE
581
 
.PP
582
 
To allow members of the UNIX group
583
 
\FCfoo\F[]
584
 
to create user defined shares, create the directory to contain the share definitions as follows:
585
 
.PP
586
 
Become root:
587
 
.sp
588
 
.if n \{\
589
 
.RS 4
590
 
.\}
591
 
.fam C
592
 
.ps -1
593
 
.nf
594
 
.if t \{\
595
 
.sp -1
596
 
.\}
597
 
.BB lightgray adjust-for-leading-newline
598
 
.sp -1
599
 
 
600
 
mkdir /usr/local/samba/lib/usershares
601
 
chgrp foo /usr/local/samba/lib/usershares
602
 
chmod 1770 /usr/local/samba/lib/usershares
603
 
.EB lightgray adjust-for-leading-newline
604
 
.if t \{\
605
 
.sp 1
606
 
.\}
607
 
.fi
608
 
.fam
609
 
.ps +1
610
 
.if n \{\
611
 
.RE
612
 
.\}
613
 
.PP
614
 
Then add the parameters
615
 
.sp
616
 
.if n \{\
617
 
.RS 4
618
 
.\}
619
 
.fam C
620
 
.ps -1
621
 
.nf
622
 
.if t \{\
623
 
.sp -1
624
 
.\}
625
 
.BB lightgray adjust-for-leading-newline
626
 
.sp -1
627
 
 
628
 
        \m[blue]\fBusershare path = /usr/local/samba/lib/usershares\fR\m[]
629
 
        \m[blue]\fBusershare max shares = 10\fR\m[] # (or the desired number of shares)
630
 
.EB lightgray adjust-for-leading-newline
631
 
.if t \{\
632
 
.sp 1
633
 
.\}
634
 
.fi
635
 
.fam
636
 
.ps +1
637
 
.if n \{\
638
 
.RE
639
 
.\}
640
 
.sp
641
 
to the global section of your
642
 
\FCsmb\&.conf\F[]\&. Members of the group foo may then manipulate the user defined shares using the following commands\&.
643
 
.PP
644
 
net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]
645
 
.RS 4
646
 
To create or modify (overwrite) a user defined share\&.
647
 
.RE
648
 
.PP
649
 
net usershare delete sharename
650
 
.RS 4
651
 
To delete a user defined share\&.
652
 
.RE
653
 
.PP
654
 
net usershare list wildcard\-sharename
655
 
.RS 4
656
 
To list user defined shares\&.
657
 
.RE
658
 
.PP
659
 
net usershare info wildcard\-sharename
660
 
.RS 4
661
 
To print information about user defined shares\&.
662
 
.RE
663
 
.SH "PARAMETERS"
664
 
.PP
665
 
Parameters define the specific attributes of sections\&.
666
 
.PP
667
 
Some parameters are specific to the [global] section (e\&.g\&.,
668
 
\fIsecurity\fR)\&. Some parameters are usable in all sections (e\&.g\&.,
669
 
\fIcreate mask\fR)\&. 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
670
 
\fIG\fR
671
 
in parentheses indicates that a parameter is specific to the [global] section\&. The letter
672
 
\fIS\fR
673
 
indicates that a parameter can be specified in a service specific section\&. All
674
 
\fIS\fR
675
 
parameters can also be specified in the [global] section \- in which case they will define the default behavior for all services\&.
676
 
.PP
677
 
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\&.
678
 
.SH "VARIABLE SUBSTITUTIONS"
679
 
.PP
680
 
Many of the strings that are settable in the config file can take substitutions\&. For example the option
681
 
\(lqpath = /tmp/%u\(rq
682
 
is interpreted as
683
 
\(lqpath = /tmp/john\(rq
684
 
if the user connected with the username john\&.
685
 
.PP
686
 
These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant\&. These are:
687
 
.PP
688
 
%U
689
 
.RS 4
690
 
session username (the username that the client wanted, not necessarily the same as the one they got)\&.
691
 
.RE
692
 
.PP
693
 
%G
694
 
.RS 4
695
 
primary group name of %U\&.
696
 
.RE
697
 
.PP
698
 
%h
699
 
.RS 4
700
 
the Internet hostname that Samba is running on\&.
701
 
.RE
702
 
.PP
703
 
%m
704
 
.RS 4
705
 
the NetBIOS name of the client machine (very useful)\&.
706
 
.sp
707
 
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
708
 
\fIsmb ports = 139\fR\&. This will cause Samba to not listen on port 445 and will permit include functionality to function as it did with Samba 2\&.x\&.
709
 
.RE
710
 
.PP
711
 
%L
712
 
.RS 4
713
 
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
714
 
\(lqdual personality\(rq\&.
715
 
.RE
716
 
.PP
717
 
%M
718
 
.RS 4
719
 
the Internet name of the client machine\&.
720
 
.RE
721
 
.PP
722
 
%R
723
 
.RS 4
724
 
the selected protocol level after protocol negotiation\&. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1\&.
725
 
.RE
726
 
.PP
727
 
%d
728
 
.RS 4
729
 
the process id of the current server process\&.
730
 
.RE
731
 
.PP
732
 
%a
733
 
.RS 4
734
 
The architecture of the remote machine\&. It currently recognizes Samba (\fBSamba\fR), the Linux CIFS file system (\fBCIFSFS\fR), OS/2, (\fBOS2\fR), Windows for Workgroups (\fBWfWg\fR), Windows 9x/ME (\fBWin95\fR), Windows NT (\fBWinNT\fR), Windows 2000 (\fBWin2K\fR), Windows XP (\fBWinXP\fR), Windows XP 64\-bit(\fBWinXP64\fR), Windows 2003 including 2003R2 (\fBWin2K3\fR), and Windows Vista (\fBVista\fR)\&. Anything else will be known as
735
 
\fBUNKNOWN\fR\&.
736
 
.RE
737
 
.PP
738
 
%I
739
 
.RS 4
740
 
the IP address of the client machine\&.
741
 
.RE
742
 
.PP
743
 
%i
744
 
.RS 4
745
 
the local IP address to which a client connected\&.
746
 
.RE
747
 
.PP
748
 
%T
749
 
.RS 4
750
 
the current date and time\&.
751
 
.RE
752
 
.PP
753
 
%D
754
 
.RS 4
755
 
name of the domain or workgroup of the current user\&.
756
 
.RE
757
 
.PP
758
 
%w
759
 
.RS 4
760
 
the winbind separator\&.
761
 
.RE
762
 
.PP
763
 
%$(\fIenvvar\fR)
764
 
.RS 4
765
 
the value of the environment variable
766
 
\fIenvar\fR\&.
767
 
.RE
768
 
.PP
769
 
The following substitutes apply only to some configuration options (only those that are used when a connection has been established):
770
 
.PP
771
 
%S
772
 
.RS 4
773
 
the name of the current service, if any\&.
774
 
.RE
775
 
.PP
776
 
%P
777
 
.RS 4
778
 
the root directory of the current service, if any\&.
779
 
.RE
780
 
.PP
781
 
%u
782
 
.RS 4
783
 
username of the current service, if any\&.
784
 
.RE
785
 
.PP
786
 
%g
787
 
.RS 4
788
 
primary group name of %u\&.
789
 
.RE
790
 
.PP
791
 
%H
792
 
.RS 4
793
 
the home directory of the user given by %u\&.
794
 
.RE
795
 
.PP
796
 
%N
797
 
.RS 4
798
 
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
799
 
\fI\-\-with\-automount\fR
800
 
option, this value will be the same as %L\&.
801
 
.RE
802
 
.PP
803
 
%p
804
 
.RS 4
805
 
the path of the service\'s home directory, obtained from your NIS auto\&.map entry\&. The NIS auto\&.map entry is split up as
806
 
\FC%N:%p\F[]\&.
807
 
.RE
808
 
.PP
809
 
There are some quite creative things that can be done with these substitutions and other
810
 
\FCsmb\&.conf\F[]
811
 
options\&.
812
 
.SH "NAME MANGLING"
813
 
.PP
814
 
Samba supports
815
 
\FCname mangling\F[]
816
 
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\&.
817
 
.PP
818
 
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\&.
819
 
.PP
820
 
These options can be set separately for each service\&.
821
 
.PP
822
 
The options are:
823
 
.PP
824
 
case sensitive = yes/no/auto
825
 
.RS 4
826
 
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
827
 
\fIauto\fR\&.
828
 
.RE
829
 
.PP
830
 
default case = upper/lower
831
 
.RS 4
832
 
controls what the default case is for new filenames (ie\&. files that don\'t currently exist in the filesystem)\&. Default
833
 
\fIlower\fR\&. IMPORTANT NOTE: This option will be used to modify the case of
834
 
\fIall\fR
835
 
incoming client filenames, not just new filenames if the options
836
 
\m[blue]\fBcase sensitive = yes\fR\m[],
837
 
\m[blue]\fBpreserve case = No\fR\m[],
838
 
\m[blue]\fBshort preserve case = No\fR\m[]
839
 
are set\&. This change is needed as part of the optimisations for directories containing large numbers of files\&.
840
 
.RE
841
 
.PP
842
 
preserve case = yes/no
843
 
.RS 4
844
 
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
845
 
\FCdefault\F[]
846
 
case\&. Default
847
 
\fIyes\fR\&.
848
 
.RE
849
 
.PP
850
 
short preserve case = yes/no
851
 
.RS 4
852
 
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
853
 
\FCdefault\F[]
854
 
case\&. This option can be used with
855
 
\FCpreserve case = yes\F[]
856
 
to permit long filenames to retain their case, while short names are lowercased\&. Default
857
 
\fIyes\fR\&.
858
 
.RE
859
 
.PP
860
 
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\&.
861
 
.SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
862
 
.PP
863
 
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\&.
864
 
.PP
865
 
If the service is marked
866
 
\(lqguest only = yes\(rq
867
 
and the server is running with share\-level security (\(lqsecurity = share\(rq, steps 1 to 5 are skipped\&.
868
 
.sp
869
 
.RS 4
870
 
.ie n \{\
871
 
\h'-04' 1.\h'+01'\c
872
 
.\}
873
 
.el \{\
874
 
.sp -1
875
 
.IP "  1." 4.2
876
 
.\}
877
 
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
878
 
\FC\e\eserver\eservice\F[]%\fIusername\fR
879
 
method of passing a username\&.
880
 
.RE
881
 
.sp
882
 
.RS 4
883
 
.ie n \{\
884
 
\h'-04' 2.\h'+01'\c
885
 
.\}
886
 
.el \{\
887
 
.sp -1
888
 
.IP "  2." 4.2
889
 
.\}
890
 
If the client has previously registered a username with the system and now supplies a correct password for that username, the connection is allowed\&.
891
 
.RE
892
 
.sp
893
 
.RS 4
894
 
.ie n \{\
895
 
\h'-04' 3.\h'+01'\c
896
 
.\}
897
 
.el \{\
898
 
.sp -1
899
 
.IP "  3." 4.2
900
 
.\}
901
 
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\&.
902
 
.RE
903
 
.sp
904
 
.RS 4
905
 
.ie n \{\
906
 
\h'-04' 4.\h'+01'\c
907
 
.\}
908
 
.el \{\
909
 
.sp -1
910
 
.IP "  4." 4.2
911
 
.\}
912
 
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\&.
913
 
.RE
914
 
.sp
915
 
.RS 4
916
 
.ie n \{\
917
 
\h'-04' 5.\h'+01'\c
918
 
.\}
919
 
.el \{\
920
 
.sp -1
921
 
.IP "  5." 4.2
922
 
.\}
923
 
If a
924
 
\FCuser = \F[]
925
 
field is given in the
926
 
\FCsmb\&.conf\F[]
927
 
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
928
 
\FCuser =\F[]
929
 
field, the connection is made as the username in the
930
 
\FCuser =\F[]
931
 
line\&. If one of the usernames in the
932
 
\FCuser =\F[]
933
 
list begins with a
934
 
\FC@\F[], that name expands to a list of names in the group of the same name\&.
935
 
.RE
936
 
.sp
937
 
.RS 4
938
 
.ie n \{\
939
 
\h'-04' 6.\h'+01'\c
940
 
.\}
941
 
.el \{\
942
 
.sp -1
943
 
.IP "  6." 4.2
944
 
.\}
945
 
If the service is a guest service, a connection is made as the username given in the
946
 
\FCguest account =\F[]
947
 
for the service, irrespective of the supplied password\&.
948
 
.RE
949
 
.SH "REGISTRY-BASED CONFIGURATION"
950
 
.PP
951
 
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
952
 
\fI\FCHKLM\eSoftware\eSamba\esmbconf\F[]\fR\&. There are two levels of registry configuration:
953
 
.sp
954
 
.RS 4
955
 
.ie n \{\
956
 
\h'-04' 1.\h'+01'\c
957
 
.\}
958
 
.el \{\
959
 
.sp -1
960
 
.IP "  1." 4.2
961
 
.\}
962
 
Share definitions stored in registry are used\&. This is triggered by setting the global parameter
963
 
\fIregistry shares\fR
964
 
to
965
 
\(lqyes\(rq
966
 
in
967
 
\fIsmb\&.conf\fR\&.
968
 
.sp
969
 
The registry shares are loaded not at startup but on demand at runtime by
970
 
\fIsmbd\fR\&. Shares defined in
971
 
\fIsmb\&.conf\fR
972
 
take priority over shares of the same name defined in registry\&.
973
 
.RE
974
 
.sp
975
 
.RS 4
976
 
.ie n \{\
977
 
\h'-04' 2.\h'+01'\c
978
 
.\}
979
 
.el \{\
980
 
.sp -1
981
 
.IP "  2." 4.2
982
 
.\}
983
 
Global
984
 
\fIsmb\&.conf\fR
985
 
options stored in registry are used\&. This can be activated in two different ways:
986
 
.sp
987
 
Firstly, a registry only configuration is triggered by setting
988
 
\m[blue]\fBconfig backend = registry\fR\m[]
989
 
in the [global] section of
990
 
\fIsmb\&.conf\fR\&. 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\&.
991
 
.sp
992
 
Secondly, a mixed configuration can be activated by a special new meaning of the parameter
993
 
\m[blue]\fBinclude = registry\fR\m[]
994
 
in the [global] section of
995
 
\fIsmb\&.conf\fR\&. 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\&.
996
 
.sp
997
 
Activation of global registry options automatically activates registry shares\&. So in the registry only case, shares are loaded on demand only\&.
998
 
.RE
999
 
.sp
1000
 
.RE
1001
 
.PP
1002
 
Note: To make registry\-based configurations foolproof at least to a certain extent, the use of
1003
 
\fIlock directory\fR
1004
 
and
1005
 
\fIconfig backend\fR
1006
 
inside the registry configuration has been disabled: Especially by changing the
1007
 
\fIlock directory\fR
1008
 
inside the registry configuration, one would create a broken setup where the daemons do not see the configuration they loaded once it is active\&.
1009
 
.PP
1010
 
The registry configuration can be accessed with tools like
1011
 
\fIregedit\fR
1012
 
or
1013
 
\fInet (rpc) registry\fR
1014
 
in the key
1015
 
\fI\FCHKLM\eSoftware\eSamba\esmbconf\F[]\fR\&. More conveniently, the
1016
 
\fIconf\fR
1017
 
subcommand of the
1018
 
\fBnet\fR(8)
1019
 
utility offers a dedicated interface to read and write the registry based configuration locally, i\&.e\&. directly accessing the database file, circumventing the server\&.
1020
 
.SH "EXPLANATION OF EACH PARAMETER"
1021
 
 
1022
 
 
1023
 
abort shutdown script (G)
1024
 
.\" abort shutdown script
1025
 
.PP
1026
 
.RS 4
1027
 
This a full path name to a script called by
1028
 
\fBsmbd\fR(8)
1029
 
that should stop a shutdown procedure issued by the
1030
 
\m[blue]\fBshutdown script\fR\m[]\&.
1031
 
.sp
1032
 
If the connected user posseses the
1033
 
\fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.
1034
 
.sp
1035
 
Default:
1036
 
\fI\fIabort shutdown script\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
1037
 
.sp
1038
 
Example:
1039
 
\fI\fIabort shutdown script\fR\fR\fI = \fR\fI\FC/sbin/shutdown \-c\F[]\fR\fI \fR
1040
 
.RE
1041
 
 
1042
 
access based share enum (S)
1043
 
.\" access based share enum
1044
 
.PP
1045
 
.RS 4
1046
 
If this parameter is
1047
 
\fByes\fR
1048
 
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 \e\esambaserver)\&. 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\&.
1049
 
.sp
1050
 
Default:
1051
 
\fI\fIaccess based share enum\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1052
 
.RE
1053
 
 
1054
 
acl check permissions (S)
1055
 
.\" acl check permissions
1056
 
.PP
1057
 
.RS 4
1058
 
This boolean parameter controls what
1059
 
\fBsmbd\fR(8)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\&.
1060
 
.sp
1061
 
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\&.
1062
 
.sp
1063
 
Default:
1064
 
\fI\fIacl check permissions\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
1065
 
.RE
1066
 
 
1067
 
acl compatibility (G)
1068
 
.\" acl compatibility
1069
 
.PP
1070
 
.RS 4
1071
 
This parameter specifies what OS ACL semantics should be compatible with\&. Possible values are
1072
 
\fIwinnt\fR
1073
 
for Windows NT 4,
1074
 
\fIwin2k\fR
1075
 
for Windows 2000 and above and
1076
 
\fIauto\fR\&. If you specify
1077
 
\fIauto\fR, 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\&.
1078
 
.sp
1079
 
Default:
1080
 
\fI\fIacl compatibility\fR\fR\fI = \fR\fI\FCAuto\F[]\fR\fI \fR
1081
 
.sp
1082
 
Example:
1083
 
\fI\fIacl compatibility\fR\fR\fI = \fR\fI\FCwin2k\F[]\fR\fI \fR
1084
 
.RE
1085
 
 
1086
 
acl group control (S)
1087
 
.\" acl group control
1088
 
.PP
1089
 
.RS 4
1090
 
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
1091
 
\fIprimary group owner\fR
1092
 
of a file or directory to modify the permissions and ACLs on that file\&.
1093
 
.sp
1094
 
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\&.
1095
 
.sp
1096
 
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\&.
1097
 
.sp
1098
 
This parameter is best used with the
1099
 
\m[blue]\fBinherit owner\fR\m[]
1100
 
option and also on on a share containing directories with the UNIX
1101
 
\fIsetgid bit\fR
1102
 
set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory\&.
1103
 
.sp
1104
 
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
1105
 
\fIdos filemode\fR
1106
 
option\&.
1107
 
.sp
1108
 
Default:
1109
 
\fI\fIacl group control\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1110
 
.RE
1111
 
 
1112
 
acl map full control (S)
1113
 
.\" acl map full control
1114
 
.PP
1115
 
.RS 4
1116
 
This boolean parameter controls whether
1117
 
\fBsmbd\fR(8)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\&.
1118
 
.sp
1119
 
Default:
1120
 
\fI\fIacl map full control\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
1121
 
.RE
1122
 
 
1123
 
add group script (G)
1124
 
.\" add group script
1125
 
.PP
1126
 
.RS 4
1127
 
This is the full pathname to a script that will be run
1128
 
\fIAS ROOT\fR
1129
 
by
1130
 
\fBsmbd\fR(8)
1131
 
when a new group is requested\&. It will expand any
1132
 
\fI%g\fR
1133
 
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\&.
1134
 
.sp
1135
 
Default:
1136
 
\fI\fIadd group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1137
 
.sp
1138
 
Example:
1139
 
\fI\fIadd group script\fR\fR\fI = \fR\fI\FC/usr/sbin/groupadd %g\F[]\fR\fI \fR
1140
 
.RE
1141
 
 
1142
 
add machine script (G)
1143
 
.\" add machine script
1144
 
.PP
1145
 
.RS 4
1146
 
This is the full pathname to a script that will be run by
1147
 
\fBsmbd\fR(8)
1148
 
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\&.
1149
 
.sp
1150
 
This option is very similar to the
1151
 
\m[blue]\fBadd user script\fR\m[], and likewise uses the %u substitution for the account name\&. Do not use the %m substitution\&.
1152
 
.sp
1153
 
Default:
1154
 
\fI\fIadd machine script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1155
 
.sp
1156
 
Example for Debian:
1157
 
\fI\fIadd machine script\fR\fR\fI = \fR\fI\FC/usr/sbin/adduser \-\-disabled-password \-\-ingroup machines \-\-gecos Machine \-\-home /var/lib/samba \-\-shell /bin/false %u\F[]\fR\fI \fR
1158
 
.RE
1159
 
 
1160
 
add port command (G)
1161
 
.\" add port command
1162
 
.PP
1163
 
.RS 4
1164
 
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:
1165
 
.sp
1166
 
.RS 4
1167
 
.ie n \{\
1168
 
\h'-04'\(bu\h'+03'\c
1169
 
.\}
1170
 
.el \{\
1171
 
.sp -1
1172
 
.IP \(bu 2.3
1173
 
.\}
1174
 
\fIport name\fR
1175
 
.RE
1176
 
.sp
1177
 
.RS 4
1178
 
.ie n \{\
1179
 
\h'-04'\(bu\h'+03'\c
1180
 
.\}
1181
 
.el \{\
1182
 
.sp -1
1183
 
.IP \(bu 2.3
1184
 
.\}
1185
 
\fIdevice URI\fR
1186
 
.sp
1187
 
.RE
1188
 
The deviceURI is in the for of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>\&.
1189
 
.sp
1190
 
Default:
1191
 
\fI\fIadd port command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1192
 
.sp
1193
 
Example:
1194
 
\fI\fIadd port command\fR\fR\fI = \fR\fI\FC/etc/samba/scripts/addport\&.sh\F[]\fR\fI \fR
1195
 
.RE
1196
 
 
1197
 
addprinter command (G)
1198
 
.\" addprinter command
1199
 
.PP
1200
 
.RS 4
1201
 
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\&.
1202
 
.sp
1203
 
For a Samba host this means that the printer must be physically added to the underlying printing system\&. The
1204
 
\fIaddprinter command\fR
1205
 
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
1206
 
\FCsmb\&.conf\F[]
1207
 
file in order that it can be shared by
1208
 
\fBsmbd\fR(8)\&.
1209
 
.sp
1210
 
The
1211
 
\fIaddprinter command\fR
1212
 
is automatically invoked with the following parameter (in order):
1213
 
.sp
1214
 
.RS 4
1215
 
.ie n \{\
1216
 
\h'-04'\(bu\h'+03'\c
1217
 
.\}
1218
 
.el \{\
1219
 
.sp -1
1220
 
.IP \(bu 2.3
1221
 
.\}
1222
 
\fIprinter name\fR
1223
 
.RE
1224
 
.sp
1225
 
.RS 4
1226
 
.ie n \{\
1227
 
\h'-04'\(bu\h'+03'\c
1228
 
.\}
1229
 
.el \{\
1230
 
.sp -1
1231
 
.IP \(bu 2.3
1232
 
.\}
1233
 
\fIshare name\fR
1234
 
.RE
1235
 
.sp
1236
 
.RS 4
1237
 
.ie n \{\
1238
 
\h'-04'\(bu\h'+03'\c
1239
 
.\}
1240
 
.el \{\
1241
 
.sp -1
1242
 
.IP \(bu 2.3
1243
 
.\}
1244
 
\fIport name\fR
1245
 
.RE
1246
 
.sp
1247
 
.RS 4
1248
 
.ie n \{\
1249
 
\h'-04'\(bu\h'+03'\c
1250
 
.\}
1251
 
.el \{\
1252
 
.sp -1
1253
 
.IP \(bu 2.3
1254
 
.\}
1255
 
\fIdriver name\fR
1256
 
.RE
1257
 
.sp
1258
 
.RS 4
1259
 
.ie n \{\
1260
 
\h'-04'\(bu\h'+03'\c
1261
 
.\}
1262
 
.el \{\
1263
 
.sp -1
1264
 
.IP \(bu 2.3
1265
 
.\}
1266
 
\fIlocation\fR
1267
 
.RE
1268
 
.sp
1269
 
.RS 4
1270
 
.ie n \{\
1271
 
\h'-04'\(bu\h'+03'\c
1272
 
.\}
1273
 
.el \{\
1274
 
.sp -1
1275
 
.IP \(bu 2.3
1276
 
.\}
1277
 
\fIWindows 9x driver location\fR
1278
 
.sp
1279
 
.RE
1280
 
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\&.
1281
 
.sp
1282
 
Once the
1283
 
\fIaddprinter command\fR
1284
 
has been executed,
1285
 
\FCsmbd\F[]
1286
 
will reparse the
1287
 
\FC smb\&.conf\F[]
1288
 
to determine if the share defined by the APW exists\&. If the sharename is still invalid, then
1289
 
\FCsmbd \F[]
1290
 
will return an ACCESS_DENIED error to the client\&.
1291
 
.sp
1292
 
The
1293
 
\fIaddprinter command\fR
1294
 
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\&.
1295
 
.sp
1296
 
Default:
1297
 
\fI\fIaddprinter command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1298
 
.sp
1299
 
Example:
1300
 
\fI\fIaddprinter command\fR\fR\fI = \fR\fI\FC/usr/bin/addprinter\F[]\fR\fI \fR
1301
 
.RE
1302
 
 
1303
 
add share command (G)
1304
 
.\" add share command
1305
 
.PP
1306
 
.RS 4
1307
 
Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
1308
 
\fIadd share command\fR
1309
 
is used to define an external program or script which will add a new service definition to
1310
 
\FCsmb\&.conf\F[]\&.
1311
 
.sp
1312
 
In order to successfully execute the
1313
 
\fIadd share command\fR,
1314
 
\FCsmbd\F[]
1315
 
requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
1316
 
\FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
1317
 
\fIadd share command\fR
1318
 
parameter are executed as root\&.
1319
 
.sp
1320
 
When executed,
1321
 
\FCsmbd\F[]
1322
 
will automatically invoke the
1323
 
\fIadd share command\fR
1324
 
with five parameters\&.
1325
 
.sp
1326
 
.RS 4
1327
 
.ie n \{\
1328
 
\h'-04'\(bu\h'+03'\c
1329
 
.\}
1330
 
.el \{\
1331
 
.sp -1
1332
 
.IP \(bu 2.3
1333
 
.\}
1334
 
\fIconfigFile\fR
1335
 
\- the location of the global
1336
 
\FCsmb\&.conf\F[]
1337
 
file\&.
1338
 
.RE
1339
 
.sp
1340
 
.RS 4
1341
 
.ie n \{\
1342
 
\h'-04'\(bu\h'+03'\c
1343
 
.\}
1344
 
.el \{\
1345
 
.sp -1
1346
 
.IP \(bu 2.3
1347
 
.\}
1348
 
\fIshareName\fR
1349
 
\- the name of the new share\&.
1350
 
.RE
1351
 
.sp
1352
 
.RS 4
1353
 
.ie n \{\
1354
 
\h'-04'\(bu\h'+03'\c
1355
 
.\}
1356
 
.el \{\
1357
 
.sp -1
1358
 
.IP \(bu 2.3
1359
 
.\}
1360
 
\fIpathName\fR
1361
 
\- path to an **existing** directory on disk\&.
1362
 
.RE
1363
 
.sp
1364
 
.RS 4
1365
 
.ie n \{\
1366
 
\h'-04'\(bu\h'+03'\c
1367
 
.\}
1368
 
.el \{\
1369
 
.sp -1
1370
 
.IP \(bu 2.3
1371
 
.\}
1372
 
\fIcomment\fR
1373
 
\- comment string to associate with the new share\&.
1374
 
.RE
1375
 
.sp
1376
 
.RS 4
1377
 
.ie n \{\
1378
 
\h'-04'\(bu\h'+03'\c
1379
 
.\}
1380
 
.el \{\
1381
 
.sp -1
1382
 
.IP \(bu 2.3
1383
 
.\}
1384
 
\fImax connections\fR
1385
 
Number of maximum simultaneous connections to this share\&.
1386
 
.sp
1387
 
.RE
1388
 
This parameter is only used to add file shares\&. To add printer shares, see the
1389
 
\m[blue]\fBaddprinter command\fR\m[]\&.
1390
 
.sp
1391
 
Default:
1392
 
\fI\fIadd share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1393
 
.sp
1394
 
Example:
1395
 
\fI\fIadd share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/addshare\F[]\fR\fI \fR
1396
 
.RE
1397
 
 
1398
 
add user script (G)
1399
 
.\" add user script
1400
 
.PP
1401
 
.RS 4
1402
 
This is the full pathname to a script that will be run
1403
 
\fIAS ROOT\fR
1404
 
by
1405
 
\fBsmbd\fR(8)
1406
 
under special circumstances described below\&.
1407
 
.sp
1408
 
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
1409
 
\fION DEMAND\fR
1410
 
when a user accesses the Samba server\&.
1411
 
.sp
1412
 
In order to use this option,
1413
 
\fBsmbd\fR(8)
1414
 
must
1415
 
\fINOT\fR
1416
 
be set to
1417
 
\m[blue]\fBsecurity = share\fR\m[]
1418
 
and
1419
 
\m[blue]\fBadd user script\fR\m[]
1420
 
must be set to a full pathname for a script that will create a UNIX user given one argument of
1421
 
\fI%u\fR, which expands into the UNIX user name to create\&.
1422
 
.sp
1423
 
When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time,
1424
 
\fBsmbd\fR(8)
1425
 
contacts the
1426
 
\m[blue]\fBpassword server\fR\m[]
1427
 
and attempts to authenticate the given user with the given password\&. If the authentication succeeds then
1428
 
\FCsmbd\F[]
1429
 
attempts to find a UNIX user in the UNIX password database to map the Windows user into\&. If this lookup fails, and
1430
 
\m[blue]\fBadd user script\fR\m[]
1431
 
is set then
1432
 
\FCsmbd\F[]
1433
 
will call the specified script
1434
 
\fIAS ROOT\fR, expanding any
1435
 
\fI%u\fR
1436
 
argument to be the user name to create\&.
1437
 
.sp
1438
 
If this script successfully creates the user then
1439
 
\FCsmbd\F[]
1440
 
will continue on as though the UNIX user already existed\&. In this way, UNIX users are dynamically created to match existing Windows NT accounts\&.
1441
 
.sp
1442
 
See also
1443
 
\m[blue]\fBsecurity\fR\m[],
1444
 
\m[blue]\fBpassword server\fR\m[],
1445
 
\m[blue]\fBdelete user script\fR\m[]\&.
1446
 
.sp
1447
 
Default:
1448
 
\fI\fIadd user script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1449
 
.sp
1450
 
Example:
1451
 
\fI\fIadd user script\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/add_user %u\F[]\fR\fI \fR
1452
 
.RE
1453
 
 
1454
 
add user to group script (G)
1455
 
.\" add user to group script
1456
 
.PP
1457
 
.RS 4
1458
 
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
1459
 
\fBsmbd\fR(8)
1460
 
\fIAS ROOT\fR\&. Any
1461
 
\fI%g\fR
1462
 
will be replaced with the group name and any
1463
 
\fI%u\fR
1464
 
will be replaced with the user name\&.
1465
 
.sp
1466
 
Note that the
1467
 
\FCadduser\F[]
1468
 
command used in the example below does not support the used syntax on all systems\&.
1469
 
.sp
1470
 
Default:
1471
 
\fI\fIadd user to group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1472
 
.sp
1473
 
Example:
1474
 
\fI\fIadd user to group script\fR\fR\fI = \fR\fI\FC/usr/sbin/adduser %u %g\F[]\fR\fI \fR
1475
 
.RE
1476
 
 
1477
 
administrative share (S)
1478
 
.\" administrative share
1479
 
.PP
1480
 
.RS 4
1481
 
If this parameter is set to
1482
 
\fByes\fR
1483
 
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\&.
1484
 
.sp
1485
 
See the section below on
1486
 
\m[blue]\fBsecurity\fR\m[]
1487
 
for more information about this option\&.
1488
 
.sp
1489
 
Default:
1490
 
\fI\fIadministrative share\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1491
 
.RE
1492
 
 
1493
 
admin users (S)
1494
 
.\" admin users
1495
 
.PP
1496
 
.RS 4
1497
 
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)\&.
1498
 
.sp
1499
 
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\&.
1500
 
.sp
1501
 
This parameter will not work with the
1502
 
\m[blue]\fBsecurity = share\fR\m[]
1503
 
in Samba 3\&.0\&. This is by design\&.
1504
 
.sp
1505
 
Default:
1506
 
\fI\fIadmin users\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1507
 
.sp
1508
 
Example:
1509
 
\fI\fIadmin users\fR\fR\fI = \fR\fI\FCjason\F[]\fR\fI \fR
1510
 
.RE
1511
 
 
1512
 
afs share (S)
1513
 
.\" afs share
1514
 
.PP
1515
 
.RS 4
1516
 
This parameter controls whether special AFS features are enabled for this share\&. If enabled, it assumes that the directory exported via the
1517
 
\fIpath\fR
1518
 
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\&.
1519
 
.sp
1520
 
Default:
1521
 
\fI\fIafs share\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1522
 
.RE
1523
 
 
1524
 
afs username map (G)
1525
 
.\" afs username map
1526
 
.PP
1527
 
.RS 4
1528
 
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\&.
1529
 
.sp
1530
 
The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token\&.
1531
 
.sp
1532
 
Default:
1533
 
\fI\fIafs username map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1534
 
.sp
1535
 
Example:
1536
 
\fI\fIafs username map\fR\fR\fI = \fR\fI\FC%u@afs\&.samba\&.org\F[]\fR\fI \fR
1537
 
.RE
1538
 
 
1539
 
aio read size (S)
1540
 
.\" aio read size
1541
 
.PP
1542
 
.RS 4
1543
 
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\&.
1544
 
.sp
1545
 
Current implementation of asynchronous I/O in Samba 3\&.0 does support only up to 10 outstanding asynchronous requests, read and write combined\&.
1546
 
.sp
1547
 
Related command:
1548
 
\m[blue]\fBwrite cache size\fR\m[]
1549
 
.sp
1550
 
Related command:
1551
 
\m[blue]\fBaio write size\fR\m[]
1552
 
.sp
1553
 
Default:
1554
 
\fI\fIaio read size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
1555
 
.sp
1556
 
Example:
1557
 
\fI\fIaio read size\fR\fR\fI = \fR\fI\FC16384 # Use asynchronous I/O for reads bigger than 16KB request size\F[]\fR\fI \fR
1558
 
.RE
1559
 
 
1560
 
aio write size (S)
1561
 
.\" aio write size
1562
 
.PP
1563
 
.RS 4
1564
 
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\&.
1565
 
.sp
1566
 
Current implementation of asynchronous I/O in Samba 3\&.0 does support only up to 10 outstanding asynchronous requests, read and write combined\&.
1567
 
.sp
1568
 
Related command:
1569
 
\m[blue]\fBwrite cache size\fR\m[]
1570
 
.sp
1571
 
Related command:
1572
 
\m[blue]\fBaio read size\fR\m[]
1573
 
.sp
1574
 
Default:
1575
 
\fI\fIaio write size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
1576
 
.sp
1577
 
Example:
1578
 
\fI\fIaio write size\fR\fR\fI = \fR\fI\FC16384 # Use asynchronous I/O for writes bigger than 16KB request size\F[]\fR\fI \fR
1579
 
.RE
1580
 
 
1581
 
algorithmic rid base (G)
1582
 
.\" algorithmic rid base
1583
 
.PP
1584
 
.RS 4
1585
 
This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers\&.
1586
 
.sp
1587
 
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\&.
1588
 
.sp
1589
 
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\&.
1590
 
.sp
1591
 
Default:
1592
 
\fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
1593
 
.sp
1594
 
Example:
1595
 
\fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI\FC100000\F[]\fR\fI \fR
1596
 
.RE
1597
 
 
1598
 
allocation roundup size (S)
1599
 
.\" allocation roundup size
1600
 
.PP
1601
 
.RS 4
1602
 
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\&.
1603
 
.sp
1604
 
The integer parameter specifies the roundup size in bytes\&.
1605
 
.sp
1606
 
Default:
1607
 
\fI\fIallocation roundup size\fR\fR\fI = \fR\fI\FC1048576\F[]\fR\fI \fR
1608
 
.sp
1609
 
Example:
1610
 
\fI\fIallocation roundup size\fR\fR\fI = \fR\fI\FC0 # (to disable roundups)\F[]\fR\fI \fR
1611
 
.RE
1612
 
 
1613
 
allow trusted domains (G)
1614
 
.\" allow trusted domains
1615
 
.PP
1616
 
.RS 4
1617
 
This option only takes effect when the
1618
 
\m[blue]\fBsecurity\fR\m[]
1619
 
option is set to
1620
 
\fBserver\fR,
1621
 
\fBdomain\fR
1622
 
or
1623
 
\fBads\fR\&. 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\&.
1624
 
.sp
1625
 
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\&.
1626
 
.sp
1627
 
Default:
1628
 
\fI\fIallow trusted domains\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1629
 
.RE
1630
 
 
1631
 
announce as (G)
1632
 
.\" announce as
1633
 
.PP
1634
 
.RS 4
1635
 
This specifies what type of server
1636
 
\fBnmbd\fR(8)
1637
 
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\&.
1638
 
.sp
1639
 
Default:
1640
 
\fI\fIannounce as\fR\fR\fI = \fR\fI\FCNT Server\F[]\fR\fI \fR
1641
 
.sp
1642
 
Example:
1643
 
\fI\fIannounce as\fR\fR\fI = \fR\fI\FCWin95\F[]\fR\fI \fR
1644
 
.RE
1645
 
 
1646
 
announce version (G)
1647
 
.\" announce version
1648
 
.PP
1649
 
.RS 4
1650
 
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\&.
1651
 
.sp
1652
 
Default:
1653
 
\fI\fIannounce version\fR\fR\fI = \fR\fI\FC4\&.9\F[]\fR\fI \fR
1654
 
.sp
1655
 
Example:
1656
 
\fI\fIannounce version\fR\fR\fI = \fR\fI\FC2\&.0\F[]\fR\fI \fR
1657
 
.RE
1658
 
 
1659
 
auth methods (G)
1660
 
.\" auth methods
1661
 
.PP
1662
 
.RS 4
1663
 
This option allows the administrator to chose what authentication methods
1664
 
\FCsmbd\F[]
1665
 
will use when authenticating a user\&. This option defaults to sensible values based on
1666
 
\m[blue]\fBsecurity\fR\m[]\&. 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\&.
1667
 
.sp
1668
 
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\&.
1669
 
.sp
1670
 
Possible options include
1671
 
\fBguest\fR
1672
 
(anonymous access),
1673
 
\fBsam\fR
1674
 
(lookups in local list of accounts based on netbios name or domain name),
1675
 
\fBwinbind\fR
1676
 
(relay authentication requests for remote users through winbindd),
1677
 
\fBntdomain\fR
1678
 
(pre\-winbindd method of authentication for remote domain users; deprecated in favour of winbind method),
1679
 
\fBtrustdomain\fR
1680
 
(authenticate trusted users by contacting the remote DC directly from smbd; deprecated in favour of winbind method)\&.
1681
 
.sp
1682
 
Default:
1683
 
\fI\fIauth methods\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1684
 
.sp
1685
 
Example:
1686
 
\fI\fIauth methods\fR\fR\fI = \fR\fI\FCguest sam winbind\F[]\fR\fI \fR
1687
 
.RE
1688
 
 
1689
 
available (S)
1690
 
.\" available
1691
 
.PP
1692
 
.RS 4
1693
 
This parameter lets you "turn off" a service\&. If
1694
 
\fIavailable = no\fR, then
1695
 
\fIALL\fR
1696
 
attempts to connect to the service will fail\&. Such failures are logged\&.
1697
 
.sp
1698
 
Default:
1699
 
\fI\fIavailable\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1700
 
.RE
1701
 
 
1702
 
bind interfaces only (G)
1703
 
.\" bind interfaces only
1704
 
.PP
1705
 
.RS 4
1706
 
This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\&. It affects file service
1707
 
\fBsmbd\fR(8)
1708
 
and name service
1709
 
\fBnmbd\fR(8)
1710
 
in a slightly different ways\&.
1711
 
.sp
1712
 
For name service it causes
1713
 
\FCnmbd\F[]
1714
 
to bind to ports 137 and 138 on the interfaces listed in the
1715
 
\m[blue]\fBinterfaces\fR\m[]
1716
 
parameter\&.
1717
 
\FCnmbd\F[]
1718
 
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
1719
 
\FCnmbd\F[]
1720
 
will service name requests on all of these sockets\&. If
1721
 
\m[blue]\fBbind interfaces only\fR\m[]
1722
 
is set then
1723
 
\FCnmbd\F[]
1724
 
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
1725
 
\m[blue]\fBinterfaces\fR\m[]
1726
 
parameter list\&. As unicast packets are received on the other sockets it allows
1727
 
\FCnmbd\F[]
1728
 
to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the
1729
 
\m[blue]\fBinterfaces\fR\m[]
1730
 
list\&. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
1731
 
\FCnmbd\F[]\&.
1732
 
.sp
1733
 
For file service it causes
1734
 
\fBsmbd\fR(8)
1735
 
to bind only to the interface list given in the
1736
 
\m[blue]\fBinterfaces\fR\m[]
1737
 
parameter\&. This restricts the networks that
1738
 
\FCsmbd\F[]
1739
 
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\&.
1740
 
.sp
1741
 
If
1742
 
\m[blue]\fBbind interfaces only\fR\m[]
1743
 
is set and the network address
1744
 
\fI127\&.0\&.0\&.1\fR
1745
 
is not added to the
1746
 
\m[blue]\fBinterfaces\fR\m[]
1747
 
parameter list
1748
 
\fBsmbpasswd\fR(8)
1749
 
and
1750
 
\fBswat\fR(8)
1751
 
may not work as expected due to the reasons covered below\&.
1752
 
.sp
1753
 
To change a users SMB password, the
1754
 
\FCsmbpasswd\F[]
1755
 
by default connects to the
1756
 
\fIlocalhost \- 127\&.0\&.0\&.1\fR
1757
 
address as an SMB client to issue the password change request\&. If
1758
 
\m[blue]\fBbind interfaces only\fR\m[]
1759
 
is set then unless the network address
1760
 
\fI127\&.0\&.0\&.1\fR
1761
 
is added to the
1762
 
\m[blue]\fBinterfaces\fR\m[]
1763
 
parameter list then
1764
 
\FC smbpasswd\F[]
1765
 
will fail to connect in it\'s default mode\&.
1766
 
\FCsmbpasswd\F[]
1767
 
can be forced to use the primary IP interface of the local host by using its
1768
 
\fBsmbpasswd\fR(8)
1769
 
\fI\-r \fR\fI\fIremote machine\fR\fR
1770
 
parameter, with
1771
 
\fIremote machine\fR
1772
 
set to the IP name of the primary interface of the local host\&.
1773
 
.sp
1774
 
The
1775
 
\FCswat\F[]
1776
 
status page tries to connect with
1777
 
\FCsmbd\F[]
1778
 
and
1779
 
\FCnmbd\F[]
1780
 
at the address
1781
 
\fI127\&.0\&.0\&.1\fR
1782
 
to determine if they are running\&. Not adding
1783
 
\fI127\&.0\&.0\&.1\fR
1784
 
will cause
1785
 
\FC smbd\F[]
1786
 
and
1787
 
\FCnmbd\F[]
1788
 
to always show "not running" even if they really are\&. This can prevent
1789
 
\FC swat\F[]
1790
 
from starting/stopping/restarting
1791
 
\FCsmbd\F[]
1792
 
and
1793
 
\FCnmbd\F[]\&.
1794
 
.sp
1795
 
Default:
1796
 
\fI\fIbind interfaces only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1797
 
.RE
1798
 
 
1799
 
blocking locks (S)
1800
 
.\" blocking locks
1801
 
.PP
1802
 
.RS 4
1803
 
This parameter controls the behavior of
1804
 
\fBsmbd\fR(8)
1805
 
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\&.
1806
 
.sp
1807
 
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\&.
1808
 
.sp
1809
 
If this parameter is set to
1810
 
\fBno\fR, then samba will behave as previous versions of Samba would and will fail the lock request immediately if the lock range cannot be obtained\&.
1811
 
.sp
1812
 
Default:
1813
 
\fI\fIblocking locks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1814
 
.RE
1815
 
 
1816
 
block size (S)
1817
 
.\" block size
1818
 
.PP
1819
 
.RS 4
1820
 
This parameter controls the behavior of
1821
 
\fBsmbd\fR(8)
1822
 
when reporting disk free sizes\&. By default, this reports a disk block size of 1024 bytes\&.
1823
 
.sp
1824
 
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\&.
1825
 
.sp
1826
 
Changing this option does not change the disk free reporting size, just the block size unit reported to the client\&.
1827
 
.sp
1828
 
Default:
1829
 
\fI\fIblock size\fR\fR\fI = \fR\fI\FC1024\F[]\fR\fI \fR
1830
 
.sp
1831
 
Example:
1832
 
\fI\fIblock size\fR\fR\fI = \fR\fI\FC4096\F[]\fR\fI \fR
1833
 
.RE
1834
 
 
1835
 
browsable
1836
 
.\" browsable
1837
 
.PP
1838
 
.RS 4
1839
 
This parameter is a synonym for
1840
 
browseable\&.
1841
 
.RE
1842
 
 
1843
 
browseable (S)
1844
 
.\" browseable
1845
 
.PP
1846
 
.RS 4
1847
 
This controls whether this share is seen in the list of available shares in a net view and in the browse list\&.
1848
 
.sp
1849
 
Default:
1850
 
\fI\fIbrowseable\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1851
 
.RE
1852
 
 
1853
 
browse list (G)
1854
 
.\" browse list
1855
 
.PP
1856
 
.RS 4
1857
 
This controls whether
1858
 
\fBsmbd\fR(8)
1859
 
will serve a browse list to a client doing a
1860
 
\FCNetServerEnum\F[]
1861
 
call\&. Normally set to
1862
 
\fByes\fR\&. You should never need to change this\&.
1863
 
.sp
1864
 
Default:
1865
 
\fI\fIbrowse list\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1866
 
.RE
1867
 
 
1868
 
casesignames
1869
 
.\" casesignames
1870
 
.PP
1871
 
.RS 4
1872
 
This parameter is a synonym for
1873
 
case sensitive\&.
1874
 
.RE
1875
 
 
1876
 
case sensitive (S)
1877
 
.\" case sensitive
1878
 
.PP
1879
 
.RS 4
1880
 
See the discussion in the section
1881
 
\m[blue]\fBname mangling\fR\m[]\&.
1882
 
.sp
1883
 
Default:
1884
 
\fI\fIcase sensitive\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
1885
 
.RE
1886
 
 
1887
 
change notify (S)
1888
 
.\" change notify
1889
 
.PP
1890
 
.RS 4
1891
 
This parameter specifies whether Samba should reply to a client\'s file change notify requests\&.
1892
 
.sp
1893
 
You should never need to change this parameter
1894
 
.sp
1895
 
Default:
1896
 
\fI\fIchange notify\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
1897
 
.RE
1898
 
 
1899
 
change share command (G)
1900
 
.\" change share command
1901
 
.PP
1902
 
.RS 4
1903
 
Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
1904
 
\fIchange share command\fR
1905
 
is used to define an external program or script which will modify an existing service definition in
1906
 
\FCsmb\&.conf\F[]\&.
1907
 
.sp
1908
 
In order to successfully execute the
1909
 
\fIchange share command\fR,
1910
 
\FCsmbd\F[]
1911
 
requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
1912
 
\FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
1913
 
\fIchange share command\fR
1914
 
parameter are executed as root\&.
1915
 
.sp
1916
 
When executed,
1917
 
\FCsmbd\F[]
1918
 
will automatically invoke the
1919
 
\fIchange share command\fR
1920
 
with five parameters\&.
1921
 
.sp
1922
 
.RS 4
1923
 
.ie n \{\
1924
 
\h'-04'\(bu\h'+03'\c
1925
 
.\}
1926
 
.el \{\
1927
 
.sp -1
1928
 
.IP \(bu 2.3
1929
 
.\}
1930
 
\fIconfigFile\fR
1931
 
\- the location of the global
1932
 
\FCsmb\&.conf\F[]
1933
 
file\&.
1934
 
.RE
1935
 
.sp
1936
 
.RS 4
1937
 
.ie n \{\
1938
 
\h'-04'\(bu\h'+03'\c
1939
 
.\}
1940
 
.el \{\
1941
 
.sp -1
1942
 
.IP \(bu 2.3
1943
 
.\}
1944
 
\fIshareName\fR
1945
 
\- the name of the new share\&.
1946
 
.RE
1947
 
.sp
1948
 
.RS 4
1949
 
.ie n \{\
1950
 
\h'-04'\(bu\h'+03'\c
1951
 
.\}
1952
 
.el \{\
1953
 
.sp -1
1954
 
.IP \(bu 2.3
1955
 
.\}
1956
 
\fIpathName\fR
1957
 
\- path to an **existing** directory on disk\&.
1958
 
.RE
1959
 
.sp
1960
 
.RS 4
1961
 
.ie n \{\
1962
 
\h'-04'\(bu\h'+03'\c
1963
 
.\}
1964
 
.el \{\
1965
 
.sp -1
1966
 
.IP \(bu 2.3
1967
 
.\}
1968
 
\fIcomment\fR
1969
 
\- comment string to associate with the new share\&.
1970
 
.RE
1971
 
.sp
1972
 
.RS 4
1973
 
.ie n \{\
1974
 
\h'-04'\(bu\h'+03'\c
1975
 
.\}
1976
 
.el \{\
1977
 
.sp -1
1978
 
.IP \(bu 2.3
1979
 
.\}
1980
 
\fImax connections\fR
1981
 
Number of maximum simultaneous connections to this share\&.
1982
 
.sp
1983
 
.RE
1984
 
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\&.
1985
 
.sp
1986
 
Default:
1987
 
\fI\fIchange share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
1988
 
.sp
1989
 
Example:
1990
 
\fI\fIchange share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/changeshare\F[]\fR\fI \fR
1991
 
.RE
1992
 
 
1993
 
check password script (G)
1994
 
.\" check password script
1995
 
.PP
1996
 
.RS 4
1997
 
The name of a program that can be used to check password complexity\&. The password is sent to the program\'s standard input\&.
1998
 
.sp
1999
 
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\&.
2000
 
.sp
2001
 
Note: In the example directory is a sample program called
2002
 
\FCcrackcheck\F[]
2003
 
that uses cracklib to check the password quality\&.
2004
 
.sp
2005
 
Default:
2006
 
\fI\fIcheck password script\fR\fR\fI = \fR\fI\FCDisabled\F[]\fR\fI \fR
2007
 
.sp
2008
 
Example:
2009
 
\fI\fIcheck password script\fR\fR\fI = \fR\fI\FC/usr/local/sbin/crackcheck\F[]\fR\fI \fR
2010
 
.RE
2011
 
 
2012
 
client lanman auth (G)
2013
 
.\" client lanman auth
2014
 
.PP
2015
 
.RS 4
2016
 
This parameter determines whether or not
2017
 
\fBsmbclient\fR(8)
2018
 
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\&.
2019
 
.sp
2020
 
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\&.
2021
 
.sp
2022
 
Disabling this option will also disable the
2023
 
\FCclient plaintext auth\F[]
2024
 
option\&.
2025
 
.sp
2026
 
Likewise, if the
2027
 
\FCclient ntlmv2 auth\F[]
2028
 
parameter is enabled, then only NTLMv2 logins will be attempted\&.
2029
 
.sp
2030
 
Default:
2031
 
\fI\fIclient lanman auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2032
 
.RE
2033
 
 
2034
 
client ldap sasl wrapping (G)
2035
 
.\" client ldap sasl wrapping
2036
 
.PP
2037
 
.RS 4
2038
 
The
2039
 
\m[blue]\fBclient ldap sasl wrapping\fR\m[]
2040
 
defines whether ldap traffic will be signed or signed and encrypted (sealed)\&. Possible values are
2041
 
\fIplain\fR,
2042
 
\fIsign\fR
2043
 
and
2044
 
\fIseal\fR\&.
2045
 
.sp
2046
 
The values
2047
 
\fIsign\fR
2048
 
and
2049
 
\fIseal\fR
2050
 
are only available if Samba has been compiled against a modern OpenLDAP version (2\&.3\&.x or higher)\&.
2051
 
.sp
2052
 
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 "\FCHKLM\eSystem\eCurrentControlSet\eServices\e\F[]
2053
 
\FCNTDS\eParameters\eLDAPServerIntegrity\F[]" on the Windows server side\&.
2054
 
.sp
2055
 
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,
2056
 
\fIsign\fR
2057
 
is just an alias for
2058
 
\fIseal\fR\&.
2059
 
.sp
2060
 
The default value is
2061
 
\fIplain\fR
2062
 
which is not irritable to KRB5 clock skew errors\&. That implies synchronizing the time with the KDC in the case of using
2063
 
\fIsign\fR
2064
 
or
2065
 
\fIseal\fR\&.
2066
 
.sp
2067
 
Default:
2068
 
\fI\fIclient ldap sasl wrapping\fR\fR\fI = \fR\fI\FCplain\F[]\fR\fI \fR
2069
 
.RE
2070
 
 
2071
 
client ntlmv2 auth (G)
2072
 
.\" client ntlmv2 auth
2073
 
.PP
2074
 
.RS 4
2075
 
This parameter determines whether or not
2076
 
\fBsmbclient\fR(8)
2077
 
will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\&.
2078
 
.sp
2079
 
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\&.
2080
 
.sp
2081
 
Similarly, if enabled, NTLMv1,
2082
 
\FCclient lanman auth\F[]
2083
 
and
2084
 
\FCclient plaintext auth\F[]
2085
 
authentication will be disabled\&. This also disables share\-level authentication\&.
2086
 
.sp
2087
 
If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of
2088
 
\FCclient lanman auth\F[]\&.
2089
 
.sp
2090
 
Note that some sites (particularly those following \'best practice\' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM\&.
2091
 
.sp
2092
 
Default:
2093
 
\fI\fIclient ntlmv2 auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2094
 
.RE
2095
 
 
2096
 
client plaintext auth (G)
2097
 
.\" client plaintext auth
2098
 
.PP
2099
 
.RS 4
2100
 
Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\&.
2101
 
.sp
2102
 
Default:
2103
 
\fI\fIclient plaintext auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2104
 
.RE
2105
 
 
2106
 
client schannel (G)
2107
 
.\" client schannel
2108
 
.PP
2109
 
.RS 4
2110
 
This controls whether the client offers or even demands the use of the netlogon schannel\&.
2111
 
\m[blue]\fBclient schannel = no\fR\m[]
2112
 
does not offer the schannel,
2113
 
\m[blue]\fBclient schannel = auto\fR\m[]
2114
 
offers the schannel but does not enforce it, and
2115
 
\m[blue]\fBclient schannel = yes\fR\m[]
2116
 
denies access if the server is not able to speak netlogon schannel\&.
2117
 
.sp
2118
 
Default:
2119
 
\fI\fIclient schannel\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
2120
 
.sp
2121
 
Example:
2122
 
\fI\fIclient schannel\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
2123
 
.RE
2124
 
 
2125
 
client signing (G)
2126
 
.\" client signing
2127
 
.PP
2128
 
.RS 4
2129
 
This controls whether the client is allowed or required to use SMB signing\&. Possible values are
2130
 
\fIauto\fR,
2131
 
\fImandatory\fR
2132
 
and
2133
 
\fIdisabled\fR\&.
2134
 
.sp
2135
 
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\&.
2136
 
.sp
2137
 
Default:
2138
 
\fI\fIclient signing\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
2139
 
.RE
2140
 
 
2141
 
client use spnego (G)
2142
 
.\" client use spnego
2143
 
.PP
2144
 
.RS 4
2145
 
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\&.
2146
 
.sp
2147
 
Default:
2148
 
\fI\fIclient use spnego\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
2149
 
.RE
2150
 
 
2151
 
cluster addresses (G)
2152
 
.\" cluster addresses
2153
 
.PP
2154
 
.RS 4
2155
 
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\&.
2156
 
.sp
2157
 
Default:
2158
 
\fI\fIcluster addresses\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2159
 
.sp
2160
 
Example:
2161
 
\fI\fIcluster addresses\fR\fR\fI = \fR\fI\FC10\&.0\&.0\&.1 10\&.0\&.0\&.2 10\&.0\&.0\&.3\F[]\fR\fI \fR
2162
 
.RE
2163
 
 
2164
 
clustering (G)
2165
 
.\" clustering
2166
 
.PP
2167
 
.RS 4
2168
 
This parameter specifies whether Samba should contact ctdb for accessing its tdb files and use ctdb as a backend for its messaging backend\&.
2169
 
.sp
2170
 
Set this parameter to
2171
 
\FCyes\F[]
2172
 
only if you have a cluster setup with ctdb running\&.
2173
 
.sp
2174
 
Default:
2175
 
\fI\fIclustering\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2176
 
.RE
2177
 
 
2178
 
comment (S)
2179
 
.\" comment
2180
 
.PP
2181
 
.RS 4
2182
 
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
2183
 
\FCnet view\F[]
2184
 
to list what shares are available\&.
2185
 
.sp
2186
 
If you want to set the string that is displayed next to the machine name then see the
2187
 
\m[blue]\fBserver string\fR\m[]
2188
 
parameter\&.
2189
 
.sp
2190
 
Default:
2191
 
\fI\fIcomment\fR\fR\fI = \fR\fI\FC # No comment\F[]\fR\fI \fR
2192
 
.sp
2193
 
Example:
2194
 
\fI\fIcomment\fR\fR\fI = \fR\fI\FCFred\'s Files\F[]\fR\fI \fR
2195
 
.RE
2196
 
 
2197
 
config backend (G)
2198
 
.\" config backend
2199
 
.PP
2200
 
.RS 4
2201
 
This controls the backend for storing the configuration\&. Possible values are
2202
 
\fIfile\fR
2203
 
(the default) and
2204
 
\fIregistry\fR\&. When
2205
 
\m[blue]\fBconfig backend = registry\fR\m[]
2206
 
is encountered while loading
2207
 
\fIsmb\&.conf\fR, 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
2208
 
\fIregistry shares\fR
2209
 
is set to
2210
 
\fIyes\fR\&.
2211
 
.sp
2212
 
Note: This option can not be set inside the registry configuration itself\&.
2213
 
.sp
2214
 
Default:
2215
 
\fI\fIconfig backend\fR\fR\fI = \fR\fI\FCfile\F[]\fR\fI \fR
2216
 
.sp
2217
 
Example:
2218
 
\fI\fIconfig backend\fR\fR\fI = \fR\fI\FCregistry\F[]\fR\fI \fR
2219
 
.RE
2220
 
 
2221
 
config file (G)
2222
 
.\" config file
2223
 
.PP
2224
 
.RS 4
2225
 
This allows you to override the config file to use, instead of the default (usually
2226
 
\FCsmb\&.conf\F[])\&. There is a chicken and egg problem here as this option is set in the config file!
2227
 
.sp
2228
 
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\&.
2229
 
.sp
2230
 
This option takes the usual substitutions, which can be very useful\&.
2231
 
.sp
2232
 
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)\&.
2233
 
.sp
2234
 
\fINo default\fR
2235
 
.sp
2236
 
Example:
2237
 
\fI\fIconfig file\fR\fR\fI = \fR\fI\FC/usr/local/samba/lib/smb\&.conf\&.%m\F[]\fR\fI \fR
2238
 
.RE
2239
 
 
2240
 
copy (S)
2241
 
.\" copy
2242
 
.PP
2243
 
.RS 4
2244
 
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\&.
2245
 
.sp
2246
 
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\&.
2247
 
.sp
2248
 
Default:
2249
 
\fI\fIcopy\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2250
 
.sp
2251
 
Example:
2252
 
\fI\fIcopy\fR\fR\fI = \fR\fI\FCotherservice\F[]\fR\fI \fR
2253
 
.RE
2254
 
 
2255
 
create mode
2256
 
.\" create mode
2257
 
.PP
2258
 
.RS 4
2259
 
This parameter is a synonym for
2260
 
create mask\&.
2261
 
.RE
2262
 
 
2263
 
create mask (S)
2264
 
.\" create mask
2265
 
.PP
2266
 
.RS 4
2267
 
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
2268
 
\fInot\fR
2269
 
set here will be removed from the modes set on a file when it is created\&.
2270
 
.sp
2271
 
The default value of this parameter removes the
2272
 
\FCgroup\F[]
2273
 
and
2274
 
\FCother\F[]
2275
 
write and execute bits from the UNIX modes\&.
2276
 
.sp
2277
 
Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the
2278
 
\m[blue]\fBforce create mode\fR\m[]
2279
 
parameter which is set to 000 by default\&.
2280
 
.sp
2281
 
This parameter does not affect directory masks\&. See the parameter
2282
 
\m[blue]\fBdirectory mask\fR\m[]
2283
 
for details\&.
2284
 
.sp
2285
 
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
2286
 
\m[blue]\fBsecurity mask\fR\m[]\&.
2287
 
.sp
2288
 
Default:
2289
 
\fI\fIcreate mask\fR\fR\fI = \fR\fI\FC0744\F[]\fR\fI \fR
2290
 
.sp
2291
 
Example:
2292
 
\fI\fIcreate mask\fR\fR\fI = \fR\fI\FC0775\F[]\fR\fI \fR
2293
 
.RE
2294
 
 
2295
 
csc policy (S)
2296
 
.\" csc policy
2297
 
.PP
2298
 
.RS 4
2299
 
This stands for
2300
 
\fIclient\-side caching policy\fR, and specifies how clients capable of offline caching will cache the files in the share\&. The valid values are: manual, documents, programs, disable\&.
2301
 
.sp
2302
 
These values correspond to those used on Windows servers\&.
2303
 
.sp
2304
 
For example, shares containing roaming profiles can have offline caching disabled using
2305
 
\m[blue]\fBcsc policy = disable\fR\m[]\&.
2306
 
.sp
2307
 
Default:
2308
 
\fI\fIcsc policy\fR\fR\fI = \fR\fI\FCmanual\F[]\fR\fI \fR
2309
 
.sp
2310
 
Example:
2311
 
\fI\fIcsc policy\fR\fR\fI = \fR\fI\FCprograms\F[]\fR\fI \fR
2312
 
.RE
2313
 
 
2314
 
ctdbd socket (G)
2315
 
.\" ctdbd socket
2316
 
.PP
2317
 
.RS 4
2318
 
If you set
2319
 
\FCclustering=yes\F[], 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\&.
2320
 
.sp
2321
 
Default:
2322
 
\fI\fIctdbd socket\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2323
 
.sp
2324
 
Example:
2325
 
\fI\fIctdbd socket\fR\fR\fI = \fR\fI\FC/tmp/ctdb\&.socket\F[]\fR\fI \fR
2326
 
.RE
2327
 
 
2328
 
cups connection timeout (G)
2329
 
.\" cups connection timeout
2330
 
.PP
2331
 
.RS 4
2332
 
This parameter is only applicable if
2333
 
\m[blue]\fBprinting\fR\m[]
2334
 
is set to
2335
 
\fBcups\fR\&.
2336
 
.sp
2337
 
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\&.
2338
 
.sp
2339
 
Default:
2340
 
\fI\fIcups connection timeout\fR\fR\fI = \fR\fI\FC30\F[]\fR\fI \fR
2341
 
.sp
2342
 
Example:
2343
 
\fI\fIcups connection timeout\fR\fR\fI = \fR\fI\FC60\F[]\fR\fI \fR
2344
 
.RE
2345
 
 
2346
 
cups options (S)
2347
 
.\" cups options
2348
 
.PP
2349
 
.RS 4
2350
 
This parameter is only applicable if
2351
 
\m[blue]\fBprinting\fR\m[]
2352
 
is set to
2353
 
\fBcups\fR\&. Its value is a free form string of options passed directly to the cups library\&.
2354
 
.sp
2355
 
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\&.
2356
 
.sp
2357
 
You should set this parameter to
2358
 
\fBraw\fR
2359
 
if your CUPS server
2360
 
\FCerror_log\F[]
2361
 
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
2362
 
\FC/etc/cups/mime\&.{convs,types}\F[]\&.
2363
 
.sp
2364
 
Default:
2365
 
\fI\fIcups options\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
2366
 
.sp
2367
 
Example:
2368
 
\fI\fIcups options\fR\fR\fI = \fR\fI\FC"raw media=a4"\F[]\fR\fI \fR
2369
 
.RE
2370
 
 
2371
 
cups server (G)
2372
 
.\" cups server
2373
 
.PP
2374
 
.RS 4
2375
 
This parameter is only applicable if
2376
 
\m[blue]\fBprinting\fR\m[]
2377
 
is set to
2378
 
\fBcups\fR\&.
2379
 
.sp
2380
 
If set, this option overrides the ServerName option in the CUPS
2381
 
\FCclient\&.conf\F[]\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
2382
 
.sp
2383
 
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\&.
2384
 
.sp
2385
 
Default:
2386
 
\fI\fIcups server\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
2387
 
.sp
2388
 
Example:
2389
 
\fI\fIcups server\fR\fR\fI = \fR\fI\FCmycupsserver\F[]\fR\fI \fR
2390
 
.sp
2391
 
Example:
2392
 
\fI\fIcups server\fR\fR\fI = \fR\fI\FCmycupsserver:1631\F[]\fR\fI \fR
2393
 
.RE
2394
 
 
2395
 
deadtime (G)
2396
 
.\" deadtime
2397
 
.PP
2398
 
.RS 4
2399
 
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\&.
2400
 
.sp
2401
 
This is useful to stop a server\'s resources being exhausted by a large number of inactive connections\&.
2402
 
.sp
2403
 
Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\&.
2404
 
.sp
2405
 
Using this parameter with a timeout of a few minutes is recommended for most systems\&.
2406
 
.sp
2407
 
A deadtime of zero indicates that no auto\-disconnection should be performed\&.
2408
 
.sp
2409
 
Default:
2410
 
\fI\fIdeadtime\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
2411
 
.sp
2412
 
Example:
2413
 
\fI\fIdeadtime\fR\fR\fI = \fR\fI\FC15\F[]\fR\fI \fR
2414
 
.RE
2415
 
 
2416
 
debug class (G)
2417
 
.\" debug class
2418
 
.PP
2419
 
.RS 4
2420
 
With this boolean parameter enabled, the debug class (DBGC_CLASS) will be displayed in the debug header\&.
2421
 
.sp
2422
 
For more information about currently available debug classes, see section about
2423
 
\m[blue]\fBlog level\fR\m[]\&.
2424
 
.sp
2425
 
Default:
2426
 
\fI\fIdebug class\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2427
 
.RE
2428
 
 
2429
 
debug hires timestamp (G)
2430
 
.\" debug hires timestamp
2431
 
.PP
2432
 
.RS 4
2433
 
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\&.
2434
 
.sp
2435
 
Note that the parameter
2436
 
\m[blue]\fBdebug timestamp\fR\m[]
2437
 
must be on for this to have an effect\&.
2438
 
.sp
2439
 
Default:
2440
 
\fI\fIdebug hires timestamp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2441
 
.RE
2442
 
 
2443
 
debug pid (G)
2444
 
.\" debug pid
2445
 
.PP
2446
 
.RS 4
2447
 
When using only one log file for more then one forked
2448
 
\fBsmbd\fR(8)\-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\&.
2449
 
.sp
2450
 
Note that the parameter
2451
 
\m[blue]\fBdebug timestamp\fR\m[]
2452
 
must be on for this to have an effect\&.
2453
 
.sp
2454
 
Default:
2455
 
\fI\fIdebug pid\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2456
 
.RE
2457
 
 
2458
 
debug prefix timestamp (G)
2459
 
.\" debug prefix timestamp
2460
 
.PP
2461
 
.RS 4
2462
 
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
2463
 
\m[blue]\fBdebug timestamp\fR\m[]
2464
 
parameter\&. This gives timestamps to the messages without adding an additional line\&.
2465
 
.sp
2466
 
Note that this parameter overrides the
2467
 
\m[blue]\fBdebug timestamp\fR\m[]
2468
 
parameter\&.
2469
 
.sp
2470
 
Default:
2471
 
\fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2472
 
.RE
2473
 
 
2474
 
timestamp logs
2475
 
.\" timestamp logs
2476
 
.PP
2477
 
.RS 4
2478
 
This parameter is a synonym for
2479
 
debug timestamp\&.
2480
 
.RE
2481
 
 
2482
 
debug timestamp (G)
2483
 
.\" debug timestamp
2484
 
.PP
2485
 
.RS 4
2486
 
Samba debug log messages are timestamped by default\&. If you are running at a high
2487
 
\m[blue]\fBdebug level\fR\m[]
2488
 
these timestamps can be distracting\&. This boolean parameter allows timestamping to be turned off\&.
2489
 
.sp
2490
 
Default:
2491
 
\fI\fIdebug timestamp\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
2492
 
.RE
2493
 
 
2494
 
debug uid (G)
2495
 
.\" debug uid
2496
 
.PP
2497
 
.RS 4
2498
 
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\&.
2499
 
.sp
2500
 
Note that the parameter
2501
 
\m[blue]\fBdebug timestamp\fR\m[]
2502
 
must be on for this to have an effect\&.
2503
 
.sp
2504
 
Default:
2505
 
\fI\fIdebug uid\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2506
 
.RE
2507
 
 
2508
 
dedicated keytab file (G)
2509
 
.\" dedicated keytab file
2510
 
.PP
2511
 
.RS 4
2512
 
Specifies the path to the kerberos keytab file when
2513
 
\m[blue]\fBkerberos method\fR\m[]
2514
 
is set to "dedicated keytab"\&.
2515
 
.sp
2516
 
Default:
2517
 
\fI\fIdedicated keytab file\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2518
 
.sp
2519
 
Example:
2520
 
\fI\fIdedicated keytab file\fR\fR\fI = \fR\fI\FC/usr/local/etc/krb5\&.keytab\F[]\fR\fI \fR
2521
 
.RE
2522
 
 
2523
 
default case (S)
2524
 
.\" default case
2525
 
.PP
2526
 
.RS 4
2527
 
See the section on
2528
 
\m[blue]\fBname mangling\fR\m[]\&. Also note the
2529
 
\m[blue]\fBshort preserve case\fR\m[]
2530
 
parameter\&.
2531
 
.sp
2532
 
Default:
2533
 
\fI\fIdefault case\fR\fR\fI = \fR\fI\FClower\F[]\fR\fI \fR
2534
 
.RE
2535
 
 
2536
 
default devmode (S)
2537
 
.\" default devmode
2538
 
.PP
2539
 
.RS 4
2540
 
This parameter is only applicable to
2541
 
\m[blue]\fBprintable\fR\m[]
2542
 
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\&.
2543
 
.sp
2544
 
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)\&.
2545
 
.sp
2546
 
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
2547
 
\FCdefault devmode = yes\F[]
2548
 
will instruct smbd to generate a default one\&.
2549
 
.sp
2550
 
For more information on Windows NT/2k printing and Device Modes, see the
2551
 
MSDN documentation\&.
2552
 
.sp
2553
 
Default:
2554
 
\fI\fIdefault devmode\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
2555
 
.RE
2556
 
 
2557
 
default
2558
 
.\" default
2559
 
.PP
2560
 
.RS 4
2561
 
This parameter is a synonym for
2562
 
default service\&.
2563
 
.RE
2564
 
 
2565
 
default service (G)
2566
 
.\" default service
2567
 
.PP
2568
 
.RS 4
2569
 
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
2570
 
\fINOT\fR
2571
 
given in the parameter value (see example below)\&.
2572
 
.sp
2573
 
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\&.
2574
 
.sp
2575
 
Typically the default service would be a
2576
 
\m[blue]\fBguest ok\fR\m[],
2577
 
\m[blue]\fBread\-only\fR\m[]
2578
 
service\&.
2579
 
.sp
2580
 
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
2581
 
\fI%S\fR
2582
 
to make a wildcard service\&.
2583
 
.sp
2584
 
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\&.
2585
 
.sp
2586
 
Default:
2587
 
\fI\fIdefault service\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2588
 
.sp
2589
 
Example:
2590
 
\fI\fIdefault service\fR\fR\fI = \fR\fI\FCpub\F[]\fR\fI \fR
2591
 
.RE
2592
 
 
2593
 
defer sharing violations (G)
2594
 
.\" defer sharing violations
2595
 
.PP
2596
 
.RS 4
2597
 
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\&.
2598
 
.sp
2599
 
UNIX by default does not have this behaviour\&.
2600
 
.sp
2601
 
There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\&.
2602
 
.sp
2603
 
Default:
2604
 
\fI\fIdefer sharing violations\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
2605
 
.RE
2606
 
 
2607
 
delete group script (G)
2608
 
.\" delete group script
2609
 
.PP
2610
 
.RS 4
2611
 
This is the full pathname to a script that will be run
2612
 
\fIAS ROOT\fR
2613
 
\fBsmbd\fR(8)
2614
 
when a group is requested to be deleted\&. It will expand any
2615
 
\fI%g\fR
2616
 
to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&.
2617
 
.sp
2618
 
Default:
2619
 
\fI\fIdelete group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2620
 
.RE
2621
 
 
2622
 
deleteprinter command (G)
2623
 
.\" deleteprinter command
2624
 
.PP
2625
 
.RS 4
2626
 
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\&.
2627
 
.sp
2628
 
For a Samba host this means that the printer must be physically deleted from the underlying printing system\&. The
2629
 
\m[blue]\fBdeleteprinter command\fR\m[]
2630
 
defines a script to be run which will perform the necessary operations for removing the printer from the print system and from
2631
 
\FCsmb\&.conf\F[]\&.
2632
 
.sp
2633
 
The
2634
 
\m[blue]\fBdeleteprinter command\fR\m[]
2635
 
is automatically called with only one parameter:
2636
 
\m[blue]\fBprinter name\fR\m[]\&.
2637
 
.sp
2638
 
Once the
2639
 
\m[blue]\fBdeleteprinter command\fR\m[]
2640
 
has been executed,
2641
 
\FCsmbd\F[]
2642
 
will reparse the
2643
 
\FC smb\&.conf\F[]
2644
 
to check that the associated printer no longer exists\&. If the sharename is still valid, then
2645
 
\FCsmbd \F[]
2646
 
will return an ACCESS_DENIED error to the client\&.
2647
 
.sp
2648
 
Default:
2649
 
\fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2650
 
.sp
2651
 
Example:
2652
 
\fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\FC/usr/bin/removeprinter\F[]\fR\fI \fR
2653
 
.RE
2654
 
 
2655
 
delete readonly (S)
2656
 
.\" delete readonly
2657
 
.PP
2658
 
.RS 4
2659
 
This parameter allows readonly files to be deleted\&. This is not normal DOS semantics, but is allowed by UNIX\&.
2660
 
.sp
2661
 
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\&.
2662
 
.sp
2663
 
Default:
2664
 
\fI\fIdelete readonly\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2665
 
.RE
2666
 
 
2667
 
delete share command (G)
2668
 
.\" delete share command
2669
 
.PP
2670
 
.RS 4
2671
 
Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
2672
 
\fIdelete share command\fR
2673
 
is used to define an external program or script which will remove an existing service definition from
2674
 
\FCsmb\&.conf\F[]\&.
2675
 
.sp
2676
 
In order to successfully execute the
2677
 
\fIdelete share command\fR,
2678
 
\FCsmbd\F[]
2679
 
requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
2680
 
\FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
2681
 
\fIdelete share command\fR
2682
 
parameter are executed as root\&.
2683
 
.sp
2684
 
When executed,
2685
 
\FCsmbd\F[]
2686
 
will automatically invoke the
2687
 
\fIdelete share command\fR
2688
 
with two parameters\&.
2689
 
.sp
2690
 
.RS 4
2691
 
.ie n \{\
2692
 
\h'-04'\(bu\h'+03'\c
2693
 
.\}
2694
 
.el \{\
2695
 
.sp -1
2696
 
.IP \(bu 2.3
2697
 
.\}
2698
 
\fIconfigFile\fR
2699
 
\- the location of the global
2700
 
\FCsmb\&.conf\F[]
2701
 
file\&.
2702
 
.RE
2703
 
.sp
2704
 
.RS 4
2705
 
.ie n \{\
2706
 
\h'-04'\(bu\h'+03'\c
2707
 
.\}
2708
 
.el \{\
2709
 
.sp -1
2710
 
.IP \(bu 2.3
2711
 
.\}
2712
 
\fIshareName\fR
2713
 
\- the name of the existing service\&.
2714
 
.sp
2715
 
.RE
2716
 
This parameter is only used to remove file shares\&. To delete printer shares, see the
2717
 
\m[blue]\fBdeleteprinter command\fR\m[]\&.
2718
 
.sp
2719
 
Default:
2720
 
\fI\fIdelete share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2721
 
.sp
2722
 
Example:
2723
 
\fI\fIdelete share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/delshare\F[]\fR\fI \fR
2724
 
.RE
2725
 
 
2726
 
delete user from group script (G)
2727
 
.\" delete user from group script
2728
 
.PP
2729
 
.RS 4
2730
 
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
2731
 
\fBsmbd\fR(8)
2732
 
\fIAS ROOT\fR\&. Any
2733
 
\fI%g\fR
2734
 
will be replaced with the group name and any
2735
 
\fI%u\fR
2736
 
will be replaced with the user name\&.
2737
 
.sp
2738
 
Default:
2739
 
\fI\fIdelete user from group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2740
 
.sp
2741
 
Example:
2742
 
\fI\fIdelete user from group script\fR\fR\fI = \fR\fI\FC/usr/sbin/deluser %u %g\F[]\fR\fI \fR
2743
 
.RE
2744
 
 
2745
 
delete user script (G)
2746
 
.\" delete user script
2747
 
.PP
2748
 
.RS 4
2749
 
This is the full pathname to a script that will be run by
2750
 
\fBsmbd\fR(8)
2751
 
when managing users with remote RPC (NT) tools\&.
2752
 
.sp
2753
 
This script is called when a remote client removes a user from the server, normally using \'User Manager for Domains\' or
2754
 
\FCrpcclient\F[]\&.
2755
 
.sp
2756
 
This script should delete the given UNIX username\&.
2757
 
.sp
2758
 
Default:
2759
 
\fI\fIdelete user script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
2760
 
.sp
2761
 
Example:
2762
 
\fI\fIdelete user script\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/del_user %u\F[]\fR\fI \fR
2763
 
.RE
2764
 
 
2765
 
delete veto files (S)
2766
 
.\" delete veto files
2767
 
.PP
2768
 
.RS 4
2769
 
This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories (see the
2770
 
\m[blue]\fBveto files\fR\m[]
2771
 
option)\&. If this option is set to
2772
 
\fBno\fR
2773
 
(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\&.
2774
 
.sp
2775
 
If this option is set to
2776
 
\fByes\fR, 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\&.
2777
 
\FC\&.AppleDouble\F[])
2778
 
.sp
2779
 
Setting
2780
 
\m[blue]\fBdelete veto files = yes\fR\m[]
2781
 
allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\&.
2782
 
.sp
2783
 
Default:
2784
 
\fI\fIdelete veto files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2785
 
.RE
2786
 
 
2787
 
dfree cache time (S)
2788
 
.\" dfree cache time
2789
 
.PP
2790
 
.RS 4
2791
 
The
2792
 
\fIdfree cache time\fR
2793
 
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\&.
2794
 
.sp
2795
 
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
2796
 
\m[blue]\fBdfree command\fR\m[]
2797
 
scripts increasing the load\&.
2798
 
.sp
2799
 
By default this parameter is zero, meaning no caching will be done\&.
2800
 
.sp
2801
 
\fINo default\fR
2802
 
.sp
2803
 
Example:
2804
 
\fI\fIdfree cache time\fR\fR\fI = \fR\fI\FCdfree cache time = 60\F[]\fR\fI \fR
2805
 
.RE
2806
 
 
2807
 
dfree command (S)
2808
 
.\" dfree command
2809
 
.PP
2810
 
.RS 4
2811
 
The
2812
 
\fIdfree command\fR
2813
 
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\&.
2814
 
.sp
2815
 
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\&.
2816
 
.sp
2817
 
In Samba version 3\&.0\&.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter
2818
 
\m[blue]\fBdfree cache time\fR\m[]
2819
 
was added to allow the output of this script to be cached for systems under heavy load\&.
2820
 
.sp
2821
 
The external program will be passed a single parameter indicating a directory in the filesystem being queried\&. This will typically consist of the string
2822
 
\FC\&./\F[]\&. 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\&.
2823
 
.sp
2824
 
Note: Your script should
2825
 
\fINOT\fR
2826
 
be setuid or setgid and should be owned by (and writeable only by) root!
2827
 
.sp
2828
 
Where the script dfree (which must be made executable) could be:
2829
 
.sp
2830
 
.if n \{\
2831
 
.RS 4
2832
 
.\}
2833
 
.fam C
2834
 
.ps -1
2835
 
.nf
2836
 
.BB lightgray
2837
 
 
2838
 
#!/bin/sh
2839
 
df $1 | tail \-1 | awk \'{print $(NF\-4),$(NF\-2)}\'
2840
 
.EB lightgray
2841
 
.fi
2842
 
.fam
2843
 
.ps +1
2844
 
.if n \{\
2845
 
.RE
2846
 
.\}
2847
 
.sp
2848
 
or perhaps (on Sys V based systems):
2849
 
.sp
2850
 
.if n \{\
2851
 
.RS 4
2852
 
.\}
2853
 
.fam C
2854
 
.ps -1
2855
 
.nf
2856
 
.BB lightgray
2857
 
 
2858
 
#!/bin/sh
2859
 
/usr/bin/df \-k $1 | tail \-1 | awk \'{print $3" "$5}\'
2860
 
.EB lightgray
2861
 
.fi
2862
 
.fam
2863
 
.ps +1
2864
 
.if n \{\
2865
 
.RE
2866
 
.\}
2867
 
.sp
2868
 
Note that you may have to replace the command names with full path names on some systems\&.
2869
 
.sp
2870
 
By default internal routines for determining the disk capacity and remaining space will be used\&.
2871
 
.sp
2872
 
\fINo default\fR
2873
 
.sp
2874
 
Example:
2875
 
\fI\fIdfree command\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/dfree\F[]\fR\fI \fR
2876
 
.RE
2877
 
 
2878
 
directory mode
2879
 
.\" directory mode
2880
 
.PP
2881
 
.RS 4
2882
 
This parameter is a synonym for
2883
 
directory mask\&.
2884
 
.RE
2885
 
 
2886
 
directory mask (S)
2887
 
.\" directory mask
2888
 
.PP
2889
 
.RS 4
2890
 
This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\&.
2891
 
.sp
2892
 
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
2893
 
\fInot\fR
2894
 
set here will be removed from the modes set on a directory when it is created\&.
2895
 
.sp
2896
 
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\&.
2897
 
.sp
2898
 
Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the
2899
 
\m[blue]\fBforce directory mode\fR\m[]
2900
 
parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode bits are added)\&.
2901
 
.sp
2902
 
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
2903
 
\m[blue]\fBdirectory security mask\fR\m[]\&.
2904
 
.sp
2905
 
Default:
2906
 
\fI\fIdirectory mask\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
2907
 
.sp
2908
 
Example:
2909
 
\fI\fIdirectory mask\fR\fR\fI = \fR\fI\FC0775\F[]\fR\fI \fR
2910
 
.RE
2911
 
 
2912
 
directory security mask (S)
2913
 
.\" directory security mask
2914
 
.PP
2915
 
.RS 4
2916
 
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\&.
2917
 
.sp
2918
 
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
2919
 
\m[blue]\fBforce directory security mode\fR\m[], 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\&.
2920
 
.sp
2921
 
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\&.
2922
 
.sp
2923
 
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\&.
2924
 
.sp
2925
 
\fINote\fR
2926
 
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
2927
 
\fB0777\fR\&.
2928
 
.sp
2929
 
Default:
2930
 
\fI\fIdirectory security mask\fR\fR\fI = \fR\fI\FC0777\F[]\fR\fI \fR
2931
 
.sp
2932
 
Example:
2933
 
\fI\fIdirectory security mask\fR\fR\fI = \fR\fI\FC0700\F[]\fR\fI \fR
2934
 
.RE
2935
 
 
2936
 
disable netbios (G)
2937
 
.\" disable netbios
2938
 
.PP
2939
 
.RS 4
2940
 
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\&.
2941
 
.if n \{\
2942
 
.sp
2943
 
.\}
2944
 
.RS 4
2945
 
.BM yellow
2946
 
.it 1 an-trap
2947
 
.nr an-no-space-flag 1
2948
 
.nr an-break-flag 1
2949
 
.br
2950
 
.ps +1
2951
 
\fBNote\fR
2952
 
.ps -1
2953
 
.br
2954
 
Clients that only support netbios won\'t be able to see your samba server when netbios support is disabled\&.
2955
 
.sp .5v
2956
 
.EM yellow
2957
 
.RE
2958
 
Default:
2959
 
\fI\fIdisable netbios\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2960
 
.RE
2961
 
 
2962
 
disable spoolss (G)
2963
 
.\" disable spoolss
2964
 
.PP
2965
 
.RS 4
2966
 
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\&.
2967
 
\fIBe very careful about enabling this parameter\&.\fR
2968
 
.sp
2969
 
Default:
2970
 
\fI\fIdisable spoolss\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2971
 
.RE
2972
 
 
2973
 
display charset (G)
2974
 
.\" display charset
2975
 
.PP
2976
 
.RS 4
2977
 
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
2978
 
\m[blue]\fBunix charset\fR\m[]\&.
2979
 
.sp
2980
 
Default:
2981
 
\fI\fIdisplay charset\fR\fR\fI = \fR\fI\FC"LOCALE" or "ASCII" (depending on the system)\F[]\fR\fI \fR
2982
 
.sp
2983
 
Example:
2984
 
\fI\fIdisplay charset\fR\fR\fI = \fR\fI\FCUTF8\F[]\fR\fI \fR
2985
 
.RE
2986
 
 
2987
 
dmapi support (S)
2988
 
.\" dmapi support
2989
 
.PP
2990
 
.RS 4
2991
 
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\&.
2992
 
.sp
2993
 
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\&.
2994
 
.sp
2995
 
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\&.
2996
 
.sp
2997
 
Default:
2998
 
\fI\fIdmapi support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
2999
 
.RE
3000
 
 
3001
 
dns proxy (G)
3002
 
.\" dns proxy
3003
 
.PP
3004
 
.RS 4
3005
 
Specifies that
3006
 
\fBnmbd\fR(8)
3007
 
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\&.
3008
 
.sp
3009
 
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\&.
3010
 
.sp
3011
 
\FCnmbd\F[]
3012
 
spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\&.
3013
 
.sp
3014
 
Default:
3015
 
\fI\fIdns proxy\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3016
 
.RE
3017
 
 
3018
 
domain logons (G)
3019
 
.\" domain logons
3020
 
.PP
3021
 
.RS 4
3022
 
If set to
3023
 
\fByes\fR, the Samba server will provide the netlogon service for Windows 9X network logons for the
3024
 
\m[blue]\fBworkgroup\fR\m[]
3025
 
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\&.
3026
 
.sp
3027
 
Default:
3028
 
\fI\fIdomain logons\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3029
 
.RE
3030
 
 
3031
 
domain master (G)
3032
 
.\" domain master
3033
 
.PP
3034
 
.RS 4
3035
 
Tell
3036
 
\fBsmbd\fR(8)
3037
 
to enable WAN\-wide browse list collation\&. Setting this option causes
3038
 
\FCnmbd\F[]
3039
 
to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given
3040
 
\m[blue]\fBworkgroup\fR\m[]\&. Local master browsers in the same
3041
 
\m[blue]\fBworkgroup\fR\m[]
3042
 
on broadcast\-isolated subnets will give this
3043
 
\FCnmbd\F[]
3044
 
their local browse lists, and then ask
3045
 
\fBsmbd\fR(8)
3046
 
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\&.
3047
 
.sp
3048
 
Note that Windows NT Primary Domain Controllers expect to be able to claim this
3049
 
\m[blue]\fBworkgroup\fR\m[]
3050
 
specific special NetBIOS name that identifies them as domain master browsers for that
3051
 
\m[blue]\fBworkgroup\fR\m[]
3052
 
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
3053
 
\FCnmbd\F[]
3054
 
claims the special name for a
3055
 
\m[blue]\fBworkgroup\fR\m[]
3056
 
before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\&.
3057
 
.sp
3058
 
If
3059
 
\m[blue]\fBdomain logons = yes\fR\m[], then the default behavior is to enable the
3060
 
\m[blue]\fBdomain master\fR\m[]
3061
 
parameter\&. If
3062
 
\m[blue]\fBdomain logons\fR\m[]
3063
 
is not enabled (the default setting), then neither will
3064
 
\m[blue]\fBdomain master\fR\m[]
3065
 
be enabled by default\&.
3066
 
.sp
3067
 
When
3068
 
\m[blue]\fBdomain logons = Yes\fR\m[]
3069
 
the default setting for this parameter is Yes, with the result that Samba will be a PDC\&. If
3070
 
\m[blue]\fBdomain master = No\fR\m[], Samba will function as a BDC\&. In general, this parameter should be set to \'No\' only on a BDC\&.
3071
 
.sp
3072
 
Default:
3073
 
\fI\fIdomain master\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
3074
 
.RE
3075
 
 
3076
 
dont descend (S)
3077
 
.\" dont descend
3078
 
.PP
3079
 
.RS 4
3080
 
There are certain directories on some systems (e\&.g\&., the
3081
 
\FC/proc\F[]
3082
 
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\&.
3083
 
.sp
3084
 
Note that Samba can be very fussy about the exact format of the "dont descend" entries\&. For example you may need
3085
 
\FC \&./proc\F[]
3086
 
instead of just
3087
 
\FC/proc\F[]\&. Experimentation is the best policy :\-)
3088
 
.sp
3089
 
Default:
3090
 
\fI\fIdont descend\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3091
 
.sp
3092
 
Example:
3093
 
\fI\fIdont descend\fR\fR\fI = \fR\fI\FC/proc,/dev\F[]\fR\fI \fR
3094
 
.RE
3095
 
 
3096
 
dos charset (G)
3097
 
.\" dos charset
3098
 
.PP
3099
 
.RS 4
3100
 
DOS SMB clients assume the server has the same charset as they do\&. This option specifies which charset Samba should talk to DOS clients\&.
3101
 
.sp
3102
 
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
3103
 
\fBtestparm\fR(1)
3104
 
to check the default on your system\&.
3105
 
.sp
3106
 
\fINo default\fR
3107
 
.RE
3108
 
 
3109
 
dos filemode (S)
3110
 
.\" dos filemode
3111
 
.PP
3112
 
.RS 4
3113
 
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\&.
3114
 
.sp
3115
 
Default:
3116
 
\fI\fIdos filemode\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3117
 
.RE
3118
 
 
3119
 
dos filetime resolution (S)
3120
 
.\" dos filetime resolution
3121
 
.PP
3122
 
.RS 4
3123
 
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
3124
 
\fBsmbd\fR(8)\&.
3125
 
.sp
3126
 
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\&.
3127
 
.sp
3128
 
Default:
3129
 
\fI\fIdos filetime resolution\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3130
 
.RE
3131
 
 
3132
 
dos filetimes (S)
3133
 
.\" dos filetimes
3134
 
.PP
3135
 
.RS 4
3136
 
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
3137
 
\FCsmbd\F[]
3138
 
is acting on behalf of is not the file owner\&. Setting this option to
3139
 
\fB yes\fR
3140
 
allows DOS semantics and
3141
 
\fBsmbd\fR(8)
3142
 
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\&.
3143
 
.sp
3144
 
Default:
3145
 
\fI\fIdos filetimes\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3146
 
.RE
3147
 
 
3148
 
ea support (S)
3149
 
.\" ea support
3150
 
.PP
3151
 
.RS 4
3152
 
This boolean parameter controls whether
3153
 
\fBsmbd\fR(8)
3154
 
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\&.
3155
 
.sp
3156
 
Default:
3157
 
\fI\fIea support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3158
 
.RE
3159
 
 
3160
 
enable asu support (G)
3161
 
.\" enable asu support
3162
 
.PP
3163
 
.RS 4
3164
 
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\&.
3165
 
.sp
3166
 
Default:
3167
 
\fI\fIenable asu support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3168
 
.RE
3169
 
 
3170
 
enable privileges (G)
3171
 
.\" enable privileges
3172
 
.PP
3173
 
.RS 4
3174
 
This parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either
3175
 
\FCnet rpc rights\F[]
3176
 
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\&.
3177
 
.sp
3178
 
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\&.
3179
 
.sp
3180
 
Please read the extended description provided in the Samba HOWTO documentation\&.
3181
 
.sp
3182
 
Default:
3183
 
\fI\fIenable privileges\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3184
 
.RE
3185
 
 
3186
 
encrypt passwords (G)
3187
 
.\" encrypt passwords
3188
 
.PP
3189
 
.RS 4
3190
 
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\&.
3191
 
.sp
3192
 
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\&.
3193
 
.sp
3194
 
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\&.
3195
 
.sp
3196
 
In order for encrypted passwords to work correctly
3197
 
\fBsmbd\fR(8)
3198
 
must either have access to a local
3199
 
\fBsmbpasswd\fR(5)
3200
 
file (see the
3201
 
\fBsmbpasswd\fR(8)
3202
 
program for information on how to set up and maintain this file), or set the
3203
 
\m[blue]\fBsecurity = [server|domain|ads]\fR\m[]
3204
 
parameter which causes
3205
 
\FCsmbd\F[]
3206
 
to authenticate against another server\&.
3207
 
.sp
3208
 
Default:
3209
 
\fI\fIencrypt passwords\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3210
 
.RE
3211
 
 
3212
 
enhanced browsing (G)
3213
 
.\" enhanced browsing
3214
 
.PP
3215
 
.RS 4
3216
 
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\&.
3217
 
.sp
3218
 
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\&.
3219
 
.sp
3220
 
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\&.
3221
 
.sp
3222
 
In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\&.
3223
 
.sp
3224
 
Default:
3225
 
\fI\fIenhanced browsing\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3226
 
.RE
3227
 
 
3228
 
enumports command (G)
3229
 
.\" enumports command
3230
 
.PP
3231
 
.RS 4
3232
 
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\-\-\fB"Samba Printer Port"\fR\&. Under Windows NT/2000, all printers must have a valid port name\&. If you wish to have a list of ports displayed (\FCsmbd \F[]
3233
 
does not use a port name for anything) other than the default
3234
 
\fB"Samba Printer Port"\fR, you can define
3235
 
\fIenumports command\fR
3236
 
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\&.
3237
 
.sp
3238
 
Default:
3239
 
\fI\fIenumports command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3240
 
.sp
3241
 
Example:
3242
 
\fI\fIenumports command\fR\fR\fI = \fR\fI\FC/usr/bin/listports\F[]\fR\fI \fR
3243
 
.RE
3244
 
 
3245
 
eventlog list (G)
3246
 
.\" eventlog list
3247
 
.PP
3248
 
.RS 4
3249
 
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
3250
 
\FC$(lockdir)/eventlog\F[]\&.
3251
 
.sp
3252
 
The administrator must use an external process to parse the normal Unix logs such as
3253
 
\FC/var/log/messages\F[]
3254
 
and write then entries to the eventlog tdb files\&. Refer to the eventlogadm(8) utility for how to write eventlog entries\&.
3255
 
.sp
3256
 
Default:
3257
 
\fI\fIeventlog list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3258
 
.sp
3259
 
Example:
3260
 
\fI\fIeventlog list\fR\fR\fI = \fR\fI\FCSecurity Application Syslog Apache\F[]\fR\fI \fR
3261
 
.RE
3262
 
 
3263
 
fake directory create times (S)
3264
 
.\" fake directory create times
3265
 
.PP
3266
 
.RS 4
3267
 
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\&.
3268
 
.sp
3269
 
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\&.
3270
 
.sp
3271
 
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\&.
3272
 
.sp
3273
 
Default:
3274
 
\fI\fIfake directory create times\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3275
 
.RE
3276
 
 
3277
 
fake oplocks (S)
3278
 
.\" fake oplocks
3279
 
.PP
3280
 
.RS 4
3281
 
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\&.
3282
 
.sp
3283
 
When you set
3284
 
\FCfake oplocks = yes\F[],
3285
 
\fBsmbd\fR(8)
3286
 
will always grant oplock requests no matter how many clients are using the file\&.
3287
 
.sp
3288
 
It is generally much better to use the real
3289
 
\m[blue]\fBoplocks\fR\m[]
3290
 
support rather than this parameter\&.
3291
 
.sp
3292
 
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!
3293
 
.sp
3294
 
Default:
3295
 
\fI\fIfake oplocks\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3296
 
.RE
3297
 
 
3298
 
follow symlinks (S)
3299
 
.\" follow symlinks
3300
 
.PP
3301
 
.RS 4
3302
 
This parameter allows the Samba administrator to stop
3303
 
\fBsmbd\fR(8)
3304
 
from following symbolic links in a particular share\&. Setting this parameter to
3305
 
\fBno\fR
3306
 
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
3307
 
\FC/etc/passwd\F[]
3308
 
in their home directory for instance\&. However it will slow filename lookups down slightly\&.
3309
 
.sp
3310
 
This option is enabled (i\&.e\&.
3311
 
\FCsmbd\F[]
3312
 
will follow symbolic links) by default\&.
3313
 
.sp
3314
 
Default:
3315
 
\fI\fIfollow symlinks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3316
 
.RE
3317
 
 
3318
 
force create mode (S)
3319
 
.\" force create mode
3320
 
.PP
3321
 
.RS 4
3322
 
This parameter specifies a set of UNIX mode bit permissions that will
3323
 
\fIalways\fR
3324
 
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
3325
 
\fIcreate mask\fR
3326
 
parameter is applied\&.
3327
 
.sp
3328
 
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\'\&.
3329
 
.sp
3330
 
Default:
3331
 
\fI\fIforce create mode\fR\fR\fI = \fR\fI\FC000\F[]\fR\fI \fR
3332
 
.sp
3333
 
Example:
3334
 
\fI\fIforce create mode\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
3335
 
.RE
3336
 
 
3337
 
force directory mode (S)
3338
 
.\" force directory mode
3339
 
.PP
3340
 
.RS 4
3341
 
This parameter specifies a set of UNIX mode bit permissions that will
3342
 
\fIalways\fR
3343
 
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
3344
 
\fIdirectory mask\fR
3345
 
is applied\&.
3346
 
.sp
3347
 
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\'\&.
3348
 
.sp
3349
 
Default:
3350
 
\fI\fIforce directory mode\fR\fR\fI = \fR\fI\FC000\F[]\fR\fI \fR
3351
 
.sp
3352
 
Example:
3353
 
\fI\fIforce directory mode\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
3354
 
.RE
3355
 
 
3356
 
force directory security mode (S)
3357
 
.\" force directory security mode
3358
 
.PP
3359
 
.RS 4
3360
 
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\&.
3361
 
.sp
3362
 
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
3363
 
\m[blue]\fBdirectory security mask\fR\m[], which works in a similar manner to this one, but uses a logical AND instead of an OR\&.
3364
 
.sp
3365
 
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)\&.
3366
 
.sp
3367
 
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\&.
3368
 
.if n \{\
3369
 
.sp
3370
 
.\}
3371
 
.RS 4
3372
 
.BM yellow
3373
 
.it 1 an-trap
3374
 
.nr an-no-space-flag 1
3375
 
.nr an-break-flag 1
3376
 
.br
3377
 
.ps +1
3378
 
\fBNote\fR
3379
 
.ps -1
3380
 
.br
3381
 
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\&.
3382
 
.sp .5v
3383
 
.EM yellow
3384
 
.RE
3385
 
Default:
3386
 
\fI\fIforce directory security mode\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
3387
 
.sp
3388
 
Example:
3389
 
\fI\fIforce directory security mode\fR\fR\fI = \fR\fI\FC700\F[]\fR\fI \fR
3390
 
.RE
3391
 
 
3392
 
group
3393
 
.\" group
3394
 
.PP
3395
 
.RS 4
3396
 
This parameter is a synonym for
3397
 
force group\&.
3398
 
.RE
3399
 
 
3400
 
force group (S)
3401
 
.\" force group
3402
 
.PP
3403
 
.RS 4
3404
 
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\&.
3405
 
.sp
3406
 
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
3407
 
\FCforce group = +sys\F[]
3408
 
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\&.
3409
 
.sp
3410
 
If the
3411
 
\m[blue]\fBforce user\fR\m[]
3412
 
parameter is also set the group specified in
3413
 
\fIforce group\fR
3414
 
will override the primary group set in
3415
 
\fIforce user\fR\&.
3416
 
.sp
3417
 
Default:
3418
 
\fI\fIforce group\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3419
 
.sp
3420
 
Example:
3421
 
\fI\fIforce group\fR\fR\fI = \fR\fI\FCagroup\F[]\fR\fI \fR
3422
 
.RE
3423
 
 
3424
 
force printername (S)
3425
 
.\" force printername
3426
 
.PP
3427
 
.RS 4
3428
 
When printing from Windows NT (or later), each printer in
3429
 
\FCsmb\&.conf\F[]
3430
 
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
3431
 
\fIprinter name\fR
3432
 
option)\&.
3433
 
.sp
3434
 
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
3435
 
\fIforce printername = yes\fR\&.
3436
 
.sp
3437
 
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\&.
3438
 
.sp
3439
 
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\&.
3440
 
.sp
3441
 
Default:
3442
 
\fI\fIforce printername\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3443
 
.RE
3444
 
 
3445
 
force security mode (S)
3446
 
.\" force security mode
3447
 
.PP
3448
 
.RS 4
3449
 
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\&.
3450
 
.sp
3451
 
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
3452
 
\m[blue]\fBsecurity mask\fR\m[], which works similar like this one but uses logical AND instead of OR\&.
3453
 
.sp
3454
 
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\&.
3455
 
.sp
3456
 
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\&.
3457
 
.sp
3458
 
\fI Note\fR
3459
 
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\&.
3460
 
.sp
3461
 
Default:
3462
 
\fI\fIforce security mode\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
3463
 
.sp
3464
 
Example:
3465
 
\fI\fIforce security mode\fR\fR\fI = \fR\fI\FC700\F[]\fR\fI \fR
3466
 
.RE
3467
 
 
3468
 
force unknown acl user (S)
3469
 
.\" force unknown acl user
3470
 
.PP
3471
 
.RS 4
3472
 
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\&.
3473
 
.sp
3474
 
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\&.
3475
 
.sp
3476
 
Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\&.
3477
 
.sp
3478
 
Default:
3479
 
\fI\fIforce unknown acl user\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3480
 
.RE
3481
 
 
3482
 
force user (S)
3483
 
.\" force user
3484
 
.PP
3485
 
.RS 4
3486
 
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\&.
3487
 
.sp
3488
 
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\&.
3489
 
.sp
3490
 
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)\&.
3491
 
.sp
3492
 
Default:
3493
 
\fI\fIforce user\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3494
 
.sp
3495
 
Example:
3496
 
\fI\fIforce user\fR\fR\fI = \fR\fI\FCauser\F[]\fR\fI \fR
3497
 
.RE
3498
 
 
3499
 
fstype (S)
3500
 
.\" fstype
3501
 
.PP
3502
 
.RS 4
3503
 
This parameter allows the administrator to configure the string that specifies the type of filesystem a share is using that is reported by
3504
 
\fBsmbd\fR(8)
3505
 
when a client queries the filesystem type for a share\&. The default type is
3506
 
\fBNTFS\fR
3507
 
for compatibility with Windows NT but this can be changed to other strings such as
3508
 
\fBSamba\fR
3509
 
or
3510
 
\fBFAT\fR
3511
 
if required\&.
3512
 
.sp
3513
 
Default:
3514
 
\fI\fIfstype\fR\fR\fI = \fR\fI\FCNTFS\F[]\fR\fI \fR
3515
 
.sp
3516
 
Example:
3517
 
\fI\fIfstype\fR\fR\fI = \fR\fI\FCSamba\F[]\fR\fI \fR
3518
 
.RE
3519
 
 
3520
 
get quota command (G)
3521
 
.\" get quota command
3522
 
.PP
3523
 
.RS 4
3524
 
The
3525
 
\FCget quota command\F[]
3526
 
should only be used whenever there is no operating system API available from the OS that samba can use\&.
3527
 
.sp
3528
 
This option is only available you have compiled Samba with the
3529
 
\FC\-\-with\-sys\-quotas\F[]
3530
 
option or on Linux with
3531
 
\FC\-\-with\-quotas\F[]
3532
 
and a working quota api was found in the system\&.
3533
 
.sp
3534
 
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\&.
3535
 
.sp
3536
 
Such a script should take 3 arguments:
3537
 
.sp
3538
 
.RS 4
3539
 
.ie n \{\
3540
 
\h'-04'\(bu\h'+03'\c
3541
 
.\}
3542
 
.el \{\
3543
 
.sp -1
3544
 
.IP \(bu 2.3
3545
 
.\}
3546
 
directory
3547
 
.RE
3548
 
.sp
3549
 
.RS 4
3550
 
.ie n \{\
3551
 
\h'-04'\(bu\h'+03'\c
3552
 
.\}
3553
 
.el \{\
3554
 
.sp -1
3555
 
.IP \(bu 2.3
3556
 
.\}
3557
 
type of query
3558
 
.RE
3559
 
.sp
3560
 
.RS 4
3561
 
.ie n \{\
3562
 
\h'-04'\(bu\h'+03'\c
3563
 
.\}
3564
 
.el \{\
3565
 
.sp -1
3566
 
.IP \(bu 2.3
3567
 
.\}
3568
 
uid of user or gid of group
3569
 
.sp
3570
 
.RE
3571
 
The type of query can be one of :
3572
 
.sp
3573
 
.RS 4
3574
 
.ie n \{\
3575
 
\h'-04'\(bu\h'+03'\c
3576
 
.\}
3577
 
.el \{\
3578
 
.sp -1
3579
 
.IP \(bu 2.3
3580
 
.\}
3581
 
1 \- user quotas
3582
 
.RE
3583
 
.sp
3584
 
.RS 4
3585
 
.ie n \{\
3586
 
\h'-04'\(bu\h'+03'\c
3587
 
.\}
3588
 
.el \{\
3589
 
.sp -1
3590
 
.IP \(bu 2.3
3591
 
.\}
3592
 
2 \- user default quotas (uid = \-1)
3593
 
.RE
3594
 
.sp
3595
 
.RS 4
3596
 
.ie n \{\
3597
 
\h'-04'\(bu\h'+03'\c
3598
 
.\}
3599
 
.el \{\
3600
 
.sp -1
3601
 
.IP \(bu 2.3
3602
 
.\}
3603
 
3 \- group quotas
3604
 
.RE
3605
 
.sp
3606
 
.RS 4
3607
 
.ie n \{\
3608
 
\h'-04'\(bu\h'+03'\c
3609
 
.\}
3610
 
.el \{\
3611
 
.sp -1
3612
 
.IP \(bu 2.3
3613
 
.\}
3614
 
4 \- group default quotas (gid = \-1)
3615
 
.sp
3616
 
.RE
3617
 
This script should print one line as output with spaces between the arguments\&. The arguments are:
3618
 
.sp
3619
 
.RS 4
3620
 
.ie n \{\
3621
 
\h'-04'\(bu\h'+03'\c
3622
 
.\}
3623
 
.el \{\
3624
 
.sp -1
3625
 
.IP \(bu 2.3
3626
 
.\}
3627
 
Arg 1 \- quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)
3628
 
.RE
3629
 
.sp
3630
 
.RS 4
3631
 
.ie n \{\
3632
 
\h'-04'\(bu\h'+03'\c
3633
 
.\}
3634
 
.el \{\
3635
 
.sp -1
3636
 
.IP \(bu 2.3
3637
 
.\}
3638
 
Arg 2 \- number of currently used blocks
3639
 
.RE
3640
 
.sp
3641
 
.RS 4
3642
 
.ie n \{\
3643
 
\h'-04'\(bu\h'+03'\c
3644
 
.\}
3645
 
.el \{\
3646
 
.sp -1
3647
 
.IP \(bu 2.3
3648
 
.\}
3649
 
Arg 3 \- the softlimit number of blocks
3650
 
.RE
3651
 
.sp
3652
 
.RS 4
3653
 
.ie n \{\
3654
 
\h'-04'\(bu\h'+03'\c
3655
 
.\}
3656
 
.el \{\
3657
 
.sp -1
3658
 
.IP \(bu 2.3
3659
 
.\}
3660
 
Arg 4 \- the hardlimit number of blocks
3661
 
.RE
3662
 
.sp
3663
 
.RS 4
3664
 
.ie n \{\
3665
 
\h'-04'\(bu\h'+03'\c
3666
 
.\}
3667
 
.el \{\
3668
 
.sp -1
3669
 
.IP \(bu 2.3
3670
 
.\}
3671
 
Arg 5 \- currently used number of inodes
3672
 
.RE
3673
 
.sp
3674
 
.RS 4
3675
 
.ie n \{\
3676
 
\h'-04'\(bu\h'+03'\c
3677
 
.\}
3678
 
.el \{\
3679
 
.sp -1
3680
 
.IP \(bu 2.3
3681
 
.\}
3682
 
Arg 6 \- the softlimit number of inodes
3683
 
.RE
3684
 
.sp
3685
 
.RS 4
3686
 
.ie n \{\
3687
 
\h'-04'\(bu\h'+03'\c
3688
 
.\}
3689
 
.el \{\
3690
 
.sp -1
3691
 
.IP \(bu 2.3
3692
 
.\}
3693
 
Arg 7 \- the hardlimit number of inodes
3694
 
.RE
3695
 
.sp
3696
 
.RS 4
3697
 
.ie n \{\
3698
 
\h'-04'\(bu\h'+03'\c
3699
 
.\}
3700
 
.el \{\
3701
 
.sp -1
3702
 
.IP \(bu 2.3
3703
 
.\}
3704
 
Arg 8(optional) \- the number of bytes in a block(default is 1024)
3705
 
.sp
3706
 
.RE
3707
 
Default:
3708
 
\fI\fIget quota command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3709
 
.sp
3710
 
Example:
3711
 
\fI\fIget quota command\fR\fR\fI = \fR\fI\FC/usr/local/sbin/query_quota\F[]\fR\fI \fR
3712
 
.RE
3713
 
 
3714
 
getwd cache (G)
3715
 
.\" getwd cache
3716
 
.PP
3717
 
.RS 4
3718
 
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
3719
 
\m[blue]\fBwide smbconfoptions\fR\m[]
3720
 
parameter is set to
3721
 
\fBno\fR\&.
3722
 
.sp
3723
 
Default:
3724
 
\fI\fIgetwd cache\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3725
 
.RE
3726
 
 
3727
 
guest account (G)
3728
 
.\" guest account
3729
 
.PP
3730
 
.RS 4
3731
 
This is a username which will be used for access to services which are specified as
3732
 
\m[blue]\fBguest ok\fR\m[]
3733
 
(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\&.
3734
 
.sp
3735
 
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
3736
 
\FCsu \-\F[]
3737
 
command) and trying to print using the system print command such as
3738
 
\FClpr(1)\F[]
3739
 
or
3740
 
\FC lp(1)\F[]\&.
3741
 
.sp
3742
 
This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation\&.
3743
 
.sp
3744
 
Default:
3745
 
\fI\fIguest account\fR\fR\fI = \fR\fI\FCnobody # default can be changed at compile\-time\F[]\fR\fI \fR
3746
 
.sp
3747
 
Example:
3748
 
\fI\fIguest account\fR\fR\fI = \fR\fI\FCftp\F[]\fR\fI \fR
3749
 
.RE
3750
 
 
3751
 
public
3752
 
.\" public
3753
 
.PP
3754
 
.RS 4
3755
 
This parameter is a synonym for
3756
 
guest ok\&.
3757
 
.RE
3758
 
 
3759
 
guest ok (S)
3760
 
.\" guest ok
3761
 
.PP
3762
 
.RS 4
3763
 
If this parameter is
3764
 
\fByes\fR
3765
 
for a service, then no password is required to connect to the service\&. Privileges will be those of the
3766
 
\m[blue]\fBguest account\fR\m[]\&.
3767
 
.sp
3768
 
This paramater nullifies the benifits of setting
3769
 
\m[blue]\fBrestrict anonymous = 2\fR\m[]
3770
 
.sp
3771
 
See the section below on
3772
 
\m[blue]\fBsecurity\fR\m[]
3773
 
for more information about this option\&.
3774
 
.sp
3775
 
Default:
3776
 
\fI\fIguest ok\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3777
 
.RE
3778
 
 
3779
 
only guest
3780
 
.\" only guest
3781
 
.PP
3782
 
.RS 4
3783
 
This parameter is a synonym for
3784
 
guest only\&.
3785
 
.RE
3786
 
 
3787
 
guest only (S)
3788
 
.\" guest only
3789
 
.PP
3790
 
.RS 4
3791
 
If this parameter is
3792
 
\fByes\fR
3793
 
for a service, then only guest connections to the service are permitted\&. This parameter will have no effect if
3794
 
\m[blue]\fBguest ok\fR\m[]
3795
 
is not set for the service\&.
3796
 
.sp
3797
 
See the section below on
3798
 
\m[blue]\fBsecurity\fR\m[]
3799
 
for more information about this option\&.
3800
 
.sp
3801
 
Default:
3802
 
\fI\fIguest only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3803
 
.RE
3804
 
 
3805
 
hide dot files (S)
3806
 
.\" hide dot files
3807
 
.PP
3808
 
.RS 4
3809
 
This is a boolean parameter that controls whether files starting with a dot appear as hidden files\&.
3810
 
.sp
3811
 
Default:
3812
 
\fI\fIhide dot files\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3813
 
.RE
3814
 
 
3815
 
hide files (S)
3816
 
.\" hide files
3817
 
.PP
3818
 
.RS 4
3819
 
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\&.
3820
 
.sp
3821
 
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\&.
3822
 
.sp
3823
 
Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator \'/\'\&.
3824
 
.sp
3825
 
Note that the case sensitivity option is applicable in hiding files\&.
3826
 
.sp
3827
 
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\&.
3828
 
.sp
3829
 
The example shown above is based on files that the Macintosh SMB client (DAVE) available from
3830
 
Thursby
3831
 
creates for internal use, and also still hides all files beginning with a dot\&.
3832
 
.sp
3833
 
An example of us of this parameter is:
3834
 
.sp
3835
 
.if n \{\
3836
 
.RS 4
3837
 
.\}
3838
 
.fam C
3839
 
.ps -1
3840
 
.nf
3841
 
.if t \{\
3842
 
.sp -1
3843
 
.\}
3844
 
.BB lightgray adjust-for-leading-newline
3845
 
.sp -1
3846
 
 
3847
 
hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/
3848
 
.EB lightgray adjust-for-leading-newline
3849
 
.if t \{\
3850
 
.sp 1
3851
 
.\}
3852
 
.fi
3853
 
.fam
3854
 
.ps +1
3855
 
.if n \{\
3856
 
.RE
3857
 
.\}
3858
 
.sp
3859
 
Default:
3860
 
\fI\fIhide files\fR\fR\fI = \fR\fI\FC # no file are hidden\F[]\fR\fI \fR
3861
 
.RE
3862
 
 
3863
 
hide special files (S)
3864
 
.\" hide special files
3865
 
.PP
3866
 
.RS 4
3867
 
This parameter prevents clients from seeing special files such as sockets, devices and fifo\'s in directory listings\&.
3868
 
.sp
3869
 
Default:
3870
 
\fI\fIhide special files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3871
 
.RE
3872
 
 
3873
 
hide unreadable (S)
3874
 
.\" hide unreadable
3875
 
.PP
3876
 
.RS 4
3877
 
This parameter prevents clients from seeing the existance of files that cannot be read\&. Defaults to off\&.
3878
 
.sp
3879
 
Default:
3880
 
\fI\fIhide unreadable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3881
 
.RE
3882
 
 
3883
 
hide unwriteable files (S)
3884
 
.\" hide unwriteable files
3885
 
.PP
3886
 
.RS 4
3887
 
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\&.
3888
 
.sp
3889
 
Default:
3890
 
\fI\fIhide unwriteable files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3891
 
.RE
3892
 
 
3893
 
homedir map (G)
3894
 
.\" homedir map
3895
 
.PP
3896
 
.RS 4
3897
 
If
3898
 
\m[blue]\fBnis homedir\fR\m[]
3899
 
is
3900
 
\fByes\fR, and
3901
 
\fBsmbd\fR(8)
3902
 
is also acting as a Win95/98
3903
 
\fIlogon server\fR
3904
 
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:
3905
 
.sp
3906
 
.if n \{\
3907
 
.RS 4
3908
 
.\}
3909
 
.fam C
3910
 
.ps -1
3911
 
.nf
3912
 
.if t \{\
3913
 
.sp -1
3914
 
.\}
3915
 
.BB lightgray adjust-for-leading-newline
3916
 
.sp -1
3917
 
 
3918
 
\FCusername server:/some/file/system\F[]
3919
 
.EB lightgray adjust-for-leading-newline
3920
 
.if t \{\
3921
 
.sp 1
3922
 
.\}
3923
 
.fi
3924
 
.fam
3925
 
.ps +1
3926
 
.if n \{\
3927
 
.RE
3928
 
.\}
3929
 
.sp
3930
 
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\&.
3931
 
.if n \{\
3932
 
.sp
3933
 
.\}
3934
 
.RS 4
3935
 
.BM yellow
3936
 
.it 1 an-trap
3937
 
.nr an-no-space-flag 1
3938
 
.nr an-break-flag 1
3939
 
.br
3940
 
.ps +1
3941
 
\fBNote\fR
3942
 
.ps -1
3943
 
.br
3944
 
A working NIS client is required on the system for this option to work\&.
3945
 
.sp .5v
3946
 
.EM yellow
3947
 
.RE
3948
 
Default:
3949
 
\fI\fIhomedir map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
3950
 
.sp
3951
 
Example:
3952
 
\fI\fIhomedir map\fR\fR\fI = \fR\fI\FCamd\&.homedir\F[]\fR\fI \fR
3953
 
.RE
3954
 
 
3955
 
host msdfs (G)
3956
 
.\" host msdfs
3957
 
.PP
3958
 
.RS 4
3959
 
If set to
3960
 
\fByes\fR, Samba will act as a Dfs server, and allow Dfs\-aware clients to browse Dfs trees hosted on the server\&.
3961
 
.sp
3962
 
See also the
3963
 
\m[blue]\fBmsdfs root\fR\m[]
3964
 
share level parameter\&. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\&.
3965
 
.sp
3966
 
Default:
3967
 
\fI\fIhost msdfs\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3968
 
.RE
3969
 
 
3970
 
hostname lookups (G)
3971
 
.\" hostname lookups
3972
 
.PP
3973
 
.RS 4
3974
 
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
3975
 
\FChosts deny\F[]
3976
 
and
3977
 
\FChosts allow\F[]\&.
3978
 
.sp
3979
 
Default:
3980
 
\fI\fIhostname lookups\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
3981
 
.sp
3982
 
Example:
3983
 
\fI\fIhostname lookups\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
3984
 
.RE
3985
 
 
3986
 
allow hosts
3987
 
.\" allow hosts
3988
 
.PP
3989
 
.RS 4
3990
 
This parameter is a synonym for
3991
 
hosts allow\&.
3992
 
.RE
3993
 
 
3994
 
hosts allow (S)
3995
 
.\" hosts allow
3996
 
.PP
3997
 
.RS 4
3998
 
A synonym for this parameter is
3999
 
\m[blue]\fBallow hosts\fR\m[]\&.
4000
 
.sp
4001
 
This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\&.
4002
 
.sp
4003
 
If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\&.
4004
 
.sp
4005
 
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
4006
 
\FCallow hosts = 150\&.203\&.5\&.\F[]\&. The full syntax of the list is described in the man page
4007
 
\FChosts_access(5)\F[]\&. Note that this man page may not be present on your system, so a brief description will be given here also\&.
4008
 
.sp
4009
 
Note that the localhost address 127\&.0\&.0\&.1 will always be allowed access unless specifically denied by a
4010
 
\m[blue]\fBhosts deny\fR\m[]
4011
 
option\&.
4012
 
.sp
4013
 
You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\&. The
4014
 
\fIEXCEPT\fR
4015
 
keyword can also be used to limit a wildcard list\&. The following examples may provide some help:
4016
 
.sp
4017
 
Example 1: allow all IPs in 150\&.203\&.*\&.*; except one
4018
 
.sp
4019
 
\FChosts allow = 150\&.203\&. EXCEPT 150\&.203\&.6\&.66\F[]
4020
 
.sp
4021
 
Example 2: allow hosts that match the given network/netmask
4022
 
.sp
4023
 
\FChosts allow = 150\&.203\&.15\&.0/255\&.255\&.255\&.0\F[]
4024
 
.sp
4025
 
Example 3: allow a couple of hosts
4026
 
.sp
4027
 
\FChosts allow = lapland, arvidsjaur\F[]
4028
 
.sp
4029
 
Example 4: allow only hosts in NIS netgroup "foonet", but deny access from one particular host
4030
 
.sp
4031
 
\FChosts allow = @foonet\F[]
4032
 
.sp
4033
 
\FChosts deny = pirate\F[]
4034
 
.if n \{\
4035
 
.sp
4036
 
.\}
4037
 
.RS 4
4038
 
.BM yellow
4039
 
.it 1 an-trap
4040
 
.nr an-no-space-flag 1
4041
 
.nr an-break-flag 1
4042
 
.br
4043
 
.ps +1
4044
 
\fBNote\fR
4045
 
.ps -1
4046
 
.br
4047
 
Note that access still requires suitable user\-level passwords\&.
4048
 
.sp .5v
4049
 
.EM yellow
4050
 
.RE
4051
 
See
4052
 
\fBtestparm\fR(1)
4053
 
for a way of testing your host access to see if it does what you expect\&.
4054
 
.sp
4055
 
Default:
4056
 
\fI\fIhosts allow\fR\fR\fI = \fR\fI\FC # none (i\&.e\&., all hosts permitted access)\F[]\fR\fI \fR
4057
 
.sp
4058
 
Example:
4059
 
\fI\fIhosts allow\fR\fR\fI = \fR\fI\FC150\&.203\&.5\&. myhost\&.mynet\&.edu\&.au\F[]\fR\fI \fR
4060
 
.RE
4061
 
 
4062
 
deny hosts
4063
 
.\" deny hosts
4064
 
.PP
4065
 
.RS 4
4066
 
This parameter is a synonym for
4067
 
hosts deny\&.
4068
 
.RE
4069
 
 
4070
 
hosts deny (S)
4071
 
.\" hosts deny
4072
 
.PP
4073
 
.RS 4
4074
 
The opposite of
4075
 
\fIhosts allow\fR
4076
 
\- hosts listed here are
4077
 
\fINOT\fR
4078
 
permitted access to services unless the specific services have their own lists to override this one\&. Where the lists conflict, the
4079
 
\fIallow\fR
4080
 
list takes precedence\&.
4081
 
.sp
4082
 
In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask
4083
 
\FC0\&.0\&.0\&.0/0\F[]) and then explicitly specify to the
4084
 
\m[blue]\fBhosts allow = hosts allow\fR\m[]
4085
 
parameter those hosts that should be permitted access\&.
4086
 
.sp
4087
 
Default:
4088
 
\fI\fIhosts deny\fR\fR\fI = \fR\fI\FC # none (i\&.e\&., no hosts specifically excluded)\F[]\fR\fI \fR
4089
 
.sp
4090
 
Example:
4091
 
\fI\fIhosts deny\fR\fR\fI = \fR\fI\FC150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\F[]\fR\fI \fR
4092
 
.RE
4093
 
 
4094
 
idmap alloc backend (G)
4095
 
.\" idmap alloc backend
4096
 
.PP
4097
 
.RS 4
4098
 
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 (\fBidmap_tdb\fR(8)) and ldap (\fBidmap_ldap\fR(8)) libraries\&.
4099
 
.sp
4100
 
This parameter defaults to the value
4101
 
\m[blue]\fBidmap backend\fR\m[]
4102
 
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\&.
4103
 
.sp
4104
 
Also refer to the
4105
 
\m[blue]\fBidmap alloc config\fR\m[]
4106
 
option\&.
4107
 
.sp
4108
 
\fINo default\fR
4109
 
.sp
4110
 
Example:
4111
 
\fI\fIidmap alloc backend\fR\fR\fI = \fR\fI\FCtdb\F[]\fR\fI \fR
4112
 
.RE
4113
 
 
4114
 
idmap alloc config (G)
4115
 
.\" idmap alloc config
4116
 
.PP
4117
 
.RS 4
4118
 
The idmap alloc config prefix provides a means of managing settings for the backend defined by the
4119
 
\m[blue]\fBidmap alloc backend\fR\m[]
4120
 
parameter\&. Refer to the man page for each idmap plugin regarding specific configuration details\&.
4121
 
.sp
4122
 
\fINo default\fR
4123
 
.RE
4124
 
 
4125
 
idmap backend (G)
4126
 
.\" idmap backend
4127
 
.PP
4128
 
.RS 4
4129
 
The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables\&.
4130
 
.sp
4131
 
This option specifies the default backend that is used when no special configuration set by
4132
 
\m[blue]\fBidmap config\fR\m[]
4133
 
matches the specific request\&.
4134
 
.sp
4135
 
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
4136
 
\fBidmap_tdb\fR(8)
4137
 
or
4138
 
\fBidmap_ldap\fR(8)
4139
 
as the idmap backend\&. The
4140
 
\fBidmap_rid\fR(8)
4141
 
and
4142
 
\fBidmap_ad\fR(8)
4143
 
backends are not writable and thus will generate unexpected results if set as idmap backend\&.
4144
 
.sp
4145
 
To use the rid and ad backends, please specify them via the
4146
 
\m[blue]\fBidmap config\fR\m[]
4147
 
parameter, possibly also for the domain your machine is member of, specified by
4148
 
\m[blue]\fBworkgroup\fR\m[]\&.
4149
 
.sp
4150
 
Examples of SID/uid/gid backends include tdb (\fBidmap_tdb\fR(8)), ldap (\fBidmap_ldap\fR(8)), rid (\fBidmap_rid\fR(8)), and ad (\fBidmap_ad\fR(8))\&.
4151
 
.sp
4152
 
Default:
4153
 
\fI\fIidmap backend\fR\fR\fI = \fR\fI\FCtdb\F[]\fR\fI \fR
4154
 
.RE
4155
 
 
4156
 
idmap cache time (G)
4157
 
.\" idmap cache time
4158
 
.PP
4159
 
.RS 4
4160
 
This parameter specifies the number of seconds that Winbind\'s idmap interface will cache positive SID/uid/gid query results\&.
4161
 
.sp
4162
 
Default:
4163
 
\fI\fIidmap cache time\fR\fR\fI = \fR\fI\FC604800 (one week)\F[]\fR\fI \fR
4164
 
.RE
4165
 
 
4166
 
idmap config (G)
4167
 
.\" idmap config
4168
 
.PP
4169
 
.RS 4
4170
 
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:
4171
 
.PP
4172
 
backend = backend_name
4173
 
.RS 4
4174
 
Specifies the name of the idmap plugin to use as the SID/uid/gid backend for this domain\&.
4175
 
.RE
4176
 
.PP
4177
 
range = low \- high
4178
 
.RS 4
4179
 
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\&.
4180
 
.sp
4181
 
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
4182
 
\m[blue]\fBidmap uid\fR\m[]
4183
 
and
4184
 
\m[blue]\fBidmap gid\fR\m[]\&.
4185
 
.RE
4186
 
.sp
4187
 
The following example illustrates how to configure the
4188
 
\fBidmap_ad\fR(8)
4189
 
for the CORP domain and the
4190
 
\fBidmap_tdb\fR(8)
4191
 
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\&.
4192
 
.sp
4193
 
.if n \{\
4194
 
.RS 4
4195
 
.\}
4196
 
.fam C
4197
 
.ps -1
4198
 
.nf
4199
 
.if t \{\
4200
 
.sp -1
4201
 
.\}
4202
 
.BB lightgray adjust-for-leading-newline
4203
 
.sp -1
4204
 
 
4205
 
        idmap backend = tdb
4206
 
        idmap uid = 1000000\-1999999
4207
 
        idmap gid = 1000000\-1999999
4208
 
 
4209
 
        idmap config CORP : backend  = ad
4210
 
        idmap config CORP : range = 1000\-999999
4211
 
        
4212
 
.EB lightgray adjust-for-leading-newline
4213
 
.if t \{\
4214
 
.sp 1
4215
 
.\}
4216
 
.fi
4217
 
.fam
4218
 
.ps +1
4219
 
.if n \{\
4220
 
.RE
4221
 
.\}
4222
 
.sp
4223
 
\fINo default\fR
4224
 
.RE
4225
 
 
4226
 
winbind gid
4227
 
.\" winbind gid
4228
 
.PP
4229
 
.RS 4
4230
 
This parameter is a synonym for
4231
 
idmap gid\&.
4232
 
.RE
4233
 
 
4234
 
idmap gid (G)
4235
 
.\" idmap gid
4236
 
.PP
4237
 
.RS 4
4238
 
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\&.
4239
 
.sp
4240
 
See also the
4241
 
\m[blue]\fBidmap backend\fR\m[], and
4242
 
\m[blue]\fBidmap config\fR\m[]
4243
 
options\&.
4244
 
.sp
4245
 
Default:
4246
 
\fI\fIidmap gid\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4247
 
.sp
4248
 
Example:
4249
 
\fI\fIidmap gid\fR\fR\fI = \fR\fI\FC10000\-20000\F[]\fR\fI \fR
4250
 
.RE
4251
 
 
4252
 
idmap negative cache time (G)
4253
 
.\" idmap negative cache time
4254
 
.PP
4255
 
.RS 4
4256
 
This parameter specifies the number of seconds that Winbind\'s idmap interface will cache negative SID/uid/gid query results\&.
4257
 
.sp
4258
 
Default:
4259
 
\fI\fIidmap negative cache time\fR\fR\fI = \fR\fI\FC120\F[]\fR\fI \fR
4260
 
.RE
4261
 
 
4262
 
winbind uid
4263
 
.\" winbind uid
4264
 
.PP
4265
 
.RS 4
4266
 
This parameter is a synonym for
4267
 
idmap uid\&.
4268
 
.RE
4269
 
 
4270
 
idmap uid (G)
4271
 
.\" idmap uid
4272
 
.PP
4273
 
.RS 4
4274
 
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\&.
4275
 
.sp
4276
 
See also the
4277
 
\m[blue]\fBidmap backend\fR\m[]
4278
 
and
4279
 
\m[blue]\fBidmap config\fR\m[]
4280
 
options\&.
4281
 
.sp
4282
 
Default:
4283
 
\fI\fIidmap uid\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4284
 
.sp
4285
 
Example:
4286
 
\fI\fIidmap uid\fR\fR\fI = \fR\fI\FC10000\-20000\F[]\fR\fI \fR
4287
 
.RE
4288
 
 
4289
 
include (G)
4290
 
.\" include
4291
 
.PP
4292
 
.RS 4
4293
 
This allows you to include one config file inside another\&. The file is included literally, as though typed in place\&.
4294
 
.sp
4295
 
It takes the standard substitutions, except
4296
 
\fI%u\fR,
4297
 
\fI%P\fR
4298
 
and
4299
 
\fI%S\fR\&.
4300
 
.sp
4301
 
The parameter
4302
 
\fIinclude = registry\fR
4303
 
has a special meaning: It does
4304
 
\fInot\fR
4305
 
include a file named
4306
 
\fIregistry\fR
4307
 
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\&.
4308
 
.sp
4309
 
Default:
4310
 
\fI\fIinclude\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4311
 
.sp
4312
 
Example:
4313
 
\fI\fIinclude\fR\fR\fI = \fR\fI\FC/usr/local/samba/lib/admin_smb\&.conf\F[]\fR\fI \fR
4314
 
.RE
4315
 
 
4316
 
inherit acls (S)
4317
 
.\" inherit acls
4318
 
.PP
4319
 
.RS 4
4320
 
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\&.
4321
 
.sp
4322
 
Default:
4323
 
\fI\fIinherit acls\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4324
 
.RE
4325
 
 
4326
 
inherit owner (S)
4327
 
.\" inherit owner
4328
 
.PP
4329
 
.RS 4
4330
 
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\&.
4331
 
.sp
4332
 
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\&.
4333
 
.sp
4334
 
Default:
4335
 
\fI\fIinherit owner\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4336
 
.RE
4337
 
 
4338
 
inherit permissions (S)
4339
 
.\" inherit permissions
4340
 
.PP
4341
 
.RS 4
4342
 
The permissions on new files and directories are normally governed by
4343
 
\m[blue]\fBcreate mask\fR\m[],
4344
 
\m[blue]\fBdirectory mask\fR\m[],
4345
 
\m[blue]\fBforce create mode\fR\m[]
4346
 
and
4347
 
\m[blue]\fBforce directory mode\fR\m[]
4348
 
but the boolean inherit permissions parameter overrides this\&.
4349
 
.sp
4350
 
New directories inherit the mode of the parent directory, including bits such as setgid\&.
4351
 
.sp
4352
 
New files inherit their read/write bits from the parent directory\&. Their execute bits continue to be determined by
4353
 
\m[blue]\fBmap archive\fR\m[],
4354
 
\m[blue]\fBmap hidden\fR\m[]
4355
 
and
4356
 
\m[blue]\fBmap system\fR\m[]
4357
 
as usual\&.
4358
 
.sp
4359
 
Note that the setuid bit is
4360
 
\fInever\fR
4361
 
set via inheritance (the code explicitly prohibits this)\&.
4362
 
.sp
4363
 
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\&.
4364
 
.sp
4365
 
Default:
4366
 
\fI\fIinherit permissions\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4367
 
.RE
4368
 
 
4369
 
init logon delayed hosts (G)
4370
 
.\" init logon delayed hosts
4371
 
.PP
4372
 
.RS 4
4373
 
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)\&.
4374
 
.sp
4375
 
The length of the delay can be specified with the
4376
 
\m[blue]\fBinit logon delay\fR\m[]
4377
 
parameter\&.
4378
 
.sp
4379
 
Default:
4380
 
\fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4381
 
.sp
4382
 
Example:
4383
 
\fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI\FC150\&.203\&.5\&. myhost\&.mynet\&.de\F[]\fR\fI \fR
4384
 
.RE
4385
 
 
4386
 
init logon delay (G)
4387
 
.\" init logon delay
4388
 
.PP
4389
 
.RS 4
4390
 
This parameter specifies a delay in milliseconds for the hosts configured for delayed initial samlogon with
4391
 
\m[blue]\fBinit logon delayed hosts\fR\m[]\&.
4392
 
.sp
4393
 
Default:
4394
 
\fI\fIinit logon delay\fR\fR\fI = \fR\fI\FC100\F[]\fR\fI \fR
4395
 
.RE
4396
 
 
4397
 
interfaces (G)
4398
 
.\" interfaces
4399
 
.PP
4400
 
.RS 4
4401
 
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\&.
4402
 
.sp
4403
 
The option takes a list of interface strings\&. Each string can be in any of the following forms:
4404
 
.sp
4405
 
.RS 4
4406
 
.ie n \{\
4407
 
\h'-04'\(bu\h'+03'\c
4408
 
.\}
4409
 
.el \{\
4410
 
.sp -1
4411
 
.IP \(bu 2.3
4412
 
.\}
4413
 
a network interface name (such as eth0)\&. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth"
4414
 
.RE
4415
 
.sp
4416
 
.RS 4
4417
 
.ie n \{\
4418
 
\h'-04'\(bu\h'+03'\c
4419
 
.\}
4420
 
.el \{\
4421
 
.sp -1
4422
 
.IP \(bu 2.3
4423
 
.\}
4424
 
an IP address\&. In this case the netmask is determined from the list of interfaces obtained from the kernel
4425
 
.RE
4426
 
.sp
4427
 
.RS 4
4428
 
.ie n \{\
4429
 
\h'-04'\(bu\h'+03'\c
4430
 
.\}
4431
 
.el \{\
4432
 
.sp -1
4433
 
.IP \(bu 2.3
4434
 
.\}
4435
 
an IP/mask pair\&.
4436
 
.RE
4437
 
.sp
4438
 
.RS 4
4439
 
.ie n \{\
4440
 
\h'-04'\(bu\h'+03'\c
4441
 
.\}
4442
 
.el \{\
4443
 
.sp -1
4444
 
.IP \(bu 2.3
4445
 
.\}
4446
 
a broadcast/mask pair\&.
4447
 
.sp
4448
 
.RE
4449
 
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\&.
4450
 
.sp
4451
 
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\&.
4452
 
.sp
4453
 
By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\&.0\&.0\&.1)\&.
4454
 
.sp
4455
 
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\&.
4456
 
.sp
4457
 
Default:
4458
 
\fI\fIinterfaces\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4459
 
.sp
4460
 
Example:
4461
 
\fI\fIinterfaces\fR\fR\fI = \fR\fI\FCeth0 192\&.168\&.2\&.10/24 192\&.168\&.3\&.10/255\&.255\&.255\&.0\F[]\fR\fI \fR
4462
 
.RE
4463
 
 
4464
 
invalid users (S)
4465
 
.\" invalid users
4466
 
.PP
4467
 
.RS 4
4468
 
This is a list of users that should not be allowed to login to this service\&. This is really a
4469
 
\fIparanoid\fR
4470
 
check to absolutely ensure an improper setting does not breach your security\&.
4471
 
.sp
4472
 
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\&.
4473
 
.sp
4474
 
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
4475
 
\fI+&group\fR
4476
 
means check the UNIX group database, followed by the NIS netgroup database, and the value
4477
 
\fI&+group\fR
4478
 
means check the NIS netgroup database, followed by the UNIX group database (the same as the \'@\' prefix)\&.
4479
 
.sp
4480
 
The current servicename is substituted for
4481
 
\fI%S\fR\&. This is useful in the [homes] section\&.
4482
 
.sp
4483
 
Default:
4484
 
\fI\fIinvalid users\fR\fR\fI = \fR\fI\FC # no invalid users\F[]\fR\fI \fR
4485
 
.sp
4486
 
Example:
4487
 
\fI\fIinvalid users\fR\fR\fI = \fR\fI\FCroot fred admin @wheel\F[]\fR\fI \fR
4488
 
.RE
4489
 
 
4490
 
iprint server (G)
4491
 
.\" iprint server
4492
 
.PP
4493
 
.RS 4
4494
 
This parameter is only applicable if
4495
 
\m[blue]\fBprinting\fR\m[]
4496
 
is set to
4497
 
\fBiprint\fR\&.
4498
 
.sp
4499
 
If set, this option overrides the ServerName option in the CUPS
4500
 
\FCclient\&.conf\F[]\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
4501
 
.sp
4502
 
Default:
4503
 
\fI\fIiprint server\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
4504
 
.sp
4505
 
Example:
4506
 
\fI\fIiprint server\fR\fR\fI = \fR\fI\FCMYCUPSSERVER\F[]\fR\fI \fR
4507
 
.RE
4508
 
 
4509
 
keepalive (G)
4510
 
.\" keepalive
4511
 
.PP
4512
 
.RS 4
4513
 
The value of the parameter (an integer) represents the number of seconds between
4514
 
\fIkeepalive\fR
4515
 
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\&.
4516
 
.sp
4517
 
Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\&. (see
4518
 
\m[blue]\fBsocket options\fR\m[])\&. Basically you should only use this option if you strike difficulties\&.
4519
 
.sp
4520
 
Default:
4521
 
\fI\fIkeepalive\fR\fR\fI = \fR\fI\FC300\F[]\fR\fI \fR
4522
 
.sp
4523
 
Example:
4524
 
\fI\fIkeepalive\fR\fR\fI = \fR\fI\FC600\F[]\fR\fI \fR
4525
 
.RE
4526
 
 
4527
 
kerberos method (G)
4528
 
.\" kerberos method
4529
 
.PP
4530
 
.RS 4
4531
 
Controls how kerberos tickets are verified\&.
4532
 
.sp
4533
 
Valid options are:
4534
 
.sp
4535
 
.RS 4
4536
 
.ie n \{\
4537
 
\h'-04'\(bu\h'+03'\c
4538
 
.\}
4539
 
.el \{\
4540
 
.sp -1
4541
 
.IP \(bu 2.3
4542
 
.\}
4543
 
secrets only \- use only the secrets\&.tdb for ticket verification (default)
4544
 
.RE
4545
 
.sp
4546
 
.RS 4
4547
 
.ie n \{\
4548
 
\h'-04'\(bu\h'+03'\c
4549
 
.\}
4550
 
.el \{\
4551
 
.sp -1
4552
 
.IP \(bu 2.3
4553
 
.\}
4554
 
system keytab \- use only the system keytab for ticket verification
4555
 
.RE
4556
 
.sp
4557
 
.RS 4
4558
 
.ie n \{\
4559
 
\h'-04'\(bu\h'+03'\c
4560
 
.\}
4561
 
.el \{\
4562
 
.sp -1
4563
 
.IP \(bu 2.3
4564
 
.\}
4565
 
dedicated keytab \- use a dedicated keytab for ticket verification
4566
 
.RE
4567
 
.sp
4568
 
.RS 4
4569
 
.ie n \{\
4570
 
\h'-04'\(bu\h'+03'\c
4571
 
.\}
4572
 
.el \{\
4573
 
.sp -1
4574
 
.IP \(bu 2.3
4575
 
.\}
4576
 
secrets and keytab \- use the secrets\&.tdb first, then the system keytab
4577
 
.sp
4578
 
.RE
4579
 
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\&.
4580
 
.sp
4581
 
When the kerberos method is in "dedicated keytab" mode,
4582
 
\m[blue]\fBdedicated keytab file\fR\m[]
4583
 
must be set to specify the location of the keytab file\&.
4584
 
.sp
4585
 
Default:
4586
 
\fI\fIkerberos method\fR\fR\fI = \fR\fI\FCsecrets only\F[]\fR\fI \fR
4587
 
.RE
4588
 
 
4589
 
kernel change notify (S)
4590
 
.\" kernel change notify
4591
 
.PP
4592
 
.RS 4
4593
 
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\&.
4594
 
.sp
4595
 
This parameter is only used when your kernel supports change notification to user programs using the inotify interface\&.
4596
 
.sp
4597
 
Default:
4598
 
\fI\fIkernel change notify\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
4599
 
.RE
4600
 
 
4601
 
kernel oplocks (G)
4602
 
.\" kernel oplocks
4603
 
.PP
4604
 
.RS 4
4605
 
For UNIXes that support kernel based
4606
 
\m[blue]\fBoplocks\fR\m[]
4607
 
(currently only IRIX and the Linux 2\&.4 kernel), this parameter allows the use of them to be turned on or off\&.
4608
 
.sp
4609
 
Kernel oplocks support allows Samba
4610
 
\fIoplocks \fR
4611
 
to be broken whenever a local UNIX process or NFS operation accesses a file that
4612
 
\fBsmbd\fR(8)
4613
 
has oplocked\&. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a
4614
 
\fIvery\fR
4615
 
cool feature :\-)\&.
4616
 
.sp
4617
 
This parameter defaults to
4618
 
\fBon\fR, 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\&.
4619
 
.sp
4620
 
Default:
4621
 
\fI\fIkernel oplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
4622
 
.RE
4623
 
 
4624
 
lanman auth (G)
4625
 
.\" lanman auth
4626
 
.PP
4627
 
.RS 4
4628
 
This parameter determines whether or not
4629
 
\fBsmbd\fR(8)
4630
 
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\&.
4631
 
.sp
4632
 
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\&.
4633
 
.sp
4634
 
Unlike the
4635
 
\FCencrypt passwords\F[]
4636
 
option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\&. See the
4637
 
\FCclient lanman auth\F[]
4638
 
to disable this for Samba\'s clients (such as smbclient)
4639
 
.sp
4640
 
If this option, and
4641
 
\FCntlm auth\F[]
4642
 
are both disabled, then only NTLMv2 logins will be permited\&. Not all clients support NTLMv2, and most will require special configuration to use it\&.
4643
 
.sp
4644
 
Default:
4645
 
\fI\fIlanman auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4646
 
.RE
4647
 
 
4648
 
large readwrite (G)
4649
 
.\" large readwrite
4650
 
.PP
4651
 
.RS 4
4652
 
This parameter determines whether or not
4653
 
\fBsmbd\fR(8)
4654
 
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\&.
4655
 
.sp
4656
 
Default:
4657
 
\fI\fIlarge readwrite\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
4658
 
.RE
4659
 
 
4660
 
ldap admin dn (G)
4661
 
.\" ldap admin dn
4662
 
.PP
4663
 
.RS 4
4664
 
The
4665
 
\m[blue]\fBldap admin dn\fR\m[]
4666
 
defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information\&. The
4667
 
\m[blue]\fBldap admin dn\fR\m[]
4668
 
is used in conjunction with the admin dn password stored in the
4669
 
\FCprivate/secrets\&.tdb\F[]
4670
 
file\&. See the
4671
 
\fBsmbpasswd\fR(8)
4672
 
man page for more information on how to accomplish this\&.
4673
 
.sp
4674
 
The
4675
 
\m[blue]\fBldap admin dn\fR\m[]
4676
 
requires a fully specified DN\&. The
4677
 
\m[blue]\fBldap suffix\fR\m[]
4678
 
is not appended to the
4679
 
\m[blue]\fBldap admin dn\fR\m[]\&.
4680
 
.sp
4681
 
\fINo default\fR
4682
 
.RE
4683
 
 
4684
 
ldap connection timeout (G)
4685
 
.\" ldap connection timeout
4686
 
.PP
4687
 
.RS 4
4688
 
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\&.
4689
 
.sp
4690
 
This parameter is different from
4691
 
\m[blue]\fBldap timeout\fR\m[]
4692
 
which affects operations on LDAP servers using an existing connection and not establishing an initial connection\&.
4693
 
.sp
4694
 
Default:
4695
 
\fI\fIldap connection timeout\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
4696
 
.RE
4697
 
 
4698
 
ldap debug level (G)
4699
 
.\" ldap debug level
4700
 
.PP
4701
 
.RS 4
4702
 
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
4703
 
\fBslapd.conf\fR(5)
4704
 
manpage\&. A typical useful value will be
4705
 
\fI1\fR
4706
 
for tracing function calls\&.
4707
 
.sp
4708
 
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
4709
 
\fIldap debug threshold\fR\&.
4710
 
.sp
4711
 
Default:
4712
 
\fI\fIldap debug level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
4713
 
.sp
4714
 
Example:
4715
 
\fI\fIldap debug level\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
4716
 
.RE
4717
 
 
4718
 
ldap debug threshold (G)
4719
 
.\" ldap debug threshold
4720
 
.PP
4721
 
.RS 4
4722
 
This parameter controls the Samba debug level at which the ldap library debug output is printed in the Samba logs\&. See the description of
4723
 
\fIldap debug level\fR
4724
 
for details\&.
4725
 
.sp
4726
 
Default:
4727
 
\fI\fIldap debug threshold\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
4728
 
.sp
4729
 
Example:
4730
 
\fI\fIldap debug threshold\fR\fR\fI = \fR\fI\FC5\F[]\fR\fI \fR
4731
 
.RE
4732
 
 
4733
 
ldap delete dn (G)
4734
 
.\" ldap delete dn
4735
 
.PP
4736
 
.RS 4
4737
 
This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\&.
4738
 
.sp
4739
 
Default:
4740
 
\fI\fIldap delete dn\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4741
 
.RE
4742
 
 
4743
 
ldap group suffix (G)
4744
 
.\" ldap group suffix
4745
 
.PP
4746
 
.RS 4
4747
 
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
4748
 
\m[blue]\fBldap suffix\fR\m[]
4749
 
will be used instead\&. The suffix string is pre\-pended to the
4750
 
\m[blue]\fBldap suffix\fR\m[]
4751
 
string so use a partial DN\&.
4752
 
.sp
4753
 
Default:
4754
 
\fI\fIldap group suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4755
 
.sp
4756
 
Example:
4757
 
\fI\fIldap group suffix\fR\fR\fI = \fR\fI\FCou=Groups\F[]\fR\fI \fR
4758
 
.RE
4759
 
 
4760
 
ldap idmap suffix (G)
4761
 
.\" ldap idmap suffix
4762
 
.PP
4763
 
.RS 4
4764
 
This parameters specifies the suffix that is used when storing idmap mappings\&. If this parameter is unset, the value of
4765
 
\m[blue]\fBldap suffix\fR\m[]
4766
 
will be used instead\&. The suffix string is pre\-pended to the
4767
 
\m[blue]\fBldap suffix\fR\m[]
4768
 
string so use a partial DN\&.
4769
 
.sp
4770
 
Default:
4771
 
\fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4772
 
.sp
4773
 
Example:
4774
 
\fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\FCou=Idmap\F[]\fR\fI \fR
4775
 
.RE
4776
 
 
4777
 
ldap machine suffix (G)
4778
 
.\" ldap machine suffix
4779
 
.PP
4780
 
.RS 4
4781
 
It specifies where machines should be added to the ldap tree\&. If this parameter is unset, the value of
4782
 
\m[blue]\fBldap suffix\fR\m[]
4783
 
will be used instead\&. The suffix string is pre\-pended to the
4784
 
\m[blue]\fBldap suffix\fR\m[]
4785
 
string so use a partial DN\&.
4786
 
.sp
4787
 
Default:
4788
 
\fI\fIldap machine suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
4789
 
.sp
4790
 
Example:
4791
 
\fI\fIldap machine suffix\fR\fR\fI = \fR\fI\FCou=Computers\F[]\fR\fI \fR
4792
 
.RE
4793
 
 
4794
 
ldap passwd sync (G)
4795
 
.\" ldap passwd sync
4796
 
.PP
4797
 
.RS 4
4798
 
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\&.
4799
 
.sp
4800
 
The
4801
 
\m[blue]\fBldap passwd sync\fR\m[]
4802
 
can be set to one of three values:
4803
 
.sp
4804
 
.RS 4
4805
 
.ie n \{\
4806
 
\h'-04'\(bu\h'+03'\c
4807
 
.\}
4808
 
.el \{\
4809
 
.sp -1
4810
 
.IP \(bu 2.3
4811
 
.\}
4812
 
\fIYes\fR
4813
 
= Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\&.
4814
 
.RE
4815
 
.sp
4816
 
.RS 4
4817
 
.ie n \{\
4818
 
\h'-04'\(bu\h'+03'\c
4819
 
.\}
4820
 
.el \{\
4821
 
.sp -1
4822
 
.IP \(bu 2.3
4823
 
.\}
4824
 
\fINo\fR
4825
 
= Update NT and LM passwords and update the pwdLastSet time\&.
4826
 
.RE
4827
 
.sp
4828
 
.RS 4
4829
 
.ie n \{\
4830
 
\h'-04'\(bu\h'+03'\c
4831
 
.\}
4832
 
.el \{\
4833
 
.sp -1
4834
 
.IP \(bu 2.3
4835
 
.\}
4836
 
\fIOnly\fR
4837
 
= Only update the LDAP password and let the LDAP server do the rest\&.
4838
 
.sp
4839
 
.RE
4840
 
Default:
4841
 
\fI\fIldap passwd sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4842
 
.RE
4843
 
 
4844
 
ldap replication sleep (G)
4845
 
.\" ldap replication sleep
4846
 
.PP
4847
 
.RS 4
4848
 
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\&.
4849
 
.sp
4850
 
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\&.
4851
 
.sp
4852
 
The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\&.
4853
 
.sp
4854
 
Default:
4855
 
\fI\fIldap replication sleep\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
4856
 
.RE
4857
 
 
4858
 
ldapsam:editposix (G)
4859
 
.\" ldapsam:editposix
4860
 
.PP
4861
 
.RS 4
4862
 
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\&.
4863
 
.sp
4864
 
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
4865
 
\FCnet sam provision\F[]\&. 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
4866
 
\m[blue]\fBldapsam:trusted = yes\fR\m[]
4867
 
option is usually sufficient to use
4868
 
\m[blue]\fBldapsam:editposix = yes\fR\m[]
4869
 
as well\&.
4870
 
.sp
4871
 
An example configuration can be the following:
4872
 
.sp
4873
 
.if n \{\
4874
 
.RS 4
4875
 
.\}
4876
 
.fam C
4877
 
.ps -1
4878
 
.nf
4879
 
.if t \{\
4880
 
.sp -1
4881
 
.\}
4882
 
.BB lightgray adjust-for-leading-newline
4883
 
.sp -1
4884
 
 
4885
 
        encrypt passwords = true
4886
 
        passdb backend = ldapsam
4887
 
 
4888
 
        ldapsam:trusted=yes
4889
 
        ldapsam:editposix=yes
4890
 
 
4891
 
        ldap admin dn = cn=admin,dc=samba,dc=org
4892
 
        ldap delete dn = yes
4893
 
        ldap group suffix = ou=groups
4894
 
        ldap idmap suffix = ou=idmap
4895
 
        ldap machine suffix = ou=computers
4896
 
        ldap user suffix = ou=users
4897
 
        ldap suffix = dc=samba,dc=org
4898
 
 
4899
 
        idmap backend = ldap:"ldap://localhost"
4900
 
 
4901
 
        idmap uid = 5000\-50000
4902
 
        idmap gid = 5000\-50000
4903
 
        
4904
 
.EB lightgray adjust-for-leading-newline
4905
 
.if t \{\
4906
 
.sp 1
4907
 
.\}
4908
 
.fi
4909
 
.fam
4910
 
.ps +1
4911
 
.if n \{\
4912
 
.RE
4913
 
.\}
4914
 
.sp
4915
 
This configuration assumes a directory layout like described in the following ldif:
4916
 
.sp
4917
 
.if n \{\
4918
 
.RS 4
4919
 
.\}
4920
 
.fam C
4921
 
.ps -1
4922
 
.nf
4923
 
.if t \{\
4924
 
.sp -1
4925
 
.\}
4926
 
.BB lightgray adjust-for-leading-newline
4927
 
.sp -1
4928
 
 
4929
 
        dn: dc=samba,dc=org
4930
 
        objectClass: top
4931
 
        objectClass: dcObject
4932
 
        objectClass: organization
4933
 
        o: samba\&.org
4934
 
        dc: samba
4935
 
 
4936
 
        dn: cn=admin,dc=samba,dc=org
4937
 
        objectClass: simpleSecurityObject
4938
 
        objectClass: organizationalRole
4939
 
        cn: admin
4940
 
        description: LDAP administrator
4941
 
        userPassword: secret
4942
 
 
4943
 
        dn: ou=users,dc=samba,dc=org
4944
 
        objectClass: top
4945
 
        objectClass: organizationalUnit
4946
 
        ou: users
4947
 
 
4948
 
        dn: ou=groups,dc=samba,dc=org
4949
 
        objectClass: top
4950
 
        objectClass: organizationalUnit
4951
 
        ou: groups
4952
 
 
4953
 
        dn: ou=idmap,dc=samba,dc=org
4954
 
        objectClass: top
4955
 
        objectClass: organizationalUnit
4956
 
        ou: idmap
4957
 
 
4958
 
        dn: ou=computers,dc=samba,dc=org
4959
 
        objectClass: top
4960
 
        objectClass: organizationalUnit
4961
 
        ou: computers
4962
 
        
4963
 
.EB lightgray adjust-for-leading-newline
4964
 
.if t \{\
4965
 
.sp 1
4966
 
.\}
4967
 
.fi
4968
 
.fam
4969
 
.ps +1
4970
 
.if n \{\
4971
 
.RE
4972
 
.\}
4973
 
.sp
4974
 
Default:
4975
 
\fI\fIldapsam:editposix\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4976
 
.RE
4977
 
 
4978
 
ldapsam:trusted (G)
4979
 
.\" ldapsam:trusted
4980
 
.PP
4981
 
.RS 4
4982
 
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\&.
4983
 
.sp
4984
 
To make Samba scale well in large environments, the
4985
 
\m[blue]\fBldapsam:trusted = yes\fR\m[]
4986
 
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,
4987
 
\m[blue]\fBldapsam:trusted = yes\fR\m[]
4988
 
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\&.
4989
 
.sp
4990
 
Default:
4991
 
\fI\fIldapsam:trusted\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
4992
 
.RE
4993
 
 
4994
 
ldap ssl ads (G)
4995
 
.\" ldap ssl ads
4996
 
.PP
4997
 
.RS 4
4998
 
This option is used to define whether or not Samba should use SSL when connecting to the ldap server using
4999
 
\fIads\fR
5000
 
methods\&. Rpc methods are not affected by this parameter\&. Please note, that this parameter won\'t have any effect if
5001
 
\m[blue]\fBldap ssl\fR\m[]
5002
 
is set to
5003
 
\fIno\fR\&.
5004
 
.sp
5005
 
See
5006
 
smb\&.conf(5)
5007
 
for more information on
5008
 
\m[blue]\fBldap ssl\fR\m[]\&.
5009
 
.sp
5010
 
Default:
5011
 
\fI\fIldap ssl ads\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
5012
 
.RE
5013
 
 
5014
 
ldap ssl (G)
5015
 
.\" ldap ssl
5016
 
.PP
5017
 
.RS 4
5018
 
This option is used to define whether or not Samba should use SSL when connecting to the ldap server This is
5019
 
\fINOT\fR
5020
 
related to Samba\'s previous SSL support which was enabled by specifying the
5021
 
\FC\-\-with\-ssl\F[]
5022
 
option to the
5023
 
\FCconfigure\F[]
5024
 
script\&.
5025
 
.sp
5026
 
LDAP connections should be secured where possible\&. This may be done setting
5027
 
\fIeither\fR
5028
 
this parameter to
5029
 
\fIStart_tls\fR
5030
 
\fIor\fR
5031
 
by specifying
5032
 
\fIldaps://\fR
5033
 
in the URL argument of
5034
 
\m[blue]\fBpassdb backend\fR\m[]\&.
5035
 
.sp
5036
 
The
5037
 
\m[blue]\fBldap ssl\fR\m[]
5038
 
can be set to one of two values:
5039
 
.sp
5040
 
.RS 4
5041
 
.ie n \{\
5042
 
\h'-04'\(bu\h'+03'\c
5043
 
.\}
5044
 
.el \{\
5045
 
.sp -1
5046
 
.IP \(bu 2.3
5047
 
.\}
5048
 
\fIOff\fR
5049
 
= Never use SSL when querying the directory\&.
5050
 
.RE
5051
 
.sp
5052
 
.RS 4
5053
 
.ie n \{\
5054
 
\h'-04'\(bu\h'+03'\c
5055
 
.\}
5056
 
.el \{\
5057
 
.sp -1
5058
 
.IP \(bu 2.3
5059
 
.\}
5060
 
\fIstart tls\fR
5061
 
= Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\&.
5062
 
.sp
5063
 
.RE
5064
 
Please note that this parameter does only affect
5065
 
\fIrpc\fR
5066
 
methods\&. To enable the LDAPv3 StartTLS extended operation (RFC2830) for
5067
 
\fIads\fR, set
5068
 
\m[blue]\fBldap ssl = yes\fR\m[]
5069
 
\fIand\fR
5070
 
\m[blue]\fBldap ssl ads = yes\fR\m[]\&. See
5071
 
smb\&.conf(5)
5072
 
for more information on
5073
 
\m[blue]\fBldap ssl ads\fR\m[]\&.
5074
 
.sp
5075
 
Default:
5076
 
\fI\fIldap ssl\fR\fR\fI = \fR\fI\FCstart tls\F[]\fR\fI \fR
5077
 
.RE
5078
 
 
5079
 
ldap suffix (G)
5080
 
.\" ldap suffix
5081
 
.PP
5082
 
.RS 4
5083
 
Specifies the base for all ldap suffixes and for storing the sambaDomain object\&.
5084
 
.sp
5085
 
The ldap suffix will be appended to the values specified for the
5086
 
\m[blue]\fBldap user suffix\fR\m[],
5087
 
\m[blue]\fBldap group suffix\fR\m[],
5088
 
\m[blue]\fBldap machine suffix\fR\m[], and the
5089
 
\m[blue]\fBldap idmap suffix\fR\m[]\&. Each of these should be given only a DN relative to the
5090
 
\m[blue]\fBldap suffix\fR\m[]\&.
5091
 
.sp
5092
 
Default:
5093
 
\fI\fIldap suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
5094
 
.sp
5095
 
Example:
5096
 
\fI\fIldap suffix\fR\fR\fI = \fR\fI\FCdc=samba,dc=org\F[]\fR\fI \fR
5097
 
.RE
5098
 
 
5099
 
ldap timeout (G)
5100
 
.\" ldap timeout
5101
 
.PP
5102
 
.RS 4
5103
 
This parameter defines the number of seconds that Samba should use as timeout for LDAP operations\&.
5104
 
.sp
5105
 
Default:
5106
 
\fI\fIldap timeout\fR\fR\fI = \fR\fI\FC15\F[]\fR\fI \fR
5107
 
.RE
5108
 
 
5109
 
ldap user suffix (G)
5110
 
.\" ldap user suffix
5111
 
.PP
5112
 
.RS 4
5113
 
This parameter specifies where users are added to the tree\&. If this parameter is unset, the value of
5114
 
\m[blue]\fBldap suffix\fR\m[]
5115
 
will be used instead\&. The suffix string is pre\-pended to the
5116
 
\m[blue]\fBldap suffix\fR\m[]
5117
 
string so use a partial DN\&.
5118
 
.sp
5119
 
Default:
5120
 
\fI\fIldap user suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
5121
 
.sp
5122
 
Example:
5123
 
\fI\fIldap user suffix\fR\fR\fI = \fR\fI\FCou=people\F[]\fR\fI \fR
5124
 
.RE
5125
 
 
5126
 
level2 oplocks (S)
5127
 
.\" level2 oplocks
5128
 
.PP
5129
 
.RS 4
5130
 
This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\&.
5131
 
.sp
5132
 
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)\&.
5133
 
.sp
5134
 
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\&.
5135
 
.sp
5136
 
It is recommended that this parameter be turned on to speed access to shared executables\&.
5137
 
.sp
5138
 
For more discussions on level2 oplocks see the CIFS spec\&.
5139
 
.sp
5140
 
Currently, if
5141
 
\m[blue]\fBkernel oplocks\fR\m[]
5142
 
are supported then level2 oplocks are not granted (even if this parameter is set to
5143
 
\fByes\fR)\&. Note also, the
5144
 
\m[blue]\fBoplocks\fR\m[]
5145
 
parameter must be set to
5146
 
\fByes\fR
5147
 
on this share in order for this parameter to have any effect\&.
5148
 
.sp
5149
 
Default:
5150
 
\fI\fIlevel2 oplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
5151
 
.RE
5152
 
 
5153
 
lm announce (G)
5154
 
.\" lm announce
5155
 
.PP
5156
 
.RS 4
5157
 
This parameter determines if
5158
 
\fBnmbd\fR(8)
5159
 
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,
5160
 
\fByes\fR,
5161
 
\fBno\fR, or
5162
 
\fBauto\fR\&. The default is
5163
 
\fBauto\fR\&. If set to
5164
 
\fBno\fR
5165
 
Samba will never produce these broadcasts\&. If set to
5166
 
\fByes\fR
5167
 
Samba will produce Lanman announce broadcasts at a frequency set by the parameter
5168
 
\m[blue]\fBlm interval\fR\m[]\&. If set to
5169
 
\fBauto\fR
5170
 
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
5171
 
\m[blue]\fBlm interval\fR\m[]\&.
5172
 
.sp
5173
 
Default:
5174
 
\fI\fIlm announce\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
5175
 
.sp
5176
 
Example:
5177
 
\fI\fIlm announce\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
5178
 
.RE
5179
 
 
5180
 
lm interval (G)
5181
 
.\" lm interval
5182
 
.PP
5183
 
.RS 4
5184
 
If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the
5185
 
\m[blue]\fBlm announce\fR\m[]
5186
 
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
5187
 
\m[blue]\fBlm announce\fR\m[]
5188
 
parameter\&.
5189
 
.sp
5190
 
Default:
5191
 
\fI\fIlm interval\fR\fR\fI = \fR\fI\FC60\F[]\fR\fI \fR
5192
 
.sp
5193
 
Example:
5194
 
\fI\fIlm interval\fR\fR\fI = \fR\fI\FC120\F[]\fR\fI \fR
5195
 
.RE
5196
 
 
5197
 
load printers (G)
5198
 
.\" load printers
5199
 
.PP
5200
 
.RS 4
5201
 
A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\&. See the
5202
 
\m[blue]\fBprinters\fR\m[]
5203
 
section for more details\&.
5204
 
.sp
5205
 
Default:
5206
 
\fI\fIload printers\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
5207
 
.RE
5208
 
 
5209
 
local master (G)
5210
 
.\" local master
5211
 
.PP
5212
 
.RS 4
5213
 
This option allows
5214
 
\fBnmbd\fR(8)
5215
 
to try and become a local master browser on a subnet\&. If set to
5216
 
\fBno\fR
5217
 
then
5218
 
\FC nmbd\F[]
5219
 
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
5220
 
\fByes\fR\&. Setting this value to
5221
 
\fByes\fR
5222
 
doesn\'t mean that Samba will
5223
 
\fIbecome\fR
5224
 
the local master browser on a subnet, just that
5225
 
\FCnmbd\F[]
5226
 
will
5227
 
\fIparticipate\fR
5228
 
in elections for local master browser\&.
5229
 
.sp
5230
 
Setting this value to
5231
 
\fBno\fR
5232
 
will cause
5233
 
\FCnmbd\F[]
5234
 
\fInever\fR
5235
 
to become a local master browser\&.
5236
 
.sp
5237
 
Default:
5238
 
\fI\fIlocal master\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
5239
 
.RE
5240
 
 
5241
 
lock dir
5242
 
.\" lock dir
5243
 
.PP
5244
 
.RS 4
5245
 
This parameter is a synonym for
5246
 
lock directory\&.
5247
 
.RE
5248
 
 
5249
 
lock directory (G)
5250
 
.\" lock directory
5251
 
.PP
5252
 
.RS 4
5253
 
This option specifies the directory where lock files will be placed\&. The lock files are used to implement the
5254
 
\m[blue]\fBmax connections\fR\m[]
5255
 
option\&.
5256
 
.sp
5257
 
Note: This option can not be set inside registry configurations\&.
5258
 
.sp
5259
 
Default:
5260
 
\fI\fIlock directory\fR\fR\fI = \fR\fI\FC${prefix}/var/locks\F[]\fR\fI \fR
5261
 
.sp
5262
 
Example:
5263
 
\fI\fIlock directory\fR\fR\fI = \fR\fI\FC/var/run/samba/locks\F[]\fR\fI \fR
5264
 
.RE
5265
 
 
5266
 
locking (S)
5267
 
.\" locking
5268
 
.PP
5269
 
.RS 4
5270
 
This controls whether or not locking will be performed by the server in response to lock requests from the client\&.
5271
 
.sp
5272
 
If
5273
 
\FClocking = no\F[], all lock and unlock requests will appear to succeed and all lock queries will report that the file in question is available for locking\&.
5274
 
.sp
5275
 
If
5276
 
\FClocking = yes\F[], real locking will be performed by the server\&.
5277
 
.sp
5278
 
This option
5279
 
\fImay\fR
5280
 
be useful for read\-only filesystems which
5281
 
\fImay\fR
5282
 
not need locking (such as CDROM drives), although setting this parameter of
5283
 
\fBno\fR
5284
 
is not really recommended even in this case\&.
5285
 
.sp
5286
 
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\&.
5287
 
.sp
5288
 
\fINo default\fR
5289
 
.RE
5290
 
 
5291
 
lock spin count (G)
5292
 
.\" lock spin count
5293
 
.PP
5294
 
.RS 4
5295
 
This parameter has been made inoperative in Samba 3\&.0\&.24\&. The functionality it contolled is now controlled by the parameter
5296
 
\m[blue]\fBlock spin time\fR\m[]\&.
5297
 
.sp
5298
 
Default:
5299
 
\fI\fIlock spin count\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
5300
 
.RE
5301
 
 
5302
 
lock spin time (G)
5303
 
.\" lock spin time
5304
 
.PP
5305
 
.RS 4
5306
 
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
5307
 
\m[blue]\fBlock spin count\fR\m[]
5308
 
parameter is no longer used in Samba 3\&.0\&.24\&. You should not need to change the value of this parameter\&.
5309
 
.sp
5310
 
Default:
5311
 
\fI\fIlock spin time\fR\fR\fI = \fR\fI\FC200\F[]\fR\fI \fR
5312
 
.RE
5313
 
 
5314
 
log file (G)
5315
 
.\" log file
5316
 
.PP
5317
 
.RS 4
5318
 
This option allows you to override the name of the Samba log file (also known as the debug file)\&.
5319
 
.sp
5320
 
This option takes the standard substitutions, allowing you to have separate log files for each user or machine\&.
5321
 
.sp
5322
 
\fINo default\fR
5323
 
.sp
5324
 
Example:
5325
 
\fI\fIlog file\fR\fR\fI = \fR\fI\FC/usr/local/samba/var/log\&.%m\F[]\fR\fI \fR
5326
 
.RE
5327
 
 
5328
 
debuglevel
5329
 
.\" debuglevel
5330
 
.PP
5331
 
.RS 4
5332
 
This parameter is a synonym for
5333
 
log level\&.
5334
 
.RE
5335
 
 
5336
 
log level (G)
5337
 
.\" log level
5338
 
.PP
5339
 
.RS 4
5340
 
The value of the parameter (a astring) allows the debug level (logging level) to be specified in the
5341
 
\FCsmb\&.conf\F[]
5342
 
file\&.
5343
 
.sp
5344
 
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:
5345
 
.sp
5346
 
.RS 4
5347
 
.ie n \{\
5348
 
\h'-04'\(bu\h'+03'\c
5349
 
.\}
5350
 
.el \{\
5351
 
.sp -1
5352
 
.IP \(bu 2.3
5353
 
.\}
5354
 
\fIall\fR
5355
 
.RE
5356
 
.sp
5357
 
.RS 4
5358
 
.ie n \{\
5359
 
\h'-04'\(bu\h'+03'\c
5360
 
.\}
5361
 
.el \{\
5362
 
.sp -1
5363
 
.IP \(bu 2.3
5364
 
.\}
5365
 
\fItdb\fR
5366
 
.RE
5367
 
.sp
5368
 
.RS 4
5369
 
.ie n \{\
5370
 
\h'-04'\(bu\h'+03'\c
5371
 
.\}
5372
 
.el \{\
5373
 
.sp -1
5374
 
.IP \(bu 2.3
5375
 
.\}
5376
 
\fIprintdrivers\fR
5377
 
.RE
5378
 
.sp
5379
 
.RS 4
5380
 
.ie n \{\
5381
 
\h'-04'\(bu\h'+03'\c
5382
 
.\}
5383
 
.el \{\
5384
 
.sp -1
5385
 
.IP \(bu 2.3
5386
 
.\}
5387
 
\fIlanman\fR
5388
 
.RE
5389
 
.sp
5390
 
.RS 4
5391
 
.ie n \{\
5392
 
\h'-04'\(bu\h'+03'\c
5393
 
.\}
5394
 
.el \{\
5395
 
.sp -1
5396
 
.IP \(bu 2.3
5397
 
.\}
5398
 
\fIsmb\fR
5399
 
.RE
5400
 
.sp
5401
 
.RS 4
5402
 
.ie n \{\
5403
 
\h'-04'\(bu\h'+03'\c
5404
 
.\}
5405
 
.el \{\
5406
 
.sp -1
5407
 
.IP \(bu 2.3
5408
 
.\}
5409
 
\fIrpc_parse\fR
5410
 
.RE
5411
 
.sp
5412
 
.RS 4
5413
 
.ie n \{\
5414
 
\h'-04'\(bu\h'+03'\c
5415
 
.\}
5416
 
.el \{\
5417
 
.sp -1
5418
 
.IP \(bu 2.3
5419
 
.\}
5420
 
\fIrpc_srv\fR
5421
 
.RE
5422
 
.sp
5423
 
.RS 4
5424
 
.ie n \{\
5425
 
\h'-04'\(bu\h'+03'\c
5426
 
.\}
5427
 
.el \{\
5428
 
.sp -1
5429
 
.IP \(bu 2.3
5430
 
.\}
5431
 
\fIrpc_cli\fR
5432
 
.RE
5433
 
.sp
5434
 
.RS 4
5435
 
.ie n \{\
5436
 
\h'-04'\(bu\h'+03'\c
5437
 
.\}
5438
 
.el \{\
5439
 
.sp -1
5440
 
.IP \(bu 2.3
5441
 
.\}
5442
 
\fIpassdb\fR
5443
 
.RE
5444
 
.sp
5445
 
.RS 4
5446
 
.ie n \{\
5447
 
\h'-04'\(bu\h'+03'\c
5448
 
.\}
5449
 
.el \{\
5450
 
.sp -1
5451
 
.IP \(bu 2.3
5452
 
.\}
5453
 
\fIsam\fR
5454
 
.RE
5455
 
.sp
5456
 
.RS 4
5457
 
.ie n \{\
5458
 
\h'-04'\(bu\h'+03'\c
5459
 
.\}
5460
 
.el \{\
5461
 
.sp -1
5462
 
.IP \(bu 2.3
5463
 
.\}
5464
 
\fIauth\fR
5465
 
.RE
5466
 
.sp
5467
 
.RS 4
5468
 
.ie n \{\
5469
 
\h'-04'\(bu\h'+03'\c
5470
 
.\}
5471
 
.el \{\
5472
 
.sp -1
5473
 
.IP \(bu 2.3
5474
 
.\}
5475
 
\fIwinbind\fR
5476
 
.RE
5477
 
.sp
5478
 
.RS 4
5479
 
.ie n \{\
5480
 
\h'-04'\(bu\h'+03'\c
5481
 
.\}
5482
 
.el \{\
5483
 
.sp -1
5484
 
.IP \(bu 2.3
5485
 
.\}
5486
 
\fIvfs\fR
5487
 
.RE
5488
 
.sp
5489
 
.RS 4
5490
 
.ie n \{\
5491
 
\h'-04'\(bu\h'+03'\c
5492
 
.\}
5493
 
.el \{\
5494
 
.sp -1
5495
 
.IP \(bu 2.3
5496
 
.\}
5497
 
\fIidmap\fR
5498
 
.RE
5499
 
.sp
5500
 
.RS 4
5501
 
.ie n \{\
5502
 
\h'-04'\(bu\h'+03'\c
5503
 
.\}
5504
 
.el \{\
5505
 
.sp -1
5506
 
.IP \(bu 2.3
5507
 
.\}
5508
 
\fIquota\fR
5509
 
.RE
5510
 
.sp
5511
 
.RS 4
5512
 
.ie n \{\
5513
 
\h'-04'\(bu\h'+03'\c
5514
 
.\}
5515
 
.el \{\
5516
 
.sp -1
5517
 
.IP \(bu 2.3
5518
 
.\}
5519
 
\fIacls\fR
5520
 
.RE
5521
 
.sp
5522
 
.RS 4
5523
 
.ie n \{\
5524
 
\h'-04'\(bu\h'+03'\c
5525
 
.\}
5526
 
.el \{\
5527
 
.sp -1
5528
 
.IP \(bu 2.3
5529
 
.\}
5530
 
\fIlocking\fR
5531
 
.RE
5532
 
.sp
5533
 
.RS 4
5534
 
.ie n \{\
5535
 
\h'-04'\(bu\h'+03'\c
5536
 
.\}
5537
 
.el \{\
5538
 
.sp -1
5539
 
.IP \(bu 2.3
5540
 
.\}
5541
 
\fImsdfs\fR
5542
 
.RE
5543
 
.sp
5544
 
.RS 4
5545
 
.ie n \{\
5546
 
\h'-04'\(bu\h'+03'\c
5547
 
.\}
5548
 
.el \{\
5549
 
.sp -1
5550
 
.IP \(bu 2.3
5551
 
.\}
5552
 
\fIdmapi\fR
5553
 
.RE
5554
 
.sp
5555
 
.RS 4
5556
 
.ie n \{\
5557
 
\h'-04'\(bu\h'+03'\c
5558
 
.\}
5559
 
.el \{\
5560
 
.sp -1
5561
 
.IP \(bu 2.3
5562
 
.\}
5563
 
\fIregistry\fR
5564
 
.sp
5565
 
.RE
5566
 
Default:
5567
 
\fI\fIlog level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
5568
 
.sp
5569
 
Example:
5570
 
\fI\fIlog level\fR\fR\fI = \fR\fI\FC3 passdb:5 auth:10 winbind:2\F[]\fR\fI \fR
5571
 
.RE
5572
 
 
5573
 
logon drive (G)
5574
 
.\" logon drive
5575
 
.PP
5576
 
.RS 4
5577
 
This parameter specifies the local path to which the home directory will be connected (see
5578
 
\m[blue]\fBlogon home\fR\m[]) and is only used by NT Workstations\&.
5579
 
.sp
5580
 
Note that this option is only useful if Samba is set up as a logon server\&.
5581
 
.sp
5582
 
Default:
5583
 
\fI\fIlogon drive\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
5584
 
.sp
5585
 
Example:
5586
 
\fI\fIlogon drive\fR\fR\fI = \fR\fI\FCh:\F[]\fR\fI \fR
5587
 
.RE
5588
 
 
5589
 
logon home (G)
5590
 
.\" logon home
5591
 
.PP
5592
 
.RS 4
5593
 
This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\&. It allows you to do
5594
 
.sp
5595
 
 
5596
 
\FCC:\e>\F[]\fBNET USE H: /HOME\fR
5597
 
.sp
5598
 
from a command prompt, for example\&.
5599
 
.sp
5600
 
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
5601
 
.sp
5602
 
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:
5603
 
.sp
5604
 
 
5605
 
\FClogon home = \e\e%N\e%U\eprofile\F[]
5606
 
.sp
5607
 
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 \e\eserver\eshare when a user does
5608
 
\FCnet use /home\F[]
5609
 
but use the whole string when dealing with profiles\&.
5610
 
.sp
5611
 
Note that in prior versions of Samba, the
5612
 
\m[blue]\fBlogon path\fR\m[]
5613
 
was returned rather than
5614
 
\fIlogon home\fR\&. This broke
5615
 
\FCnet use /home\F[]
5616
 
but allowed profiles outside the home directory\&. The current implementation is correct, and can be used for profiles if you use the above trick\&.
5617
 
.sp
5618
 
Disable this feature by setting
5619
 
\m[blue]\fBlogon home = ""\fR\m[]
5620
 
\- using the empty string\&.
5621
 
.sp
5622
 
This option is only useful if Samba is set up as a logon server\&.
5623
 
.sp
5624
 
Default:
5625
 
\fI\fIlogon home\fR\fR\fI = \fR\fI\FC\e\e%N\e%U\F[]\fR\fI \fR
5626
 
.sp
5627
 
Example:
5628
 
\fI\fIlogon home\fR\fR\fI = \fR\fI\FC\e\eremote_smb_server\e%U\F[]\fR\fI \fR
5629
 
.RE
5630
 
 
5631
 
logon path (G)
5632
 
.\" logon path
5633
 
.PP
5634
 
.RS 4
5635
 
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
5636
 
\m[blue]\fBlogon home\fR\m[]
5637
 
parameter\&.
5638
 
.sp
5639
 
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",
5640
 
\FCdesktop\F[],
5641
 
\FCstart menu\F[],
5642
 
\FCnetwork neighborhood\F[],
5643
 
\FCprograms\F[]
5644
 
and other folders, and their contents, are loaded and displayed on your Windows NT client\&.
5645
 
.sp
5646
 
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
5647
 
\fIMAN\fRdatory profile)\&.
5648
 
.sp
5649
 
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 \e\e%N\ehomes\eprofile_path will cause problems)\&.
5650
 
.sp
5651
 
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
5652
 
.if n \{\
5653
 
.sp
5654
 
.\}
5655
 
.RS 4
5656
 
.BM yellow
5657
 
.it 1 an-trap
5658
 
.nr an-no-space-flag 1
5659
 
.nr an-break-flag 1
5660
 
.br
5661
 
.ps +1
5662
 
\fBWarning\fR
5663
 
.ps -1
5664
 
.br
5665
 
Do not quote the value\&. Setting this as
5666
 
\(lq\e\e%N\eprofile\e%U\(rq
5667
 
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)\&.
5668
 
.sp .5v
5669
 
.EM yellow
5670
 
.RE
5671
 
Note that this option is only useful if Samba is set up as a domain controller\&.
5672
 
.sp
5673
 
Disable the use of roaming profiles by setting the value of this parameter to the empty string\&. For example,
5674
 
\m[blue]\fBlogon path = ""\fR\m[]\&. 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\&.
5675
 
.sp
5676
 
An example of use is:
5677
 
.sp
5678
 
.if n \{\
5679
 
.RS 4
5680
 
.\}
5681
 
.fam C
5682
 
.ps -1
5683
 
.nf
5684
 
.if t \{\
5685
 
.sp -1
5686
 
.\}
5687
 
.BB lightgray adjust-for-leading-newline
5688
 
.sp -1
5689
 
 
5690
 
logon path = \e\ePROFILESERVER\ePROFILE\e%U
5691
 
.EB lightgray adjust-for-leading-newline
5692
 
.if t \{\
5693
 
.sp 1
5694
 
.\}
5695
 
.fi
5696
 
.fam
5697
 
.ps +1
5698
 
.if n \{\
5699
 
.RE
5700
 
.\}
5701
 
.sp
5702
 
Default:
5703
 
\fI\fIlogon path\fR\fR\fI = \fR\fI\FC\e\e%N\e%U\eprofile\F[]\fR\fI \fR
5704
 
.RE
5705
 
 
5706
 
logon script (G)
5707
 
.\" logon script
5708
 
.PP
5709
 
.RS 4
5710
 
This parameter specifies the batch file (\FC\&.bat\F[]) or NT command file (\FC\&.cmd\F[]) 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\&.
5711
 
.sp
5712
 
The script must be a relative path to the
5713
 
\fI[netlogon]\fR
5714
 
service\&. If the [netlogon] service specifies a
5715
 
\m[blue]\fBpath\fR\m[]
5716
 
of
5717
 
\FC/usr/local/samba/netlogon\F[], and
5718
 
\m[blue]\fBlogon script = STARTUP\&.BAT\fR\m[], then the file that will be downloaded is:
5719
 
.sp
5720
 
.if n \{\
5721
 
.RS 4
5722
 
.\}
5723
 
.fam C
5724
 
.ps -1
5725
 
.nf
5726
 
.if t \{\
5727
 
.sp -1
5728
 
.\}
5729
 
.BB lightgray adjust-for-leading-newline
5730
 
.sp -1
5731
 
 
5732
 
        /usr/local/samba/netlogon/STARTUP\&.BAT
5733
 
.EB lightgray adjust-for-leading-newline
5734
 
.if t \{\
5735
 
.sp 1
5736
 
.\}
5737
 
.fi
5738
 
.fam
5739
 
.ps +1
5740
 
.if n \{\
5741
 
.RE
5742
 
.\}
5743
 
.sp
5744
 
The contents of the batch file are entirely your choice\&. A suggested command would be to add
5745
 
\FCNET TIME \e\eSERVER /SET /YES\F[], to force every machine to synchronize clocks with the same time server\&. Another use would be to add
5746
 
\FCNET USE U: \e\eSERVER\eUTILS\F[]
5747
 
for commonly used utilities, or
5748
 
.sp
5749
 
.if n \{\
5750
 
.RS 4
5751
 
.\}
5752
 
.fam C
5753
 
.ps -1
5754
 
.nf
5755
 
.if t \{\
5756
 
.sp -1
5757
 
.\}
5758
 
.BB lightgray adjust-for-leading-newline
5759
 
.sp -1
5760
 
 
5761
 
\fBNET USE Q: \e\eSERVER\eISO9001_QA\fR
5762
 
.EB lightgray adjust-for-leading-newline
5763
 
.if t \{\
5764
 
.sp 1
5765
 
.\}
5766
 
.fi
5767
 
.fam
5768
 
.ps +1
5769
 
.if n \{\
5770
 
.RE
5771
 
.\}
5772
 
.sp
5773
 
for example\&.
5774
 
.sp
5775
 
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\&.
5776
 
.sp
5777
 
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
5778
 
.sp
5779
 
This option is only useful if Samba is set up as a logon server\&.
5780
 
.sp
5781
 
Default:
5782
 
\fI\fIlogon script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
5783
 
.sp
5784
 
Example:
5785
 
\fI\fIlogon script\fR\fR\fI = \fR\fI\FCscripts\e%U\&.bat\F[]\fR\fI \fR
5786
 
.RE
5787
 
 
5788
 
lppause command (S)
5789
 
.\" lppause command
5790
 
.PP
5791
 
.RS 4
5792
 
This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\&.
5793
 
.sp
5794
 
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\&.
5795
 
.sp
5796
 
If a
5797
 
\fI%p\fR
5798
 
is given then the printer name is put in its place\&. A
5799
 
\fI%j\fR
5800
 
is replaced with the job number (an integer)\&. On HPUX (see
5801
 
\fIprinting=hpux \fR), if the
5802
 
\fI\-p%p\fR
5803
 
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\&.
5804
 
.sp
5805
 
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\&.
5806
 
.sp
5807
 
Default:
5808
 
\fI\fIlppause command\fR\fR\fI = \fR\fI\FC # Currently no default value is given to this string, unless the value of the \m[blue]\fBprinting\fR\m[] parameter is \fBSYSV\fR, in which case the default is : \FClp \-i %p\-%j \-H hold\F[] or if the value of the \fIprinting\fR parameter is \fBSOFTQ\fR, then the default is: \FCqstat \-s \-j%j \-h\F[]\&. \F[]\fR\fI \fR
5809
 
.sp
5810
 
Example:
5811
 
\fI\fIlppause command\fR\fR\fI = \fR\fI\FC/usr/bin/lpalt %p\-%j \-p0\F[]\fR\fI \fR
5812
 
.RE
5813
 
 
5814
 
lpq cache time (G)
5815
 
.\" lpq cache time
5816
 
.PP
5817
 
.RS 4
5818
 
This controls how long lpq info will be cached for to prevent the
5819
 
\FClpq\F[]
5820
 
command being called too often\&. A separate cache is kept for each variation of the
5821
 
\FC lpq\F[]
5822
 
command used by the system, so if you use different
5823
 
\FClpq\F[]
5824
 
commands for different users then they won\'t share cache information\&.
5825
 
.sp
5826
 
The cache files are stored in
5827
 
\FC/tmp/lpq\&.xxxx\F[]
5828
 
where xxxx is a hash of the
5829
 
\FClpq\F[]
5830
 
command in use\&.
5831
 
.sp
5832
 
The default is 30 seconds, meaning that the cached results of a previous identical
5833
 
\FClpq\F[]
5834
 
command will be used if the cached data is less than 30 seconds old\&. A large value may be advisable if your
5835
 
\FClpq\F[]
5836
 
command is very slow\&.
5837
 
.sp
5838
 
A value of 0 will disable caching completely\&.
5839
 
.sp
5840
 
Default:
5841
 
\fI\fIlpq cache time\fR\fR\fI = \fR\fI\FC30\F[]\fR\fI \fR
5842
 
.sp
5843
 
Example:
5844
 
\fI\fIlpq cache time\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
5845
 
.RE
5846
 
 
5847
 
lpq command (S)
5848
 
.\" lpq command
5849
 
.PP
5850
 
.RS 4
5851
 
This parameter specifies the command to be executed on the server host in order to obtain
5852
 
\FClpq \F[]\-style printer status information\&.
5853
 
.sp
5854
 
This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\&.
5855
 
.sp
5856
 
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
5857
 
\fIprinting =\fR
5858
 
option\&.
5859
 
.sp
5860
 
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\&.
5861
 
.sp
5862
 
If a
5863
 
\fI%p\fR
5864
 
is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
5865
 
.sp
5866
 
Note that it is good practice to include the absolute path in the
5867
 
\fIlpq command\fR
5868
 
as the
5869
 
\fB$PATH \fR
5870
 
may not be available to the server\&. When compiled with the CUPS libraries, no
5871
 
\fIlpq command\fR
5872
 
is needed because smbd will make a library call to obtain the print queue listing\&.
5873
 
.sp
5874
 
Default:
5875
 
\fI\fIlpq command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
5876
 
.sp
5877
 
Example:
5878
 
\fI\fIlpq command\fR\fR\fI = \fR\fI\FC/usr/bin/lpq \-P%p\F[]\fR\fI \fR
5879
 
.RE
5880
 
 
5881
 
lpresume command (S)
5882
 
.\" lpresume command
5883
 
.PP
5884
 
.RS 4
5885
 
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\&.
5886
 
.sp
5887
 
This command should be a program or script which takes a printer name and job number to resume the print job\&. See also the
5888
 
\m[blue]\fBlppause command\fR\m[]
5889
 
parameter\&.
5890
 
.sp
5891
 
If a
5892
 
\fI%p\fR
5893
 
is given then the printer name is put in its place\&. A
5894
 
\fI%j\fR
5895
 
is replaced with the job number (an integer)\&.
5896
 
.sp
5897
 
Note that it is good practice to include the absolute path in the
5898
 
\fIlpresume command\fR
5899
 
as the PATH may not be available to the server\&.
5900
 
.sp
5901
 
See also the
5902
 
\m[blue]\fBprinting\fR\m[]
5903
 
parameter\&.
5904
 
.sp
5905
 
Default: Currently no default value is given to this string, unless the value of the
5906
 
\fIprinting\fR
5907
 
parameter is
5908
 
\fBSYSV\fR, in which case the default is:
5909
 
.sp
5910
 
\FClp \-i %p\-%j \-H resume\F[]
5911
 
.sp
5912
 
or if the value of the
5913
 
\fIprinting\fR
5914
 
parameter is
5915
 
\fBSOFTQ\fR, then the default is:
5916
 
.sp
5917
 
\FCqstat \-s \-j%j \-r\F[]
5918
 
.sp
5919
 
\fINo default\fR
5920
 
.sp
5921
 
Example:
5922
 
\fI\fIlpresume command\fR\fR\fI = \fR\fI\FC/usr/bin/lpalt %p\-%j \-p2\F[]\fR\fI \fR
5923
 
.RE
5924
 
 
5925
 
lprm command (S)
5926
 
.\" lprm command
5927
 
.PP
5928
 
.RS 4
5929
 
This parameter specifies the command to be executed on the server host in order to delete a print job\&.
5930
 
.sp
5931
 
This command should be a program or script which takes a printer name and job number, and deletes the print job\&.
5932
 
.sp
5933
 
If a
5934
 
\fI%p\fR
5935
 
is given then the printer name is put in its place\&. A
5936
 
\fI%j\fR
5937
 
is replaced with the job number (an integer)\&.
5938
 
.sp
5939
 
Note that it is good practice to include the absolute path in the
5940
 
\fIlprm command\fR
5941
 
as the PATH may not be available to the server\&.
5942
 
.sp
5943
 
Examples of use are:
5944
 
.sp
5945
 
.if n \{\
5946
 
.RS 4
5947
 
.\}
5948
 
.fam C
5949
 
.ps -1
5950
 
.nf
5951
 
.if t \{\
5952
 
.sp -1
5953
 
.\}
5954
 
.BB lightgray adjust-for-leading-newline
5955
 
.sp -1
5956
 
 
5957
 
lprm command = /usr/bin/lprm \-P%p %j
5958
 
 
5959
 
or
5960
 
 
5961
 
lprm command = /usr/bin/cancel %p\-%j
5962
 
.EB lightgray adjust-for-leading-newline
5963
 
.if t \{\
5964
 
.sp 1
5965
 
.\}
5966
 
.fi
5967
 
.fam
5968
 
.ps +1
5969
 
.if n \{\
5970
 
.RE
5971
 
.\}
5972
 
.sp
5973
 
Default:
5974
 
\fI\fIlprm command\fR\fR\fI = \fR\fI\FC determined by printing parameter\F[]\fR\fI \fR
5975
 
.RE
5976
 
 
5977
 
machine password timeout (G)
5978
 
.\" machine password timeout
5979
 
.PP
5980
 
.RS 4
5981
 
If a Samba server is a member of a Windows NT Domain (see the
5982
 
\m[blue]\fBsecurity = domain\fR\m[]
5983
 
parameter) then periodically a running smbd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called
5984
 
\FCprivate/secrets\&.tdb \F[]\&. 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\&.
5985
 
.sp
5986
 
See also
5987
 
\fBsmbpasswd\fR(8), and the
5988
 
\m[blue]\fBsecurity = domain\fR\m[]
5989
 
parameter\&.
5990
 
.sp
5991
 
Default:
5992
 
\fI\fImachine password timeout\fR\fR\fI = \fR\fI\FC604800\F[]\fR\fI \fR
5993
 
.RE
5994
 
 
5995
 
magic output (S)
5996
 
.\" magic output
5997
 
.PP
5998
 
.RS 4
5999
 
This parameter specifies the name of a file which will contain output created by a magic script (see the
6000
 
\m[blue]\fBmagic script\fR\m[]
6001
 
parameter below)\&.
6002
 
.if n \{\
6003
 
.sp
6004
 
.\}
6005
 
.RS 4
6006
 
.BM yellow
6007
 
.it 1 an-trap
6008
 
.nr an-no-space-flag 1
6009
 
.nr an-break-flag 1
6010
 
.br
6011
 
.ps +1
6012
 
\fBWarning\fR
6013
 
.ps -1
6014
 
.br
6015
 
If two clients use the same
6016
 
\fImagic script \fR
6017
 
in the same directory the output file content is undefined\&.
6018
 
.sp .5v
6019
 
.EM yellow
6020
 
.RE
6021
 
Default:
6022
 
\fI\fImagic output\fR\fR\fI = \fR\fI\FC<magic script name>\&.out\F[]\fR\fI \fR
6023
 
.sp
6024
 
Example:
6025
 
\fI\fImagic output\fR\fR\fI = \fR\fI\FCmyfile\&.txt\F[]\fR\fI \fR
6026
 
.RE
6027
 
 
6028
 
magic script (S)
6029
 
.\" magic script
6030
 
.PP
6031
 
.RS 4
6032
 
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\&.
6033
 
.sp
6034
 
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\&.
6035
 
.sp
6036
 
If the script generates output, output will be sent to the file specified by the
6037
 
\m[blue]\fBmagic output\fR\m[]
6038
 
parameter (see above)\&.
6039
 
.sp
6040
 
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
6041
 
\fIas is\fR
6042
 
on the host, which for some hosts and some shells will require filtering at the DOS end\&.
6043
 
.sp
6044
 
Magic scripts are
6045
 
\fIEXPERIMENTAL\fR
6046
 
and should
6047
 
\fINOT\fR
6048
 
be relied upon\&.
6049
 
.sp
6050
 
Default:
6051
 
\fI\fImagic script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
6052
 
.sp
6053
 
Example:
6054
 
\fI\fImagic script\fR\fR\fI = \fR\fI\FCuser\&.csh\F[]\fR\fI \fR
6055
 
.RE
6056
 
 
6057
 
mangled names (S)
6058
 
.\" mangled names
6059
 
.PP
6060
 
.RS 4
6061
 
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\&.
6062
 
.sp
6063
 
See the section on
6064
 
\m[blue]\fBname mangling\fR\m[]
6065
 
for details on how to control the mangling process\&.
6066
 
.sp
6067
 
If mangling is used then the mangling algorithm is as follows:
6068
 
.sp
6069
 
.RS 4
6070
 
.ie n \{\
6071
 
\h'-04'\(bu\h'+03'\c
6072
 
.\}
6073
 
.el \{\
6074
 
.sp -1
6075
 
.IP \(bu 2.3
6076
 
.\}
6077
 
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\&.
6078
 
.RE
6079
 
.sp
6080
 
.RS 4
6081
 
.ie n \{\
6082
 
\h'-04'\(bu\h'+03'\c
6083
 
.\}
6084
 
.el \{\
6085
 
.sp -1
6086
 
.IP \(bu 2.3
6087
 
.\}
6088
 
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\&.
6089
 
.sp
6090
 
Note that the character to use may be specified using the
6091
 
\m[blue]\fBmangling char\fR\m[]
6092
 
option, if you don\'t like \'~\'\&.
6093
 
.RE
6094
 
.sp
6095
 
.RS 4
6096
 
.ie n \{\
6097
 
\h'-04'\(bu\h'+03'\c
6098
 
.\}
6099
 
.el \{\
6100
 
.sp -1
6101
 
.IP \(bu 2.3
6102
 
.\}
6103
 
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)\&.
6104
 
.sp
6105
 
.RE
6106
 
The two\-digit hash value consists of upper case alphanumeric characters\&.
6107
 
.sp
6108
 
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\&.
6109
 
.sp
6110
 
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\&.
6111
 
.sp
6112
 
Default:
6113
 
\fI\fImangled names\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
6114
 
.RE
6115
 
 
6116
 
mangle prefix (G)
6117
 
.\" mangle prefix
6118
 
.PP
6119
 
.RS 4
6120
 
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\&.
6121
 
.sp
6122
 
mangle prefix is effective only when mangling method is hash2\&.
6123
 
.sp
6124
 
Default:
6125
 
\fI\fImangle prefix\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
6126
 
.sp
6127
 
Example:
6128
 
\fI\fImangle prefix\fR\fR\fI = \fR\fI\FC4\F[]\fR\fI \fR
6129
 
.RE
6130
 
 
6131
 
mangling char (S)
6132
 
.\" mangling char
6133
 
.PP
6134
 
.RS 4
6135
 
This controls what character is used as the
6136
 
\fImagic\fR
6137
 
character in
6138
 
\m[blue]\fBname mangling\fR\m[]\&. 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\&.
6139
 
.sp
6140
 
Default:
6141
 
\fI\fImangling char\fR\fR\fI = \fR\fI\FC~\F[]\fR\fI \fR
6142
 
.sp
6143
 
Example:
6144
 
\fI\fImangling char\fR\fR\fI = \fR\fI\FC^\F[]\fR\fI \fR
6145
 
.RE
6146
 
 
6147
 
mangling method (G)
6148
 
.\" mangling method
6149
 
.PP
6150
 
.RS 4
6151
 
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\&.
6152
 
.sp
6153
 
Default:
6154
 
\fI\fImangling method\fR\fR\fI = \fR\fI\FChash2\F[]\fR\fI \fR
6155
 
.sp
6156
 
Example:
6157
 
\fI\fImangling method\fR\fR\fI = \fR\fI\FChash\F[]\fR\fI \fR
6158
 
.RE
6159
 
 
6160
 
map acl inherit (S)
6161
 
.\" map acl inherit
6162
 
.PP
6163
 
.RS 4
6164
 
This boolean parameter controls whether
6165
 
\fBsmbd\fR(8)
6166
 
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\&.
6167
 
.sp
6168
 
Default:
6169
 
\fI\fImap acl inherit\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
6170
 
.RE
6171
 
 
6172
 
map archive (S)
6173
 
.\" map archive
6174
 
.PP
6175
 
.RS 4
6176
 
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\&.\&.\&.
6177
 
.sp
6178
 
Note that this requires the
6179
 
\m[blue]\fBcreate mask\fR\m[]
6180
 
parameter to be set such that owner execute bit is not masked out (i\&.e\&. it must include 100)\&. See the parameter
6181
 
\m[blue]\fBcreate mask\fR\m[]
6182
 
for details\&.
6183
 
.sp
6184
 
Default:
6185
 
\fI\fImap archive\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
6186
 
.RE
6187
 
 
6188
 
map hidden (S)
6189
 
.\" map hidden
6190
 
.PP
6191
 
.RS 4
6192
 
This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\&.
6193
 
.sp
6194
 
Note that this requires the
6195
 
\m[blue]\fBcreate mask\fR\m[]
6196
 
to be set such that the world execute bit is not masked out (i\&.e\&. it must include 001)\&. See the parameter
6197
 
\m[blue]\fBcreate mask\fR\m[]
6198
 
for details\&.
6199
 
.sp
6200
 
\fINo default\fR
6201
 
.RE
6202
 
 
6203
 
map read only (S)
6204
 
.\" map read only
6205
 
.PP
6206
 
.RS 4
6207
 
This controls how the DOS read only attribute should be mapped from a UNIX filesystem\&.
6208
 
.sp
6209
 
This parameter can take three different values, which tell
6210
 
\fBsmbd\fR(8)
6211
 
how to display the read only attribute on files, where either
6212
 
\m[blue]\fBstore dos attributes\fR\m[]
6213
 
is set to
6214
 
\fBNo\fR, or no extended attribute is present\&. If
6215
 
\m[blue]\fBstore dos attributes\fR\m[]
6216
 
is set to
6217
 
\fByes\fR
6218
 
then this parameter is
6219
 
\fIignored\fR\&. This is a new parameter introduced in Samba version 3\&.0\&.21\&.
6220
 
.sp
6221
 
The three settings are :
6222
 
.sp
6223
 
.RS 4
6224
 
.ie n \{\
6225
 
\h'-04'\(bu\h'+03'\c
6226
 
.\}
6227
 
.el \{\
6228
 
.sp -1
6229
 
.IP \(bu 2.3
6230
 
.\}
6231
 
 
6232
 
\fBYes\fR
6233
 
\- 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\&.
6234
 
.RE
6235
 
.sp
6236
 
.RS 4
6237
 
.ie n \{\
6238
 
\h'-04'\(bu\h'+03'\c
6239
 
.\}
6240
 
.el \{\
6241
 
.sp -1
6242
 
.IP \(bu 2.3
6243
 
.\}
6244
 
 
6245
 
\fBPermissions\fR
6246
 
\- The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by
6247
 
\fBsmbd\fR(8)
6248
 
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\&.
6249
 
.RE
6250
 
.sp
6251
 
.RS 4
6252
 
.ie n \{\
6253
 
\h'-04'\(bu\h'+03'\c
6254
 
.\}
6255
 
.el \{\
6256
 
.sp -1
6257
 
.IP \(bu 2.3
6258
 
.\}
6259
 
 
6260
 
\fBNo\fR
6261
 
\- The read only DOS attribute is unaffected by permissions, and can only be set by the
6262
 
\m[blue]\fBstore dos attributes\fR\m[]
6263
 
method\&. This may be useful for exporting mounted CDs\&.
6264
 
.sp
6265
 
.RE
6266
 
Default:
6267
 
\fI\fImap read only\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
6268
 
.RE
6269
 
 
6270
 
map system (S)
6271
 
.\" map system
6272
 
.PP
6273
 
.RS 4
6274
 
This controls whether DOS style system files should be mapped to the UNIX group execute bit\&.
6275
 
.sp
6276
 
Note that this requires the
6277
 
\m[blue]\fBcreate mask\fR\m[]
6278
 
to be set such that the group execute bit is not masked out (i\&.e\&. it must include 010)\&. See the parameter
6279
 
\m[blue]\fBcreate mask\fR\m[]
6280
 
for details\&.
6281
 
.sp
6282
 
Default:
6283
 
\fI\fImap system\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
6284
 
.RE
6285
 
 
6286
 
map to guest (G)
6287
 
.\" map to guest
6288
 
.PP
6289
 
.RS 4
6290
 
This parameter is only useful in
6291
 
\m[blue]\fBSECURITY = security\fR\m[]
6292
 
modes other than
6293
 
\fIsecurity = share\fR
6294
 
and
6295
 
\fIsecurity = server\fR
6296
 
\- i\&.e\&.
6297
 
\fBuser\fR, and
6298
 
\fBdomain\fR\&.
6299
 
.sp
6300
 
This parameter can take four different values, which tell
6301
 
\fBsmbd\fR(8)
6302
 
what to do with user login requests that don\'t match a valid UNIX user in some way\&.
6303
 
.sp
6304
 
The four settings are :
6305
 
.sp
6306
 
.RS 4
6307
 
.ie n \{\
6308
 
\h'-04'\(bu\h'+03'\c
6309
 
.\}
6310
 
.el \{\
6311
 
.sp -1
6312
 
.IP \(bu 2.3
6313
 
.\}
6314
 
\fBNever\fR
6315
 
\- Means user login requests with an invalid password are rejected\&. This is the default\&.
6316
 
.RE
6317
 
.sp
6318
 
.RS 4
6319
 
.ie n \{\
6320
 
\h'-04'\(bu\h'+03'\c
6321
 
.\}
6322
 
.el \{\
6323
 
.sp -1
6324
 
.IP \(bu 2.3
6325
 
.\}
6326
 
\fBBad User\fR
6327
 
\- 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
6328
 
\m[blue]\fBguest account\fR\m[]\&.
6329
 
.RE
6330
 
.sp
6331
 
.RS 4
6332
 
.ie n \{\
6333
 
\h'-04'\(bu\h'+03'\c
6334
 
.\}
6335
 
.el \{\
6336
 
.sp -1
6337
 
.IP \(bu 2.3
6338
 
.\}
6339
 
\fBBad Password\fR
6340
 
\- Means user logins with an invalid password are treated as a guest login and mapped into the
6341
 
\m[blue]\fBguest account\fR\m[]\&. 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
6342
 
\fIhate\fR
6343
 
you if you set the
6344
 
\fImap to guest\fR
6345
 
parameter this way :\-)\&.
6346
 
.RE
6347
 
.sp
6348
 
.RS 4
6349
 
.ie n \{\
6350
 
\h'-04'\(bu\h'+03'\c
6351
 
.\}
6352
 
.el \{\
6353
 
.sp -1
6354
 
.IP \(bu 2.3
6355
 
.\}
6356
 
\fBBad Uid\fR
6357
 
\- 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\&.
6358
 
.sp
6359
 
.RE
6360
 
Note that this parameter is needed to set up "Guest" share services when using
6361
 
\fIsecurity\fR
6362
 
modes other than share and server\&. This is because in these modes the name of the resource being requested is
6363
 
\fInot\fR
6364
 
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
6365
 
\fIsecurity = server\fR
6366
 
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\&.
6367
 
.sp
6368
 
For people familiar with the older Samba releases, this parameter maps to the old compile\-time setting of the
6369
 
\fB GUEST_SESSSETUP\fR
6370
 
value in local\&.h\&.
6371
 
.sp
6372
 
Default:
6373
 
\fI\fImap to guest\fR\fR\fI = \fR\fI\FCNever\F[]\fR\fI \fR
6374
 
.sp
6375
 
Example:
6376
 
\fI\fImap to guest\fR\fR\fI = \fR\fI\FCBad User\F[]\fR\fI \fR
6377
 
.RE
6378
 
 
6379
 
map untrusted to domain (G)
6380
 
.\" map untrusted to domain
6381
 
.PP
6382
 
.RS 4
6383
 
If a client connects to smbd using an untrusted domain name, such as BOGUS\euser, 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\euser\&. In the case where smbd is acting as a domain member server or a standalone server this will be WORKSTATION\euser\&.
6384
 
.sp
6385
 
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\euser\&.
6386
 
.sp
6387
 
When this parameter is set to
6388
 
\fByes\fR
6389
 
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\&.
6390
 
.sp
6391
 
Default:
6392
 
\fI\fImap untrusted to domain\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
6393
 
.RE
6394
 
 
6395
 
max connections (S)
6396
 
.\" max connections
6397
 
.PP
6398
 
.RS 4
6399
 
This option allows the number of simultaneous connections to a service to be limited\&. If
6400
 
\fImax connections\fR
6401
 
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\&.
6402
 
.sp
6403
 
Record lock files are used to implement this feature\&. The lock files will be stored in the directory specified by the
6404
 
\m[blue]\fBlock directory\fR\m[]
6405
 
option\&.
6406
 
.sp
6407
 
Default:
6408
 
\fI\fImax connections\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6409
 
.sp
6410
 
Example:
6411
 
\fI\fImax connections\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
6412
 
.RE
6413
 
 
6414
 
max disk size (G)
6415
 
.\" max disk size
6416
 
.PP
6417
 
.RS 4
6418
 
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\&.
6419
 
.sp
6420
 
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
6421
 
\fImax disk size\fR\&.
6422
 
.sp
6423
 
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\&.
6424
 
.sp
6425
 
A
6426
 
\fImax disk size\fR
6427
 
of 0 means no limit\&.
6428
 
.sp
6429
 
Default:
6430
 
\fI\fImax disk size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6431
 
.sp
6432
 
Example:
6433
 
\fI\fImax disk size\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
6434
 
.RE
6435
 
 
6436
 
max log size (G)
6437
 
.\" max log size
6438
 
.PP
6439
 
.RS 4
6440
 
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
6441
 
\FC\&.old\F[]
6442
 
extension\&.
6443
 
.sp
6444
 
A size of 0 means no limit\&.
6445
 
.sp
6446
 
Default:
6447
 
\fI\fImax log size\fR\fR\fI = \fR\fI\FC5000\F[]\fR\fI \fR
6448
 
.sp
6449
 
Example:
6450
 
\fI\fImax log size\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
6451
 
.RE
6452
 
 
6453
 
max mux (G)
6454
 
.\" max mux
6455
 
.PP
6456
 
.RS 4
6457
 
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\&.
6458
 
.sp
6459
 
Default:
6460
 
\fI\fImax mux\fR\fR\fI = \fR\fI\FC50\F[]\fR\fI \fR
6461
 
.RE
6462
 
 
6463
 
max open files (G)
6464
 
.\" max open files
6465
 
.PP
6466
 
.RS 4
6467
 
This parameter limits the maximum number of open files that one
6468
 
\fBsmbd\fR(8)
6469
 
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\&.
6470
 
.sp
6471
 
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\&.
6472
 
.sp
6473
 
Default:
6474
 
\fI\fImax open files\fR\fR\fI = \fR\fI\FC10000\F[]\fR\fI \fR
6475
 
.RE
6476
 
 
6477
 
max print jobs (S)
6478
 
.\" max print jobs
6479
 
.PP
6480
 
.RS 4
6481
 
This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\&. If this number is exceeded,
6482
 
\fBsmbd\fR(8)
6483
 
will remote "Out of Space" to the client\&.
6484
 
.sp
6485
 
Default:
6486
 
\fI\fImax print jobs\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
6487
 
.sp
6488
 
Example:
6489
 
\fI\fImax print jobs\fR\fR\fI = \fR\fI\FC5000\F[]\fR\fI \fR
6490
 
.RE
6491
 
 
6492
 
protocol
6493
 
.\" protocol
6494
 
.PP
6495
 
.RS 4
6496
 
This parameter is a synonym for
6497
 
max protocol\&.
6498
 
.RE
6499
 
 
6500
 
max protocol (G)
6501
 
.\" max protocol
6502
 
.PP
6503
 
.RS 4
6504
 
The value of the parameter (a string) is the highest protocol level that will be supported by the server\&.
6505
 
.sp
6506
 
Possible values are :
6507
 
.sp
6508
 
.RS 4
6509
 
.ie n \{\
6510
 
\h'-04'\(bu\h'+03'\c
6511
 
.\}
6512
 
.el \{\
6513
 
.sp -1
6514
 
.IP \(bu 2.3
6515
 
.\}
6516
 
\fBCORE\fR: Earliest version\&. No concept of user names\&.
6517
 
.RE
6518
 
.sp
6519
 
.RS 4
6520
 
.ie n \{\
6521
 
\h'-04'\(bu\h'+03'\c
6522
 
.\}
6523
 
.el \{\
6524
 
.sp -1
6525
 
.IP \(bu 2.3
6526
 
.\}
6527
 
\fBCOREPLUS\fR: Slight improvements on CORE for efficiency\&.
6528
 
.RE
6529
 
.sp
6530
 
.RS 4
6531
 
.ie n \{\
6532
 
\h'-04'\(bu\h'+03'\c
6533
 
.\}
6534
 
.el \{\
6535
 
.sp -1
6536
 
.IP \(bu 2.3
6537
 
.\}
6538
 
\fBLANMAN1\fR: First
6539
 
\fI modern\fR
6540
 
version of the protocol\&. Long filename support\&.
6541
 
.RE
6542
 
.sp
6543
 
.RS 4
6544
 
.ie n \{\
6545
 
\h'-04'\(bu\h'+03'\c
6546
 
.\}
6547
 
.el \{\
6548
 
.sp -1
6549
 
.IP \(bu 2.3
6550
 
.\}
6551
 
\fBLANMAN2\fR: Updates to Lanman1 protocol\&.
6552
 
.RE
6553
 
.sp
6554
 
.RS 4
6555
 
.ie n \{\
6556
 
\h'-04'\(bu\h'+03'\c
6557
 
.\}
6558
 
.el \{\
6559
 
.sp -1
6560
 
.IP \(bu 2.3
6561
 
.\}
6562
 
\fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.
6563
 
.sp
6564
 
.RE
6565
 
Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
6566
 
.sp
6567
 
Default:
6568
 
\fI\fImax protocol\fR\fR\fI = \fR\fI\FCNT1\F[]\fR\fI \fR
6569
 
.sp
6570
 
Example:
6571
 
\fI\fImax protocol\fR\fR\fI = \fR\fI\FCLANMAN1\F[]\fR\fI \fR
6572
 
.RE
6573
 
 
6574
 
max reported print jobs (S)
6575
 
.\" max reported print jobs
6576
 
.PP
6577
 
.RS 4
6578
 
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\&.
6579
 
.sp
6580
 
Default:
6581
 
\fI\fImax reported print jobs\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6582
 
.sp
6583
 
Example:
6584
 
\fI\fImax reported print jobs\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
6585
 
.RE
6586
 
 
6587
 
max smbd processes (G)
6588
 
.\" max smbd processes
6589
 
.PP
6590
 
.RS 4
6591
 
This parameter limits the maximum number of
6592
 
\fBsmbd\fR(8)
6593
 
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
6594
 
\fBsmbd\fR(8)
6595
 
associated with him or her to handle connections to all shares from a given host\&.
6596
 
.sp
6597
 
Default:
6598
 
\fI\fImax smbd processes\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6599
 
.sp
6600
 
Example:
6601
 
\fI\fImax smbd processes\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
6602
 
.RE
6603
 
 
6604
 
max stat cache size (G)
6605
 
.\" max stat cache size
6606
 
.PP
6607
 
.RS 4
6608
 
This parameter limits the size in memory of any
6609
 
\fIstat cache\fR
6610
 
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\&.
6611
 
.sp
6612
 
Default:
6613
 
\fI\fImax stat cache size\fR\fR\fI = \fR\fI\FC256\F[]\fR\fI \fR
6614
 
.sp
6615
 
Example:
6616
 
\fI\fImax stat cache size\fR\fR\fI = \fR\fI\FC100\F[]\fR\fI \fR
6617
 
.RE
6618
 
 
6619
 
max ttl (G)
6620
 
.\" max ttl
6621
 
.PP
6622
 
.RS 4
6623
 
This option tells
6624
 
\fBnmbd\fR(8)
6625
 
what the default \'time to live\' of NetBIOS names should be (in seconds) when
6626
 
\FCnmbd\F[]
6627
 
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\&.
6628
 
.sp
6629
 
Default:
6630
 
\fI\fImax ttl\fR\fR\fI = \fR\fI\FC259200\F[]\fR\fI \fR
6631
 
.RE
6632
 
 
6633
 
max wins ttl (G)
6634
 
.\" max wins ttl
6635
 
.PP
6636
 
.RS 4
6637
 
This option tells
6638
 
\fBsmbd\fR(8)
6639
 
when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the maximum \'time to live\' of NetBIOS names that
6640
 
\FCnmbd\F[]
6641
 
will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 days (518400 seconds)\&.
6642
 
.sp
6643
 
Default:
6644
 
\fI\fImax wins ttl\fR\fR\fI = \fR\fI\FC518400\F[]\fR\fI \fR
6645
 
.RE
6646
 
 
6647
 
max xmit (G)
6648
 
.\" max xmit
6649
 
.PP
6650
 
.RS 4
6651
 
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\&.
6652
 
.sp
6653
 
Default:
6654
 
\fI\fImax xmit\fR\fR\fI = \fR\fI\FC16644\F[]\fR\fI \fR
6655
 
.sp
6656
 
Example:
6657
 
\fI\fImax xmit\fR\fR\fI = \fR\fI\FC8192\F[]\fR\fI \fR
6658
 
.RE
6659
 
 
6660
 
message command (G)
6661
 
.\" message command
6662
 
.PP
6663
 
.RS 4
6664
 
This specifies what command to run when the server receives a WinPopup style message\&.
6665
 
.sp
6666
 
This would normally be a command that would deliver the message somehow\&. How this is to be done is up to your imagination\&.
6667
 
.sp
6668
 
An example is:
6669
 
.sp
6670
 
.if n \{\
6671
 
.RS 4
6672
 
.\}
6673
 
.fam C
6674
 
.ps -1
6675
 
.nf
6676
 
.if t \{\
6677
 
.sp -1
6678
 
.\}
6679
 
.BB lightgray adjust-for-leading-newline
6680
 
.sp -1
6681
 
 
6682
 
\FCmessage command = csh \-c \'xedit %s;rm %s\' &\F[]
6683
 
.EB lightgray adjust-for-leading-newline
6684
 
.if t \{\
6685
 
.sp 1
6686
 
.\}
6687
 
.fi
6688
 
.fam
6689
 
.ps +1
6690
 
.if n \{\
6691
 
.RE
6692
 
.\}
6693
 
.sp
6694
 
This delivers the message using
6695
 
\FCxedit\F[], then removes it afterwards\&.
6696
 
\fINOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN IMMEDIATELY\fR\&. 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)\&.
6697
 
.sp
6698
 
All messages are delivered as the global guest user\&. The command takes the standard substitutions, although
6699
 
\fI %u\fR
6700
 
won\'t work (\fI%U\fR
6701
 
may be better in this case)\&.
6702
 
.sp
6703
 
Apart from the standard substitutions, some additional ones apply\&. In particular:
6704
 
.sp
6705
 
.RS 4
6706
 
.ie n \{\
6707
 
\h'-04'\(bu\h'+03'\c
6708
 
.\}
6709
 
.el \{\
6710
 
.sp -1
6711
 
.IP \(bu 2.3
6712
 
.\}
6713
 
\fI%s\fR
6714
 
= the filename containing the message\&.
6715
 
.RE
6716
 
.sp
6717
 
.RS 4
6718
 
.ie n \{\
6719
 
\h'-04'\(bu\h'+03'\c
6720
 
.\}
6721
 
.el \{\
6722
 
.sp -1
6723
 
.IP \(bu 2.3
6724
 
.\}
6725
 
\fI%t\fR
6726
 
= the destination that the message was sent to (probably the server name)\&.
6727
 
.RE
6728
 
.sp
6729
 
.RS 4
6730
 
.ie n \{\
6731
 
\h'-04'\(bu\h'+03'\c
6732
 
.\}
6733
 
.el \{\
6734
 
.sp -1
6735
 
.IP \(bu 2.3
6736
 
.\}
6737
 
\fI%f\fR
6738
 
= who the message is from\&.
6739
 
.sp
6740
 
.RE
6741
 
You could make this command send mail, or whatever else takes your fancy\&. Please let us know of any really interesting ideas you have\&.
6742
 
.sp
6743
 
Here\'s a way of sending the messages as mail to root:
6744
 
.sp
6745
 
.if n \{\
6746
 
.RS 4
6747
 
.\}
6748
 
.fam C
6749
 
.ps -1
6750
 
.nf
6751
 
.if t \{\
6752
 
.sp -1
6753
 
.\}
6754
 
.BB lightgray adjust-for-leading-newline
6755
 
.sp -1
6756
 
 
6757
 
\FCmessage command = /bin/mail \-s \'message from %f on %m\' root < %s; rm %s\F[]
6758
 
.EB lightgray adjust-for-leading-newline
6759
 
.if t \{\
6760
 
.sp 1
6761
 
.\}
6762
 
.fi
6763
 
.fam
6764
 
.ps +1
6765
 
.if n \{\
6766
 
.RE
6767
 
.\}
6768
 
.sp
6769
 
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\&.
6770
 
.sp
6771
 
If you want to silently delete it then try:
6772
 
.sp
6773
 
.if n \{\
6774
 
.RS 4
6775
 
.\}
6776
 
.fam C
6777
 
.ps -1
6778
 
.nf
6779
 
.if t \{\
6780
 
.sp -1
6781
 
.\}
6782
 
.BB lightgray adjust-for-leading-newline
6783
 
.sp -1
6784
 
 
6785
 
\FCmessage command = rm %s\F[]
6786
 
.EB lightgray adjust-for-leading-newline
6787
 
.if t \{\
6788
 
.sp 1
6789
 
.\}
6790
 
.fi
6791
 
.fam
6792
 
.ps +1
6793
 
.if n \{\
6794
 
.RE
6795
 
.\}
6796
 
.sp
6797
 
Default:
6798
 
\fI\fImessage command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
6799
 
.sp
6800
 
Example:
6801
 
\fI\fImessage command\fR\fR\fI = \fR\fI\FCcsh \-c \'xedit %s; rm %s\' &\F[]\fR\fI \fR
6802
 
.RE
6803
 
 
6804
 
min print space (S)
6805
 
.\" min print space
6806
 
.PP
6807
 
.RS 4
6808
 
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\&.
6809
 
.sp
6810
 
Default:
6811
 
\fI\fImin print space\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6812
 
.sp
6813
 
Example:
6814
 
\fI\fImin print space\fR\fR\fI = \fR\fI\FC2000\F[]\fR\fI \fR
6815
 
.RE
6816
 
 
6817
 
min protocol (G)
6818
 
.\" min protocol
6819
 
.PP
6820
 
.RS 4
6821
 
The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support\&. Please refer to the
6822
 
\m[blue]\fBmax protocol\fR\m[]
6823
 
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
6824
 
\FCsource/smbd/negprot\&.c\F[]
6825
 
for a listing of known protocol dialects supported by clients\&.
6826
 
.sp
6827
 
If you are viewing this parameter as a security measure, you should also refer to the
6828
 
\m[blue]\fBlanman auth\fR\m[]
6829
 
parameter\&. Otherwise, you should never need to change this parameter\&.
6830
 
.sp
6831
 
Default:
6832
 
\fI\fImin protocol\fR\fR\fI = \fR\fI\FCCORE\F[]\fR\fI \fR
6833
 
.sp
6834
 
Example:
6835
 
\fI\fImin protocol\fR\fR\fI = \fR\fI\FCNT1\F[]\fR\fI \fR
6836
 
.RE
6837
 
 
6838
 
min receivefile size (G)
6839
 
.\" min receivefile size
6840
 
.PP
6841
 
.RS 4
6842
 
This option changes the behavior of
6843
 
\fBsmbd\fR(8)
6844
 
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\&.
6845
 
.sp
6846
 
Note this option will have NO EFFECT if set on a SMB signed connection\&.
6847
 
.sp
6848
 
The default is zero, which diables this option\&.
6849
 
.sp
6850
 
Default:
6851
 
\fI\fImin receivefile size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6852
 
.RE
6853
 
 
6854
 
min wins ttl (G)
6855
 
.\" min wins ttl
6856
 
.PP
6857
 
.RS 4
6858
 
This option tells
6859
 
\fBnmbd\fR(8)
6860
 
when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the minimum \'time to live\' of NetBIOS names that
6861
 
\FCnmbd\F[]
6862
 
will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 hours (21600 seconds)\&.
6863
 
.sp
6864
 
Default:
6865
 
\fI\fImin wins ttl\fR\fR\fI = \fR\fI\FC21600\F[]\fR\fI \fR
6866
 
.RE
6867
 
 
6868
 
msdfs proxy (S)
6869
 
.\" msdfs proxy
6870
 
.PP
6871
 
.RS 4
6872
 
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\&.
6873
 
.sp
6874
 
Only Dfs roots can act as proxy shares\&. Take a look at the
6875
 
\m[blue]\fBmsdfs root\fR\m[]
6876
 
and
6877
 
\m[blue]\fBhost msdfs\fR\m[]
6878
 
options to find out how to set up a Dfs root share\&.
6879
 
.sp
6880
 
\fINo default\fR
6881
 
.sp
6882
 
Example:
6883
 
\fI\fImsdfs proxy\fR\fR\fI = \fR\fI\FC\eotherserver\esomeshare\F[]\fR\fI \fR
6884
 
.RE
6885
 
 
6886
 
msdfs root (S)
6887
 
.\" msdfs root
6888
 
.PP
6889
 
.RS 4
6890
 
If set to
6891
 
\fByes\fR, 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
6892
 
\FCmsdfs:serverA\e\eshareA,serverB\e\eshareB\F[]
6893
 
and so on\&. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\&.
6894
 
.sp
6895
 
Default:
6896
 
\fI\fImsdfs root\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
6897
 
.RE
6898
 
 
6899
 
name cache timeout (G)
6900
 
.\" name cache timeout
6901
 
.PP
6902
 
.RS 4
6903
 
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\&.
6904
 
.sp
6905
 
Default:
6906
 
\fI\fIname cache timeout\fR\fR\fI = \fR\fI\FC660\F[]\fR\fI \fR
6907
 
.sp
6908
 
Example:
6909
 
\fI\fIname cache timeout\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
6910
 
.RE
6911
 
 
6912
 
name resolve order (G)
6913
 
.\" name resolve order
6914
 
.PP
6915
 
.RS 4
6916
 
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\&.
6917
 
.sp
6918
 
The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows:
6919
 
.sp
6920
 
.RS 4
6921
 
.ie n \{\
6922
 
\h'-04'\(bu\h'+03'\c
6923
 
.\}
6924
 
.el \{\
6925
 
.sp -1
6926
 
.IP \(bu 2.3
6927
 
.\}
6928
 
 
6929
 
\fBlmhosts\fR
6930
 
: 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\&.
6931
 
.RE
6932
 
.sp
6933
 
.RS 4
6934
 
.ie n \{\
6935
 
\h'-04'\(bu\h'+03'\c
6936
 
.\}
6937
 
.el \{\
6938
 
.sp -1
6939
 
.IP \(bu 2.3
6940
 
.\}
6941
 
 
6942
 
\fBhost\fR
6943
 
: Do a standard host name to IP address resolution, using the system
6944
 
\FC/etc/hosts \F[], 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
6945
 
\FC/etc/nsswitch\&.conf\F[]
6946
 
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\&.
6947
 
.RE
6948
 
.sp
6949
 
.RS 4
6950
 
.ie n \{\
6951
 
\h'-04'\(bu\h'+03'\c
6952
 
.\}
6953
 
.el \{\
6954
 
.sp -1
6955
 
.IP \(bu 2.3
6956
 
.\}
6957
 
\fBwins\fR
6958
 
: Query a name with the IP address listed in the
6959
 
\m[blue]\fBWINSSERVER\fR\m[]
6960
 
parameter\&. If no WINS server has been specified this method will be ignored\&.
6961
 
.RE
6962
 
.sp
6963
 
.RS 4
6964
 
.ie n \{\
6965
 
\h'-04'\(bu\h'+03'\c
6966
 
.\}
6967
 
.el \{\
6968
 
.sp -1
6969
 
.IP \(bu 2.3
6970
 
.\}
6971
 
\fBbcast\fR
6972
 
: Do a broadcast on each of the known local interfaces listed in the
6973
 
\m[blue]\fBinterfaces\fR\m[]
6974
 
parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.
6975
 
.sp
6976
 
.RE
6977
 
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\&.
6978
 
.sp
6979
 
When Samba is functioning in ADS security mode (\FCsecurity = ads\F[]) it is advised to use following settings for
6980
 
\fIname resolve order\fR:
6981
 
.sp
6982
 
\FCname resolve order = wins bcast\F[]
6983
 
.sp
6984
 
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\&.
6985
 
.sp
6986
 
Default:
6987
 
\fI\fIname resolve order\fR\fR\fI = \fR\fI\FClmhosts host wins bcast\F[]\fR\fI \fR
6988
 
.sp
6989
 
Example:
6990
 
\fI\fIname resolve order\fR\fR\fI = \fR\fI\FClmhosts bcast host\F[]\fR\fI \fR
6991
 
.RE
6992
 
 
6993
 
netbios aliases (G)
6994
 
.\" netbios aliases
6995
 
.PP
6996
 
.RS 4
6997
 
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\&.
6998
 
.sp
6999
 
Default:
7000
 
\fI\fInetbios aliases\fR\fR\fI = \fR\fI\FC # empty string (no additional names)\F[]\fR\fI \fR
7001
 
.sp
7002
 
Example:
7003
 
\fI\fInetbios aliases\fR\fR\fI = \fR\fI\FCTEST TEST1 TEST2\F[]\fR\fI \fR
7004
 
.RE
7005
 
 
7006
 
netbios name (G)
7007
 
.\" netbios name
7008
 
.PP
7009
 
.RS 4
7010
 
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\&.
7011
 
.sp
7012
 
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
7013
 
\FCPIPE\F[]\&. To avoid this problem, do not name your Samba\-3 server
7014
 
\FCPIPE\F[]\&.
7015
 
.sp
7016
 
Default:
7017
 
\fI\fInetbios name\fR\fR\fI = \fR\fI\FC # machine DNS name\F[]\fR\fI \fR
7018
 
.sp
7019
 
Example:
7020
 
\fI\fInetbios name\fR\fR\fI = \fR\fI\FCMYNAME\F[]\fR\fI \fR
7021
 
.RE
7022
 
 
7023
 
netbios scope (G)
7024
 
.\" netbios scope
7025
 
.PP
7026
 
.RS 4
7027
 
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\&.
7028
 
.sp
7029
 
Default:
7030
 
\fI\fInetbios scope\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7031
 
.RE
7032
 
 
7033
 
nis homedir (G)
7034
 
.\" nis homedir
7035
 
.PP
7036
 
.RS 4
7037
 
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\&.
7038
 
.sp
7039
 
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\&.
7040
 
.sp
7041
 
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
7042
 
\m[blue]\fBhomedir map\fR\m[]
7043
 
and return the server listed there\&.
7044
 
.sp
7045
 
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\&.
7046
 
.sp
7047
 
Default:
7048
 
\fI\fInis homedir\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7049
 
.RE
7050
 
 
7051
 
nt acl support (S)
7052
 
.\" nt acl support
7053
 
.PP
7054
 
.RS 4
7055
 
This boolean parameter controls whether
7056
 
\fBsmbd\fR(8)
7057
 
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\&.
7058
 
.sp
7059
 
Default:
7060
 
\fI\fInt acl support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7061
 
.RE
7062
 
 
7063
 
ntlm auth (G)
7064
 
.\" ntlm auth
7065
 
.PP
7066
 
.RS 4
7067
 
This parameter determines whether or not
7068
 
\fBsmbd\fR(8)
7069
 
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\&.
7070
 
.sp
7071
 
If this option, and
7072
 
\FClanman auth\F[]
7073
 
are both disabled, then only NTLMv2 logins will be permited\&. Not all clients support NTLMv2, and most will require special configuration to use it\&.
7074
 
.sp
7075
 
Default:
7076
 
\fI\fIntlm auth\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7077
 
.RE
7078
 
 
7079
 
nt pipe support (G)
7080
 
.\" nt pipe support
7081
 
.PP
7082
 
.RS 4
7083
 
This boolean parameter controls whether
7084
 
\fBsmbd\fR(8)
7085
 
will allow Windows NT clients to connect to the NT SMB specific
7086
 
\fBIPC$\fR
7087
 
pipes\&. This is a developer debugging option and can be left alone\&.
7088
 
.sp
7089
 
Default:
7090
 
\fI\fInt pipe support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7091
 
.RE
7092
 
 
7093
 
nt status support (G)
7094
 
.\" nt status support
7095
 
.PP
7096
 
.RS 4
7097
 
This boolean parameter controls whether
7098
 
\fBsmbd\fR(8)
7099
 
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
7100
 
\fBno\fR
7101
 
then Samba offers exactly the same DOS error codes that versions prior to Samba 2\&.2\&.3 reported\&.
7102
 
.sp
7103
 
You should not need to ever disable this parameter\&.
7104
 
.sp
7105
 
Default:
7106
 
\fI\fInt status support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7107
 
.RE
7108
 
 
7109
 
null passwords (G)
7110
 
.\" null passwords
7111
 
.PP
7112
 
.RS 4
7113
 
Allow or disallow client access to accounts that have null passwords\&.
7114
 
.sp
7115
 
See also
7116
 
\fBsmbpasswd\fR(5)\&.
7117
 
.sp
7118
 
Default:
7119
 
\fI\fInull passwords\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7120
 
.RE
7121
 
 
7122
 
obey pam restrictions (G)
7123
 
.\" obey pam restrictions
7124
 
.PP
7125
 
.RS 4
7126
 
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
7127
 
\m[blue]\fBencrypt passwords = yes\fR\m[]\&. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption\&.
7128
 
.sp
7129
 
Default:
7130
 
\fI\fIobey pam restrictions\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7131
 
.RE
7132
 
 
7133
 
only user (S)
7134
 
.\" only user
7135
 
.PP
7136
 
.RS 4
7137
 
This is a boolean option that controls whether connections with usernames not in the
7138
 
\fIuser\fR
7139
 
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
7140
 
\fIuser\fR
7141
 
list and is only really useful in
7142
 
\m[blue]\fBsecurity = share\fR\m[]
7143
 
level security\&.
7144
 
.sp
7145
 
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
7146
 
\FCuser = %S\F[]
7147
 
which means your
7148
 
\fIuser\fR
7149
 
list will be just the service name, which for home directories is the name of the user\&.
7150
 
.sp
7151
 
Default:
7152
 
\fI\fIonly user\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7153
 
.RE
7154
 
 
7155
 
oplock break wait time (G)
7156
 
.\" oplock break wait time
7157
 
.PP
7158
 
.RS 4
7159
 
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\&.
7160
 
.if n \{\
7161
 
.sp
7162
 
.\}
7163
 
.RS 4
7164
 
.BM yellow
7165
 
.it 1 an-trap
7166
 
.nr an-no-space-flag 1
7167
 
.nr an-break-flag 1
7168
 
.br
7169
 
.ps +1
7170
 
\fBWarning\fR
7171
 
.ps -1
7172
 
.br
7173
 
DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
7174
 
.sp .5v
7175
 
.EM yellow
7176
 
.RE
7177
 
Default:
7178
 
\fI\fIoplock break wait time\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
7179
 
.RE
7180
 
 
7181
 
oplock contention limit (S)
7182
 
.\" oplock contention limit
7183
 
.PP
7184
 
.RS 4
7185
 
This is a
7186
 
\fIvery\fR
7187
 
advanced
7188
 
\fBsmbd\fR(8)
7189
 
tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file\&.
7190
 
.sp
7191
 
In brief it specifies a number, which causes
7192
 
\fBsmbd\fR(8)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
7193
 
\FCsmbd\F[]
7194
 
to behave in a similar way to Windows NT\&.
7195
 
.if n \{\
7196
 
.sp
7197
 
.\}
7198
 
.RS 4
7199
 
.BM yellow
7200
 
.it 1 an-trap
7201
 
.nr an-no-space-flag 1
7202
 
.nr an-break-flag 1
7203
 
.br
7204
 
.ps +1
7205
 
\fBWarning\fR
7206
 
.ps -1
7207
 
.br
7208
 
DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
7209
 
.sp .5v
7210
 
.EM yellow
7211
 
.RE
7212
 
Default:
7213
 
\fI\fIoplock contention limit\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
7214
 
.RE
7215
 
 
7216
 
oplocks (S)
7217
 
.\" oplocks
7218
 
.PP
7219
 
.RS 4
7220
 
This boolean option tells
7221
 
\FCsmbd\F[]
7222
 
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)\&. For more information see the file
7223
 
\FCSpeed\&.txt\F[]
7224
 
in the Samba
7225
 
\FCdocs/\F[]
7226
 
directory\&.
7227
 
.sp
7228
 
Oplocks may be selectively turned off on certain files with a share\&. See the
7229
 
\m[blue]\fBveto oplock files\fR\m[]
7230
 
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
7231
 
\m[blue]\fBkernel oplocks\fR\m[]
7232
 
parameter for details\&.
7233
 
.sp
7234
 
Default:
7235
 
\fI\fIoplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7236
 
.RE
7237
 
 
7238
 
os2 driver map (G)
7239
 
.\" os2 driver map
7240
 
.PP
7241
 
.RS 4
7242
 
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:
7243
 
.sp
7244
 
<nt driver name> = <os2 driver name>\&.<device name>
7245
 
.sp
7246
 
For example, a valid entry using the HP LaserJet 5 printer driver would appear as
7247
 
\FCHP LaserJet 5L = LASERJET\&.HP LaserJet 5L\F[]\&.
7248
 
.sp
7249
 
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\&.
7250
 
.sp
7251
 
Default:
7252
 
\fI\fIos2 driver map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7253
 
.RE
7254
 
 
7255
 
os level (G)
7256
 
.\" os level
7257
 
.PP
7258
 
.RS 4
7259
 
This integer value controls what level Samba advertises itself as for browse elections\&. The value of this parameter determines whether
7260
 
\fBnmbd\fR(8)
7261
 
has a chance of becoming a local master browser for the
7262
 
\m[blue]\fBworkgroup\fR\m[]
7263
 
in the local broadcast area\&.
7264
 
.sp
7265
 
\fI Note:\fR
7266
 
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\&.
7267
 
\fINote:\fR
7268
 
The maximum value for this parameter is 255\&. If you use higher values, counting will start at 0!
7269
 
.sp
7270
 
Default:
7271
 
\fI\fIos level\fR\fR\fI = \fR\fI\FC20\F[]\fR\fI \fR
7272
 
.sp
7273
 
Example:
7274
 
\fI\fIos level\fR\fR\fI = \fR\fI\FC65\F[]\fR\fI \fR
7275
 
.RE
7276
 
 
7277
 
pam password change (G)
7278
 
.\" pam password change
7279
 
.PP
7280
 
.RS 4
7281
 
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
7282
 
\m[blue]\fBpasswd program\fR\m[]\&. It should be possible to enable this without changing your
7283
 
\m[blue]\fBpasswd chat\fR\m[]
7284
 
parameter for most setups\&.
7285
 
.sp
7286
 
Default:
7287
 
\fI\fIpam password change\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7288
 
.RE
7289
 
 
7290
 
panic action (G)
7291
 
.\" panic action
7292
 
.PP
7293
 
.RS 4
7294
 
This is a Samba developer option that allows a system command to be called when either
7295
 
\fBsmbd\fR(8)
7296
 
or
7297
 
\fBnmbd\fR(8)
7298
 
crashes\&. This is usually used to draw attention to the fact that a problem occurred\&.
7299
 
.sp
7300
 
Default:
7301
 
\fI\fIpanic action\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7302
 
.sp
7303
 
Example:
7304
 
\fI\fIpanic action\fR\fR\fI = \fR\fI\FC"/bin/sleep 90000"\F[]\fR\fI \fR
7305
 
.RE
7306
 
 
7307
 
paranoid server security (G)
7308
 
.\" paranoid server security
7309
 
.PP
7310
 
.RS 4
7311
 
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\&.
7312
 
.sp
7313
 
Disabling this option prevents Samba from making this check, which involves deliberatly attempting a bad logon to the remote server\&.
7314
 
.sp
7315
 
Default:
7316
 
\fI\fIparanoid server security\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7317
 
.RE
7318
 
 
7319
 
passdb backend (G)
7320
 
.\" passdb backend
7321
 
.PP
7322
 
.RS 4
7323
 
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\&.
7324
 
.sp
7325
 
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\&.
7326
 
.sp
7327
 
Available backends can include:
7328
 
.sp
7329
 
.RS 4
7330
 
.ie n \{\
7331
 
\h'-04'\(bu\h'+03'\c
7332
 
.\}
7333
 
.el \{\
7334
 
.sp -1
7335
 
.IP \(bu 2.3
7336
 
.\}
7337
 
\FCsmbpasswd\F[]
7338
 
\- 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\&.
7339
 
.RE
7340
 
.sp
7341
 
.RS 4
7342
 
.ie n \{\
7343
 
\h'-04'\(bu\h'+03'\c
7344
 
.\}
7345
 
.el \{\
7346
 
.sp -1
7347
 
.IP \(bu 2.3
7348
 
.\}
7349
 
\FCtdbsam\F[]
7350
 
\- The TDB based password storage backend\&. Takes a path to the TDB as an optional argument (defaults to passdb\&.tdb in the
7351
 
\m[blue]\fBprivate dir\fR\m[]
7352
 
directory\&.
7353
 
.RE
7354
 
.sp
7355
 
.RS 4
7356
 
.ie n \{\
7357
 
\h'-04'\(bu\h'+03'\c
7358
 
.\}
7359
 
.el \{\
7360
 
.sp -1
7361
 
.IP \(bu 2.3
7362
 
.\}
7363
 
\FCldapsam\F[]
7364
 
\- The LDAP based passdb backend\&. Takes an LDAP URL as an optional argument (defaults to
7365
 
\FCldap://localhost\F[])
7366
 
.sp
7367
 
LDAP connections should be secured where possible\&. This may be done using either Start\-TLS (see
7368
 
\m[blue]\fBldap ssl\fR\m[]) or by specifying
7369
 
\fIldaps://\fR
7370
 
in the URL argument\&.
7371
 
.sp
7372
 
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\&.
7373
 
.sp
7374
 
.RE
7375
 
 
7376
 
        Examples of use are:
7377
 
.sp
7378
 
.if n \{\
7379
 
.RS 4
7380
 
.\}
7381
 
.fam C
7382
 
.ps -1
7383
 
.nf
7384
 
.if t \{\
7385
 
.sp -1
7386
 
.\}
7387
 
.BB lightgray adjust-for-leading-newline
7388
 
.sp -1
7389
 
 
7390
 
passdb backend = tdbsam:/etc/samba/private/passdb\&.tdb 
7391
 
 
7392
 
or multi server LDAP URL with OpenLDAP library:
7393
 
 
7394
 
passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap://ldap\-2\&.example\&.com"
7395
 
 
7396
 
or multi server LDAP URL with Netscape based LDAP library:
7397
 
 
7398
 
passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap\-2\&.example\&.com"
7399
 
.EB lightgray adjust-for-leading-newline
7400
 
.if t \{\
7401
 
.sp 1
7402
 
.\}
7403
 
.fi
7404
 
.fam
7405
 
.ps +1
7406
 
.if n \{\
7407
 
.RE
7408
 
.\}
7409
 
.sp
7410
 
Default:
7411
 
\fI\fIpassdb backend\fR\fR\fI = \fR\fI\FCtdbsam\F[]\fR\fI \fR
7412
 
.RE
7413
 
 
7414
 
passdb expand explicit (G)
7415
 
.\" passdb expand explicit
7416
 
.PP
7417
 
.RS 4
7418
 
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\&.
7419
 
.sp
7420
 
Default:
7421
 
\fI\fIpassdb expand explicit\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7422
 
.RE
7423
 
 
7424
 
passwd chat debug (G)
7425
 
.\" passwd chat debug
7426
 
.PP
7427
 
.RS 4
7428
 
This boolean specifies if the passwd chat script parameter is run in
7429
 
\fIdebug\fR
7430
 
mode\&. In this mode the strings passed to and received from the passwd chat are printed in the
7431
 
\fBsmbd\fR(8)
7432
 
log with a
7433
 
\m[blue]\fBdebug level\fR\m[]
7434
 
of 100\&. This is a dangerous option as it will allow plaintext passwords to be seen in the
7435
 
\FCsmbd\F[]
7436
 
log\&. It is available to help Samba admins debug their
7437
 
\fIpasswd chat\fR
7438
 
scripts when calling the
7439
 
\fIpasswd program\fR
7440
 
and should be turned off after this has been done\&. This option has no effect if the
7441
 
\m[blue]\fBpam password change\fR\m[]
7442
 
parameter is set\&. This parameter is off by default\&.
7443
 
.sp
7444
 
Default:
7445
 
\fI\fIpasswd chat debug\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7446
 
.RE
7447
 
 
7448
 
passwd chat timeout (G)
7449
 
.\" passwd chat timeout
7450
 
.PP
7451
 
.RS 4
7452
 
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\&.
7453
 
.sp
7454
 
Default:
7455
 
\fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
7456
 
.RE
7457
 
 
7458
 
passwd chat (G)
7459
 
.\" passwd chat
7460
 
.PP
7461
 
.RS 4
7462
 
This string controls the
7463
 
\fI"chat"\fR
7464
 
conversation that takes places between
7465
 
\fBsmbd\fR(8)
7466
 
and the local password changing program to change the user\'s password\&. The string describes a sequence of response\-receive pairs that
7467
 
\fBsmbd\fR(8)
7468
 
uses to determine what to send to the
7469
 
\m[blue]\fBpasswd program\fR\m[]
7470
 
and what to expect back\&. If the expected output is not received then the password is not changed\&.
7471
 
.sp
7472
 
This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc)\&.
7473
 
.sp
7474
 
Note that this parameter only is used if the
7475
 
\m[blue]\fBunix password sync\fR\m[]
7476
 
parameter is set to
7477
 
\fByes\fR\&. This sequence is then called
7478
 
\fIAS ROOT\fR
7479
 
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
7480
 
\m[blue]\fBpasswd program\fR\m[]
7481
 
must be executed on the NIS master\&.
7482
 
.sp
7483
 
The string can contain the macro
7484
 
\fI%n\fR
7485
 
which is substituted for the new password\&. The old passsword (\fI%o\fR) is only available when
7486
 
\m[blue]\fBencrypt passwords\fR\m[]
7487
 
has been disabled\&. The chat sequence can also contain the standard macros \en, \er, \et and \es 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\&.
7488
 
.sp
7489
 
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\&.
7490
 
.sp
7491
 
If the
7492
 
\m[blue]\fBpam password change\fR\m[]
7493
 
parameter is set to
7494
 
\fByes\fR, the chat pairs may be matched in any order, and success is determined by the PAM result, not any particular output\&. The \en macro is ignored for PAM conversions\&.
7495
 
.sp
7496
 
Default:
7497
 
\fI\fIpasswd chat\fR\fR\fI = \fR\fI\FC*new*password* %n\en*new*password* %n\en *changed*\F[]\fR\fI \fR
7498
 
.sp
7499
 
Example:
7500
 
\fI\fIpasswd chat\fR\fR\fI = \fR\fI\FC"*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"\F[]\fR\fI \fR
7501
 
.RE
7502
 
 
7503
 
passwd program (G)
7504
 
.\" passwd program
7505
 
.PP
7506
 
.RS 4
7507
 
The name of a program that can be used to set UNIX user passwords\&. Any occurrences of
7508
 
\fI%u\fR
7509
 
will be replaced with the user name\&. The user name is checked for existence before calling the password changing program\&.
7510
 
.sp
7511
 
Also note that many passwd programs insist in
7512
 
\fIreasonable \fR
7513
 
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\&.
7514
 
.sp
7515
 
\fINote\fR
7516
 
that if the
7517
 
\fIunix password sync\fR
7518
 
parameter is set to
7519
 
\fByes \fR
7520
 
then this program is called
7521
 
\fIAS ROOT\fR
7522
 
before the SMB password in the smbpasswd file is changed\&. If this UNIX password change fails, then
7523
 
\FCsmbd\F[]
7524
 
will fail to change the SMB password also (this is by design)\&.
7525
 
.sp
7526
 
If the
7527
 
\fIunix password sync\fR
7528
 
parameter is set this parameter
7529
 
\fIMUST USE ABSOLUTE PATHS\fR
7530
 
for
7531
 
\fIALL\fR
7532
 
programs called, and must be examined for security implications\&. Note that by default
7533
 
\fIunix password sync\fR
7534
 
is set to
7535
 
\fBno\fR\&.
7536
 
.sp
7537
 
Default:
7538
 
\fI\fIpasswd program\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7539
 
.sp
7540
 
Example:
7541
 
\fI\fIpasswd program\fR\fR\fI = \fR\fI\FC/bin/passwd %u\F[]\fR\fI \fR
7542
 
.RE
7543
 
 
7544
 
password level (G)
7545
 
.\" password level
7546
 
.PP
7547
 
.RS 4
7548
 
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\&.
7549
 
.sp
7550
 
This parameter defines the maximum number of characters that may be upper case in passwords\&.
7551
 
.sp
7552
 
For example, say the password given was "FRED"\&. If
7553
 
\fI password level\fR
7554
 
is set to 1, the following combinations would be tried if "FRED" failed:
7555
 
.sp
7556
 
"Fred", "fred", "fRed", "frEd","freD"
7557
 
.sp
7558
 
If
7559
 
\fIpassword level\fR
7560
 
was set to 2, the following combinations would also be tried:
7561
 
.sp
7562
 
"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", \&.\&.
7563
 
.sp
7564
 
And so on\&.
7565
 
.sp
7566
 
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\&.
7567
 
.sp
7568
 
A value of zero will cause only two attempts to be made \- the password as is and the password in all\-lower case\&.
7569
 
.sp
7570
 
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
7571
 
\m[blue]\fBencrypt passwords = No\fR\m[]\&.
7572
 
.sp
7573
 
Default:
7574
 
\fI\fIpassword level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
7575
 
.sp
7576
 
Example:
7577
 
\fI\fIpassword level\fR\fR\fI = \fR\fI\FC4\F[]\fR\fI \fR
7578
 
.RE
7579
 
 
7580
 
password server (G)
7581
 
.\" password server
7582
 
.PP
7583
 
.RS 4
7584
 
By specifying the name of another SMB server or Active Directory domain controller with this option, and using
7585
 
\FCsecurity = [ads|domain|server]\F[]
7586
 
it is possible to get Samba to do all its username/password validation using a specific remote server\&.
7587
 
.sp
7588
 
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\&.
7589
 
.sp
7590
 
If parameter is a name, it is looked up using the parameter
7591
 
\m[blue]\fBname resolve order\fR\m[]
7592
 
and so may resolved by any method and order described in that parameter\&.
7593
 
.sp
7594
 
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\&.
7595
 
.if n \{\
7596
 
.sp
7597
 
.\}
7598
 
.RS 4
7599
 
.BM yellow
7600
 
.it 1 an-trap
7601
 
.nr an-no-space-flag 1
7602
 
.nr an-break-flag 1
7603
 
.br
7604
 
.ps +1
7605
 
\fBNote\fR
7606
 
.ps -1
7607
 
.br
7608
 
Using a password server means your UNIX box (running Samba) is only as secure as your password server\&.
7609
 
\fIDO NOT CHOOSE A PASSWORD SERVER THAT YOU DON\'T COMPLETELY TRUST\fR\&.
7610
 
.sp .5v
7611
 
.EM yellow
7612
 
.RE
7613
 
Never point a Samba server at itself for password serving\&. This will cause a loop and could lock up your Samba server!
7614
 
.sp
7615
 
The name of the password server takes the standard substitutions, but probably the only useful one is
7616
 
\fI%m \fR, 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!
7617
 
.sp
7618
 
If the
7619
 
\fIsecurity\fR
7620
 
parameter is set to
7621
 
\fBdomain\fR
7622
 
or
7623
 
\fBads\fR, 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
7624
 
\FC security = domain\F[]
7625
 
is that if you list several hosts in the
7626
 
\fIpassword server\fR
7627
 
option then
7628
 
\FCsmbd \F[]
7629
 
will try each in turn till it finds one that responds\&. This is useful in case your primary server goes down\&.
7630
 
.sp
7631
 
If the
7632
 
\fIpassword server\fR
7633
 
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
7634
 
\fBWORKGROUP<1C>\fR
7635
 
and then contacting each server returned in the list of IP addresses from the name resolution source\&.
7636
 
.sp
7637
 
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\&.
7638
 
.sp
7639
 
If the
7640
 
\fIsecurity\fR
7641
 
parameter is set to
7642
 
\fBserver\fR, then there are different restrictions that
7643
 
\FCsecurity = domain\F[]
7644
 
doesn\'t suffer from:
7645
 
.sp
7646
 
.RS 4
7647
 
.ie n \{\
7648
 
\h'-04'\(bu\h'+03'\c
7649
 
.\}
7650
 
.el \{\
7651
 
.sp -1
7652
 
.IP \(bu 2.3
7653
 
.\}
7654
 
You may list several password servers in the
7655
 
\fIpassword server\fR
7656
 
parameter, however if an
7657
 
\FCsmbd\F[]
7658
 
makes a connection to a password server, and then the password server fails, no more users will be able to be authenticated from this
7659
 
\FCsmbd\F[]\&. This is a restriction of the SMB/CIFS protocol when in
7660
 
\FCsecurity = server \F[]
7661
 
mode and cannot be fixed in Samba\&.
7662
 
.RE
7663
 
.sp
7664
 
.RS 4
7665
 
.ie n \{\
7666
 
\h'-04'\(bu\h'+03'\c
7667
 
.\}
7668
 
.el \{\
7669
 
.sp -1
7670
 
.IP \(bu 2.3
7671
 
.\}
7672
 
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
7673
 
\FC security = server\F[]
7674
 
mode the network logon will appear to come from there rather than from the users workstation\&.
7675
 
.sp
7676
 
.RE
7677
 
Default:
7678
 
\fI\fIpassword server\fR\fR\fI = \fR\fI\FC*\F[]\fR\fI \fR
7679
 
.sp
7680
 
Example:
7681
 
\fI\fIpassword server\fR\fR\fI = \fR\fI\FCNT\-PDC, NT\-BDC1, NT\-BDC2, *\F[]\fR\fI \fR
7682
 
.sp
7683
 
Example:
7684
 
\fI\fIpassword server\fR\fR\fI = \fR\fI\FCwindc\&.mydomain\&.com:389 192\&.168\&.1\&.101 *\F[]\fR\fI \fR
7685
 
.RE
7686
 
 
7687
 
directory
7688
 
.\" directory
7689
 
.PP
7690
 
.RS 4
7691
 
This parameter is a synonym for
7692
 
path\&.
7693
 
.RE
7694
 
 
7695
 
path (S)
7696
 
.\" path
7697
 
.PP
7698
 
.RS 4
7699
 
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\&.
7700
 
.sp
7701
 
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\&.
7702
 
.sp
7703
 
Any occurrences of
7704
 
\fI%u\fR
7705
 
in the path will be replaced with the UNIX username that the client is using on this connection\&. Any occurrences of
7706
 
\fI%m\fR
7707
 
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\&.
7708
 
.sp
7709
 
Note that this path will be based on
7710
 
\m[blue]\fBroot dir\fR\m[]
7711
 
if one was specified\&.
7712
 
.sp
7713
 
Default:
7714
 
\fI\fIpath\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7715
 
.sp
7716
 
Example:
7717
 
\fI\fIpath\fR\fR\fI = \fR\fI\FC/home/fred\F[]\fR\fI \fR
7718
 
.RE
7719
 
 
7720
 
perfcount module (G)
7721
 
.\" perfcount module
7722
 
.PP
7723
 
.RS 4
7724
 
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\&.
7725
 
.sp
7726
 
\fINo default\fR
7727
 
.RE
7728
 
 
7729
 
pid directory (G)
7730
 
.\" pid directory
7731
 
.PP
7732
 
.RS 4
7733
 
This option specifies the directory where pid files will be placed\&.
7734
 
.sp
7735
 
Default:
7736
 
\fI\fIpid directory\fR\fR\fI = \fR\fI\FC${prefix}/var/locks\F[]\fR\fI \fR
7737
 
.sp
7738
 
Example:
7739
 
\fI\fIpid directory\fR\fR\fI = \fR\fI\FCpid directory = /var/run/\F[]\fR\fI \fR
7740
 
.RE
7741
 
 
7742
 
posix locking (S)
7743
 
.\" posix locking
7744
 
.PP
7745
 
.RS 4
7746
 
The
7747
 
\fBsmbd\fR(8)
7748
 
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\&.
7749
 
.sp
7750
 
Default:
7751
 
\fI\fIposix locking\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7752
 
.RE
7753
 
 
7754
 
postexec (S)
7755
 
.\" postexec
7756
 
.PP
7757
 
.RS 4
7758
 
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\&.
7759
 
.sp
7760
 
An interesting example may be to unmount server resources:
7761
 
.sp
7762
 
\FCpostexec = /etc/umount /cdrom\F[]
7763
 
.sp
7764
 
Default:
7765
 
\fI\fIpostexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7766
 
.sp
7767
 
Example:
7768
 
\fI\fIpostexec\fR\fR\fI = \fR\fI\FCecho \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log\F[]\fR\fI \fR
7769
 
.RE
7770
 
 
7771
 
preexec close (S)
7772
 
.\" preexec close
7773
 
.PP
7774
 
.RS 4
7775
 
This boolean option controls whether a non\-zero return code from
7776
 
\m[blue]\fBpreexec\fR\m[]
7777
 
should close the service being connected to\&.
7778
 
.sp
7779
 
Default:
7780
 
\fI\fIpreexec close\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7781
 
.RE
7782
 
 
7783
 
exec
7784
 
.\" exec
7785
 
.PP
7786
 
.RS 4
7787
 
This parameter is a synonym for
7788
 
preexec\&.
7789
 
.RE
7790
 
 
7791
 
preexec (S)
7792
 
.\" preexec
7793
 
.PP
7794
 
.RS 4
7795
 
This option specifies a command to be run whenever the service is connected to\&. It takes the usual substitutions\&.
7796
 
.sp
7797
 
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:
7798
 
.sp
7799
 
 
7800
 
\FCpreexec = csh \-c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient \-M %m \-I %I\' & \F[]
7801
 
.sp
7802
 
Of course, this could get annoying after a while :\-)
7803
 
.sp
7804
 
See also
7805
 
\m[blue]\fBpreexec close\fR\m[]
7806
 
and
7807
 
\m[blue]\fBpostexec\fR\m[]\&.
7808
 
.sp
7809
 
Default:
7810
 
\fI\fIpreexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7811
 
.sp
7812
 
Example:
7813
 
\fI\fIpreexec\fR\fR\fI = \fR\fI\FCecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\F[]\fR\fI \fR
7814
 
.RE
7815
 
 
7816
 
prefered master
7817
 
.\" prefered master
7818
 
.PP
7819
 
.RS 4
7820
 
This parameter is a synonym for
7821
 
preferred master\&.
7822
 
.RE
7823
 
 
7824
 
preferred master (G)
7825
 
.\" preferred master
7826
 
.PP
7827
 
.RS 4
7828
 
This boolean parameter controls if
7829
 
\fBnmbd\fR(8)
7830
 
is a preferred master browser for its workgroup\&.
7831
 
.sp
7832
 
If this is set to
7833
 
\fByes\fR, on startup,
7834
 
\FCnmbd\F[]
7835
 
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
7836
 
\m[blue]\fBdomain master = yes\fR\m[], so that
7837
 
\FCnmbd\F[]
7838
 
can guarantee becoming a domain master\&.
7839
 
.sp
7840
 
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\&.
7841
 
.sp
7842
 
Default:
7843
 
\fI\fIpreferred master\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
7844
 
.RE
7845
 
 
7846
 
preload modules (G)
7847
 
.\" preload modules
7848
 
.PP
7849
 
.RS 4
7850
 
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\&.
7851
 
.sp
7852
 
Default:
7853
 
\fI\fIpreload modules\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7854
 
.sp
7855
 
Example:
7856
 
\fI\fIpreload modules\fR\fR\fI = \fR\fI\FC/usr/lib/samba/passdb/mysql\&.so\F[]\fR\fI \fR
7857
 
.RE
7858
 
 
7859
 
auto services
7860
 
.\" auto services
7861
 
.PP
7862
 
.RS 4
7863
 
This parameter is a synonym for
7864
 
preload\&.
7865
 
.RE
7866
 
 
7867
 
preload (G)
7868
 
.\" preload
7869
 
.PP
7870
 
.RS 4
7871
 
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\&.
7872
 
.sp
7873
 
Note that if you just want all printers in your printcap file loaded then the
7874
 
\m[blue]\fBload printers\fR\m[]
7875
 
option is easier\&.
7876
 
.sp
7877
 
Default:
7878
 
\fI\fIpreload\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
7879
 
.sp
7880
 
Example:
7881
 
\fI\fIpreload\fR\fR\fI = \fR\fI\FCfred lp colorlp\F[]\fR\fI \fR
7882
 
.RE
7883
 
 
7884
 
preserve case (S)
7885
 
.\" preserve case
7886
 
.PP
7887
 
.RS 4
7888
 
This controls if new filenames are created with the case that the client passes, or if they are forced to be the
7889
 
\m[blue]\fBdefault case\fR\m[]\&.
7890
 
.sp
7891
 
See the section on
7892
 
NAME MANGLING
7893
 
for a fuller discussion\&.
7894
 
.sp
7895
 
Default:
7896
 
\fI\fIpreserve case\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
7897
 
.RE
7898
 
 
7899
 
print ok
7900
 
.\" print ok
7901
 
.PP
7902
 
.RS 4
7903
 
This parameter is a synonym for
7904
 
printable\&.
7905
 
.RE
7906
 
 
7907
 
printable (S)
7908
 
.\" printable
7909
 
.PP
7910
 
.RS 4
7911
 
If this parameter is
7912
 
\fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\&.
7913
 
.sp
7914
 
Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\&. The
7915
 
\m[blue]\fBread only\fR\m[]
7916
 
parameter controls only non\-printing access to the resource\&.
7917
 
.sp
7918
 
Default:
7919
 
\fI\fIprintable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
7920
 
.RE
7921
 
 
7922
 
printcap cache time (G)
7923
 
.\" printcap cache time
7924
 
.PP
7925
 
.RS 4
7926
 
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\&.
7927
 
.sp
7928
 
Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\&.
7929
 
.sp
7930
 
Default:
7931
 
\fI\fIprintcap cache time\fR\fR\fI = \fR\fI\FC750\F[]\fR\fI \fR
7932
 
.sp
7933
 
Example:
7934
 
\fI\fIprintcap cache time\fR\fR\fI = \fR\fI\FC600\F[]\fR\fI \fR
7935
 
.RE
7936
 
 
7937
 
printcap
7938
 
.\" printcap
7939
 
.PP
7940
 
.RS 4
7941
 
This parameter is a synonym for
7942
 
printcap name\&.
7943
 
.RE
7944
 
 
7945
 
printcap name (G)
7946
 
.\" printcap name
7947
 
.PP
7948
 
.RS 4
7949
 
This parameter may be used to override the compiled\-in default printcap name used by the server (usually
7950
 
\FC /etc/printcap\F[])\&. See the discussion of the
7951
 
[printers]
7952
 
section above for reasons why you might want to do this\&.
7953
 
.sp
7954
 
To use the CUPS printing interface set
7955
 
\FCprintcap name = cups \F[]\&. This should be supplemented by an addtional setting
7956
 
\m[blue]\fBprinting = cups\fR\m[]
7957
 
in the [global] section\&.
7958
 
\FCprintcap name = cups\F[]
7959
 
will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\&.
7960
 
.sp
7961
 
On System V systems that use
7962
 
\FClpstat\F[]
7963
 
to list available printers you can use
7964
 
\FCprintcap name = lpstat \F[]
7965
 
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
7966
 
\fI printcap name\fR
7967
 
is set to
7968
 
\FClpstat\F[]
7969
 
on these systems then Samba will launch
7970
 
\FClpstat \-v\F[]
7971
 
and attempt to parse the output to obtain a printer list\&.
7972
 
.sp
7973
 
A minimal printcap file would look something like this:
7974
 
.sp
7975
 
.if n \{\
7976
 
.RS 4
7977
 
.\}
7978
 
.fam C
7979
 
.ps -1
7980
 
.nf
7981
 
.if t \{\
7982
 
.sp -1
7983
 
.\}
7984
 
.BB lightgray adjust-for-leading-newline
7985
 
.sp -1
7986
 
 
7987
 
print1|My Printer 1
7988
 
print2|My Printer 2
7989
 
print3|My Printer 3
7990
 
print4|My Printer 4
7991
 
print5|My Printer 5
7992
 
.EB lightgray adjust-for-leading-newline
7993
 
.if t \{\
7994
 
.sp 1
7995
 
.\}
7996
 
.fi
7997
 
.fam
7998
 
.ps +1
7999
 
.if n \{\
8000
 
.RE
8001
 
.\}
8002
 
.sp
8003
 
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\&.
8004
 
.if n \{\
8005
 
.sp
8006
 
.\}
8007
 
.RS 4
8008
 
.BM yellow
8009
 
.it 1 an-trap
8010
 
.nr an-no-space-flag 1
8011
 
.nr an-break-flag 1
8012
 
.br
8013
 
.ps +1
8014
 
\fBNote\fR
8015
 
.ps -1
8016
 
.br
8017
 
Under AIX the default printcap name is
8018
 
\FC/etc/qconfig\F[]\&. Samba will assume the file is in AIX
8019
 
\FCqconfig\F[]
8020
 
format if the string
8021
 
\FCqconfig\F[]
8022
 
appears in the printcap filename\&.
8023
 
.sp .5v
8024
 
.EM yellow
8025
 
.RE
8026
 
Default:
8027
 
\fI\fIprintcap name\fR\fR\fI = \fR\fI\FC/etc/printcap\F[]\fR\fI \fR
8028
 
.sp
8029
 
Example:
8030
 
\fI\fIprintcap name\fR\fR\fI = \fR\fI\FC/etc/myprintcap\F[]\fR\fI \fR
8031
 
.RE
8032
 
 
8033
 
print command (S)
8034
 
.\" print command
8035
 
.PP
8036
 
.RS 4
8037
 
After a print job has finished spooling to a service, this command will be used via a
8038
 
\FCsystem()\F[]
8039
 
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\&.
8040
 
.sp
8041
 
The print command is simply a text string\&. It will be used verbatim after macro substitutions have been made:
8042
 
.sp
8043
 
%s, %f \- the path to the spool file name
8044
 
.sp
8045
 
%p \- the appropriate printer name
8046
 
.sp
8047
 
%J \- the job name as transmitted by the client\&.
8048
 
.sp
8049
 
%c \- The number of printed pages of the spooled job (if known)\&.
8050
 
.sp
8051
 
%z \- the size of the spooled print job (in bytes)
8052
 
.sp
8053
 
The print command
8054
 
\fIMUST\fR
8055
 
contain at least one occurrence of
8056
 
\fI%s\fR
8057
 
or
8058
 
\fI%f \fR
8059
 
\- the
8060
 
\fI%p\fR
8061
 
is optional\&. At the time a job is submitted, if no printer name is supplied the
8062
 
\fI%p \fR
8063
 
will be silently removed from the printer command\&.
8064
 
.sp
8065
 
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\&.
8066
 
.sp
8067
 
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\&.
8068
 
.sp
8069
 
Note that printing may fail on some UNIXes from the
8070
 
\fBnobody\fR
8071
 
account\&. If this happens then create an alternative guest account that can print and set the
8072
 
\m[blue]\fBguest account\fR\m[]
8073
 
in the [global] section\&.
8074
 
.sp
8075
 
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\&.
8076
 
.sp
8077
 
\FCprint command = echo Printing %s >> /tmp/print\&.log; lpr \-P %p %s; rm %s\F[]
8078
 
.sp
8079
 
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
8080
 
\m[blue]\fBprinting\fR\m[]
8081
 
parameter\&.
8082
 
.sp
8083
 
Default: For
8084
 
\FCprinting = BSD, AIX, QNX, LPRNG or PLP :\F[]
8085
 
.sp
8086
 
\FCprint command = lpr \-r \-P%p %s\F[]
8087
 
.sp
8088
 
For
8089
 
\FCprinting = SYSV or HPUX :\F[]
8090
 
.sp
8091
 
\FCprint command = lp \-c \-d%p %s; rm %s\F[]
8092
 
.sp
8093
 
For
8094
 
\FCprinting = SOFTQ :\F[]
8095
 
.sp
8096
 
\FCprint command = lp \-d%p \-s %s; rm %s\F[]
8097
 
.sp
8098
 
For printing = CUPS : If SAMBA is compiled against libcups, then
8099
 
\m[blue]\fBprintcap = cups\fR\m[]
8100
 
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
8101
 
\FClp \-c \-d%p \-oraw; rm %s\F[]\&. With
8102
 
\FCprinting = cups\F[], and if SAMBA is compiled against libcups, any manually set print command will be ignored\&.
8103
 
.sp
8104
 
\fINo default\fR
8105
 
.sp
8106
 
Example:
8107
 
\fI\fIprint command\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/myprintscript %p %s\F[]\fR\fI \fR
8108
 
.RE
8109
 
 
8110
 
printer admin (S)
8111
 
.\" printer admin
8112
 
.PP
8113
 
.RS 4
8114
 
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\&.
8115
 
.sp
8116
 
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\&.
8117
 
.sp
8118
 
Default:
8119
 
\fI\fIprinter admin\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8120
 
.sp
8121
 
Example:
8122
 
\fI\fIprinter admin\fR\fR\fI = \fR\fI\FCadmin, @staff\F[]\fR\fI \fR
8123
 
.RE
8124
 
 
8125
 
printer
8126
 
.\" printer
8127
 
.PP
8128
 
.RS 4
8129
 
This parameter is a synonym for
8130
 
printer name\&.
8131
 
.RE
8132
 
 
8133
 
printer name (S)
8134
 
.\" printer name
8135
 
.PP
8136
 
.RS 4
8137
 
This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\&.
8138
 
.sp
8139
 
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\&.
8140
 
.sp
8141
 
The default value of the
8142
 
\m[blue]\fBprinter name\fR\m[]
8143
 
may be
8144
 
\FClp\F[]
8145
 
on many systems\&.
8146
 
.sp
8147
 
Default:
8148
 
\fI\fIprinter name\fR\fR\fI = \fR\fI\FCnone\F[]\fR\fI \fR
8149
 
.sp
8150
 
Example:
8151
 
\fI\fIprinter name\fR\fR\fI = \fR\fI\FClaserwriter\F[]\fR\fI \fR
8152
 
.RE
8153
 
 
8154
 
printing (S)
8155
 
.\" printing
8156
 
.PP
8157
 
.RS 4
8158
 
This parameters controls how printer status information is interpreted on your system\&. It also affects the default values for the
8159
 
\fIprint command\fR,
8160
 
\fIlpq command\fR,
8161
 
\fIlppause command \fR,
8162
 
\fIlpresume command\fR, and
8163
 
\fIlprm command\fR
8164
 
if specified in the [global] section\&.
8165
 
.sp
8166
 
Currently nine printing styles are supported\&. They are
8167
 
\fBBSD\fR,
8168
 
\fBAIX\fR,
8169
 
\fBLPRNG\fR,
8170
 
\fBPLP\fR,
8171
 
\fBSYSV\fR,
8172
 
\fBHPUX\fR,
8173
 
\fBQNX\fR,
8174
 
\fBSOFTQ\fR, and
8175
 
\fBCUPS\fR\&.
8176
 
.sp
8177
 
To see what the defaults are for the other print commands when using the various options use the
8178
 
\fBtestparm\fR(1)
8179
 
program\&.
8180
 
.sp
8181
 
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
8182
 
\fIprinting\fR
8183
 
option since it will reset the printing commands to default values\&.
8184
 
.sp
8185
 
See also the discussion in the
8186
 
[printers]
8187
 
section\&.
8188
 
.sp
8189
 
Default:
8190
 
\fI\fIprinting\fR\fR\fI = \fR\fI\FCDepends on the operating system, see \FCtestparm \-v\&.\F[]\F[]\fR\fI \fR
8191
 
.RE
8192
 
 
8193
 
printjob username (S)
8194
 
.\" printjob username
8195
 
.PP
8196
 
.RS 4
8197
 
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\&.
8198
 
.sp
8199
 
Default:
8200
 
\fI\fIprintjob username\fR\fR\fI = \fR\fI\FC%U\F[]\fR\fI \fR
8201
 
.sp
8202
 
Example:
8203
 
\fI\fIprintjob username\fR\fR\fI = \fR\fI\FC%D\e%U\F[]\fR\fI \fR
8204
 
.RE
8205
 
 
8206
 
private dir (G)
8207
 
.\" private dir
8208
 
.PP
8209
 
.RS 4
8210
 
This parameters defines the directory smbd will use for storing such files as
8211
 
\FCsmbpasswd\F[]
8212
 
and
8213
 
\FCsecrets\&.tdb\F[]\&.
8214
 
.sp
8215
 
Default:
8216
 
\fI\fIprivate dir\fR\fR\fI = \fR\fI\FC${prefix}/private\F[]\fR\fI \fR
8217
 
.RE
8218
 
 
8219
 
profile acls (S)
8220
 
.\" profile acls
8221
 
.PP
8222
 
.RS 4
8223
 
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\&.
8224
 
.sp
8225
 
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\e\eAdministrators, BUILTIN\e\eUsers 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\e\eUsers to every returned ACL\&. This will allow any Windows 2000 or XP workstation user to access the profile\&.
8226
 
.sp
8227
 
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\&.
8228
 
.sp
8229
 
Default:
8230
 
\fI\fIprofile acls\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
8231
 
.RE
8232
 
 
8233
 
queuepause command (S)
8234
 
.\" queuepause command
8235
 
.PP
8236
 
.RS 4
8237
 
This parameter specifies the command to be executed on the server host in order to pause the printer queue\&.
8238
 
.sp
8239
 
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\&.
8240
 
.sp
8241
 
This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
8242
 
.sp
8243
 
If a
8244
 
\fI%p\fR
8245
 
is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
8246
 
.sp
8247
 
Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
8248
 
.sp
8249
 
\fINo default\fR
8250
 
.sp
8251
 
Example:
8252
 
\fI\fIqueuepause command\fR\fR\fI = \fR\fI\FCdisable %p\F[]\fR\fI \fR
8253
 
.RE
8254
 
 
8255
 
queueresume command (S)
8256
 
.\" queueresume command
8257
 
.PP
8258
 
.RS 4
8259
 
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 (\m[blue]\fBqueuepause command\fR\m[])\&.
8260
 
.sp
8261
 
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\&.
8262
 
.sp
8263
 
This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
8264
 
.sp
8265
 
If a
8266
 
\fI%p\fR
8267
 
is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
8268
 
.sp
8269
 
Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
8270
 
.sp
8271
 
Default:
8272
 
\fI\fIqueueresume command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8273
 
.sp
8274
 
Example:
8275
 
\fI\fIqueueresume command\fR\fR\fI = \fR\fI\FCenable %p\F[]\fR\fI \fR
8276
 
.RE
8277
 
 
8278
 
read list (S)
8279
 
.\" read list
8280
 
.PP
8281
 
.RS 4
8282
 
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
8283
 
\m[blue]\fBread only\fR\m[]
8284
 
option is set to\&. The list can include group names using the syntax described in the
8285
 
\m[blue]\fBinvalid users\fR\m[]
8286
 
parameter\&.
8287
 
.sp
8288
 
This parameter will not work with the
8289
 
\m[blue]\fBsecurity = share\fR\m[]
8290
 
in Samba 3\&.0\&. This is by design\&.
8291
 
.sp
8292
 
Default:
8293
 
\fI\fIread list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8294
 
.sp
8295
 
Example:
8296
 
\fI\fIread list\fR\fR\fI = \fR\fI\FCmary, @students\F[]\fR\fI \fR
8297
 
.RE
8298
 
 
8299
 
read only (S)
8300
 
.\" read only
8301
 
.PP
8302
 
.RS 4
8303
 
An inverted synonym is
8304
 
\m[blue]\fBwriteable\fR\m[]\&.
8305
 
.sp
8306
 
If this parameter is
8307
 
\fByes\fR, then users of a service may not create or modify files in the service\'s directory\&.
8308
 
.sp
8309
 
Note that a printable service (\FCprintable = yes\F[]) will
8310
 
\fIALWAYS\fR
8311
 
allow writing to the directory (user privileges permitting), but only via spooling operations\&.
8312
 
.sp
8313
 
Default:
8314
 
\fI\fIread only\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
8315
 
.RE
8316
 
 
8317
 
read raw (G)
8318
 
.\" read raw
8319
 
.PP
8320
 
.RS 4
8321
 
This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients\&.
8322
 
.sp
8323
 
If enabled, raw reads allow reads of 65535 bytes in one packet\&. This typically provides a major performance benefit\&.
8324
 
.sp
8325
 
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\&.
8326
 
.sp
8327
 
In general this parameter should be viewed as a system tuning tool and left severely alone\&.
8328
 
.sp
8329
 
Default:
8330
 
\fI\fIread raw\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
8331
 
.RE
8332
 
 
8333
 
realm (G)
8334
 
.\" realm
8335
 
.PP
8336
 
.RS 4
8337
 
This option specifies the kerberos realm to use\&. The realm is used as the ADS equivalent of the NT4
8338
 
\FCdomain\F[]\&. It is usually set to the DNS name of the kerberos server\&.
8339
 
.sp
8340
 
Default:
8341
 
\fI\fIrealm\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8342
 
.sp
8343
 
Example:
8344
 
\fI\fIrealm\fR\fR\fI = \fR\fI\FCmysambabox\&.mycompany\&.com\F[]\fR\fI \fR
8345
 
.RE
8346
 
 
8347
 
registry shares (G)
8348
 
.\" registry shares
8349
 
.PP
8350
 
.RS 4
8351
 
This turns on or off support for share definitions read from registry\&. Shares defined in
8352
 
\fIsmb\&.conf\fR
8353
 
take precedence over shares with the same name defined in registry\&. See the section on registry\-based configuration for details\&.
8354
 
.sp
8355
 
Note that this parameter defaults to
8356
 
\fIno\fR, but it is set to
8357
 
\fIyes\fR
8358
 
when
8359
 
\fIconfig backend\fR
8360
 
is set to
8361
 
\fIregistry\fR\&.
8362
 
.sp
8363
 
Default:
8364
 
\fI\fIregistry shares\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
8365
 
.sp
8366
 
Example:
8367
 
\fI\fIregistry shares\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
8368
 
.RE
8369
 
 
8370
 
remote announce (G)
8371
 
.\" remote announce
8372
 
.PP
8373
 
.RS 4
8374
 
This option allows you to setup
8375
 
\fBnmbd\fR(8)
8376
 
to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name\&.
8377
 
.sp
8378
 
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\&.
8379
 
.sp
8380
 
For example:
8381
 
.sp
8382
 
.if n \{\
8383
 
.RS 4
8384
 
.\}
8385
 
.fam C
8386
 
.ps -1
8387
 
.nf
8388
 
.if t \{\
8389
 
.sp -1
8390
 
.\}
8391
 
.BB lightgray adjust-for-leading-newline
8392
 
.sp -1
8393
 
 
8394
 
\FCremote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\F[]
8395
 
.EB lightgray adjust-for-leading-newline
8396
 
.if t \{\
8397
 
.sp 1
8398
 
.\}
8399
 
.fi
8400
 
.fam
8401
 
.ps +1
8402
 
.if n \{\
8403
 
.RE
8404
 
.\}
8405
 
.sp
8406
 
the above line would cause
8407
 
\FCnmbd\F[]
8408
 
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
8409
 
\m[blue]\fBworkgroup\fR\m[]
8410
 
parameter is used instead\&.
8411
 
.sp
8412
 
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\&.
8413
 
.sp
8414
 
See the chapter on Network Browsing in the Samba\-HOWTO book\&.
8415
 
.sp
8416
 
Default:
8417
 
\fI\fIremote announce\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8418
 
.RE
8419
 
 
8420
 
remote browse sync (G)
8421
 
.\" remote browse sync
8422
 
.PP
8423
 
.RS 4
8424
 
This option allows you to setup
8425
 
\fBnmbd\fR(8)
8426
 
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\&.
8427
 
.sp
8428
 
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\&.
8429
 
.sp
8430
 
For example:
8431
 
.sp
8432
 
.if n \{\
8433
 
.RS 4
8434
 
.\}
8435
 
.fam C
8436
 
.ps -1
8437
 
.nf
8438
 
.if t \{\
8439
 
.sp -1
8440
 
.\}
8441
 
.BB lightgray adjust-for-leading-newline
8442
 
.sp -1
8443
 
 
8444
 
\fIremote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fR
8445
 
.EB lightgray adjust-for-leading-newline
8446
 
.if t \{\
8447
 
.sp 1
8448
 
.\}
8449
 
.fi
8450
 
.fam
8451
 
.ps +1
8452
 
.if n \{\
8453
 
.RE
8454
 
.\}
8455
 
.sp
8456
 
the above line would cause
8457
 
\FCnmbd\F[]
8458
 
to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server\&.
8459
 
.sp
8460
 
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\&.
8461
 
.sp
8462
 
The
8463
 
\m[blue]\fBremote browse sync\fR\m[]
8464
 
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\&.
8465
 
.sp
8466
 
Default:
8467
 
\fI\fIremote browse sync\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8468
 
.RE
8469
 
 
8470
 
rename user script (G)
8471
 
.\" rename user script
8472
 
.PP
8473
 
.RS 4
8474
 
This is the full pathname to a script that will be run as root by
8475
 
\fBsmbd\fR(8)
8476
 
under special circumstances described below\&.
8477
 
.sp
8478
 
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,
8479
 
\FC%uold\F[]
8480
 
and
8481
 
\FC%unew\F[], will be substituted with the old and new usernames, respectively\&. The script should return 0 upon successful completion, and nonzero otherwise\&.
8482
 
.if n \{\
8483
 
.sp
8484
 
.\}
8485
 
.RS 4
8486
 
.BM yellow
8487
 
.it 1 an-trap
8488
 
.nr an-no-space-flag 1
8489
 
.nr an-break-flag 1
8490
 
.br
8491
 
.ps +1
8492
 
\fBNote\fR
8493
 
.ps -1
8494
 
.br
8495
 
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\&.
8496
 
.sp .5v
8497
 
.EM yellow
8498
 
.RE
8499
 
Default:
8500
 
\fI\fIrename user script\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
8501
 
.RE
8502
 
 
8503
 
reset on zero vc (G)
8504
 
.\" reset on zero vc
8505
 
.PP
8506
 
.RS 4
8507
 
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\&.
8508
 
.sp
8509
 
Default:
8510
 
\fI\fIreset on zero vc\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
8511
 
.RE
8512
 
 
8513
 
restrict anonymous (G)
8514
 
.\" restrict anonymous
8515
 
.PP
8516
 
.RS 4
8517
 
The setting of this parameter determines whether user and group list information is returned for an anonymous connection\&. and mirrors the effects of the
8518
 
.sp
8519
 
.if n \{\
8520
 
.RS 4
8521
 
.\}
8522
 
.fam C
8523
 
.ps -1
8524
 
.nf
8525
 
.if t \{\
8526
 
.sp -1
8527
 
.\}
8528
 
.BB lightgray adjust-for-leading-newline
8529
 
.sp -1
8530
 
 
8531
 
HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\e
8532
 
           Control\eLSA\eRestrictAnonymous
8533
 
.EB lightgray adjust-for-leading-newline
8534
 
.if t \{\
8535
 
.sp 1
8536
 
.\}
8537
 
.fi
8538
 
.fam
8539
 
.ps +1
8540
 
.if n \{\
8541
 
.RE
8542
 
.\}
8543
 
.sp
8544
 
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\&.
8545
 
.sp
8546
 
The security advantage of using restrict anonymous = 1 is dubious, as user and group list information can be obtained using other means\&.
8547
 
.if n \{\
8548
 
.sp
8549
 
.\}
8550
 
.RS 4
8551
 
.BM yellow
8552
 
.it 1 an-trap
8553
 
.nr an-no-space-flag 1
8554
 
.nr an-break-flag 1
8555
 
.br
8556
 
.ps +1
8557
 
\fBNote\fR
8558
 
.ps -1
8559
 
.br
8560
 
The security advantage of using restrict anonymous = 2 is removed by setting
8561
 
\m[blue]\fBguest ok = yes\fR\m[]
8562
 
on any share\&.
8563
 
.sp .5v
8564
 
.EM yellow
8565
 
.RE
8566
 
Default:
8567
 
\fI\fIrestrict anonymous\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
8568
 
.RE
8569
 
 
8570
 
root
8571
 
.\" root
8572
 
.PP
8573
 
.RS 4
8574
 
This parameter is a synonym for
8575
 
root directory\&.
8576
 
.RE
8577
 
 
8578
 
root dir
8579
 
.\" root dir
8580
 
.PP
8581
 
.RS 4
8582
 
This parameter is a synonym for
8583
 
root directory\&.
8584
 
.RE
8585
 
 
8586
 
root directory (G)
8587
 
.\" root directory
8588
 
.PP
8589
 
.RS 4
8590
 
The server will
8591
 
\FCchroot()\F[]
8592
 
(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
8593
 
\m[blue]\fBwide smbconfoptions\fR\m[]
8594
 
parameter)\&.
8595
 
.sp
8596
 
Adding a
8597
 
\fIroot directory\fR
8598
 
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
8599
 
\fIroot directory\fR
8600
 
option,
8601
 
\fIincluding\fR
8602
 
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
8603
 
\fIroot directory\fR
8604
 
tree\&. In particular you will need to mirror
8605
 
\FC/etc/passwd\F[]
8606
 
(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\&.
8607
 
.sp
8608
 
Default:
8609
 
\fI\fIroot directory\fR\fR\fI = \fR\fI\FC/\F[]\fR\fI \fR
8610
 
.sp
8611
 
Example:
8612
 
\fI\fIroot directory\fR\fR\fI = \fR\fI\FC/homes/smb\F[]\fR\fI \fR
8613
 
.RE
8614
 
 
8615
 
root postexec (S)
8616
 
.\" root postexec
8617
 
.PP
8618
 
.RS 4
8619
 
This is the same as the
8620
 
\fIpostexec\fR
8621
 
parameter except that the command is run as root\&. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed\&.
8622
 
.sp
8623
 
Default:
8624
 
\fI\fIroot postexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8625
 
.RE
8626
 
 
8627
 
root preexec close (S)
8628
 
.\" root preexec close
8629
 
.PP
8630
 
.RS 4
8631
 
This is the same as the
8632
 
\fIpreexec close \fR
8633
 
parameter except that the command is run as root\&.
8634
 
.sp
8635
 
Default:
8636
 
\fI\fIroot preexec close\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
8637
 
.RE
8638
 
 
8639
 
root preexec (S)
8640
 
.\" root preexec
8641
 
.PP
8642
 
.RS 4
8643
 
This is the same as the
8644
 
\fIpreexec\fR
8645
 
parameter except that the command is run as root\&. This is useful for mounting filesystems (such as CDROMs) when a connection is opened\&.
8646
 
.sp
8647
 
Default:
8648
 
\fI\fIroot preexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
8649
 
.RE
8650
 
 
8651
 
security mask (S)
8652
 
.\" security mask
8653
 
.PP
8654
 
.RS 4
8655
 
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\&.
8656
 
.sp
8657
 
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
8658
 
\m[blue]\fBforce security mode\fR\m[], which works in a manner similar to this one but uses a logical OR instead of an AND\&.
8659
 
.sp
8660
 
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\&.
8661
 
.sp
8662
 
If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file\&.
8663
 
.sp
8664
 
\fI Note\fR
8665
 
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
8666
 
\fB0777\fR\&.
8667
 
.sp
8668
 
Default:
8669
 
\fI\fIsecurity mask\fR\fR\fI = \fR\fI\FC0777\F[]\fR\fI \fR
8670
 
.sp
8671
 
Example:
8672
 
\fI\fIsecurity mask\fR\fR\fI = \fR\fI\FC0770\F[]\fR\fI \fR
8673
 
.RE
8674
 
 
8675
 
security (G)
8676
 
.\" security
8677
 
.PP
8678
 
.RS 4
8679
 
This option affects how clients respond to Samba and is one of the most important settings in the
8680
 
\FC smb\&.conf\F[]
8681
 
file\&.
8682
 
.sp
8683
 
The option sets the "security mode bit" in replies to protocol negotiations with
8684
 
\fBsmbd\fR(8)
8685
 
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\&.
8686
 
.sp
8687
 
The default is
8688
 
\FCsecurity = user\F[], as this is the most common setting needed when talking to Windows 98 and Windows NT\&.
8689
 
.sp
8690
 
The alternatives are
8691
 
\FCsecurity = share\F[],
8692
 
\FCsecurity = server\F[]
8693
 
or
8694
 
\FCsecurity = domain \F[]\&.
8695
 
.sp
8696
 
In versions of Samba prior to 2\&.0\&.0, the default was
8697
 
\FCsecurity = share\F[]
8698
 
mainly because that was the only option at one stage\&.
8699
 
.sp
8700
 
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\&.
8701
 
.sp
8702
 
If your PCs use usernames that are the same as their usernames on the UNIX machine then you will want to use
8703
 
\FCsecurity = user\F[]\&. If you mostly use usernames that don\'t exist on the UNIX box then use
8704
 
\FCsecurity = share\F[]\&.
8705
 
.sp
8706
 
You should also use
8707
 
\FCsecurity = share\F[]
8708
 
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
8709
 
\FCsecurity = user\F[], see the
8710
 
\m[blue]\fBmap to guest\fR\m[]
8711
 
parameter for details\&.
8712
 
.sp
8713
 
It is possible to use
8714
 
\FCsmbd\F[]
8715
 
in a
8716
 
\fI hybrid mode\fR
8717
 
where it is offers both user and share level security under different
8718
 
\m[blue]\fBNetBIOS aliases\fR\m[]\&.
8719
 
.sp
8720
 
The different settings will now be explained\&.
8721
 
.sp
8722
 
\fISECURITY = SHARE\fR
8723
 
.sp
8724
 
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
8725
 
\FCsecurity = share \F[]
8726
 
server)\&. Instead, the clients send authentication information (passwords) on a per\-share basis, at the time they attempt to connect to that share\&.
8727
 
.sp
8728
 
Note that
8729
 
\FCsmbd\F[]
8730
 
\fIALWAYS\fR
8731
 
uses a valid UNIX user to act on behalf of the client, even in
8732
 
\FCsecurity = share\F[]
8733
 
level security\&.
8734
 
.sp
8735
 
As clients are not required to send a username to the server in share level security,
8736
 
\FCsmbd\F[]
8737
 
uses several techniques to determine the correct UNIX user to use on behalf of the client\&.
8738
 
.sp
8739
 
A list of possible UNIX usernames to match with the given client password is constructed using the following methods :
8740
 
.sp
8741
 
.RS 4
8742
 
.ie n \{\
8743
 
\h'-04'\(bu\h'+03'\c
8744
 
.\}
8745
 
.el \{\
8746
 
.sp -1
8747
 
.IP \(bu 2.3
8748
 
.\}
8749
 
If the
8750
 
\m[blue]\fBguest only\fR\m[]
8751
 
parameter is set, then all the other stages are missed and only the
8752
 
\m[blue]\fBguest account\fR\m[]
8753
 
username is checked\&.
8754
 
.RE
8755
 
.sp
8756
 
.RS 4
8757
 
.ie n \{\
8758
 
\h'-04'\(bu\h'+03'\c
8759
 
.\}
8760
 
.el \{\
8761
 
.sp -1
8762
 
.IP \(bu 2.3
8763
 
.\}
8764
 
Is a username is sent with the share connection request, then this username (after mapping \- see
8765
 
\m[blue]\fBusername map\fR\m[]), is added as a potential username\&.
8766
 
.RE
8767
 
.sp
8768
 
.RS 4
8769
 
.ie n \{\
8770
 
\h'-04'\(bu\h'+03'\c
8771
 
.\}
8772
 
.el \{\
8773
 
.sp -1
8774
 
.IP \(bu 2.3
8775
 
.\}
8776
 
If the client did a previous
8777
 
\fIlogon \fR
8778
 
request (the SessionSetup SMB call) then the username sent in this SMB will be added as a potential username\&.
8779
 
.RE
8780
 
.sp
8781
 
.RS 4
8782
 
.ie n \{\
8783
 
\h'-04'\(bu\h'+03'\c
8784
 
.\}
8785
 
.el \{\
8786
 
.sp -1
8787
 
.IP \(bu 2.3
8788
 
.\}
8789
 
The name of the service the client requested is added as a potential username\&.
8790
 
.RE
8791
 
.sp
8792
 
.RS 4
8793
 
.ie n \{\
8794
 
\h'-04'\(bu\h'+03'\c
8795
 
.\}
8796
 
.el \{\
8797
 
.sp -1
8798
 
.IP \(bu 2.3
8799
 
.\}
8800
 
The NetBIOS name of the client is added to the list as a potential username\&.
8801
 
.RE
8802
 
.sp
8803
 
.RS 4
8804
 
.ie n \{\
8805
 
\h'-04'\(bu\h'+03'\c
8806
 
.\}
8807
 
.el \{\
8808
 
.sp -1
8809
 
.IP \(bu 2.3
8810
 
.\}
8811
 
Any users on the
8812
 
\m[blue]\fBuser\fR\m[]
8813
 
list are added as potential usernames\&.
8814
 
.sp
8815
 
.RE
8816
 
If the
8817
 
\fIguest only\fR
8818
 
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\&.
8819
 
.sp
8820
 
If the
8821
 
\fIguest only\fR
8822
 
parameter is set, or no username can be determined then if the share is marked as available to the
8823
 
\fIguest account\fR, then this guest user will be used, otherwise access is denied\&.
8824
 
.sp
8825
 
Note that it can be
8826
 
\fIvery\fR
8827
 
confusing in share\-level security as to which UNIX username will eventually be used in granting access\&.
8828
 
.sp
8829
 
See also the section
8830
 
NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
8831
 
.sp
8832
 
\fISECURITY = USER\fR
8833
 
.sp
8834
 
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
8835
 
\m[blue]\fBusername map\fR\m[]
8836
 
parameter)\&. Encrypted passwords (see the
8837
 
\m[blue]\fBencrypted passwords\fR\m[]
8838
 
parameter) can also be used in this security mode\&. Parameters such as
8839
 
\m[blue]\fBuser\fR\m[]
8840
 
and
8841
 
\m[blue]\fBguest only\fR\m[]
8842
 
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\&.
8843
 
.sp
8844
 
\fINote\fR
8845
 
that the name of the resource being requested is
8846
 
\fInot\fR
8847
 
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
8848
 
\m[blue]\fBguest account\fR\m[]\&. See the
8849
 
\m[blue]\fBmap to guest\fR\m[]
8850
 
parameter for details on doing this\&.
8851
 
.sp
8852
 
See also the section
8853
 
NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
8854
 
.sp
8855
 
\fISECURITY = DOMAIN\fR
8856
 
.sp
8857
 
This mode will only work correctly if
8858
 
\fBnet\fR(8)
8859
 
has been used to add this machine into a Windows NT Domain\&. It expects the
8860
 
\m[blue]\fBencrypted passwords\fR\m[]
8861
 
parameter to be set to
8862
 
\fByes\fR\&. 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\&.
8863
 
.sp
8864
 
\fINote\fR
8865
 
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\&.
8866
 
.sp
8867
 
\fINote\fR
8868
 
that from the client\'s point of view
8869
 
\FCsecurity = domain\F[]
8870
 
is the same as
8871
 
\FCsecurity = user\F[]\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
8872
 
.sp
8873
 
\fINote\fR
8874
 
that the name of the resource being requested is
8875
 
\fInot\fR
8876
 
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
8877
 
\m[blue]\fBguest account\fR\m[]\&. See the
8878
 
\m[blue]\fBmap to guest\fR\m[]
8879
 
parameter for details on doing this\&.
8880
 
.sp
8881
 
See also the section
8882
 
NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
8883
 
.sp
8884
 
See also the
8885
 
\m[blue]\fBpassword server\fR\m[]
8886
 
parameter and the
8887
 
\m[blue]\fBencrypted passwords\fR\m[]
8888
 
parameter\&.
8889
 
.sp
8890
 
\fISECURITY = SERVER\fR
8891
 
.sp
8892
 
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
8893
 
\FCsecurity = user\F[]\&. It expects the
8894
 
\m[blue]\fBencrypted passwords\fR\m[]
8895
 
parameter to be set to
8896
 
\fByes\fR, 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
8897
 
\FCsmbpasswd\F[]
8898
 
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\&.
8899
 
.if n \{\
8900
 
.sp
8901
 
.\}
8902
 
.RS 4
8903
 
.BM yellow
8904
 
.it 1 an-trap
8905
 
.nr an-no-space-flag 1
8906
 
.nr an-break-flag 1
8907
 
.br
8908
 
.ps +1
8909
 
\fBNote\fR
8910
 
.ps -1
8911
 
.br
8912
 
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)\&.
8913
 
.sp .5v
8914
 
.EM yellow
8915
 
.RE
8916
 
.if n \{\
8917
 
.sp
8918
 
.\}
8919
 
.RS 4
8920
 
.BM yellow
8921
 
.it 1 an-trap
8922
 
.nr an-no-space-flag 1
8923
 
.nr an-break-flag 1
8924
 
.br
8925
 
.ps +1
8926
 
\fBNote\fR
8927
 
.ps -1
8928
 
.br
8929
 
From the client\'s point of view,
8930
 
\FCsecurity = server\F[]
8931
 
is the same as
8932
 
\FCsecurity = user\F[]\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
8933
 
.sp .5v
8934
 
.EM yellow
8935
 
.RE
8936
 
\fINote\fR
8937
 
that the name of the resource being requested is
8938
 
\fInot\fR
8939
 
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
8940
 
\m[blue]\fBguest account\fR\m[]\&. See the
8941
 
\m[blue]\fBmap to guest\fR\m[]
8942
 
parameter for details on doing this\&.
8943
 
.sp
8944
 
See also the section
8945
 
NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
8946
 
.sp
8947
 
See also the
8948
 
\m[blue]\fBpassword server\fR\m[]
8949
 
parameter and the
8950
 
\m[blue]\fBencrypted passwords\fR\m[]
8951
 
parameter\&.
8952
 
.sp
8953
 
\fISECURITY = ADS\fR
8954
 
.sp
8955
 
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\&.
8956
 
.sp
8957
 
Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\&.
8958
 
.sp
8959
 
Read the chapter about Domain Membership in the HOWTO for details\&.
8960
 
.sp
8961
 
Default:
8962
 
\fI\fIsecurity\fR\fR\fI = \fR\fI\FCUSER\F[]\fR\fI \fR
8963
 
.sp
8964
 
Example:
8965
 
\fI\fIsecurity\fR\fR\fI = \fR\fI\FCDOMAIN\F[]\fR\fI \fR
8966
 
.RE
8967
 
 
8968
 
server schannel (G)
8969
 
.\" server schannel
8970
 
.PP
8971
 
.RS 4
8972
 
This controls whether the server offers or even demands the use of the netlogon schannel\&.
8973
 
\m[blue]\fBserver schannel = no\fR\m[]
8974
 
does not offer the schannel,
8975
 
\m[blue]\fBserver schannel = auto\fR\m[]
8976
 
offers the schannel but does not enforce it, and
8977
 
\m[blue]\fBserver schannel = yes\fR\m[]
8978
 
denies access if the client is not able to speak netlogon schannel\&. This is only the case for Windows NT4 before SP4\&.
8979
 
.sp
8980
 
Please note that with this set to
8981
 
\FCno\F[], you will have to apply the WindowsXP
8982
 
\FCWinXP_SignOrSeal\&.reg\F[]
8983
 
registry patch found in the docs/registry subdirectory of the Samba distribution tarball\&.
8984
 
.sp
8985
 
Default:
8986
 
\fI\fIserver schannel\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
8987
 
.sp
8988
 
Example:
8989
 
\fI\fIserver schannel\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
8990
 
.RE
8991
 
 
8992
 
server signing (G)
8993
 
.\" server signing
8994
 
.PP
8995
 
.RS 4
8996
 
This controls whether the client is allowed or required to use SMB signing\&. Possible values are
8997
 
\fIauto\fR,
8998
 
\fImandatory\fR
8999
 
and
9000
 
\fIdisabled\fR\&.
9001
 
.sp
9002
 
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\&.
9003
 
.sp
9004
 
Default:
9005
 
\fI\fIserver signing\fR\fR\fI = \fR\fI\FCDisabled\F[]\fR\fI \fR
9006
 
.RE
9007
 
 
9008
 
server string (G)
9009
 
.\" server string
9010
 
.PP
9011
 
.RS 4
9012
 
This controls what string will show up in the printer comment box in print manager and next to the IPC connection in
9013
 
\FCnet view\F[]\&. It can be any string that you wish to show to your users\&.
9014
 
.sp
9015
 
It also sets what will appear in browse lists next to the machine name\&.
9016
 
.sp
9017
 
A
9018
 
\fI%v\fR
9019
 
will be replaced with the Samba version number\&.
9020
 
.sp
9021
 
A
9022
 
\fI%h\fR
9023
 
will be replaced with the hostname\&.
9024
 
.sp
9025
 
Default:
9026
 
\fI\fIserver string\fR\fR\fI = \fR\fI\FCSamba %v\F[]\fR\fI \fR
9027
 
.sp
9028
 
Example:
9029
 
\fI\fIserver string\fR\fR\fI = \fR\fI\FCUniversity of GNUs Samba Server\F[]\fR\fI \fR
9030
 
.RE
9031
 
 
9032
 
set directory (S)
9033
 
.\" set directory
9034
 
.PP
9035
 
.RS 4
9036
 
If
9037
 
\FCset directory = no\F[], then users of the service may not use the setdir command to change directory\&.
9038
 
.sp
9039
 
The
9040
 
\FCsetdir\F[]
9041
 
command is only implemented in the Digital Pathworks client\&. See the Pathworks documentation for details\&.
9042
 
.sp
9043
 
Default:
9044
 
\fI\fIset directory\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9045
 
.RE
9046
 
 
9047
 
set primary group script (G)
9048
 
.\" set primary group script
9049
 
.PP
9050
 
.RS 4
9051
 
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
9052
 
\FCnet rpc vampire\F[]\&.
9053
 
\fI%u\fR
9054
 
will be replaced with the user whose primary group is to be set\&.
9055
 
\fI%g\fR
9056
 
will be replaced with the group to set\&.
9057
 
.sp
9058
 
Default:
9059
 
\fI\fIset primary group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9060
 
.sp
9061
 
Example:
9062
 
\fI\fIset primary group script\fR\fR\fI = \fR\fI\FC/usr/sbin/usermod \-g \'%g\' \'%u\'\F[]\fR\fI \fR
9063
 
.RE
9064
 
 
9065
 
set quota command (G)
9066
 
.\" set quota command
9067
 
.PP
9068
 
.RS 4
9069
 
The
9070
 
\FCset quota command\F[]
9071
 
should only be used whenever there is no operating system API available from the OS that samba can use\&.
9072
 
.sp
9073
 
This option is only available if Samba was configured with the argument
9074
 
\FC\-\-with\-sys\-quotas\F[]
9075
 
or on linux when
9076
 
\FC\&./configure \-\-with\-quotas\F[]
9077
 
was used and a working quota api was found in the system\&. Most packages are configured with these options already\&.
9078
 
.sp
9079
 
This parameter should specify the path to a script that can set quota for the specified arguments\&.
9080
 
.sp
9081
 
The specified script should take the following arguments:
9082
 
.sp
9083
 
.RS 4
9084
 
.ie n \{\
9085
 
\h'-04'\(bu\h'+03'\c
9086
 
.\}
9087
 
.el \{\
9088
 
.sp -1
9089
 
.IP \(bu 2.3
9090
 
.\}
9091
 
1 \- quota type
9092
 
.sp
9093
 
.RS 4
9094
 
.ie n \{\
9095
 
\h'-04'\(bu\h'+03'\c
9096
 
.\}
9097
 
.el \{\
9098
 
.sp -1
9099
 
.IP \(bu 2.3
9100
 
.\}
9101
 
1 \- user quotas
9102
 
.RE
9103
 
.sp
9104
 
.RS 4
9105
 
.ie n \{\
9106
 
\h'-04'\(bu\h'+03'\c
9107
 
.\}
9108
 
.el \{\
9109
 
.sp -1
9110
 
.IP \(bu 2.3
9111
 
.\}
9112
 
2 \- user default quotas (uid = \-1)
9113
 
.RE
9114
 
.sp
9115
 
.RS 4
9116
 
.ie n \{\
9117
 
\h'-04'\(bu\h'+03'\c
9118
 
.\}
9119
 
.el \{\
9120
 
.sp -1
9121
 
.IP \(bu 2.3
9122
 
.\}
9123
 
3 \- group quotas
9124
 
.RE
9125
 
.sp
9126
 
.RS 4
9127
 
.ie n \{\
9128
 
\h'-04'\(bu\h'+03'\c
9129
 
.\}
9130
 
.el \{\
9131
 
.sp -1
9132
 
.IP \(bu 2.3
9133
 
.\}
9134
 
4 \- group default quotas (gid = \-1)
9135
 
.sp
9136
 
.RE
9137
 
.RE
9138
 
.sp
9139
 
.RS 4
9140
 
.ie n \{\
9141
 
\h'-04'\(bu\h'+03'\c
9142
 
.\}
9143
 
.el \{\
9144
 
.sp -1
9145
 
.IP \(bu 2.3
9146
 
.\}
9147
 
2 \- id (uid for user, gid for group, \-1 if N/A)
9148
 
.RE
9149
 
.sp
9150
 
.RS 4
9151
 
.ie n \{\
9152
 
\h'-04'\(bu\h'+03'\c
9153
 
.\}
9154
 
.el \{\
9155
 
.sp -1
9156
 
.IP \(bu 2.3
9157
 
.\}
9158
 
3 \- quota state (0 = disable, 1 = enable, 2 = enable and enforce)
9159
 
.RE
9160
 
.sp
9161
 
.RS 4
9162
 
.ie n \{\
9163
 
\h'-04'\(bu\h'+03'\c
9164
 
.\}
9165
 
.el \{\
9166
 
.sp -1
9167
 
.IP \(bu 2.3
9168
 
.\}
9169
 
4 \- block softlimit
9170
 
.RE
9171
 
.sp
9172
 
.RS 4
9173
 
.ie n \{\
9174
 
\h'-04'\(bu\h'+03'\c
9175
 
.\}
9176
 
.el \{\
9177
 
.sp -1
9178
 
.IP \(bu 2.3
9179
 
.\}
9180
 
5 \- block hardlimit
9181
 
.RE
9182
 
.sp
9183
 
.RS 4
9184
 
.ie n \{\
9185
 
\h'-04'\(bu\h'+03'\c
9186
 
.\}
9187
 
.el \{\
9188
 
.sp -1
9189
 
.IP \(bu 2.3
9190
 
.\}
9191
 
6 \- inode softlimit
9192
 
.RE
9193
 
.sp
9194
 
.RS 4
9195
 
.ie n \{\
9196
 
\h'-04'\(bu\h'+03'\c
9197
 
.\}
9198
 
.el \{\
9199
 
.sp -1
9200
 
.IP \(bu 2.3
9201
 
.\}
9202
 
7 \- inode hardlimit
9203
 
.RE
9204
 
.sp
9205
 
.RS 4
9206
 
.ie n \{\
9207
 
\h'-04'\(bu\h'+03'\c
9208
 
.\}
9209
 
.el \{\
9210
 
.sp -1
9211
 
.IP \(bu 2.3
9212
 
.\}
9213
 
8(optional) \- block size, defaults to 1024
9214
 
.sp
9215
 
.RE
9216
 
The script should output at least one line of data on success\&. And nothing on failure\&.
9217
 
.sp
9218
 
Default:
9219
 
\fI\fIset quota command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9220
 
.sp
9221
 
Example:
9222
 
\fI\fIset quota command\fR\fR\fI = \fR\fI\FC/usr/local/sbin/set_quota\F[]\fR\fI \fR
9223
 
.RE
9224
 
 
9225
 
share:fake_fscaps (G)
9226
 
.\" share:fake_fscaps
9227
 
.PP
9228
 
.RS 4
9229
 
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
9230
 
\m[blue]\fBshare:fake_fscaps = 64\fR\m[]
9231
 
the SPARSE_FILES file system capability flag is set\&. Use other decimal values to specify the bitmask you need to fake\&.
9232
 
.sp
9233
 
Default:
9234
 
\fI\fIshare:fake_fscaps\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
9235
 
.RE
9236
 
 
9237
 
share modes (S)
9238
 
.\" share modes
9239
 
.PP
9240
 
.RS 4
9241
 
This enables or disables the honoring of the
9242
 
\fIshare modes\fR
9243
 
during a file open\&. These modes are used by clients to gain exclusive read or write access to a file\&.
9244
 
.sp
9245
 
This is a deprecated option from old versions of Samba, and will be removed in the next major release\&.
9246
 
.sp
9247
 
These open modes are not directly supported by UNIX, so they are simulated using shared memory\&.
9248
 
.sp
9249
 
The share modes that are enabled by this option are the standard Windows share modes\&.
9250
 
.sp
9251
 
This option gives full share compatibility and is enabled by default\&.
9252
 
.sp
9253
 
You should
9254
 
\fINEVER\fR
9255
 
turn this parameter off as many Windows applications will break if you do so\&.
9256
 
.sp
9257
 
Default:
9258
 
\fI\fIshare modes\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9259
 
.RE
9260
 
 
9261
 
short preserve case (S)
9262
 
.\" short preserve case
9263
 
.PP
9264
 
.RS 4
9265
 
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
9266
 
\m[blue]\fBdefault case\fR\m[]\&. This option can be use with
9267
 
\m[blue]\fBpreserve case = yes\fR\m[]
9268
 
to permit long filenames to retain their case, while short names are lowered\&.
9269
 
.sp
9270
 
See the section on
9271
 
NAME MANGLING\&.
9272
 
.sp
9273
 
Default:
9274
 
\fI\fIshort preserve case\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9275
 
.RE
9276
 
 
9277
 
show add printer wizard (G)
9278
 
.\" show add printer wizard
9279
 
.PP
9280
 
.RS 4
9281
 
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\&.
9282
 
.sp
9283
 
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
9284
 
\fIprinter admin\fR
9285
 
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\&.
9286
 
.sp
9287
 
Disabling the
9288
 
\fIshow add printer wizard\fR
9289
 
parameter will always cause the OpenPrinterEx() on the server to fail\&. Thus the APW icon will never be displayed\&.
9290
 
.if n \{\
9291
 
.sp
9292
 
.\}
9293
 
.RS 4
9294
 
.BM yellow
9295
 
.it 1 an-trap
9296
 
.nr an-no-space-flag 1
9297
 
.nr an-break-flag 1
9298
 
.br
9299
 
.ps +1
9300
 
\fBNote\fR
9301
 
.ps -1
9302
 
.br
9303
 
This does not prevent the same user from having administrative privilege on an individual printer\&.
9304
 
.sp .5v
9305
 
.EM yellow
9306
 
.RE
9307
 
Default:
9308
 
\fI\fIshow add printer wizard\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9309
 
.RE
9310
 
 
9311
 
shutdown script (G)
9312
 
.\" shutdown script
9313
 
.PP
9314
 
.RS 4
9315
 
This a full path name to a script called by
9316
 
\fBsmbd\fR(8)
9317
 
that should start a shutdown procedure\&.
9318
 
.sp
9319
 
If the connected user posseses the
9320
 
\fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.
9321
 
.sp
9322
 
The %z %t %r %f variables are expanded as follows:
9323
 
.sp
9324
 
.RS 4
9325
 
.ie n \{\
9326
 
\h'-04'\(bu\h'+03'\c
9327
 
.\}
9328
 
.el \{\
9329
 
.sp -1
9330
 
.IP \(bu 2.3
9331
 
.\}
9332
 
\fI%z\fR
9333
 
will be substituted with the shutdown message sent to the server\&.
9334
 
.RE
9335
 
.sp
9336
 
.RS 4
9337
 
.ie n \{\
9338
 
\h'-04'\(bu\h'+03'\c
9339
 
.\}
9340
 
.el \{\
9341
 
.sp -1
9342
 
.IP \(bu 2.3
9343
 
.\}
9344
 
\fI%t\fR
9345
 
will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\&.
9346
 
.RE
9347
 
.sp
9348
 
.RS 4
9349
 
.ie n \{\
9350
 
\h'-04'\(bu\h'+03'\c
9351
 
.\}
9352
 
.el \{\
9353
 
.sp -1
9354
 
.IP \(bu 2.3
9355
 
.\}
9356
 
\fI%r\fR
9357
 
will be substituted with the switch
9358
 
\fI\-r\fR\&. It means reboot after shutdown for NT\&.
9359
 
.RE
9360
 
.sp
9361
 
.RS 4
9362
 
.ie n \{\
9363
 
\h'-04'\(bu\h'+03'\c
9364
 
.\}
9365
 
.el \{\
9366
 
.sp -1
9367
 
.IP \(bu 2.3
9368
 
.\}
9369
 
\fI%f\fR
9370
 
will be substituted with the switch
9371
 
\fI\-f\fR\&. It means force the shutdown even if applications do not respond for NT\&.
9372
 
.sp
9373
 
.RE
9374
 
Shutdown script example:
9375
 
.sp
9376
 
.if n \{\
9377
 
.RS 4
9378
 
.\}
9379
 
.fam C
9380
 
.ps -1
9381
 
.nf
9382
 
.if t \{\
9383
 
.sp -1
9384
 
.\}
9385
 
.BB lightgray adjust-for-leading-newline
9386
 
.sp -1
9387
 
 
9388
 
#!/bin/bash
9389
 
                
9390
 
$time=0
9391
 
let "time/60"
9392
 
let "time++"
9393
 
 
9394
 
/sbin/shutdown $3 $4 +$time $1 &
9395
 
.EB lightgray adjust-for-leading-newline
9396
 
.if t \{\
9397
 
.sp 1
9398
 
.\}
9399
 
.fi
9400
 
.fam
9401
 
.ps +1
9402
 
.if n \{\
9403
 
.RE
9404
 
.\}
9405
 
.sp
9406
 
Shutdown does not return so we need to launch it in background\&.
9407
 
.sp
9408
 
Default:
9409
 
\fI\fIshutdown script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9410
 
.sp
9411
 
Example:
9412
 
\fI\fIshutdown script\fR\fR\fI = \fR\fI\FC/usr/local/samba/sbin/shutdown %m %t %r %f\F[]\fR\fI \fR
9413
 
.RE
9414
 
 
9415
 
smb encrypt (S)
9416
 
.\" smb encrypt
9417
 
.PP
9418
 
.RS 4
9419
 
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\&.
9420
 
.sp
9421
 
This controls whether the remote client is allowed or required to use SMB encryption\&. Possible values are
9422
 
\fIauto\fR,
9423
 
\fImandatory\fR
9424
 
and
9425
 
\fIdisabled\fR\&. 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
9426
 
\fImust\fR
9427
 
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\&.
9428
 
.sp
9429
 
If SMB encryption is selected, Windows style SMB signing (see the
9430
 
\m[blue]\fBserver signing\fR\m[]
9431
 
option) is no longer necessary, as the GSSAPI flags use select both signing and sealing of the data\&.
9432
 
.sp
9433
 
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\&.
9434
 
.sp
9435
 
Default:
9436
 
\fI\fIsmb encrypt\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
9437
 
.RE
9438
 
 
9439
 
smb passwd file (G)
9440
 
.\" smb passwd file
9441
 
.PP
9442
 
.RS 4
9443
 
This option sets the path to the encrypted smbpasswd file\&. By default the path to the smbpasswd file is compiled into Samba\&.
9444
 
.sp
9445
 
An example of use is:
9446
 
.sp
9447
 
.if n \{\
9448
 
.RS 4
9449
 
.\}
9450
 
.fam C
9451
 
.ps -1
9452
 
.nf
9453
 
.if t \{\
9454
 
.sp -1
9455
 
.\}
9456
 
.BB lightgray adjust-for-leading-newline
9457
 
.sp -1
9458
 
 
9459
 
smb passwd file = /etc/samba/smbpasswd
9460
 
.EB lightgray adjust-for-leading-newline
9461
 
.if t \{\
9462
 
.sp 1
9463
 
.\}
9464
 
.fi
9465
 
.fam
9466
 
.ps +1
9467
 
.if n \{\
9468
 
.RE
9469
 
.\}
9470
 
.sp
9471
 
Default:
9472
 
\fI\fIsmb passwd file\fR\fR\fI = \fR\fI\FC${prefix}/private/smbpasswd\F[]\fR\fI \fR
9473
 
.RE
9474
 
 
9475
 
smb ports (G)
9476
 
.\" smb ports
9477
 
.PP
9478
 
.RS 4
9479
 
Specifies which ports the server should listen on for SMB traffic\&.
9480
 
.sp
9481
 
Default:
9482
 
\fI\fIsmb ports\fR\fR\fI = \fR\fI\FC445 139\F[]\fR\fI \fR
9483
 
.RE
9484
 
 
9485
 
socket address (G)
9486
 
.\" socket address
9487
 
.PP
9488
 
.RS 4
9489
 
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\&.
9490
 
.sp
9491
 
Setting this option should never be necessary on usual Samba servers running only one nmbd\&.
9492
 
.sp
9493
 
By default Samba will accept connections on any address\&.
9494
 
.sp
9495
 
Default:
9496
 
\fI\fIsocket address\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9497
 
.sp
9498
 
Example:
9499
 
\fI\fIsocket address\fR\fR\fI = \fR\fI\FC192\&.168\&.2\&.20\F[]\fR\fI \fR
9500
 
.RE
9501
 
 
9502
 
socket options (G)
9503
 
.\" socket options
9504
 
.PP
9505
 
.RS 4
9506
 
This option allows you to set socket options to be used when talking with the client\&.
9507
 
.sp
9508
 
Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\&.
9509
 
.sp
9510
 
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
9511
 
\FCman setsockopt\F[]
9512
 
will help)\&.
9513
 
.sp
9514
 
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
9515
 
samba\-technical@samba\&.org\&.
9516
 
.sp
9517
 
Any of the supported socket options may be combined in any way you like, as long as your OS allows it\&.
9518
 
.sp
9519
 
This is the list of socket options currently settable using this option:
9520
 
.sp
9521
 
.RS 4
9522
 
.ie n \{\
9523
 
\h'-04'\(bu\h'+03'\c
9524
 
.\}
9525
 
.el \{\
9526
 
.sp -1
9527
 
.IP \(bu 2.3
9528
 
.\}
9529
 
SO_KEEPALIVE
9530
 
.RE
9531
 
.sp
9532
 
.RS 4
9533
 
.ie n \{\
9534
 
\h'-04'\(bu\h'+03'\c
9535
 
.\}
9536
 
.el \{\
9537
 
.sp -1
9538
 
.IP \(bu 2.3
9539
 
.\}
9540
 
SO_REUSEADDR
9541
 
.RE
9542
 
.sp
9543
 
.RS 4
9544
 
.ie n \{\
9545
 
\h'-04'\(bu\h'+03'\c
9546
 
.\}
9547
 
.el \{\
9548
 
.sp -1
9549
 
.IP \(bu 2.3
9550
 
.\}
9551
 
SO_BROADCAST
9552
 
.RE
9553
 
.sp
9554
 
.RS 4
9555
 
.ie n \{\
9556
 
\h'-04'\(bu\h'+03'\c
9557
 
.\}
9558
 
.el \{\
9559
 
.sp -1
9560
 
.IP \(bu 2.3
9561
 
.\}
9562
 
TCP_NODELAY
9563
 
.RE
9564
 
.sp
9565
 
.RS 4
9566
 
.ie n \{\
9567
 
\h'-04'\(bu\h'+03'\c
9568
 
.\}
9569
 
.el \{\
9570
 
.sp -1
9571
 
.IP \(bu 2.3
9572
 
.\}
9573
 
IPTOS_LOWDELAY
9574
 
.RE
9575
 
.sp
9576
 
.RS 4
9577
 
.ie n \{\
9578
 
\h'-04'\(bu\h'+03'\c
9579
 
.\}
9580
 
.el \{\
9581
 
.sp -1
9582
 
.IP \(bu 2.3
9583
 
.\}
9584
 
IPTOS_THROUGHPUT
9585
 
.RE
9586
 
.sp
9587
 
.RS 4
9588
 
.ie n \{\
9589
 
\h'-04'\(bu\h'+03'\c
9590
 
.\}
9591
 
.el \{\
9592
 
.sp -1
9593
 
.IP \(bu 2.3
9594
 
.\}
9595
 
SO_SNDBUF *
9596
 
.RE
9597
 
.sp
9598
 
.RS 4
9599
 
.ie n \{\
9600
 
\h'-04'\(bu\h'+03'\c
9601
 
.\}
9602
 
.el \{\
9603
 
.sp -1
9604
 
.IP \(bu 2.3
9605
 
.\}
9606
 
SO_RCVBUF *
9607
 
.RE
9608
 
.sp
9609
 
.RS 4
9610
 
.ie n \{\
9611
 
\h'-04'\(bu\h'+03'\c
9612
 
.\}
9613
 
.el \{\
9614
 
.sp -1
9615
 
.IP \(bu 2.3
9616
 
.\}
9617
 
SO_SNDLOWAT *
9618
 
.RE
9619
 
.sp
9620
 
.RS 4
9621
 
.ie n \{\
9622
 
\h'-04'\(bu\h'+03'\c
9623
 
.\}
9624
 
.el \{\
9625
 
.sp -1
9626
 
.IP \(bu 2.3
9627
 
.\}
9628
 
SO_RCVLOWAT *
9629
 
.sp
9630
 
.RE
9631
 
Those marked with a
9632
 
\fI\'*\'\fR
9633
 
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\&.
9634
 
.sp
9635
 
To specify an argument use the syntax SOME_OPTION = VALUE for example
9636
 
\FCSO_SNDBUF = 8192\F[]\&. Note that you must not have any spaces before or after the = sign\&.
9637
 
.sp
9638
 
If you are on a local network then a sensible option might be:
9639
 
.sp
9640
 
\FCsocket options = IPTOS_LOWDELAY\F[]
9641
 
.sp
9642
 
If you have a local network then you could try:
9643
 
.sp
9644
 
\FCsocket options = IPTOS_LOWDELAY TCP_NODELAY\F[]
9645
 
.sp
9646
 
If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\&.
9647
 
.sp
9648
 
Note that several of the options may cause your Samba server to fail completely\&. Use these options with caution!
9649
 
.sp
9650
 
Default:
9651
 
\fI\fIsocket options\fR\fR\fI = \fR\fI\FCTCP_NODELAY\F[]\fR\fI \fR
9652
 
.sp
9653
 
Example:
9654
 
\fI\fIsocket options\fR\fR\fI = \fR\fI\FCIPTOS_LOWDELAY\F[]\fR\fI \fR
9655
 
.RE
9656
 
 
9657
 
stat cache (G)
9658
 
.\" stat cache
9659
 
.PP
9660
 
.RS 4
9661
 
This parameter determines if
9662
 
\fBsmbd\fR(8)
9663
 
will use a cache in order to speed up case insensitive name mappings\&. You should never need to change this parameter\&.
9664
 
.sp
9665
 
Default:
9666
 
\fI\fIstat cache\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9667
 
.RE
9668
 
 
9669
 
store dos attributes (S)
9670
 
.\" store dos attributes
9671
 
.PP
9672
 
.RS 4
9673
 
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
9674
 
\m[blue]\fBmap hidden\fR\m[]
9675
 
and
9676
 
\m[blue]\fBmap readonly\fR\m[])\&. 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
9677
 
\m[blue]\fBmap hidden\fR\m[],
9678
 
\m[blue]\fBmap system\fR\m[],
9679
 
\m[blue]\fBmap archive\fR\m[]
9680
 
and
9681
 
\m[blue]\fBmap readonly\fR\m[]
9682
 
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\&.
9683
 
.sp
9684
 
Default:
9685
 
\fI\fIstore dos attributes\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9686
 
.RE
9687
 
 
9688
 
strict allocate (S)
9689
 
.\" strict allocate
9690
 
.PP
9691
 
.RS 4
9692
 
This is a boolean that controls the handling of disk space allocation in the server\&. When this is set to
9693
 
\fByes\fR
9694
 
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\&.
9695
 
.sp
9696
 
When strict allocate is
9697
 
\fBno\fR
9698
 
the server does sparse disk block allocation when a file is extended\&.
9699
 
.sp
9700
 
Setting this to
9701
 
\fByes\fR
9702
 
can help Samba return out of quota messages on systems that are restricting the disk quota of users\&.
9703
 
.sp
9704
 
Default:
9705
 
\fI\fIstrict allocate\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9706
 
.RE
9707
 
 
9708
 
strict locking (S)
9709
 
.\" strict locking
9710
 
.PP
9711
 
.RS 4
9712
 
This is an enumerated type that controls the handling of file locking in the server\&. When this is set to
9713
 
\fByes\fR, 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\&.
9714
 
.sp
9715
 
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\&.
9716
 
.sp
9717
 
When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\&.
9718
 
.sp
9719
 
Well\-behaved clients always ask for lock checks when it is important\&. So in the vast majority of cases,
9720
 
\FCstrict locking = Auto\F[]
9721
 
or
9722
 
\FCstrict locking = no\F[]
9723
 
is acceptable\&.
9724
 
.sp
9725
 
Default:
9726
 
\fI\fIstrict locking\fR\fR\fI = \fR\fI\FCAuto\F[]\fR\fI \fR
9727
 
.RE
9728
 
 
9729
 
strict sync (S)
9730
 
.\" strict sync
9731
 
.PP
9732
 
.RS 4
9733
 
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
9734
 
\fBno\fR
9735
 
(the default) means that
9736
 
\fBsmbd\fR(8)
9737
 
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\&.
9738
 
.sp
9739
 
Default:
9740
 
\fI\fIstrict sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9741
 
.RE
9742
 
 
9743
 
svcctl list (G)
9744
 
.\" svcctl list
9745
 
.PP
9746
 
.RS 4
9747
 
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\&.
9748
 
.sp
9749
 
The administrator must create a directory name
9750
 
\FCsvcctl\F[]
9751
 
in Samba\'s $(libdir) and create symbolic links to the init scripts in
9752
 
\FC/etc/init\&.d/\F[]\&. The name of the links must match the names given as part of the
9753
 
\fIsvcctl list\fR\&.
9754
 
.sp
9755
 
Default:
9756
 
\fI\fIsvcctl list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9757
 
.sp
9758
 
Example:
9759
 
\fI\fIsvcctl list\fR\fR\fI = \fR\fI\FCcups postfix portmap httpd\F[]\fR\fI \fR
9760
 
.RE
9761
 
 
9762
 
sync always (S)
9763
 
.\" sync always
9764
 
.PP
9765
 
.RS 4
9766
 
This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\&. If this is
9767
 
\fBno\fR
9768
 
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
9769
 
\fByes\fR
9770
 
then every write will be followed by a
9771
 
\FCfsync() \F[]
9772
 
call to ensure the data is written to disk\&. Note that the
9773
 
\fIstrict sync\fR
9774
 
parameter must be set to
9775
 
\fByes\fR
9776
 
in order for this parameter to have any effect\&.
9777
 
.sp
9778
 
Default:
9779
 
\fI\fIsync always\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9780
 
.RE
9781
 
 
9782
 
syslog only (G)
9783
 
.\" syslog only
9784
 
.PP
9785
 
.RS 4
9786
 
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
9787
 
\fIsyslog only\fR
9788
 
is enabled\&.
9789
 
.sp
9790
 
Default:
9791
 
\fI\fIsyslog only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9792
 
.RE
9793
 
 
9794
 
syslog (G)
9795
 
.\" syslog
9796
 
.PP
9797
 
.RS 4
9798
 
This parameter maps how Samba debug messages are logged onto the system syslog logging levels\&. Samba debug level zero maps onto syslog
9799
 
\fBLOG_ERR\fR, debug level one maps onto
9800
 
\fBLOG_WARNING\fR, debug level two maps onto
9801
 
\fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\&. All higher levels are mapped to
9802
 
\fBLOG_DEBUG\fR\&.
9803
 
.sp
9804
 
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
9805
 
\fIsyslog only\fR
9806
 
is enabled\&.
9807
 
.sp
9808
 
Default:
9809
 
\fI\fIsyslog\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
9810
 
.RE
9811
 
 
9812
 
template homedir (G)
9813
 
.\" template homedir
9814
 
.PP
9815
 
.RS 4
9816
 
When filling out the user information for a Windows NT user, the
9817
 
\fBwinbindd\fR(8)
9818
 
daemon uses this parameter to fill in the home directory for that user\&. If the string
9819
 
\fI%D\fR
9820
 
is present it is substituted with the user\'s Windows NT domain name\&. If the string
9821
 
\fI%U\fR
9822
 
is present it is substituted with the user\'s Windows NT user name\&.
9823
 
.sp
9824
 
Default:
9825
 
\fI\fItemplate homedir\fR\fR\fI = \fR\fI\FC/home/%D/%U\F[]\fR\fI \fR
9826
 
.RE
9827
 
 
9828
 
template shell (G)
9829
 
.\" template shell
9830
 
.PP
9831
 
.RS 4
9832
 
When filling out the user information for a Windows NT user, the
9833
 
\fBwinbindd\fR(8)
9834
 
daemon uses this parameter to fill in the login shell for that user\&.
9835
 
.sp
9836
 
\fINo default\fR
9837
 
.RE
9838
 
 
9839
 
time offset (G)
9840
 
.\" time offset
9841
 
.PP
9842
 
.RS 4
9843
 
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\&.
9844
 
.sp
9845
 
Default:
9846
 
\fI\fItime offset\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
9847
 
.sp
9848
 
Example:
9849
 
\fI\fItime offset\fR\fR\fI = \fR\fI\FC60\F[]\fR\fI \fR
9850
 
.RE
9851
 
 
9852
 
time server (G)
9853
 
.\" time server
9854
 
.PP
9855
 
.RS 4
9856
 
This parameter determines if
9857
 
\fBnmbd\fR(8)
9858
 
advertises itself as a time server to Windows clients\&.
9859
 
.sp
9860
 
Default:
9861
 
\fI\fItime server\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9862
 
.RE
9863
 
 
9864
 
unix charset (G)
9865
 
.\" unix charset
9866
 
.PP
9867
 
.RS 4
9868
 
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\&.
9869
 
.sp
9870
 
This is also the charset Samba will use when specifying arguments to scripts that it invokes\&.
9871
 
.sp
9872
 
Default:
9873
 
\fI\fIunix charset\fR\fR\fI = \fR\fI\FCUTF8\F[]\fR\fI \fR
9874
 
.sp
9875
 
Example:
9876
 
\fI\fIunix charset\fR\fR\fI = \fR\fI\FCASCII\F[]\fR\fI \fR
9877
 
.RE
9878
 
 
9879
 
unix extensions (G)
9880
 
.\" unix extensions
9881
 
.PP
9882
 
.RS 4
9883
 
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\&.
9884
 
.sp
9885
 
Default:
9886
 
\fI\fIunix extensions\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9887
 
.RE
9888
 
 
9889
 
unix password sync (G)
9890
 
.\" unix password sync
9891
 
.PP
9892
 
.RS 4
9893
 
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
9894
 
\fByes\fR
9895
 
the program specified in the
9896
 
\fIpasswd program\fR
9897
 
parameter is called
9898
 
\fIAS ROOT\fR
9899
 
\- 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)\&.
9900
 
.sp
9901
 
Default:
9902
 
\fI\fIunix password sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9903
 
.RE
9904
 
 
9905
 
update encrypted (G)
9906
 
.\" update encrypted
9907
 
.PP
9908
 
.RS 4
9909
 
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
9910
 
\fBno\fR\&.
9911
 
.sp
9912
 
In order for this parameter to be operative the
9913
 
\m[blue]\fBencrypt passwords\fR\m[]
9914
 
parameter must be set to
9915
 
\fBno\fR\&. The default value of
9916
 
\m[blue]\fBencrypt passwords = Yes\fR\m[]\&. Note: This must be set to
9917
 
\fBno\fR
9918
 
for this
9919
 
\m[blue]\fBupdate encrypted\fR\m[]
9920
 
to work\&.
9921
 
.sp
9922
 
Note that even when this parameter is set, a user authenticating to
9923
 
\FCsmbd\F[]
9924
 
must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords\&.
9925
 
.sp
9926
 
Default:
9927
 
\fI\fIupdate encrypted\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9928
 
.RE
9929
 
 
9930
 
use client driver (S)
9931
 
.\" use client driver
9932
 
.PP
9933
 
.RS 4
9934
 
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
9935
 
\FCdisable spoolss = yes\F[]\&.
9936
 
.sp
9937
 
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)\&.
9938
 
.sp
9939
 
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\&.
9940
 
\fIThis parameter MUST not be enabled on a print share which has valid print driver installed on the Samba server\&.\fR
9941
 
.sp
9942
 
Default:
9943
 
\fI\fIuse client driver\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
9944
 
.RE
9945
 
 
9946
 
use mmap (G)
9947
 
.\" use mmap
9948
 
.PP
9949
 
.RS 4
9950
 
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
9951
 
\fBno\fR
9952
 
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\&.
9953
 
.sp
9954
 
Default:
9955
 
\fI\fIuse mmap\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
9956
 
.RE
9957
 
 
9958
 
username level (G)
9959
 
.\" username level
9960
 
.PP
9961
 
.RS 4
9962
 
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\&.
9963
 
.sp
9964
 
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
9965
 
\fBAstrangeUser \fR\&.
9966
 
.sp
9967
 
This parameter is needed only on UNIX systems that have case sensitive usernames\&.
9968
 
.sp
9969
 
Default:
9970
 
\fI\fIusername level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
9971
 
.sp
9972
 
Example:
9973
 
\fI\fIusername level\fR\fR\fI = \fR\fI\FC5\F[]\fR\fI \fR
9974
 
.RE
9975
 
 
9976
 
username map script (G)
9977
 
.\" username map script
9978
 
.PP
9979
 
.RS 4
9980
 
This script is a mutually exclusive alternative to the
9981
 
\m[blue]\fBusername map\fR\m[]
9982
 
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\&.
9983
 
.sp
9984
 
Default:
9985
 
\fI\fIusername map script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
9986
 
.sp
9987
 
Example:
9988
 
\fI\fIusername map script\fR\fR\fI = \fR\fI\FC/etc/samba/scripts/mapusers\&.sh\F[]\fR\fI \fR
9989
 
.RE
9990
 
 
9991
 
username map (G)
9992
 
.\" username map
9993
 
.PP
9994
 
.RS 4
9995
 
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\&.
9996
 
.sp
9997
 
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 =
9998
 
\FCDOMAIN\efoo\F[])\&.
9999
 
.sp
10000
 
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\&.
10001
 
.sp
10002
 
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\&.
10003
 
.sp
10004
 
If any line begins with a \'#\' or a \';\' then it is ignored\&.
10005
 
.sp
10006
 
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\&.
10007
 
.sp
10008
 
For example to map from the name
10009
 
\fBadmin\fR
10010
 
or
10011
 
\fBadministrator\fR
10012
 
to the UNIX name
10013
 
\fB root\fR
10014
 
you would use:
10015
 
.sp
10016
 
.if n \{\
10017
 
.RS 4
10018
 
.\}
10019
 
.fam C
10020
 
.ps -1
10021
 
.nf
10022
 
.if t \{\
10023
 
.sp -1
10024
 
.\}
10025
 
.BB lightgray adjust-for-leading-newline
10026
 
.sp -1
10027
 
 
10028
 
\FCroot = admin administrator\F[]
10029
 
.EB lightgray adjust-for-leading-newline
10030
 
.if t \{\
10031
 
.sp 1
10032
 
.\}
10033
 
.fi
10034
 
.fam
10035
 
.ps +1
10036
 
.if n \{\
10037
 
.RE
10038
 
.\}
10039
 
.sp
10040
 
Or to map anyone in the UNIX group
10041
 
\fBsystem\fR
10042
 
to the UNIX name
10043
 
\fBsys\fR
10044
 
you would use:
10045
 
.sp
10046
 
.if n \{\
10047
 
.RS 4
10048
 
.\}
10049
 
.fam C
10050
 
.ps -1
10051
 
.nf
10052
 
.if t \{\
10053
 
.sp -1
10054
 
.\}
10055
 
.BB lightgray adjust-for-leading-newline
10056
 
.sp -1
10057
 
 
10058
 
\FCsys = @system\F[]
10059
 
.EB lightgray adjust-for-leading-newline
10060
 
.if t \{\
10061
 
.sp 1
10062
 
.\}
10063
 
.fi
10064
 
.fam
10065
 
.ps +1
10066
 
.if n \{\
10067
 
.RE
10068
 
.\}
10069
 
.sp
10070
 
You can have as many mappings as you like in a username map file\&.
10071
 
.sp
10072
 
If your system supports the NIS NETGROUP option then the netgroup database is checked before the
10073
 
\FC/etc/group \F[]
10074
 
database for matching groups\&.
10075
 
.sp
10076
 
You can map Windows usernames that have spaces in them by using double quotes around the name\&. For example:
10077
 
.sp
10078
 
.if n \{\
10079
 
.RS 4
10080
 
.\}
10081
 
.fam C
10082
 
.ps -1
10083
 
.nf
10084
 
.if t \{\
10085
 
.sp -1
10086
 
.\}
10087
 
.BB lightgray adjust-for-leading-newline
10088
 
.sp -1
10089
 
 
10090
 
\FCtridge = "Andrew Tridgell"\F[]
10091
 
.EB lightgray adjust-for-leading-newline
10092
 
.if t \{\
10093
 
.sp 1
10094
 
.\}
10095
 
.fi
10096
 
.fam
10097
 
.ps +1
10098
 
.if n \{\
10099
 
.RE
10100
 
.\}
10101
 
.sp
10102
 
would map the windows username "Andrew Tridgell" to the unix username "tridge"\&.
10103
 
.sp
10104
 
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:
10105
 
.sp
10106
 
.if n \{\
10107
 
.RS 4
10108
 
.\}
10109
 
.fam C
10110
 
.ps -1
10111
 
.nf
10112
 
.if t \{\
10113
 
.sp -1
10114
 
.\}
10115
 
.BB lightgray adjust-for-leading-newline
10116
 
.sp -1
10117
 
 
10118
 
!sys = mary fred
10119
 
guest = *
10120
 
.EB lightgray adjust-for-leading-newline
10121
 
.if t \{\
10122
 
.sp 1
10123
 
.\}
10124
 
.fi
10125
 
.fam
10126
 
.ps +1
10127
 
.if n \{\
10128
 
.RE
10129
 
.\}
10130
 
.sp
10131
 
Note that the remapping is applied to all occurrences of usernames\&. Thus if you connect to \e\eserver\efred and
10132
 
\fBfred\fR
10133
 
is remapped to
10134
 
\fBmary\fR
10135
 
then you will actually be connecting to \e\eserver\emary and will need to supply a password suitable for
10136
 
\fBmary\fR
10137
 
not
10138
 
\fBfred\fR\&. The only exception to this is the username passed to the
10139
 
\m[blue]\fBpassword server\fR\m[]
10140
 
(if you have one)\&. The password server will receive whatever username the client supplies without modification\&.
10141
 
.sp
10142
 
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\&.
10143
 
.sp
10144
 
Samba versions prior to 3\&.0\&.8 would only support reading the fully qualified username (e\&.g\&.:
10145
 
\FCDOMAIN\euser\F[]) 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\&.
10146
 
.sp
10147
 
The following functionality is obeyed in version 3\&.0\&.8 and later:
10148
 
.sp
10149
 
When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\&.
10150
 
.sp
10151
 
When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\&.e\&.
10152
 
\FCDOMAIN\euser\F[]) only after the user has been successfully authenticated\&.
10153
 
.sp
10154
 
An example of use is:
10155
 
.sp
10156
 
.if n \{\
10157
 
.RS 4
10158
 
.\}
10159
 
.fam C
10160
 
.ps -1
10161
 
.nf
10162
 
.if t \{\
10163
 
.sp -1
10164
 
.\}
10165
 
.BB lightgray adjust-for-leading-newline
10166
 
.sp -1
10167
 
 
10168
 
username map = /usr/local/samba/lib/users\&.map
10169
 
.EB lightgray adjust-for-leading-newline
10170
 
.if t \{\
10171
 
.sp 1
10172
 
.\}
10173
 
.fi
10174
 
.fam
10175
 
.ps +1
10176
 
.if n \{\
10177
 
.RE
10178
 
.\}
10179
 
.sp
10180
 
Default:
10181
 
\fI\fIusername map\fR\fR\fI = \fR\fI\FC # no username map\F[]\fR\fI \fR
10182
 
.RE
10183
 
 
10184
 
user
10185
 
.\" user
10186
 
.PP
10187
 
.RS 4
10188
 
This parameter is a synonym for
10189
 
username\&.
10190
 
.RE
10191
 
 
10192
 
users
10193
 
.\" users
10194
 
.PP
10195
 
.RS 4
10196
 
This parameter is a synonym for
10197
 
username\&.
10198
 
.RE
10199
 
 
10200
 
username (S)
10201
 
.\" username
10202
 
.PP
10203
 
.RS 4
10204
 
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)\&.
10205
 
.sp
10206
 
The
10207
 
\fIusername\fR
10208
 
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 \e\eserver\eshare%user syntax instead\&.
10209
 
.sp
10210
 
The
10211
 
\fIusername\fR
10212
 
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
10213
 
\fIusername\fR
10214
 
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\&.
10215
 
.sp
10216
 
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\&.
10217
 
.sp
10218
 
To restrict a service to a particular set of users you can use the
10219
 
\m[blue]\fBvalid users\fR\m[]
10220
 
parameter\&.
10221
 
.sp
10222
 
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\&.
10223
 
.sp
10224
 
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\&.
10225
 
.sp
10226
 
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\&.
10227
 
.sp
10228
 
Note that searching though a groups database can take quite some time, and some clients may time out during the search\&.
10229
 
.sp
10230
 
See the section
10231
 
NOTE ABOUT USERNAME/PASSWORD VALIDATION
10232
 
for more information on how this parameter determines access to the services\&.
10233
 
.sp
10234
 
Default:
10235
 
\fI\fIusername\fR\fR\fI = \fR\fI\FC # The guest account if a guest service, else <empty string>\&.\F[]\fR\fI \fR
10236
 
.sp
10237
 
Example:
10238
 
\fI\fIusername\fR\fR\fI = \fR\fI\FCfred, mary, jack, jane, @users, @pcgroup\F[]\fR\fI \fR
10239
 
.RE
10240
 
 
10241
 
usershare allow guests (G)
10242
 
.\" usershare allow guests
10243
 
.PP
10244
 
.RS 4
10245
 
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
10246
 
\fIguest ok = yes\fR
10247
 
in a share definition\&. Due to its security sensitive nature, the default is set to off\&.
10248
 
.sp
10249
 
Default:
10250
 
\fI\fIusershare allow guests\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10251
 
.RE
10252
 
 
10253
 
usershare max shares (G)
10254
 
.\" usershare max shares
10255
 
.PP
10256
 
.RS 4
10257
 
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\&.
10258
 
.sp
10259
 
Default:
10260
 
\fI\fIusershare max shares\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
10261
 
.RE
10262
 
 
10263
 
usershare owner only (G)
10264
 
.\" usershare owner only
10265
 
.PP
10266
 
.RS 4
10267
 
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\&.
10268
 
.sp
10269
 
Default:
10270
 
\fI\fIusershare owner only\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
10271
 
.RE
10272
 
 
10273
 
usershare path (G)
10274
 
.\" usershare path
10275
 
.PP
10276
 
.RS 4
10277
 
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\&.
10278
 
.sp
10279
 
For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\&.
10280
 
.sp
10281
 
 
10282
 
.sp
10283
 
.if n \{\
10284
 
.RS 4
10285
 
.\}
10286
 
.fam C
10287
 
.ps -1
10288
 
.nf
10289
 
.if t \{\
10290
 
.sp -1
10291
 
.\}
10292
 
.BB lightgray adjust-for-leading-newline
10293
 
.sp -1
10294
 
 
10295
 
        ls \-ld /usr/local/samba/lib/usershares/
10296
 
        drwxrwx\-\-T  2 root power_users 4096 2006\-05\-05 12:27 /usr/local/samba/lib/usershares/
10297
 
        
10298
 
.EB lightgray adjust-for-leading-newline
10299
 
.if t \{\
10300
 
.sp 1
10301
 
.\}
10302
 
.fi
10303
 
.fam
10304
 
.ps +1
10305
 
.if n \{\
10306
 
.RE
10307
 
.\}
10308
 
.sp
10309
 
In this case, only members of the group "power_users" can create user defined shares\&.
10310
 
.sp
10311
 
Default:
10312
 
\fI\fIusershare path\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
10313
 
.RE
10314
 
 
10315
 
usershare prefix allow list (G)
10316
 
.\" usershare prefix allow list
10317
 
.PP
10318
 
.RS 4
10319
 
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\&.
10320
 
.sp
10321
 
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\&.
10322
 
.sp
10323
 
Default:
10324
 
\fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
10325
 
.sp
10326
 
Example:
10327
 
\fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\FC/home /data /space\F[]\fR\fI \fR
10328
 
.RE
10329
 
 
10330
 
usershare prefix deny list (G)
10331
 
.\" usershare prefix deny list
10332
 
.PP
10333
 
.RS 4
10334
 
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\&.
10335
 
.sp
10336
 
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\&.
10337
 
.sp
10338
 
Default:
10339
 
\fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
10340
 
.sp
10341
 
Example:
10342
 
\fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\FC/etc /dev /private\F[]\fR\fI \fR
10343
 
.RE
10344
 
 
10345
 
usershare template share (G)
10346
 
.\" usershare template share
10347
 
.PP
10348
 
.RS 4
10349
 
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\&.
10350
 
.sp
10351
 
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\&.
10352
 
.sp
10353
 
Default:
10354
 
\fI\fIusershare template share\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
10355
 
.sp
10356
 
Example:
10357
 
\fI\fIusershare template share\fR\fR\fI = \fR\fI\FCtemplate_share\F[]\fR\fI \fR
10358
 
.RE
10359
 
 
10360
 
use sendfile (S)
10361
 
.\" use sendfile
10362
 
.PP
10363
 
.RS 4
10364
 
If this parameter is
10365
 
\fByes\fR, and the
10366
 
\fBsendfile()\fR
10367
 
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)\&.
10368
 
.sp
10369
 
Default:
10370
 
\fI\fIuse sendfile\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
10371
 
.RE
10372
 
 
10373
 
use spnego (G)
10374
 
.\" use spnego
10375
 
.PP
10376
 
.RS 4
10377
 
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\&.
10378
 
.sp
10379
 
Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled\&.
10380
 
.sp
10381
 
Default:
10382
 
\fI\fIuse spnego\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10383
 
.RE
10384
 
 
10385
 
utmp directory (G)
10386
 
.\" utmp directory
10387
 
.PP
10388
 
.RS 4
10389
 
This parameter is only available if Samba has been configured and compiled with the option
10390
 
\FC \-\-with\-utmp\F[]\&. 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
10391
 
\FC/var/run/utmp\F[]
10392
 
on Linux)\&.
10393
 
.sp
10394
 
Default:
10395
 
\fI\fIutmp directory\fR\fR\fI = \fR\fI\FC # Determined automatically\F[]\fR\fI \fR
10396
 
.sp
10397
 
Example:
10398
 
\fI\fIutmp directory\fR\fR\fI = \fR\fI\FC/var/run/utmp\F[]\fR\fI \fR
10399
 
.RE
10400
 
 
10401
 
utmp (G)
10402
 
.\" utmp
10403
 
.PP
10404
 
.RS 4
10405
 
This boolean parameter is only available if Samba has been configured and compiled with the option
10406
 
\FC\-\-with\-utmp\F[]\&. If set to
10407
 
\fByes\fR
10408
 
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\&.
10409
 
.sp
10410
 
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\&.
10411
 
.sp
10412
 
Default:
10413
 
\fI\fIutmp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10414
 
.RE
10415
 
 
10416
 
valid users (S)
10417
 
.\" valid users
10418
 
.PP
10419
 
.RS 4
10420
 
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
10421
 
\fIinvalid users\fR
10422
 
parameter\&.
10423
 
.sp
10424
 
If this is empty (the default) then any user can login\&. If a username is in both this list and the
10425
 
\fIinvalid users\fR
10426
 
list then access is denied for that user\&.
10427
 
.sp
10428
 
The current servicename is substituted for
10429
 
\fI%S\fR\&. This is useful in the [homes] section\&.
10430
 
.sp
10431
 
Default:
10432
 
\fI\fIvalid users\fR\fR\fI = \fR\fI\FC # No valid users list (anyone can login) \F[]\fR\fI \fR
10433
 
.sp
10434
 
Example:
10435
 
\fI\fIvalid users\fR\fR\fI = \fR\fI\FCgreg, @pcusers\F[]\fR\fI \fR
10436
 
.RE
10437
 
 
10438
 
\-valid (S)
10439
 
.\" -valid
10440
 
.PP
10441
 
.RS 4
10442
 
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\&.
10443
 
.sp
10444
 
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\&.
10445
 
.sp
10446
 
Default:
10447
 
\fI\fI\-valid\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10448
 
.RE
10449
 
 
10450
 
veto files (S)
10451
 
.\" veto files
10452
 
.PP
10453
 
.RS 4
10454
 
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\&.
10455
 
.sp
10456
 
Each entry must be a unix path, not a DOS path and must
10457
 
\fInot\fR
10458
 
include the unix directory separator \'/\'\&.
10459
 
.sp
10460
 
Note that the
10461
 
\m[blue]\fBcase sensitive\fR\m[]
10462
 
option is applicable in vetoing files\&.
10463
 
.sp
10464
 
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
10465
 
\fIfail\fR
10466
 
unless you also set the
10467
 
\m[blue]\fBdelete veto files\fR\m[]
10468
 
parameter to
10469
 
\fIyes\fR\&.
10470
 
.sp
10471
 
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\&.
10472
 
.sp
10473
 
Examples of use include:
10474
 
.sp
10475
 
.if n \{\
10476
 
.RS 4
10477
 
.\}
10478
 
.fam C
10479
 
.ps -1
10480
 
.nf
10481
 
.if t \{\
10482
 
.sp -1
10483
 
.\}
10484
 
.BB lightgray adjust-for-leading-newline
10485
 
.sp -1
10486
 
 
10487
 
; Veto any files containing the word Security,
10488
 
; any ending in \&.tmp, and any directory containing the
10489
 
; word root\&.
10490
 
veto files = /*Security*/*\&.tmp/*root*/
10491
 
 
10492
 
; Veto the Apple specific files that a NetAtalk server
10493
 
; creates\&.
10494
 
veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
10495
 
.EB lightgray adjust-for-leading-newline
10496
 
.if t \{\
10497
 
.sp 1
10498
 
.\}
10499
 
.fi
10500
 
.fam
10501
 
.ps +1
10502
 
.if n \{\
10503
 
.RE
10504
 
.\}
10505
 
.sp
10506
 
Default:
10507
 
\fI\fIveto files\fR\fR\fI = \fR\fI\FCNo files or directories are vetoed\&.\F[]\fR\fI \fR
10508
 
.RE
10509
 
 
10510
 
veto oplock files (S)
10511
 
.\" veto oplock files
10512
 
.PP
10513
 
.RS 4
10514
 
This parameter is only valid when the
10515
 
\m[blue]\fBoplocks\fR\m[]
10516
 
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
10517
 
\m[blue]\fBveto files\fR\m[]
10518
 
parameter\&.
10519
 
.sp
10520
 
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
10521
 
\FC\&.SEM\F[]\&. 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\&.
10522
 
.sp
10523
 
An example of use is:
10524
 
.sp
10525
 
.if n \{\
10526
 
.RS 4
10527
 
.\}
10528
 
.fam C
10529
 
.ps -1
10530
 
.nf
10531
 
.if t \{\
10532
 
.sp -1
10533
 
.\}
10534
 
.BB lightgray adjust-for-leading-newline
10535
 
.sp -1
10536
 
 
10537
 
veto oplock files = /\&.*SEM/
10538
 
.EB lightgray adjust-for-leading-newline
10539
 
.if t \{\
10540
 
.sp 1
10541
 
.\}
10542
 
.fi
10543
 
.fam
10544
 
.ps +1
10545
 
.if n \{\
10546
 
.RE
10547
 
.\}
10548
 
.sp
10549
 
Default:
10550
 
\fI\fIveto oplock files\fR\fR\fI = \fR\fI\FC # No files are vetoed for oplock grants\F[]\fR\fI \fR
10551
 
.RE
10552
 
 
10553
 
vfs object
10554
 
.\" vfs object
10555
 
.PP
10556
 
.RS 4
10557
 
This parameter is a synonym for
10558
 
vfs objects\&.
10559
 
.RE
10560
 
 
10561
 
vfs objects (S)
10562
 
.\" vfs objects
10563
 
.PP
10564
 
.RS 4
10565
 
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\&.
10566
 
.sp
10567
 
Default:
10568
 
\fI\fIvfs objects\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
10569
 
.sp
10570
 
Example:
10571
 
\fI\fIvfs objects\fR\fR\fI = \fR\fI\FCextd_audit recycle\F[]\fR\fI \fR
10572
 
.RE
10573
 
 
10574
 
volume (S)
10575
 
.\" volume
10576
 
.PP
10577
 
.RS 4
10578
 
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\&.
10579
 
.sp
10580
 
Default:
10581
 
\fI\fIvolume\fR\fR\fI = \fR\fI\FC # the name of the share\F[]\fR\fI \fR
10582
 
.RE
10583
 
 
10584
 
wide links (S)
10585
 
.\" wide links
10586
 
.PP
10587
 
.RS 4
10588
 
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\&.
10589
 
.sp
10590
 
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\&.
10591
 
.sp
10592
 
Default:
10593
 
\fI\fIwide links\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10594
 
.RE
10595
 
 
10596
 
winbind cache time (G)
10597
 
.\" winbind cache time
10598
 
.PP
10599
 
.RS 4
10600
 
This parameter specifies the number of seconds the
10601
 
\fBwinbindd\fR(8)
10602
 
daemon will cache user and group information before querying a Windows NT server again\&.
10603
 
.sp
10604
 
This does not apply to authentication requests, these are always evaluated in real time unless the
10605
 
\m[blue]\fBwinbind offline logon\fR\m[]
10606
 
option has been enabled\&.
10607
 
.sp
10608
 
Default:
10609
 
\fI\fIwinbind cache time\fR\fR\fI = \fR\fI\FC300\F[]\fR\fI \fR
10610
 
.RE
10611
 
 
10612
 
winbind enum groups (G)
10613
 
.\" winbind enum groups
10614
 
.PP
10615
 
.RS 4
10616
 
On large installations using
10617
 
\fBwinbindd\fR(8)
10618
 
it may be necessary to suppress the enumeration of groups through the
10619
 
\FCsetgrent()\F[],
10620
 
\FCgetgrent()\F[]
10621
 
and
10622
 
\FCendgrent()\F[]
10623
 
group of system calls\&. If the
10624
 
\fIwinbind enum groups\fR
10625
 
parameter is
10626
 
\fBno\fR, calls to the
10627
 
\FCgetgrent()\F[]
10628
 
system call will not return any data\&.
10629
 
.if n \{\
10630
 
.sp
10631
 
.\}
10632
 
.RS 4
10633
 
.BM yellow
10634
 
.it 1 an-trap
10635
 
.nr an-no-space-flag 1
10636
 
.nr an-break-flag 1
10637
 
.br
10638
 
.ps +1
10639
 
\fBWarning\fR
10640
 
.ps -1
10641
 
.br
10642
 
Turning off group enumeration may cause some programs to behave oddly\&.
10643
 
.sp .5v
10644
 
.EM yellow
10645
 
.RE
10646
 
Default:
10647
 
\fI\fIwinbind enum groups\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10648
 
.RE
10649
 
 
10650
 
winbind enum users (G)
10651
 
.\" winbind enum users
10652
 
.PP
10653
 
.RS 4
10654
 
On large installations using
10655
 
\fBwinbindd\fR(8)
10656
 
it may be necessary to suppress the enumeration of users through the
10657
 
\FCsetpwent()\F[],
10658
 
\FCgetpwent()\F[]
10659
 
and
10660
 
\FCendpwent()\F[]
10661
 
group of system calls\&. If the
10662
 
\fIwinbind enum users\fR
10663
 
parameter is
10664
 
\fBno\fR, calls to the
10665
 
\FCgetpwent\F[]
10666
 
system call will not return any data\&.
10667
 
.if n \{\
10668
 
.sp
10669
 
.\}
10670
 
.RS 4
10671
 
.BM yellow
10672
 
.it 1 an-trap
10673
 
.nr an-no-space-flag 1
10674
 
.nr an-break-flag 1
10675
 
.br
10676
 
.ps +1
10677
 
\fBWarning\fR
10678
 
.ps -1
10679
 
.br
10680
 
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\&.
10681
 
.sp .5v
10682
 
.EM yellow
10683
 
.RE
10684
 
Default:
10685
 
\fI\fIwinbind enum users\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10686
 
.RE
10687
 
 
10688
 
winbind expand groups (G)
10689
 
.\" winbind expand groups
10690
 
.PP
10691
 
.RS 4
10692
 
This option controls the maximum depth that winbindd will traverse when flattening nested group memberships of Windows domain groups\&. This is different from the
10693
 
\m[blue]\fBwinbind nested groups\fR\m[]
10694
 
option which implements the Windows NT4 model of local group nesting\&. The "winbind expand groups" parameter specifically applies to the membership of domain groups\&.
10695
 
.sp
10696
 
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\&.
10697
 
.sp
10698
 
Default:
10699
 
\fI\fIwinbind expand groups\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
10700
 
.RE
10701
 
 
10702
 
winbind nested groups (G)
10703
 
.\" winbind nested groups
10704
 
.PP
10705
 
.RS 4
10706
 
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\&.
10707
 
.sp
10708
 
Default:
10709
 
\fI\fIwinbind nested groups\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10710
 
.RE
10711
 
 
10712
 
winbind normalize names (G)
10713
 
.\" winbind normalize names
10714
 
.PP
10715
 
.RS 4
10716
 
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\&.
10717
 
.sp
10718
 
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\&.
10719
 
.sp
10720
 
Default:
10721
 
\fI\fIwinbind normalize names\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10722
 
.sp
10723
 
Example:
10724
 
\fI\fIwinbind normalize names\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10725
 
.RE
10726
 
 
10727
 
winbind nss info (G)
10728
 
.\" winbind nss info
10729
 
.PP
10730
 
.RS 4
10731
 
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:
10732
 
.sp
10733
 
.RS 4
10734
 
.ie n \{\
10735
 
\h'-04'\(bu\h'+03'\c
10736
 
.\}
10737
 
.el \{\
10738
 
.sp -1
10739
 
.IP \(bu 2.3
10740
 
.\}
10741
 
\fItemplate\fR
10742
 
\- The default, using the parameters of
10743
 
\fItemplate shell\fR
10744
 
and
10745
 
\fItemplate homedir\fR)
10746
 
.RE
10747
 
.sp
10748
 
.RS 4
10749
 
.ie n \{\
10750
 
\h'-04'\(bu\h'+03'\c
10751
 
.\}
10752
 
.el \{\
10753
 
.sp -1
10754
 
.IP \(bu 2.3
10755
 
.\}
10756
 
\fI<sfu | rfc2307 >\fR
10757
 
\- 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
10758
 
\fIidmap backend\fR
10759
 
= ad or
10760
 
\fIidmap config DOMAIN:backend\fR
10761
 
= ad as well\&.
10762
 
.sp
10763
 
.RE
10764
 
.sp
10765
 
Default:
10766
 
\fI\fIwinbind nss info\fR\fR\fI = \fR\fI\FCtemplate\F[]\fR\fI \fR
10767
 
.sp
10768
 
Example:
10769
 
\fI\fIwinbind nss info\fR\fR\fI = \fR\fI\FCtemplate sfu\F[]\fR\fI \fR
10770
 
.RE
10771
 
 
10772
 
winbind offline logon (G)
10773
 
.\" winbind offline logon
10774
 
.PP
10775
 
.RS 4
10776
 
This parameter is designed to control whether Winbind should allow to login with the
10777
 
\fIpam_winbind\fR
10778
 
module using Cached Credentials\&. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\&.
10779
 
.sp
10780
 
Default:
10781
 
\fI\fIwinbind offline logon\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
10782
 
.sp
10783
 
Example:
10784
 
\fI\fIwinbind offline logon\fR\fR\fI = \fR\fI\FCtrue\F[]\fR\fI \fR
10785
 
.RE
10786
 
 
10787
 
winbind reconnect delay (G)
10788
 
.\" winbind reconnect delay
10789
 
.PP
10790
 
.RS 4
10791
 
This parameter specifies the number of seconds the
10792
 
\fBwinbindd\fR(8)
10793
 
daemon will wait between attempts to contact a Domain controller for a domain that is determined to be down or not contactable\&.
10794
 
.sp
10795
 
Default:
10796
 
\fI\fIwinbind reconnect delay\fR\fR\fI = \fR\fI\FC30\F[]\fR\fI \fR
10797
 
.RE
10798
 
 
10799
 
winbind refresh tickets (G)
10800
 
.\" winbind refresh tickets
10801
 
.PP
10802
 
.RS 4
10803
 
This parameter is designed to control whether Winbind should refresh Kerberos Tickets retrieved using the
10804
 
\fIpam_winbind\fR
10805
 
module\&.
10806
 
.sp
10807
 
Default:
10808
 
\fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
10809
 
.sp
10810
 
Example:
10811
 
\fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fI\FCtrue\F[]\fR\fI \fR
10812
 
.RE
10813
 
 
10814
 
winbind rpc only (G)
10815
 
.\" winbind rpc only
10816
 
.PP
10817
 
.RS 4
10818
 
Setting this parameter to
10819
 
\FCyes\F[]
10820
 
forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers\&.
10821
 
.sp
10822
 
Default:
10823
 
\fI\fIwinbind rpc only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10824
 
.RE
10825
 
 
10826
 
winbind separator (G)
10827
 
.\" winbind separator
10828
 
.PP
10829
 
.RS 4
10830
 
This parameter allows an admin to define the character used when listing a username of the form of
10831
 
\fIDOMAIN \fR\e\fIuser\fR\&. This parameter is only applicable when using the
10832
 
\FCpam_winbind\&.so\F[]
10833
 
and
10834
 
\FCnss_winbind\&.so\F[]
10835
 
modules for UNIX services\&.
10836
 
.sp
10837
 
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\&.
10838
 
.sp
10839
 
Default:
10840
 
\fI\fIwinbind separator\fR\fR\fI = \fR\fI\FC\'\e\'\F[]\fR\fI \fR
10841
 
.sp
10842
 
Example:
10843
 
\fI\fIwinbind separator\fR\fR\fI = \fR\fI\FC+\F[]\fR\fI \fR
10844
 
.RE
10845
 
 
10846
 
winbind trusted domains only (G)
10847
 
.\" winbind trusted domains only
10848
 
.PP
10849
 
.RS 4
10850
 
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
10851
 
\FCDOMAIN\euser1\F[]
10852
 
would be mapped to the account user1 in /etc/passwd instead of allocating a new uid for him or her\&.
10853
 
.sp
10854
 
This parameter is now deprecated in favor of the newer idmap_nss backend\&. Refer to the
10855
 
\fBidmap_nss\fR(8)
10856
 
man page for more information\&.
10857
 
.sp
10858
 
Default:
10859
 
\fI\fIwinbind trusted domains only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10860
 
.RE
10861
 
 
10862
 
winbind use default domain (G)
10863
 
.\" winbind use default domain
10864
 
.PP
10865
 
.RS 4
10866
 
This parameter specifies whether the
10867
 
\fBwinbindd\fR(8)
10868
 
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\&.
10869
 
.sp
10870
 
Default:
10871
 
\fI\fIwinbind use default domain\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10872
 
.sp
10873
 
Example:
10874
 
\fI\fIwinbind use default domain\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
10875
 
.RE
10876
 
 
10877
 
wins hook (G)
10878
 
.\" wins hook
10879
 
.PP
10880
 
.RS 4
10881
 
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\&.
10882
 
.sp
10883
 
The wins hook parameter specifies the name of a script or executable that will be called as follows:
10884
 
.sp
10885
 
\FCwins_hook operation name nametype ttl IP_list\F[]
10886
 
.sp
10887
 
.RS 4
10888
 
.ie n \{\
10889
 
\h'-04'\(bu\h'+03'\c
10890
 
.\}
10891
 
.el \{\
10892
 
.sp -1
10893
 
.IP \(bu 2.3
10894
 
.\}
10895
 
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\&.
10896
 
.RE
10897
 
.sp
10898
 
.RS 4
10899
 
.ie n \{\
10900
 
\h'-04'\(bu\h'+03'\c
10901
 
.\}
10902
 
.el \{\
10903
 
.sp -1
10904
 
.IP \(bu 2.3
10905
 
.\}
10906
 
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\&.
10907
 
.RE
10908
 
.sp
10909
 
.RS 4
10910
 
.ie n \{\
10911
 
\h'-04'\(bu\h'+03'\c
10912
 
.\}
10913
 
.el \{\
10914
 
.sp -1
10915
 
.IP \(bu 2.3
10916
 
.\}
10917
 
The third argument is the NetBIOS name type as a 2 digit hexadecimal number\&.
10918
 
.RE
10919
 
.sp
10920
 
.RS 4
10921
 
.ie n \{\
10922
 
\h'-04'\(bu\h'+03'\c
10923
 
.\}
10924
 
.el \{\
10925
 
.sp -1
10926
 
.IP \(bu 2.3
10927
 
.\}
10928
 
The fourth argument is the TTL (time to live) for the name in seconds\&.
10929
 
.RE
10930
 
.sp
10931
 
.RS 4
10932
 
.ie n \{\
10933
 
\h'-04'\(bu\h'+03'\c
10934
 
.\}
10935
 
.el \{\
10936
 
.sp -1
10937
 
.IP \(bu 2.3
10938
 
.\}
10939
 
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\&.
10940
 
.sp
10941
 
.RE
10942
 
An example script that calls the BIND dynamic DNS update program
10943
 
\FCnsupdate\F[]
10944
 
is provided in the examples directory of the Samba source code\&.
10945
 
.sp
10946
 
\fINo default\fR
10947
 
.RE
10948
 
 
10949
 
wins proxy (G)
10950
 
.\" wins proxy
10951
 
.PP
10952
 
.RS 4
10953
 
This is a boolean that controls if
10954
 
\fBnmbd\fR(8)
10955
 
will respond to broadcast name queries on behalf of other hosts\&. You may need to set this to
10956
 
\fByes\fR
10957
 
for some older clients\&.
10958
 
.sp
10959
 
Default:
10960
 
\fI\fIwins proxy\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
10961
 
.RE
10962
 
 
10963
 
wins server (G)
10964
 
.\" wins server
10965
 
.PP
10966
 
.RS 4
10967
 
This specifies the IP address (or DNS name: IP address for preference) of the WINS server that
10968
 
\fBnmbd\fR(8)
10969
 
should register with\&. If you have a WINS server on your network then you should set this to the WINS server\'s IP\&.
10970
 
.sp
10971
 
You should point this at your WINS server if you have a multi\-subnetted network\&.
10972
 
.sp
10973
 
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\&.
10974
 
.if n \{\
10975
 
.sp
10976
 
.\}
10977
 
.RS 4
10978
 
.BM yellow
10979
 
.it 1 an-trap
10980
 
.nr an-no-space-flag 1
10981
 
.nr an-break-flag 1
10982
 
.br
10983
 
.ps +1
10984
 
\fBNote\fR
10985
 
.ps -1
10986
 
.br
10987
 
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\&.
10988
 
.sp .5v
10989
 
.EM yellow
10990
 
.RE
10991
 
See the chapter in the Samba3\-HOWTO on Network Browsing\&.
10992
 
.sp
10993
 
Default:
10994
 
\fI\fIwins server\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
10995
 
.sp
10996
 
Example:
10997
 
\fI\fIwins server\fR\fR\fI = \fR\fI\FCmary: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\&.\F[]\fR\fI \fR
10998
 
.sp
10999
 
Example:
11000
 
\fI\fIwins server\fR\fR\fI = \fR\fI\FC192\&.9\&.200\&.1 192\&.168\&.2\&.61\F[]\fR\fI \fR
11001
 
.RE
11002
 
 
11003
 
wins support (G)
11004
 
.\" wins support
11005
 
.PP
11006
 
.RS 4
11007
 
This boolean controls if the
11008
 
\fBnmbd\fR(8)
11009
 
process in Samba will act as a WINS server\&. You should not set this to
11010
 
\fByes\fR
11011
 
unless you have a multi\-subnetted network and you wish a particular
11012
 
\FCnmbd\F[]
11013
 
to be your WINS server\&. Note that you should
11014
 
\fINEVER\fR
11015
 
set this to
11016
 
\fByes\fR
11017
 
on more than one machine in your network\&.
11018
 
.sp
11019
 
Default:
11020
 
\fI\fIwins support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
11021
 
.RE
11022
 
 
11023
 
workgroup (G)
11024
 
.\" workgroup
11025
 
.PP
11026
 
.RS 4
11027
 
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
11028
 
\m[blue]\fBsecurity = domain\fR\m[]
11029
 
setting\&.
11030
 
.sp
11031
 
Default:
11032
 
\fI\fIworkgroup\fR\fR\fI = \fR\fI\FCWORKGROUP\F[]\fR\fI \fR
11033
 
.sp
11034
 
Example:
11035
 
\fI\fIworkgroup\fR\fR\fI = \fR\fI\FCMYGROUP\F[]\fR\fI \fR
11036
 
.RE
11037
 
 
11038
 
writable
11039
 
.\" writable
11040
 
.PP
11041
 
.RS 4
11042
 
This parameter is a synonym for
11043
 
writeable\&.
11044
 
.RE
11045
 
 
11046
 
writeable (S)
11047
 
.\" writeable
11048
 
.PP
11049
 
.RS 4
11050
 
Inverted synonym for
11051
 
\m[blue]\fBread only\fR\m[]\&.
11052
 
.sp
11053
 
Default:
11054
 
\fI\fIwriteable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
11055
 
.RE
11056
 
 
11057
 
write cache size (S)
11058
 
.\" write cache size
11059
 
.PP
11060
 
.RS 4
11061
 
If this integer parameter is set to non\-zero value, Samba will create an in\-memory cache for each oplocked file (it does
11062
 
\fInot\fR
11063
 
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\&.
11064
 
.sp
11065
 
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\&.
11066
 
.sp
11067
 
The integer parameter specifies the size of this cache (per oplocked file) in bytes\&.
11068
 
.sp
11069
 
Default:
11070
 
\fI\fIwrite cache size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
11071
 
.sp
11072
 
Example:
11073
 
\fI\fIwrite cache size\fR\fR\fI = \fR\fI\FC262144 # for a 256k cache size per file\F[]\fR\fI \fR
11074
 
.RE
11075
 
 
11076
 
write list (S)
11077
 
.\" write list
11078
 
.PP
11079
 
.RS 4
11080
 
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
11081
 
\m[blue]\fBread only\fR\m[]
11082
 
option is set to\&. The list can include group names using the @group syntax\&.
11083
 
.sp
11084
 
Note that if a user is in both the read list and the write list then they will be given write access\&.
11085
 
.sp
11086
 
By design, this parameter will not work with the
11087
 
\m[blue]\fBsecurity = share\fR\m[]
11088
 
in Samba 3\&.0\&.
11089
 
.sp
11090
 
Default:
11091
 
\fI\fIwrite list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
11092
 
.sp
11093
 
Example:
11094
 
\fI\fIwrite list\fR\fR\fI = \fR\fI\FCadmin, root, @staff\F[]\fR\fI \fR
11095
 
.RE
11096
 
 
11097
 
write raw (G)
11098
 
.\" write raw
11099
 
.PP
11100
 
.RS 4
11101
 
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\&.
11102
 
.sp
11103
 
Default:
11104
 
\fI\fIwrite raw\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
11105
 
.RE
11106
 
 
11107
 
wtmp directory (G)
11108
 
.\" wtmp directory
11109
 
.PP
11110
 
.RS 4
11111
 
This parameter is only available if Samba has been configured and compiled with the option
11112
 
\FC \-\-with\-utmp\F[]\&. 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\&.
11113
 
.sp
11114
 
By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually
11115
 
\FC/var/run/wtmp\F[]
11116
 
on Linux)\&.
11117
 
.sp
11118
 
Default:
11119
 
\fI\fIwtmp directory\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
11120
 
.sp
11121
 
Example:
11122
 
\fI\fIwtmp directory\fR\fR\fI = \fR\fI\FC/var/log/wtmp\F[]\fR\fI \fR
11123
 
.RE
11124
 
.SH "WARNINGS"
11125
 
.PP
11126
 
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\&.
11127
 
.PP
11128
 
On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\&.
11129
 
\fBsmbd\fR(8)
11130
 
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\&.
11131
 
.PP
11132
 
Use of the
11133
 
\FC[homes]\F[]
11134
 
and
11135
 
\FC[printers]\F[]
11136
 
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\&.
11137
 
.SH "VERSION"
11138
 
.PP
11139
 
This man page is correct for version 3 of the Samba suite\&.
11140
 
.SH "SEE ALSO"
11141
 
.PP
11142
 
 
11143
 
\fBsamba\fR(7),
11144
 
\fBsmbpasswd\fR(8),
11145
 
\fBswat\fR(8),
11146
 
\fBsmbd\fR(8),
11147
 
\fBnmbd\fR(8),
11148
 
\fBsmbclient\fR(1),
11149
 
\fBnmblookup\fR(1),
11150
 
\fBtestparm\fR(1),
11151
 
\fBtestprns\fR(1)\&.
11152
 
.SH "AUTHOR"
11153
 
.PP
11154
 
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\&.
11155
 
.PP
11156
 
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
11157
 
ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) 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\&.