Ignore:
Timestamp:
Jun 24, 2009, 5:09:21 PM (16 years ago)
Author:
Herwig Bauernfeind
Message:

Update 3.0 to 3.0.35

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/samba-3.0/docs/manpages/smb.conf.5

    r158 r286  
    11.\"     Title: smb.conf
    2 .\"    Author:
    3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
    4 .\"      Date: 08/25/2008
     2.\"    Author: [see the "AUTHOR" section]
     3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
     4.\"      Date: 06/22/2009
    55.\"    Manual: File Formats and Conventions
    66.\"    Source: Samba 3.0
     7.\"  Language: English
    78.\"
    8 .TH "SMB\.CONF" "5" "08/25/2008" "Samba 3\.0" "File Formats and Conventions"
     9.TH "SMB\&.CONF" "5" "06/22/2009" "Samba 3\&.0" "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.\" -----------------------------------------------------------------
    9162.\" disable hyphenation
    10163.nh
    11164.\" disable justification (adjust text to left margin only)
    12165.ad l
    13 .SH "NAME"
    14 smb.conf - The configuration file for the Samba suite
     166.\" -----------------------------------------------------------------
     167.\" * MAIN CONTENT STARTS HERE *
     168.\" -----------------------------------------------------------------
     169.SH "Name"
     170smb.conf \- The configuration file for the Samba suite
    15171.SH "SYNOPSIS"
    16172.PP
    17173The
    18 \fIsmb\.conf\fR
    19 file is a configuration file for the Samba suite\.
    20 \fIsmb\.conf\fR
    21 contains runtime configuration information for the Samba programs\. The
    22 \fIsmb\.conf\fR
     174\FCsmb\&.conf\F[]
     175file is a configuration file for the Samba suite\&.
     176\FCsmb\&.conf\F[]
     177contains runtime configuration information for the Samba programs\&. The
     178\FCsmb\&.conf\F[]
    23179file is designed to be configured and administered by the
    24180\fBswat\fR(8)
    25 program\. The complete description of the file format and possible parameters held within are here for reference purposes\.
     181program\&. The complete description of the file format and possible parameters held within are here for reference purposes\&.
    26182.SH "FILE FORMAT"
    27183.PP
    28 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:
    29 .sp
    30 .RS 4
     184The 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
    31191.nf
     192.if t \{\
     193.sp -1
     194.\}
     195.BB lightgray adjust-for-leading-newline
     196.sp -1
     197
    32198\fIname\fR = \fIvalue \fR
     199.EB lightgray adjust-for-leading-newline
     200.if t \{\
     201.sp 1
     202.\}
    33203.fi
    34 .RE
    35 .PP
    36 The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\.
    37 .PP
    38 Section and parameter names are not case sensitive\.
    39 .PP
    40 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\.
    41 .PP
    42 Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\.
     204.fam
     205.ps +1
     206.if n \{\
     207.RE
     208.\}
     209.PP
     210The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\&.
     211.PP
     212Section and parameter names are not case sensitive\&.
     213.PP
     214Only 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
     216Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\&.
    43217.PP
    44218Any line ending in a
    45 \(lq\e\(rq
    46 is continued on the next line in the customary UNIX fashion\.
    47 .PP
    48 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, 0/1 or true/false\. Case is not significant in boolean values, but is preserved in string values\. Some items such as create masks are numeric\.
     219\(lq\FC\e\F[]\(rq
     220is continued on the next line in the customary UNIX fashion\&.
     221.PP
     222The 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, 0/1 or true/false\&. Case is not significant in boolean values, but is preserved in string values\&. Some items such as create masks are numeric\&.
    49223.SH "SECTION DESCRIPTIONS"
    50224.PP
    51225Each section in the configuration file (except for the [global] section) describes a shared resource (known as a
    52 \(lqshare\(rq)\. The section name is the name of the shared resource and the parameters within the section define the shares attributes\.
     226\(lqshare\(rq)\&. The section name is the name of the shared resource and the parameters within the section define the shares attributes\&.
    53227.PP
    54228There are three special sections, [global], [homes] and [printers], which are described under
    55 \fIspecial sections\fR\. The following notes apply to ordinary section descriptions\.
    56 .PP
    57 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\.
    58 .PP
    59 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)\.
     229\fIspecial sections\fR\&. The following notes apply to ordinary section descriptions\&.
     230.PP
     231A 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
     233Sections 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)\&.
    60234.PP
    61235Sections may be designated
    62236\fIguest\fR
    63 services, in which case no password is required to access them\. A specified UNIX
     237services, in which case no password is required to access them\&. A specified UNIX
    64238\fIguest account\fR
    65 is used to define access privileges in this case\.
    66 .PP
    67 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
    68 user =
    69 option in the share definition\. For modern clients such as Windows 95/98/ME/NT/2000, this should not be necessary\.
    70 .PP
    71 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\.
    72 .PP
    73 The following sample section defines a file space share\. The user has write access to the path
    74 \fI/home/bar\fR\. The share is accessed via the share name
    75 foo:
    76 .sp
    77 .RS 4
     239is used to define access privileges in this case\&.
     240.PP
     241Sections 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[]
     243option in the share definition\&. For modern clients such as Windows 95/98/ME/NT/2000, this should not be necessary\&.
     244.PP
     245The 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
     247The 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
    78256.nf
     257.if t \{\
     258.sp -1
     259.\}
     260.BB lightgray adjust-for-leading-newline
     261.sp -1
     262
    79263        \fI[foo]\fR
    80         \fIpath = /home/bar\fR
    81         \fIread only = no\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.\}
    82270.fi
    83 .RE
    84 .PP
    85 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
     271.fam
     272.ps +1
     273.if n \{\
     274.RE
     275.\}
     276.PP
     277The 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
    86278\fIguest ok\fR
    87279parameter means access will be permitted as the default guest user (specified elsewhere):
    88280.sp
    89 .RS 4
     281.if n \{\
     282.RS 4
     283.\}
     284.fam C
     285.ps -1
    90286.nf
     287.if t \{\
     288.sp -1
     289.\}
     290.BB lightgray adjust-for-leading-newline
     291.sp -1
     292
    91293        \fI[aprinter]\fR
    92         \fIpath = /usr/spool/public\fR
    93         \fIread only = yes\fR
    94         \fIprintable = yes\fR
    95         \fIguest ok = yes\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.\}
    96302.fi
    97 .RE
     303.fam
     304.ps +1
     305.if n \{\
     306.RE
     307.\}
    98308.sp
    99309.SH "SPECIAL SECTIONS"
    100310.SS "The [global] section"
    101311.PP
    102 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\.
     312Parameters 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\&.
    103313.SS "The [homes] section"
    104314.PP
    105 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\.
    106 .PP
    107 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\.
     315If 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
     317When 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\&.
    108318.PP
    109319Some modifications are then made to the newly created share:
     
    117327.IP \(bu 2.3
    118328.\}
    119 The share name is changed from homes to the located username\.
    120 .RE
    121 .sp
    122 .RS 4
    123 .ie n \{\
    124 \h'-04'\(bu\h'+03'\c
    125 .\}
    126 .el \{\
    127 .sp -1
    128 .IP \(bu 2.3
    129 .\}
    130 If no path was given, the path is set to the user\'s home directory\.
     329The 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.\}
     340If no path was given, the path is set to the user\'s home directory\&.
    131341.sp
    132342.RE
     
    134344If you decide to use a
    135345\fIpath =\fR
    136 line in your [homes] section, it may be useful to use the %S macro\. For example:
    137 .sp
    138 .RS 4
     346line 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
    139353.nf
     354.if t \{\
     355.sp -1
     356.\}
     357.BB lightgray adjust-for-leading-newline
     358.sp -1
     359
    140360\fBpath = /data/pchome/%S\fR
     361.EB lightgray adjust-for-leading-newline
     362.if t \{\
     363.sp 1
     364.\}
    141365.fi
    142 .RE
    143 .sp
    144 is useful if you have different home directories for your PCs than for UNIX access\.
    145 .PP
    146 This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss\.
     366.fam
     367.ps +1
     368.if n \{\
     369.RE
     370.\}
     371.sp
     372is useful if you have different home directories for your PCs than for UNIX access\&.
     373.PP
     374This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss\&.
    147375.PP
    148376A similar process occurs if the requested section name is
    149 \(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\.
    150 .PP
    151 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:
    152 .sp
    153 .RS 4
     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
     379The [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
    154386.nf
     387.if t \{\
     388.sp -1
     389.\}
     390.BB lightgray adjust-for-leading-newline
     391.sp -1
     392
    155393\fI[homes]\fR
    156 \fIread only = no\fR
     394\m[blue]\fBread only = no\fR\m[]
     395.EB lightgray adjust-for-leading-newline
     396.if t \{\
     397.sp 1
     398.\}
    157399.fi
    158 .RE
     400.fam
     401.ps +1
     402.if n \{\
     403.RE
     404.\}
    159405.PP
    160406An important point is that if guest access is specified in the [homes] section, all home directories will be visible to all clients
    161 \fIwithout a password\fR\. In the very unlikely event that this is actually desirable, it is wise to also specify
    162 \fIread only access\fR\.
     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\&.
    163409.PP
    164410The
    165411\fIbrowseable\fR
    166 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
     412flag for auto home directories will be inherited from the global browseable flag, not the [homes] browseable flag\&. This is useful as it means setting
    167413\fIbrowseable = no\fR
    168 in the [homes] section will hide the [homes] share but make any auto home directories visible\.
     414in the [homes] section will hide the [homes] share but make any auto home directories visible\&.
    169415.SS "The [printers] section"
    170416.PP
    171 This section works like [homes], but for printers\.
    172 .PP
    173 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\.
    174 .PP
    175 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\.
     417This section works like [homes], but for printers\&.
     418.PP
     419If 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
     421When 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\&.
    176422.PP
    177423A few modifications are then made to the newly created share:
     
    207453.IP \(bu 2.3
    208454.\}
    209 If the share does not permit guest access and no username was given, the username is set to the located printer name\.
    210 .sp
    211 .RE
    212 .PP
    213 The [printers] service MUST be printable \- if you specify otherwise, the server will refuse to load the configuration file\.
    214 .PP
    215 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:
    216 .sp
    217 .RS 4
     455If 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
     459The [printers] service MUST be printable \- if you specify otherwise, the server will refuse to load the configuration file\&.
     460.PP
     461Typically 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
    218468.nf
     469.if t \{\
     470.sp -1
     471.\}
     472.BB lightgray adjust-for-leading-newline
     473.sp -1
     474
    219475\fI[printers]\fR
    220 \fIpath = /usr/spool/public\fR
    221 \fIguest ok = yes\fR
    222 \fIprintable = yes\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.\}
    223483.fi
    224 .RE
    225 .PP
    226 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:
    227 .sp
    228 .RS 4
     484.fam
     485.ps +1
     486.if n \{\
     487.RE
     488.\}
     489.PP
     490All 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
    229497.nf
    230 alias|alias|alias|alias\.\.\.   
     498.if t \{\
     499.sp -1
     500.\}
     501.BB lightgray adjust-for-leading-newline
     502.sp -1
     503
     504alias|alias|alias|alias\&.\&.\&.   
     505.EB lightgray adjust-for-leading-newline
     506.if t \{\
     507.sp 1
     508.\}
    231509.fi
    232 .RE
    233 .PP
    234 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\.
    235 .PP
    236 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 (|)\.
    237 .sp
     510.fam
     511.ps +1
     512.if n \{\
     513.RE
     514.\}
     515.PP
     516Each 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
     518An 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
    238524.it 1 an-trap
    239525.nr an-no-space-flag 1
    240526.nr an-break-flag 1
    241527.br
    242 Note
     528.ps +1
     529\fBNote\fR
     530.ps -1
     531.br
    243532.PP
    244533On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use
    245 printcap name = lpstat
    246 to automatically obtain a list of printers\. See the
    247 printcap name
    248 option for more details\.
     534\FCprintcap name = lpstat\F[]
     535to automatically obtain a list of printers\&. See the
     536\FCprintcap name\F[]
     537option for more details\&.
     538.sp .5v
     539.EM yellow
     540.RE
    249541.SH "USERSHARES"
    250542.PP
    251 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
     543Starting 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
    252544\fIusershares\fR
    253 and is controlled by a set of parameters in the [global] section of the smb\.conf\. The relevant parameters are :
     545and is controlled by a set of parameters in the [global] section of the smb\&.conf\&. The relevant parameters are :
    254546.PP
    255547usershare allow guests
    256548.RS 4
    257 Controls if usershares can permit guest access\.
     549Controls if usershares can permit guest access\&.
    258550.RE
    259551.PP
    260552usershare max shares
    261553.RS 4
    262 Maximum number of user defined shares allowed\.
     554Maximum number of user defined shares allowed\&.
    263555.RE
    264556.PP
    265557usershare owner only
    266558.RS 4
    267 If set only directories owned by the sharing user can be shared\.
     559If set only directories owned by the sharing user can be shared\&.
    268560.RE
    269561.PP
    270562usershare path
    271563.RS 4
    272 Points to the directory containing the user defined share definitions\. The filesystem permissions on this directory control who can create user defined shares\.
     564Points to the directory containing the user defined share definitions\&. The filesystem permissions on this directory control who can create user defined shares\&.
    273565.RE
    274566.PP
    275567usershare prefix allow list
    276568.RS 4
    277 Comma\-separated list of absolute pathnames restricting what directories can be shared\. Only directories below the pathnames in this list are permitted\.
     569Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Only directories below the pathnames in this list are permitted\&.
    278570.RE
    279571.PP
    280572usershare prefix deny list
    281573.RS 4
    282 Comma\-separated list of absolute pathnames restricting what directories can be shared\. Directories below the pathnames in this list are prohibited\.
     574Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Directories below the pathnames in this list are prohibited\&.
    283575.RE
    284576.PP
    285577usershare template share
    286578.RS 4
    287 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\.
     579Names 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\&.
    288580.RE
    289581.PP
    290582To allow members of the UNIX group
    291 foo
     583\FCfoo\F[]
    292584to create user defined shares, create the directory to contain the share definitions as follows:
    293585.PP
    294586Become root:
    295587.sp
    296 .RS 4
     588.if n \{\
     589.RS 4
     590.\}
     591.fam C
     592.ps -1
    297593.nf
     594.if t \{\
     595.sp -1
     596.\}
     597.BB lightgray adjust-for-leading-newline
     598.sp -1
     599
    298600mkdir /usr/local/samba/lib/usershares
    299601chgrp foo /usr/local/samba/lib/usershares
    300602chmod 1770 /usr/local/samba/lib/usershares
     603.EB lightgray adjust-for-leading-newline
     604.if t \{\
     605.sp 1
     606.\}
    301607.fi
    302 .RE
     608.fam
     609.ps +1
     610.if n \{\
     611.RE
     612.\}
    303613.PP
    304614Then add the parameters
    305615.sp
    306 .RS 4
     616.if n \{\
     617.RS 4
     618.\}
     619.fam C
     620.ps -1
    307621.nf
    308         \fIusershare path = /usr/local/samba/lib/usershares\fR
    309         \fIusershare max shares = 10\fR # (or the desired number of shares)
     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.\}
    310634.fi
    311 .RE
     635.fam
     636.ps +1
     637.if n \{\
     638.RE
     639.\}
    312640.sp
    313641to the global section of your
    314 \fIsmb\.conf\fR\. Members of the group foo may then manipulate the user defined shares using the following commands\.
     642\FCsmb\&.conf\F[]\&. Members of the group foo may then manipulate the user defined shares using the following commands\&.
    315643.PP
    316644net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]
    317645.RS 4
    318 To create or modify (overwrite) a user defined share\.
     646To create or modify (overwrite) a user defined share\&.
    319647.RE
    320648.PP
    321649net usershare delete sharename
    322650.RS 4
    323 To delete a user defined share\.
     651To delete a user defined share\&.
    324652.RE
    325653.PP
    326654net usershare list wildcard\-sharename
    327655.RS 4
    328 To list user defined shares\.
     656To list user defined shares\&.
    329657.RE
    330658.PP
    331659net usershare info wildcard\-sharename
    332660.RS 4
    333 To print information about user defined shares\.
     661To print information about user defined shares\&.
    334662.RE
    335663.SH "PARAMETERS"
    336664.PP
    337 Parameters define the specific attributes of sections\.
    338 .PP
    339 Some parameters are specific to the [global] section (e\.g\.,
    340 \fIsecurity\fR)\. Some parameters are usable in all sections (e\.g\.,
    341 \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
     665Parameters define the specific attributes of sections\&.
     666.PP
     667Some 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
    342670\fIG\fR
    343 in parentheses indicates that a parameter is specific to the [global] section\. The letter
     671in parentheses indicates that a parameter is specific to the [global] section\&. The letter
    344672\fIS\fR
    345 indicates that a parameter can be specified in a service specific section\. All
     673indicates that a parameter can be specified in a service specific section\&. All
    346674\fIS\fR
    347 parameters can also be specified in the [global] section \- in which case they will define the default behavior for all services\.
    348 .PP
    349 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\.
     675parameters can also be specified in the [global] section \- in which case they will define the default behavior for all services\&.
     676.PP
     677Parameters 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\&.
    350678.SH "VARIABLE SUBSTITUTIONS"
    351679.PP
    352 Many of the strings that are settable in the config file can take substitutions\. For example the option
     680Many of the strings that are settable in the config file can take substitutions\&. For example the option
    353681\(lqpath = /tmp/%u\(rq
    354682is interpreted as
    355683\(lqpath = /tmp/john\(rq
    356 if the user connected with the username john\.
    357 .PP
    358 These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant\. These are:
     684if the user connected with the username john\&.
     685.PP
     686These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant\&. These are:
    359687.PP
    360688%U
    361689.RS 4
    362 session username (the username that the client wanted, not necessarily the same as the one they got)\.
     690session username (the username that the client wanted, not necessarily the same as the one they got)\&.
    363691.RE
    364692.PP
    365693%G
    366694.RS 4
    367 primary group name of %U\.
     695primary group name of %U\&.
    368696.RE
    369697.PP
    370698%h
    371699.RS 4
    372 the Internet hostname that Samba is running on\.
     700the Internet hostname that Samba is running on\&.
    373701.RE
    374702.PP
    375703%m
    376704.RS 4
    377 the NetBIOS name of the client machine (very useful)\.
    378 .sp
    379 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
    380 \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\.
     705the NetBIOS name of the client machine (very useful)\&.
     706.sp
     707This 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\&.
    381709.RE
    382710.PP
    383711%L
    384712.RS 4
    385 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
    386 \(lqdual personality\(rq\.
     713the 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\&.
    387715.RE
    388716.PP
    389717%M
    390718.RS 4
    391 the Internet name of the client machine\.
     719the Internet name of the client machine\&.
    392720.RE
    393721.PP
    394722%R
    395723.RS 4
    396 the selected protocol level after protocol negotiation\. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1\.
     724the selected protocol level after protocol negotiation\&. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2 or NT1\&.
    397725.RE
    398726.PP
    399727%d
    400728.RS 4
    401 the process id of the current server process\.
     729the process id of the current server process\&.
    402730.RE
    403731.PP
    404732%a
    405733.RS 4
    406 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
    407 \fBUNKNOWN\fR\.
     734The 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\&.
    408736.RE
    409737.PP
    410738%I
    411739.RS 4
    412 the IP address of the client machine\.
     740the IP address of the client machine\&.
    413741.RE
    414742.PP
    415743%i
    416744.RS 4
    417 the local IP address to which a client connected\.
     745the local IP address to which a client connected\&.
    418746.RE
    419747.PP
    420748%T
    421749.RS 4
    422 the current date and time\.
     750the current date and time\&.
    423751.RE
    424752.PP
    425753%D
    426754.RS 4
    427 name of the domain or workgroup of the current user\.
     755name of the domain or workgroup of the current user\&.
    428756.RE
    429757.PP
    430758%w
    431759.RS 4
    432 the winbind separator\.
     760the winbind separator\&.
    433761.RE
    434762.PP
     
    436764.RS 4
    437765the value of the environment variable
    438 \fIenvar\fR\.
     766\fIenvar\fR\&.
    439767.RE
    440768.PP
     
    443771%S
    444772.RS 4
    445 the name of the current service, if any\.
     773the name of the current service, if any\&.
    446774.RE
    447775.PP
    448776%P
    449777.RS 4
    450 the root directory of the current service, if any\.
     778the root directory of the current service, if any\&.
    451779.RE
    452780.PP
    453781%u
    454782.RS 4
    455 username of the current service, if any\.
     783username of the current service, if any\&.
    456784.RE
    457785.PP
    458786%g
    459787.RS 4
    460 primary group name of %u\.
     788primary group name of %u\&.
    461789.RE
    462790.PP
    463791%H
    464792.RS 4
    465 the home directory of the user given by %u\.
     793the home directory of the user given by %u\&.
    466794.RE
    467795.PP
    468796%N
    469797.RS 4
    470 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
     798the name of your NIS home directory server\&. This is obtained from your NIS auto\&.map entry\&. If you have not compiled Samba with the
    471799\fI\-\-with\-automount\fR
    472 option, this value will be the same as %L\.
     800option, this value will be the same as %L\&.
    473801.RE
    474802.PP
    475803%p
    476804.RS 4
    477 the path of the service\'s home directory, obtained from your NIS auto\.map entry\. The NIS auto\.map entry is split up as
    478 %N:%p\.
     805the 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[]\&.
    479807.RE
    480808.PP
    481809There are some quite creative things that can be done with these substitutions and other
    482 \fIsmb\.conf\fR
    483 options\.
     810\FCsmb\&.conf\F[]
     811options\&.
    484812.SH "NAME MANGLING"
    485813.PP
    486814Samba supports
    487 name mangling
    488 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\.
    489 .PP
    490 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\.
    491 .PP
    492 These options can be set separately for each service\.
     815\FCname mangling\F[]
     816so 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
     818There 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
     820These options can be set separately for each service\&.
    493821.PP
    494822The options are:
     
    496824case sensitive = yes/no/auto
    497825.RS 4
    498 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
    499 \fIauto\fR\.
     826controls 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\&.
    500828.RE
    501829.PP
    502830default case = upper/lower
    503831.RS 4
    504 controls what the default case is for new filenames (ie\. files that don\'t currently exist in the filesystem)\. Default
    505 \fIlower\fR\. IMPORTANT NOTE: This option will be used to modify the case of
     832controls 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
    506834\fIall\fR
    507835incoming client filenames, not just new filenames if the options
    508 \fIcase sensitive = yes\fR,
    509 \fIpreserve case = No\fR,
    510 \fIshort preserve case = No\fR
    511 are set\. This change is needed as part of the optimisations for directories containing large numbers of files\.
     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[]
     839are set\&. This change is needed as part of the optimisations for directories containing large numbers of files\&.
    512840.RE
    513841.PP
    514842preserve case = yes/no
    515843.RS 4
    516 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
    517 default
    518 case\. Default
    519 \fIyes\fR\.
     844controls 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[]
     846case\&. Default
     847\fIyes\fR\&.
    520848.RE
    521849.PP
    522850short preserve case = yes/no
    523851.RS 4
    524 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
    525 default
    526 case\. This option can be used with
    527 preserve case = yes
    528 to permit long filenames to retain their case, while short names are lowercased\. Default
    529 \fIyes\fR\.
    530 .RE
    531 .PP
    532 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\.
     852controls 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[]
     854case\&. This option can be used with
     855\FCpreserve case = yes\F[]
     856to permit long filenames to retain their case, while short names are lowercased\&. Default
     857\fIyes\fR\&.
     858.RE
     859.PP
     860By 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\&.
    533861.SH "NOTE ABOUT USERNAME/PASSWORD VALIDATION"
    534862.PP
    535 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\.
     863There 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\&.
    536864.PP
    537865If the service is marked
    538866\(lqguest only = yes\(rq
    539 and the server is running with share\-level security (\(lqsecurity = share\(rq, steps 1 to 5 are skipped\.
    540 .sp
    541 .RS 4
    542 \h'-04' 1.\h'+02'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
    543 \e\eserver\eservice%\fIusername\fR
    544 method of passing a username\.
    545 .RE
    546 .sp
    547 .RS 4
    548 \h'-04' 2.\h'+02'If the client has previously registered a username with the system and now supplies a correct password for that username, the connection is allowed\.
    549 .RE
    550 .sp
    551 .RS 4
    552 \h'-04' 3.\h'+02'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\.
    553 .RE
    554 .sp
    555 .RS 4
    556 \h'-04' 4.\h'+02'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\.
    557 .RE
    558 .sp
    559 .RS 4
    560 \h'-04' 5.\h'+02'If a
    561 user =
     867and 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.\}
     877If 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
     879method 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.\}
     890If 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.\}
     901The 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.\}
     912If 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.\}
     923If a
     924\FCuser = \F[]
    562925field is given in the
    563 \fIsmb\.conf\fR
     926\FCsmb\&.conf\F[]
    564927file 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
    565 user =
     928\FCuser =\F[]
    566929field, the connection is made as the username in the
    567 user =
    568 line\. If one of the usernames in the
    569 user =
     930\FCuser =\F[]
     931line\&. If one of the usernames in the
     932\FCuser =\F[]
    570933list begins with a
    571 @, that name expands to a list of names in the group of the same name\.
    572 .RE
    573 .sp
    574 .RS 4
    575 \h'-04' 6.\h'+02'If the service is a guest service, a connection is made as the username given in the
    576 guest account =
    577 for the service, irrespective of the supplied password\.
     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.\}
     945If the service is a guest service, a connection is made as the username given in the
     946\FCguest account =\F[]
     947for the service, irrespective of the supplied password\&.
    578948.RE
    579949.SH "EXPLANATION OF EACH PARAMETER"
     
    581951
    582952abort shutdown script (G)
     953.\" abort shutdown script
    583954.PP
    584955.RS 4
     
    586957\fBsmbd\fR(8)
    587958that should stop a shutdown procedure issued by the
    588 \fIshutdown script\fR\.
     959\m[blue]\fBshutdown script\fR\m[]\&.
    589960.sp
    590961If the connected user posseses the
    591 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user\.
    592 .sp
    593 Default:
    594 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI""\fR\fI \fR
    595 .sp
    596 Example:
    597 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI/sbin/shutdown \-c\fR\fI \fR
     962\fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user\&.
     963.sp
     964Default:
     965\fI\fIabort shutdown script\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
     966.sp
     967Example:
     968\fI\fIabort shutdown script\fR\fR\fI = \fR\fI\FC/sbin/shutdown \-c\F[]\fR\fI \fR
    598969.RE
    599970
    600971acl check permissions (S)
     972.\" acl check permissions
    601973.PP
    602974.RS 4
    603975This boolean parameter controls what
    604 \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\.
    605 .sp
    606 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 refersh\. 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\.
    607 .sp
    608 Default:
    609 \fI\fIacl check permissions\fR\fR\fI = \fR\fITrue\fR\fI \fR
    610 .RE
    611 
    612 acl compatibility (S)
    613 .PP
    614 .RS 4
    615 This parameter specifies what OS ACL semantics should be compatible with\. Possible values are
     976\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\&.
     977.sp
     978If 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 refersh\&. 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\&.
     979.sp
     980Default:
     981\fI\fIacl check permissions\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
     982.RE
     983
     984acl compatibility (G)
     985.\" acl compatibility
     986.PP
     987.RS 4
     988This parameter specifies what OS ACL semantics should be compatible with\&. Possible values are
    616989\fIwinnt\fR
    617990for Windows NT 4,
    618991\fIwin2k\fR
    619992for Windows 2000 and above and
    620 \fIauto\fR\. If you specify
    621 \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\.
    622 .sp
    623 Default:
    624 \fI\fIacl compatibility\fR\fR\fI = \fR\fIAuto\fR\fI \fR
    625 .sp
    626 Example:
    627 \fI\fIacl compatibility\fR\fR\fI = \fR\fIwin2k\fR\fI \fR
     993\fIauto\fR\&. If you specify
     994\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\&.
     995.sp
     996Default:
     997\fI\fIacl compatibility\fR\fR\fI = \fR\fI\FCAuto\F[]\fR\fI \fR
     998.sp
     999Example:
     1000\fI\fIacl compatibility\fR\fR\fI = \fR\fI\FCwin2k\F[]\fR\fI \fR
    6281001.RE
    6291002
    6301003acl group control (S)
    631 .PP
    632 .RS 4
    633 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
     1004.\" acl group control
     1005.PP
     1006.RS 4
     1007In 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
    6341008\fIprimary group owner\fR
    635 of a file or directory to modify the permissions and ACLs on that file\.
    636 .sp
    637 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\.
    638 .sp
    639 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\.
     1009of a file or directory to modify the permissions and ACLs on that file\&.
     1010.sp
     1011On 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\&.
     1012.sp
     1013This 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\&.
    6401014.sp
    6411015This parameter is best used with the
    642 \fIinherit owner\fR
     1016\m[blue]\fBinherit owner\fR\m[]
    6431017option and also on on a share containing directories with the UNIX
    6441018\fIsetgid bit\fR
    645 set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory\.
    646 .sp
    647 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
     1019set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory\&.
     1020.sp
     1021This 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
    6481022\fIdos filemode\fR
    649 option\.
    650 .sp
    651 Default:
    652 \fI\fIacl group control\fR\fR\fI = \fR\fIno\fR\fI \fR
     1023option\&.
     1024.sp
     1025Default:
     1026\fI\fIacl group control\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    6531027.RE
    6541028
    6551029acl map full control (S)
     1030.\" acl map full control
    6561031.PP
    6571032.RS 4
    6581033This boolean parameter controls whether
    659 \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\.
    660 .sp
    661 Default:
    662 \fI\fIacl map full control\fR\fR\fI = \fR\fITrue\fR\fI \fR
     1034\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\&.
     1035.sp
     1036Default:
     1037\fI\fIacl map full control\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
    6631038.RE
    6641039
    6651040add group script (G)
     1041.\" add group script
    6661042.PP
    6671043.RS 4
     
    6701046by
    6711047\fBsmbd\fR(8)
    672 when a new group is requested\. It will expand any
     1048when a new group is requested\&. It will expand any
    6731049\fI%g\fR
    674 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\.
    675 .sp
    676 Default:
    677 \fI\fIadd group script\fR\fR\fI = \fR\fI\fR\fI \fR
    678 .sp
    679 Example:
    680 \fI\fIadd group script\fR\fR\fI = \fR\fI/usr/sbin/groupadd %g\fR\fI \fR
     1050to 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\&.
     1051.sp
     1052Default:
     1053\fI\fIadd group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1054.sp
     1055Example:
     1056\fI\fIadd group script\fR\fR\fI = \fR\fI\FC/usr/sbin/groupadd %g\F[]\fR\fI \fR
    6811057.RE
    6821058
    6831059add machine script (G)
     1060.\" add machine script
    6841061.PP
    6851062.RS 4
    6861063This is the full pathname to a script that will be run by
    6871064\fBsmbd\fR(8)
    688 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\.
     1065when a machine is added to Samba\'s domain and a Unix account matching the machine\'s name appended with a "$" does not already exist\&.
    6891066.sp
    6901067This option is very similar to the
    691 \fIadd user script\fR, and likewise uses the %u substitution for the account name\. Do not use the %m substitution\.
    692 .sp
    693 Default:
    694 \fI\fIadd machine script\fR\fR\fI = \fR\fI\fR\fI \fR
    695 .sp
    696 Example:
    697 \fI\fIadd machine script\fR\fR\fI = \fR\fI/usr/sbin/adduser \-n \-g machines \-c Machine \-d /var/lib/nobody \-s /bin/false %u\fR\fI \fR
     1068\m[blue]\fBadd user script\fR\m[], and likewise uses the %u substitution for the account name\&. Do not use the %m substitution\&.
     1069.sp
     1070Default:
     1071\fI\fIadd machine script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1072.sp
     1073Example:
     1074\fI\fIadd machine script\fR\fR\fI = \fR\fI\FC/usr/sbin/adduser \-n \-g machines \-c Machine \-d /var/lib/nobody \-s /bin/false %u\F[]\fR\fI \fR
    6981075.RE
    6991076
    7001077add port command (G)
    701 .PP
    702 .RS 4
    703 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:
     1078.\" add port command
     1079.PP
     1080.RS 4
     1081Samba 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:
    7041082.sp
    7051083.RS 4
     
    7251103.sp
    7261104.RE
    727 The deviceURI is in the for of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>\.
    728 .sp
    729 Default:
    730 \fI\fIadd port command\fR\fR\fI = \fR\fI\fR\fI \fR
    731 .sp
    732 Example:
    733 \fI\fIadd port command\fR\fR\fI = \fR\fI/etc/samba/scripts/addport\.sh\fR\fI \fR
     1105The deviceURI is in the for of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>\&.
     1106.sp
     1107Default:
     1108\fI\fIadd port command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1109.sp
     1110Example:
     1111\fI\fIadd port command\fR\fR\fI = \fR\fI\FC/etc/samba/scripts/addport\&.sh\F[]\fR\fI \fR
    7341112.RE
    7351113
    7361114add printer command (G)
    737 .PP
    738 .RS 4
    739 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\.
    740 .sp
    741 For a Samba host this means that the printer must be physically added to the underlying printing system\. The
     1115.\" add printer command
     1116.PP
     1117.RS 4
     1118With 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\&.
     1119.sp
     1120For a Samba host this means that the printer must be physically added to the underlying printing system\&. The
    7421121\fIadd printer command\fR
    7431122defines 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
    744 \fIsmb\.conf\fR
     1123\FCsmb\&.conf\F[]
    7451124file in order that it can be shared by
    746 \fBsmbd\fR(8)\.
     1125\fBsmbd\fR(8)\&.
    7471126.sp
    7481127The
     
    8161195.sp
    8171196.RE
    818 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\.
     1197All 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\&.
    8191198.sp
    8201199Once the
    8211200\fIaddprinter command\fR
    8221201has been executed,
    823 smbd
     1202\FCsmbd\F[]
    8241203will reparse the
    825 \fI smb\.conf\fR
    826 to determine if the share defined by the APW exists\. If the sharename is still invalid, then
    827 smbd
    828 will return an ACCESS_DENIED error to the client\.
    829 .sp
    830 The "add printer command" 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\.
    831 .sp
    832 Default:
    833 \fI\fIadd printer command\fR\fR\fI = \fR\fI\fR\fI \fR
    834 .sp
    835 Example:
    836 \fI\fIadd printer command\fR\fR\fI = \fR\fI/usr/bin/addprinter\fR\fI \fR
     1204\FC smb\&.conf\F[]
     1205to determine if the share defined by the APW exists\&. If the sharename is still invalid, then
     1206\FCsmbd \F[]
     1207will return an ACCESS_DENIED error to the client\&.
     1208.sp
     1209The "add printer command" 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\&.
     1210.sp
     1211Default:
     1212\fI\fIadd printer command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1213.sp
     1214Example:
     1215\fI\fIadd printer command\fR\fR\fI = \fR\fI\FC/usr/bin/addprinter\F[]\fR\fI \fR
    8371216.RE
    8381217
    8391218add share command (G)
    840 .PP
    841 .RS 4
    842 Samba 2\.2\.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\.0 Server Manager\. The
     1219.\" add share command
     1220.PP
     1221.RS 4
     1222Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
    8431223\fIadd share command\fR
    8441224is used to define an external program or script which will add a new service definition to
    845 \fIsmb\.conf\fR\. In order to successfully execute the
     1225\FCsmb\&.conf\F[]\&.
     1226.sp
     1227In order to successfully execute the
    8461228\fIadd share command\fR,
    847 smbd
    848 requires that the administrator be connected using a root account (i\.e\. uid == 0)\.
    849 .sp
    850 If the connected account has
    851 SeDiskOperatorPrivilege, scripts defined in
    852 \fIchange share\fR
    853 parameter are executed as root\.
     1229\FCsmbd\F[]
     1230requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
     1231\FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
     1232\fIadd share command\fR
     1233parameter are executed as root\&.
    8541234.sp
    8551235When executed,
    856 smbd
     1236\FCsmbd\F[]
    8571237will automatically invoke the
    8581238\fIadd share command\fR
    859 with five parameters\.
     1239with five parameters\&.
    8601240.sp
    8611241.RS 4
     
    8691249\fIconfigFile\fR
    8701250\- the location of the global
    871 \fIsmb\.conf\fR
    872 file\.
     1251\FCsmb\&.conf\F[]
     1252file\&.
    8731253.RE
    8741254.sp
     
    8821262.\}
    8831263\fIshareName\fR
    884 \- the name of the new share\.
     1264\- the name of the new share\&.
    8851265.RE
    8861266.sp
     
    8941274.\}
    8951275\fIpathName\fR
    896 \- path to an **existing** directory on disk\.
     1276\- path to an **existing** directory on disk\&.
    8971277.RE
    8981278.sp
     
    9061286.\}
    9071287\fIcomment\fR
    908 \- comment string to associate with the new share\.
     1288\- comment string to associate with the new share\&.
    9091289.RE
    9101290.sp
     
    9181298.\}
    9191299\fImax connections\fR
    920 Number of maximum simultaneous connections to this share\.
    921 .sp
    922 .RE
    923 This parameter is only used for add file shares\. To add printer shares, see the
    924 \fIaddprinter command\fR\.
    925 .sp
    926 Default:
    927 \fI\fIadd share command\fR\fR\fI = \fR\fI\fR\fI \fR
    928 .sp
    929 Example:
    930 \fI\fIadd share command\fR\fR\fI = \fR\fI/usr/local/bin/addshare\fR\fI \fR
     1300Number of maximum simultaneous connections to this share\&.
     1301.sp
     1302.RE
     1303This parameter is only used to add file shares\&. To add printer shares, see the
     1304\m[blue]\fBaddprinter command\fR\m[]\&.
     1305.sp
     1306Default:
     1307\fI\fIadd share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1308.sp
     1309Example:
     1310\fI\fIadd share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/addshare\F[]\fR\fI \fR
    9311311.RE
    9321312
    9331313add user script (G)
     1314.\" add user script
    9341315.PP
    9351316.RS 4
     
    9381319by
    9391320\fBsmbd\fR(8)
    940 under special circumstances described below\.
    941 .sp
    942 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
     1321under special circumstances described below\&.
     1322.sp
     1323Normally, 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
    9431324\fION DEMAND\fR
    944 when a user accesses the Samba server\.
     1325when a user accesses the Samba server\&.
    9451326.sp
    9461327In order to use this option,
     
    9491330\fINOT\fR
    9501331be set to
    951 \fIsecurity = share\fR
     1332\m[blue]\fBsecurity = share\fR\m[]
    9521333and
    953 \fIadd user script\fR
     1334\m[blue]\fBadd user script\fR\m[]
    9541335must be set to a full pathname for a script that will create a UNIX user given one argument of
    955 \fI%u\fR, which expands into the UNIX user name to create\.
     1336\fI%u\fR, which expands into the UNIX user name to create\&.
    9561337.sp
    9571338When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time,
    9581339\fBsmbd\fR(8)
    9591340contacts the
    960 \fIpassword server\fR
    961 and attempts to authenticate the given user with the given password\. If the authentication succeeds then
    962 smbd
    963 attempts to find a UNIX user in the UNIX password database to map the Windows user into\. If this lookup fails, and
    964 \fIadd user script\fR
     1341\m[blue]\fBpassword server\fR\m[]
     1342and attempts to authenticate the given user with the given password\&. If the authentication succeeds then
     1343\FCsmbd\F[]
     1344attempts to find a UNIX user in the UNIX password database to map the Windows user into\&. If this lookup fails, and
     1345\m[blue]\fBadd user script\fR\m[]
    9651346is set then
    966 smbd
     1347\FCsmbd\F[]
    9671348will call the specified script
    9681349\fIAS ROOT\fR, expanding any
    9691350\fI%u\fR
    970 argument to be the user name to create\.
     1351argument to be the user name to create\&.
    9711352.sp
    9721353If this script successfully creates the user then
    973 smbd
    974 will continue on as though the UNIX user already existed\. In this way, UNIX users are dynamically created to match existing Windows NT accounts\.
     1354\FCsmbd\F[]
     1355will continue on as though the UNIX user already existed\&. In this way, UNIX users are dynamically created to match existing Windows NT accounts\&.
    9751356.sp
    9761357See also
    977 \fIsecurity\fR,
    978 \fIpassword server\fR,
    979 \fIdelete user script\fR\.
    980 .sp
    981 Default:
    982 \fI\fIadd user script\fR\fR\fI = \fR\fI\fR\fI \fR
    983 .sp
    984 Example:
    985 \fI\fIadd user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/add_user %u\fR\fI \fR
     1358\m[blue]\fBsecurity\fR\m[],
     1359\m[blue]\fBpassword server\fR\m[],
     1360\m[blue]\fBdelete user script\fR\m[]\&.
     1361.sp
     1362Default:
     1363\fI\fIadd user script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1364.sp
     1365Example:
     1366\fI\fIadd user script\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/add_user %u\F[]\fR\fI \fR
    9861367.RE
    9871368
    9881369add user to group script (G)
    989 .PP
    990 .RS 4
    991 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
     1370.\" add user to group script
     1371.PP
     1372.RS 4
     1373Full 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
    9921374\fBsmbd\fR(8)
    993 \fIAS ROOT\fR\. Any
     1375\fIAS ROOT\fR\&. Any
    9941376\fI%g\fR
    9951377will be replaced with the group name and any
    9961378\fI%u\fR
    997 will be replaced with the user name\.
     1379will be replaced with the user name\&.
    9981380.sp
    9991381Note that the
    1000 adduser
    1001 command used in the example below does not support the used syntax on all systems\.
    1002 .sp
    1003 Default:
    1004 \fI\fIadd user to group script\fR\fR\fI = \fR\fI\fR\fI \fR
    1005 .sp
    1006 Example:
    1007 \fI\fIadd user to group script\fR\fR\fI = \fR\fI/usr/sbin/adduser %u %g\fR\fI \fR
     1382\FCadduser\F[]
     1383command used in the example below does not support the used syntax on all systems\&.
     1384.sp
     1385Default:
     1386\fI\fIadd user to group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1387.sp
     1388Example:
     1389\fI\fIadd user to group script\fR\fR\fI = \fR\fI\FC/usr/sbin/adduser %u %g\F[]\fR\fI \fR
    10081390.RE
    10091391
    10101392admin users (S)
    1011 .PP
    1012 .RS 4
    1013 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)\.
    1014 .sp
    1015 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\.
     1393.\" admin users
     1394.PP
     1395.RS 4
     1396This 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)\&.
     1397.sp
     1398You 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\&.
    10161399.sp
    10171400This parameter will not work with the
    1018 \fIsecurity = share\fR
    1019 in Samba 3\.0\. This is by design\.
    1020 .sp
    1021 Default:
    1022 \fI\fIadmin users\fR\fR\fI = \fR\fI\fR\fI \fR
    1023 .sp
    1024 Example:
    1025 \fI\fIadmin users\fR\fR\fI = \fR\fIjason\fR\fI \fR
     1401\m[blue]\fBsecurity = share\fR\m[]
     1402in Samba 3\&.0\&. This is by design\&.
     1403.sp
     1404Default:
     1405\fI\fIadmin users\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1406.sp
     1407Example:
     1408\fI\fIadmin users\fR\fR\fI = \fR\fI\FCjason\F[]\fR\fI \fR
    10261409.RE
    10271410
    10281411afs share (S)
    1029 .PP
    1030 .RS 4
    1031 This parameter controls whether special AFS features are enabled for this share\. If enabled, it assumes that the directory exported via the
     1412.\" afs share
     1413.PP
     1414.RS 4
     1415This parameter controls whether special AFS features are enabled for this share\&. If enabled, it assumes that the directory exported via the
    10321416\fIpath\fR
    1033 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\.
    1034 .sp
    1035 Default:
    1036 \fI\fIafs share\fR\fR\fI = \fR\fIno\fR\fI \fR
     1417parameter 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\&.
     1418.sp
     1419Default:
     1420\fI\fIafs share\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    10371421.RE
    10381422
    10391423afs username map (G)
    1040 .PP
    1041 .RS 4
    1042 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\.
    1043 .sp
    1044 The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token\.
    1045 .sp
    1046 Default:
    1047 \fI\fIafs username map\fR\fR\fI = \fR\fI\fR\fI \fR
    1048 .sp
    1049 Example:
    1050 \fI\fIafs username map\fR\fR\fI = \fR\fI%u@afs\.samba\.org\fR\fI \fR
     1424.\" afs username map
     1425.PP
     1426.RS 4
     1427If 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\&.
     1428.sp
     1429The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token\&.
     1430.sp
     1431Default:
     1432\fI\fIafs username map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1433.sp
     1434Example:
     1435\fI\fIafs username map\fR\fR\fI = \fR\fI\FC%u@afs\&.samba\&.org\F[]\fR\fI \fR
    10511436.RE
    10521437
    10531438aio read size (S)
    1054 .PP
    1055 .RS 4
    1056 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\.
    1057 .sp
    1058 Current implementation of asynchronous I/O in Samba 3\.0 does support only up to 10 outstanding asynchronous requests, read and write combined\.
     1439.\" aio read size
     1440.PP
     1441.RS 4
     1442If 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\&.
     1443.sp
     1444Current implementation of asynchronous I/O in Samba 3\&.0 does support only up to 10 outstanding asynchronous requests, read and write combined\&.
    10591445.sp
    10601446Related command:
    1061 \fIwrite cache size\fR
     1447\m[blue]\fBwrite cache size\fR\m[]
    10621448.sp
    10631449Related command:
    1064 \fIaio write size\fR
    1065 .sp
    1066 Default:
    1067 \fI\fIaio read size\fR\fR\fI = \fR\fI0\fR\fI \fR
    1068 .sp
    1069 Example:
    1070 \fI\fIaio read size\fR\fR\fI = \fR\fI16384 # Use asynchronous I/O for reads bigger than 16KB request size\fR\fI \fR
     1450\m[blue]\fBaio write size\fR\m[]
     1451.sp
     1452Default:
     1453\fI\fIaio read size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     1454.sp
     1455Example:
     1456\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
    10711457.RE
    10721458
    10731459aio write size (S)
    1074 .PP
    1075 .RS 4
    1076 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\.
    1077 .sp
    1078 Current implementation of asynchronous I/O in Samba 3\.0 does support only up to 10 outstanding asynchronous requests, read and write combined\.
     1460.\" aio write size
     1461.PP
     1462.RS 4
     1463If 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\&.
     1464.sp
     1465Current implementation of asynchronous I/O in Samba 3\&.0 does support only up to 10 outstanding asynchronous requests, read and write combined\&.
    10791466.sp
    10801467Related command:
    1081 \fIwrite cache size\fR
     1468\m[blue]\fBwrite cache size\fR\m[]
    10821469.sp
    10831470Related command:
    1084 \fIaio read size\fR
    1085 .sp
    1086 Default:
    1087 \fI\fIaio write size\fR\fR\fI = \fR\fI0\fR\fI \fR
    1088 .sp
    1089 Example:
    1090 \fI\fIaio write size\fR\fR\fI = \fR\fI16384 # Use asynchronous I/O for writes bigger than 16KB request size\fR\fI \fR
     1471\m[blue]\fBaio read size\fR\m[]
     1472.sp
     1473Default:
     1474\fI\fIaio write size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     1475.sp
     1476Example:
     1477\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
    10911478.RE
    10921479
    10931480algorithmic rid base (G)
    1094 .PP
    1095 .RS 4
    1096 This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers\.
    1097 .sp
    1098 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\.
    1099 .sp
    1100 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\.
    1101 .sp
    1102 Default:
    1103 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI1000\fR\fI \fR
    1104 .sp
    1105 Example:
    1106 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI100000\fR\fI \fR
     1481.\" algorithmic rid base
     1482.PP
     1483.RS 4
     1484This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers\&.
     1485.sp
     1486Setting 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\&.
     1487.sp
     1488All 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\&.
     1489.sp
     1490Default:
     1491\fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
     1492.sp
     1493Example:
     1494\fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI\FC100000\F[]\fR\fI \fR
    11071495.RE
    11081496
    11091497allocation roundup size (S)
    1110 .PP
    1111 .RS 4
    1112 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\.
    1113 .sp
    1114 The integer parameter specifies the roundup size in bytes\.
    1115 .sp
    1116 Default:
    1117 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI1048576\fR\fI \fR
    1118 .sp
    1119 Example:
    1120 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI0 # (to disable roundups)\fR\fI \fR
     1498.\" allocation roundup size
     1499.PP
     1500.RS 4
     1501This 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\&.
     1502.sp
     1503The integer parameter specifies the roundup size in bytes\&.
     1504.sp
     1505Default:
     1506\fI\fIallocation roundup size\fR\fR\fI = \fR\fI\FC1048576\F[]\fR\fI \fR
     1507.sp
     1508Example:
     1509\fI\fIallocation roundup size\fR\fR\fI = \fR\fI\FC0 # (to disable roundups)\F[]\fR\fI \fR
    11211510.RE
    11221511
    11231512allow trusted domains (G)
     1513.\" allow trusted domains
    11241514.PP
    11251515.RS 4
    11261516This option only takes effect when the
    1127 \fIsecurity\fR
     1517\m[blue]\fBsecurity\fR\m[]
    11281518option is set to
    11291519\fBserver\fR,
    11301520\fBdomain\fR
    11311521or
    1132 \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\.
    1133 .sp
    1134 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\.
    1135 .sp
    1136 Default:
    1137 \fI\fIallow trusted domains\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1522\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\&.
     1523.sp
     1524This 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\&.
     1525.sp
     1526Default:
     1527\fI\fIallow trusted domains\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    11381528.RE
    11391529
    11401530announce as (G)
     1531.\" announce as
    11411532.PP
    11421533.RS 4
    11431534This specifies what type of server
    11441535\fBnmbd\fR(8)
    1145 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\.
    1146 .sp
    1147 Default:
    1148 \fI\fIannounce as\fR\fR\fI = \fR\fINT Server\fR\fI \fR
    1149 .sp
    1150 Example:
    1151 \fI\fIannounce as\fR\fR\fI = \fR\fIWin95\fR\fI \fR
     1536will 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\&.
     1537.sp
     1538Default:
     1539\fI\fIannounce as\fR\fR\fI = \fR\fI\FCNT Server\F[]\fR\fI \fR
     1540.sp
     1541Example:
     1542\fI\fIannounce as\fR\fR\fI = \fR\fI\FCWin95\F[]\fR\fI \fR
    11521543.RE
    11531544
    11541545announce version (G)
    1155 .PP
    1156 .RS 4
    1157 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\.
    1158 .sp
    1159 Default:
    1160 \fI\fIannounce version\fR\fR\fI = \fR\fI4\.9\fR\fI \fR
    1161 .sp
    1162 Example:
    1163 \fI\fIannounce version\fR\fR\fI = \fR\fI2\.0\fR\fI \fR
     1546.\" announce version
     1547.PP
     1548.RS 4
     1549This 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\&.
     1550.sp
     1551Default:
     1552\fI\fIannounce version\fR\fR\fI = \fR\fI\FC4\&.9\F[]\fR\fI \fR
     1553.sp
     1554Example:
     1555\fI\fIannounce version\fR\fR\fI = \fR\fI\FC2\&.0\F[]\fR\fI \fR
    11641556.RE
    11651557
    11661558auth methods (G)
     1559.\" auth methods
    11671560.PP
    11681561.RS 4
    11691562This option allows the administrator to chose what authentication methods
    1170 smbd
    1171 will use when authenticating a user\. This option defaults to sensible values based on
    1172 \fIsecurity\fR\. 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\.
    1173 .sp
    1174 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\.
     1563\FCsmbd\F[]
     1564will use when authenticating a user\&. This option defaults to sensible values based on
     1565\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\&.
     1566.sp
     1567Each 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\&.
    11751568.sp
    11761569Possible options include
     
    11841577(pre\-winbindd method of authentication for remote domain users; deprecated in favour of winbind method),
    11851578\fBtrustdomain\fR
    1186 (authenticate trusted users by contacting the remote DC directly from smbd; deprecated in favour of winbind method)\.
    1187 .sp
    1188 Default:
    1189 \fI\fIauth methods\fR\fR\fI = \fR\fI\fR\fI \fR
    1190 .sp
    1191 Example:
    1192 \fI\fIauth methods\fR\fR\fI = \fR\fIguest sam winbind\fR\fI \fR
     1579(authenticate trusted users by contacting the remote DC directly from smbd; deprecated in favour of winbind method)\&.
     1580.sp
     1581Default:
     1582\fI\fIauth methods\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1583.sp
     1584Example:
     1585\fI\fIauth methods\fR\fR\fI = \fR\fI\FCguest sam winbind\F[]\fR\fI \fR
    11931586.RE
    11941587
    11951588available (S)
    1196 .PP
    1197 .RS 4
    1198 This parameter lets you "turn off" a service\. If
     1589.\" available
     1590.PP
     1591.RS 4
     1592This parameter lets you "turn off" a service\&. If
    11991593\fIavailable = no\fR, then
    12001594\fIALL\fR
    1201 attempts to connect to the service will fail\. Such failures are logged\.
    1202 .sp
    1203 Default:
    1204 \fI\fIavailable\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1595attempts to connect to the service will fail\&. Such failures are logged\&.
     1596.sp
     1597Default:
     1598\fI\fIavailable\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    12051599.RE
    12061600
    12071601bind interfaces only (G)
    1208 .PP
    1209 .RS 4
    1210 This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\. It affects file service
     1602.\" bind interfaces only
     1603.PP
     1604.RS 4
     1605This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\&. It affects file service
    12111606\fBsmbd\fR(8)
    12121607and name service
    12131608\fBnmbd\fR(8)
    1214 in a slightly different ways\.
     1609in a slightly different ways\&.
    12151610.sp
    12161611For name service it causes
    1217 nmbd
     1612\FCnmbd\F[]
    12181613to bind to ports 137 and 138 on the interfaces listed in the
    1219 \fIinterfaces\fR
    1220 parameter\.
    1221 nmbd
    1222 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
    1223 nmbd
    1224 will service name requests on all of these sockets\. If
    1225 \fIbind interfaces only\fR
     1614\m[blue]\fBinterfaces\fR\m[]
     1615parameter\&.
     1616\FCnmbd\F[]
     1617also 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
     1618\FCnmbd\F[]
     1619will service name requests on all of these sockets\&. If
     1620\m[blue]\fBbind interfaces only\fR\m[]
    12261621is set then
    1227 nmbd
     1622\FCnmbd\F[]
    12281623will 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
    1229 \fIinterfaces\fR
    1230 parameter list\. As unicast packets are received on the other sockets it allows
    1231 nmbd
     1624\m[blue]\fBinterfaces\fR\m[]
     1625parameter list\&. As unicast packets are received on the other sockets it allows
     1626\FCnmbd\F[]
    12321627to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the
    1233 \fIinterfaces\fR
    1234 list\. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
    1235 nmbd\.
     1628\m[blue]\fBinterfaces\fR\m[]
     1629list\&. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
     1630\FCnmbd\F[]\&.
    12361631.sp
    12371632For file service it causes
    12381633\fBsmbd\fR(8)
    12391634to bind only to the interface list given in the
    1240 \fIinterfaces\fR
    1241 parameter\. This restricts the networks that
    1242 smbd
    1243 will serve to packets coming in 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\.
     1635\m[blue]\fBinterfaces\fR\m[]
     1636parameter\&. This restricts the networks that
     1637\FCsmbd\F[]
     1638will serve to packets coming in 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\&.
    12441639.sp
    12451640If
    1246 \fIbind interfaces only\fR
     1641\m[blue]\fBbind interfaces only\fR\m[]
    12471642is set then unless the network address
    1248 \fI127\.0\.0\.1\fR
     1643\fI127\&.0\&.0\&.1\fR
    12491644is added to the
    1250 \fIinterfaces\fR
     1645\m[blue]\fBinterfaces\fR\m[]
    12511646parameter list
    12521647\fBsmbpasswd\fR(8)
    12531648and
    12541649\fBswat\fR(8)
    1255 may not work as expected due to the reasons covered below\.
     1650may not work as expected due to the reasons covered below\&.
    12561651.sp
    12571652To change a users SMB password, the
    1258 smbpasswd
     1653\FCsmbpasswd\F[]
    12591654by default connects to the
    1260 \fIlocalhost \- 127\.0\.0\.1\fR
    1261 address as an SMB client to issue the password change request\. If
    1262 \fIbind interfaces only\fR
     1655\fIlocalhost \- 127\&.0\&.0\&.1\fR
     1656address as an SMB client to issue the password change request\&. If
     1657\m[blue]\fBbind interfaces only\fR\m[]
    12631658is set then unless the network address
    1264 \fI127\.0\.0\.1\fR
     1659\fI127\&.0\&.0\&.1\fR
    12651660is added to the
    1266 \fIinterfaces\fR
     1661\m[blue]\fBinterfaces\fR\m[]
    12671662parameter list then
    1268 smbpasswd
    1269 will fail to connect in it\'s default mode\.
    1270 smbpasswd
     1663\FC smbpasswd\F[]
     1664will fail to connect in it\'s default mode\&.
     1665\FCsmbpasswd\F[]
    12711666can be forced to use the primary IP interface of the local host by using its
    12721667\fBsmbpasswd\fR(8)
     
    12741669parameter, with
    12751670\fIremote machine\fR
    1276 set to the IP name of the primary interface of the local host\.
     1671set to the IP name of the primary interface of the local host\&.
    12771672.sp
    12781673The
    1279 swat
     1674\FCswat\F[]
    12801675status page tries to connect with
    1281 smbd
     1676\FCsmbd\F[]
    12821677and
    1283 nmbd
     1678\FCnmbd\F[]
    12841679at the address
    1285 \fI127\.0\.0\.1\fR
    1286 to determine if they are running\. Not adding
    1287 \fI127\.0\.0\.1\fR
     1680\fI127\&.0\&.0\&.1\fR
     1681to determine if they are running\&. Not adding
     1682\fI127\&.0\&.0\&.1\fR
    12881683will cause
    1289 smbd
     1684\FC smbd\F[]
    12901685and
    1291 nmbd
    1292 to always show "not running" even if they really are\. This can prevent
    1293 swat
     1686\FCnmbd\F[]
     1687to always show "not running" even if they really are\&. This can prevent
     1688\FC swat\F[]
    12941689from starting/stopping/restarting
    1295 smbd
     1690\FCsmbd\F[]
    12961691and
    1297 nmbd\.
    1298 .sp
    1299 Default:
    1300 \fI\fIbind interfaces only\fR\fR\fI = \fR\fIno\fR\fI \fR
     1692\FCnmbd\F[]\&.
     1693.sp
     1694Default:
     1695\fI\fIbind interfaces only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    13011696.RE
    13021697
    13031698blocking locks (S)
     1699.\" blocking locks
    13041700.PP
    13051701.RS 4
    13061702This parameter controls the behavior of
    13071703\fBsmbd\fR(8)
    1308 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\.
    1309 .sp
    1310 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\.
     1704when 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\&.
     1705.sp
     1706If 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\&.
    13111707.sp
    13121708If this parameter is set to
    1313 \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\.
    1314 .sp
    1315 Default:
    1316 \fI\fIblocking locks\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1709\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\&.
     1710.sp
     1711Default:
     1712\fI\fIblocking locks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    13171713.RE
    13181714
    13191715block size (S)
     1716.\" block size
    13201717.PP
    13211718.RS 4
    13221719This parameter controls the behavior of
    13231720\fBsmbd\fR(8)
    1324 when reporting disk free sizes\. By default, this reports a disk block size of 1024 bytes\.
    1325 .sp
    1326 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\.
    1327 .sp
    1328 Changing this option does not change the disk free reporting size, just the block size unit reported to the client\.
    1329 .sp
    1330 Default:
    1331 \fI\fIblock size\fR\fR\fI = \fR\fI1024\fR\fI \fR
    1332 .sp
    1333 Example:
    1334 \fI\fIblock size\fR\fR\fI = \fR\fI4096\fR\fI \fR
     1721when reporting disk free sizes\&. By default, this reports a disk block size of 1024 bytes\&.
     1722.sp
     1723Changing 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\&.
     1724.sp
     1725Changing this option does not change the disk free reporting size, just the block size unit reported to the client\&.
     1726.sp
     1727Default:
     1728\fI\fIblock size\fR\fR\fI = \fR\fI\FC1024\F[]\fR\fI \fR
     1729.sp
     1730Example:
     1731\fI\fIblock size\fR\fR\fI = \fR\fI\FC4096\F[]\fR\fI \fR
    13351732.RE
    13361733
    13371734browsable
     1735.\" browsable
    13381736.PP
    13391737.RS 4
    13401738This parameter is a synonym for
    1341 browseable\.
     1739browseable\&.
    13421740.RE
    13431741
    13441742browseable (S)
    1345 .PP
    1346 .RS 4
    1347 This controls whether this share is seen in the list of available shares in a net view and in the browse list\.
    1348 .sp
    1349 Default:
    1350 \fI\fIbrowseable\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1743.\" browseable
     1744.PP
     1745.RS 4
     1746This controls whether this share is seen in the list of available shares in a net view and in the browse list\&.
     1747.sp
     1748Default:
     1749\fI\fIbrowseable\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    13511750.RE
    13521751
    13531752browse list (G)
     1753.\" browse list
    13541754.PP
    13551755.RS 4
     
    13571757\fBsmbd\fR(8)
    13581758will serve a browse list to a client doing a
    1359 NetServerEnum
    1360 call\. Normally set to
    1361 \fByes\fR\. You should never need to change this\.
    1362 .sp
    1363 Default:
    1364 \fI\fIbrowse list\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1759\FCNetServerEnum\F[]
     1760call\&. Normally set to
     1761\fByes\fR\&. You should never need to change this\&.
     1762.sp
     1763Default:
     1764\fI\fIbrowse list\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    13651765.RE
    13661766
    13671767casesignames
     1768.\" casesignames
    13681769.PP
    13691770.RS 4
    13701771This parameter is a synonym for
    1371 case sensitive\.
     1772case sensitive\&.
    13721773.RE
    13731774
    13741775case sensitive (S)
     1776.\" case sensitive
    13751777.PP
    13761778.RS 4
    13771779See the discussion in the section
    1378 \fIname mangling\fR\.
    1379 .sp
    1380 Default:
    1381 \fI\fIcase sensitive\fR\fR\fI = \fR\fIno\fR\fI \fR
     1780\m[blue]\fBname mangling\fR\m[]\&.
     1781.sp
     1782Default:
     1783\fI\fIcase sensitive\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    13821784.RE
    13831785
    13841786change notify (S)
    1385 .PP
    1386 .RS 4
    1387 This parameter specifies whether Samba should reply to a client\'s file change notify requests\.
     1787.\" change notify
     1788.PP
     1789.RS 4
     1790This parameter specifies whether Samba should reply to a client\'s file change notify requests\&.
    13881791.sp
    13891792You should never need to change this parameter
    13901793.sp
    13911794Default:
    1392 \fI\fIchange notify\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1795\fI\fIchange notify\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    13931796.RE
    13941797
    13951798change share command (G)
    1396 .PP
    1397 .RS 4
    1398 Samba 2\.2\.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\.0 Server Manager\. The
     1799.\" change share command
     1800.PP
     1801.RS 4
     1802Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
    13991803\fIchange share command\fR
    14001804is used to define an external program or script which will modify an existing service definition in
    1401 \fIsmb\.conf\fR\. In order to successfully execute the
     1805\FCsmb\&.conf\F[]\&.
     1806.sp
     1807In order to successfully execute the
    14021808\fIchange share command\fR,
    1403 smbd
    1404 requires that the administrator be connected using a root account (i\.e\. uid == 0)\.
    1405 .sp
    1406 If the connected account has
    1407 SeDiskOperatorPrivilege, scripts defined in
    1408 \fIchange share\fR
    1409 parameter are executed as root\.
     1809\FCsmbd\F[]
     1810requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
     1811\FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
     1812\fIchange share command\fR
     1813parameter are executed as root\&.
    14101814.sp
    14111815When executed,
    1412 smbd
     1816\FCsmbd\F[]
    14131817will automatically invoke the
    14141818\fIchange share command\fR
    1415 with five parameters\.
     1819with five parameters\&.
    14161820.sp
    14171821.RS 4
     
    14251829\fIconfigFile\fR
    14261830\- the location of the global
    1427 \fIsmb\.conf\fR
    1428 file\.
     1831\FCsmb\&.conf\F[]
     1832file\&.
    14291833.RE
    14301834.sp
     
    14381842.\}
    14391843\fIshareName\fR
    1440 \- the name of the new share\.
     1844\- the name of the new share\&.
    14411845.RE
    14421846.sp
     
    14501854.\}
    14511855\fIpathName\fR
    1452 \- path to an **existing** directory on disk\.
     1856\- path to an **existing** directory on disk\&.
    14531857.RE
    14541858.sp
     
    14621866.\}
    14631867\fIcomment\fR
    1464 \- comment string to associate with the new share\.
     1868\- comment string to associate with the new share\&.
    14651869.RE
    14661870.sp
     
    14741878.\}
    14751879\fImax connections\fR
    1476 Number of maximum simultaneous connections to this share\.
    1477 .sp
    1478 .RE
    1479 This parameter is only used modify existing file shares definitions\. To modify printer shares, use the "Printers\.\.\." folder as seen when browsing the Samba host\.
    1480 .sp
    1481 Default:
    1482 \fI\fIchange share command\fR\fR\fI = \fR\fI\fR\fI \fR
    1483 .sp
    1484 Example:
    1485 \fI\fIchange share command\fR\fR\fI = \fR\fI/usr/local/bin/addshare\fR\fI \fR
     1880Number of maximum simultaneous connections to this share\&.
     1881.sp
     1882.RE
     1883This 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\&.
     1884.sp
     1885Default:
     1886\fI\fIchange share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1887.sp
     1888Example:
     1889\fI\fIchange share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/changeshare\F[]\fR\fI \fR
    14861890.RE
    14871891
    14881892check password script (G)
    1489 .PP
    1490 .RS 4
    1491 The name of a program that can be used to check password complexity\. The password is sent to the program\'s standrad input\.
    1492 .sp
    1493 The program must return 0 on good password any other value otherwise\. In case the password is considered weak (the program do not return 0) the user will be notified and the password change will fail\.
    1494 .sp
    1495 Note: In the example directory there is a sample program called crackcheck that uses cracklib to checkpassword quality\.
    1496 .sp
    1497 Default:
    1498 \fI\fIcheck password script\fR\fR\fI = \fR\fIDisabled\fR\fI \fR
    1499 .sp
    1500 Example:
    1501 \fI\fIcheck password script\fR\fR\fI = \fR\fIcheck password script = /usr/local/sbin/crackcheck\fR\fI \fR
     1893.\" check password script
     1894.PP
     1895.RS 4
     1896The name of a program that can be used to check password complexity\&. The password is sent to the program\'s standrad input\&.
     1897.sp
     1898The program must return 0 on good password any other value otherwise\&. In case the password is considered weak (the program do not return 0) the user will be notified and the password change will fail\&.
     1899.sp
     1900Note: In the example directory there is a sample program called crackcheck that uses cracklib to checkpassword quality\&.
     1901.sp
     1902Default:
     1903\fI\fIcheck password script\fR\fR\fI = \fR\fI\FCDisabled\F[]\fR\fI \fR
     1904.sp
     1905Example:
     1906\fI\fIcheck password script\fR\fR\fI = \fR\fI\FCcheck password script = /usr/local/sbin/crackcheck\F[]\fR\fI \fR
    15021907.RE
    15031908
    15041909client lanman auth (G)
     1910.\" client lanman auth
    15051911.PP
    15061912.RS 4
    15071913This parameter determines whether or not
    15081914\fBsmbclient\fR(8)
    1509 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\.
    1510 .sp
    1511 The LANMAN encrypted response is easily broken, due to it\'s case\-insensitive nature, and the choice of algorithm\. Clients without Windows 95/98 servers are advised to disable this option\.
     1915and 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\&.
     1916.sp
     1917The LANMAN encrypted response is easily broken, due to it\'s case\-insensitive nature, and the choice of algorithm\&. Clients without Windows 95/98 servers are advised to disable this option\&.
    15121918.sp
    15131919Disabling this option will also disable the
    1514 client plaintext auth
     1920\FCclient plaintext auth\F[]
    15151921option
    15161922.sp
    15171923Likewise, if the
    1518 client ntlmv2 auth
    1519 parameter is enabled, then only NTLMv2 logins will be attempted\.
    1520 .sp
    1521 Default:
    1522 \fI\fIclient lanman auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1924\FCclient ntlmv2 auth\F[]
     1925parameter is enabled, then only NTLMv2 logins will be attempted\&.
     1926.sp
     1927Default:
     1928\fI\fIclient lanman auth\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    15231929.RE
    15241930
    15251931client ntlmv2 auth (G)
     1932.\" client ntlmv2 auth
    15261933.PP
    15271934.RS 4
    15281935This parameter determines whether or not
    15291936\fBsmbclient\fR(8)
    1530 will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\.
    1531 .sp
    1532 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\.
     1937will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\&.
     1938.sp
     1939If 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\&.
    15331940.sp
    15341941Similarly, if enabled, NTLMv1,
    1535 client lanman auth
     1942\FCclient lanman auth\F[]
    15361943and
    1537 client plaintext auth
    1538 authentication will be disabled\. This also disables share\-level authentication\.
     1944\FCclient plaintext auth\F[]
     1945authentication will be disabled\&. This also disables share\-level authentication\&.
    15391946.sp
    15401947If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of
    1541 client lanman auth\.
    1542 .sp
    1543 Note that some sites (particularly those following \'best practice\' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM\.
    1544 .sp
    1545 Default:
    1546 \fI\fIclient ntlmv2 auth\fR\fR\fI = \fR\fIno\fR\fI \fR
     1948\FCclient lanman auth\F[]\&.
     1949.sp
     1950Note that some sites (particularly those following \'best practice\' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM\&.
     1951.sp
     1952Default:
     1953\fI\fIclient ntlmv2 auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    15471954.RE
    15481955
    15491956client plaintext auth (G)
    1550 .PP
    1551 .RS 4
    1552 Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\.
    1553 .sp
    1554 Default:
    1555 \fI\fIclient plaintext auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1957.\" client plaintext auth
     1958.PP
     1959.RS 4
     1960Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\&.
     1961.sp
     1962Default:
     1963\fI\fIclient plaintext auth\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    15561964.RE
    15571965
    15581966client schannel (G)
    1559 .PP
    1560 .RS 4
    1561 This controls whether the client offers or even demands the use of the netlogon schannel\.
    1562 \fIclient schannel = no\fR
     1967.\" client schannel
     1968.PP
     1969.RS 4
     1970This controls whether the client offers or even demands the use of the netlogon schannel\&.
     1971\m[blue]\fBclient schannel = no\fR\m[]
    15631972does not offer the schannel,
    1564 \fIclient schannel = auto\fR
     1973\m[blue]\fBclient schannel = auto\fR\m[]
    15651974offers the schannel but does not enforce it, and
    1566 \fIclient schannel = yes\fR
    1567 denies access if the server is not able to speak netlogon schannel\.
    1568 .sp
    1569 Default:
    1570 \fI\fIclient schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR
    1571 .sp
    1572 Example:
    1573 \fI\fIclient schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1975\m[blue]\fBclient schannel = yes\fR\m[]
     1976denies access if the server is not able to speak netlogon schannel\&.
     1977.sp
     1978Default:
     1979\fI\fIclient schannel\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
     1980.sp
     1981Example:
     1982\fI\fIclient schannel\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    15741983.RE
    15751984
    15761985client signing (G)
    1577 .PP
    1578 .RS 4
    1579 This controls whether the client offers or requires the server it talks to to use SMB signing\. Possible values are
     1986.\" client signing
     1987.PP
     1988.RS 4
     1989This controls whether the client offers or requires the server it talks to to use SMB signing\&. Possible values are
    15801990\fIauto\fR,
    15811991\fImandatory\fR
    15821992and
    1583 \fIdisabled\fR\.
    1584 .sp
    1585 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\.
    1586 .sp
    1587 Default:
    1588 \fI\fIclient signing\fR\fR\fI = \fR\fIauto\fR\fI \fR
     1993\fIdisabled\fR\&.
     1994.sp
     1995When 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\&.
     1996.sp
     1997Default:
     1998\fI\fIclient signing\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
    15891999.RE
    15902000
    15912001client use spnego (G)
    1592 .PP
    1593 .RS 4
    1594 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\.
    1595 .sp
    1596 Default:
    1597 \fI\fIclient use spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2002.\" client use spnego
     2003.PP
     2004.RS 4
     2005This 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\&.
     2006.sp
     2007Default:
     2008\fI\fIclient use spnego\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    15982009.RE
    15992010
    16002011comment (S)
     2012.\" comment
    16012013.PP
    16022014.RS 4
    16032015This 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
    1604 net view
    1605 to list what shares are available\.
     2016\FCnet view\F[]
     2017to list what shares are available\&.
    16062018.sp
    16072019If you want to set the string that is displayed next to the machine name then see the
    1608 \fIserver string\fR
    1609 parameter\.
    1610 .sp
    1611 Default:
    1612 \fI\fIcomment\fR\fR\fI = \fR\fI # No comment\fR\fI \fR
    1613 .sp
    1614 Example:
    1615 \fI\fIcomment\fR\fR\fI = \fR\fIFred\'s Files\fR\fI \fR
     2020\m[blue]\fBserver string\fR\m[]
     2021parameter\&.
     2022.sp
     2023Default:
     2024\fI\fIcomment\fR\fR\fI = \fR\fI\FC # No comment\F[]\fR\fI \fR
     2025.sp
     2026Example:
     2027\fI\fIcomment\fR\fR\fI = \fR\fI\FCFred\'s Files\F[]\fR\fI \fR
    16162028.RE
    16172029
    16182030config file (G)
     2031.\" config file
    16192032.PP
    16202033.RS 4
    16212034This allows you to override the config file to use, instead of the default (usually
    1622 \fIsmb\.conf\fR)\. There is a chicken and egg problem here as this option is set in the config file!
    1623 .sp
    1624 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\.
    1625 .sp
    1626 This option takes the usual substitutions, which can be very useful\.
    1627 .sp
    1628 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)\.
     2035\FCsmb\&.conf\F[])\&. There is a chicken and egg problem here as this option is set in the config file!
     2036.sp
     2037For 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\&.
     2038.sp
     2039This option takes the usual substitutions, which can be very useful\&.
     2040.sp
     2041If 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)\&.
    16292042.sp
    16302043\fINo default\fR
    16312044.sp
    16322045Example:
    1633 \fI\fIconfig file\fR\fR\fI = \fR\fI/usr/local/samba/lib/smb\.conf\.%m\fR\fI \fR
     2046\fI\fIconfig file\fR\fR\fI = \fR\fI\FC/usr/local/samba/lib/smb\&.conf\&.%m\F[]\fR\fI \fR
    16342047.RE
    16352048
    16362049copy (S)
    1637 .PP
    1638 .RS 4
    1639 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\.
    1640 .sp
    1641 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\.
    1642 .sp
    1643 Default:
    1644 \fI\fIcopy\fR\fR\fI = \fR\fI\fR\fI \fR
    1645 .sp
    1646 Example:
    1647 \fI\fIcopy\fR\fR\fI = \fR\fIotherservice\fR\fI \fR
     2050.\" copy
     2051.PP
     2052.RS 4
     2053This 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\&.
     2054.sp
     2055This 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\&.
     2056.sp
     2057Default:
     2058\fI\fIcopy\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2059.sp
     2060Example:
     2061\fI\fIcopy\fR\fR\fI = \fR\fI\FCotherservice\F[]\fR\fI \fR
    16482062.RE
    16492063
    16502064create mode
     2065.\" create mode
    16512066.PP
    16522067.RS 4
    16532068This parameter is a synonym for
    1654 create mask\.
     2069create mask\&.
    16552070.RE
    16562071
    16572072create mask (S)
    1658 .PP
    1659 .RS 4
    1660 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
     2073.\" create mask
     2074.PP
     2075.RS 4
     2076When 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
    16612077\fInot\fR
    1662 set here will be removed from the modes set on a file when it is created\.
     2078set here will be removed from the modes set on a file when it is created\&.
    16632079.sp
    16642080The default value of this parameter removes the
    1665 group
     2081\FCgroup\F[]
    16662082and
    1667 other
    1668 write and execute bits from the UNIX modes\.
     2083\FCother\F[]
     2084write and execute bits from the UNIX modes\&.
    16692085.sp
    16702086Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the
    1671 \fIforce create mode\fR
    1672 parameter which is set to 000 by default\.
    1673 .sp
    1674 This parameter does not affect directory masks\. See the parameter
    1675 \fIdirectory mask\fR
    1676 for details\.
    1677 .sp
    1678 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
    1679 \fIsecurity mask\fR\.
    1680 .sp
    1681 Default:
    1682 \fI\fIcreate mask\fR\fR\fI = \fR\fI0744\fR\fI \fR
    1683 .sp
    1684 Example:
    1685 \fI\fIcreate mask\fR\fR\fI = \fR\fI0775\fR\fI \fR
     2087\m[blue]\fBforce create mode\fR\m[]
     2088parameter which is set to 000 by default\&.
     2089.sp
     2090This parameter does not affect directory masks\&. See the parameter
     2091\m[blue]\fBdirectory mask\fR\m[]
     2092for details\&.
     2093.sp
     2094Note 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
     2095\m[blue]\fBsecurity mask\fR\m[]\&.
     2096.sp
     2097Default:
     2098\fI\fIcreate mask\fR\fR\fI = \fR\fI\FC0744\F[]\fR\fI \fR
     2099.sp
     2100Example:
     2101\fI\fIcreate mask\fR\fR\fI = \fR\fI\FC0775\F[]\fR\fI \fR
    16862102.RE
    16872103
    16882104csc policy (S)
     2105.\" csc policy
    16892106.PP
    16902107.RS 4
    16912108This stands for
    1692 \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\.
    1693 .sp
    1694 These values correspond to those used on Windows servers\.
     2109\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\&.
     2110.sp
     2111These values correspond to those used on Windows servers\&.
    16952112.sp
    16962113For example, shares containing roaming profiles can have offline caching disabled using
    1697 \fIcsc policy = disable\fR\.
    1698 .sp
    1699 Default:
    1700 \fI\fIcsc policy\fR\fR\fI = \fR\fImanual\fR\fI \fR
    1701 .sp
    1702 Example:
    1703 \fI\fIcsc policy\fR\fR\fI = \fR\fIprograms\fR\fI \fR
     2114\m[blue]\fBcsc policy = disable\fR\m[]\&.
     2115.sp
     2116Default:
     2117\fI\fIcsc policy\fR\fR\fI = \fR\fI\FCmanual\F[]\fR\fI \fR
     2118.sp
     2119Example:
     2120\fI\fIcsc policy\fR\fR\fI = \fR\fI\FCprograms\F[]\fR\fI \fR
    17042121.RE
    17052122
    17062123cups options (S)
     2124.\" cups options
    17072125.PP
    17082126.RS 4
    17092127This parameter is only applicable if
    1710 \fIprinting\fR
     2128\m[blue]\fBprinting\fR\m[]
    17112129is set to
    1712 \fBcups\fR\. Its value is a free form string of options passed directly to the cups library\.
    1713 .sp
    1714 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\.
     2130\fBcups\fR\&. Its value is a free form string of options passed directly to the cups library\&.
     2131.sp
     2132You 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\&.
    17152133.sp
    17162134You should set this parameter to
    17172135\fBraw\fR
    17182136if your CUPS server
    1719 \fIerror_log\fR
    1720 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
    1721 \fI/etc/cups/mime\.{convs,types}\fR\.
    1722 .sp
    1723 Default:
    1724 \fI\fIcups options\fR\fR\fI = \fR\fI""\fR\fI \fR
    1725 .sp
    1726 Example:
    1727 \fI\fIcups options\fR\fR\fI = \fR\fI"raw media=a4"\fR\fI \fR
     2137\FCerror_log\F[]
     2138file 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
     2139\FC/etc/cups/mime\&.{convs,types}\F[]\&.
     2140.sp
     2141Default:
     2142\fI\fIcups options\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
     2143.sp
     2144Example:
     2145\fI\fIcups options\fR\fR\fI = \fR\fI\FC"raw media=a4"\F[]\fR\fI \fR
    17282146.RE
    17292147
    17302148cups server (G)
     2149.\" cups server
    17312150.PP
    17322151.RS 4
    17332152This parameter is only applicable if
    1734 \fIprinting\fR
     2153\m[blue]\fBprinting\fR\m[]
    17352154is set to
    1736 \fBcups\fR\.
     2155\fBcups\fR\&.
    17372156.sp
    17382157If set, this option overrides the ServerName option in the CUPS
    1739 \fIclient\.conf\fR\. This is necessary if you have virtual samba servers that connect to different CUPS daemons\.
    1740 .sp
    1741 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\.
    1742 .sp
    1743 Default:
    1744 \fI\fIcups server\fR\fR\fI = \fR\fI""\fR\fI \fR
    1745 .sp
    1746 Example:
    1747 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver\fR\fI \fR
    1748 .sp
    1749 Example:
    1750 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver:1631\fR\fI \fR
     2158\FCclient\&.conf\F[]\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
     2159.sp
     2160Optionally, 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\&.
     2161.sp
     2162Default:
     2163\fI\fIcups server\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
     2164.sp
     2165Example:
     2166\fI\fIcups server\fR\fR\fI = \fR\fI\FCmycupsserver\F[]\fR\fI \fR
     2167.sp
     2168Example:
     2169\fI\fIcups server\fR\fR\fI = \fR\fI\FCmycupsserver:1631\F[]\fR\fI \fR
    17512170.RE
    17522171
    17532172deadtime (G)
    1754 .PP
    1755 .RS 4
    1756 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\.
    1757 .sp
    1758 This is useful to stop a server\'s resources being exhausted by a large number of inactive connections\.
    1759 .sp
    1760 Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\.
    1761 .sp
    1762 Using this parameter with a timeout of a few minutes is recommended for most systems\.
    1763 .sp
    1764 A deadtime of zero indicates that no auto\-disconnection should be performed\.
    1765 .sp
    1766 Default:
    1767 \fI\fIdeadtime\fR\fR\fI = \fR\fI0\fR\fI \fR
    1768 .sp
    1769 Example:
    1770 \fI\fIdeadtime\fR\fR\fI = \fR\fI15\fR\fI \fR
     2173.\" deadtime
     2174.PP
     2175.RS 4
     2176The 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\&.
     2177.sp
     2178This is useful to stop a server\'s resources being exhausted by a large number of inactive connections\&.
     2179.sp
     2180Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\&.
     2181.sp
     2182Using this parameter with a timeout of a few minutes is recommended for most systems\&.
     2183.sp
     2184A deadtime of zero indicates that no auto\-disconnection should be performed\&.
     2185.sp
     2186Default:
     2187\fI\fIdeadtime\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     2188.sp
     2189Example:
     2190\fI\fIdeadtime\fR\fR\fI = \fR\fI\FC15\F[]\fR\fI \fR
    17712191.RE
    17722192
    17732193debug hires timestamp (G)
    1774 .PP
    1775 .RS 4
    1776 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\.
     2194.\" debug hires timestamp
     2195.PP
     2196.RS 4
     2197Sometimes 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\&.
    17772198.sp
    17782199Note that the parameter
    1779 \fIdebug timestamp\fR
    1780 must be on for this to have an effect\.
    1781 .sp
    1782 Default:
    1783 \fI\fIdebug hires timestamp\fR\fR\fI = \fR\fIno\fR\fI \fR
     2200\m[blue]\fBdebug timestamp\fR\m[]
     2201must be on for this to have an effect\&.
     2202.sp
     2203Default:
     2204\fI\fIdebug hires timestamp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    17842205.RE
    17852206
    17862207debug pid (G)
     2208.\" debug pid
    17872209.PP
    17882210.RS 4
    17892211When using only one log file for more then one forked
    1790 \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\.
     2212\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\&.
    17912213.sp
    17922214Note that the parameter
    1793 \fIdebug timestamp\fR
    1794 must be on for this to have an effect\.
    1795 .sp
    1796 Default:
    1797 \fI\fIdebug pid\fR\fR\fI = \fR\fIno\fR\fI \fR
     2215\m[blue]\fBdebug timestamp\fR\m[]
     2216must be on for this to have an effect\&.
     2217.sp
     2218Default:
     2219\fI\fIdebug pid\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    17982220.RE
    17992221
    18002222debug prefix timestamp (G)
     2223.\" debug prefix timestamp
    18012224.PP
    18022225.RS 4
    18032226With this option enabled, the timestamp message header is prefixed to the debug message without the filename and function information that is included with the
    1804 \fIdebug timestamp\fR
    1805 parameter\. This gives timestamps to the messages without adding an additional line\.
     2227\m[blue]\fBdebug timestamp\fR\m[]
     2228parameter\&. This gives timestamps to the messages without adding an additional line\&.
    18062229.sp
    18072230Note that this parameter overrides the
    1808 \fIdebug timestamp\fR
    1809 parameter\.
    1810 .sp
    1811 Default:
    1812 \fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fIno\fR\fI \fR
     2231\m[blue]\fBdebug timestamp\fR\m[]
     2232parameter\&.
     2233.sp
     2234Default:
     2235\fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    18132236.RE
    18142237
    18152238timestamp logs
     2239.\" timestamp logs
    18162240.PP
    18172241.RS 4
    18182242This parameter is a synonym for
    1819 debug timestamp\.
     2243debug timestamp\&.
    18202244.RE
    18212245
    18222246debug timestamp (G)
    1823 .PP
    1824 .RS 4
    1825 Samba debug log messages are timestamped by default\. If you are running at a high
    1826 \fIdebug level\fR
    1827 these timestamps can be distracting\. This boolean parameter allows timestamping to be turned off\.
    1828 .sp
    1829 Default:
    1830 \fI\fIdebug timestamp\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2247.\" debug timestamp
     2248.PP
     2249.RS 4
     2250Samba debug log messages are timestamped by default\&. If you are running at a high
     2251\m[blue]\fBdebug level\fR\m[]
     2252these timestamps can be distracting\&. This boolean parameter allows timestamping to be turned off\&.
     2253.sp
     2254Default:
     2255\fI\fIdebug timestamp\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    18312256.RE
    18322257
    18332258debug uid (G)
    1834 .PP
    1835 .RS 4
    1836 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\.
     2259.\" debug uid
     2260.PP
     2261.RS 4
     2262Samba 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\&.
    18372263.sp
    18382264Note that the parameter
    1839 \fIdebug timestamp\fR
    1840 must be on for this to have an effect\.
    1841 .sp
    1842 Default:
    1843 \fI\fIdebug uid\fR\fR\fI = \fR\fIno\fR\fI \fR
     2265\m[blue]\fBdebug timestamp\fR\m[]
     2266must be on for this to have an effect\&.
     2267.sp
     2268Default:
     2269\fI\fIdebug uid\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    18442270.RE
    18452271
    18462272default case (S)
     2273.\" default case
    18472274.PP
    18482275.RS 4
    18492276See the section on
    1850 \fIname mangling\fR\. Also note the
    1851 \fIshort preserve case\fR
    1852 parameter\.
    1853 .sp
    1854 Default:
    1855 \fI\fIdefault case\fR\fR\fI = \fR\fIlower\fR\fI \fR
     2277\m[blue]\fBname mangling\fR\m[]\&. Also note the
     2278\m[blue]\fBshort preserve case\fR\m[]
     2279parameter\&.
     2280.sp
     2281Default:
     2282\fI\fIdefault case\fR\fR\fI = \fR\fI\FClower\F[]\fR\fI \fR
    18562283.RE
    18572284
    18582285default devmode (S)
     2286.\" default devmode
    18592287.PP
    18602288.RS 4
    18612289This parameter is only applicable to
    1862 \fIprintable\fR
    1863 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\.
    1864 .sp
    1865 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)\.
    1866 .sp
    1867 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
    1868 default devmode = yes
    1869 will instruct smbd to generate a default one\.
     2290\m[blue]\fBprintable\fR\m[]
     2291services\&. 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\&.
     2292.sp
     2293Most 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)\&.
     2294.sp
     2295This 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
     2296\FCdefault devmode = yes\F[]
     2297will instruct smbd to generate a default one\&.
    18702298.sp
    18712299For more information on Windows NT/2k printing and Device Modes, see the
    1872 MSDN documentation\.
    1873 .sp
    1874 Default:
    1875 \fI\fIdefault devmode\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2300MSDN documentation\&.
     2301.sp
     2302Default:
     2303\fI\fIdefault devmode\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    18762304.RE
    18772305
    18782306default
     2307.\" default
    18792308.PP
    18802309.RS 4
    18812310This parameter is a synonym for
    1882 default service\.
     2311default service\&.
    18832312.RE
    18842313
    18852314default service (G)
    1886 .PP
    1887 .RS 4
    1888 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
     2315.\" default service
     2316.PP
     2317.RS 4
     2318This 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
    18892319\fINOT\fR
    1890 given in the parameter value (see example below)\.
    1891 .sp
    1892 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\.
     2320given in the parameter value (see example below)\&.
     2321.sp
     2322There is no default value for this parameter\&. If this parameter is not given, attempting to connect to a nonexistent service results in an error\&.
    18932323.sp
    18942324Typically the default service would be a
    1895 \fIguest ok\fR,
    1896 \fIread\-only\fR
    1897 service\.
     2325\m[blue]\fBguest ok\fR\m[],
     2326\m[blue]\fBread\-only\fR\m[]
     2327service\&.
    18982328.sp
    18992329Also 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
    19002330\fI%S\fR
    1901 to make a wildcard service\.
    1902 .sp
    1903 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\.
    1904 .sp
    1905 Default:
    1906 \fI\fIdefault service\fR\fR\fI = \fR\fI\fR\fI \fR
    1907 .sp
    1908 Example:
    1909 \fI\fIdefault service\fR\fR\fI = \fR\fIpub\fR\fI \fR
     2331to make a wildcard service\&.
     2332.sp
     2333Note 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\&.
     2334.sp
     2335Default:
     2336\fI\fIdefault service\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2337.sp
     2338Example:
     2339\fI\fIdefault service\fR\fR\fI = \fR\fI\FCpub\F[]\fR\fI \fR
    19102340.RE
    19112341
    19122342defer sharing violations (G)
    1913 .PP
    1914 .RS 4
    1915 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\.
    1916 .sp
    1917 UNIX by default does not have this behaviour\.
    1918 .sp
    1919 There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\.
    1920 .sp
    1921 Default:
    1922 \fI\fIdefer sharing violations\fR\fR\fI = \fR\fITrue\fR\fI \fR
     2343.\" defer sharing violations
     2344.PP
     2345.RS 4
     2346Windows 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\&.
     2347.sp
     2348UNIX by default does not have this behaviour\&.
     2349.sp
     2350There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\&.
     2351.sp
     2352Default:
     2353\fI\fIdefer sharing violations\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
    19232354.RE
    19242355
    19252356delete group script (G)
     2357.\" delete group script
    19262358.PP
    19272359.RS 4
     
    19292361\fIAS ROOT\fR
    19302362\fBsmbd\fR(8)
    1931 when a group is requested to be deleted\. It will expand any
     2363when a group is requested to be deleted\&. It will expand any
    19322364\fI%g\fR
    1933 to the group name passed\. This script is only useful for installations using the Windows NT domain administration tools\.
    1934 .sp
    1935 Default:
    1936 \fI\fIdelete group script\fR\fR\fI = \fR\fI\fR\fI \fR
     2365to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&.
     2366.sp
     2367Default:
     2368\fI\fIdelete group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    19372369.RE
    19382370
    19392371deleteprinter command (G)
    1940 .PP
    1941 .RS 4
    1942 With the introduction of MS\-RPC based printer support for Windows NT/2000 clients in Samba 2\.2, it is now possible to delete printer at run time by issuing the DeletePrinter() RPC call\.
    1943 .sp
    1944 For a Samba host this means that the printer must be physically deleted from underlying printing system\. The
    1945 \fIdeleteprinter command\fR
     2372.\" deleteprinter command
     2373.PP
     2374.RS 4
     2375With the introduction of MS\-RPC based printer support for Windows NT/2000 clients in Samba 2\&.2, it is now possible to delete printer at run time by issuing the DeletePrinter() RPC call\&.
     2376.sp
     2377For a Samba host this means that the printer must be physically deleted from underlying printing system\&. The
     2378\m[blue]\fBdeleteprinter command\fR\m[]
    19462379defines a script to be run which will perform the necessary operations for removing the printer from the print system and from
    1947 \fIsmb\.conf\fR\.
     2380\FCsmb\&.conf\F[]\&.
    19482381.sp
    19492382The
    1950 \fIdeleteprinter command\fR
     2383\m[blue]\fBdeleteprinter command\fR\m[]
    19512384is automatically called with only one parameter:
    1952 \fIprinter name\fR\.
     2385\m[blue]\fBprinter name\fR\m[]\&.
    19532386.sp
    19542387Once the
    1955 \fIdeleteprinter command\fR
     2388\m[blue]\fBdeleteprinter command\fR\m[]
    19562389has been executed,
    1957 smbd
     2390\FCsmbd\F[]
    19582391will reparse the
    1959 \fI smb\.conf\fR
    1960 to associated printer no longer exists\. If the sharename is still valid, then
    1961 smbd
    1962 will return an ACCESS_DENIED error to the client\.
    1963 .sp
    1964 Default:
    1965 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\fR\fI \fR
    1966 .sp
    1967 Example:
    1968 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI/usr/bin/removeprinter\fR\fI \fR
     2392\FC smb\&.conf\F[]
     2393to associated printer no longer exists\&. If the sharename is still valid, then
     2394\FCsmbd \F[]
     2395will return an ACCESS_DENIED error to the client\&.
     2396.sp
     2397Default:
     2398\fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2399.sp
     2400Example:
     2401\fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\FC/usr/bin/removeprinter\F[]\fR\fI \fR
    19692402.RE
    19702403
    19712404delete readonly (S)
    1972 .PP
    1973 .RS 4
    1974 This parameter allows readonly files to be deleted\. This is not normal DOS semantics, but is allowed by UNIX\.
    1975 .sp
    1976 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\.
    1977 .sp
    1978 Default:
    1979 \fI\fIdelete readonly\fR\fR\fI = \fR\fIno\fR\fI \fR
     2405.\" delete readonly
     2406.PP
     2407.RS 4
     2408This parameter allows readonly files to be deleted\&. This is not normal DOS semantics, but is allowed by UNIX\&.
     2409.sp
     2410This 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\&.
     2411.sp
     2412Default:
     2413\fI\fIdelete readonly\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    19802414.RE
    19812415
    19822416delete share command (G)
    1983 .PP
    1984 .RS 4
    1985 Samba 2\.2\.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\.0 Server Manager\. The
     2417.\" delete share command
     2418.PP
     2419.RS 4
     2420Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
    19862421\fIdelete share command\fR
    19872422is used to define an external program or script which will remove an existing service definition from
    1988 \fIsmb\.conf\fR\. In order to successfully execute the
     2423\FCsmb\&.conf\F[]\&.
     2424.sp
     2425In order to successfully execute the
    19892426\fIdelete share command\fR,
    1990 smbd
    1991 requires that the administrator be connected using a root account (i\.e\. uid == 0)\.
    1992 .sp
    1993 If the connected account has
    1994 SeDiskOperatorPrivilege, scripts defined in
    1995 \fIchange share\fR
    1996 parameter are executed as root\.
     2427\FCsmbd\F[]
     2428requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
     2429\FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
     2430\fIdelete share command\fR
     2431parameter are executed as root\&.
    19972432.sp
    19982433When executed,
    1999 smbd
     2434\FCsmbd\F[]
    20002435will automatically invoke the
    20012436\fIdelete share command\fR
    2002 with two parameters\.
     2437with two parameters\&.
    20032438.sp
    20042439.RS 4
     
    20122447\fIconfigFile\fR
    20132448\- the location of the global
    2014 \fIsmb\.conf\fR
    2015 file\.
     2449\FCsmb\&.conf\F[]
     2450file\&.
    20162451.RE
    20172452.sp
     
    20252460.\}
    20262461\fIshareName\fR
    2027 \- the name of the existing service\.
    2028 .sp
    2029 .RE
    2030 This parameter is only used to remove file shares\. To delete printer shares, see the
    2031 \fIdeleteprinter command\fR\.
    2032 .sp
    2033 Default:
    2034 \fI\fIdelete share command\fR\fR\fI = \fR\fI\fR\fI \fR
    2035 .sp
    2036 Example:
    2037 \fI\fIdelete share command\fR\fR\fI = \fR\fI/usr/local/bin/delshare\fR\fI \fR
     2462\- the name of the existing service\&.
     2463.sp
     2464.RE
     2465This parameter is only used to remove file shares\&. To delete printer shares, see the
     2466\m[blue]\fBdeleteprinter command\fR\m[]\&.
     2467.sp
     2468Default:
     2469\fI\fIdelete share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2470.sp
     2471Example:
     2472\fI\fIdelete share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/delshare\F[]\fR\fI \fR
    20382473.RE
    20392474
    20402475delete user from group script (G)
    2041 .PP
    2042 .RS 4
    2043 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
     2476.\" delete user from group script
     2477.PP
     2478.RS 4
     2479Full 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
    20442480\fBsmbd\fR(8)
    2045 \fIAS ROOT\fR\. Any
     2481\fIAS ROOT\fR\&. Any
    20462482\fI%g\fR
    20472483will be replaced with the group name and any
    20482484\fI%u\fR
    2049 will be replaced with the user name\.
    2050 .sp
    2051 Default:
    2052 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI\fR\fI \fR
    2053 .sp
    2054 Example:
    2055 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI/usr/sbin/deluser %u %g\fR\fI \fR
     2485will be replaced with the user name\&.
     2486.sp
     2487Default:
     2488\fI\fIdelete user from group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2489.sp
     2490Example:
     2491\fI\fIdelete user from group script\fR\fR\fI = \fR\fI\FC/usr/sbin/deluser %u %g\F[]\fR\fI \fR
    20562492.RE
    20572493
    20582494delete user script (G)
     2495.\" delete user script
    20592496.PP
    20602497.RS 4
    20612498This is the full pathname to a script that will be run by
    20622499\fBsmbd\fR(8)
    2063 when managing users with remote RPC (NT) tools\.
     2500when managing users with remote RPC (NT) tools\&.
    20642501.sp
    20652502This script is called when a remote client removes a user from the server, normally using \'User Manager for Domains\' or
    2066 rpcclient\.
    2067 .sp
    2068 This script should delete the given UNIX username\.
    2069 .sp
    2070 Default:
    2071 \fI\fIdelete user script\fR\fR\fI = \fR\fI\fR\fI \fR
    2072 .sp
    2073 Example:
    2074 \fI\fIdelete user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/del_user %u\fR\fI \fR
     2503\FCrpcclient\F[]\&.
     2504.sp
     2505This script should delete the given UNIX username\&.
     2506.sp
     2507Default:
     2508\fI\fIdelete user script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2509.sp
     2510Example:
     2511\fI\fIdelete user script\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/del_user %u\F[]\fR\fI \fR
    20752512.RE
    20762513
    20772514delete veto files (S)
     2515.\" delete veto files
    20782516.PP
    20792517.RS 4
    20802518This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories (see the
    2081 \fIveto files\fR
    2082 option)\. If this option is set to
     2519\m[blue]\fBveto files\fR\m[]
     2520option)\&. If this option is set to
    20832521\fBno\fR
    2084 (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\.
     2522(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\&.
    20852523.sp
    20862524If this option is set to
    2087 \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\.
    2088 \fI\.AppleDouble\fR)
     2525\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\&.
     2526\FC\&.AppleDouble\F[])
    20892527.sp
    20902528Setting
    2091 \fIdelete veto files = yes\fR
    2092 allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\.
    2093 .sp
    2094 Default:
    2095 \fI\fIdelete veto files\fR\fR\fI = \fR\fIno\fR\fI \fR
     2529\m[blue]\fBdelete veto files = yes\fR\m[]
     2530allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\&.
     2531.sp
     2532Default:
     2533\fI\fIdelete veto files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    20962534.RE
    20972535
    20982536dfree cache time (S)
     2537.\" dfree cache time
    20992538.PP
    21002539.RS 4
    21012540The
    21022541\fIdfree cache time\fR
    2103 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\.
    2104 .sp
    2105 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
    2106 \fIdfree command\fR
    2107 scripts increasing the load\.
    2108 .sp
    2109 By default this parameter is zero, meaning no caching will be done\.
     2542should 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\&.
     2543.sp
     2544This 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
     2545\m[blue]\fBdfree command\fR\m[]
     2546scripts increasing the load\&.
     2547.sp
     2548By default this parameter is zero, meaning no caching will be done\&.
    21102549.sp
    21112550\fINo default\fR
    21122551.sp
    21132552Example:
    2114 \fI\fIdfree cache time\fR\fR\fI = \fR\fIdfree cache time = 60\fR\fI \fR
     2553\fI\fIdfree cache time\fR\fR\fI = \fR\fI\FCdfree cache time = 60\F[]\fR\fI \fR
    21152554.RE
    21162555
    21172556dfree command (S)
     2557.\" dfree command
    21182558.PP
    21192559.RS 4
    21202560The
    21212561\fIdfree command\fR
    2122 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\.
    2123 .sp
    2124 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\.
    2125 .sp
    2126 In Samba version 3\.0\.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter
    2127 \fIdfree cache time\fR
    2128 was added to allow the output of this script to be cached for systems under heavy load\.
    2129 .sp
    2130 The external program will be passed a single parameter indicating a directory in the filesystem being queried\. This will typically consist of the string
    2131 \fI\./\fR\. 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\.
     2562setting 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\&.
     2563.sp
     2564This 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\&.
     2565.sp
     2566In Samba version 3\&.0\&.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter
     2567\m[blue]\fBdfree cache time\fR\m[]
     2568was added to allow the output of this script to be cached for systems under heavy load\&.
     2569.sp
     2570The external program will be passed a single parameter indicating a directory in the filesystem being queried\&. This will typically consist of the string
     2571\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\&.
    21322572.sp
    21332573Note: Your script should
     
    21372577Where the script dfree (which must be made executable) could be:
    21382578.sp
    2139 .RS 4
     2579.if n \{\
     2580.RS 4
     2581.\}
     2582.fam C
     2583.ps -1
    21402584.nf
     2585.BB lightgray
    21412586 
    21422587#!/bin/sh
    21432588df $1 | tail \-1 | awk \'{print $(NF\-4),$(NF\-2)}\'
     2589.EB lightgray
    21442590.fi
    2145 .RE
     2591.fam
     2592.ps +1
     2593.if n \{\
     2594.RE
     2595.\}
    21462596.sp
    21472597or perhaps (on Sys V based systems):
    21482598.sp
    2149 .RS 4
     2599.if n \{\
     2600.RS 4
     2601.\}
     2602.fam C
     2603.ps -1
    21502604.nf
     2605.BB lightgray
    21512606 
    21522607#!/bin/sh
    21532608/usr/bin/df \-k $1 | tail \-1 | awk \'{print $3" "$5}\'
     2609.EB lightgray
    21542610.fi
    2155 .RE
    2156 .sp
    2157 Note that you may have to replace the command names with full path names on some systems\.
    2158 .sp
    2159 By default internal routines for determining the disk capacity and remaining space will be used\.
     2611.fam
     2612.ps +1
     2613.if n \{\
     2614.RE
     2615.\}
     2616.sp
     2617Note that you may have to replace the command names with full path names on some systems\&.
     2618.sp
     2619By default internal routines for determining the disk capacity and remaining space will be used\&.
    21602620.sp
    21612621\fINo default\fR
    21622622.sp
    21632623Example:
    2164 \fI\fIdfree command\fR\fR\fI = \fR\fI/usr/local/samba/bin/dfree\fR\fI \fR
     2624\fI\fIdfree command\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/dfree\F[]\fR\fI \fR
    21652625.RE
    21662626
    21672627directory mode
     2628.\" directory mode
    21682629.PP
    21692630.RS 4
    21702631This parameter is a synonym for
    2171 directory mask\.
     2632directory mask\&.
    21722633.RE
    21732634
    21742635directory mask (S)
    2175 .PP
    2176 .RS 4
    2177 This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\.
    2178 .sp
    2179 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
     2636.\" directory mask
     2637.PP
     2638.RS 4
     2639This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\&.
     2640.sp
     2641When 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
    21802642\fInot\fR
    2181 set here will be removed from the modes set on a directory when it is created\.
    2182 .sp
    2183 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\.
     2643set here will be removed from the modes set on a directory when it is created\&.
     2644.sp
     2645The 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\&.
    21842646.sp
    21852647Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the
    2186 \fIforce directory mode\fR
    2187 parameter\. This parameter is set to 000 by default (i\.e\. no extra mode bits are added)\.
    2188 .sp
    2189 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
    2190 \fIdirectory security mask\fR\.
    2191 .sp
    2192 Default:
    2193 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0755\fR\fI \fR
    2194 .sp
    2195 Example:
    2196 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0775\fR\fI \fR
     2648\m[blue]\fBforce directory mode\fR\m[]
     2649parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode bits are added)\&.
     2650.sp
     2651Note 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
     2652\m[blue]\fBdirectory security mask\fR\m[]\&.
     2653.sp
     2654Default:
     2655\fI\fIdirectory mask\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
     2656.sp
     2657Example:
     2658\fI\fIdirectory mask\fR\fR\fI = \fR\fI\FC0775\F[]\fR\fI \fR
    21972659.RE
    21982660
    21992661directory security mask (S)
    2200 .PP
    2201 .RS 4
    2202 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\.
    2203 .sp
    2204 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
    2205 \fIforce directory security mode\fR, 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\.
    2206 .sp
    2207 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\.
    2208 .sp
    2209 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\.
     2662.\" directory security mask
     2663.PP
     2664.RS 4
     2665This 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\&.
     2666.sp
     2667This 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
     2668\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\&.
     2669.sp
     2670Essentially, 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\&.
     2671.sp
     2672If 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\&.
    22102673.sp
    22112674\fINote\fR
    2212 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
    2213 \fB0777\fR\.
    2214 .sp
    2215 Default:
    2216 \fI\fIdirectory security mask\fR\fR\fI = \fR\fI0777\fR\fI \fR
    2217 .sp
    2218 Example:
    2219 \fI\fIdirectory security mask\fR\fR\fI = \fR\fI0700\fR\fI \fR
     2675that 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
     2676\fB0777\fR\&.
     2677.sp
     2678Default:
     2679\fI\fIdirectory security mask\fR\fR\fI = \fR\fI\FC0777\F[]\fR\fI \fR
     2680.sp
     2681Example:
     2682\fI\fIdirectory security mask\fR\fR\fI = \fR\fI\FC0700\F[]\fR\fI \fR
    22202683.RE
    22212684
    22222685disable netbios (G)
    2223 .PP
    2224 .RS 4
    2225 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\.
    2226 .sp
     2686.\" disable netbios
     2687.PP
     2688.RS 4
     2689Enabling 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\&.
     2690.if n \{\
     2691.sp
     2692.\}
     2693.RS 4
     2694.BM yellow
    22272695.it 1 an-trap
    22282696.nr an-no-space-flag 1
    22292697.nr an-break-flag 1
    22302698.br
    2231 Note
    2232 Clients that only support netbios won\'t be able to see your samba server when netbios support is disabled\.
    2233 
    2234 Default:
    2235 \fI\fIdisable netbios\fR\fR\fI = \fR\fIno\fR\fI \fR
     2699.ps +1
     2700\fBNote\fR
     2701.ps -1
     2702.br
     2703Clients that only support netbios won\'t be able to see your samba server when netbios support is disabled\&.
     2704.sp .5v
     2705.EM yellow
     2706.RE
     2707Default:
     2708\fI\fIdisable netbios\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    22362709.RE
    22372710
    22382711disable spoolss (G)
    2239 .PP
    2240 .RS 4
    2241 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\.
    2242 \fIBe very careful about enabling this parameter\.\fR
    2243 .sp
    2244 Default:
    2245 \fI\fIdisable spoolss\fR\fR\fI = \fR\fIno\fR\fI \fR
     2712.\" disable spoolss
     2713.PP
     2714.RS 4
     2715Enabling 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\&.
     2716\fIBe very careful about enabling this parameter\&.\fR
     2717.sp
     2718Default:
     2719\fI\fIdisable spoolss\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    22462720.RE
    22472721
    22482722display charset (G)
    2249 .PP
    2250 .RS 4
    2251 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
    2252 \fIunix charset\fR\.
    2253 .sp
    2254 Default:
    2255 \fI\fIdisplay charset\fR\fR\fI = \fR\fI"LOCALE" or "ASCII" (depending on the system)\fR\fI \fR
    2256 .sp
    2257 Example:
    2258 \fI\fIdisplay charset\fR\fR\fI = \fR\fIUTF8\fR\fI \fR
     2723.\" display charset
     2724.PP
     2725.RS 4
     2726Specifies 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
     2727\m[blue]\fBunix charset\fR\m[]\&.
     2728.sp
     2729Default:
     2730\fI\fIdisplay charset\fR\fR\fI = \fR\fI\FC"LOCALE" or "ASCII" (depending on the system)\F[]\fR\fI \fR
     2731.sp
     2732Example:
     2733\fI\fIdisplay charset\fR\fR\fI = \fR\fI\FCUTF8\F[]\fR\fI \fR
    22592734.RE
    22602735
    22612736dmapi support (S)
    2262 .PP
    2263 .RS 4
    2264 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\.
    2265 .sp
    2266 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\.
    2267 .sp
    2268 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\.
    2269 .sp
    2270 .sp
    2271 Default:
    2272 \fI\fIdmapi support\fR\fR\fI = \fR\fIno\fR\fI \fR
     2737.\" dmapi support
     2738.PP
     2739.RS 4
     2740This 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\&.
     2741.sp
     2742Note 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\&.
     2743.sp
     2744This 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\&.
     2745.sp
     2746Default:
     2747\fI\fIdmapi support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    22732748.RE
    22742749
    22752750dns proxy (G)
     2751.\" dns proxy
    22762752.PP
    22772753.RS 4
    22782754Specifies that
    22792755\fBnmbd\fR(8)
    2280 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\.
    2281 .sp
    2282 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\.
    2283 .sp
    2284 nmbd
    2285 spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\.
    2286 .sp
    2287 Default:
    2288 \fI\fIdns proxy\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2756when 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\&.
     2757.sp
     2758Note 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\&.
     2759.sp
     2760\FCnmbd\F[]
     2761spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\&.
     2762.sp
     2763Default:
     2764\fI\fIdns proxy\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    22892765.RE
    22902766
    22912767domain logons (G)
     2768.\" domain logons
    22922769.PP
    22932770.RS 4
    22942771If set to
    22952772\fByes\fR, the Samba server will provide the netlogon service for Windows 9X network logons for the
    2296 \fIworkgroup\fR
    2297 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\.
    2298 .sp
    2299 Default:
    2300 \fI\fIdomain logons\fR\fR\fI = \fR\fIno\fR\fI \fR
     2773\m[blue]\fBworkgroup\fR\m[]
     2774it 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\&.
     2775.sp
     2776Default:
     2777\fI\fIdomain logons\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    23012778.RE
    23022779
    23032780domain master (G)
     2781.\" domain master
    23042782.PP
    23052783.RS 4
    23062784Tell
    23072785\fBsmbd\fR(8)
    2308 to enable WAN\-wide browse list collation\. Setting this option causes
    2309 nmbd
     2786to enable WAN\-wide browse list collation\&. Setting this option causes
     2787\FCnmbd\F[]
    23102788to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given
    2311 \fIworkgroup\fR\. Local master browsers in the same
    2312 \fIworkgroup\fR
     2789\m[blue]\fBworkgroup\fR\m[]\&. Local master browsers in the same
     2790\m[blue]\fBworkgroup\fR\m[]
    23132791on broadcast\-isolated subnets will give this
    2314 nmbd
     2792\FCnmbd\F[]
    23152793their local browse lists, and then ask
    23162794\fBsmbd\fR(8)
    2317 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\.
     2795for 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\&.
    23182796.sp
    23192797Note that Windows NT Primary Domain Controllers expect to be able to claim this
    2320 \fIworkgroup\fR
     2798\m[blue]\fBworkgroup\fR\m[]
    23212799specific special NetBIOS name that identifies them as domain master browsers for that
    2322 \fIworkgroup\fR
    2323 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
    2324 nmbd
     2800\m[blue]\fBworkgroup\fR\m[]
     2801by 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
     2802\FCnmbd\F[]
    23252803claims the special name for a
    2326 \fIworkgroup\fR
    2327 before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\.
     2804\m[blue]\fBworkgroup\fR\m[]
     2805before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\&.
    23282806.sp
    23292807If
    2330 \fIdomain logons = yes\fR, then the default behavior is to enable the
    2331 \fIdomain master\fR
    2332 parameter\. If
    2333 \fIdomain logons\fR
     2808\m[blue]\fBdomain logons = yes\fR\m[], then the default behavior is to enable the
     2809\m[blue]\fBdomain master\fR\m[]
     2810parameter\&. If
     2811\m[blue]\fBdomain logons\fR\m[]
    23342812is not enabled (the default setting), then neither will
    2335 \fIdomain master\fR
    2336 be enabled by default\.
     2813\m[blue]\fBdomain master\fR\m[]
     2814be enabled by default\&.
    23372815.sp
    23382816When
    2339 \fIdomain logons = Yes\fR
    2340 the default setting for this parameter is Yes, with the result that Samba will be a PDC\. If
    2341 \fIdomain master = No\fR, Samba will function as a BDC\. In general, this parameter should be set to \'No\' only on a BDC\.
    2342 .sp
    2343 Default:
    2344 \fI\fIdomain master\fR\fR\fI = \fR\fIauto\fR\fI \fR
     2817\m[blue]\fBdomain logons = Yes\fR\m[]
     2818the default setting for this parameter is Yes, with the result that Samba will be a PDC\&. If
     2819\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\&.
     2820.sp
     2821Default:
     2822\fI\fIdomain master\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
    23452823.RE
    23462824
    23472825dont descend (S)
    2348 .PP
    2349 .RS 4
    2350 There are certain directories on some systems (e\.g\., the
    2351 \fI/proc\fR
    2352 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\.
    2353 .sp
    2354 Note that Samba can be very fussy about the exact format of the "dont descend" entries\. For example you may need
    2355 \fI \./proc\fR
     2826.\" dont descend
     2827.PP
     2828.RS 4
     2829There are certain directories on some systems (e\&.g\&., the
     2830\FC/proc\F[]
     2831tree 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\&.
     2832.sp
     2833Note that Samba can be very fussy about the exact format of the "dont descend" entries\&. For example you may need
     2834\FC \&./proc\F[]
    23562835instead of just
    2357 \fI/proc\fR\. Experimentation is the best policy :\-)
    2358 .sp
    2359 Default:
    2360 \fI\fIdont descend\fR\fR\fI = \fR\fI\fR\fI \fR
    2361 .sp
    2362 Example:
    2363 \fI\fIdont descend\fR\fR\fI = \fR\fI/proc,/dev\fR\fI \fR
     2836\FC/proc\F[]\&. Experimentation is the best policy :\-)
     2837.sp
     2838Default:
     2839\fI\fIdont descend\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2840.sp
     2841Example:
     2842\fI\fIdont descend\fR\fR\fI = \fR\fI\FC/proc,/dev\F[]\fR\fI \fR
    23642843.RE
    23652844
    23662845dos charset (G)
    2367 .PP
    2368 .RS 4
    2369 DOS SMB clients assume the server has the same charset as they do\. This option specifies which charset Samba should talk to DOS clients\.
    2370 .sp
    2371 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
     2846.\" dos charset
     2847.PP
     2848.RS 4
     2849DOS SMB clients assume the server has the same charset as they do\&. This option specifies which charset Samba should talk to DOS clients\&.
     2850.sp
     2851The 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
    23722852\fBtestparm\fR(1)
    2373 to check the default on your system\.
     2853to check the default on your system\&.
    23742854.sp
    23752855\fINo default\fR
     
    23772857
    23782858dos filemode (S)
    2379 .PP
    2380 .RS 4
    2381 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\.
    2382 .sp
    2383 Default:
    2384 \fI\fIdos filemode\fR\fR\fI = \fR\fIno\fR\fI \fR
     2859.\" dos filemode
     2860.PP
     2861.RS 4
     2862The 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\&.
     2863.sp
     2864Default:
     2865\fI\fIdos filemode\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    23852866.RE
    23862867
    23872868dos filetime resolution (S)
    2388 .PP
    2389 .RS 4
    2390 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
    2391 \fBsmbd\fR(8)\.
    2392 .sp
    2393 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\.
    2394 .sp
    2395 Default:
    2396 \fI\fIdos filetime resolution\fR\fR\fI = \fR\fIno\fR\fI \fR
     2869.\" dos filetime resolution
     2870.PP
     2871.RS 4
     2872Under 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
     2873\fBsmbd\fR(8)\&.
     2874.sp
     2875This 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\&.
     2876.sp
     2877Default:
     2878\fI\fIdos filetime resolution\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    23972879.RE
    23982880
    23992881dos filetimes (S)
    2400 .PP
    2401 .RS 4
    2402 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
    2403 smbd
    2404 is acting on behalf of is not the file owner\. Setting this option to
     2882.\" dos filetimes
     2883.PP
     2884.RS 4
     2885Under 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
     2886\FCsmbd\F[]
     2887is acting on behalf of is not the file owner\&. Setting this option to
    24052888\fB yes\fR
    24062889allows DOS semantics and
    24072890\fBsmbd\fR(8)
    2408 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\.
    2409 .sp
    2410 Default:
    2411 \fI\fIdos filetimes\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2891will 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\&.
     2892.sp
     2893Default:
     2894\fI\fIdos filetimes\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    24122895.RE
    24132896
    24142897ea support (S)
     2898.\" ea support
    24152899.PP
    24162900.RS 4
    24172901This boolean parameter controls whether
    24182902\fBsmbd\fR(8)
    2419 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\.
    2420 .sp
    2421 Default:
    2422 \fI\fIea support\fR\fR\fI = \fR\fIno\fR\fI \fR
     2903will 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\&.
     2904.sp
     2905Default:
     2906\fI\fIea support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    24232907.RE
    24242908
    24252909enable asu support (G)
    2426 .PP
    2427 .RS 4
    2428 Hosts running the "Advanced Server for Unix (ASU)" product require some special accomodations such as creating a builting [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\.
    2429 .sp
    2430 Default:
    2431 \fI\fIenable asu support\fR\fR\fI = \fR\fIno\fR\fI \fR
     2910.\" enable asu support
     2911.PP
     2912.RS 4
     2913Hosts running the "Advanced Server for Unix (ASU)" product require some special accomodations such as creating a builting [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\&.
     2914.sp
     2915Default:
     2916\fI\fIenable asu support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    24322917.RE
    24332918
    24342919enable privileges (G)
     2920.\" enable privileges
    24352921.PP
    24362922.RS 4
    24372923This parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either
    2438 net rpc rights
    2439 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\.
    2440 .sp
    2441 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\.
    2442 .sp
    2443 Please read the extended description provided in the Samba HOWTO documentation\.
    2444 .sp
    2445 Default:
    2446 \fI\fIenable privileges\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2924\FCnet rpc rights\F[]
     2925or 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\&.
     2926.sp
     2927An 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\&.
     2928.sp
     2929Please read the extended description provided in the Samba HOWTO documentation\&.
     2930.sp
     2931Default:
     2932\fI\fIenable privileges\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    24472933.RE
    24482934
    24492935encrypt passwords (G)
    2450 .PP
    2451 .RS 4
    2452 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\.
    2453 .sp
    2454 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\.
    2455 .sp
    2456 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\.
     2936.\" encrypt passwords
     2937.PP
     2938.RS 4
     2939This 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\&.
     2940.sp
     2941MS 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\&.
     2942.sp
     2943The 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\&.
    24572944.sp
    24582945In order for encrypted passwords to work correctly
     
    24632950\fBsmbpasswd\fR(8)
    24642951program for information on how to set up and maintain this file), or set the
    2465 \fIsecurity = [server|domain|ads]\fR
     2952\m[blue]\fBsecurity = [server|domain|ads]\fR\m[]
    24662953parameter which causes
    2467 smbd
    2468 to authenticate against another server\.
    2469 .sp
    2470 Default:
    2471 \fI\fIencrypt passwords\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2954\FCsmbd\F[]
     2955to authenticate against another server\&.
     2956.sp
     2957Default:
     2958\fI\fIencrypt passwords\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    24722959.RE
    24732960
    24742961enhanced browsing (G)
    2475 .PP
    2476 .RS 4
    2477 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\.
    2478 .sp
    2479 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\.
    2480 .sp
    2481 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\.
    2482 .sp
    2483 In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\.
    2484 .sp
    2485 Default:
    2486 \fI\fIenhanced browsing\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2962.\" enhanced browsing
     2963.PP
     2964.RS 4
     2965This 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\&.
     2966.sp
     2967The 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\&.
     2968.sp
     2969You 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\&.
     2970.sp
     2971In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\&.
     2972.sp
     2973Default:
     2974\fI\fIenhanced browsing\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    24872975.RE
    24882976
    24892977enumports command (G)
    2490 .PP
    2491 .RS 4
    2492 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 (smbd
     2978.\" enumports command
     2979.PP
     2980.RS 4
     2981The 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[]
    24932982does not use a port name for anything) other than the default
    24942983\fB"Samba Printer Port"\fR, you can define
    24952984\fIenumports command\fR
    2496 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\.
    2497 .sp
    2498 Default:
    2499 \fI\fIenumports command\fR\fR\fI = \fR\fI\fR\fI \fR
    2500 .sp
    2501 Example:
    2502 \fI\fIenumports command\fR\fR\fI = \fR\fI/usr/bin/listports\fR\fI \fR
     2985to 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\&.
     2986.sp
     2987Default:
     2988\fI\fIenumports command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2989.sp
     2990Example:
     2991\fI\fIenumports command\fR\fR\fI = \fR\fI\FC/usr/bin/listports\F[]\fR\fI \fR
    25032992.RE
    25042993
    25052994eventlog list (G)
    2506 .PP
    2507 .RS 4
    2508 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
    2509 \fI$(lockdir)/eventlog\fR\.
     2995.\" eventlog list
     2996.PP
     2997.RS 4
     2998This 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
     2999\FC$(lockdir)/eventlog\F[]\&.
    25103000.sp
    25113001The administrator must use an external process to parse the normal Unix logs such as
    2512 \fI/var/log/messages\fR
    2513 and write then entries to the eventlog tdb files\. Refer to the eventlogadm(8) utility for how to write eventlog entries\.
    2514 .sp
    2515 Default:
    2516 \fI\fIeventlog list\fR\fR\fI = \fR\fI\fR\fI \fR
    2517 .sp
    2518 Example:
    2519 \fI\fIeventlog list\fR\fR\fI = \fR\fISecurity Application Syslog Apache\fR\fI \fR
     3002\FC/var/log/messages\F[]
     3003and write then entries to the eventlog tdb files\&. Refer to the eventlogadm(8) utility for how to write eventlog entries\&.
     3004.sp
     3005Default:
     3006\fI\fIeventlog list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3007.sp
     3008Example:
     3009\fI\fIeventlog list\fR\fR\fI = \fR\fI\FCSecurity Application Syslog Apache\F[]\fR\fI \fR
    25203010.RE
    25213011
    25223012fake directory create times (S)
    2523 .PP
    2524 .RS 4
    2525 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\.
    2526 .sp
    2527 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\.
    2528 .sp
    2529 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\.
    2530 .sp
    2531 Default:
    2532 \fI\fIfake directory create times\fR\fR\fI = \fR\fIno\fR\fI \fR
     3013.\" fake directory create times
     3014.PP
     3015.RS 4
     3016NTFS 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\&.
     3017.sp
     3018This 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\&.
     3019.sp
     3020However, 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\&.
     3021.sp
     3022Default:
     3023\fI\fIfake directory create times\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    25333024.RE
    25343025
    25353026fake oplocks (S)
    2536 .PP
    2537 .RS 4
    2538 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\.
     3027.\" fake oplocks
     3028.PP
     3029.RS 4
     3030Oplocks 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\&.
    25393031.sp
    25403032When you set
    2541 fake oplocks = yes,
     3033\FCfake oplocks = yes\F[],
    25423034\fBsmbd\fR(8)
    2543 will always grant oplock requests no matter how many clients are using the file\.
     3035will always grant oplock requests no matter how many clients are using the file\&.
    25443036.sp
    25453037It is generally much better to use the real
    2546 \fIoplocks\fR
    2547 support rather than this parameter\.
    2548 .sp
    2549 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!
    2550 .sp
    2551 Default:
    2552 \fI\fIfake oplocks\fR\fR\fI = \fR\fIno\fR\fI \fR
     3038\m[blue]\fBoplocks\fR\m[]
     3039support rather than this parameter\&.
     3040.sp
     3041If 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!
     3042.sp
     3043Default:
     3044\fI\fIfake oplocks\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    25533045.RE
    25543046
    25553047follow symlinks (S)
     3048.\" follow symlinks
    25563049.PP
    25573050.RS 4
    25583051This parameter allows the Samba administrator to stop
    25593052\fBsmbd\fR(8)
    2560 from following symbolic links in a particular share\. Setting this parameter to
     3053from following symbolic links in a particular share\&. Setting this parameter to
    25613054\fBno\fR
    2562 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
    2563 \fI/etc/passwd\fR
    2564 in their home directory for instance\. However it will slow filename lookups down slightly\.
    2565 .sp
    2566 This option is enabled (i\.e\.
    2567 smbd
    2568 will follow symbolic links) by default\.
    2569 .sp
    2570 Default:
    2571 \fI\fIfollow symlinks\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3055prevents 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
     3056\FC/etc/passwd\F[]
     3057in their home directory for instance\&. However it will slow filename lookups down slightly\&.
     3058.sp
     3059This option is enabled (i\&.e\&.
     3060\FCsmbd\F[]
     3061will follow symbolic links) by default\&.
     3062.sp
     3063Default:
     3064\fI\fIfollow symlinks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    25723065.RE
    25733066
    25743067force create mode (S)
     3068.\" force create mode
    25753069.PP
    25763070.RS 4
    25773071This parameter specifies a set of UNIX mode bit permissions that will
    25783072\fIalways\fR
    2579 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 or having its permissions changed\. 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
     3073be 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 or having its permissions changed\&. 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
    25803074\fIcreate mask\fR
    2581 parameter is applied\.
    2582 .sp
    2583 The example below would force all 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\'\.
    2584 .sp
    2585 Default:
    2586 \fI\fIforce create mode\fR\fR\fI = \fR\fI000\fR\fI \fR
    2587 .sp
    2588 Example:
    2589 \fI\fIforce create mode\fR\fR\fI = \fR\fI0755\fR\fI \fR
     3075parameter is applied\&.
     3076.sp
     3077The example below would force all 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\'\&.
     3078.sp
     3079Default:
     3080\fI\fIforce create mode\fR\fR\fI = \fR\fI\FC000\F[]\fR\fI \fR
     3081.sp
     3082Example:
     3083\fI\fIforce create mode\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
    25903084.RE
    25913085
    25923086force directory mode (S)
     3087.\" force directory mode
    25933088.PP
    25943089.RS 4
    25953090This parameter specifies a set of UNIX mode bit permissions that will
    25963091\fIalways\fR
    2597 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
     3092be 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
    25983093\fIdirectory mask\fR
    2599 is applied\.
    2600 .sp
    2601 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\'\.
    2602 .sp
    2603 Default:
    2604 \fI\fIforce directory mode\fR\fR\fI = \fR\fI000\fR\fI \fR
    2605 .sp
    2606 Example:
    2607 \fI\fIforce directory mode\fR\fR\fI = \fR\fI0755\fR\fI \fR
     3094is applied\&.
     3095.sp
     3096The 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\'\&.
     3097.sp
     3098Default:
     3099\fI\fIforce directory mode\fR\fR\fI = \fR\fI\FC000\F[]\fR\fI \fR
     3100.sp
     3101Example:
     3102\fI\fIforce directory mode\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
    26083103.RE
    26093104
    26103105force directory security mode (S)
    2611 .PP
    2612 .RS 4
    2613 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\.
    2614 .sp
    2615 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
    2616 \fIdirectory security mask\fR, which works in a similar manner to this one, but uses a logical AND instead of an OR\.
    2617 .sp
    2618 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)\.
    2619 .sp
    2620 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\.
    2621 .sp
     3106.\" force directory security mode
     3107.PP
     3108.RS 4
     3109This 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\&.
     3110.sp
     3111This 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
     3112\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\&.
     3113.sp
     3114Essentially, 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)\&.
     3115.sp
     3116If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world permissions on a directory without restrictions\&.
     3117.if n \{\
     3118.sp
     3119.\}
     3120.RS 4
     3121.BM yellow
    26223122.it 1 an-trap
    26233123.nr an-no-space-flag 1
    26243124.nr an-break-flag 1
    26253125.br
    2626 Note
    2627 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\.
    2628 
    2629 Default:
    2630 \fI\fIforce directory security mode\fR\fR\fI = \fR\fI0\fR\fI \fR
    2631 .sp
    2632 Example:
    2633 \fI\fIforce directory security mode\fR\fR\fI = \fR\fI700\fR\fI \fR
     3126.ps +1
     3127\fBNote\fR
     3128.ps -1
     3129.br
     3130Users 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\&.
     3131.sp .5v
     3132.EM yellow
     3133.RE
     3134Default:
     3135\fI\fIforce directory security mode\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     3136.sp
     3137Example:
     3138\fI\fIforce directory security mode\fR\fR\fI = \fR\fI\FC700\F[]\fR\fI \fR
    26343139.RE
    26353140
    26363141group
     3142.\" group
    26373143.PP
    26383144.RS 4
    26393145This parameter is a synonym for
    2640 force group\.
     3146force group\&.
    26413147.RE
    26423148
    26433149force group (S)
    2644 .PP
    2645 .RS 4
    2646 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\.
    2647 .sp
    2648 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
    2649 \fIforce group = +sys\fR
    2650 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\.
     3150.\" force group
     3151.PP
     3152.RS 4
     3153This 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\&.
     3154.sp
     3155In 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
     3156\FCforce group = +sys\F[]
     3157means 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\&.
    26513158.sp
    26523159If the
    2653 \fIforce user\fR
     3160\m[blue]\fBforce user\fR\m[]
    26543161parameter is also set the group specified in
    26553162\fIforce group\fR
    26563163will override the primary group set in
    2657 \fIforce user\fR\.
    2658 .sp
    2659 Default:
    2660 \fI\fIforce group\fR\fR\fI = \fR\fI\fR\fI \fR
    2661 .sp
    2662 Example:
    2663 \fI\fIforce group\fR\fR\fI = \fR\fIagroup\fR\fI \fR
     3164\fIforce user\fR\&.
     3165.sp
     3166Default:
     3167\fI\fIforce group\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3168.sp
     3169Example:
     3170\fI\fIforce group\fR\fR\fI = \fR\fI\FCagroup\F[]\fR\fI \fR
    26643171.RE
    26653172
    26663173force printername (S)
     3174.\" force printername
    26673175.PP
    26683176.RS 4
    26693177When printing from Windows NT (or later), each printer in
    2670 \fIsmb\.conf\fR
    2671 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
     3178\FCsmb\&.conf\F[]
     3179has 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
    26723180\fIprinter name\fR
    2673 option)\.
    2674 .sp
    2675 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
    2676 \fIforce printername = yes\fR\.
    2677 .sp
    2678 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\.
    2679 .sp
    2680 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\.
    2681 .sp
    2682 Default:
    2683 \fI\fIforce printername\fR\fR\fI = \fR\fIno\fR\fI \fR
     3181option)\&.
     3182.sp
     3183When 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
     3184\fIforce printername = yes\fR\&.
     3185.sp
     3186Be 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\&.
     3187.sp
     3188It 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\&.
     3189.sp
     3190Default:
     3191\fI\fIforce printername\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    26843192.RE
    26853193
    26863194force security mode (S)
    2687 .PP
    2688 .RS 4
    2689 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\.
    2690 .sp
    2691 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
    2692 \fIsecurity mask\fR, which works similar like this one but uses logical AND instead of OR\.
    2693 .sp
    2694 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\.
    2695 .sp
    2696 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\.
     3195.\" force security mode
     3196.PP
     3197.RS 4
     3198This 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\&.
     3199.sp
     3200This 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
     3201\m[blue]\fBsecurity mask\fR\m[], which works similar like this one but uses logical AND instead of OR\&.
     3202.sp
     3203Essentially, 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\&.
     3204.sp
     3205If 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\&.
    26973206.sp
    26983207\fI Note\fR
    2699 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\.
    2700 .sp
    2701 Default:
    2702 \fI\fIforce security mode\fR\fR\fI = \fR\fI0\fR\fI \fR
    2703 .sp
    2704 Example:
    2705 \fI\fIforce security mode\fR\fR\fI = \fR\fI700\fR\fI \fR
     3208that 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\&.
     3209.sp
     3210Default:
     3211\fI\fIforce security mode\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     3212.sp
     3213Example:
     3214\fI\fIforce security mode\fR\fR\fI = \fR\fI\FC700\F[]\fR\fI \fR
    27063215.RE
    27073216
    27083217force unknown acl user (S)
    2709 .PP
    2710 .RS 4
    2711 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\.
    2712 .sp
    2713 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\.
    2714 .sp
    2715 Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\.
    2716 .sp
    2717 Default:
    2718 \fI\fIforce unknown acl user\fR\fR\fI = \fR\fIno\fR\fI \fR
     3218.\" force unknown acl user
     3219.PP
     3220.RS 4
     3221If 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\&.
     3222.sp
     3223This 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\&.
     3224.sp
     3225Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\&.
     3226.sp
     3227Default:
     3228\fI\fIforce unknown acl user\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    27193229.RE
    27203230
    27213231force user (S)
    2722 .PP
    2723 .RS 4
    2724 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\.
    2725 .sp
    2726 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\.
    2727 .sp
    2728 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)\.
    2729 .sp
    2730 Default:
    2731 \fI\fIforce user\fR\fR\fI = \fR\fI\fR\fI \fR
    2732 .sp
    2733 Example:
    2734 \fI\fIforce user\fR\fR\fI = \fR\fIauser\fR\fI \fR
     3232.\" force user
     3233.PP
     3234.RS 4
     3235This 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\&.
     3236.sp
     3237This 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\&.
     3238.sp
     3239In 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)\&.
     3240.sp
     3241Default:
     3242\fI\fIforce user\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3243.sp
     3244Example:
     3245\fI\fIforce user\fR\fR\fI = \fR\fI\FCauser\F[]\fR\fI \fR
    27353246.RE
    27363247
    27373248fstype (S)
     3249.\" fstype
    27383250.PP
    27393251.RS 4
    27403252This parameter allows the administrator to configure the string that specifies the type of filesystem a share is using that is reported by
    27413253\fBsmbd\fR(8)
    2742 when a client queries the filesystem type for a share\. The default type is
     3254when a client queries the filesystem type for a share\&. The default type is
    27433255\fBNTFS\fR
    27443256for compatibility with Windows NT but this can be changed to other strings such as
     
    27463258or
    27473259\fBFAT\fR
    2748 if required\.
    2749 .sp
    2750 Default:
    2751 \fI\fIfstype\fR\fR\fI = \fR\fINTFS\fR\fI \fR
    2752 .sp
    2753 Example:
    2754 \fI\fIfstype\fR\fR\fI = \fR\fISamba\fR\fI \fR
     3260if required\&.
     3261.sp
     3262Default:
     3263\fI\fIfstype\fR\fR\fI = \fR\fI\FCNTFS\F[]\fR\fI \fR
     3264.sp
     3265Example:
     3266\fI\fIfstype\fR\fR\fI = \fR\fI\FCSamba\F[]\fR\fI \fR
    27553267.RE
    27563268
    27573269get quota command (G)
     3270.\" get quota command
    27583271.PP
    27593272.RS 4
    27603273The
    2761 get quota command
    2762 should only be used whenever there is no operating system API available from the OS that samba can use\.
     3274\FCget quota command\F[]
     3275should only be used whenever there is no operating system API available from the OS that samba can use\&.
    27633276.sp
    27643277This option is only available you have compiled Samba with the
    2765 \-\-with\-sys\-quotas
     3278\FC\-\-with\-sys\-quotas\F[]
    27663279option or on Linux with
    2767 \-\-with\-quotas
    2768 and a working quota api was found in the system\.
    2769 .sp
    2770 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\.
     3280\FC\-\-with\-quotas\F[]
     3281and a working quota api was found in the system\&.
     3282.sp
     3283This 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\&.
    27713284.sp
    27723285Such a script should take 3 arguments:
     
    28513364.sp
    28523365.RE
    2853 This script should print one line as output with spaces between the arguments\. The arguments are:
     3366This script should print one line as output with spaces between the arguments\&. The arguments are:
    28543367.sp
    28553368.RS 4
     
    29423455.RE
    29433456Default:
    2944 \fI\fIget quota command\fR\fR\fI = \fR\fI\fR\fI \fR
    2945 .sp
    2946 Example:
    2947 \fI\fIget quota command\fR\fR\fI = \fR\fI/usr/local/sbin/query_quota\fR\fI \fR
     3457\fI\fIget quota command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3458.sp
     3459Example:
     3460\fI\fIget quota command\fR\fR\fI = \fR\fI\FC/usr/local/sbin/query_quota\F[]\fR\fI \fR
    29483461.RE
    29493462
    29503463getwd cache (G)
    2951 .PP
    2952 .RS 4
    2953 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
    2954 \fIwide smbconfoptions\fR
     3464.\" getwd cache
     3465.PP
     3466.RS 4
     3467This 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
     3468\m[blue]\fBwide smbconfoptions\fR\m[]
    29553469parameter is set to
    2956 \fBno\fR\.
    2957 .sp
    2958 Default:
    2959 \fI\fIgetwd cache\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3470\fBno\fR\&.
     3471.sp
     3472Default:
     3473\fI\fIgetwd cache\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    29603474.RE
    29613475
    29623476guest account (G)
     3477.\" guest account
    29633478.PP
    29643479.RS 4
    29653480This is a username which will be used for access to services which are specified as
    2966 \fIguest ok\fR
    2967 (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\.
    2968 .sp
    2969 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
    2970 su \-
     3481\m[blue]\fBguest ok\fR\m[]
     3482(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\&.
     3483.sp
     3484On 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
     3485\FCsu \-\F[]
    29713486command) and trying to print using the system print command such as
    2972 lpr(1)
     3487\FClpr(1)\F[]
    29733488or
    2974 lp(1)\.
    2975 .sp
    2976 This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation\.
    2977 .sp
    2978 Default:
    2979 \fI\fIguest account\fR\fR\fI = \fR\fInobody # default can be changed at compile\-time\fR\fI \fR
    2980 .sp
    2981 Example:
    2982 \fI\fIguest account\fR\fR\fI = \fR\fIftp\fR\fI \fR
     3489\FC lp(1)\F[]\&.
     3490.sp
     3491This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation\&.
     3492.sp
     3493Default:
     3494\fI\fIguest account\fR\fR\fI = \fR\fI\FCnobody # default can be changed at compile\-time\F[]\fR\fI \fR
     3495.sp
     3496Example:
     3497\fI\fIguest account\fR\fR\fI = \fR\fI\FCftp\F[]\fR\fI \fR
    29833498.RE
    29843499
    29853500public
     3501.\" public
    29863502.PP
    29873503.RS 4
    29883504This parameter is a synonym for
    2989 guest ok\.
     3505guest ok\&.
    29903506.RE
    29913507
    29923508guest ok (S)
     3509.\" guest ok
    29933510.PP
    29943511.RS 4
    29953512If this parameter is
    29963513\fByes\fR
    2997 for a service, then no password is required to connect to the service\. Privileges will be those of the
    2998 \fIguest account\fR\.
     3514for a service, then no password is required to connect to the service\&. Privileges will be those of the
     3515\m[blue]\fBguest account\fR\m[]\&.
    29993516.sp
    30003517This paramater nullifies the benifits of setting
    3001 \fIrestrict anonymous = 2\fR
     3518\m[blue]\fBrestrict anonymous = 2\fR\m[]
    30023519.sp
    30033520See the section below on
    3004 \fIsecurity\fR
    3005 for more information about this option\.
    3006 .sp
    3007 Default:
    3008 \fI\fIguest ok\fR\fR\fI = \fR\fIno\fR\fI \fR
     3521\m[blue]\fBsecurity\fR\m[]
     3522for more information about this option\&.
     3523.sp
     3524Default:
     3525\fI\fIguest ok\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    30093526.RE
    30103527
    30113528only guest
     3529.\" only guest
    30123530.PP
    30133531.RS 4
    30143532This parameter is a synonym for
    3015 guest only\.
     3533guest only\&.
    30163534.RE
    30173535
    30183536guest only (S)
     3537.\" guest only
    30193538.PP
    30203539.RS 4
    30213540If this parameter is
    30223541\fByes\fR
    3023 for a service, then only guest connections to the service are permitted\. This parameter will have no effect if
    3024 \fIguest ok\fR
    3025 is not set for the service\.
     3542for a service, then only guest connections to the service are permitted\&. This parameter will have no effect if
     3543\m[blue]\fBguest ok\fR\m[]
     3544is not set for the service\&.
    30263545.sp
    30273546See the section below on
    3028 \fIsecurity\fR
    3029 for more information about this option\.
    3030 .sp
    3031 Default:
    3032 \fI\fIguest only\fR\fR\fI = \fR\fIno\fR\fI \fR
     3547\m[blue]\fBsecurity\fR\m[]
     3548for more information about this option\&.
     3549.sp
     3550Default:
     3551\fI\fIguest only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    30333552.RE
    30343553
    30353554hide dot files (S)
    3036 .PP
    3037 .RS 4
    3038 This is a boolean parameter that controls whether files starting with a dot appear as hidden files\.
    3039 .sp
    3040 Default:
    3041 \fI\fIhide dot files\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3555.\" hide dot files
     3556.PP
     3557.RS 4
     3558This is a boolean parameter that controls whether files starting with a dot appear as hidden files\&.
     3559.sp
     3560Default:
     3561\fI\fIhide dot files\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    30423562.RE
    30433563
    30443564hide files (S)
    3045 .PP
    3046 .RS 4
    3047 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\.
    3048 .sp
    3049 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\.
    3050 .sp
    3051 Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator \'/\'\.
    3052 .sp
    3053 Note that the case sensitivity option is applicable in hiding files\.
    3054 .sp
    3055 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\.
     3565.\" hide files
     3566.PP
     3567.RS 4
     3568This 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\&.
     3569.sp
     3570Each 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\&.
     3571.sp
     3572Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator \'/\'\&.
     3573.sp
     3574Note that the case sensitivity option is applicable in hiding files\&.
     3575.sp
     3576Setting 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\&.
    30563577.sp
    30573578The example shown above is based on files that the Macintosh SMB client (DAVE) available from
    30583579Thursby
    3059 creates for internal use, and also still hides all files beginning with a dot\.
     3580creates for internal use, and also still hides all files beginning with a dot\&.
    30603581.sp
    30613582An example of us of this parameter is:
    30623583.sp
    3063 .RS 4
     3584.if n \{\
     3585.RS 4
     3586.\}
     3587.fam C
     3588.ps -1
    30643589.nf
    3065 hide files = /\.*/DesktopFolderDB/TrashFor%m/resource\.frk/
     3590.if t \{\
     3591.sp -1
     3592.\}
     3593.BB lightgray adjust-for-leading-newline
     3594.sp -1
     3595
     3596hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/
     3597.EB lightgray adjust-for-leading-newline
     3598.if t \{\
     3599.sp 1
     3600.\}
    30663601.fi
    3067 .RE
    3068 .sp
    3069 .sp
    3070 Default:
    3071 \fI\fIhide files\fR\fR\fI = \fR\fI # no file are hidden\fR\fI \fR
     3602.fam
     3603.ps +1
     3604.if n \{\
     3605.RE
     3606.\}
     3607.sp
     3608Default:
     3609\fI\fIhide files\fR\fR\fI = \fR\fI\FC # no file are hidden\F[]\fR\fI \fR
    30723610.RE
    30733611
    30743612hide special files (S)
    3075 .PP
    3076 .RS 4
    3077 This parameter prevents clients from seeing special files such as sockets, devices and fifo\'s in directory listings\.
    3078 .sp
    3079 Default:
    3080 \fI\fIhide special files\fR\fR\fI = \fR\fIno\fR\fI \fR
     3613.\" hide special files
     3614.PP
     3615.RS 4
     3616This parameter prevents clients from seeing special files such as sockets, devices and fifo\'s in directory listings\&.
     3617.sp
     3618Default:
     3619\fI\fIhide special files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    30813620.RE
    30823621
    30833622hide unreadable (S)
    3084 .PP
    3085 .RS 4
    3086 This parameter prevents clients from seeing the existance of files that cannot be read\. Defaults to off\.
    3087 .sp
    3088 Default:
    3089 \fI\fIhide unreadable\fR\fR\fI = \fR\fIno\fR\fI \fR
     3623.\" hide unreadable
     3624.PP
     3625.RS 4
     3626This parameter prevents clients from seeing the existance of files that cannot be read\&. Defaults to off\&.
     3627.sp
     3628Default:
     3629\fI\fIhide unreadable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    30903630.RE
    30913631
    30923632hide unwriteable files (S)
    3093 .PP
    3094 .RS 4
    3095 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\.
    3096 .sp
    3097 Default:
    3098 \fI\fIhide unwriteable files\fR\fR\fI = \fR\fIno\fR\fI \fR
     3633.\" hide unwriteable files
     3634.PP
     3635.RS 4
     3636This 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\&.
     3637.sp
     3638Default:
     3639\fI\fIhide unwriteable files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    30993640.RE
    31003641
    31013642homedir map (G)
     3643.\" homedir map
    31023644.PP
    31033645.RS 4
    31043646If
    3105 \fInis homedir\fR
     3647\m[blue]\fBnis homedir\fR\m[]
    31063648is
    31073649\fByes\fR, and
     
    31093651is also acting as a Win95/98
    31103652\fIlogon server\fR
    3111 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:
    3112 .sp
    3113 .RS 4
     3653then 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:
     3654.sp
     3655.if n \{\
     3656.RS 4
     3657.\}
     3658.fam C
     3659.ps -1
    31143660.nf
    3115 username server:/some/file/system
     3661.if t \{\
     3662.sp -1
     3663.\}
     3664.BB lightgray adjust-for-leading-newline
     3665.sp -1
     3666
     3667\FCusername server:/some/file/system\F[]
     3668.EB lightgray adjust-for-leading-newline
     3669.if t \{\
     3670.sp 1
     3671.\}
    31163672.fi
    3117 .RE
    3118 .sp
    3119 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\.
    3120 .sp
     3673.fam
     3674.ps +1
     3675.if n \{\
     3676.RE
     3677.\}
     3678.sp
     3679and 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\&.
     3680.if n \{\
     3681.sp
     3682.\}
     3683.RS 4
     3684.BM yellow
    31213685.it 1 an-trap
    31223686.nr an-no-space-flag 1
    31233687.nr an-break-flag 1
    31243688.br
    3125 Note
    3126 A working NIS client is required on the system for this option to work\.
    3127 
    3128 Default:
    3129 \fI\fIhomedir map\fR\fR\fI = \fR\fI\fR\fI \fR
    3130 .sp
    3131 Example:
    3132 \fI\fIhomedir map\fR\fR\fI = \fR\fIamd\.homedir\fR\fI \fR
     3689.ps +1
     3690\fBNote\fR
     3691.ps -1
     3692.br
     3693A working NIS client is required on the system for this option to work\&.
     3694.sp .5v
     3695.EM yellow
     3696.RE
     3697Default:
     3698\fI\fIhomedir map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3699.sp
     3700Example:
     3701\fI\fIhomedir map\fR\fR\fI = \fR\fI\FCamd\&.homedir\F[]\fR\fI \fR
    31333702.RE
    31343703
    31353704host msdfs (G)
     3705.\" host msdfs
    31363706.PP
    31373707.RS 4
    31383708If set to
    3139 \fByes\fR, Samba will act as a Dfs server, and allow Dfs\-aware clients to browse Dfs trees hosted on the server\.
     3709\fByes\fR, Samba will act as a Dfs server, and allow Dfs\-aware clients to browse Dfs trees hosted on the server\&.
    31403710.sp
    31413711See also the
    3142 \fImsdfs root\fR
    3143 share level parameter\. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\.
    3144 .sp
    3145 Default:
    3146 \fI\fIhost msdfs\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3712\m[blue]\fBmsdfs root\fR\m[]
     3713share level parameter\&. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\&.
     3714.sp
     3715Default:
     3716\fI\fIhost msdfs\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    31473717.RE
    31483718
    31493719hostname lookups (G)
    3150 .PP
    3151 .RS 4
    3152 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
    3153 hosts deny
     3720.\" hostname lookups
     3721.PP
     3722.RS 4
     3723Specifies 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
     3724\FChosts deny\F[]
    31543725and
    3155 hosts allow\.
    3156 .sp
    3157 Default:
    3158 \fI\fIhostname lookups\fR\fR\fI = \fR\fIno\fR\fI \fR
    3159 .sp
    3160 Example:
    3161 \fI\fIhostname lookups\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3726\FChosts allow\F[]\&.
     3727.sp
     3728Default:
     3729\fI\fIhostname lookups\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
     3730.sp
     3731Example:
     3732\fI\fIhostname lookups\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    31623733.RE
    31633734
    31643735allow hosts
     3736.\" allow hosts
    31653737.PP
    31663738.RS 4
    31673739This parameter is a synonym for
    3168 hosts allow\.
     3740hosts allow\&.
    31693741.RE
    31703742
    31713743hosts allow (S)
     3744.\" hosts allow
    31723745.PP
    31733746.RS 4
    31743747A synonym for this parameter is
    3175 \fIallow hosts\fR\.
    3176 .sp
    3177 This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\.
    3178 .sp
    3179 If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\.
    3180 .sp
    3181 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
    3182 allow hosts = 150\.203\.5\.\. The full syntax of the list is described in the man page
    3183 \fIhosts_access(5)\fR\. Note that this man page may not be present on your system, so a brief description will be given here also\.
    3184 .sp
    3185 Note that the localhost address 127\.0\.0\.1 will always be allowed access unless specifically denied by a
    3186 \fIhosts deny\fR
    3187 option\.
    3188 .sp
    3189 You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\. The
     3748\m[blue]\fBallow hosts\fR\m[]\&.
     3749.sp
     3750This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\&.
     3751.sp
     3752If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\&.
     3753.sp
     3754You 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
     3755\FCallow hosts = 150\&.203\&.5\&.\F[]\&. The full syntax of the list is described in the man page
     3756\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\&.
     3757.sp
     3758Note that the localhost address 127\&.0\&.0\&.1 will always be allowed access unless specifically denied by a
     3759\m[blue]\fBhosts deny\fR\m[]
     3760option\&.
     3761.sp
     3762You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\&. The
    31903763\fIEXCEPT\fR
    3191 keyword can also be used to limit a wildcard list\. The following examples may provide some help:
    3192 .sp
    3193 Example 1: allow all IPs in 150\.203\.*\.*; except one
    3194 .sp
    3195 hosts allow = 150\.203\. EXCEPT 150\.203\.6\.66
     3764keyword can also be used to limit a wildcard list\&. The following examples may provide some help:
     3765.sp
     3766Example 1: allow all IPs in 150\&.203\&.*\&.*; except one
     3767.sp
     3768\FChosts allow = 150\&.203\&. EXCEPT 150\&.203\&.6\&.66\F[]
    31963769.sp
    31973770Example 2: allow hosts that match the given network/netmask
    31983771.sp
    3199 hosts allow = 150\.203\.15\.0/255\.255\.255\.0
     3772\FChosts allow = 150\&.203\&.15\&.0/255\&.255\&.255\&.0\F[]
    32003773.sp
    32013774Example 3: allow a couple of hosts
    32023775.sp
    3203 hosts allow = lapland, arvidsjaur
     3776\FChosts allow = lapland, arvidsjaur\F[]
    32043777.sp
    32053778Example 4: allow only hosts in NIS netgroup "foonet", but deny access from one particular host
    32063779.sp
    3207 hosts allow = @foonet
    3208 .sp
    3209 hosts deny = pirate
    3210 .sp
     3780\FChosts allow = @foonet\F[]
     3781.sp
     3782\FChosts deny = pirate\F[]
     3783.if n \{\
     3784.sp
     3785.\}
     3786.RS 4
     3787.BM yellow
    32113788.it 1 an-trap
    32123789.nr an-no-space-flag 1
    32133790.nr an-break-flag 1
    32143791.br
    3215 Note
    3216 Note that access still requires suitable user\-level passwords\.
    3217 
     3792.ps +1
     3793\fBNote\fR
     3794.ps -1
     3795.br
     3796Note that access still requires suitable user\-level passwords\&.
     3797.sp .5v
     3798.EM yellow
     3799.RE
    32183800See
    32193801\fBtestparm\fR(1)
    3220 for a way of testing your host access to see if it does what you expect\.
    3221 .sp
    3222 Default:
    3223 \fI\fIhosts allow\fR\fR\fI = \fR\fI # none (i\.e\., all hosts permitted access)\fR\fI \fR
    3224 .sp
    3225 Example:
    3226 \fI\fIhosts allow\fR\fR\fI = \fR\fI150\.203\.5\. myhost\.mynet\.edu\.au\fR\fI \fR
     3802for a way of testing your host access to see if it does what you expect\&.
     3803.sp
     3804Default:
     3805\fI\fIhosts allow\fR\fR\fI = \fR\fI\FC # none (i\&.e\&., all hosts permitted access)\F[]\fR\fI \fR
     3806.sp
     3807Example:
     3808\fI\fIhosts allow\fR\fR\fI = \fR\fI\FC150\&.203\&.5\&. myhost\&.mynet\&.edu\&.au\F[]\fR\fI \fR
    32273809.RE
    32283810
    32293811deny hosts
     3812.\" deny hosts
    32303813.PP
    32313814.RS 4
    32323815This parameter is a synonym for
    3233 hosts deny\.
     3816hosts deny\&.
    32343817.RE
    32353818
    32363819hosts deny (S)
     3820.\" hosts deny
    32373821.PP
    32383822.RS 4
     
    32413825\- hosts listed here are
    32423826\fINOT\fR
    3243 permitted access to services unless the specific services have their own lists to override this one\. Where the lists conflict, the
     3827permitted access to services unless the specific services have their own lists to override this one\&. Where the lists conflict, the
    32443828\fIallow\fR
    3245 list takes precedence\.
     3829list takes precedence\&.
    32463830.sp
    32473831In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask
    3248 0\.0\.0\.0/0) and then explicitly specify to the
    3249 \fIhosts allow = hosts allow\fR
    3250 parameter those hosts that should be permitted access\.
    3251 .sp
    3252 Default:
    3253 \fI\fIhosts deny\fR\fR\fI = \fR\fI # none (i\.e\., no hosts specifically excluded)\fR\fI \fR
    3254 .sp
    3255 Example:
    3256 \fI\fIhosts deny\fR\fR\fI = \fR\fI150\.203\.4\. badhost\.mynet\.edu\.au\fR\fI \fR
     3832\FC0\&.0\&.0\&.0/0\F[]) and then explicitly specify to the
     3833\m[blue]\fBhosts allow = hosts allow\fR\m[]
     3834parameter those hosts that should be permitted access\&.
     3835.sp
     3836Default:
     3837\fI\fIhosts deny\fR\fR\fI = \fR\fI\FC # none (i\&.e\&., no hosts specifically excluded)\F[]\fR\fI \fR
     3838.sp
     3839Example:
     3840\fI\fIhosts deny\fR\fR\fI = \fR\fI\FC150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\F[]\fR\fI \fR
    32573841.RE
    32583842
    32593843idmap alloc backend (G)
    3260 .PP
    3261 .RS 4
    3262 The idmap alloc backend provides a plugin interface for Winbind to use when allocating Unix uids/gids for Windows SIDs\. This option is to be used in conjunction with the
    3263 \fIidmap domains\fR
    3264 parameter and 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\.
     3844.\" idmap alloc backend
     3845.PP
     3846.RS 4
     3847The idmap alloc backend provides a plugin interface for Winbind to use when allocating Unix uids/gids for Windows SIDs\&. This option is to be used in conjunction with the
     3848\m[blue]\fBidmap domains\fR\m[]
     3849parameter and 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\&.
    32653850.sp
    32663851Also refer to the
    3267 \fIidmap alloc config\fR
    3268 option\.
     3852\m[blue]\fBidmap alloc config\fR\m[]
     3853option\&.
    32693854.sp
    32703855\fINo default\fR
    32713856.sp
    32723857Example:
    3273 \fI\fIidmap alloc backend\fR\fR\fI = \fR\fItdb\fR\fI \fR
     3858\fI\fIidmap alloc backend\fR\fR\fI = \fR\fI\FCtdb\F[]\fR\fI \fR
    32743859.RE
    32753860
    32763861idmap alloc config (G)
     3862.\" idmap alloc config
    32773863.PP
    32783864.RS 4
    32793865The idmap alloc config prefix provides a means of managing settings for the backend defined by the
    3280 \fIidmap alloc backend\fR
    3281 parameter\. Refer to the man page for each idmap plugin regarding specific configuration details\.
     3866\m[blue]\fBidmap alloc backend\fR\m[]
     3867parameter\&. Refer to the man page for each idmap plugin regarding specific configuration details\&.
    32823868.sp
    32833869\fINo default\fR
     
    32853871
    32863872idmap backend (G)
    3287 .PP
    3288 .RS 4
    3289 The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables\. This option is mutually exclusive with the newer and more flexible
    3290 \fIidmap domains\fR
    3291 parameter\. The main difference between the "idmap backend" and the "idmap domains" is that the former only allows one backend for all domains while the latter supports configuring backends on a per domain basis\.
    3292 .sp
    3293 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_tdb\fR(8))\.
    3294 .sp
    3295 Default:
    3296 \fI\fIidmap backend\fR\fR\fI = \fR\fItdb\fR\fI \fR
     3873.\" idmap backend
     3874.PP
     3875.RS 4
     3876The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables\&. This option is mutually exclusive with the newer and more flexible
     3877\m[blue]\fBidmap domains\fR\m[]
     3878parameter\&. The main difference between the "idmap backend" and the "idmap domains" is that the former only allows one backend for all domains while the latter supports configuring backends on a per domain basis\&.
     3879.sp
     3880Examples of SID/uid/gid backends include tdb (\fBidmap_tdb\fR(8)), ldap (\fBidmap_ldap\fR(8)), rid (\fBidmap_rid\fR(8)), and ad (\fBidmap_tdb\fR(8))\&.
     3881.sp
     3882Default:
     3883\fI\fIidmap backend\fR\fR\fI = \fR\fI\FCtdb\F[]\fR\fI \fR
    32973884.RE
    32983885
    32993886idmap cache time (G)
    3300 .PP
    3301 .RS 4
    3302 This parameter specifies the number of seconds that Winbind\'s idmap interface will cache positive SID/uid/gid query results\.
    3303 .sp
    3304 Default:
    3305 \fI\fIidmap cache time\fR\fR\fI = \fR\fI900\fR\fI \fR
     3887.\" idmap cache time
     3888.PP
     3889.RS 4
     3890This parameter specifies the number of seconds that Winbind\'s idmap interface will cache positive SID/uid/gid query results\&.
     3891.sp
     3892Default:
     3893\fI\fIidmap cache time\fR\fR\fI = \fR\fI\FC900\F[]\fR\fI \fR
    33063894.RE
    33073895
    33083896idmap config (G)
     3897.\" idmap config
    33093898.PP
    33103899.RS 4
    33113900The idmap config prefix provides a means of managing each domain defined by the
    3312 \fIidmap domains\fR
    3313 option using Samba\'s parametric option support\. 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:
     3901\m[blue]\fBidmap domains\fR\m[]
     3902option using Samba\'s parametric option support\&. 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:
    33143903.PP
    33153904backend = backend_name
    33163905.RS 4
    3317 Specifies the name of the idmap plugin to use as the SID/uid/gid backend for this domain\.
     3906Specifies the name of the idmap plugin to use as the SID/uid/gid backend for this domain\&.
    33183907.RE
    33193908.PP
    33203909default = [yes|no]
    33213910.RS 4
    3322 The default domain/backend will be used for searching for users and groups not belonging to one of the explicitly listed domains (matched by comparing the account SID and the domain SID)\.
     3911The default domain/backend will be used for searching for users and groups not belonging to one of the explicitly listed domains (matched by comparing the account SID and the domain SID)\&.
    33233912.RE
    33243913.PP
     
    33263915.RS 4
    33273916Mark the domain as readonly which means that no attempts to allocate a uid or gid (by the
    3328 \fIidmap alloc backend\fR) for any user or group in that domain will be attempted\.
     3917\m[blue]\fBidmap alloc backend\fR\m[]) for any user or group in that domain will be attempted\&.
    33293918.RE
    33303919.sp
     
    33333922for the CORP domain and the
    33343923\fBidmap_tdb\fR(8)
    3335 backend for all other domains\. The TRUSTEDDOMAINS string is simply an arbitrary key used to reference the "idmap config" settings and does not represent the actual name of a domain\. It is a catchall domain backend for any domain not explicitly listed\.
    3336 .sp
    3337 .RS 4
     3924backend for all other domains\&. The TRUSTEDDOMAINS string is simply an arbitrary key used to reference the "idmap config" settings and does not represent the actual name of a domain\&. It is a catchall domain backend for any domain not explicitly listed\&.
     3925.sp
     3926.if n \{\
     3927.RS 4
     3928.\}
     3929.fam C
     3930.ps -1
    33383931.nf
     3932.if t \{\
     3933.sp -1
     3934.\}
     3935.BB lightgray adjust-for-leading-newline
     3936.sp -1
     3937
    33393938        idmap domains = CORP TRUSTEDDOMAINS
    33403939
     
    33463945        idmap config TRUSTEDDOMAINS:range   = 1000 \- 9999
    33473946       
     3947.EB lightgray adjust-for-leading-newline
     3948.if t \{\
     3949.sp 1
     3950.\}
    33483951.fi
    3349 .RE
     3952.fam
     3953.ps +1
     3954.if n \{\
     3955.RE
     3956.\}
     3957.sp
    33503958\fINo default\fR
    33513959.RE
    33523960
    33533961idmap domains (G)
    3354 .PP
    3355 .RS 4
    3356 The idmap domains option defines a list of Windows domains which will each have a separately configured backend for managing Winbind\'s SID/uid/gid tables\. This parameter is mutually exclusive with the older
    3357 \fIidmap backend\fR
    3358 option\.
    3359 .sp
    3360 Values consist of the short domain name for Winbind\'s primary or collection of trusted domains\. You may also use an arbitrary string to represent a catchall domain backend for any domain not explicitly listed\.
     3962.\" idmap domains
     3963.PP
     3964.RS 4
     3965The idmap domains option defines a list of Windows domains which will each have a separately configured backend for managing Winbind\'s SID/uid/gid tables\&. This parameter is mutually exclusive with the older
     3966\m[blue]\fBidmap backend\fR\m[]
     3967option\&.
     3968.sp
     3969Values consist of the short domain name for Winbind\'s primary or collection of trusted domains\&. You may also use an arbitrary string to represent a catchall domain backend for any domain not explicitly listed\&.
    33613970.sp
    33623971Refer to the
    3363 \fIidmap config\fR
    3364 for details about managing the SID/uid/gid backend for each domain\.
     3972\m[blue]\fBidmap config\fR\m[]
     3973for details about managing the SID/uid/gid backend for each domain\&.
    33653974.sp
    33663975\fINo default\fR
    33673976.sp
    33683977Example:
    3369 \fI\fIidmap domains\fR\fR\fI = \fR\fIdefault AD CORP\fR\fI \fR
     3978\fI\fIidmap domains\fR\fR\fI = \fR\fI\FCdefault AD CORP\F[]\fR\fI \fR
    33703979.RE
    33713980
    33723981winbind gid
     3982.\" winbind gid
    33733983.PP
    33743984.RS 4
    33753985This parameter is a synonym for
    3376 idmap gid\.
     3986idmap gid\&.
    33773987.RE
    33783988
    33793989idmap gid (G)
    3380 .PP
    3381 .RS 4
    3382 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\.
     3990.\" idmap gid
     3991.PP
     3992.RS 4
     3993The 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\&.
    33833994.sp
    33843995See also the
    3385 \fIidmap backend\fR,
    3386 \fIidmap domains\fR, and
    3387 \fIidmap config\fR
    3388 options\.
    3389 .sp
    3390 Default:
    3391 \fI\fIidmap gid\fR\fR\fI = \fR\fI\fR\fI \fR
    3392 .sp
    3393 Example:
    3394 \fI\fIidmap gid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR
     3996\m[blue]\fBidmap backend\fR\m[],
     3997\m[blue]\fBidmap domains\fR\m[], and
     3998\m[blue]\fBidmap config\fR\m[]
     3999options\&.
     4000.sp
     4001Default:
     4002\fI\fIidmap gid\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4003.sp
     4004Example:
     4005\fI\fIidmap gid\fR\fR\fI = \fR\fI\FC10000\-20000\F[]\fR\fI \fR
    33954006.RE
    33964007
    33974008idmap negative cache time (G)
    3398 .PP
    3399 .RS 4
    3400 This parameter specifies the number of seconds that Winbind\'s idmap interface will cache negative SID/uid/gid query results\.
    3401 .sp
    3402 Default:
    3403 \fI\fIidmap negative cache time\fR\fR\fI = \fR\fI120\fR\fI \fR
     4009.\" idmap negative cache time
     4010.PP
     4011.RS 4
     4012This parameter specifies the number of seconds that Winbind\'s idmap interface will cache negative SID/uid/gid query results\&.
     4013.sp
     4014Default:
     4015\fI\fIidmap negative cache time\fR\fR\fI = \fR\fI\FC120\F[]\fR\fI \fR
    34044016.RE
    34054017
    34064018winbind uid
     4019.\" winbind uid
    34074020.PP
    34084021.RS 4
    34094022This parameter is a synonym for
    3410 idmap uid\.
     4023idmap uid\&.
    34114024.RE
    34124025
    34134026idmap uid (G)
    3414 .PP
    3415 .RS 4
    3416 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\.
     4027.\" idmap uid
     4028.PP
     4029.RS 4
     4030The 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\&.
    34174031.sp
    34184032See also the
    3419 \fIidmap backend\fR,
    3420 \fIidmap domains\fR, and
    3421 \fIidmap config\fR
    3422 options\.
    3423 .sp
    3424 Default:
    3425 \fI\fIidmap uid\fR\fR\fI = \fR\fI\fR\fI \fR
    3426 .sp
    3427 Example:
    3428 \fI\fIidmap uid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR
     4033\m[blue]\fBidmap backend\fR\m[],
     4034\m[blue]\fBidmap domains\fR\m[], and
     4035\m[blue]\fBidmap config\fR\m[]
     4036options\&.
     4037.sp
     4038Default:
     4039\fI\fIidmap uid\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4040.sp
     4041Example:
     4042\fI\fIidmap uid\fR\fR\fI = \fR\fI\FC10000\-20000\F[]\fR\fI \fR
    34294043.RE
    34304044
    34314045include (G)
    3432 .PP
    3433 .RS 4
    3434 This allows you to include one config file inside another\. The file is included literally, as though typed in place\.
     4046.\" include
     4047.PP
     4048.RS 4
     4049This allows you to include one config file inside another\&. The file is included literally, as though typed in place\&.
    34354050.sp
    34364051It takes the standard substitutions, except
     
    34384053\fI%P\fR
    34394054and
    3440 \fI%S\fR\.
    3441 .sp
    3442 Default:
    3443 \fI\fIinclude\fR\fR\fI = \fR\fI\fR\fI \fR
    3444 .sp
    3445 Example:
    3446 \fI\fIinclude\fR\fR\fI = \fR\fI/usr/local/samba/lib/admin_smb\.conf\fR\fI \fR
     4055\fI%S\fR\&.
     4056.sp
     4057Default:
     4058\fI\fIinclude\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4059.sp
     4060Example:
     4061\fI\fIinclude\fR\fR\fI = \fR\fI\FC/usr/local/samba/lib/admin_smb\&.conf\F[]\fR\fI \fR
    34474062.RE
    34484063
    34494064inherit acls (S)
    3450 .PP
    3451 .RS 4
    3452 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\.
    3453 .sp
    3454 Default:
    3455 \fI\fIinherit acls\fR\fR\fI = \fR\fIno\fR\fI \fR
     4065.\" inherit acls
     4066.PP
     4067.RS 4
     4068This 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\&.
     4069.sp
     4070Default:
     4071\fI\fIinherit acls\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    34564072.RE
    34574073
    34584074inherit owner (S)
    3459 .PP
    3460 .RS 4
    3461 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\.
    3462 .sp
    3463 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\.
    3464 .sp
    3465 Default:
    3466 \fI\fIinherit owner\fR\fR\fI = \fR\fIno\fR\fI \fR
     4075.\" inherit owner
     4076.PP
     4077.RS 4
     4078The 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\&.
     4079.sp
     4080Common 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\&.
     4081.sp
     4082Default:
     4083\fI\fIinherit owner\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    34674084.RE
    34684085
    34694086inherit permissions (S)
     4087.\" inherit permissions
    34704088.PP
    34714089.RS 4
    34724090The permissions on new files and directories are normally governed by
    3473 \fIcreate mask\fR,
    3474 \fIdirectory mask\fR,
    3475 \fIforce create mode\fR
     4091\m[blue]\fBcreate mask\fR\m[],
     4092\m[blue]\fBdirectory mask\fR\m[],
     4093\m[blue]\fBforce create mode\fR\m[]
    34764094and
    3477 \fIforce directory mode\fR
    3478 but the boolean inherit permissions parameter overrides this\.
    3479 .sp
    3480 New directories inherit the mode of the parent directory, including bits such as setgid\.
    3481 .sp
    3482 New files inherit their read/write bits from the parent directory\. Their execute bits continue to be determined by
    3483 \fImap archive\fR,
    3484 \fImap hidden\fR
     4095\m[blue]\fBforce directory mode\fR\m[]
     4096but the boolean inherit permissions parameter overrides this\&.
     4097.sp
     4098New directories inherit the mode of the parent directory, including bits such as setgid\&.
     4099.sp
     4100New files inherit their read/write bits from the parent directory\&. Their execute bits continue to be determined by
     4101\m[blue]\fBmap archive\fR\m[],
     4102\m[blue]\fBmap hidden\fR\m[]
    34854103and
    3486 \fImap system\fR
    3487 as usual\.
     4104\m[blue]\fBmap system\fR\m[]
     4105as usual\&.
    34884106.sp
    34894107Note that the setuid bit is
    34904108\fInever\fR
    3491 set via inheritance (the code explicitly prohibits this)\.
    3492 .sp
    3493 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\.
    3494 .sp
    3495 Default:
    3496 \fI\fIinherit permissions\fR\fR\fI = \fR\fIno\fR\fI \fR
     4109set via inheritance (the code explicitly prohibits this)\&.
     4110.sp
     4111This 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\&.
     4112.sp
     4113Default:
     4114\fI\fIinherit permissions\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    34974115.RE
    34984116
    34994117interfaces (G)
    3500 .PP
    3501 .RS 4
    3502 This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other 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\.
    3503 .sp
    3504 The option takes a list of interface strings\. Each string can be in any of the following forms:
    3505 .sp
    3506 .RS 4
    3507 .ie n \{\
    3508 \h'-04'\(bu\h'+03'\c
    3509 .\}
    3510 .el \{\
    3511 .sp -1
    3512 .IP \(bu 2.3
    3513 .\}
    3514 a network interface name (such as eth0)\. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth"
    3515 .RE
    3516 .sp
    3517 .RS 4
    3518 .ie n \{\
    3519 \h'-04'\(bu\h'+03'\c
    3520 .\}
    3521 .el \{\
    3522 .sp -1
    3523 .IP \(bu 2.3
    3524 .\}
    3525 an IP address\. In this case the netmask is determined from the list of interfaces obtained from the kernel
    3526 .RE
    3527 .sp
    3528 .RS 4
    3529 .ie n \{\
    3530 \h'-04'\(bu\h'+03'\c
    3531 .\}
    3532 .el \{\
    3533 .sp -1
    3534 .IP \(bu 2.3
    3535 .\}
    3536 an IP/mask pair\.
    3537 .RE
    3538 .sp
    3539 .RS 4
    3540 .ie n \{\
    3541 \h'-04'\(bu\h'+03'\c
    3542 .\}
    3543 .el \{\
    3544 .sp -1
    3545 .IP \(bu 2.3
    3546 .\}
    3547 a broadcast/mask pair\.
    3548 .sp
    3549 .RE
    3550 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\.
    3551 .sp
    3552 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\.
    3553 .sp
    3554 By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\.0\.0\.1)\.
    3555 .sp
    3556 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\.
    3557 .sp
    3558 Default:
    3559 \fI\fIinterfaces\fR\fR\fI = \fR\fI\fR\fI \fR
    3560 .sp
    3561 Example:
    3562 \fI\fIinterfaces\fR\fR\fI = \fR\fIeth0 192\.168\.2\.10/24 192\.168\.3\.10/255\.255\.255\.0\fR\fI \fR
     4118.\" interfaces
     4119.PP
     4120.RS 4
     4121This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other 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\&.
     4122.sp
     4123The option takes a list of interface strings\&. Each string can be in any of the following forms:
     4124.sp
     4125.RS 4
     4126.ie n \{\
     4127\h'-04'\(bu\h'+03'\c
     4128.\}
     4129.el \{\
     4130.sp -1
     4131.IP \(bu 2.3
     4132.\}
     4133a network interface name (such as eth0)\&. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth"
     4134.RE
     4135.sp
     4136.RS 4
     4137.ie n \{\
     4138\h'-04'\(bu\h'+03'\c
     4139.\}
     4140.el \{\
     4141.sp -1
     4142.IP \(bu 2.3
     4143.\}
     4144an IP address\&. In this case the netmask is determined from the list of interfaces obtained from the kernel
     4145.RE
     4146.sp
     4147.RS 4
     4148.ie n \{\
     4149\h'-04'\(bu\h'+03'\c
     4150.\}
     4151.el \{\
     4152.sp -1
     4153.IP \(bu 2.3
     4154.\}
     4155an IP/mask pair\&.
     4156.RE
     4157.sp
     4158.RS 4
     4159.ie n \{\
     4160\h'-04'\(bu\h'+03'\c
     4161.\}
     4162.el \{\
     4163.sp -1
     4164.IP \(bu 2.3
     4165.\}
     4166a broadcast/mask pair\&.
     4167.sp
     4168.RE
     4169The "mask" parameters can either be a bit length (such as 24 for a C class network) or a full netmask in dotted decimal form\&.
     4170.sp
     4171The "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\&.
     4172.sp
     4173By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\&.0\&.0\&.1)\&.
     4174.sp
     4175The 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\&.
     4176.sp
     4177Default:
     4178\fI\fIinterfaces\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4179.sp
     4180Example:
     4181\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
    35634182.RE
    35644183
    35654184invalid users (S)
    3566 .PP
    3567 .RS 4
    3568 This is a list of users that should not be allowed to login to this service\. This is really a
     4185.\" invalid users
     4186.PP
     4187.RS 4
     4188This is a list of users that should not be allowed to login to this service\&. This is really a
    35694189\fIparanoid\fR
    3570 check to absolutely ensure an improper setting does not breach your security\.
    3571 .sp
    3572 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\.
    3573 .sp
    3574 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
     4190check to absolutely ensure an improper setting does not breach your security\&.
     4191.sp
     4192A 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\&.
     4193.sp
     4194A 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
    35754195\fI+&group\fR
    35764196means check the UNIX group database, followed by the NIS netgroup database, and the value
    35774197\fI&+group\fR
    3578 means check the NIS netgroup database, followed by the UNIX group database (the same as the \'@\' prefix)\.
     4198means check the NIS netgroup database, followed by the UNIX group database (the same as the \'@\' prefix)\&.
    35794199.sp
    35804200The current servicename is substituted for
    3581 \fI%S\fR\. This is useful in the [homes] section\.
    3582 .sp
    3583 Default:
    3584 \fI\fIinvalid users\fR\fR\fI = \fR\fI # no invalid users\fR\fI \fR
    3585 .sp
    3586 Example:
    3587 \fI\fIinvalid users\fR\fR\fI = \fR\fIroot fred admin @wheel\fR\fI \fR
     4201\fI%S\fR\&. This is useful in the [homes] section\&.
     4202.sp
     4203Default:
     4204\fI\fIinvalid users\fR\fR\fI = \fR\fI\FC # no invalid users\F[]\fR\fI \fR
     4205.sp
     4206Example:
     4207\fI\fIinvalid users\fR\fR\fI = \fR\fI\FCroot fred admin @wheel\F[]\fR\fI \fR
    35884208.RE
    35894209
    35904210iprint server (G)
     4211.\" iprint server
    35914212.PP
    35924213.RS 4
    35934214This parameter is only applicable if
    3594 \fIprinting\fR
     4215\m[blue]\fBprinting\fR\m[]
    35954216is set to
    3596 \fBiprint\fR\.
     4217\fBiprint\fR\&.
    35974218.sp
    35984219If set, this option overrides the ServerName option in the CUPS
    3599 \fIclient\.conf\fR\. This is necessary if you have virtual samba servers that connect to different CUPS daemons\.
    3600 .sp
    3601 Default:
    3602 \fI\fIiprint server\fR\fR\fI = \fR\fI""\fR\fI \fR
    3603 .sp
    3604 Example:
    3605 \fI\fIiprint server\fR\fR\fI = \fR\fIMYCUPSSERVER\fR\fI \fR
     4220\FCclient\&.conf\F[]\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
     4221.sp
     4222Default:
     4223\fI\fIiprint server\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
     4224.sp
     4225Example:
     4226\fI\fIiprint server\fR\fR\fI = \fR\fI\FCMYCUPSSERVER\F[]\fR\fI \fR
    36064227.RE
    36074228
    36084229keepalive (G)
     4230.\" keepalive
    36094231.PP
    36104232.RS 4
    36114233The value of the parameter (an integer) represents the number of seconds between
    36124234\fIkeepalive\fR
    3613 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\.
    3614 .sp
    3615 Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\. (see
    3616 \fIsocket options\fR)\. Basically you should only use this option if you strike difficulties\.
    3617 .sp
    3618 Default:
    3619 \fI\fIkeepalive\fR\fR\fI = \fR\fI300\fR\fI \fR
    3620 .sp
    3621 Example:
    3622 \fI\fIkeepalive\fR\fR\fI = \fR\fI600\fR\fI \fR
     4235packets\&. 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\&.
     4236.sp
     4237Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\&. (see
     4238\m[blue]\fBsocket options\fR\m[])\&. Basically you should only use this option if you strike difficulties\&.
     4239.sp
     4240Default:
     4241\fI\fIkeepalive\fR\fR\fI = \fR\fI\FC300\F[]\fR\fI \fR
     4242.sp
     4243Example:
     4244\fI\fIkeepalive\fR\fR\fI = \fR\fI\FC600\F[]\fR\fI \fR
    36234245.RE
    36244246
    36254247kernel change notify (S)
    3626 .PP
    3627 .RS 4
    3628 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\.
    3629 .sp
    3630 This parameter is only used when your kernel supports change notification to user programs using the inotify interface\.
    3631 .sp
    3632 Default:
    3633 \fI\fIkernel change notify\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4248.\" kernel change notify
     4249.PP
     4250.RS 4
     4251This 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\&.
     4252.sp
     4253This parameter is only used when your kernel supports change notification to user programs using the inotify interface\&.
     4254.sp
     4255Default:
     4256\fI\fIkernel change notify\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    36344257.RE
    36354258
    36364259kernel oplocks (G)
     4260.\" kernel oplocks
    36374261.PP
    36384262.RS 4
    36394263For UNIXes that support kernel based
    3640 \fIoplocks\fR
    3641 (currently only IRIX and the Linux 2\.4 kernel), this parameter allows the use of them to be turned on or off\.
     4264\m[blue]\fBoplocks\fR\m[]
     4265(currently only IRIX and the Linux 2\&.4 kernel), this parameter allows the use of them to be turned on or off\&.
    36424266.sp
    36434267Kernel oplocks support allows Samba
     
    36454269to be broken whenever a local UNIX process or NFS operation accesses a file that
    36464270\fBsmbd\fR(8)
    3647 has oplocked\. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a
     4271has oplocked\&. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a
    36484272\fIvery\fR
    3649 cool feature :\-)\.
     4273cool feature :\-)\&.
    36504274.sp
    36514275This parameter defaults to
    3652 \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\.
    3653 .sp
    3654 Default:
    3655 \fI\fIkernel oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4276\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\&.
     4277.sp
     4278Default:
     4279\fI\fIkernel oplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    36564280.RE
    36574281
    36584282lanman auth (G)
     4283.\" lanman auth
    36594284.PP
    36604285.RS 4
    36614286This parameter determines whether or not
    36624287\fBsmbd\fR(8)
    3663 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\.
    3664 .sp
    3665 The LANMAN encrypted response is easily broken, due to it\'s case\-insensitive nature, and the choice of algorithm\. Servers without Windows 95/98/ME or MS DOS clients are advised to disable this option\.
     4288will 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\&.
     4289.sp
     4290The LANMAN encrypted response is easily broken, due to it\'s case\-insensitive nature, and the choice of algorithm\&. Servers without Windows 95/98/ME or MS DOS clients are advised to disable this option\&.
    36664291.sp
    36674292Unlike the
    3668 encrypt passwords
    3669 option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\. See the
    3670 client lanman auth
     4293\FCencrypt passwords\F[]
     4294option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\&. See the
     4295\FCclient lanman auth\F[]
    36714296to disable this for Samba\'s clients (such as smbclient)
    36724297.sp
    36734298If this option, and
    3674 ntlm auth
    3675 are both disabled, then only NTLMv2 logins will be permited\. Not all clients support NTLMv2, and most will require special configuration to use it\.
    3676 .sp
    3677 Default:
    3678 \fI\fIlanman auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4299\FCntlm auth\F[]
     4300are both disabled, then only NTLMv2 logins will be permited\&. Not all clients support NTLMv2, and most will require special configuration to use it\&.
     4301.sp
     4302Default:
     4303\fI\fIlanman auth\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    36794304.RE
    36804305
    36814306large readwrite (G)
     4307.\" large readwrite
    36824308.PP
    36834309.RS 4
    36844310This parameter determines whether or not
    36854311\fBsmbd\fR(8)
    3686 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\.
    3687 .sp
    3688 Default:
    3689 \fI\fIlarge readwrite\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4312supports 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\&.
     4313.sp
     4314Default:
     4315\fI\fIlarge readwrite\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    36904316.RE
    36914317
    36924318ldap admin dn (G)
     4319.\" ldap admin dn
    36934320.PP
    36944321.RS 4
    36954322The
    3696 \fIldap admin dn\fR
    3697 defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information\. The
    3698 \fIldap admin dn\fR
     4323\m[blue]\fBldap admin dn\fR\m[]
     4324defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information\&. The
     4325\m[blue]\fBldap admin dn\fR\m[]
    36994326is used in conjunction with the admin dn password stored in the
    3700 \fIprivate/secrets\.tdb\fR
    3701 file\. See the
     4327\FCprivate/secrets\&.tdb\F[]
     4328file\&. See the
    37024329\fBsmbpasswd\fR(8)
    3703 man page for more information on how to accomplish this\.
     4330man page for more information on how to accomplish this\&.
    37044331.sp
    37054332The
    3706 \fIldap admin dn\fR
    3707 requires a fully specified DN\. The
    3708 \fIldap suffix\fR
     4333\m[blue]\fBldap admin dn\fR\m[]
     4334requires a fully specified DN\&. The
     4335\m[blue]\fBldap suffix\fR\m[]
    37094336is not appended to the
    3710 \fIldap admin dn\fR\.
     4337\m[blue]\fBldap admin dn\fR\m[]\&.
    37114338.sp
    37124339\fINo default\fR
     
    37144341
    37154342ldap delete dn (G)
    3716 .PP
    3717 .RS 4
    3718 This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\.
    3719 .sp
    3720 Default:
    3721 \fI\fIldap delete dn\fR\fR\fI = \fR\fIno\fR\fI \fR
     4343.\" ldap delete dn
     4344.PP
     4345.RS 4
     4346This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\&.
     4347.sp
     4348Default:
     4349\fI\fIldap delete dn\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    37224350.RE
    37234351
    37244352ldap group suffix (G)
    3725 .PP
    3726 .RS 4
    3727 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
    3728 \fIldap suffix\fR
    3729 will be used instead\. The suffix string is pre\-pended to the
    3730 \fIldap suffix\fR
    3731 string so use a partial DN\.
    3732 .sp
    3733 Default:
    3734 \fI\fIldap group suffix\fR\fR\fI = \fR\fI\fR\fI \fR
    3735 .sp
    3736 Example:
    3737 \fI\fIldap group suffix\fR\fR\fI = \fR\fIou=Groups\fR\fI \fR
     4353.\" ldap group suffix
     4354.PP
     4355.RS 4
     4356This 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
     4357\m[blue]\fBldap suffix\fR\m[]
     4358will be used instead\&. The suffix string is pre\-pended to the
     4359\m[blue]\fBldap suffix\fR\m[]
     4360string so use a partial DN\&.
     4361.sp
     4362Default:
     4363\fI\fIldap group suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4364.sp
     4365Example:
     4366\fI\fIldap group suffix\fR\fR\fI = \fR\fI\FCou=Groups\F[]\fR\fI \fR
    37384367.RE
    37394368
    37404369ldap idmap suffix (G)
    3741 .PP
    3742 .RS 4
    3743 This parameters specifies the suffix that is used when storing idmap mappings\. If this parameter is unset, the value of
    3744 \fIldap suffix\fR
    3745 will be used instead\. The suffix string is pre\-pended to the
    3746 \fIldap suffix\fR
    3747 string so use a partial DN\.
    3748 .sp
    3749 Default:
    3750 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\fR\fI \fR
    3751 .sp
    3752 Example:
    3753 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fIou=Idmap\fR\fI \fR
     4370.\" ldap idmap suffix
     4371.PP
     4372.RS 4
     4373This parameters specifies the suffix that is used when storing idmap mappings\&. If this parameter is unset, the value of
     4374\m[blue]\fBldap suffix\fR\m[]
     4375will be used instead\&. The suffix string is pre\-pended to the
     4376\m[blue]\fBldap suffix\fR\m[]
     4377string so use a partial DN\&.
     4378.sp
     4379Default:
     4380\fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4381.sp
     4382Example:
     4383\fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\FCou=Idmap\F[]\fR\fI \fR
    37544384.RE
    37554385
    37564386ldap machine suffix (G)
    3757 .PP
    3758 .RS 4
    3759 It specifies where machines should be added to the ldap tree\. If this parameter is unset, the value of
    3760 \fIldap suffix\fR
    3761 will be used instead\. The suffix string is pre\-pended to the
    3762 \fIldap suffix\fR
    3763 string so use a partial DN\.
    3764 .sp
    3765 Default:
    3766 \fI\fIldap machine suffix\fR\fR\fI = \fR\fI\fR\fI \fR
    3767 .sp
    3768 Example:
    3769 \fI\fIldap machine suffix\fR\fR\fI = \fR\fIou=Computers\fR\fI \fR
     4387.\" ldap machine suffix
     4388.PP
     4389.RS 4
     4390It specifies where machines should be added to the ldap tree\&. If this parameter is unset, the value of
     4391\m[blue]\fBldap suffix\fR\m[]
     4392will be used instead\&. The suffix string is pre\-pended to the
     4393\m[blue]\fBldap suffix\fR\m[]
     4394string so use a partial DN\&.
     4395.sp
     4396Default:
     4397\fI\fIldap machine suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4398.sp
     4399Example:
     4400\fI\fIldap machine suffix\fR\fR\fI = \fR\fI\FCou=Computers\F[]\fR\fI \fR
    37704401.RE
    37714402
    37724403ldap passwd sync (G)
    3773 .PP
    3774 .RS 4
    3775 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\.
     4404.\" ldap passwd sync
     4405.PP
     4406.RS 4
     4407This 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\&.
    37764408.sp
    37774409The
    3778 \fIldap passwd sync\fR
     4410\m[blue]\fBldap passwd sync\fR\m[]
    37794411can be set to one of three values:
    37804412.sp
     
    37884420.\}
    37894421\fIYes\fR
    3790 = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\.
     4422= Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\&.
    37914423.RE
    37924424.sp
     
    38004432.\}
    38014433\fINo\fR
    3802 = Update NT and LM passwords and update the pwdLastSet time\.
     4434= Update NT and LM passwords and update the pwdLastSet time\&.
    38034435.RE
    38044436.sp
     
    38124444.\}
    38134445\fIOnly\fR
    3814 = Only update the LDAP password and let the LDAP server do the rest\.
    3815 .sp
    3816 .RE
    3817 Default:
    3818 \fI\fIldap passwd sync\fR\fR\fI = \fR\fIno\fR\fI \fR
     4446= Only update the LDAP password and let the LDAP server do the rest\&.
     4447.sp
     4448.RE
     4449Default:
     4450\fI\fIldap passwd sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    38194451.RE
    38204452
    38214453ldap replication sleep (G)
    3822 .PP
    3823 .RS 4
    3824 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\.
    3825 .sp
    3826 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\.
    3827 .sp
    3828 The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\.
    3829 .sp
    3830 Default:
    3831 \fI\fIldap replication sleep\fR\fR\fI = \fR\fI1000\fR\fI \fR
     4454.\" ldap replication sleep
     4455.PP
     4456.RS 4
     4457When 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\&.
     4458.sp
     4459This 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\&.
     4460.sp
     4461The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\&.
     4462.sp
     4463Default:
     4464\fI\fIldap replication sleep\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
    38324465.RE
    38334466
    38344467ldapsam:editposix (G)
    3835 .PP
    3836 .RS 4
    3837 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\.
    3838 .sp
    3839 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
    3840 net sam provision\. 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
    3841 \fIldapsam:trusted = yes\fR
     4468.\" ldapsam:editposix
     4469.PP
     4470.RS 4
     4471Editposix 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\&.
     4472.sp
     4473To 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
     4474\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
     4475\m[blue]\fBldapsam:trusted = yes\fR\m[]
    38424476option is usually sufficient to use
    3843 \fIldapsam:editposix = yes\fR
    3844 as well\.
     4477\m[blue]\fBldapsam:editposix = yes\fR\m[]
     4478as well\&.
    38454479.sp
    38464480An example configuration can be the following:
    38474481.sp
    3848 .RS 4
     4482.if n \{\
     4483.RS 4
     4484.\}
     4485.fam C
     4486.ps -1
    38494487.nf
     4488.if t \{\
     4489.sp -1
     4490.\}
     4491.BB lightgray adjust-for-leading-newline
     4492.sp -1
     4493
    38504494        encrypt passwords = true
    38514495        passdb backend = ldapsam
     
    38674511        idmap gid = 5000\-50000
    38684512       
     4513.EB lightgray adjust-for-leading-newline
     4514.if t \{\
     4515.sp 1
     4516.\}
    38694517.fi
    3870 .RE
     4518.fam
     4519.ps +1
     4520.if n \{\
     4521.RE
     4522.\}
    38714523.sp
    38724524This configuration assume the ldap server have been loaded with a base tree like described in the following ldif:
    38734525.sp
    3874 .RS 4
     4526.if n \{\
     4527.RS 4
     4528.\}
     4529.fam C
     4530.ps -1
    38754531.nf
     4532.if t \{\
     4533.sp -1
     4534.\}
     4535.BB lightgray adjust-for-leading-newline
     4536.sp -1
     4537
    38764538        dn: dc=samba,dc=org
    38774539        objectClass: top
    38784540        objectClass: dcObject
    38794541        objectClass: organization
    3880         o: samba\.org
     4542        o: samba\&.org
    38814543        dc: samba
    38824544
     
    39084570        ou: computers
    39094571       
     4572.EB lightgray adjust-for-leading-newline
     4573.if t \{\
     4574.sp 1
     4575.\}
    39104576.fi
    3911 .RE
    3912 .sp
    3913 .sp
    3914 Default:
    3915 \fI\fIldapsam:editposix\fR\fR\fI = \fR\fIno\fR\fI \fR
     4577.fam
     4578.ps +1
     4579.if n \{\
     4580.RE
     4581.\}
     4582.sp
     4583Default:
     4584\fI\fIldapsam:editposix\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    39164585.RE
    39174586
    39184587ldapsam:trusted (G)
    3919 .PP
    3920 .RS 4
    3921 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\.
     4588.\" ldapsam:trusted
     4589.PP
     4590.RS 4
     4591By 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\&.
    39224592.sp
    39234593To make Samba scale well in large environments, the
    3924 \fIldapsam:trusted = yes\fR
    3925 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,
    3926 \fIldapsam:trusted = yes\fR
    3927 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\.
    3928 .sp
    3929 Default:
    3930 \fI\fIldapsam:trusted\fR\fR\fI = \fR\fIno\fR\fI \fR
     4594\m[blue]\fBldapsam:trusted = yes\fR\m[]
     4595option 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,
     4596\m[blue]\fBldapsam:trusted = yes\fR\m[]
     4597can 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\&.
     4598.sp
     4599Default:
     4600\fI\fIldapsam:trusted\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    39314601.RE
    39324602
    39334603ldap ssl (G)
     4604.\" ldap ssl
    39344605.PP
    39354606.RS 4
     
    39374608\fINOT\fR
    39384609related to Samba\'s previous SSL support which was enabled by specifying the
    3939 \-\-with\-ssl
     4610\FC\-\-with\-ssl\F[]
    39404611option to the
    3941 \fIconfigure\fR
    3942 script\.
     4612\FCconfigure\F[]
     4613script\&.
     4614.sp
     4615LDAP connections should be secured where possible\&. This may be done setting either this parameter to
     4616\fIStart_tls\fR
     4617or by specifying
     4618\fIldaps://\fR
     4619in the URL argument of
     4620\m[blue]\fBpassdb backend\fR\m[]\&.
    39434621.sp
    39444622The
    3945 \fIldap ssl\fR
    3946 can be set to one of three values:
     4623\m[blue]\fBldap ssl\fR\m[]
     4624can be set to one of two values:
    39474625.sp
    39484626.RS 4
     
    39554633.\}
    39564634\fIOff\fR
    3957 = Never use SSL when querying the directory\.
     4635= Never use SSL when querying the directory\&.
    39584636.RE
    39594637.sp
     
    39674645.\}
    39684646\fIStart_tls\fR
    3969 = Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\.
    3970 .RE
    3971 .sp
    3972 .RS 4
    3973 .ie n \{\
    3974 \h'-04'\(bu\h'+03'\c
    3975 .\}
    3976 .el \{\
    3977 .sp -1
    3978 .IP \(bu 2.3
    3979 .\}
    3980 \fIOn\fR
    3981 = Use SSL on the ldaps port when contacting the
    3982 \fIldap server\fR\. Only available when the backwards\-compatiblity
    3983 \-\-with\-ldapsam
    3984 option is specified to configure\. See
    3985 \fIpassdb backend\fR
    3986 \.
    3987                 .sp
    3988 .RE
    3989 Default:
    3990 \fI\fIldap ssl\fR\fR\fI = \fR\fIstart_tls\fR\fI \fR
     4647= Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\&.
     4648.sp
     4649.RE
     4650Default:
     4651\fI\fIldap ssl\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    39914652.RE
    39924653
    39934654ldap suffix (G)
    3994 .PP
    3995 .RS 4
    3996 Specifies the base for all ldap suffixes and for storing the sambaDomain object\.
     4655.\" ldap suffix
     4656.PP
     4657.RS 4
     4658Specifies the base for all ldap suffixes and for storing the sambaDomain object\&.
    39974659.sp
    39984660The ldap suffix will be appended to the values specified for the
    3999 \fIldap user suffix\fR,
    4000 \fIldap group suffix\fR,
    4001 \fIldap machine suffix\fR, and the
    4002 \fIldap idmap suffix\fR\. Each of these should be given only a DN relative to the
    4003 \fIldap suffix\fR\.
    4004 .sp
    4005 Default:
    4006 \fI\fIldap suffix\fR\fR\fI = \fR\fI\fR\fI \fR
    4007 .sp
    4008 Example:
    4009 \fI\fIldap suffix\fR\fR\fI = \fR\fIdc=samba,dc=org\fR\fI \fR
     4661\m[blue]\fBldap user suffix\fR\m[],
     4662\m[blue]\fBldap group suffix\fR\m[],
     4663\m[blue]\fBldap machine suffix\fR\m[], and the
     4664\m[blue]\fBldap idmap suffix\fR\m[]\&. Each of these should be given only a DN relative to the
     4665\m[blue]\fBldap suffix\fR\m[]\&.
     4666.sp
     4667Default:
     4668\fI\fIldap suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4669.sp
     4670Example:
     4671\fI\fIldap suffix\fR\fR\fI = \fR\fI\FCdc=samba,dc=org\F[]\fR\fI \fR
    40104672.RE
    40114673
    40124674ldap timeout (G)
    4013 .PP
    4014 .RS 4
    4015 When Samba connects to an ldap server that servermay be down or unreachable\. To prevent Samba from hanging whilst waiting for the connection this parameter specifies in seconds how long Samba should wait before failing the connect\. The default is to only wait fifteen seconds for the ldap server to respond to the connect request\.
    4016 .sp
    4017 Default:
    4018 \fI\fIldap timeout\fR\fR\fI = \fR\fI15\fR\fI \fR
     4675.\" ldap timeout
     4676.PP
     4677.RS 4
     4678When Samba connects to an ldap server that servermay be down or unreachable\&. To prevent Samba from hanging whilst waiting for the connection this parameter specifies in seconds how long Samba should wait before failing the connect\&. The default is to only wait fifteen seconds for the ldap server to respond to the connect request\&.
     4679.sp
     4680Default:
     4681\fI\fIldap timeout\fR\fR\fI = \fR\fI\FC15\F[]\fR\fI \fR
    40194682.RE
    40204683
    40214684ldap user suffix (G)
    4022 .PP
    4023 .RS 4
    4024 This parameter specifies where users are added to the tree\. If this parameter is unset, the value of
    4025 \fIldap suffix\fR
    4026 will be used instead\. The suffix string is pre\-pended to the
    4027 \fIldap suffix\fR
    4028 string so use a partial DN\.
    4029 .sp
    4030 Default:
    4031 \fI\fIldap user suffix\fR\fR\fI = \fR\fI\fR\fI \fR
    4032 .sp
    4033 Example:
    4034 \fI\fIldap user suffix\fR\fR\fI = \fR\fIou=people\fR\fI \fR
     4685.\" ldap user suffix
     4686.PP
     4687.RS 4
     4688This parameter specifies where users are added to the tree\&. If this parameter is unset, the value of
     4689\m[blue]\fBldap suffix\fR\m[]
     4690will be used instead\&. The suffix string is pre\-pended to the
     4691\m[blue]\fBldap suffix\fR\m[]
     4692string so use a partial DN\&.
     4693.sp
     4694Default:
     4695\fI\fIldap user suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4696.sp
     4697Example:
     4698\fI\fIldap user suffix\fR\fR\fI = \fR\fI\FCou=people\F[]\fR\fI \fR
    40354699.RE
    40364700
    40374701level2 oplocks (S)
    4038 .PP
    4039 .RS 4
    4040 This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\.
    4041 .sp
    4042 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)\.
    4043 .sp
    4044 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\.
    4045 .sp
    4046 It is recommended that this parameter be turned on to speed access to shared executables\.
    4047 .sp
    4048 For more discussions on level2 oplocks see the CIFS spec\.
     4702.\" level2 oplocks
     4703.PP
     4704.RS 4
     4705This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\&.
     4706.sp
     4707Level2, 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)\&.
     4708.sp
     4709Once 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\&.
     4710.sp
     4711It is recommended that this parameter be turned on to speed access to shared executables\&.
     4712.sp
     4713For more discussions on level2 oplocks see the CIFS spec\&.
    40494714.sp
    40504715Currently, if
    4051 \fIkernel oplocks\fR
     4716\m[blue]\fBkernel oplocks\fR\m[]
    40524717are supported then level2 oplocks are not granted (even if this parameter is set to
    4053 \fByes\fR)\. Note also, the
    4054 \fIoplocks\fR
     4718\fByes\fR)\&. Note also, the
     4719\m[blue]\fBoplocks\fR\m[]
    40554720parameter must be set to
    40564721\fByes\fR
    4057 on this share in order for this parameter to have any effect\.
    4058 .sp
    4059 Default:
    4060 \fI\fIlevel2 oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4722on this share in order for this parameter to have any effect\&.
     4723.sp
     4724Default:
     4725\fI\fIlevel2 oplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    40614726.RE
    40624727
    40634728lm announce (G)
     4729.\" lm announce
    40644730.PP
    40654731.RS 4
    40664732This parameter determines if
    40674733\fBnmbd\fR(8)
    4068 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,
     4734will 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,
    40694735\fByes\fR,
    40704736\fBno\fR, or
    4071 \fBauto\fR\. The default is
    4072 \fBauto\fR\. If set to
     4737\fBauto\fR\&. The default is
     4738\fBauto\fR\&. If set to
    40734739\fBno\fR
    4074 Samba will never produce these broadcasts\. If set to
     4740Samba will never produce these broadcasts\&. If set to
    40754741\fByes\fR
    40764742Samba will produce Lanman announce broadcasts at a frequency set by the parameter
    4077 \fIlm interval\fR\. If set to
     4743\m[blue]\fBlm interval\fR\m[]\&. If set to
    40784744\fBauto\fR
    4079 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
    4080 \fIlm interval\fR\.
    4081 .sp
    4082 Default:
    4083 \fI\fIlm announce\fR\fR\fI = \fR\fIauto\fR\fI \fR
    4084 .sp
    4085 Example:
    4086 \fI\fIlm announce\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4745Samba 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
     4746\m[blue]\fBlm interval\fR\m[]\&.
     4747.sp
     4748Default:
     4749\fI\fIlm announce\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
     4750.sp
     4751Example:
     4752\fI\fIlm announce\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    40874753.RE
    40884754
    40894755lm interval (G)
     4756.\" lm interval
    40904757.PP
    40914758.RS 4
    40924759If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the
    4093 \fIlm announce\fR
    4094 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
    4095 \fIlm announce\fR
    4096 parameter\.
    4097 .sp
    4098 Default:
    4099 \fI\fIlm interval\fR\fR\fI = \fR\fI60\fR\fI \fR
    4100 .sp
    4101 Example:
    4102 \fI\fIlm interval\fR\fR\fI = \fR\fI120\fR\fI \fR
     4760\m[blue]\fBlm announce\fR\m[]
     4761parameter) 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
     4762\m[blue]\fBlm announce\fR\m[]
     4763parameter\&.
     4764.sp
     4765Default:
     4766\fI\fIlm interval\fR\fR\fI = \fR\fI\FC60\F[]\fR\fI \fR
     4767.sp
     4768Example:
     4769\fI\fIlm interval\fR\fR\fI = \fR\fI\FC120\F[]\fR\fI \fR
    41034770.RE
    41044771
    41054772load printers (G)
    4106 .PP
    4107 .RS 4
    4108 A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\. See the
    4109 \fIprinters\fR
    4110 section for more details\.
    4111 .sp
    4112 Default:
    4113 \fI\fIload printers\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4773.\" load printers
     4774.PP
     4775.RS 4
     4776A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\&. See the
     4777\m[blue]\fBprinters\fR\m[]
     4778section for more details\&.
     4779.sp
     4780Default:
     4781\fI\fIload printers\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    41144782.RE
    41154783
    41164784local master (G)
     4785.\" local master
    41174786.PP
    41184787.RS 4
    41194788This option allows
    41204789\fBnmbd\fR(8)
    4121 to try and become a local master browser on a subnet\. If set to
     4790to try and become a local master browser on a subnet\&. If set to
    41224791\fBno\fR
    41234792then
    4124 nmbd
    4125 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
    4126 \fByes\fR\. Setting this value to
     4793\FC nmbd\F[]
     4794will 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
     4795\fByes\fR\&. Setting this value to
    41274796\fByes\fR
    41284797doesn\'t mean that Samba will
    41294798\fIbecome\fR
    41304799the local master browser on a subnet, just that
    4131 nmbd
     4800\FCnmbd\F[]
    41324801will
    41334802\fIparticipate\fR
    4134 in elections for local master browser\.
     4803in elections for local master browser\&.
    41354804.sp
    41364805Setting this value to
    41374806\fBno\fR
    41384807will cause
    4139 nmbd
     4808\FCnmbd\F[]
    41404809\fInever\fR
    4141 to become a local master browser\.
    4142 .sp
    4143 Default:
    4144 \fI\fIlocal master\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4810to become a local master browser\&.
     4811.sp
     4812Default:
     4813\fI\fIlocal master\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    41454814.RE
    41464815
    41474816lock dir
     4817.\" lock dir
    41484818.PP
    41494819.RS 4
    41504820This parameter is a synonym for
    4151 lock directory\.
     4821lock directory\&.
    41524822.RE
    41534823
    41544824lock directory (G)
    4155 .PP
    4156 .RS 4
    4157 This option specifies the directory where lock files will be placed\. The lock files are used to implement the
    4158 \fImax connections\fR
    4159 option\.
    4160 .sp
    4161 Default:
    4162 \fI\fIlock directory\fR\fR\fI = \fR\fI${prefix}/var/locks\fR\fI \fR
    4163 .sp
    4164 Example:
    4165 \fI\fIlock directory\fR\fR\fI = \fR\fI/var/run/samba/locks\fR\fI \fR
     4825.\" lock directory
     4826.PP
     4827.RS 4
     4828This option specifies the directory where lock files will be placed\&. The lock files are used to implement the
     4829\m[blue]\fBmax connections\fR\m[]
     4830option\&.
     4831.sp
     4832Default:
     4833\fI\fIlock directory\fR\fR\fI = \fR\fI\FC${prefix}/var/locks\F[]\fR\fI \fR
     4834.sp
     4835Example:
     4836\fI\fIlock directory\fR\fR\fI = \fR\fI\FC/var/run/samba/locks\F[]\fR\fI \fR
    41664837.RE
    41674838
    41684839locking (S)
    4169 .PP
    4170 .RS 4
    4171 This controls whether or not locking will be performed by the server in response to lock requests from the client\.
     4840.\" locking
     4841.PP
     4842.RS 4
     4843This controls whether or not locking will be performed by the server in response to lock requests from the client\&.
    41724844.sp
    41734845If
    4174 locking = no, all lock and unlock requests will appear to succeed and all lock queries will report that the file in question is available for locking\.
     4846\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\&.
    41754847.sp
    41764848If
    4177 locking = yes, real locking will be performed by the server\.
     4849\FClocking = yes\F[], real locking will be performed by the server\&.
    41784850.sp
    41794851This option
     
    41834855not need locking (such as CDROM drives), although setting this parameter of
    41844856\fBno\fR
    4185 is not really recommended even in this case\.
    4186 .sp
    4187 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\.
     4857is not really recommended even in this case\&.
     4858.sp
     4859Be 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\&.
    41884860.sp
    41894861\fINo default\fR
     
    41914863
    41924864lock spin count (G)
    4193 .PP
    4194 .RS 4
    4195 This parameter has been made inoperative in Samba 3\.0\.24\. The functionality it contolled is now controlled by the parameter
    4196 \fIlock spin time\fR\.
    4197 .sp
    4198 Default:
    4199 \fI\fIlock spin count\fR\fR\fI = \fR\fI0\fR\fI \fR
     4865.\" lock spin count
     4866.PP
     4867.RS 4
     4868This parameter has been made inoperative in Samba 3\&.0\&.24\&. The functionality it contolled is now controlled by the parameter
     4869\m[blue]\fBlock spin time\fR\m[]\&.
     4870.sp
     4871Default:
     4872\fI\fIlock spin count\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    42004873.RE
    42014874
    42024875lock spin time (G)
    4203 .PP
    4204 .RS 4
    4205 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
    4206 \fIlock spin count\fR
    4207 parameter is no longer used in Samba 3\.0\.24\. You should not need to change the value of this parameter\.
    4208 .sp
    4209 Default:
    4210 \fI\fIlock spin time\fR\fR\fI = \fR\fI200\fR\fI \fR
     4876.\" lock spin time
     4877.PP
     4878.RS 4
     4879The 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
     4880\m[blue]\fBlock spin count\fR\m[]
     4881parameter is no longer used in Samba 3\&.0\&.24\&. You should not need to change the value of this parameter\&.
     4882.sp
     4883Default:
     4884\fI\fIlock spin time\fR\fR\fI = \fR\fI\FC200\F[]\fR\fI \fR
    42114885.RE
    42124886
    42134887log file (G)
    4214 .PP
    4215 .RS 4
    4216 This option allows you to override the name of the Samba log file (also known as the debug file)\.
    4217 .sp
    4218 This option takes the standard substitutions, allowing you to have separate log files for each user or machine\.
     4888.\" log file
     4889.PP
     4890.RS 4
     4891This option allows you to override the name of the Samba log file (also known as the debug file)\&.
     4892.sp
     4893This option takes the standard substitutions, allowing you to have separate log files for each user or machine\&.
    42194894.sp
    42204895\fINo default\fR
    42214896.sp
    42224897Example:
    4223 \fI\fIlog file\fR\fR\fI = \fR\fI/usr/local/samba/var/log\.%m\fR\fI \fR
     4898\fI\fIlog file\fR\fR\fI = \fR\fI\FC/usr/local/samba/var/log\&.%m\F[]\fR\fI \fR
    42244899.RE
    42254900
    42264901debuglevel
     4902.\" debuglevel
    42274903.PP
    42284904.RS 4
    42294905This parameter is a synonym for
    4230 log level\.
     4906log level\&.
    42314907.RE
    42324908
    42334909log level (G)
     4910.\" log level
    42344911.PP
    42354912.RS 4
    42364913The value of the parameter (a astring) allows the debug level (logging level) to be specified in the
    4237 \fIsmb\.conf\fR
    4238 file\.
    4239 .sp
    4240 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:
     4914\FCsmb\&.conf\F[]
     4915file\&.
     4916.sp
     4917This 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:
    42414918.sp
    42424919.RS 4
     
    44615138.RE
    44625139Default:
    4463 \fI\fIlog level\fR\fR\fI = \fR\fI0\fR\fI \fR
    4464 .sp
    4465 Example:
    4466 \fI\fIlog level\fR\fR\fI = \fR\fI3 passdb:5 auth:10 winbind:2\fR\fI \fR
     5140\fI\fIlog level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     5141.sp
     5142Example:
     5143\fI\fIlog level\fR\fR\fI = \fR\fI\FC3 passdb:5 auth:10 winbind:2\F[]\fR\fI \fR
    44675144.RE
    44685145
    44695146logon drive (G)
     5147.\" logon drive
    44705148.PP
    44715149.RS 4
    44725150This parameter specifies the local path to which the home directory will be connected (see
    4473 \fIlogon home\fR) and is only used by NT Workstations\.
    4474 .sp
    4475 Note that this option is only useful if Samba is set up as a logon server\.
    4476 .sp
    4477 Default:
    4478 \fI\fIlogon drive\fR\fR\fI = \fR\fI\fR\fI \fR
    4479 .sp
    4480 Example:
    4481 \fI\fIlogon drive\fR\fR\fI = \fR\fIh:\fR\fI \fR
     5151\m[blue]\fBlogon home\fR\m[]) and is only used by NT Workstations\&.
     5152.sp
     5153Note that this option is only useful if Samba is set up as a logon server\&.
     5154.sp
     5155Default:
     5156\fI\fIlogon drive\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     5157.sp
     5158Example:
     5159\fI\fIlogon drive\fR\fR\fI = \fR\fI\FCh:\F[]\fR\fI \fR
    44825160.RE
    44835161
    44845162logon home (G)
    4485 .PP
    4486 .RS 4
    4487 This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\. It allows you to do
    4488 .sp
    4489 
    4490 C:\e>\fBNET USE H: /HOME\fR
    4491 .sp
    4492 from a command prompt, for example\.
    4493 .sp
    4494 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\.
    4495 .sp
    4496 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:
    4497 .sp
    4498 
    4499 logon home = \e\e%N\e%U\eprofile
    4500 .sp
    4501 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
    4502 net use /home
    4503 but use the whole string when dealing with profiles\.
     5163.\" logon home
     5164.PP
     5165.RS 4
     5166This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\&. It allows you to do
     5167.sp
     5168
     5169\FCC:\e>\F[]\fBNET USE H: /HOME\fR
     5170.sp
     5171from a command prompt, for example\&.
     5172.sp
     5173This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
     5174.sp
     5175This 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:
     5176.sp
     5177
     5178\FClogon home = \e\e%N\e%U\eprofile\F[]
     5179.sp
     5180This 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
     5181\FCnet use /home\F[]
     5182but use the whole string when dealing with profiles\&.
    45045183.sp
    45055184Note that in prior versions of Samba, the
    4506 \fIlogon path\fR
     5185\m[blue]\fBlogon path\fR\m[]
    45075186was returned rather than
    4508 \fIlogon home\fR\. This broke
    4509 net use /home
    4510 but allowed profiles outside the home directory\. The current implementation is correct, and can be used for profiles if you use the above trick\.
     5187\fIlogon home\fR\&. This broke
     5188\FCnet use /home\F[]
     5189but allowed profiles outside the home directory\&. The current implementation is correct, and can be used for profiles if you use the above trick\&.
    45115190.sp
    45125191Disable this feature by setting
    4513 \fIlogon home = ""\fR
    4514 \- using the empty string\.
    4515 .sp
    4516 This option is only useful if Samba is set up as a logon server\.
    4517 .sp
    4518 Default:
    4519 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\e%N\e%U\fR\fI \fR
    4520 .sp
    4521 Example:
    4522 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\eremote_smb_server\e%U\fR\fI \fR
     5192\m[blue]\fBlogon home = ""\fR\m[]
     5193\- using the empty string\&.
     5194.sp
     5195This option is only useful if Samba is set up as a logon server\&.
     5196.sp
     5197Default:
     5198\fI\fIlogon home\fR\fR\fI = \fR\fI\FC\e\e%N\e%U\F[]\fR\fI \fR
     5199.sp
     5200Example:
     5201\fI\fIlogon home\fR\fR\fI = \fR\fI\FC\e\eremote_smb_server\e%U\F[]\fR\fI \fR
    45235202.RE
    45245203
    45255204logon path (G)
    4526 .PP
    4527 .RS 4
    4528 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
    4529 \fIlogon home\fR
    4530 parameter\.
    4531 .sp
    4532 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",
    4533 \fIdesktop\fR,
    4534 \fIstart menu\fR,
    4535 \fInetwork neighborhood\fR,
    4536 \fIprograms\fR
    4537 and other folders, and their contents, are loaded and displayed on your Windows NT client\.
    4538 .sp
    4539 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
    4540 \fIMAN\fRdatory profile)\.
    4541 .sp
    4542 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)\.
    4543 .sp
    4544 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\.
    4545 .sp
     5205.\" logon path
     5206.PP
     5207.RS 4
     5208This 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
     5209\m[blue]\fBlogon home\fR\m[]
     5210parameter\&.
     5211.sp
     5212This 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",
     5213\FCdesktop\F[],
     5214\FCstart menu\F[],
     5215\FCnetwork neighborhood\F[],
     5216\FCprograms\F[]
     5217and other folders, and their contents, are loaded and displayed on your Windows NT client\&.
     5218.sp
     5219The 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
     5220\fIMAN\fRdatory profile)\&.
     5221.sp
     5222Windows 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)\&.
     5223.sp
     5224This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
     5225.if n \{\
     5226.sp
     5227.\}
     5228.RS 4
     5229.BM yellow
    45465230.it 1 an-trap
    45475231.nr an-no-space-flag 1
    45485232.nr an-break-flag 1
    45495233.br
    4550 Warning
    4551 Do not quote the value\. Setting this as
     5234.ps +1
     5235\fBWarning\fR
     5236.ps -1
     5237.br
     5238Do not quote the value\&. Setting this as
    45525239\(lq\e\e%N\eprofile\e%U\(rq
    4553 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)\.
    4554 
    4555 Note that this option is only useful if Samba is set up as a domain controller\.
    4556 .sp
    4557 Disable the use of roaming profiles by setting the value of this parameter to the empty string\. For example,
    4558 \fIlogon path = ""\fR\. 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\.
     5240will 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)\&.
     5241.sp .5v
     5242.EM yellow
     5243.RE
     5244Note that this option is only useful if Samba is set up as a domain controller\&.
     5245.sp
     5246Disable the use of roaming profiles by setting the value of this parameter to the empty string\&. For example,
     5247\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\&.
    45595248.sp
    45605249An example of use is:
    45615250.sp
    4562 .RS 4
     5251.if n \{\
     5252.RS 4
     5253.\}
     5254.fam C
     5255.ps -1
    45635256.nf
     5257.if t \{\
     5258.sp -1
     5259.\}
     5260.BB lightgray adjust-for-leading-newline
     5261.sp -1
     5262
    45645263logon path = \e\ePROFILESERVER\ePROFILE\e%U
     5264.EB lightgray adjust-for-leading-newline
     5265.if t \{\
     5266.sp 1
     5267.\}
    45655268.fi
    4566 .RE
    4567 .sp
    4568 .sp
    4569 Default:
    4570 \fI\fIlogon path\fR\fR\fI = \fR\fI\e\e%N\e%U\eprofile\fR\fI \fR
     5269.fam
     5270.ps +1
     5271.if n \{\
     5272.RE
     5273.\}
     5274.sp
     5275Default:
     5276\fI\fIlogon path\fR\fR\fI = \fR\fI\FC\e\e%N\e%U\eprofile\F[]\fR\fI \fR
    45715277.RE
    45725278
    45735279logon script (G)
    4574 .PP
    4575 .RS 4
    4576 This parameter specifies the batch file (\fI\.bat\fR) or NT command file (\fI\.cmd\fR) 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\.
     5280.\" logon script
     5281.PP
     5282.RS 4
     5283This 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\&.
    45775284.sp
    45785285The script must be a relative path to the
    45795286\fI[netlogon]\fR
    4580 service\. If the [netlogon] service specifies a
    4581 \fIpath\fR
     5287service\&. If the [netlogon] service specifies a
     5288\m[blue]\fBpath\fR\m[]
    45825289of
    4583 \fI/usr/local/samba/netlogon\fR, and
    4584 \fIlogon script = STARTUP\.BAT\fR, then the file that will be downloaded is:
    4585 .sp
    4586 .RS 4
     5290\FC/usr/local/samba/netlogon\F[], and
     5291\m[blue]\fBlogon script = STARTUP\&.BAT\fR\m[], then the file that will be downloaded is:
     5292.sp
     5293.if n \{\
     5294.RS 4
     5295.\}
     5296.fam C
     5297.ps -1
    45875298.nf
    4588         /usr/local/samba/netlogon/STARTUP\.BAT
     5299.if t \{\
     5300.sp -1
     5301.\}
     5302.BB lightgray adjust-for-leading-newline
     5303.sp -1
     5304
     5305        /usr/local/samba/netlogon/STARTUP\&.BAT
     5306.EB lightgray adjust-for-leading-newline
     5307.if t \{\
     5308.sp 1
     5309.\}
    45895310.fi
    4590 .RE
    4591 .sp
    4592 .sp
    4593 The contents of the batch file are entirely your choice\. A suggested command would be to add
    4594 NET TIME \e\eSERVER /SET /YES, to force every machine to synchronize clocks with the same time server\. Another use would be to add
    4595 NET USE U: \e\eSERVER\eUTILS
     5311.fam
     5312.ps +1
     5313.if n \{\
     5314.RE
     5315.\}
     5316.sp
     5317The contents of the batch file are entirely your choice\&. A suggested command would be to add
     5318\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
     5319\FCNET USE U: \e\eSERVER\eUTILS\F[]
    45965320for commonly used utilities, or
    45975321.sp
    4598 .RS 4
     5322.if n \{\
     5323.RS 4
     5324.\}
     5325.fam C
     5326.ps -1
    45995327.nf
     5328.if t \{\
     5329.sp -1
     5330.\}
     5331.BB lightgray adjust-for-leading-newline
     5332.sp -1
     5333
    46005334\fBNET USE Q: \e\eSERVER\eISO9001_QA\fR
     5335.EB lightgray adjust-for-leading-newline
     5336.if t \{\
     5337.sp 1
     5338.\}
    46015339.fi
    4602 .RE
    4603 .sp
    4604 for example\.
    4605 .sp
    4606 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\.
    4607 .sp
    4608 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\.
    4609 .sp
    4610 This option is only useful if Samba is set up as a logon server\.
    4611 .sp
    4612 Default:
    4613 \fI\fIlogon script\fR\fR\fI = \fR\fI\fR\fI \fR
    4614 .sp
    4615 Example:
    4616 \fI\fIlogon script\fR\fR\fI = \fR\fIscripts\e%U\.bat\fR\fI \fR
     5340.fam
     5341.ps +1
     5342.if n \{\
     5343.RE
     5344.\}
     5345.sp
     5346for example\&.
     5347.sp
     5348Note 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\&.
     5349.sp
     5350This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
     5351.sp
     5352This option is only useful if Samba is set up as a logon server\&.
     5353.sp
     5354Default:
     5355\fI\fIlogon script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     5356.sp
     5357Example:
     5358\fI\fIlogon script\fR\fR\fI = \fR\fI\FCscripts\e%U\&.bat\F[]\fR\fI \fR
    46175359.RE
    46185360
    46195361lppause command (S)
    4620 .PP
    4621 .RS 4
    4622 This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\.
    4623 .sp
    4624 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\.
     5362.\" lppause command
     5363.PP
     5364.RS 4
     5365This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\&.
     5366.sp
     5367This 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\&.
    46255368.sp
    46265369If a
    46275370\fI%p\fR
    4628 is given then the printer name is put in its place\. A
     5371is given then the printer name is put in its place\&. A
    46295372\fI%j\fR
    4630 is replaced with the job number (an integer)\. On HPUX (see
     5373is replaced with the job number (an integer)\&. On HPUX (see
    46315374\fIprinting=hpux \fR), if the
    46325375\fI\-p%p\fR
    4633 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\.
    4634 .sp
    4635 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\.
    4636 .sp
    4637 Default:
    4638 \fI\fIlppause command\fR\fR\fI = \fR\fI # Currently no default value is given to this string, unless the value of the \fIprinting\fR parameter is \fBSYSV\fR, in which case the default is : lp \-i %p\-%j \-H hold or if the value of the \fIprinting\fR parameter is \fBSOFTQ\fR, then the default is: qstat \-s \-j%j \-h\. \fR\fI \fR
    4639 .sp
    4640 Example:
    4641 \fI\fIlppause command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p0\fR\fI \fR
     5376option 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\&.
     5377.sp
     5378Note that it is good practice to include the absolute path in the lppause command as the PATH may not be available to the server\&.
     5379.sp
     5380Default:
     5381\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
     5382.sp
     5383Example:
     5384\fI\fIlppause command\fR\fR\fI = \fR\fI\FC/usr/bin/lpalt %p\-%j \-p0\F[]\fR\fI \fR
    46425385.RE
    46435386
    46445387lpq cache time (G)
     5388.\" lpq cache time
    46455389.PP
    46465390.RS 4
    46475391This controls how long lpq info will be cached for to prevent the
    4648 lpq
    4649 command being called too often\. A separate cache is kept for each variation of the
    4650 lpq
     5392\FClpq\F[]
     5393command being called too often\&. A separate cache is kept for each variation of the
     5394\FC lpq\F[]
    46515395command used by the system, so if you use different
    4652 lpq
    4653 commands for different users then they won\'t share cache information\.
     5396\FClpq\F[]
     5397commands for different users then they won\'t share cache information\&.
    46545398.sp
    46555399The cache files are stored in
    4656 \fI/tmp/lpq\.xxxx\fR
     5400\FC/tmp/lpq\&.xxxx\F[]
    46575401where xxxx is a hash of the
    4658 lpq
    4659 command in use\.
     5402\FClpq\F[]
     5403command in use\&.
    46605404.sp
    46615405The default is 30 seconds, meaning that the cached results of a previous identical
    4662 lpq
    4663 command will be used if the cached data is less than 30 seconds old\. A large value may be advisable if your
    4664 lpq
    4665 command is very slow\.
    4666 .sp
    4667 A value of 0 will disable caching completely\.
    4668 .sp
    4669 Default:
    4670 \fI\fIlpq cache time\fR\fR\fI = \fR\fI30\fR\fI \fR
    4671 .sp
    4672 Example:
    4673 \fI\fIlpq cache time\fR\fR\fI = \fR\fI10\fR\fI \fR
     5406\FClpq\F[]
     5407command will be used if the cached data is less than 30 seconds old\&. A large value may be advisable if your
     5408\FClpq\F[]
     5409command is very slow\&.
     5410.sp
     5411A value of 0 will disable caching completely\&.
     5412.sp
     5413Default:
     5414\fI\fIlpq cache time\fR\fR\fI = \fR\fI\FC30\F[]\fR\fI \fR
     5415.sp
     5416Example:
     5417\fI\fIlpq cache time\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
    46745418.RE
    46755419
    46765420lpq command (S)
     5421.\" lpq command
    46775422.PP
    46785423.RS 4
    46795424This parameter specifies the command to be executed on the server host in order to obtain
    4680 lpq\-style printer status information\.
    4681 .sp
    4682 This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\.
    4683 .sp
    4684 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
     5425\FClpq \F[]\-style printer status information\&.
     5426.sp
     5427This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\&.
     5428.sp
     5429Currently 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
    46855430\fIprinting =\fR
    4686 option\.
    4687 .sp
    4688 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\.
     5431option\&.
     5432.sp
     5433Some 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\&.
    46895434.sp
    46905435If a
    46915436\fI%p\fR
    4692 is given then the printer name is put in its place\. Otherwise it is placed at the end of the command\.
     5437is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
    46935438.sp
    46945439Note that it is good practice to include the absolute path in the
     
    46965441as the
    46975442\fB$PATH \fR
    4698 may not be available to the server\. When compiled with the CUPS libraries, no
     5443may not be available to the server\&. When compiled with the CUPS libraries, no
    46995444\fIlpq command\fR
    4700 is needed because smbd will make a library call to obtain the print queue listing\.
    4701 .sp
    4702 Default:
    4703 \fI\fIlpq command\fR\fR\fI = \fR\fI\fR\fI \fR
    4704 .sp
    4705 Example:
    4706 \fI\fIlpq command\fR\fR\fI = \fR\fI/usr/bin/lpq \-P%p\fR\fI \fR
     5445is needed because smbd will make a library call to obtain the print queue listing\&.
     5446.sp
     5447Default:
     5448\fI\fIlpq command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     5449.sp
     5450Example:
     5451\fI\fIlpq command\fR\fR\fI = \fR\fI\FC/usr/bin/lpq \-P%p\F[]\fR\fI \fR
    47075452.RE
    47085453
    47095454lpresume command (S)
    4710 .PP
    4711 .RS 4
    4712 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\.
    4713 .sp
    4714 This command should be a program or script which takes a printer name and job number to resume the print job\. See also the
    4715 \fIlppause command\fR
    4716 parameter\.
     5455.\" lpresume command
     5456.PP
     5457.RS 4
     5458This parameter specifies the command to be executed on the server host in order to restart or continue printing or spooling a specific print job\&.
     5459.sp
     5460This command should be a program or script which takes a printer name and job number to resume the print job\&. See also the
     5461\m[blue]\fBlppause command\fR\m[]
     5462parameter\&.
    47175463.sp
    47185464If a
    47195465\fI%p\fR
    4720 is given then the printer name is put in its place\. A
     5466is given then the printer name is put in its place\&. A
    47215467\fI%j\fR
    4722 is replaced with the job number (an integer)\.
     5468is replaced with the job number (an integer)\&.
    47235469.sp
    47245470Note that it is good practice to include the absolute path in the
    47255471\fIlpresume command\fR
    4726 as the PATH may not be available to the server\.
     5472as the PATH may not be available to the server\&.
    47275473.sp
    47285474See also the
    4729 \fIprinting\fR
    4730 parameter\.
     5475\m[blue]\fBprinting\fR\m[]
     5476parameter\&.
    47315477.sp
    47325478Default: Currently no default value is given to this string, unless the value of the
     
    47355481\fBSYSV\fR, in which case the default is:
    47365482.sp
    4737 lp \-i %p\-%j \-H resume
     5483\FClp \-i %p\-%j \-H resume\F[]
    47385484.sp
    47395485or if the value of the
     
    47425488\fBSOFTQ\fR, then the default is:
    47435489.sp
    4744 qstat \-s \-j%j \-r
     5490\FCqstat \-s \-j%j \-r\F[]
    47455491.sp
    47465492\fINo default\fR
    47475493.sp
    47485494Example:
    4749 \fI\fIlpresume command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p2\fR\fI \fR
     5495\fI\fIlpresume command\fR\fR\fI = \fR\fI\FC/usr/bin/lpalt %p\-%j \-p2\F[]\fR\fI \fR
    47505496.RE
    47515497
    47525498lprm command (S)
    4753 .PP
    4754 .RS 4
    4755 This parameter specifies the command to be executed on the server host in order to delete a print job\.
    4756 .sp
    4757 This command should be a program or script which takes a printer name and job number, and deletes the print job\.
     5499.\" lprm command
     5500.PP
     5501.RS 4
     5502This parameter specifies the command to be executed on the server host in order to delete a print job\&.
     5503.sp
     5504This command should be a program or script which takes a printer name and job number, and deletes the print job\&.
    47585505.sp
    47595506If a
    47605507\fI%p\fR
    4761 is given then the printer name is put in its place\. A
     5508is given then the printer name is put in its place\&. A
    47625509\fI%j\fR
    4763 is replaced with the job number (an integer)\.
     5510is replaced with the job number (an integer)\&.
    47645511.sp
    47655512Note that it is good practice to include the absolute path in the
    47665513\fIlprm command\fR
    4767 as the PATH may not be available to the server\.
     5514as the PATH may not be available to the server\&.
    47685515.sp
    47695516Examples of use are:
    47705517.sp
    4771 .RS 4
     5518.if n \{\
     5519.RS 4
     5520.\}
     5521.fam C
     5522.ps -1
    47725523.nf
     5524.if t \{\
     5525.sp -1
     5526.\}
     5527.BB lightgray adjust-for-leading-newline
     5528.sp -1
     5529
    47735530lprm command = /usr/bin/lprm \-P%p %j
    47745531
     
    47765533
    47775534lprm command = /usr/bin/cancel %p\-%j
     5535.EB lightgray adjust-for-leading-newline
     5536.if t \{\
     5537.sp 1
     5538.\}
    47785539.fi
    4779 .RE
    4780 .sp
    4781 .sp
    4782 Default:
    4783 \fI\fIlprm command\fR\fR\fI = \fR\fI determined by printing parameter\fR\fI \fR
     5540.fam
     5541.ps +1
     5542.if n \{\
     5543.RE
     5544.\}
     5545.sp
     5546Default:
     5547\fI\fIlprm command\fR\fR\fI = \fR\fI\FC determined by printing parameter\F[]\fR\fI \fR
    47845548.RE
    47855549
    47865550machine password timeout (G)
     5551.\" machine password timeout
    47875552.PP
    47885553.RS 4
    47895554If a Samba server is a member of a Windows NT Domain (see the
    4790 \fIsecurity = domain\fR
     5555\m[blue]\fBsecurity = domain\fR\m[]
    47915556parameter) then periodically a running smbd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called
    4792 \fIprivate/secrets\.tdb \fR\. 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\.
     5557\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\&.
    47935558.sp
    47945559See also
    47955560\fBsmbpasswd\fR(8), and the
    4796 \fIsecurity = domain\fR
    4797 parameter\.
    4798 .sp
    4799 Default:
    4800 \fI\fImachine password timeout\fR\fR\fI = \fR\fI604800\fR\fI \fR
     5561\m[blue]\fBsecurity = domain\fR\m[]
     5562parameter\&.
     5563.sp
     5564Default:
     5565\fI\fImachine password timeout\fR\fR\fI = \fR\fI\FC604800\F[]\fR\fI \fR
    48015566.RE
    48025567
    48035568magic output (S)
     5569.\" magic output
    48045570.PP
    48055571.RS 4
    48065572This parameter specifies the name of a file which will contain output created by a magic script (see the
    4807 \fImagic script\fR
    4808 parameter below)\.
    4809 .sp
     5573\m[blue]\fBmagic script\fR\m[]
     5574parameter below)\&.
     5575.if n \{\
     5576.sp
     5577.\}
     5578.RS 4
     5579.BM yellow
    48105580.it 1 an-trap
    48115581.nr an-no-space-flag 1
    48125582.nr an-break-flag 1
    48135583.br
    4814 Warning
     5584.ps +1
     5585\fBWarning\fR
     5586.ps -1
     5587.br
    48155588If two clients use the same
    48165589\fImagic script \fR
    4817 in the same directory the output file content is undefined\.
    4818 
    4819 Default:
    4820 \fI\fImagic output\fR\fR\fI = \fR\fI<magic script name>\.out\fR\fI \fR
    4821 .sp
    4822 Example:
    4823 \fI\fImagic output\fR\fR\fI = \fR\fImyfile\.txt\fR\fI \fR
     5590in the same directory the output file content is undefined\&.
     5591.sp .5v
     5592.EM yellow
     5593.RE
     5594Default:
     5595\fI\fImagic output\fR\fR\fI = \fR\fI\FC<magic script name>\&.out\F[]\fR\fI \fR
     5596.sp
     5597Example:
     5598\fI\fImagic output\fR\fR\fI = \fR\fI\FCmyfile\&.txt\F[]\fR\fI \fR
    48245599.RE
    48255600
    48265601magic script (S)
    4827 .PP
    4828 .RS 4
    4829 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\.
    4830 .sp
    4831 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\.
     5602.\" magic script
     5603.PP
     5604.RS 4
     5605This 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\&.
     5606.sp
     5607Scripts 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\&.
    48325608.sp
    48335609If the script generates output, output will be sent to the file specified by the
    4834 \fImagic output\fR
    4835 parameter (see above)\.
    4836 .sp
    4837 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
     5610\m[blue]\fBmagic output\fR\m[]
     5611parameter (see above)\&.
     5612.sp
     5613Note 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
    48385614\fIas is\fR
    4839 on the host, which for some hosts and some shells will require filtering at the DOS end\.
     5615on the host, which for some hosts and some shells will require filtering at the DOS end\&.
    48405616.sp
    48415617Magic scripts are
     
    48435619and should
    48445620\fINOT\fR
    4845 be relied upon\.
    4846 .sp
    4847 Default:
    4848 \fI\fImagic script\fR\fR\fI = \fR\fI\fR\fI \fR
    4849 .sp
    4850 Example:
    4851 \fI\fImagic script\fR\fR\fI = \fR\fIuser\.csh\fR\fI \fR
     5621be relied upon\&.
     5622.sp
     5623Default:
     5624\fI\fImagic script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     5625.sp
     5626Example:
     5627\fI\fImagic script\fR\fR\fI = \fR\fI\FCuser\&.csh\F[]\fR\fI \fR
    48525628.RE
    48535629
    48545630mangled map (S)
    4855 .PP
    4856 .RS 4
    4857 This is for those who want to directly map UNIX file names which cannot be represented on Windows/DOS\. The mangling of names is not always what is needed\. In particular you may have documents with file extensions that differ between DOS and UNIX\. For example, under UNIX it is common to use
    4858 \fI\.html\fR
     5631.\" mangled map
     5632.PP
     5633.RS 4
     5634This is for those who want to directly map UNIX file names which cannot be represented on Windows/DOS\&. The mangling of names is not always what is needed\&. In particular you may have documents with file extensions that differ between DOS and UNIX\&. For example, under UNIX it is common to use
     5635\FC\&.html\F[]
    48595636for HTML files, whereas under Windows/DOS
    4860 \fI\.htm\fR
    4861 is more commonly used\.
     5637\FC\&.htm\F[]
     5638is more commonly used\&.
    48625639.sp
    48635640So to map
    4864 \fIhtml\fR
     5641\FChtml\F[]
    48655642to
    4866 \fIhtm\fR
     5643\FChtm\F[]
    48675644you would use:
    48685645.sp
    48695646
    4870 \fImangled map = (*\.html *\.htm)\fR\.
     5647\m[blue]\fBmangled map = (*\&.html *\&.htm)\fR\m[]\&.
    48715648.sp
    48725649One very useful case is to remove the annoying
    4873 \fI;1\fR
    4874 off the ends of filenames on some CDROMs (only visible under some UNIXes)\. To do this use a map of (*;1 *;)\.
    4875 .sp
    4876 Default:
    4877 \fI\fImangled map\fR\fR\fI = \fR\fI # no mangled map\fR\fI \fR
    4878 .sp
    4879 Example:
    4880 \fI\fImangled map\fR\fR\fI = \fR\fI(*;1 *;)\fR\fI \fR
     5650\FC;1\F[]
     5651off the ends of filenames on some CDROMs (only visible under some UNIXes)\&. To do this use a map of (*;1 *;)\&.
     5652.sp
     5653Default:
     5654\fI\fImangled map\fR\fR\fI = \fR\fI\FC # no mangled map\F[]\fR\fI \fR
     5655.sp
     5656Example:
     5657\fI\fImangled map\fR\fR\fI = \fR\fI\FC(*;1 *;)\F[]\fR\fI \fR
    48815658.RE
    48825659
    48835660mangled names (S)
    4884 .PP
    4885 .RS 4
    4886 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\.
     5661.\" mangled names
     5662.PP
     5663.RS 4
     5664This 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\&.
    48875665.sp
    48885666See the section on
    4889 \fIname mangling\fR
    4890 for details on how to control the mangling process\.
     5667\m[blue]\fBname mangling\fR\m[]
     5668for details on how to control the mangling process\&.
    48915669.sp
    48925670If mangling is used then the mangling algorithm is as follows:
     
    49005678.IP \(bu 2.3
    49015679.\}
    4902 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\.
    4903 .RE
    4904 .sp
    4905 .RS 4
    4906 .ie n \{\
    4907 \h'-04'\(bu\h'+03'\c
    4908 .\}
    4909 .el \{\
    4910 .sp -1
    4911 .IP \(bu 2.3
    4912 .\}
    4913 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\.
     5680The 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\&.
     5681.RE
     5682.sp
     5683.RS 4
     5684.ie n \{\
     5685\h'-04'\(bu\h'+03'\c
     5686.\}
     5687.el \{\
     5688.sp -1
     5689.IP \(bu 2.3
     5690.\}
     5691A 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\&.
    49145692.sp
    49155693Note that the character to use may be specified using the
    4916 \fImangling char\fR
    4917 option, if you don\'t like \'~\'\.
    4918 .RE
    4919 .sp
    4920 .RS 4
    4921 .ie n \{\
    4922 \h'-04'\(bu\h'+03'\c
    4923 .\}
    4924 .el \{\
    4925 .sp -1
    4926 .IP \(bu 2.3
    4927 .\}
    4928 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)\.
    4929 .sp
    4930 .RE
    4931 The two\-digit hash value consists of upper case alphanumeric characters\.
    4932 .sp
    4933 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\.
    4934 .sp
    4935 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\.
    4936 .sp
    4937 Default:
    4938 \fI\fImangled names\fR\fR\fI = \fR\fIyes\fR\fI \fR
     5694\m[blue]\fBmangling char\fR\m[]
     5695option, if you don\'t like \'~\'\&.
     5696.RE
     5697.sp
     5698.RS 4
     5699.ie n \{\
     5700\h'-04'\(bu\h'+03'\c
     5701.\}
     5702.el \{\
     5703.sp -1
     5704.IP \(bu 2.3
     5705.\}
     5706Files 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)\&.
     5707.sp
     5708.RE
     5709The two\-digit hash value consists of upper case alphanumeric characters\&.
     5710.sp
     5711This 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\&.
     5712.sp
     5713The 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\&.
     5714.sp
     5715Default:
     5716\fI\fImangled names\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    49395717.RE
    49405718
    49415719mangle prefix (G)
    4942 .PP
    4943 .RS 4
    4944 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\.
    4945 .sp
    4946 mangle prefix is effective only when mangling method is hash2\.
    4947 .sp
    4948 Default:
    4949 \fI\fImangle prefix\fR\fR\fI = \fR\fI1\fR\fI \fR
    4950 .sp
    4951 Example:
    4952 \fI\fImangle prefix\fR\fR\fI = \fR\fI4\fR\fI \fR
     5720.\" mangle prefix
     5721.PP
     5722.RS 4
     5723controls 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\&.
     5724.sp
     5725mangle prefix is effective only when mangling method is hash2\&.
     5726.sp
     5727Default:
     5728\fI\fImangle prefix\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
     5729.sp
     5730Example:
     5731\fI\fImangle prefix\fR\fR\fI = \fR\fI\FC4\F[]\fR\fI \fR
    49535732.RE
    49545733
    49555734mangling char (S)
     5735.\" mangling char
    49565736.PP
    49575737.RS 4
     
    49595739\fImagic\fR
    49605740character in
    4961 \fIname mangling\fR\. 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\.
    4962 .sp
    4963 Default:
    4964 \fI\fImangling char\fR\fR\fI = \fR\fI~\fR\fI \fR
    4965 .sp
    4966 Example:
    4967 \fI\fImangling char\fR\fR\fI = \fR\fI^\fR\fI \fR
     5741\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\&.
     5742.sp
     5743Default:
     5744\fI\fImangling char\fR\fR\fI = \fR\fI\FC~\F[]\fR\fI \fR
     5745.sp
     5746Example:
     5747\fI\fImangling char\fR\fR\fI = \fR\fI\FC^\F[]\fR\fI \fR
    49685748.RE
    49695749
    49705750mangling method (G)
    4971 .PP
    4972 .RS 4
    4973 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\.
    4974 .sp
    4975 Default:
    4976 \fI\fImangling method\fR\fR\fI = \fR\fIhash2\fR\fI \fR
    4977 .sp
    4978 Example:
    4979 \fI\fImangling method\fR\fR\fI = \fR\fIhash\fR\fI \fR
     5751.\" mangling method
     5752.PP
     5753.RS 4
     5754controls 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\&.
     5755.sp
     5756Default:
     5757\fI\fImangling method\fR\fR\fI = \fR\fI\FChash2\F[]\fR\fI \fR
     5758.sp
     5759Example:
     5760\fI\fImangling method\fR\fR\fI = \fR\fI\FChash\F[]\fR\fI \fR
    49805761.RE
    49815762
    49825763map acl inherit (S)
     5764.\" map acl inherit
    49835765.PP
    49845766.RS 4
    49855767This boolean parameter controls whether
    49865768\fBsmbd\fR(8)
    4987 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\.
    4988 .sp
    4989 Default:
    4990 \fI\fImap acl inherit\fR\fR\fI = \fR\fIno\fR\fI \fR
     5769will 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\&.
     5770.sp
     5771Default:
     5772\fI\fImap acl inherit\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    49915773.RE
    49925774
    49935775map archive (S)
    4994 .PP
    4995 .RS 4
    4996 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\.\.\.
     5776.\" map archive
     5777.PP
     5778.RS 4
     5779This 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\&.\&.\&.
    49975780.sp
    49985781Note that this requires the
    4999 \fIcreate mask\fR
    5000 parameter to be set such that owner execute bit is not masked out (i\.e\. it must include 100)\. See the parameter
    5001 \fIcreate mask\fR
    5002 for details\.
    5003 .sp
    5004 Default:
    5005 \fI\fImap archive\fR\fR\fI = \fR\fIyes\fR\fI \fR
     5782\m[blue]\fBcreate mask\fR\m[]
     5783parameter to be set such that owner execute bit is not masked out (i\&.e\&. it must include 100)\&. See the parameter
     5784\m[blue]\fBcreate mask\fR\m[]
     5785for details\&.
     5786.sp
     5787Default:
     5788\fI\fImap archive\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    50065789.RE
    50075790
    50085791map hidden (S)
    5009 .PP
    5010 .RS 4
    5011 This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\.
     5792.\" map hidden
     5793.PP
     5794.RS 4
     5795This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\&.
    50125796.sp
    50135797Note that this requires the
    5014 \fIcreate mask\fR
    5015 to be set such that the world execute bit is not masked out (i\.e\. it must include 001)\. See the parameter
    5016 \fIcreate mask\fR
    5017 for details\.
     5798\m[blue]\fBcreate mask\fR\m[]
     5799to be set such that the world execute bit is not masked out (i\&.e\&. it must include 001)\&. See the parameter
     5800\m[blue]\fBcreate mask\fR\m[]
     5801for details\&.
    50185802.sp
    50195803\fINo default\fR
     
    50215805
    50225806map read only (S)
    5023 .PP
    5024 .RS 4
    5025 This controls how the DOS read only attribute should be mapped from a UNIX filesystem\.
     5807.\" map read only
     5808.PP
     5809.RS 4
     5810This controls how the DOS read only attribute should be mapped from a UNIX filesystem\&.
    50265811.sp
    50275812This parameter can take three different values, which tell
    50285813\fBsmbd\fR(8)
    50295814how to display the read only attribute on files, where either
    5030 \fIstore dos attributes\fR
     5815\m[blue]\fBstore dos attributes\fR\m[]
    50315816is set to
    5032 \fBNo\fR, or no extended attribute is present\. If
    5033 \fIstore dos attributes\fR
     5817\fBNo\fR, or no extended attribute is present\&. If
     5818\m[blue]\fBstore dos attributes\fR\m[]
    50345819is set to
    50355820\fByes\fR
    50365821then this parameter is
    5037 \fIignored\fR\. This is a new parameter introduced in Samba version 3\.0\.21\.
     5822\fIignored\fR\&. This is a new parameter introduced in Samba version 3\&.0\&.21\&.
    50385823.sp
    50395824The three settings are :
     
    50495834
    50505835\fBYes\fR
    5051 \- 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\.
     5836\- 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\&.
    50525837.RE
    50535838.sp
     
    50645849\- The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by
    50655850\fBsmbd\fR(8)
    5066 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\.
     5851by 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\&.
    50675852.RE
    50685853.sp
     
    50785863\fBNo\fR
    50795864\- The read only DOS attribute is unaffected by permissions, and can only be set by the
    5080 \fIstore dos attributes\fR
    5081 method\. This may be useful for exporting mounted CDs\.
    5082 .sp
    5083 .RE
    5084 Default:
    5085 \fI\fImap read only\fR\fR\fI = \fR\fIyes\fR\fI \fR
     5865\m[blue]\fBstore dos attributes\fR\m[]
     5866method\&. This may be useful for exporting mounted CDs\&.
     5867.sp
     5868.RE
     5869Default:
     5870\fI\fImap read only\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    50865871.RE
    50875872
    50885873map system (S)
    5089 .PP
    5090 .RS 4
    5091 This controls whether DOS style system files should be mapped to the UNIX group execute bit\.
     5874.\" map system
     5875.PP
     5876.RS 4
     5877This controls whether DOS style system files should be mapped to the UNIX group execute bit\&.
    50925878.sp
    50935879Note that this requires the
    5094 \fIcreate mask\fR
    5095 to be set such that the group execute bit is not masked out (i\.e\. it must include 010)\. See the parameter
    5096 \fIcreate mask\fR
    5097 for details\.
    5098 .sp
    5099 Default:
    5100 \fI\fImap system\fR\fR\fI = \fR\fIno\fR\fI \fR
     5880\m[blue]\fBcreate mask\fR\m[]
     5881to be set such that the group execute bit is not masked out (i\&.e\&. it must include 010)\&. See the parameter
     5882\m[blue]\fBcreate mask\fR\m[]
     5883for details\&.
     5884.sp
     5885Default:
     5886\fI\fImap system\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    51015887.RE
    51025888
    51035889map to guest (G)
     5890.\" map to guest
    51045891.PP
    51055892.RS 4
    51065893This parameter is only useful in
    5107 \fISECURITY = security\fR
     5894\m[blue]\fBSECURITY = security\fR\m[]
    51085895modes other than
    51095896\fIsecurity = share\fR
    51105897and
    51115898\fIsecurity = server\fR
    5112 \- i\.e\.
     5899\- i\&.e\&.
    51135900\fBuser\fR, and
    5114 \fBdomain\fR\.
     5901\fBdomain\fR\&.
    51155902.sp
    51165903This parameter can take four different values, which tell
    51175904\fBsmbd\fR(8)
    5118 what to do with user login requests that don\'t match a valid UNIX user in some way\.
     5905what to do with user login requests that don\'t match a valid UNIX user in some way\&.
    51195906.sp
    51205907The four settings are :
     
    51295916.\}
    51305917\fBNever\fR
    5131 \- Means user login requests with an invalid password are rejected\. This is the default\.
     5918\- Means user login requests with an invalid password are rejected\&. This is the default\&.
    51325919.RE
    51335920.sp
     
    51425929\fBBad User\fR
    51435930\- 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
    5144 \fIguest account\fR\.
     5931\m[blue]\fBguest account\fR\m[]\&.
    51455932.RE
    51465933.sp
     
    51555942\fBBad Password\fR
    51565943\- Means user logins with an invalid password are treated as a guest login and mapped into the
    5157 \fIguest account\fR\. 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
     5944\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
    51585945\fIhate\fR
    51595946you if you set the
    51605947\fImap to guest\fR
    5161 parameter this way :\-)\.
     5948parameter this way :\-)\&.
    51625949.RE
    51635950.sp
     
    51715958.\}
    51725959\fBBad Uid\fR
    5173 \- 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\.
     5960\- 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\&.
    51745961.sp
    51755962.RE
    51765963Note that this parameter is needed to set up "Guest" share services when using
    51775964\fIsecurity\fR
    5178 modes other than share and server\. This is because in these modes the name of the resource being requested is
     5965modes other than share and server\&. This is because in these modes the name of the resource being requested is
    51795966\fInot\fR
    5180 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
     5967sent 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
    51815968\fIsecurity = server\fR
    5182 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\.
     5969as 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\&.
    51835970.sp
    51845971For people familiar with the older Samba releases, this parameter maps to the old compile\-time setting of the
    51855972\fB GUEST_SESSSETUP\fR
    5186 value in local\.h\.
    5187 .sp
    5188 Default:
    5189 \fI\fImap to guest\fR\fR\fI = \fR\fINever\fR\fI \fR
    5190 .sp
    5191 Example:
    5192 \fI\fImap to guest\fR\fR\fI = \fR\fIBad User\fR\fI \fR
     5973value in local\&.h\&.
     5974.sp
     5975Default:
     5976\fI\fImap to guest\fR\fR\fI = \fR\fI\FCNever\F[]\fR\fI \fR
     5977.sp
     5978Example:
     5979\fI\fImap to guest\fR\fR\fI = \fR\fI\FCBad User\F[]\fR\fI \fR
    51935980.RE
    51945981
    51955982max connections (S)
    5196 .PP
    5197 .RS 4
    5198 This option allows the number of simultaneous connections to a service to be limited\. If
     5983.\" max connections
     5984.PP
     5985.RS 4
     5986This option allows the number of simultaneous connections to a service to be limited\&. If
    51995987\fImax connections\fR
    5200 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\.
    5201 .sp
    5202 Record lock files are used to implement this feature\. The lock files will be stored in the directory specified by the
    5203 \fIlock directory\fR
    5204 option\.
    5205 .sp
    5206 Default:
    5207 \fI\fImax connections\fR\fR\fI = \fR\fI0\fR\fI \fR
    5208 .sp
    5209 Example:
    5210 \fI\fImax connections\fR\fR\fI = \fR\fI10\fR\fI \fR
     5988is 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\&.
     5989.sp
     5990Record lock files are used to implement this feature\&. The lock files will be stored in the directory specified by the
     5991\m[blue]\fBlock directory\fR\m[]
     5992option\&.
     5993.sp
     5994Default:
     5995\fI\fImax connections\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     5996.sp
     5997Example:
     5998\fI\fImax connections\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
    52115999.RE
    52126000
    52136001max disk size (G)
    5214 .PP
    5215 .RS 4
    5216 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\.
    5217 .sp
    5218 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
    5219 \fImax disk size\fR\.
    5220 .sp
    5221 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\.
     6002.\" max disk size
     6003.PP
     6004.RS 4
     6005This 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\&.
     6006.sp
     6007Note 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
     6008\fImax disk size\fR\&.
     6009.sp
     6010This 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\&.
    52226011.sp
    52236012A
    52246013\fImax disk size\fR
    5225 of 0 means no limit\.
    5226 .sp
    5227 Default:
    5228 \fI\fImax disk size\fR\fR\fI = \fR\fI0\fR\fI \fR
    5229 .sp
    5230 Example:
    5231 \fI\fImax disk size\fR\fR\fI = \fR\fI1000\fR\fI \fR
     6014of 0 means no limit\&.
     6015.sp
     6016Default:
     6017\fI\fImax disk size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     6018.sp
     6019Example:
     6020\fI\fImax disk size\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
    52326021.RE
    52336022
    52346023max log size (G)
    5235 .PP
    5236 .RS 4
    5237 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
    5238 \fI\.old\fR
    5239 extension\.
    5240 .sp
    5241 A size of 0 means no limit\.
    5242 .sp
    5243 Default:
    5244 \fI\fImax log size\fR\fR\fI = \fR\fI5000\fR\fI \fR
    5245 .sp
    5246 Example:
    5247 \fI\fImax log size\fR\fR\fI = \fR\fI1000\fR\fI \fR
     6024.\" max log size
     6025.PP
     6026.RS 4
     6027This 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
     6028\FC\&.old\F[]
     6029extension\&.
     6030.sp
     6031A size of 0 means no limit\&.
     6032.sp
     6033Default:
     6034\fI\fImax log size\fR\fR\fI = \fR\fI\FC5000\F[]\fR\fI \fR
     6035.sp
     6036Example:
     6037\fI\fImax log size\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
    52486038.RE
    52496039
    52506040max mux (G)
    5251 .PP
    5252 .RS 4
    5253 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\.
    5254 .sp
    5255 Default:
    5256 \fI\fImax mux\fR\fR\fI = \fR\fI50\fR\fI \fR
     6041.\" max mux
     6042.PP
     6043.RS 4
     6044This 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\&.
     6045.sp
     6046Default:
     6047\fI\fImax mux\fR\fR\fI = \fR\fI\FC50\F[]\fR\fI \fR
    52576048.RE
    52586049
    52596050max open files (G)
     6051.\" max open files
    52606052.PP
    52616053.RS 4
    52626054This parameter limits the maximum number of open files that one
    52636055\fBsmbd\fR(8)
    5264 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\.
    5265 .sp
    5266 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\.
    5267 .sp
    5268 Default:
    5269 \fI\fImax open files\fR\fR\fI = \fR\fI10000\fR\fI \fR
     6056file 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\&.
     6057.sp
     6058The 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\&.
     6059.sp
     6060Default:
     6061\fI\fImax open files\fR\fR\fI = \fR\fI\FC10000\F[]\fR\fI \fR
    52706062.RE
    52716063
    52726064max print jobs (S)
    5273 .PP
    5274 .RS 4
    5275 This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\. If this number is exceeded,
     6065.\" max print jobs
     6066.PP
     6067.RS 4
     6068This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\&. If this number is exceeded,
    52766069\fBsmbd\fR(8)
    5277 will remote "Out of Space" to the client\.
    5278 .sp
    5279 Default:
    5280 \fI\fImax print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR
    5281 .sp
    5282 Example:
    5283 \fI\fImax print jobs\fR\fR\fI = \fR\fI5000\fR\fI \fR
     6070will remote "Out of Space" to the client\&.
     6071.sp
     6072Default:
     6073\fI\fImax print jobs\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
     6074.sp
     6075Example:
     6076\fI\fImax print jobs\fR\fR\fI = \fR\fI\FC5000\F[]\fR\fI \fR
    52846077.RE
    52856078
    52866079protocol
     6080.\" protocol
    52876081.PP
    52886082.RS 4
    52896083This parameter is a synonym for
    5290 max protocol\.
     6084max protocol\&.
    52916085.RE
    52926086
    52936087max protocol (G)
    5294 .PP
    5295 .RS 4
    5296 The value of the parameter (a string) is the highest protocol level that will be supported by the server\.
     6088.\" max protocol
     6089.PP
     6090.RS 4
     6091The value of the parameter (a string) is the highest protocol level that will be supported by the server\&.
    52976092.sp
    52986093Possible values are :
     
    53066101.IP \(bu 2.3
    53076102.\}
    5308 \fBCORE\fR: Earliest version\. No concept of user names\.
    5309 .RE
    5310 .sp
    5311 .RS 4
    5312 .ie n \{\
    5313 \h'-04'\(bu\h'+03'\c
    5314 .\}
    5315 .el \{\
    5316 .sp -1
    5317 .IP \(bu 2.3
    5318 .\}
    5319 \fBCOREPLUS\fR: Slight improvements on CORE for efficiency\.
     6103\fBCORE\fR: Earliest version\&. No concept of user names\&.
     6104.RE
     6105.sp
     6106.RS 4
     6107.ie n \{\
     6108\h'-04'\(bu\h'+03'\c
     6109.\}
     6110.el \{\
     6111.sp -1
     6112.IP \(bu 2.3
     6113.\}
     6114\fBCOREPLUS\fR: Slight improvements on CORE for efficiency\&.
    53206115.RE
    53216116.sp
     
    53306125\fBLANMAN1\fR: First
    53316126\fI modern\fR
    5332 version of the protocol\. Long filename support\.
    5333 .RE
    5334 .sp
    5335 .RS 4
    5336 .ie n \{\
    5337 \h'-04'\(bu\h'+03'\c
    5338 .\}
    5339 .el \{\
    5340 .sp -1
    5341 .IP \(bu 2.3
    5342 .\}
    5343 \fBLANMAN2\fR: Updates to Lanman1 protocol\.
    5344 .RE
    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 \fBNT1\fR: Current up to date version of the protocol\. Used by Windows NT\. Known as CIFS\.
    5355 .sp
    5356 .RE
    5357 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\.
    5358 .sp
    5359 Default:
    5360 \fI\fImax protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR
    5361 .sp
    5362 Example:
    5363 \fI\fImax protocol\fR\fR\fI = \fR\fILANMAN1\fR\fI \fR
     6127version of the protocol\&. Long filename support\&.
     6128.RE
     6129.sp
     6130.RS 4
     6131.ie n \{\
     6132\h'-04'\(bu\h'+03'\c
     6133.\}
     6134.el \{\
     6135.sp -1
     6136.IP \(bu 2.3
     6137.\}
     6138\fBLANMAN2\fR: Updates to Lanman1 protocol\&.
     6139.RE
     6140.sp
     6141.RS 4
     6142.ie n \{\
     6143\h'-04'\(bu\h'+03'\c
     6144.\}
     6145.el \{\
     6146.sp -1
     6147.IP \(bu 2.3
     6148.\}
     6149\fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.
     6150.sp
     6151.RE
     6152Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
     6153.sp
     6154Default:
     6155\fI\fImax protocol\fR\fR\fI = \fR\fI\FCNT1\F[]\fR\fI \fR
     6156.sp
     6157Example:
     6158\fI\fImax protocol\fR\fR\fI = \fR\fI\FCLANMAN1\F[]\fR\fI \fR
    53646159.RE
    53656160
    53666161max reported print jobs (S)
    5367 .PP
    5368 .RS 4
    5369 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\.
    5370 .sp
    5371 Default:
    5372 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI0\fR\fI \fR
    5373 .sp
    5374 Example:
    5375 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR
     6162.\" max reported print jobs
     6163.PP
     6164.RS 4
     6165This 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\&.
     6166.sp
     6167Default:
     6168\fI\fImax reported print jobs\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     6169.sp
     6170Example:
     6171\fI\fImax reported print jobs\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
    53766172.RE
    53776173
    53786174max smbd processes (G)
     6175.\" max smbd processes
    53796176.PP
    53806177.RS 4
    53816178This parameter limits the maximum number of
    53826179\fBsmbd\fR(8)
    5383 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
     6180processes 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
    53846181\fBsmbd\fR(8)
    5385 associated with him or her to handle connections to all shares from a given host\.
    5386 .sp
    5387 Default:
    5388 \fI\fImax smbd processes\fR\fR\fI = \fR\fI0\fR\fI \fR
    5389 .sp
    5390 Example:
    5391 \fI\fImax smbd processes\fR\fR\fI = \fR\fI1000\fR\fI \fR
     6182associated with him or her to handle connections to all shares from a given host\&.
     6183.sp
     6184Default:
     6185\fI\fImax smbd processes\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     6186.sp
     6187Example:
     6188\fI\fImax smbd processes\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
    53926189.RE
    53936190
    53946191max stat cache size (G)
     6192.\" max stat cache size
    53956193.PP
    53966194.RS 4
    53976195This parameter limits the size in memory of any
    53986196\fIstat cache\fR
    5399 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\.
    5400 .sp
    5401 Default:
    5402 \fI\fImax stat cache size\fR\fR\fI = \fR\fI256\fR\fI \fR
    5403 .sp
    5404 Example:
    5405 \fI\fImax stat cache size\fR\fR\fI = \fR\fI100\fR\fI \fR
     6197being 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\&.
     6198.sp
     6199Default:
     6200\fI\fImax stat cache size\fR\fR\fI = \fR\fI\FC256\F[]\fR\fI \fR
     6201.sp
     6202Example:
     6203\fI\fImax stat cache size\fR\fR\fI = \fR\fI\FC100\F[]\fR\fI \fR
    54066204.RE
    54076205
    54086206max ttl (G)
     6207.\" max ttl
    54096208.PP
    54106209.RS 4
     
    54126211\fBnmbd\fR(8)
    54136212what the default \'time to live\' of NetBIOS names should be (in seconds) when
    5414 nmbd
    5415 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\.
    5416 .sp
    5417 Default:
    5418 \fI\fImax ttl\fR\fR\fI = \fR\fI259200\fR\fI \fR
     6213\FCnmbd\F[]
     6214is 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\&.
     6215.sp
     6216Default:
     6217\fI\fImax ttl\fR\fR\fI = \fR\fI\FC259200\F[]\fR\fI \fR
    54196218.RE
    54206219
    54216220max wins ttl (G)
     6221.\" max wins ttl
    54226222.PP
    54236223.RS 4
    54246224This option tells
    54256225\fBsmbd\fR(8)
    5426 when acting as a WINS server (\fIwins support = yes\fR) what the maximum \'time to live\' of NetBIOS names that
    5427 nmbd
    5428 will grant will be (in seconds)\. You should never need to change this parameter\. The default is 6 days (518400 seconds)\.
    5429 .sp
    5430 Default:
    5431 \fI\fImax wins ttl\fR\fR\fI = \fR\fI518400\fR\fI \fR
     6226when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the maximum \'time to live\' of NetBIOS names that
     6227\FCnmbd\F[]
     6228will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 days (518400 seconds)\&.
     6229.sp
     6230Default:
     6231\fI\fImax wins ttl\fR\fR\fI = \fR\fI\FC518400\F[]\fR\fI \fR
    54326232.RE
    54336233
    54346234max xmit (G)
    5435 .PP
    5436 .RS 4
    5437 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\.
    5438 .sp
    5439 Default:
    5440 \fI\fImax xmit\fR\fR\fI = \fR\fI16644\fR\fI \fR
    5441 .sp
    5442 Example:
    5443 \fI\fImax xmit\fR\fR\fI = \fR\fI8192\fR\fI \fR
     6235.\" max xmit
     6236.PP
     6237.RS 4
     6238This 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\&.
     6239.sp
     6240Default:
     6241\fI\fImax xmit\fR\fR\fI = \fR\fI\FC16644\F[]\fR\fI \fR
     6242.sp
     6243Example:
     6244\fI\fImax xmit\fR\fR\fI = \fR\fI\FC8192\F[]\fR\fI \fR
    54446245.RE
    54456246
    54466247message command (G)
    5447 .PP
    5448 .RS 4
    5449 This specifies what command to run when the server receives a WinPopup style message\.
    5450 .sp
    5451 This would normally be a command that would deliver the message somehow\. How this is to be done is up to your imagination\.
     6248.\" message command
     6249.PP
     6250.RS 4
     6251This specifies what command to run when the server receives a WinPopup style message\&.
     6252.sp
     6253This would normally be a command that would deliver the message somehow\&. How this is to be done is up to your imagination\&.
    54526254.sp
    54536255An example is:
    54546256.sp
    5455 .RS 4
     6257.if n \{\
     6258.RS 4
     6259.\}
     6260.fam C
     6261.ps -1
    54566262.nf
    5457 message command = csh \-c \'xedit %s;rm %s\' &
     6263.if t \{\
     6264.sp -1
     6265.\}
     6266.BB lightgray adjust-for-leading-newline
     6267.sp -1
     6268
     6269\FCmessage command = csh \-c \'xedit %s;rm %s\' &\F[]
     6270.EB lightgray adjust-for-leading-newline
     6271.if t \{\
     6272.sp 1
     6273.\}
    54586274.fi
    5459 .RE
    5460 .sp
     6275.fam
     6276.ps +1
     6277.if n \{\
     6278.RE
     6279.\}
    54616280.sp
    54626281This delivers the message using
    5463 xedit, then removes it afterwards\.
    5464 \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)\.
    5465 .sp
    5466 All messages are delivered as the global guest user\. The command takes the standard substitutions, although
     6282\FCxedit\F[], then removes it afterwards\&.
     6283\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)\&.
     6284.sp
     6285All messages are delivered as the global guest user\&. The command takes the standard substitutions, although
    54676286\fI %u\fR
    54686287won\'t work (\fI%U\fR
    5469 may be better in this case)\.
    5470 .sp
    5471 Apart from the standard substitutions, some additional ones apply\. In particular:
     6288may be better in this case)\&.
     6289.sp
     6290Apart from the standard substitutions, some additional ones apply\&. In particular:
    54726291.sp
    54736292.RS 4
     
    54806299.\}
    54816300\fI%s\fR
    5482 = the filename containing the message\.
     6301= the filename containing the message\&.
    54836302.RE
    54846303.sp
     
    54926311.\}
    54936312\fI%t\fR
    5494 = the destination that the message was sent to (probably the server name)\.
     6313= the destination that the message was sent to (probably the server name)\&.
    54956314.RE
    54966315.sp
     
    55046323.\}
    55056324\fI%f\fR
    5506 = who the message is from\.
    5507 .sp
    5508 .RE
    5509 You could make this command send mail, or whatever else takes your fancy\. Please let us know of any really interesting ideas you have\.
     6325= who the message is from\&.
     6326.sp
     6327.RE
     6328You could make this command send mail, or whatever else takes your fancy\&. Please let us know of any really interesting ideas you have\&.
    55106329.sp
    55116330Here\'s a way of sending the messages as mail to root:
    55126331.sp
    5513 .RS 4
     6332.if n \{\
     6333.RS 4
     6334.\}
     6335.fam C
     6336.ps -1
    55146337.nf
    5515 message command = /bin/mail \-s \'message from %f on %m\' root < %s; rm %s
     6338.if t \{\
     6339.sp -1
     6340.\}
     6341.BB lightgray adjust-for-leading-newline
     6342.sp -1
     6343
     6344\FCmessage command = /bin/mail \-s \'message from %f on %m\' root < %s; rm %s\F[]
     6345.EB lightgray adjust-for-leading-newline
     6346.if t \{\
     6347.sp 1
     6348.\}
    55166349.fi
    5517 .RE
    5518 .sp
    5519 .sp
    5520 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\.
     6350.fam
     6351.ps +1
     6352.if n \{\
     6353.RE
     6354.\}
     6355.sp
     6356If 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\&.
    55216357.sp
    55226358If you want to silently delete it then try:
    55236359.sp
    5524 .RS 4
     6360.if n \{\
     6361.RS 4
     6362.\}
     6363.fam C
     6364.ps -1
    55256365.nf
    5526 message command = rm %s
     6366.if t \{\
     6367.sp -1
     6368.\}
     6369.BB lightgray adjust-for-leading-newline
     6370.sp -1
     6371
     6372\FCmessage command = rm %s\F[]
     6373.EB lightgray adjust-for-leading-newline
     6374.if t \{\
     6375.sp 1
     6376.\}
    55276377.fi
    5528 .RE
    5529 .sp
    5530 .sp
    5531 Default:
    5532 \fI\fImessage command\fR\fR\fI = \fR\fI\fR\fI \fR
    5533 .sp
    5534 Example:
    5535 \fI\fImessage command\fR\fR\fI = \fR\fIcsh \-c \'xedit %s; rm %s\' &\fR\fI \fR
     6378.fam
     6379.ps +1
     6380.if n \{\
     6381.RE
     6382.\}
     6383.sp
     6384Default:
     6385\fI\fImessage command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     6386.sp
     6387Example:
     6388\fI\fImessage command\fR\fR\fI = \fR\fI\FCcsh \-c \'xedit %s; rm %s\' &\F[]\fR\fI \fR
    55366389.RE
    55376390
    55386391min print space (S)
    5539 .PP
    5540 .RS 4
    5541 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\.
    5542 .sp
    5543 Default:
    5544 \fI\fImin print space\fR\fR\fI = \fR\fI0\fR\fI \fR
    5545 .sp
    5546 Example:
    5547 \fI\fImin print space\fR\fR\fI = \fR\fI2000\fR\fI \fR
     6392.\" min print space
     6393.PP
     6394.RS 4
     6395This 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\&.
     6396.sp
     6397Default:
     6398\fI\fImin print space\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     6399.sp
     6400Example:
     6401\fI\fImin print space\fR\fR\fI = \fR\fI\FC2000\F[]\fR\fI \fR
    55486402.RE
    55496403
    55506404min protocol (G)
    5551 .PP
    5552 .RS 4
    5553 The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support\. Please refer to the
    5554 \fImax protocol\fR
    5555 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
    5556 \fIsource/smbd/negprot\.c\fR
    5557 for a listing of known protocol dialects supported by clients\.
     6405.\" min protocol
     6406.PP
     6407.RS 4
     6408The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support\&. Please refer to the
     6409\m[blue]\fBmax protocol\fR\m[]
     6410parameter 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
     6411\FCsource/smbd/negprot\&.c\F[]
     6412for a listing of known protocol dialects supported by clients\&.
    55586413.sp
    55596414If you are viewing this parameter as a security measure, you should also refer to the
    5560 \fIlanman auth\fR
    5561 parameter\. Otherwise, you should never need to change this parameter\.
    5562 .sp
    5563 Default:
    5564 \fI\fImin protocol\fR\fR\fI = \fR\fICORE\fR\fI \fR
    5565 .sp
    5566 Example:
    5567 \fI\fImin protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR
     6415\m[blue]\fBlanman auth\fR\m[]
     6416parameter\&. Otherwise, you should never need to change this parameter\&.
     6417.sp
     6418Default:
     6419\fI\fImin protocol\fR\fR\fI = \fR\fI\FCCORE\F[]\fR\fI \fR
     6420.sp
     6421Example:
     6422\fI\fImin protocol\fR\fR\fI = \fR\fI\FCNT1\F[]\fR\fI \fR
    55686423.RE
    55696424
    55706425min wins ttl (G)
     6426.\" min wins ttl
    55716427.PP
    55726428.RS 4
    55736429This option tells
    55746430\fBnmbd\fR(8)
    5575 when acting as a WINS server (\fIwins support = yes\fR) what the minimum \'time to live\' of NetBIOS names that
    5576 nmbd
    5577 will grant will be (in seconds)\. You should never need to change this parameter\. The default is 6 hours (21600 seconds)\.
    5578 .sp
    5579 Default:
    5580 \fI\fImin wins ttl\fR\fR\fI = \fR\fI21600\fR\fI \fR
     6431when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the minimum \'time to live\' of NetBIOS names that
     6432\FCnmbd\F[]
     6433will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 hours (21600 seconds)\&.
     6434.sp
     6435Default:
     6436\fI\fImin wins ttl\fR\fR\fI = \fR\fI\FC21600\F[]\fR\fI \fR
    55816437.RE
    55826438
    55836439msdfs proxy (S)
    5584 .PP
    5585 .RS 4
    5586 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\.
    5587 .sp
    5588 Only Dfs roots can act as proxy shares\. Take a look at the
    5589 \fImsdfs root\fR
     6440.\" msdfs proxy
     6441.PP
     6442.RS 4
     6443This 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\&.
     6444.sp
     6445Only Dfs roots can act as proxy shares\&. Take a look at the
     6446\m[blue]\fBmsdfs root\fR\m[]
    55906447and
    5591 \fIhost msdfs\fR
    5592 options to find out how to set up a Dfs root share\.
     6448\m[blue]\fBhost msdfs\fR\m[]
     6449options to find out how to set up a Dfs root share\&.
    55936450.sp
    55946451\fINo default\fR
    55956452.sp
    55966453Example:
    5597 \fI\fImsdfs proxy\fR\fR\fI = \fR\fI\eotherserver\esomeshare\fR\fI \fR
     6454\fI\fImsdfs proxy\fR\fR\fI = \fR\fI\FC\eotherserver\esomeshare\F[]\fR\fI \fR
    55986455.RE
    55996456
    56006457msdfs root (S)
     6458.\" msdfs root
    56016459.PP
    56026460.RS 4
    56036461If set to
    5604 \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
    5605 \fImsdfs:serverA\e\eshareA,serverB\e\eshareB\fR
    5606 and so on\. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\.
    5607 .sp
    5608 Default:
    5609 \fI\fImsdfs root\fR\fR\fI = \fR\fIno\fR\fI \fR
     6462\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
     6463\FCmsdfs:serverA\e\eshareA,serverB\e\eshareB\F[]
     6464and so on\&. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\&.
     6465.sp
     6466Default:
     6467\fI\fImsdfs root\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    56106468.RE
    56116469
    56126470name cache timeout (G)
    5613 .PP
    5614 .RS 4
    5615 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\.
    5616 .sp
    5617 Default:
    5618 \fI\fIname cache timeout\fR\fR\fI = \fR\fI660\fR\fI \fR
    5619 .sp
    5620 Example:
    5621 \fI\fIname cache timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
     6471.\" name cache timeout
     6472.PP
     6473.RS 4
     6474Specifies 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\&.
     6475.sp
     6476Default:
     6477\fI\fIname cache timeout\fR\fR\fI = \fR\fI\FC660\F[]\fR\fI \fR
     6478.sp
     6479Example:
     6480\fI\fIname cache timeout\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    56226481.RE
    56236482
    56246483name resolve order (G)
    5625 .PP
    5626 .RS 4
    5627 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\.
    5628 .sp
    5629 The options are: "lmhosts", "host", "wins" and "bcast"\. They cause names to be resolved as follows:
     6484.\" name resolve order
     6485.PP
     6486.RS 4
     6487This 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\&.
     6488.sp
     6489The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows:
    56306490.sp
    56316491.RS 4
     
    56396499
    56406500\fBlmhosts\fR
    5641 : 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\.
     6501: 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\&.
    56426502.RE
    56436503.sp
     
    56536513\fBhost\fR
    56546514: Do a standard host name to IP address resolution, using the system
    5655 \fI/etc/hosts \fR, 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
    5656 \fI/etc/nsswitch\.conf\fR
    5657 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\.
     6515\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
     6516\FC/etc/nsswitch\&.conf\F[]
     6517file\&. 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\&.
    56586518.RE
    56596519.sp
     
    56686528\fBwins\fR
    56696529: Query a name with the IP address listed in the
    5670 \fIWINSSERVER\fR
    5671 parameter\. If no WINS server has been specified this method will be ignored\.
     6530\m[blue]\fBWINSSERVER\fR\m[]
     6531parameter\&. If no WINS server has been specified this method will be ignored\&.
    56726532.RE
    56736533.sp
     
    56826542\fBbcast\fR
    56836543: Do a broadcast on each of the known local interfaces listed in the
    5684 \fIinterfaces\fR
    5685 parameter\. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\.
    5686 .sp
    5687 .RE
    5688 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\.
    5689 .sp
    5690 When Samba is functioning in ADS security mode (security = ads) it is advised to use following settings for
     6544\m[blue]\fBinterfaces\fR\m[]
     6545parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.
     6546.sp
     6547.RE
     6548The example below will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup\&.
     6549.sp
     6550When Samba is functioning in ADS security mode (\FCsecurity = ads\F[]) it is advised to use following settings for
    56916551\fIname resolve order\fR:
    56926552.sp
    5693 name resolve order = wins bcast
    5694 .sp
    5695 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\.
    5696 .sp
    5697 Default:
    5698 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts host wins bcast\fR\fI \fR
    5699 .sp
    5700 Example:
    5701 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts bcast host\fR\fI \fR
     6553\FCname resolve order = wins bcast\F[]
     6554.sp
     6555DC 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\&.
     6556.sp
     6557Default:
     6558\fI\fIname resolve order\fR\fR\fI = \fR\fI\FClmhosts host wins bcast\F[]\fR\fI \fR
     6559.sp
     6560Example:
     6561\fI\fIname resolve order\fR\fR\fI = \fR\fI\FClmhosts bcast host\F[]\fR\fI \fR
    57026562.RE
    57036563
    57046564netbios aliases (G)
    5705 .PP
    5706 .RS 4
    5707 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\.
    5708 .sp
    5709 Default:
    5710 \fI\fInetbios aliases\fR\fR\fI = \fR\fI # empty string (no additional names)\fR\fI \fR
    5711 .sp
    5712 Example:
    5713 \fI\fInetbios aliases\fR\fR\fI = \fR\fITEST TEST1 TEST2\fR\fI \fR
     6565.\" netbios aliases
     6566.PP
     6567.RS 4
     6568This 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\&.
     6569.sp
     6570Default:
     6571\fI\fInetbios aliases\fR\fR\fI = \fR\fI\FC # empty string (no additional names)\F[]\fR\fI \fR
     6572.sp
     6573Example:
     6574\fI\fInetbios aliases\fR\fR\fI = \fR\fI\FCTEST TEST1 TEST2\F[]\fR\fI \fR
    57146575.RE
    57156576
    57166577netbios name (G)
    5717 .PP
    5718 .RS 4
    5719 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\.
     6578.\" netbios name
     6579.PP
     6580.RS 4
     6581This 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\&.
    57206582.sp
    57216583There 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
    5722 PIPE\. To avoid this problem, do not name your Samba\-3 server
    5723 PIPE\.
    5724 .sp
    5725 Default:
    5726 \fI\fInetbios name\fR\fR\fI = \fR\fI # machine DNS name\fR\fI \fR
    5727 .sp
    5728 Example:
    5729 \fI\fInetbios name\fR\fR\fI = \fR\fIMYNAME\fR\fI \fR
     6584\FCPIPE\F[]\&. To avoid this problem, do not name your Samba\-3 server
     6585\FCPIPE\F[]\&.
     6586.sp
     6587Default:
     6588\fI\fInetbios name\fR\fR\fI = \fR\fI\FC # machine DNS name\F[]\fR\fI \fR
     6589.sp
     6590Example:
     6591\fI\fInetbios name\fR\fR\fI = \fR\fI\FCMYNAME\F[]\fR\fI \fR
    57306592.RE
    57316593
    57326594netbios scope (G)
    5733 .PP
    5734 .RS 4
    5735 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\.
    5736 .sp
    5737 Default:
    5738 \fI\fInetbios scope\fR\fR\fI = \fR\fI\fR\fI \fR
     6595.\" netbios scope
     6596.PP
     6597.RS 4
     6598This sets the NetBIOS scope that Samba will operate under\&. This should not be set unless every machine on your LAN also sets this value\&.
     6599.sp
     6600Default:
     6601\fI\fInetbios scope\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    57396602.RE
    57406603
    57416604nis homedir (G)
    5742 .PP
    5743 .RS 4
    5744 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\.
    5745 .sp
    5746 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\.
    5747 .sp
    5748 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
    5749 \fIhomedir map\fR
    5750 and return the server listed there\.
    5751 .sp
    5752 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\.
    5753 .sp
    5754 Default:
    5755 \fI\fInis homedir\fR\fR\fI = \fR\fIno\fR\fI \fR
     6605.\" nis homedir
     6606.PP
     6607.RS 4
     6608Get 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\&.
     6609.sp
     6610When 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\&.
     6611.sp
     6612This 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
     6613\m[blue]\fBhomedir map\fR\m[]
     6614and return the server listed there\&.
     6615.sp
     6616Note 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\&.
     6617.sp
     6618Default:
     6619\fI\fInis homedir\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    57566620.RE
    57576621
    57586622nt acl support (S)
     6623.\" nt acl support
    57596624.PP
    57606625.RS 4
    57616626This boolean parameter controls whether
    57626627\fBsmbd\fR(8)
    5763 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\.
    5764 .sp
    5765 Default:
    5766 \fI\fInt acl support\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6628will 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\&.
     6629.sp
     6630Default:
     6631\fI\fInt acl support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    57676632.RE
    57686633
    57696634ntlm auth (G)
     6635.\" ntlm auth
    57706636.PP
    57716637.RS 4
    57726638This parameter determines whether or not
    57736639\fBsmbd\fR(8)
    5774 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\.
     6640will 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\&.
    57756641.sp
    57766642If this option, and
    5777 lanman auth
    5778 are both disabled, then only NTLMv2 logins will be permited\. Not all clients support NTLMv2, and most will require special configuration to us it\.
    5779 .sp
    5780 Default:
    5781 \fI\fIntlm auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6643\FClanman auth\F[]
     6644are both disabled, then only NTLMv2 logins will be permited\&. Not all clients support NTLMv2, and most will require special configuration to us it\&.
     6645.sp
     6646Default:
     6647\fI\fIntlm auth\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    57826648.RE
    57836649
    57846650nt pipe support (G)
     6651.\" nt pipe support
    57856652.PP
    57866653.RS 4
     
    57896656will allow Windows NT clients to connect to the NT SMB specific
    57906657\fBIPC$\fR
    5791 pipes\. This is a developer debugging option and can be left alone\.
    5792 .sp
    5793 Default:
    5794 \fI\fInt pipe support\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6658pipes\&. This is a developer debugging option and can be left alone\&.
     6659.sp
     6660Default:
     6661\fI\fInt pipe support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    57956662.RE
    57966663
    57976664nt status support (G)
     6665.\" nt status support
    57986666.PP
    57996667.RS 4
    58006668This boolean parameter controls whether
    58016669\fBsmbd\fR(8)
    5802 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
     6670will 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
    58036671\fBno\fR
    5804 then Samba offers exactly the same DOS error codes that versions prior to Samba 2\.2\.3 reported\.
    5805 .sp
    5806 You should not need to ever disable this parameter\.
    5807 .sp
    5808 Default:
    5809 \fI\fInt status support\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6672then Samba offers exactly the same DOS error codes that versions prior to Samba 2\&.2\&.3 reported\&.
     6673.sp
     6674You should not need to ever disable this parameter\&.
     6675.sp
     6676Default:
     6677\fI\fInt status support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    58106678.RE
    58116679
    58126680null passwords (G)
    5813 .PP
    5814 .RS 4
    5815 Allow or disallow client access to accounts that have null passwords\.
     6681.\" null passwords
     6682.PP
     6683.RS 4
     6684Allow or disallow client access to accounts that have null passwords\&.
    58166685.sp
    58176686See also
    5818 \fBsmbpasswd\fR(5)\.
    5819 .sp
    5820 Default:
    5821 \fI\fInull passwords\fR\fR\fI = \fR\fIno\fR\fI \fR
     6687\fBsmbpasswd\fR(5)\&.
     6688.sp
     6689Default:
     6690\fI\fInull passwords\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    58226691.RE
    58236692
    58246693obey pam restrictions (G)
    5825 .PP
    5826 .RS 4
    5827 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
    5828 \fIencrypt passwords = yes\fR\. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption\.
    5829 .sp
    5830 Default:
    5831 \fI\fIobey pam restrictions\fR\fR\fI = \fR\fIno\fR\fI \fR
     6694.\" obey pam restrictions
     6695.PP
     6696.RS 4
     6697When 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
     6698\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\&.
     6699.sp
     6700Default:
     6701\fI\fIobey pam restrictions\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    58326702.RE
    58336703
    58346704only user (S)
     6705.\" only user
    58356706.PP
    58366707.RS 4
    58376708This is a boolean option that controls whether connections with usernames not in the
    58386709\fIuser\fR
    5839 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
     6710list 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
    58406711\fIuser\fR
    58416712list and is only really useful in
    5842 \fIsecurity = share\fR
    5843 level security\.
    5844 .sp
    5845 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
    5846 user = %S
     6713\m[blue]\fBsecurity = share\fR\m[]
     6714level security\&.
     6715.sp
     6716Note 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
     6717\FCuser = %S\F[]
    58476718which means your
    58486719\fIuser\fR
    5849 list will be just the service name, which for home directories is the name of the user\.
    5850 .sp
    5851 Default:
    5852 \fI\fIonly user\fR\fR\fI = \fR\fIno\fR\fI \fR
     6720list will be just the service name, which for home directories is the name of the user\&.
     6721.sp
     6722Default:
     6723\fI\fIonly user\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    58536724.RE
    58546725
    58556726open files database hash size (G)
    5856 .PP
    5857 .RS 4
    5858 This parameter was added in Samba 3\.0\.23\. This is an internal tuning parameter that sets the hash size of the tdb used for the open file databases\. The presence of this parameter allows tuning of the system for very large (thousands of concurrent users) Samba setups\. The default setting of this parameter should be sufficient for most normal environments\. It is advised not to change this parameter unless advised to by a Samba Team member\.
    5859 .sp
    5860 Default:
    5861 \fI\fIopen files database hash size\fR\fR\fI = \fR\fI10007\fR\fI \fR
    5862 .sp
    5863 Example:
    5864 \fI\fIopen files database hash size\fR\fR\fI = \fR\fI1338457\fR\fI \fR
     6727.\" open files database hash size
     6728.PP
     6729.RS 4
     6730This parameter was added in Samba 3\&.0\&.23\&. This is an internal tuning parameter that sets the hash size of the tdb used for the open file databases\&. The presence of this parameter allows tuning of the system for very large (thousands of concurrent users) Samba setups\&. The default setting of this parameter should be sufficient for most normal environments\&. It is advised not to change this parameter unless advised to by a Samba Team member\&.
     6731.sp
     6732Default:
     6733\fI\fIopen files database hash size\fR\fR\fI = \fR\fI\FC10007\F[]\fR\fI \fR
     6734.sp
     6735Example:
     6736\fI\fIopen files database hash size\fR\fR\fI = \fR\fI\FC1338457\F[]\fR\fI \fR
    58656737.RE
    58666738
    58676739oplock break wait time (G)
    5868 .PP
    5869 .RS 4
    5870 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\.
    5871 .sp
     6740.\" oplock break wait time
     6741.PP
     6742.RS 4
     6743This 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\&.
     6744.if n \{\
     6745.sp
     6746.\}
     6747.RS 4
     6748.BM yellow
    58726749.it 1 an-trap
    58736750.nr an-no-space-flag 1
    58746751.nr an-break-flag 1
    58756752.br
    5876 Warning
    5877 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\.
    5878 
    5879 Default:
    5880 \fI\fIoplock break wait time\fR\fR\fI = \fR\fI0\fR\fI \fR
     6753.ps +1
     6754\fBWarning\fR
     6755.ps -1
     6756.br
     6757DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
     6758.sp .5v
     6759.EM yellow
     6760.RE
     6761Default:
     6762\fI\fIoplock break wait time\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    58816763.RE
    58826764
    58836765oplock contention limit (S)
     6766.\" oplock contention limit
    58846767.PP
    58856768.RS 4
     
    58886771advanced
    58896772\fBsmbd\fR(8)
    5890 tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file\.
     6773tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file\&.
    58916774.sp
    58926775In brief it specifies a number, which causes
    5893 \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
    5894 smbd
    5895 to behave in a similar way to Windows NT\.
    5896 .sp
     6776\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
     6777\FCsmbd\F[]
     6778to behave in a similar way to Windows NT\&.
     6779.if n \{\
     6780.sp
     6781.\}
     6782.RS 4
     6783.BM yellow
    58976784.it 1 an-trap
    58986785.nr an-no-space-flag 1
    58996786.nr an-break-flag 1
    59006787.br
    5901 Warning
    5902 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\.
    5903 
    5904 Default:
    5905 \fI\fIoplock contention limit\fR\fR\fI = \fR\fI2\fR\fI \fR
     6788.ps +1
     6789\fBWarning\fR
     6790.ps -1
     6791.br
     6792DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
     6793.sp .5v
     6794.EM yellow
     6795.RE
     6796Default:
     6797\fI\fIoplock contention limit\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
    59066798.RE
    59076799
    59086800oplocks (S)
     6801.\" oplocks
    59096802.PP
    59106803.RS 4
    59116804This boolean option tells
    5912 smbd
    5913 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
    5914 \fISpeed\.txt\fR
     6805\FCsmbd\F[]
     6806whether 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
     6807\FCSpeed\&.txt\F[]
    59156808in the Samba
    5916 \fIdocs/\fR
    5917 directory\.
    5918 .sp
    5919 Oplocks may be selectively turned off on certain files with a share\. See the
    5920 \fIveto oplock files\fR
    5921 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
    5922 \fIkernel oplocks\fR
    5923 parameter for details\.
    5924 .sp
    5925 Default:
    5926 \fI\fIoplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6809\FCdocs/\F[]
     6810directory\&.
     6811.sp
     6812Oplocks may be selectively turned off on certain files with a share\&. See the
     6813\m[blue]\fBveto oplock files\fR\m[]
     6814parameter\&. 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
     6815\m[blue]\fBkernel oplocks\fR\m[]
     6816parameter for details\&.
     6817.sp
     6818Default:
     6819\fI\fIoplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    59276820.RE
    59286821
    59296822os2 driver map (G)
    5930 .PP
    5931 .RS 4
    5932 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:
    5933 .sp
    5934 <nt driver name> = <os2 driver name>\.<device name>
     6823.\" os2 driver map
     6824.PP
     6825.RS 4
     6826The 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:
     6827.sp
     6828<nt driver name> = <os2 driver name>\&.<device name>
    59356829.sp
    59366830For example, a valid entry using the HP LaserJet 5 printer driver would appear as
    5937 HP LaserJet 5L = LASERJET\.HP LaserJet 5L\.
    5938 .sp
    5939 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\.
    5940 .sp
    5941 Default:
    5942 \fI\fIos2 driver map\fR\fR\fI = \fR\fI\fR\fI \fR
     6831\FCHP LaserJet 5L = LASERJET\&.HP LaserJet 5L\F[]\&.
     6832.sp
     6833The 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\&.
     6834.sp
     6835Default:
     6836\fI\fIos2 driver map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    59436837.RE
    59446838
    59456839os level (G)
    5946 .PP
    5947 .RS 4
    5948 This integer value controls what level Samba advertises itself as for browse elections\. The value of this parameter determines whether
     6840.\" os level
     6841.PP
     6842.RS 4
     6843This integer value controls what level Samba advertises itself as for browse elections\&. The value of this parameter determines whether
    59496844\fBnmbd\fR(8)
    59506845has a chance of becoming a local master browser for the
    5951 \fIworkgroup\fR
    5952 in the local broadcast area\.
     6846\m[blue]\fBworkgroup\fR\m[]
     6847in the local broadcast area\&.
    59536848.sp
    59546849\fI Note:\fR
    5955 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\.
     6850By 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\&.
    59566851\fINote:\fR
    5957 The maximum value for this parameter is 255\. If you use higher values, counting will start at 0!
    5958 .sp
    5959 Default:
    5960 \fI\fIos level\fR\fR\fI = \fR\fI20\fR\fI \fR
    5961 .sp
    5962 Example:
    5963 \fI\fIos level\fR\fR\fI = \fR\fI65\fR\fI \fR
     6852The maximum value for this parameter is 255\&. If you use higher values, counting will start at 0!
     6853.sp
     6854Default:
     6855\fI\fIos level\fR\fR\fI = \fR\fI\FC20\F[]\fR\fI \fR
     6856.sp
     6857Example:
     6858\fI\fIos level\fR\fR\fI = \fR\fI\FC65\F[]\fR\fI \fR
    59646859.RE
    59656860
    59666861pam password change (G)
    5967 .PP
    5968 .RS 4
    5969 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
    5970 \fIpasswd program\fR\. It should be possible to enable this without changing your
    5971 \fIpasswd chat\fR
    5972 parameter for most setups\.
    5973 .sp
    5974 Default:
    5975 \fI\fIpam password change\fR\fR\fI = \fR\fIno\fR\fI \fR
     6862.\" pam password change
     6863.PP
     6864.RS 4
     6865With 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
     6866\m[blue]\fBpasswd program\fR\m[]\&. It should be possible to enable this without changing your
     6867\m[blue]\fBpasswd chat\fR\m[]
     6868parameter for most setups\&.
     6869.sp
     6870Default:
     6871\fI\fIpam password change\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    59766872.RE
    59776873
    59786874panic action (G)
     6875.\" panic action
    59796876.PP
    59806877.RS 4
     
    59836880or
    59846881\fBnmbd\fR(8)
    5985 crashes\. This is usually used to draw attention to the fact that a problem occurred\.
    5986 .sp
    5987 Default:
    5988 \fI\fIpanic action\fR\fR\fI = \fR\fI\fR\fI \fR
    5989 .sp
    5990 Example:
    5991 \fI\fIpanic action\fR\fR\fI = \fR\fI"/bin/sleep 90000"\fR\fI \fR
     6882crashes\&. This is usually used to draw attention to the fact that a problem occurred\&.
     6883.sp
     6884Default:
     6885\fI\fIpanic action\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     6886.sp
     6887Example:
     6888\fI\fIpanic action\fR\fR\fI = \fR\fI\FC"/bin/sleep 90000"\F[]\fR\fI \fR
    59926889.RE
    59936890
    59946891paranoid server security (G)
    5995 .PP
    5996 .RS 4
    5997 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\.
    5998 .sp
    5999 Disabling this option prevents Samba from making this check, which involves deliberatly attempting a bad logon to the remote server\.
    6000 .sp
    6001 Default:
    6002 \fI\fIparanoid server security\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6892.\" paranoid server security
     6893.PP
     6894.RS 4
     6895Some 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\&.
     6896.sp
     6897Disabling this option prevents Samba from making this check, which involves deliberatly attempting a bad logon to the remote server\&.
     6898.sp
     6899Default:
     6900\fI\fIparanoid server security\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    60036901.RE
    60046902
    60056903passdb backend (G)
    6006 .PP
    6007 .RS 4
    6008 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\.
    6009 .sp
    6010 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\.
     6904.\" passdb backend
     6905.PP
     6906.RS 4
     6907This 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\&.
     6908.sp
     6909The 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\&.
    60116910.sp
    60126911Available backends can include:
     
    60206919.IP \(bu 2.3
    60216920.\}
    6022 smbpasswd
    6023 \- The default smbpasswd backend\. Takes a path to the smbpasswd file as an optional argument\.
    6024 .RE
    6025 .sp
    6026 .RS 4
    6027 .ie n \{\
    6028 \h'-04'\(bu\h'+03'\c
    6029 .\}
    6030 .el \{\
    6031 .sp -1
    6032 .IP \(bu 2.3
    6033 .\}
    6034 tdbsam
    6035 \- The TDB based password storage backend\. Takes a path to the TDB as an optional argument (defaults to passdb\.tdb in the
    6036 \fIprivate dir\fR
    6037 directory\.
    6038 .RE
    6039 .sp
    6040 .RS 4
    6041 .ie n \{\
    6042 \h'-04'\(bu\h'+03'\c
    6043 .\}
    6044 .el \{\
    6045 .sp -1
    6046 .IP \(bu 2.3
    6047 .\}
    6048 ldapsam
    6049 \- The LDAP based passdb backend\. Takes an LDAP URL as an optional argument (defaults to
    6050 ldap://localhost)
    6051 .sp
    6052 LDAP connections should be secured where possible\. This may be done using either Start\-TLS (see
    6053 \fIldap ssl\fR) or by specifying
     6921\FCsmbpasswd\F[]
     6922\- The default smbpasswd backend\&. Takes a path to the smbpasswd file as an optional argument\&.
     6923.RE
     6924.sp
     6925.RS 4
     6926.ie n \{\
     6927\h'-04'\(bu\h'+03'\c
     6928.\}
     6929.el \{\
     6930.sp -1
     6931.IP \(bu 2.3
     6932.\}
     6933\FCtdbsam\F[]
     6934\- The TDB based password storage backend\&. Takes a path to the TDB as an optional argument (defaults to passdb\&.tdb in the
     6935\m[blue]\fBprivate dir\fR\m[]
     6936directory\&.
     6937.RE
     6938.sp
     6939.RS 4
     6940.ie n \{\
     6941\h'-04'\(bu\h'+03'\c
     6942.\}
     6943.el \{\
     6944.sp -1
     6945.IP \(bu 2.3
     6946.\}
     6947\FCldapsam\F[]
     6948\- The LDAP based passdb backend\&. Takes an LDAP URL as an optional argument (defaults to
     6949\FCldap://localhost\F[])
     6950.sp
     6951LDAP connections should be secured where possible\&. This may be done using either Start\-TLS (see
     6952\m[blue]\fBldap ssl\fR\m[]) or by specifying
    60546953\fIldaps://\fR
    6055 in the URL argument\.
    6056 .sp
    6057 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\.
     6954in the URL argument\&.
     6955.sp
     6956Multiple 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\&.
    60586957.sp
    60596958.RE
     
    60616960        Examples of use are:
    60626961.sp
    6063 .RS 4
     6962.if n \{\
     6963.RS 4
     6964.\}
     6965.fam C
     6966.ps -1
    60646967.nf
    6065 passdb backend = tdbsam:/etc/samba/private/passdb\.tdb
     6968.if t \{\
     6969.sp -1
     6970.\}
     6971.BB lightgray adjust-for-leading-newline
     6972.sp -1
     6973
     6974passdb backend = tdbsam:/etc/samba/private/passdb\&.tdb
    60666975
    60676976or multi server LDAP URL with OpenLDAP library:
    60686977
    6069 passdb backend = ldapsam:"ldap://ldap\-1\.example\.com ldap://ldap\-2\.example\.com"
     6978passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap://ldap\-2\&.example\&.com"
    60706979
    60716980or multi server LDAP URL with Netscape based LDAP library:
    60726981
    6073 passdb backend = ldapsam:"ldap://ldap\-1\.example\.com ldap\-2\.example\.com"
     6982passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap\-2\&.example\&.com"
     6983.EB lightgray adjust-for-leading-newline
     6984.if t \{\
     6985.sp 1
     6986.\}
    60746987.fi
    6075 .RE
    6076 Default:
    6077 \fI\fIpassdb backend\fR\fR\fI = \fR\fIsmbpasswd\fR\fI \fR
     6988.fam
     6989.ps +1
     6990.if n \{\
     6991.RE
     6992.\}
     6993.sp
     6994Default:
     6995\fI\fIpassdb backend\fR\fR\fI = \fR\fI\FCsmbpasswd\F[]\fR\fI \fR
    60786996.RE
    60796997
    60806998passdb expand explicit (G)
    6081 .PP
    6082 .RS 4
    6083 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\.
    6084 .sp
    6085 Default:
    6086 \fI\fIpassdb expand explicit\fR\fR\fI = \fR\fIno\fR\fI \fR
     6999.\" passdb expand explicit
     7000.PP
     7001.RS 4
     7002This 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\&.
     7003.sp
     7004Default:
     7005\fI\fIpassdb expand explicit\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    60877006.RE
    60887007
    60897008passwd chat debug (G)
     7009.\" passwd chat debug
    60907010.PP
    60917011.RS 4
    60927012This boolean specifies if the passwd chat script parameter is run in
    60937013\fIdebug\fR
    6094 mode\. In this mode the strings passed to and received from the passwd chat are printed in the
     7014mode\&. In this mode the strings passed to and received from the passwd chat are printed in the
    60957015\fBsmbd\fR(8)
    60967016log with a
    6097 \fIdebug level\fR
    6098 of 100\. This is a dangerous option as it will allow plaintext passwords to be seen in the
    6099 smbd
    6100 log\. It is available to help Samba admins debug their
     7017\m[blue]\fBdebug level\fR\m[]
     7018of 100\&. This is a dangerous option as it will allow plaintext passwords to be seen in the
     7019\FCsmbd\F[]
     7020log\&. It is available to help Samba admins debug their
    61017021\fIpasswd chat\fR
    61027022scripts when calling the
    61037023\fIpasswd program\fR
    6104 and should be turned off after this has been done\. This option has no effect if the
    6105 \fIpam password change\fR
    6106 parameter is set\. This parameter is off by default\.
    6107 .sp
    6108 Default:
    6109 \fI\fIpasswd chat debug\fR\fR\fI = \fR\fIno\fR\fI \fR
     7024and should be turned off after this has been done\&. This option has no effect if the
     7025\m[blue]\fBpam password change\fR\m[]
     7026parameter is set\&. This parameter is off by default\&.
     7027.sp
     7028Default:
     7029\fI\fIpasswd chat debug\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    61107030.RE
    61117031
    61127032passwd chat timeout (G)
    6113 .PP
    6114 .RS 4
    6115 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\.
    6116 .sp
    6117 Default:
    6118 \fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI2\fR\fI \fR
     7033.\" passwd chat timeout
     7034.PP
     7035.RS 4
     7036This 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\&.
     7037.sp
     7038Default:
     7039\fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
    61197040.RE
    61207041
    61217042passwd chat (G)
     7043.\" passwd chat
    61227044.PP
    61237045.RS 4
     
    61267048conversation that takes places between
    61277049\fBsmbd\fR(8)
    6128 and the local password changing program to change the user\'s password\. The string describes a sequence of response\-receive pairs that
     7050and the local password changing program to change the user\'s password\&. The string describes a sequence of response\-receive pairs that
    61297051\fBsmbd\fR(8)
    61307052uses to determine what to send to the
    6131 \fIpasswd program\fR
    6132 and what to expect back\. If the expected output is not received then the password is not changed\.
    6133 .sp
    6134 This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc)\.
     7053\m[blue]\fBpasswd program\fR\m[]
     7054and what to expect back\&. If the expected output is not received then the password is not changed\&.
     7055.sp
     7056This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc)\&.
    61357057.sp
    61367058Note that this parameter only is only used if the
    6137 \fIunix password sync\fR
     7059\m[blue]\fBunix password sync\fR\m[]
    61387060parameter is set to
    6139 \fByes\fR\. This sequence is then called
     7061\fByes\fR\&. This sequence is then called
    61407062\fIAS ROOT\fR
    6141 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
    6142 \fIpasswd program\fR
    6143 must be executed on the NIS master\.
     7063when 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
     7064\m[blue]\fBpasswd program\fR\m[]
     7065must be executed on the NIS master\&.
    61447066.sp
    61457067The string can contain the macro
    61467068\fI%n\fR
    6147 which is substituted for the new password\. The old passsword (\fI%o\fR) is only available when
    6148 \fIencrypt passwords\fR
    6149 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\.
    6150 .sp
    6151 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\.
     7069which is substituted for the new password\&. The old passsword (\fI%o\fR) is only available when
     7070\m[blue]\fBencrypt passwords\fR\m[]
     7071has 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\&.
     7072.sp
     7073If 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\&.
    61527074.sp
    61537075If the
    6154 \fIpam password change\fR
     7076\m[blue]\fBpam password change\fR\m[]
    61557077parameter is set to
    6156 \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\.
    6157 .sp
    6158 Default:
    6159 \fI\fIpasswd chat\fR\fR\fI = \fR\fI*new*password* %n\en*new*password* %n\en *changed*\fR\fI \fR
    6160 .sp
    6161 Example:
    6162 \fI\fIpasswd chat\fR\fR\fI = \fR\fI"*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"\fR\fI \fR
     7078\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\&.
     7079.sp
     7080Default:
     7081\fI\fIpasswd chat\fR\fR\fI = \fR\fI\FC*new*password* %n\en*new*password* %n\en *changed*\F[]\fR\fI \fR
     7082.sp
     7083Example:
     7084\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
    61637085.RE
    61647086
    61657087passwd program (G)
    6166 .PP
    6167 .RS 4
    6168 The name of a program that can be used to set UNIX user passwords\. Any occurrences of
     7088.\" passwd program
     7089.PP
     7090.RS 4
     7091The name of a program that can be used to set UNIX user passwords\&. Any occurrences of
    61697092\fI%u\fR
    6170 will be replaced with the user name\. The user name is checked for existence before calling the password changing program\.
     7093will be replaced with the user name\&. The user name is checked for existence before calling the password changing program\&.
    61717094.sp
    61727095Also note that many passwd programs insist in
    61737096\fIreasonable \fR
    6174 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\.
     7097passwords, 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\&.
    61757098.sp
    61767099\fINote\fR
     
    61817104then this program is called
    61827105\fIAS ROOT\fR
    6183 before the SMB password in the smbpasswd file is changed\. If this UNIX password change fails, then
    6184 smbd
    6185 will fail to change the SMB password also (this is by design)\.
     7106before the SMB password in the smbpasswd file is changed\&. If this UNIX password change fails, then
     7107\FCsmbd\F[]
     7108will fail to change the SMB password also (this is by design)\&.
    61867109.sp
    61877110If the
     
    61917114for
    61927115\fIALL\fR
    6193 programs called, and must be examined for security implications\. Note that by default
     7116programs called, and must be examined for security implications\&. Note that by default
    61947117\fIunix password sync\fR
    61957118is set to
    6196 \fBno\fR\.
    6197 .sp
    6198 Default:
    6199 \fI\fIpasswd program\fR\fR\fI = \fR\fI\fR\fI \fR
    6200 .sp
    6201 Example:
    6202 \fI\fIpasswd program\fR\fR\fI = \fR\fI/bin/passwd %u\fR\fI \fR
     7119\fBno\fR\&.
     7120.sp
     7121Default:
     7122\fI\fIpasswd program\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7123.sp
     7124Example:
     7125\fI\fIpasswd program\fR\fR\fI = \fR\fI\FC/bin/passwd %u\F[]\fR\fI \fR
    62037126.RE
    62047127
    62057128password level (G)
    6206 .PP
    6207 .RS 4
    6208 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\.
    6209 .sp
    6210 This parameter defines the maximum number of characters that may be upper case in passwords\.
    6211 .sp
    6212 For example, say the password given was "FRED"\. If
     7129.\" password level
     7130.PP
     7131.RS 4
     7132Some 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\&.
     7133.sp
     7134This parameter defines the maximum number of characters that may be upper case in passwords\&.
     7135.sp
     7136For example, say the password given was "FRED"\&. If
    62137137\fI password level\fR
    62147138is set to 1, the following combinations would be tried if "FRED" failed:
     
    62207144was set to 2, the following combinations would also be tried:
    62217145.sp
    6222 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", \.\.
    6223 .sp
    6224 And so on\.
    6225 .sp
    6226 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\.
    6227 .sp
    6228 A value of zero will cause only two attempts to be made \- the password as is and the password in all\-lower case\.
    6229 .sp
    6230 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
    6231 \fIencrypt passwords = No\fR\.
    6232 .sp
    6233 Default:
    6234 \fI\fIpassword level\fR\fR\fI = \fR\fI0\fR\fI \fR
    6235 .sp
    6236 Example:
    6237 \fI\fIpassword level\fR\fR\fI = \fR\fI4\fR\fI \fR
     7146"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", \&.\&.
     7147.sp
     7148And so on\&.
     7149.sp
     7150The 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\&.
     7151.sp
     7152A value of zero will cause only two attempts to be made \- the password as is and the password in all\-lower case\&.
     7153.sp
     7154This 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
     7155\m[blue]\fBencrypt passwords = No\fR\m[]\&.
     7156.sp
     7157Default:
     7158\fI\fIpassword level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     7159.sp
     7160Example:
     7161\fI\fIpassword level\fR\fR\fI = \fR\fI\FC4\F[]\fR\fI \fR
    62387162.RE
    62397163
    62407164password server (G)
     7165.\" password server
    62417166.PP
    62427167.RS 4
    62437168By specifying the name of another SMB server or Active Directory domain controller with this option, and using
    6244 security = [ads|domain|server]
    6245 it is possible to get Samba to to do all its username/password validation using a specific remote server\.
    6246 .sp
    6247 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\.
     7169\FCsecurity = [ads|domain|server]\F[]
     7170it is possible to get Samba to to do all its username/password validation using a specific remote server\&.
     7171.sp
     7172This 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\&.
    62487173.sp
    62497174If parameter is a name, it is looked up using the parameter
    6250 \fIname resolve order\fR
    6251 and so may resolved by any method and order described in that parameter\.
    6252 .sp
    6253 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\.
    6254 .sp
     7175\m[blue]\fBname resolve order\fR\m[]
     7176and so may resolved by any method and order described in that parameter\&.
     7177.sp
     7178The 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\&.
     7179.if n \{\
     7180.sp
     7181.\}
     7182.RS 4
     7183.BM yellow
    62557184.it 1 an-trap
    62567185.nr an-no-space-flag 1
    62577186.nr an-break-flag 1
    62587187.br
    6259 Note
    6260 Using a password server means your UNIX box (running Samba) is only as secure as your password server\.
    6261 \fIDO NOT CHOOSE A PASSWORD SERVER THAT YOU DON\'T COMPLETELY TRUST\fR\.
    6262 
    6263 Never point a Samba server at itself for password serving\. This will cause a loop and could lock up your Samba server!
     7188.ps +1
     7189\fBNote\fR
     7190.ps -1
     7191.br
     7192Using a password server means your UNIX box (running Samba) is only as secure as your password server\&.
     7193\fIDO NOT CHOOSE A PASSWORD SERVER THAT YOU DON\'T COMPLETELY TRUST\fR\&.
     7194.sp .5v
     7195.EM yellow
     7196.RE
     7197Never point a Samba server at itself for password serving\&. This will cause a loop and could lock up your Samba server!
    62647198.sp
    62657199The name of the password server takes the standard substitutions, but probably the only useful one is
    6266 \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!
     7200\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!
    62677201.sp
    62687202If the
     
    62717205\fBdomain\fR
    62727206or
    6273 \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
    6274 security = domain
     7207\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
     7208\FC security = domain\F[]
    62757209is that if you list several hosts in the
    62767210\fIpassword server\fR
    62777211option then
    6278 smbd
    6279 will try each in turn till it finds one that responds\. This is useful in case your primary server goes down\.
     7212\FCsmbd \F[]
     7213will try each in turn till it finds one that responds\&. This is useful in case your primary server goes down\&.
    62807214.sp
    62817215If the
     
    62837217option 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
    62847218\fBWORKGROUP<1C>\fR
    6285 and then contacting each server returned in the list of IP addresses from the name resolution source\.
    6286 .sp
    6287 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\.
     7219and then contacting each server returned in the list of IP addresses from the name resolution source\&.
     7220.sp
     7221If 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\&.
    62887222.sp
    62897223If the
     
    62917225parameter is set to
    62927226\fBserver\fR, then there are different restrictions that
    6293 security = domain
     7227\FCsecurity = domain\F[]
    62947228doesn\'t suffer from:
    62957229.sp
     
    63057239\fIpassword server\fR
    63067240parameter, however if an
    6307 smbd
     7241\FCsmbd\F[]
    63087242makes a connection to a password server, and then the password server fails, no more users will be able to be authenticated from this
    6309 smbd\. This is a restriction of the SMB/CIFS protocol when in
    6310 security = server
    6311 mode and cannot be fixed in Samba\.
     7243\FCsmbd\F[]\&. This is a restriction of the SMB/CIFS protocol when in
     7244\FCsecurity = server \F[]
     7245mode and cannot be fixed in Samba\&.
    63127246.RE
    63137247.sp
     
    63217255.\}
    63227256If 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
    6323 security = server
    6324 mode the network logon will appear to come from there rather than from the users workstation\.
    6325 .sp
    6326 .RE
    6327 Default:
    6328 \fI\fIpassword server\fR\fR\fI = \fR\fI*\fR\fI \fR
    6329 .sp
    6330 Example:
    6331 \fI\fIpassword server\fR\fR\fI = \fR\fINT\-PDC, NT\-BDC1, NT\-BDC2, *\fR\fI \fR
    6332 .sp
    6333 Example:
    6334 \fI\fIpassword server\fR\fR\fI = \fR\fIwindc\.mydomain\.com:389 192\.168\.1\.101 *\fR\fI \fR
     7257\FC security = server\F[]
     7258mode the network logon will appear to come from there rather than from the users workstation\&.
     7259.sp
     7260.RE
     7261Default:
     7262\fI\fIpassword server\fR\fR\fI = \fR\fI\FC*\F[]\fR\fI \fR
     7263.sp
     7264Example:
     7265\fI\fIpassword server\fR\fR\fI = \fR\fI\FCNT\-PDC, NT\-BDC1, NT\-BDC2, *\F[]\fR\fI \fR
     7266.sp
     7267Example:
     7268\fI\fIpassword server\fR\fR\fI = \fR\fI\FCwindc\&.mydomain\&.com:389 192\&.168\&.1\&.101 *\F[]\fR\fI \fR
    63357269.RE
    63367270
    63377271directory
     7272.\" directory
    63387273.PP
    63397274.RS 4
    63407275This parameter is a synonym for
    6341 path\.
     7276path\&.
    63427277.RE
    63437278
    63447279path (S)
    6345 .PP
    6346 .RS 4
    6347 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\.
    6348 .sp
    6349 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\.
     7280.\" path
     7281.PP
     7282.RS 4
     7283This 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\&.
     7284.sp
     7285For 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\&.
    63507286.sp
    63517287Any occurrences of
    63527288\fI%u\fR
    6353 in the path will be replaced with the UNIX username that the client is using on this connection\. Any occurrences of
     7289in the path will be replaced with the UNIX username that the client is using on this connection\&. Any occurrences of
    63547290\fI%m\fR
    6355 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\.
     7291will 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\&.
    63567292.sp
    63577293Note that this path will be based on
    6358 \fIroot dir\fR
    6359 if one was specified\.
    6360 .sp
    6361 Default:
    6362 \fI\fIpath\fR\fR\fI = \fR\fI\fR\fI \fR
    6363 .sp
    6364 Example:
    6365 \fI\fIpath\fR\fR\fI = \fR\fI/home/fred\fR\fI \fR
     7294\m[blue]\fBroot dir\fR\m[]
     7295if one was specified\&.
     7296.sp
     7297Default:
     7298\fI\fIpath\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7299.sp
     7300Example:
     7301\fI\fIpath\fR\fR\fI = \fR\fI\FC/home/fred\F[]\fR\fI \fR
    63667302.RE
    63677303
    63687304pid directory (G)
    6369 .PP
    6370 .RS 4
    6371 This option specifies the directory where pid files will be placed\.
    6372 .sp
    6373 Default:
    6374 \fI\fIpid directory\fR\fR\fI = \fR\fI${prefix}/var/locks\fR\fI \fR
    6375 .sp
    6376 Example:
    6377 \fI\fIpid directory\fR\fR\fI = \fR\fIpid directory = /var/run/\fR\fI \fR
     7305.\" pid directory
     7306.PP
     7307.RS 4
     7308This option specifies the directory where pid files will be placed\&.
     7309.sp
     7310Default:
     7311\fI\fIpid directory\fR\fR\fI = \fR\fI\FC${prefix}/var/locks\F[]\fR\fI \fR
     7312.sp
     7313Example:
     7314\fI\fIpid directory\fR\fR\fI = \fR\fI\FCpid directory = /var/run/\F[]\fR\fI \fR
    63787315.RE
    63797316
    63807317posix locking (S)
     7318.\" posix locking
    63817319.PP
    63827320.RS 4
    63837321The
    63847322\fBsmbd\fR(8)
    6385 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\.
    6386 .sp
    6387 Default:
    6388 \fI\fIposix locking\fR\fR\fI = \fR\fIyes\fR\fI \fR
     7323daemon 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\&.
     7324.sp
     7325Default:
     7326\fI\fIposix locking\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    63897327.RE
    63907328
    63917329postexec (S)
    6392 .PP
    6393 .RS 4
    6394 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\.
     7330.\" postexec
     7331.PP
     7332.RS 4
     7333This 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\&.
    63957334.sp
    63967335An interesting example may be to unmount server resources:
    63977336.sp
    6398 postexec = /etc/umount /cdrom
    6399 .sp
    6400 Default:
    6401 \fI\fIpostexec\fR\fR\fI = \fR\fI\fR\fI \fR
    6402 .sp
    6403 Example:
    6404 \fI\fIpostexec\fR\fR\fI = \fR\fIecho \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log\fR\fI \fR
     7337\FCpostexec = /etc/umount /cdrom\F[]
     7338.sp
     7339Default:
     7340\fI\fIpostexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7341.sp
     7342Example:
     7343\fI\fIpostexec\fR\fR\fI = \fR\fI\FCecho \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log\F[]\fR\fI \fR
    64057344.RE
    64067345
    64077346preexec close (S)
     7347.\" preexec close
    64087348.PP
    64097349.RS 4
    64107350This boolean option controls whether a non\-zero return code from
    6411 \fIpreexec\fR
    6412 should close the service being connected to\.
    6413 .sp
    6414 Default:
    6415 \fI\fIpreexec close\fR\fR\fI = \fR\fIno\fR\fI \fR
     7351\m[blue]\fBpreexec\fR\m[]
     7352should close the service being connected to\&.
     7353.sp
     7354Default:
     7355\fI\fIpreexec close\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    64167356.RE
    64177357
    64187358exec
     7359.\" exec
    64197360.PP
    64207361.RS 4
    64217362This parameter is a synonym for
    6422 preexec\.
     7363preexec\&.
    64237364.RE
    64247365
    64257366preexec (S)
    6426 .PP
    6427 .RS 4
    6428 This option specifies a command to be run whenever the service is connected to\. It takes the usual substitutions\.
    6429 .sp
    6430 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:
    6431 .sp
    6432 
    6433 preexec = csh \-c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient \-M %m \-I %I\' &
     7367.\" preexec
     7368.PP
     7369.RS 4
     7370This option specifies a command to be run whenever the service is connected to\&. It takes the usual substitutions\&.
     7371.sp
     7372An 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:
     7373.sp
     7374
     7375\FCpreexec = csh \-c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient \-M %m \-I %I\' & \F[]
    64347376.sp
    64357377Of course, this could get annoying after a while :\-)
    64367378.sp
    64377379See also
    6438 \fIpreexec close\fR
     7380\m[blue]\fBpreexec close\fR\m[]
    64397381and
    6440 \fIpostexec\fR\.
    6441 .sp
    6442 Default:
    6443 \fI\fIpreexec\fR\fR\fI = \fR\fI\fR\fI \fR
    6444 .sp
    6445 Example:
    6446 \fI\fIpreexec\fR\fR\fI = \fR\fIecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fR\fI \fR
     7382\m[blue]\fBpostexec\fR\m[]\&.
     7383.sp
     7384Default:
     7385\fI\fIpreexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7386.sp
     7387Example:
     7388\fI\fIpreexec\fR\fR\fI = \fR\fI\FCecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\F[]\fR\fI \fR
    64477389.RE
    64487390
    64497391prefered master
     7392.\" prefered master
    64507393.PP
    64517394.RS 4
    64527395This parameter is a synonym for
    6453 preferred master\.
     7396preferred master\&.
    64547397.RE
    64557398
    64567399preferred master (G)
     7400.\" preferred master
    64577401.PP
    64587402.RS 4
    64597403This boolean parameter controls if
    64607404\fBnmbd\fR(8)
    6461 is a preferred master browser for its workgroup\.
     7405is a preferred master browser for its workgroup\&.
    64627406.sp
    64637407If this is set to
    64647408\fByes\fR, on startup,
    6465 nmbd
    6466 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
    6467 \fIdomain master = yes\fR, so that
    6468 nmbd
    6469 can guarantee becoming a domain master\.
    6470 .sp
    6471 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\.
    6472 .sp
    6473 Default:
    6474 \fI\fIpreferred master\fR\fR\fI = \fR\fIauto\fR\fI \fR
     7409\FCnmbd\F[]
     7410will 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
     7411\m[blue]\fBdomain master = yes\fR\m[], so that
     7412\FCnmbd\F[]
     7413can guarantee becoming a domain master\&.
     7414.sp
     7415Use 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\&.
     7416.sp
     7417Default:
     7418\fI\fIpreferred master\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
    64757419.RE
    64767420
    64777421preload modules (G)
    6478 .PP
    6479 .RS 4
    6480 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\.
    6481 .sp
    6482 Default:
    6483 \fI\fIpreload modules\fR\fR\fI = \fR\fI\fR\fI \fR
    6484 .sp
    6485 Example:
    6486 \fI\fIpreload modules\fR\fR\fI = \fR\fI/usr/lib/samba/passdb/mysql\.so\fR\fI \fR
     7422.\" preload modules
     7423.PP
     7424.RS 4
     7425This 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\&.
     7426.sp
     7427Default:
     7428\fI\fIpreload modules\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7429.sp
     7430Example:
     7431\fI\fIpreload modules\fR\fR\fI = \fR\fI\FC/usr/lib/samba/passdb/mysql\&.so\F[]\fR\fI \fR
    64877432.RE
    64887433
    64897434auto services
     7435.\" auto services
    64907436.PP
    64917437.RS 4
    64927438This parameter is a synonym for
    6493 preload\.
     7439preload\&.
    64947440.RE
    64957441
    64967442preload (G)
    6497 .PP
    6498 .RS 4
    6499 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\.
     7443.\" preload
     7444.PP
     7445.RS 4
     7446This 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\&.
    65007447.sp
    65017448Note that if you just want all printers in your printcap file loaded then the
    6502 \fIload printers\fR
    6503 option is easier\.
    6504 .sp
    6505 Default:
    6506 \fI\fIpreload\fR\fR\fI = \fR\fI\fR\fI \fR
    6507 .sp
    6508 Example:
    6509 \fI\fIpreload\fR\fR\fI = \fR\fIfred lp colorlp\fR\fI \fR
     7449\m[blue]\fBload printers\fR\m[]
     7450option is easier\&.
     7451.sp
     7452Default:
     7453\fI\fIpreload\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7454.sp
     7455Example:
     7456\fI\fIpreload\fR\fR\fI = \fR\fI\FCfred lp colorlp\F[]\fR\fI \fR
    65107457.RE
    65117458
    65127459preserve case (S)
     7460.\" preserve case
    65137461.PP
    65147462.RS 4
    65157463This controls if new filenames are created with the case that the client passes, or if they are forced to be the
    6516 \fIdefault case\fR\.
     7464\m[blue]\fBdefault case\fR\m[]\&.
    65177465.sp
    65187466See the section on
    65197467NAME MANGLING
    6520 for a fuller discussion\.
    6521 .sp
    6522 Default:
    6523 \fI\fIpreserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR
     7468for a fuller discussion\&.
     7469.sp
     7470Default:
     7471\fI\fIpreserve case\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    65247472.RE
    65257473
    65267474print ok
     7475.\" print ok
    65277476.PP
    65287477.RS 4
    65297478This parameter is a synonym for
    6530 printable\.
     7479printable\&.
    65317480.RE
    65327481
    65337482printable (S)
     7483.\" printable
    65347484.PP
    65357485.RS 4
    65367486If this parameter is
    6537 \fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\.
    6538 .sp
    6539 Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\. The
    6540 \fIread only\fR
    6541 parameter controls only non\-printing access to the resource\.
    6542 .sp
    6543 Default:
    6544 \fI\fIprintable\fR\fR\fI = \fR\fIno\fR\fI \fR
     7487\fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\&.
     7488.sp
     7489Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\&. The
     7490\m[blue]\fBread only\fR\m[]
     7491parameter controls only non\-printing access to the resource\&.
     7492.sp
     7493Default:
     7494\fI\fIprintable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    65457495.RE
    65467496
    65477497printcap cache time (G)
    6548 .PP
    6549 .RS 4
    6550 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\.
    6551 .sp
    6552 Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\.
    6553 .sp
    6554 Default:
    6555 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI750\fR\fI \fR
    6556 .sp
    6557 Example:
    6558 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI600\fR\fI \fR
     7498.\" printcap cache time
     7499.PP
     7500.RS 4
     7501This 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\&.
     7502.sp
     7503Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\&.
     7504.sp
     7505Default:
     7506\fI\fIprintcap cache time\fR\fR\fI = \fR\fI\FC750\F[]\fR\fI \fR
     7507.sp
     7508Example:
     7509\fI\fIprintcap cache time\fR\fR\fI = \fR\fI\FC600\F[]\fR\fI \fR
    65597510.RE
    65607511
    65617512printcap
     7513.\" printcap
    65627514.PP
    65637515.RS 4
    65647516This parameter is a synonym for
    6565 printcap name\.
     7517printcap name\&.
    65667518.RE
    65677519
    65687520printcap name (G)
     7521.\" printcap name
    65697522.PP
    65707523.RS 4
    65717524This parameter may be used to override the compiled\-in default printcap name used by the server (usually
    6572 \fI /etc/printcap\fR)\. See the discussion of the
     7525\FC /etc/printcap\F[])\&. See the discussion of the
    65737526[printers]
    6574 section above for reasons why you might want to do this\.
     7527section above for reasons why you might want to do this\&.
    65757528.sp
    65767529To use the CUPS printing interface set
    6577 printcap name = cups\. This should be supplemented by an addtional setting
    6578 \fIprinting = cups\fR
    6579 in the [global] section\.
    6580 printcap name = cups
    6581 will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\.
     7530\FCprintcap name = cups \F[]\&. This should be supplemented by an addtional setting
     7531\m[blue]\fBprinting = cups\fR\m[]
     7532in the [global] section\&.
     7533\FCprintcap name = cups\F[]
     7534will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\&.
    65827535.sp
    65837536On System V systems that use
    6584 lpstat
     7537\FClpstat\F[]
    65857538to list available printers you can use
    6586 printcap name = lpstat
    6587 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
     7539\FCprintcap name = lpstat \F[]
     7540to 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
    65887541\fI printcap name\fR
    65897542is set to
    6590 lpstat
     7543\FClpstat\F[]
    65917544on these systems then Samba will launch
    6592 lpstat \-v
    6593 and attempt to parse the output to obtain a printer list\.
     7545\FClpstat \-v\F[]
     7546and attempt to parse the output to obtain a printer list\&.
    65947547.sp
    65957548A minimal printcap file would look something like this:
    65967549.sp
    6597 .RS 4
     7550.if n \{\
     7551.RS 4
     7552.\}
     7553.fam C
     7554.ps -1
    65987555.nf
     7556.if t \{\
     7557.sp -1
     7558.\}
     7559.BB lightgray adjust-for-leading-newline
     7560.sp -1
     7561
    65997562print1|My Printer 1
    66007563print2|My Printer 2
     
    66027565print4|My Printer 4
    66037566print5|My Printer 5
     7567.EB lightgray adjust-for-leading-newline
     7568.if t \{\
     7569.sp 1
     7570.\}
    66047571.fi
    6605 .RE
    6606 .sp
    6607 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\.
    6608 .sp
     7572.fam
     7573.ps +1
     7574.if n \{\
     7575.RE
     7576.\}
     7577.sp
     7578where 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\&.
     7579.if n \{\
     7580.sp
     7581.\}
     7582.RS 4
     7583.BM yellow
    66097584.it 1 an-trap
    66107585.nr an-no-space-flag 1
    66117586.nr an-break-flag 1
    66127587.br
    6613 Note
     7588.ps +1
     7589\fBNote\fR
     7590.ps -1
     7591.br
    66147592Under AIX the default printcap name is
    6615 \fI/etc/qconfig\fR\. Samba will assume the file is in AIX
    6616 \fIqconfig\fR
     7593\FC/etc/qconfig\F[]\&. Samba will assume the file is in AIX
     7594\FCqconfig\F[]
    66177595format if the string
    6618 \fIqconfig\fR
    6619 appears in the printcap filename\.
    6620 
    6621 Default:
    6622 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/printcap\fR\fI \fR
    6623 .sp
    6624 Example:
    6625 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/myprintcap\fR\fI \fR
     7596\FCqconfig\F[]
     7597appears in the printcap filename\&.
     7598.sp .5v
     7599.EM yellow
     7600.RE
     7601Default:
     7602\fI\fIprintcap name\fR\fR\fI = \fR\fI\FC/etc/printcap\F[]\fR\fI \fR
     7603.sp
     7604Example:
     7605\fI\fIprintcap name\fR\fR\fI = \fR\fI\FC/etc/myprintcap\F[]\fR\fI \fR
    66267606.RE
    66277607
    66287608print command (S)
     7609.\" print command
    66297610.PP
    66307611.RS 4
    66317612After a print job has finished spooling to a service, this command will be used via a
    6632 system()
    6633 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\.
    6634 .sp
    6635 The print command is simply a text string\. It will be used verbatim after macro substitutions have been made:
     7613\FCsystem()\F[]
     7614call 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\&.
     7615.sp
     7616The print command is simply a text string\&. It will be used verbatim after macro substitutions have been made:
    66367617.sp
    66377618%s, %f \- the path to the spool file name
     
    66397620%p \- the appropriate printer name
    66407621.sp
    6641 %J \- the job name as transmitted by the client\.
    6642 .sp
    6643 %c \- The number of printed pages of the spooled job (if known)\.
     7622%J \- the job name as transmitted by the client\&.
     7623.sp
     7624%c \- The number of printed pages of the spooled job (if known)\&.
    66447625.sp
    66457626%z \- the size of the spooled print job (in bytes)
     
    66537634\- the
    66547635\fI%p\fR
    6655 is optional\. At the time a job is submitted, if no printer name is supplied the
     7636is optional\&. At the time a job is submitted, if no printer name is supplied the
    66567637\fI%p \fR
    6657 will be silently removed from the printer command\.
    6658 .sp
    6659 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\.
    6660 .sp
    6661 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\.
     7638will be silently removed from the printer command\&.
     7639.sp
     7640If 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\&.
     7641.sp
     7642If 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\&.
    66627643.sp
    66637644Note that printing may fail on some UNIXes from the
    66647645\fBnobody\fR
    6665 account\. If this happens then create an alternative guest account that can print and set the
    6666 \fIguest account\fR
    6667 in the [global] section\.
    6668 .sp
    6669 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\.
    6670 .sp
    6671 print command = echo Printing %s >> /tmp/print\.log; lpr \-P %p %s; rm %s
    6672 .sp
    6673 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
    6674 \fIprinting\fR
    6675 parameter\.
     7646account\&. If this happens then create an alternative guest account that can print and set the
     7647\m[blue]\fBguest account\fR\m[]
     7648in the [global] section\&.
     7649.sp
     7650You 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\&.
     7651.sp
     7652\FCprint command = echo Printing %s >> /tmp/print\&.log; lpr \-P %p %s; rm %s\F[]
     7653.sp
     7654You 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
     7655\m[blue]\fBprinting\fR\m[]
     7656parameter\&.
    66767657.sp
    66777658Default: For
    6678 printing = BSD, AIX, QNX, LPRNG or PLP :
    6679 .sp
    6680 print command = lpr \-r \-P%p %s
     7659\FCprinting = BSD, AIX, QNX, LPRNG or PLP :\F[]
     7660.sp
     7661\FCprint command = lpr \-r \-P%p %s\F[]
    66817662.sp
    66827663For
    6683 printing = SYSV or HPUX :
    6684 .sp
    6685 print command = lp \-c \-d%p %s; rm %s
     7664\FCprinting = SYSV or HPUX :\F[]
     7665.sp
     7666\FCprint command = lp \-c \-d%p %s; rm %s\F[]
    66867667.sp
    66877668For
    6688 printing = SOFTQ :
    6689 .sp
    6690 print command = lp \-d%p \-s %s; rm %s
     7669\FCprinting = SOFTQ :\F[]
     7670.sp
     7671\FCprint command = lp \-d%p \-s %s; rm %s\F[]
    66917672.sp
    66927673For printing = CUPS : If SAMBA is compiled against libcups, then
    6693 \fIprintcap = cups\fR
    6694 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
    6695 lp \-c \-d%p \-oraw; rm %s\. With
    6696 printing = cups, and if SAMBA is compiled against libcups, any manually set print command will be ignored\.
     7674\m[blue]\fBprintcap = cups\fR\m[]
     7675uses 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
     7676\FClp \-c \-d%p \-oraw; rm %s\F[]\&. With
     7677\FCprinting = cups\F[], and if SAMBA is compiled against libcups, any manually set print command will be ignored\&.
    66977678.sp
    66987679\fINo default\fR
    66997680.sp
    67007681Example:
    6701 \fI\fIprint command\fR\fR\fI = \fR\fI/usr/local/samba/bin/myprintscript %p %s\fR\fI \fR
     7682\fI\fIprint command\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/myprintscript %p %s\F[]\fR\fI \fR
    67027683.RE
    67037684
    67047685printer admin (S)
    6705 .PP
    6706 .RS 4
    6707 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\.
    6708 .sp
    6709 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\.
    6710 .sp
    6711 Default:
    6712 \fI\fIprinter admin\fR\fR\fI = \fR\fI\fR\fI \fR
    6713 .sp
    6714 Example:
    6715 \fI\fIprinter admin\fR\fR\fI = \fR\fIadmin, @staff\fR\fI \fR
     7686.\" printer admin
     7687.PP
     7688.RS 4
     7689This 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\&.
     7690.sp
     7691This parameter has been marked deprecated in favor of using the SePrintOperatorPrivilege and individual print security descriptors\&. It will be removed in a future release\&.
     7692.sp
     7693Default:
     7694\fI\fIprinter admin\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7695.sp
     7696Example:
     7697\fI\fIprinter admin\fR\fR\fI = \fR\fI\FCadmin, @staff\F[]\fR\fI \fR
    67167698.RE
    67177699
    67187700printer
     7701.\" printer
    67197702.PP
    67207703.RS 4
    67217704This parameter is a synonym for
    6722 printer name\.
     7705printer name\&.
    67237706.RE
    67247707
    67257708printer name (S)
    6726 .PP
    6727 .RS 4
    6728 This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\.
    6729 .sp
    6730 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\.
     7709.\" printer name
     7710.PP
     7711.RS 4
     7712This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\&.
     7713.sp
     7714If 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\&.
    67317715.sp
    67327716The default value of the
    6733 \fIprinter name\fR
     7717\m[blue]\fBprinter name\fR\m[]
    67347718may be
    6735 lp
    6736 on many systems\.
    6737 .sp
    6738 Default:
    6739 \fI\fIprinter name\fR\fR\fI = \fR\fInone\fR\fI \fR
    6740 .sp
    6741 Example:
    6742 \fI\fIprinter name\fR\fR\fI = \fR\fIlaserwriter\fR\fI \fR
     7719\FClp\F[]
     7720on many systems\&.
     7721.sp
     7722Default:
     7723\fI\fIprinter name\fR\fR\fI = \fR\fI\FCnone\F[]\fR\fI \fR
     7724.sp
     7725Example:
     7726\fI\fIprinter name\fR\fR\fI = \fR\fI\FClaserwriter\F[]\fR\fI \fR
    67437727.RE
    67447728
    67457729printing (S)
    6746 .PP
    6747 .RS 4
    6748 This parameters controls how printer status information is interpreted on your system\. It also affects the default values for the
     7730.\" printing
     7731.PP
     7732.RS 4
     7733This parameters controls how printer status information is interpreted on your system\&. It also affects the default values for the
    67497734\fIprint command\fR,
    67507735\fIlpq command\fR,
     
    67527737\fIlpresume command\fR, and
    67537738\fIlprm command\fR
    6754 if specified in the [global] section\.
    6755 .sp
    6756 Currently nine printing styles are supported\. They are
     7739if specified in the [global] section\&.
     7740.sp
     7741Currently nine printing styles are supported\&. They are
    67577742\fBBSD\fR,
    67587743\fBAIX\fR,
     
    67637748\fBQNX\fR,
    67647749\fBSOFTQ\fR, and
    6765 \fBCUPS\fR\.
     7750\fBCUPS\fR\&.
    67667751.sp
    67677752To see what the defaults are for the other print commands when using the various options use the
    67687753\fBtestparm\fR(1)
    6769 program\.
    6770 .sp
    6771 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
     7754program\&.
     7755.sp
     7756This 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
    67727757\fIprinting\fR
    6773 option since it will reset the printing commands to default values\.
     7758option since it will reset the printing commands to default values\&.
    67747759.sp
    67757760See also the discussion in the
    67767761[printers]
    6777 section\.
     7762section\&.
    67787763.sp
    67797764\fINo default\fR
     
    67817766
    67827767printjob username (S)
    6783 .PP
    6784 .RS 4
    6785 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\.
    6786 .sp
    6787 Default:
    6788 \fI\fIprintjob username\fR\fR\fI = \fR\fI%U\fR\fI \fR
    6789 .sp
    6790 Example:
    6791 \fI\fIprintjob username\fR\fR\fI = \fR\fI%D\e%U\fR\fI \fR
     7768.\" printjob username
     7769.PP
     7770.RS 4
     7771This 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\&.
     7772.sp
     7773Default:
     7774\fI\fIprintjob username\fR\fR\fI = \fR\fI\FC%U\F[]\fR\fI \fR
     7775.sp
     7776Example:
     7777\fI\fIprintjob username\fR\fR\fI = \fR\fI\FC%D\e%U\F[]\fR\fI \fR
    67927778.RE
    67937779
    67947780private dir (G)
     7781.\" private dir
    67957782.PP
    67967783.RS 4
    67977784This parameters defines the directory smbd will use for storing such files as
    6798 \fIsmbpasswd\fR
     7785\FCsmbpasswd\F[]
    67997786and
    6800 \fIsecrets\.tdb\fR\.
    6801 .sp
    6802 Default:
    6803 \fI\fIprivate dir\fR\fR\fI = \fR\fI${prefix}/private\fR\fI \fR
     7787\FCsecrets\&.tdb\F[]\&.
     7788.sp
     7789Default:
     7790\fI\fIprivate dir\fR\fR\fI = \fR\fI\FC${prefix}/private\F[]\fR\fI \fR
    68047791.RE
    68057792
    68067793profile acls (S)
    6807 .PP
    6808 .RS 4
    6809 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\.
    6810 .sp
    6811 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\.
    6812 .sp
    6813 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\.
    6814 .sp
    6815 Default:
    6816 \fI\fIprofile acls\fR\fR\fI = \fR\fIno\fR\fI \fR
     7794.\" profile acls
     7795.PP
     7796.RS 4
     7797This 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\&.
     7798.sp
     7799When 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\&.
     7800.sp
     7801Note 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\&.
     7802.sp
     7803Default:
     7804\fI\fIprofile acls\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    68177805.RE
    68187806
    68197807queuepause command (S)
    6820 .PP
    6821 .RS 4
    6822 This parameter specifies the command to be executed on the server host in order to pause the printer queue\.
    6823 .sp
    6824 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\.
    6825 .sp
    6826 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\.
     7808.\" queuepause command
     7809.PP
     7810.RS 4
     7811This parameter specifies the command to be executed on the server host in order to pause the printer queue\&.
     7812.sp
     7813This 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\&.
     7814.sp
     7815This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
    68277816.sp
    68287817If a
    68297818\fI%p\fR
    6830 is given then the printer name is put in its place\. Otherwise it is placed at the end of the command\.
    6831 .sp
    6832 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\.
     7819is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
     7820.sp
     7821Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
    68337822.sp
    68347823\fINo default\fR
    68357824.sp
    68367825Example:
    6837 \fI\fIqueuepause command\fR\fR\fI = \fR\fIdisable %p\fR\fI \fR
     7826\fI\fIqueuepause command\fR\fR\fI = \fR\fI\FCdisable %p\F[]\fR\fI \fR
    68387827.RE
    68397828
    68407829queueresume command (S)
    6841 .PP
    6842 .RS 4
    6843 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 (\fIqueuepause command\fR)\.
    6844 .sp
    6845 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\.
    6846 .sp
    6847 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\.
     7830.\" queueresume command
     7831.PP
     7832.RS 4
     7833This 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[])\&.
     7834.sp
     7835This 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\&.
     7836.sp
     7837This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
    68487838.sp
    68497839If a
    68507840\fI%p\fR
    6851 is given then the printer name is put in its place\. Otherwise it is placed at the end of the command\.
    6852 .sp
    6853 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\.
    6854 .sp
    6855 Default:
    6856 \fI\fIqueueresume command\fR\fR\fI = \fR\fI\fR\fI \fR
    6857 .sp
    6858 Example:
    6859 \fI\fIqueueresume command\fR\fR\fI = \fR\fIenable %p\fR\fI \fR
     7841is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
     7842.sp
     7843Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
     7844.sp
     7845Default:
     7846\fI\fIqueueresume command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7847.sp
     7848Example:
     7849\fI\fIqueueresume command\fR\fR\fI = \fR\fI\FCenable %p\F[]\fR\fI \fR
    68607850.RE
    68617851
    68627852read bmpx (G)
     7853.\" read bmpx
    68637854.PP
    68647855.RS 4
    68657856This boolean parameter controls whether
    68667857\fBsmbd\fR(8)
    6867 will support the "Read Block Multiplex" SMB\. This is now rarely used and defaults to
    6868 \fBno\fR\. You should never need to set this parameter\.
    6869 .sp
    6870 Default:
    6871 \fI\fIread bmpx\fR\fR\fI = \fR\fIno\fR\fI \fR
     7858will support the "Read Block Multiplex" SMB\&. This is now rarely used and defaults to
     7859\fBno\fR\&. You should never need to set this parameter\&.
     7860.sp
     7861Default:
     7862\fI\fIread bmpx\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    68727863.RE
    68737864
    68747865read list (S)
    6875 .PP
    6876 .RS 4
    6877 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
    6878 \fIread only\fR
    6879 option is set to\. The list can include group names using the syntax described in the
    6880 \fIinvalid users\fR
    6881 parameter\.
     7866.\" read list
     7867.PP
     7868.RS 4
     7869This 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
     7870\m[blue]\fBread only\fR\m[]
     7871option is set to\&. The list can include group names using the syntax described in the
     7872\m[blue]\fBinvalid users\fR\m[]
     7873parameter\&.
    68827874.sp
    68837875This parameter will not work with the
    6884 \fIsecurity = share\fR
    6885 in Samba 3\.0\. This is by design\.
    6886 .sp
    6887 Default:
    6888 \fI\fIread list\fR\fR\fI = \fR\fI\fR\fI \fR
    6889 .sp
    6890 Example:
    6891 \fI\fIread list\fR\fR\fI = \fR\fImary, @students\fR\fI \fR
     7876\m[blue]\fBsecurity = share\fR\m[]
     7877in Samba 3\&.0\&. This is by design\&.
     7878.sp
     7879Default:
     7880\fI\fIread list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7881.sp
     7882Example:
     7883\fI\fIread list\fR\fR\fI = \fR\fI\FCmary, @students\F[]\fR\fI \fR
    68927884.RE
    68937885
    68947886read only (S)
     7887.\" read only
    68957888.PP
    68967889.RS 4
    68977890An inverted synonym is
    6898 \fIwriteable\fR\.
     7891\m[blue]\fBwriteable\fR\m[]\&.
    68997892.sp
    69007893If this parameter is
    6901 \fByes\fR, then users of a service may not create or modify files in the service\'s directory\.
    6902 .sp
    6903 Note that a printable service (printable = yes) will
     7894\fByes\fR, then users of a service may not create or modify files in the service\'s directory\&.
     7895.sp
     7896Note that a printable service (\FCprintable = yes\F[]) will
    69047897\fIALWAYS\fR
    6905 allow writing to the directory (user privileges permitting), but only via spooling operations\.
    6906 .sp
    6907 Default:
    6908 \fI\fIread only\fR\fR\fI = \fR\fIyes\fR\fI \fR
     7898allow writing to the directory (user privileges permitting), but only via spooling operations\&.
     7899.sp
     7900Default:
     7901\fI\fIread only\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    69097902.RE
    69107903
    69117904read raw (G)
    6912 .PP
    6913 .RS 4
    6914 This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients\.
    6915 .sp
    6916 If enabled, raw reads allow reads of 65535 bytes in one packet\. This typically provides a major performance benefit\.
    6917 .sp
    6918 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\.
    6919 .sp
    6920 In general this parameter should be viewed as a system tuning tool and left severely alone\.
    6921 .sp
    6922 Default:
    6923 \fI\fIread raw\fR\fR\fI = \fR\fIyes\fR\fI \fR
     7905.\" read raw
     7906.PP
     7907.RS 4
     7908This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients\&.
     7909.sp
     7910If enabled, raw reads allow reads of 65535 bytes in one packet\&. This typically provides a major performance benefit\&.
     7911.sp
     7912However, 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\&.
     7913.sp
     7914In general this parameter should be viewed as a system tuning tool and left severely alone\&.
     7915.sp
     7916Default:
     7917\fI\fIread raw\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    69247918.RE
    69257919
    69267920realm (G)
    6927 .PP
    6928 .RS 4
    6929 This option specifies the kerberos realm to use\. The realm is used as the ADS equivalent of the NT4
    6930 domain\. It is usually set to the DNS name of the kerberos server\.
    6931 .sp
    6932 Default:
    6933 \fI\fIrealm\fR\fR\fI = \fR\fI\fR\fI \fR
    6934 .sp
    6935 Example:
    6936 \fI\fIrealm\fR\fR\fI = \fR\fImysambabox\.mycompany\.com\fR\fI \fR
     7921.\" realm
     7922.PP
     7923.RS 4
     7924This option specifies the kerberos realm to use\&. The realm is used as the ADS equivalent of the NT4
     7925\FCdomain\F[]\&. It is usually set to the DNS name of the kerberos server\&.
     7926.sp
     7927Default:
     7928\fI\fIrealm\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7929.sp
     7930Example:
     7931\fI\fIrealm\fR\fR\fI = \fR\fI\FCmysambabox\&.mycompany\&.com\F[]\fR\fI \fR
    69377932.RE
    69387933
    69397934remote announce (G)
     7935.\" remote announce
    69407936.PP
    69417937.RS 4
    69427938This option allows you to setup
    6943 \fBnmbd\fR(8)to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name\.
    6944 .sp
    6945 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\.
     7939\fBnmbd\fR(8)to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name\&.
     7940.sp
     7941This 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\&.
    69467942.sp
    69477943For example:
    69487944.sp
    6949 .RS 4
     7945.if n \{\
     7946.RS 4
     7947.\}
     7948.fam C
     7949.ps -1
    69507950.nf
    6951 remote announce = 192\.168\.2\.255/SERVERS 192\.168\.4\.255/STAFF
     7951.if t \{\
     7952.sp -1
     7953.\}
     7954.BB lightgray adjust-for-leading-newline
     7955.sp -1
     7956
     7957\FCremote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\F[]
     7958.EB lightgray adjust-for-leading-newline
     7959.if t \{\
     7960.sp 1
     7961.\}
    69527962.fi
    6953 .RE
     7963.fam
     7964.ps +1
     7965.if n \{\
     7966.RE
     7967.\}
    69547968.sp
    69557969the above line would cause
    6956 nmbd
    6957 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
    6958 \fIworkgroup\fR
    6959 parameter is used instead\.
    6960 .sp
    6961 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\.
    6962 .sp
    6963 See the chapter on Network Browsing in the Samba\-HOWTO book\.
    6964 .sp
    6965 Default:
    6966 \fI\fIremote announce\fR\fR\fI = \fR\fI\fR\fI \fR
     7970\FCnmbd\F[]
     7971to 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
     7972\m[blue]\fBworkgroup\fR\m[]
     7973parameter is used instead\&.
     7974.sp
     7975The 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\&.
     7976.sp
     7977See the chapter on Network Browsing in the Samba\-HOWTO book\&.
     7978.sp
     7979Default:
     7980\fI\fIremote announce\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    69677981.RE
    69687982
    69697983remote browse sync (G)
     7984.\" remote browse sync
    69707985.PP
    69717986.RS 4
    69727987This option allows you to setup
    69737988\fBnmbd\fR(8)
    6974 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\.
    6975 .sp
    6976 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\.
     7989to 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\&.
     7990.sp
     7991This 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\&.
    69777992.sp
    69787993For example:
    69797994.sp
    6980 .RS 4
     7995.if n \{\
     7996.RS 4
     7997.\}
     7998.fam C
     7999.ps -1
    69818000.nf
    6982 \fIremote browse sync = 192\.168\.2\.255 192\.168\.4\.255\fR
     8001.if t \{\
     8002.sp -1
     8003.\}
     8004.BB lightgray adjust-for-leading-newline
     8005.sp -1
     8006
     8007\fIremote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fR
     8008.EB lightgray adjust-for-leading-newline
     8009.if t \{\
     8010.sp 1
     8011.\}
    69838012.fi
    6984 .RE
     8013.fam
     8014.ps +1
     8015.if n \{\
     8016.RE
     8017.\}
    69858018.sp
    69868019the above line would cause
    6987 nmbd
    6988 to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server\.
    6989 .sp
    6990 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\.
     8020\FCnmbd\F[]
     8021to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server\&.
     8022.sp
     8023The 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\&.
    69918024.sp
    69928025The
    6993 \fIremote browse sync\fR
    6994 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\.
    6995 .sp
    6996 Default:
    6997 \fI\fIremote browse sync\fR\fR\fI = \fR\fI\fR\fI \fR
     8026\m[blue]\fBremote browse sync\fR\m[]
     8027may 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\&.
     8028.sp
     8029Default:
     8030\fI\fIremote browse sync\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    69988031.RE
    69998032
    70008033rename user script (G)
     8034.\" rename user script
    70018035.PP
    70028036.RS 4
    70038037This is the full pathname to a script that will be run as root by
    70048038\fBsmbd\fR(8)
    7005 under special circumstances described below\.
    7006 .sp
    7007 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,
    7008 %uold
     8039under special circumstances described below\&.
     8040.sp
     8041When 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,
     8042\FC%uold\F[]
    70098043and
    7010 %unew, will be substituted with the old and new usernames, respectively\. The script should return 0 upon successful completion, and nonzero otherwise\.
    7011 .sp
     8044\FC%unew\F[], will be substituted with the old and new usernames, respectively\&. The script should return 0 upon successful completion, and nonzero otherwise\&.
     8045.if n \{\
     8046.sp
     8047.\}
     8048.RS 4
     8049.BM yellow
    70128050.it 1 an-trap
    70138051.nr an-no-space-flag 1
    70148052.nr an-break-flag 1
    70158053.br
    7016 Note
    7017 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\.
    7018 
    7019 Default:
    7020 \fI\fIrename user script\fR\fR\fI = \fR\fIno\fR\fI \fR
     8054.ps +1
     8055\fBNote\fR
     8056.ps -1
     8057.br
     8058The 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\&.
     8059.sp .5v
     8060.EM yellow
     8061.RE
     8062Default:
     8063\fI\fIrename user script\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    70218064.RE
    70228065
    70238066reset on zero vc (G)
    7024 .PP
    7025 .RS 4
    7026 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\.
    7027 .sp
    7028 Default:
    7029 \fI\fIreset on zero vc\fR\fR\fI = \fR\fIno\fR\fI \fR
     8067.\" reset on zero vc
     8068.PP
     8069.RS 4
     8070This 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\&.
     8071.sp
     8072Default:
     8073\fI\fIreset on zero vc\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    70308074.RE
    70318075
    70328076restrict anonymous (G)
    7033 .PP
    7034 .RS 4
    7035 The setting of this parameter determines whether user and group list information is returned for an anonymous connection\. and mirrors the effects of the
    7036 .sp
    7037 .RS 4
     8077.\" restrict anonymous
     8078.PP
     8079.RS 4
     8080The setting of this parameter determines whether user and group list information is returned for an anonymous connection\&. and mirrors the effects of the
     8081.sp
     8082.if n \{\
     8083.RS 4
     8084.\}
     8085.fam C
     8086.ps -1
    70388087.nf
     8088.if t \{\
     8089.sp -1
     8090.\}
     8091.BB lightgray adjust-for-leading-newline
     8092.sp -1
     8093
    70398094HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\e
    70408095           Control\eLSA\eRestrictAnonymous
     8096.EB lightgray adjust-for-leading-newline
     8097.if t \{\
     8098.sp 1
     8099.\}
    70418100.fi
    7042 .RE
    7043 .sp
    7044 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\.
    7045 .sp
    7046 The security advantage of using restrict anonymous = 1 is dubious, as user and group list information can be obtained using other means\.
    7047 .sp
     8101.fam
     8102.ps +1
     8103.if n \{\
     8104.RE
     8105.\}
     8106.sp
     8107registry 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\&.
     8108.sp
     8109The security advantage of using restrict anonymous = 1 is dubious, as user and group list information can be obtained using other means\&.
     8110.if n \{\
     8111.sp
     8112.\}
     8113.RS 4
     8114.BM yellow
    70488115.it 1 an-trap
    70498116.nr an-no-space-flag 1
    70508117.nr an-break-flag 1
    70518118.br
    7052 Note
     8119.ps +1
     8120\fBNote\fR
     8121.ps -1
     8122.br
    70538123The security advantage of using restrict anonymous = 2 is removed by setting
    7054 \fIguest ok = yes\fR
    7055 on any share\.
    7056 
    7057 Default:
    7058 \fI\fIrestrict anonymous\fR\fR\fI = \fR\fI0\fR\fI \fR
     8124\m[blue]\fBguest ok = yes\fR\m[]
     8125on any share\&.
     8126.sp .5v
     8127.EM yellow
     8128.RE
     8129Default:
     8130\fI\fIrestrict anonymous\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    70598131.RE
    70608132
    70618133root
     8134.\" root
    70628135.PP
    70638136.RS 4
    70648137This parameter is a synonym for
    7065 root directory\.
     8138root directory\&.
    70668139.RE
    70678140
    70688141root dir
     8142.\" root dir
    70698143.PP
    70708144.RS 4
    70718145This parameter is a synonym for
    7072 root directory\.
     8146root directory\&.
    70738147.RE
    70748148
    70758149root directory (G)
     8150.\" root directory
    70768151.PP
    70778152.RS 4
    70788153The server will
    7079 chroot()
    7080 (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
    7081 \fIwide smbconfoptions\fR
    7082 parameter)\.
     8154\FCchroot()\F[]
     8155(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
     8156\m[blue]\fBwide smbconfoptions\fR\m[]
     8157parameter)\&.
    70838158.sp
    70848159Adding a
    70858160\fIroot directory\fR
    7086 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
     8161entry 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
    70878162\fIroot directory\fR
    70888163option,
    70898164\fIincluding\fR
    7090 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
     8165some 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
    70918166\fIroot directory\fR
    7092 tree\. In particular you will need to mirror
    7093 \fI/etc/passwd\fR
    7094 (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\.
    7095 .sp
    7096 Default:
    7097 \fI\fIroot directory\fR\fR\fI = \fR\fI/\fR\fI \fR
    7098 .sp
    7099 Example:
    7100 \fI\fIroot directory\fR\fR\fI = \fR\fI/homes/smb\fR\fI \fR
     8167tree\&. In particular you will need to mirror
     8168\FC/etc/passwd\F[]
     8169(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\&.
     8170.sp
     8171Default:
     8172\fI\fIroot directory\fR\fR\fI = \fR\fI\FC/\F[]\fR\fI \fR
     8173.sp
     8174Example:
     8175\fI\fIroot directory\fR\fR\fI = \fR\fI\FC/homes/smb\F[]\fR\fI \fR
    71018176.RE
    71028177
    71038178root postexec (S)
     8179.\" root postexec
    71048180.PP
    71058181.RS 4
    71068182This is the same as the
    71078183\fIpostexec\fR
    7108 parameter except that the command is run as root\. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed\.
    7109 .sp
    7110 Default:
    7111 \fI\fIroot postexec\fR\fR\fI = \fR\fI\fR\fI \fR
     8184parameter except that the command is run as root\&. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed\&.
     8185.sp
     8186Default:
     8187\fI\fIroot postexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    71128188.RE
    71138189
    71148190root preexec close (S)
     8191.\" root preexec close
    71158192.PP
    71168193.RS 4
    71178194This is the same as the
    71188195\fIpreexec close \fR
    7119 parameter except that the command is run as root\.
    7120 .sp
    7121 Default:
    7122 \fI\fIroot preexec close\fR\fR\fI = \fR\fIno\fR\fI \fR
     8196parameter except that the command is run as root\&.
     8197.sp
     8198Default:
     8199\fI\fIroot preexec close\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    71238200.RE
    71248201
    71258202root preexec (S)
     8203.\" root preexec
    71268204.PP
    71278205.RS 4
    71288206This is the same as the
    71298207\fIpreexec\fR
    7130 parameter except that the command is run as root\. This is useful for mounting filesystems (such as CDROMs) when a connection is opened\.
    7131 .sp
    7132 Default:
    7133 \fI\fIroot preexec\fR\fR\fI = \fR\fI\fR\fI \fR
     8208parameter except that the command is run as root\&. This is useful for mounting filesystems (such as CDROMs) when a connection is opened\&.
     8209.sp
     8210Default:
     8211\fI\fIroot preexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    71348212.RE
    71358213
    71368214security mask (S)
    7137 .PP
    7138 .RS 4
    7139 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\.
    7140 .sp
    7141 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
    7142 \fIforce security mode\fR, which works in a manner similar to this one but uses a logical OR instead of an AND\.
    7143 .sp
    7144 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\.
    7145 .sp
    7146 If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file\.
     8215.\" security mask
     8216.PP
     8217.RS 4
     8218This 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\&.
     8219.sp
     8220This 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
     8221\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\&.
     8222.sp
     8223Essentially, 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\&.
     8224.sp
     8225If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file\&.
    71478226.sp
    71488227\fI Note\fR
    7149 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
    7150 \fB0777\fR\.
    7151 .sp
    7152 Default:
    7153 \fI\fIsecurity mask\fR\fR\fI = \fR\fI0777\fR\fI \fR
    7154 .sp
    7155 Example:
    7156 \fI\fIsecurity mask\fR\fR\fI = \fR\fI0770\fR\fI \fR
     8228that 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
     8229\fB0777\fR\&.
     8230.sp
     8231Default:
     8232\fI\fIsecurity mask\fR\fR\fI = \fR\fI\FC0777\F[]\fR\fI \fR
     8233.sp
     8234Example:
     8235\fI\fIsecurity mask\fR\fR\fI = \fR\fI\FC0770\F[]\fR\fI \fR
    71578236.RE
    71588237
    71598238security (G)
     8239.\" security
    71608240.PP
    71618241.RS 4
    71628242This option affects how clients respond to Samba and is one of the most important settings in the
    7163 \fI smb\.conf\fR
    7164 file\.
     8243\FC smb\&.conf\F[]
     8244file\&.
    71658245.sp
    71668246The option sets the "security mode bit" in replies to protocol negotiations with
    71678247\fBsmbd\fR(8)
    7168 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\.
     8248to 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\&.
    71698249.sp
    71708250The default is
    7171 security = user, as this is the most common setting needed when talking to Windows 98 and Windows NT\.
     8251\FCsecurity = user\F[], as this is the most common setting needed when talking to Windows 98 and Windows NT\&.
    71728252.sp
    71738253The alternatives are
    7174 security = share,
    7175 security = server
     8254\FCsecurity = share\F[],
     8255\FCsecurity = server\F[]
    71768256or
    7177 security = domain\.
    7178 .sp
    7179 In versions of Samba prior to 2\.0\.0, the default was
    7180 security = share
    7181 mainly because that was the only option at one stage\.
    7182 .sp
    7183 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\.
     8257\FCsecurity = domain \F[]\&.
     8258.sp
     8259In versions of Samba prior to 2\&.0\&.0, the default was
     8260\FCsecurity = share\F[]
     8261mainly because that was the only option at one stage\&.
     8262.sp
     8263There 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\&.
    71848264.sp
    71858265If your PCs use usernames that are the same as their usernames on the UNIX machine then you will want to use
    7186 security = user\. If you mostly use usernames that don\'t exist on the UNIX box then use
    7187 security = share\.
     8266\FCsecurity = user\F[]\&. If you mostly use usernames that don\'t exist on the UNIX box then use
     8267\FCsecurity = share\F[]\&.
    71888268.sp
    71898269You should also use
    7190 security = share
    7191 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
    7192 security = user, see the
    7193 \fImap to guest\fRparameter for details\.
     8270\FCsecurity = share\F[]
     8271if 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
     8272\FCsecurity = user\F[], see the
     8273\m[blue]\fBmap to guest\fR\m[]parameter for details\&.
    71948274.sp
    71958275It is possible to use
    7196 smbd
     8276\FCsmbd\F[]
    71978277in a
    71988278\fI hybrid mode\fR
    71998279where it is offers both user and share level security under different
    7200 \fINetBIOS aliases\fR\.
    7201 .sp
    7202 The different settings will now be explained\.
     8280\m[blue]\fBNetBIOS aliases\fR\m[]\&.
     8281.sp
     8282The different settings will now be explained\&.
    72038283.sp
    72048284\fISECURITY = SHARE\fR
    72058285.sp
    72068286When 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
    7207 security = share
    7208 server)\. Instead, the clients send authentication information (passwords) on a per\-share basis, at the time they attempt to connect to that share\.
     8287\FCsecurity = share \F[]
     8288server)\&. Instead, the clients send authentication information (passwords) on a per\-share basis, at the time they attempt to connect to that share\&.
    72098289.sp
    72108290Note that
    7211 smbd
     8291\FCsmbd\F[]
    72128292\fIALWAYS\fR
    72138293uses a valid UNIX user to act on behalf of the client, even in
    7214 security = share
    7215 level security\.
     8294\FCsecurity = share\F[]
     8295level security\&.
    72168296.sp
    72178297As clients are not required to send a username to the server in share level security,
    7218 smbd
    7219 uses several techniques to determine the correct UNIX user to use on behalf of the client\.
     8298\FCsmbd\F[]
     8299uses several techniques to determine the correct UNIX user to use on behalf of the client\&.
    72208300.sp
    72218301A list of possible UNIX usernames to match with the given client password is constructed using the following methods :
     
    72298309.IP \(bu 2.3
    72308310.\}
     8311If the
     8312\m[blue]\fBguest only\fR\m[]
     8313parameter is set, then all the other stages are missed and only the
     8314\m[blue]\fBguest account\fR\m[]
     8315username is checked\&.
     8316.RE
     8317.sp
     8318.RS 4
     8319.ie n \{\
     8320\h'-04'\(bu\h'+03'\c
     8321.\}
     8322.el \{\
     8323.sp -1
     8324.IP \(bu 2.3
     8325.\}
     8326Is a username is sent with the share connection request, then this username (after mapping \- see
     8327\m[blue]\fBusername map\fR\m[]), is added as a potential username\&.
     8328.RE
     8329.sp
     8330.RS 4
     8331.ie n \{\
     8332\h'-04'\(bu\h'+03'\c
     8333.\}
     8334.el \{\
     8335.sp -1
     8336.IP \(bu 2.3
     8337.\}
     8338If the client did a previous
     8339\fIlogon \fR
     8340request (the SessionSetup SMB call) then the username sent in this SMB will be added as a potential username\&.
     8341.RE
     8342.sp
     8343.RS 4
     8344.ie n \{\
     8345\h'-04'\(bu\h'+03'\c
     8346.\}
     8347.el \{\
     8348.sp -1
     8349.IP \(bu 2.3
     8350.\}
     8351The name of the service the client requested is added as a potential username\&.
     8352.RE
     8353.sp
     8354.RS 4
     8355.ie n \{\
     8356\h'-04'\(bu\h'+03'\c
     8357.\}
     8358.el \{\
     8359.sp -1
     8360.IP \(bu 2.3
     8361.\}
     8362The NetBIOS name of the client is added to the list as a potential username\&.
     8363.RE
     8364.sp
     8365.RS 4
     8366.ie n \{\
     8367\h'-04'\(bu\h'+03'\c
     8368.\}
     8369.el \{\
     8370.sp -1
     8371.IP \(bu 2.3
     8372.\}
     8373Any users on the
     8374\m[blue]\fBuser\fR\m[]
     8375list are added as potential usernames\&.
     8376.sp
     8377.RE
    72318378If the
    72328379\fIguest only\fR
    7233 parameter is set, then all the other stages are missed and only the
    7234 \fIguest account\fR
    7235 username is checked\.
    7236 .RE
    7237 .sp
    7238 .RS 4
    7239 .ie n \{\
    7240 \h'-04'\(bu\h'+03'\c
    7241 .\}
    7242 .el \{\
    7243 .sp -1
    7244 .IP \(bu 2.3
    7245 .\}
    7246 Is a username is sent with the share connection request, then this username (after mapping \- see
    7247 \fIusername map\fR), is added as a potential username\.
    7248 .RE
    7249 .sp
    7250 .RS 4
    7251 .ie n \{\
    7252 \h'-04'\(bu\h'+03'\c
    7253 .\}
    7254 .el \{\
    7255 .sp -1
    7256 .IP \(bu 2.3
    7257 .\}
    7258 If the client did a previous
    7259 \fIlogon \fR
    7260 request (the SessionSetup SMB call) then the username sent in this SMB will be added as a potential username\.
    7261 .RE
    7262 .sp
    7263 .RS 4
    7264 .ie n \{\
    7265 \h'-04'\(bu\h'+03'\c
    7266 .\}
    7267 .el \{\
    7268 .sp -1
    7269 .IP \(bu 2.3
    7270 .\}
    7271 The name of the service the client requested is added as a potential username\.
    7272 .RE
    7273 .sp
    7274 .RS 4
    7275 .ie n \{\
    7276 \h'-04'\(bu\h'+03'\c
    7277 .\}
    7278 .el \{\
    7279 .sp -1
    7280 .IP \(bu 2.3
    7281 .\}
    7282 The NetBIOS name of the client is added to the list as a potential username\.
    7283 .RE
    7284 .sp
    7285 .RS 4
    7286 .ie n \{\
    7287 \h'-04'\(bu\h'+03'\c
    7288 .\}
    7289 .el \{\
    7290 .sp -1
    7291 .IP \(bu 2.3
    7292 .\}
    7293 Any users on the
    7294 \fIuser\fR
    7295 list are added as potential usernames\.
    7296 .sp
    7297 .RE
    7298 If the
    7299 \fIguest only\fR
    7300 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\.
     8380parameter 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\&.
    73018381.sp
    73028382If the
    73038383\fIguest only\fR
    73048384parameter is set, or no username can be determined then if the share is marked as available to the
    7305 \fIguest account\fR, then this guest user will be used, otherwise access is denied\.
     8385\fIguest account\fR, then this guest user will be used, otherwise access is denied\&.
    73068386.sp
    73078387Note that it can be
    73088388\fIvery\fR
    7309 confusing in share\-level security as to which UNIX username will eventually be used in granting access\.
     8389confusing in share\-level security as to which UNIX username will eventually be used in granting access\&.
    73108390.sp
    73118391See also the section
    7312 NOTE ABOUT USERNAME/PASSWORD VALIDATION\.
     8392NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
    73138393.sp
    73148394\fISECURITY = USER\fR
    73158395.sp
    7316 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
    7317 \fIusername map\fR
    7318 parameter)\. Encrypted passwords (see the
    7319 \fIencrypted passwords\fR
    7320 parameter) can also be used in this security mode\. Parameters such as
    7321 \fIuser\fR
     8396This 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
     8397\m[blue]\fBusername map\fR\m[]
     8398parameter)\&. Encrypted passwords (see the
     8399\m[blue]\fBencrypted passwords\fR\m[]
     8400parameter) can also be used in this security mode\&. Parameters such as
     8401\m[blue]\fBuser\fR\m[]
    73228402and
    7323 \fIguest only\fR
    7324 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\.
     8403\m[blue]\fBguest only\fR\m[]
     8404if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated\&.
    73258405.sp
    73268406\fINote\fR
    73278407that the name of the resource being requested is
    73288408\fInot\fR
    7329 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
    7330 \fIguest account\fR\. See the
    7331 \fImap to guest\fR
    7332 parameter for details on doing this\.
     8409sent 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
     8410\m[blue]\fBguest account\fR\m[]\&. See the
     8411\m[blue]\fBmap to guest\fR\m[]
     8412parameter for details on doing this\&.
    73338413.sp
    73348414See also the section
    7335 NOTE ABOUT USERNAME/PASSWORD VALIDATION\.
     8415NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
    73368416.sp
    73378417\fISECURITY = DOMAIN\fR
     
    73398419This mode will only work correctly if
    73408420\fBnet\fR(8)
    7341 has been used to add this machine into a Windows NT Domain\. It expects the
    7342 \fIencrypted passwords\fR
     8421has been used to add this machine into a Windows NT Domain\&. It expects the
     8422\m[blue]\fBencrypted passwords\fR\m[]
    73438423parameter to be set to
    7344 \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\.
     8424\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\&.
    73458425.sp
    73468426\fINote\fR
    7347 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\.
     8427that 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\&.
    73488428.sp
    73498429\fINote\fR
    73508430that from the client\'s point of view
    7351 security = domain
     8431\FCsecurity = domain\F[]
    73528432is the same as
    7353 security = user\. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\.
     8433\FCsecurity = user\F[]\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
    73548434.sp
    73558435\fINote\fR
    73568436that the name of the resource being requested is
    73578437\fInot\fR
    7358 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
    7359 \fIguest account\fR\. See the
    7360 \fImap to guest\fR
    7361 parameter for details on doing this\.
     8438sent 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
     8439\m[blue]\fBguest account\fR\m[]\&. See the
     8440\m[blue]\fBmap to guest\fR\m[]
     8441parameter for details on doing this\&.
    73628442.sp
    73638443See also the section
    7364 NOTE ABOUT USERNAME/PASSWORD VALIDATION\.
     8444NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
    73658445.sp
    73668446See also the
    7367 \fIpassword server\fR
     8447\m[blue]\fBpassword server\fR\m[]
    73688448parameter and the
    7369 \fIencrypted passwords\fR
    7370 parameter\.
     8449\m[blue]\fBencrypted passwords\fR\m[]
     8450parameter\&.
    73718451.sp
    73728452\fISECURITY = SERVER\fR
    73738453.sp
    7374 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
    7375 security = user\. It expects the
    7376 \fIencrypted passwords\fR
     8454In 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
     8455\FCsecurity = user\F[]\&. It expects the
     8456\m[blue]\fBencrypted passwords\fR\m[]
    73778457parameter to be set to
    7378 \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
    7379 \fIsmbpasswd\fR
    7380 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\.
    7381 .sp
     8458\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
     8459\FCsmbpasswd\F[]
     8460file to check users against\&. See the chapter about the User Database in the Samba HOWTO Collection for details on how to set this up\&.
     8461.if n \{\
     8462.sp
     8463.\}
     8464.RS 4
     8465.BM yellow
    73828466.it 1 an-trap
    73838467.nr an-no-space-flag 1
    73848468.nr an-break-flag 1
    73858469.br
    7386 Note
    7387 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)\.
    7388 .sp
     8470.ps +1
     8471\fBNote\fR
     8472.ps -1
     8473.br
     8474This 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)\&.
     8475.sp .5v
     8476.EM yellow
     8477.RE
     8478.if n \{\
     8479.sp
     8480.\}
     8481.RS 4
     8482.BM yellow
    73898483.it 1 an-trap
    73908484.nr an-no-space-flag 1
    73918485.nr an-break-flag 1
    73928486.br
    7393 Note
     8487.ps +1
     8488\fBNote\fR
     8489.ps -1
     8490.br
    73948491From the client\'s point of view
    7395 security = server
     8492\FCsecurity = server\F[]
    73968493is the same as
    7397 security = user\. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\.
    7398 
     8494\FCsecurity = user\F[]\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
     8495.sp .5v
     8496.EM yellow
     8497.RE
    73998498\fINote\fR
    74008499that the name of the resource being requested is
    74018500\fInot\fR
    7402 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
    7403 \fIguest account\fR\. See the
    7404 \fImap to guest\fR
    7405 parameter for details on doing this\.
     8501sent 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
     8502\m[blue]\fBguest account\fR\m[]\&. See the
     8503\m[blue]\fBmap to guest\fR\m[]
     8504parameter for details on doing this\&.
    74068505.sp
    74078506See also the section
    7408 NOTE ABOUT USERNAME/PASSWORD VALIDATION\.
     8507NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
    74098508.sp
    74108509See also the
    7411 \fIpassword server\fR
     8510\m[blue]\fBpassword server\fR\m[]
    74128511parameter and the
    7413 \fIencrypted passwords\fR
    7414 parameter\.
     8512\m[blue]\fBencrypted passwords\fR\m[]
     8513parameter\&.
    74158514.sp
    74168515\fISECURITY = ADS\fR
    74178516.sp
    7418 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\.
    7419 .sp
    7420 Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\.
    7421 .sp
    7422 Read the chapter about Domain Membership in the HOWTO for details\.
    7423 .sp
    7424 Default:
    7425 \fI\fIsecurity\fR\fR\fI = \fR\fIUSER\fR\fI \fR
    7426 .sp
    7427 Example:
    7428 \fI\fIsecurity\fR\fR\fI = \fR\fIDOMAIN\fR\fI \fR
     8517In 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\&.
     8518.sp
     8519Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\&.
     8520.sp
     8521Read the chapter about Domain Membership in the HOWTO for details\&.
     8522.sp
     8523Default:
     8524\fI\fIsecurity\fR\fR\fI = \fR\fI\FCUSER\F[]\fR\fI \fR
     8525.sp
     8526Example:
     8527\fI\fIsecurity\fR\fR\fI = \fR\fI\FCDOMAIN\F[]\fR\fI \fR
    74298528.RE
    74308529
    74318530server schannel (G)
    7432 .PP
    7433 .RS 4
    7434 This controls whether the server offers or even demands the use of the netlogon schannel\.
    7435 \fIserver schannel = no\fR
     8531.\" server schannel
     8532.PP
     8533.RS 4
     8534This controls whether the server offers or even demands the use of the netlogon schannel\&.
     8535\m[blue]\fBserver schannel = no\fR\m[]
    74368536does not offer the schannel,
    7437 \fIserver schannel = auto\fR
     8537\m[blue]\fBserver schannel = auto\fR\m[]
    74388538offers the schannel but does not enforce it, and
    7439 \fIserver schannel = yes\fR
    7440 denies access if the client is not able to speak netlogon schannel\. This is only the case for Windows NT4 before SP4\.
     8539\m[blue]\fBserver schannel = yes\fR\m[]
     8540denies access if the client is not able to speak netlogon schannel\&. This is only the case for Windows NT4 before SP4\&.
    74418541.sp
    74428542Please note that with this set to
    7443 no
     8543\FCno\F[]
    74448544you will have to apply the WindowsXP
    7445 \fIWinXP_SignOrSeal\.reg\fR
    7446 registry patch found in the docs/registry subdirectory of the Samba distribution tarball\.
    7447 .sp
    7448 Default:
    7449 \fI\fIserver schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR
    7450 .sp
    7451 Example:
    7452 \fI\fIserver schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
     8545\FCWinXP_SignOrSeal\&.reg\F[]
     8546registry patch found in the docs/registry subdirectory of the Samba distribution tarball\&.
     8547.sp
     8548Default:
     8549\fI\fIserver schannel\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
     8550.sp
     8551Example:
     8552\fI\fIserver schannel\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    74538553.RE
    74548554
    74558555server signing (G)
    7456 .PP
    7457 .RS 4
    7458 This controls whether the server offers or requires the client it talks to to use SMB signing\. Possible values are
     8556.\" server signing
     8557.PP
     8558.RS 4
     8559This controls whether the server offers or requires the client it talks to to use SMB signing\&. Possible values are
    74598560\fIauto\fR,
    74608561\fImandatory\fR
    74618562and
    7462 \fIdisabled\fR\.
    7463 .sp
    7464 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\.
    7465 .sp
    7466 Default:
    7467 \fI\fIserver signing\fR\fR\fI = \fR\fIDisabled\fR\fI \fR
     8563\fIdisabled\fR\&.
     8564.sp
     8565When 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\&.
     8566.sp
     8567Default:
     8568\fI\fIserver signing\fR\fR\fI = \fR\fI\FCDisabled\F[]\fR\fI \fR
    74688569.RE
    74698570
    74708571server string (G)
     8572.\" server string
    74718573.PP
    74728574.RS 4
    74738575This controls what string will show up in the printer comment box in print manager and next to the IPC connection in
    7474 net view\. It can be any string that you wish to show to your users\.
    7475 .sp
    7476 It also sets what will appear in browse lists next to the machine name\.
     8576\FCnet view\F[]\&. It can be any string that you wish to show to your users\&.
     8577.sp
     8578It also sets what will appear in browse lists next to the machine name\&.
    74778579.sp
    74788580A
    74798581\fI%v\fR
    7480 will be replaced with the Samba version number\.
     8582will be replaced with the Samba version number\&.
    74818583.sp
    74828584A
    74838585\fI%h\fR
    7484 will be replaced with the hostname\.
    7485 .sp
    7486 Default:
    7487 \fI\fIserver string\fR\fR\fI = \fR\fISamba %v\fR\fI \fR
    7488 .sp
    7489 Example:
    7490 \fI\fIserver string\fR\fR\fI = \fR\fIUniversity of GNUs Samba Server\fR\fI \fR
     8586will be replaced with the hostname\&.
     8587.sp
     8588Default:
     8589\fI\fIserver string\fR\fR\fI = \fR\fI\FCSamba %v\F[]\fR\fI \fR
     8590.sp
     8591Example:
     8592\fI\fIserver string\fR\fR\fI = \fR\fI\FCUniversity of GNUs Samba Server\F[]\fR\fI \fR
    74918593.RE
    74928594
    74938595set directory (S)
     8596.\" set directory
    74948597.PP
    74958598.RS 4
    74968599If
    7497 set directory = no, then users of the service may not use the setdir command to change directory\.
     8600\FCset directory = no\F[], then users of the service may not use the setdir command to change directory\&.
    74988601.sp
    74998602The
    7500 setdir
    7501 command is only implemented in the Digital Pathworks client\. See the Pathworks documentation for details\.
    7502 .sp
    7503 Default:
    7504 \fI\fIset directory\fR\fR\fI = \fR\fIno\fR\fI \fR
     8603\FCsetdir\F[]
     8604command is only implemented in the Digital Pathworks client\&. See the Pathworks documentation for details\&.
     8605.sp
     8606Default:
     8607\fI\fIset directory\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    75058608.RE
    75068609
    75078610set primary group script (G)
    7508 .PP
    7509 .RS 4
    7510 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
    7511 net rpc vampire\.
     8611.\" set primary group script
     8612.PP
     8613.RS 4
     8614Thanks 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
     8615\FCnet rpc vampire\F[]\&.
    75128616\fI%u\fR
    7513 will be replaced with the user whose primary group is to be set\.
     8617will be replaced with the user whose primary group is to be set\&.
    75148618\fI%g\fR
    7515 will be replaced with the group to set\.
    7516 .sp
    7517 Default:
    7518 \fI\fIset primary group script\fR\fR\fI = \fR\fI\fR\fI \fR
    7519 .sp
    7520 Example:
    7521 \fI\fIset primary group script\fR\fR\fI = \fR\fI/usr/sbin/usermod \-g \'%g\' \'%u\'\fR\fI \fR
     8619will be replaced with the group to set\&.
     8620.sp
     8621Default:
     8622\fI\fIset primary group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     8623.sp
     8624Example:
     8625\fI\fIset primary group script\fR\fR\fI = \fR\fI\FC/usr/sbin/usermod \-g \'%g\' \'%u\'\F[]\fR\fI \fR
    75228626.RE
    75238627
    75248628set quota command (G)
     8629.\" set quota command
    75258630.PP
    75268631.RS 4
    75278632The
    7528 set quota command
    7529 should only be used whenever there is no operating system API available from the OS that samba can use\.
     8633\FCset quota command\F[]
     8634should only be used whenever there is no operating system API available from the OS that samba can use\&.
    75308635.sp
    75318636This option is only available if Samba was configured with the argument
    7532 \-\-with\-sys\-quotas
     8637\FC\-\-with\-sys\-quotas\F[]
    75338638or on linux when
    7534 \./configure \-\-with\-quotas
    7535 was used and a working quota api was found in the system\. Most packages are configured with these options already\.
    7536 .sp
    7537 This parameter should specify the path to a script that can set quota for the specified arguments\.
     8639\FC\&./configure \-\-with\-quotas\F[]
     8640was used and a working quota api was found in the system\&. Most packages are configured with these options already\&.
     8641.sp
     8642This parameter should specify the path to a script that can set quota for the specified arguments\&.
    75388643.sp
    75398644The specified script should take the following arguments:
     
    76728777.sp
    76738778.RE
    7674 The script should output at least one line of data on success\. And nothing on failure\.
    7675 .sp
    7676 Default:
    7677 \fI\fIset quota command\fR\fR\fI = \fR\fI\fR\fI \fR
    7678 .sp
    7679 Example:
    7680 \fI\fIset quota command\fR\fR\fI = \fR\fI/usr/local/sbin/set_quota\fR\fI \fR
     8779The script should output at least one line of data on success\&. And nothing on failure\&.
     8780.sp
     8781Default:
     8782\fI\fIset quota command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     8783.sp
     8784Example:
     8785\fI\fIset quota command\fR\fR\fI = \fR\fI\FC/usr/local/sbin/set_quota\F[]\fR\fI \fR
    76818786.RE
    76828787
    76838788share modes (S)
     8789.\" share modes
    76848790.PP
    76858791.RS 4
    76868792This enables or disables the honoring of the
    76878793\fIshare modes\fR
    7688 during a file open\. These modes are used by clients to gain exclusive read or write access to a file\.
    7689 .sp
    7690 These open modes are not directly supported by UNIX, so they are simulated using shared memory, or lock files if your UNIX doesn\'t support shared memory (almost all do)\.
     8794during a file open\&. These modes are used by clients to gain exclusive read or write access to a file\&.
     8795.sp
     8796These open modes are not directly supported by UNIX, so they are simulated using shared memory, or lock files if your UNIX doesn\'t support shared memory (almost all do)\&.
    76918797.sp
    76928798The share modes that are enabled by this option are
     
    76978803\fBDENY_NONE\fR
    76988804and
    7699 \fBDENY_FCB\fR\.
    7700 .sp
    7701 This option gives full share compatibility and enabled by default\.
     8805\fBDENY_FCB\fR\&.
     8806.sp
     8807This option gives full share compatibility and enabled by default\&.
    77028808.sp
    77038809You should
    77048810\fINEVER\fR
    7705 turn this parameter off as many Windows applications will break if you do so\.
    7706 .sp
    7707 Default:
    7708 \fI\fIshare modes\fR\fR\fI = \fR\fIyes\fR\fI \fR
     8811turn this parameter off as many Windows applications will break if you do so\&.
     8812.sp
     8813Default:
     8814\fI\fIshare modes\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    77098815.RE
    77108816
    77118817short preserve case (S)
    7712 .PP
    7713 .RS 4
    7714 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
    7715 \fIdefault case\fR\. This option can be use with
    7716 \fIpreserve case = yes\fR
    7717 to permit long filenames to retain their case, while short names are lowered\.
     8818.\" short preserve case
     8819.PP
     8820.RS 4
     8821This 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
     8822\m[blue]\fBdefault case\fR\m[]\&. This option can be use with
     8823\m[blue]\fBpreserve case = yes\fR\m[]
     8824to permit long filenames to retain their case, while short names are lowered\&.
    77188825.sp
    77198826See the section on
    7720 NAME MANGLING\.
    7721 .sp
    7722 Default:
    7723 \fI\fIshort preserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR
     8827NAME MANGLING\&.
     8828.sp
     8829Default:
     8830\fI\fIshort preserve case\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    77248831.RE
    77258832
    77268833show add printer wizard (G)
    7727 .PP
    7728 .RS 4
    7729 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\.
    7730 .sp
    7731 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
     8834.\" show add printer wizard
     8835.PP
     8836.RS 4
     8837With 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\&.
     8838.sp
     8839Under 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
    77328840\fIprinter admin\fR
    7733 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\.
     8841group), 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\&.
    77348842.sp
    77358843Disabling the
    77368844\fIshow add printer wizard\fR
    7737 parameter will always cause the OpenPrinterEx() on the server to fail\. Thus the APW icon will never be displayed\.
    7738 .sp
     8845parameter will always cause the OpenPrinterEx() on the server to fail\&. Thus the APW icon will never be displayed\&.
     8846.if n \{\
     8847.sp
     8848.\}
     8849.RS 4
     8850.BM yellow
    77398851.it 1 an-trap
    77408852.nr an-no-space-flag 1
    77418853.nr an-break-flag 1
    77428854.br
    7743 Note
    7744 This does not prevent the same user from having administrative privilege on an individual printer\.
    7745 
    7746 Default:
    7747 \fI\fIshow add printer wizard\fR\fR\fI = \fR\fIyes\fR\fI \fR
     8855.ps +1
     8856\fBNote\fR
     8857.ps -1
     8858.br
     8859This does not prevent the same user from having administrative privilege on an individual printer\&.
     8860.sp .5v
     8861.EM yellow
     8862.RE
     8863Default:
     8864\fI\fIshow add printer wizard\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    77488865.RE
    77498866
    77508867shutdown script (G)
     8868.\" shutdown script
    77518869.PP
    77528870.RS 4
    77538871This a full path name to a script called by
    77548872\fBsmbd\fR(8)
    7755 that should start a shutdown procedure\.
     8873that should start a shutdown procedure\&.
    77568874.sp
    77578875If the connected user posseses the
    7758 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user\.
     8876\fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user\&.
    77598877.sp
    77608878The %z %t %r %f variables are expanded as follows:
     
    77698887.\}
    77708888\fI%z\fR
    7771 will be substituted with the shutdown message sent to the server\.
     8889will be substituted with the shutdown message sent to the server\&.
    77728890.RE
    77738891.sp
     
    77818899.\}
    77828900\fI%t\fR
    7783 will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\.
     8901will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\&.
    77848902.RE
    77858903.sp
     
    77948912\fI%r\fR
    77958913will be substituted with the switch
    7796 \fI\-r\fR\. It means reboot after shutdown for NT\.
     8914\fI\-r\fR\&. It means reboot after shutdown for NT\&.
    77978915.RE
    77988916.sp
     
    78078925\fI%f\fR
    78088926will be substituted with the switch
    7809 \fI\-f\fR\. It means force the shutdown even if applications do not respond for NT\.
     8927\fI\-f\fR\&. It means force the shutdown even if applications do not respond for NT\&.
    78108928.sp
    78118929.RE
    78128930Shutdown script example:
    78138931.sp
    7814 .RS 4
     8932.if n \{\
     8933.RS 4
     8934.\}
     8935.fam C
     8936.ps -1
    78158937.nf
     8938.if t \{\
     8939.sp -1
     8940.\}
     8941.BB lightgray adjust-for-leading-newline
     8942.sp -1
     8943
    78168944#!/bin/bash
    78178945               
     
    78218949
    78228950/sbin/shutdown $3 $4 +$time $1 &
     8951.EB lightgray adjust-for-leading-newline
     8952.if t \{\
     8953.sp 1
     8954.\}
    78238955.fi
    7824 .RE
    7825 .sp
    7826 Shutdown does not return so we need to launch it in background\.
    7827 .sp
    7828 Default:
    7829 \fI\fIshutdown script\fR\fR\fI = \fR\fI\fR\fI \fR
    7830 .sp
    7831 Example:
    7832 \fI\fIshutdown script\fR\fR\fI = \fR\fI/usr/local/samba/sbin/shutdown %m %t %r %f\fR\fI \fR
     8956.fam
     8957.ps +1
     8958.if n \{\
     8959.RE
     8960.\}
     8961.sp
     8962Shutdown does not return so we need to launch it in background\&.
     8963.sp
     8964Default:
     8965\fI\fIshutdown script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     8966.sp
     8967Example:
     8968\fI\fIshutdown script\fR\fR\fI = \fR\fI\FC/usr/local/samba/sbin/shutdown %m %t %r %f\F[]\fR\fI \fR
    78338969.RE
    78348970
    78358971smb passwd file (G)
    7836 .PP
    7837 .RS 4
    7838 This option sets the path to the encrypted smbpasswd file\. By default the path to the smbpasswd file is compiled into Samba\.
     8972.\" smb passwd file
     8973.PP
     8974.RS 4
     8975This option sets the path to the encrypted smbpasswd file\&. By default the path to the smbpasswd file is compiled into Samba\&.
    78398976.sp
    78408977An example of use is:
    78418978.sp
    7842 .RS 4
     8979.if n \{\
     8980.RS 4
     8981.\}
     8982.fam C
     8983.ps -1
    78438984.nf
     8985.if t \{\
     8986.sp -1
     8987.\}
     8988.BB lightgray adjust-for-leading-newline
     8989.sp -1
     8990
    78448991smb passwd file = /etc/samba/smbpasswd
     8992.EB lightgray adjust-for-leading-newline
     8993.if t \{\
     8994.sp 1
     8995.\}
    78458996.fi
    7846 .RE
    7847 .sp
    7848 .sp
    7849 Default:
    7850 \fI\fIsmb passwd file\fR\fR\fI = \fR\fI${prefix}/private/smbpasswd\fR\fI \fR
     8997.fam
     8998.ps +1
     8999.if n \{\
     9000.RE
     9001.\}
     9002.sp
     9003Default:
     9004\fI\fIsmb passwd file\fR\fR\fI = \fR\fI\FC${prefix}/private/smbpasswd\F[]\fR\fI \fR
    78519005.RE
    78529006
    78539007smb ports (G)
    7854 .PP
    7855 .RS 4
    7856 Specifies which ports the server should listen on for SMB traffic\.
    7857 .sp
    7858 Default:
    7859 \fI\fIsmb ports\fR\fR\fI = \fR\fI445 139\fR\fI \fR
     9008.\" smb ports
     9009.PP
     9010.RS 4
     9011Specifies which ports the server should listen on for SMB traffic\&.
     9012.sp
     9013Default:
     9014\fI\fIsmb ports\fR\fR\fI = \fR\fI\FC445 139\F[]\fR\fI \fR
    78609015.RE
    78619016
    78629017socket address (G)
    7863 .PP
    7864 .RS 4
    7865 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\.
    7866 .sp
    7867 By default Samba will accept connections on any address\.
    7868 .sp
    7869 Default:
    7870 \fI\fIsocket address\fR\fR\fI = \fR\fI\fR\fI \fR
    7871 .sp
    7872 Example:
    7873 \fI\fIsocket address\fR\fR\fI = \fR\fI192\.168\.2\.20\fR\fI \fR
     9018.\" socket address
     9019.PP
     9020.RS 4
     9021This 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\&.
     9022.sp
     9023Setting this option should never be necessary on usual Samba servers running only one nmbd\&.
     9024.sp
     9025By default Samba will accept connections on any address\&.
     9026.sp
     9027Default:
     9028\fI\fIsocket address\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     9029.sp
     9030Example:
     9031\fI\fIsocket address\fR\fR\fI = \fR\fI\FC192\&.168\&.2\&.20\F[]\fR\fI \fR
    78749032.RE
    78759033
    78769034socket options (G)
    7877 .PP
    7878 .RS 4
    7879 This option allows you to set socket options to be used when talking with the client\.
    7880 .sp
    7881 Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\.
    7882 .sp
    7883 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
    7884 man setsockopt
    7885 will help)\.
    7886 .sp
    7887 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
    7888 samba\-technical@samba\.org\.
    7889 .sp
    7890 Any of the supported socket options may be combined in any way you like, as long as your OS allows it\.
     9035.\" socket options
     9036.PP
     9037.RS 4
     9038This option allows you to set socket options to be used when talking with the client\&.
     9039.sp
     9040Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\&.
     9041.sp
     9042This 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
     9043\FCman setsockopt\F[]
     9044will help)\&.
     9045.sp
     9046You 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
     9047samba\-technical@samba\&.org\&.
     9048.sp
     9049Any of the supported socket options may be combined in any way you like, as long as your OS allows it\&.
    78919050.sp
    78929051This is the list of socket options currently settable using this option:
     
    80049163Those marked with a
    80059164\fI\'*\'\fR
    8006 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\.
     9165take 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\&.
    80079166.sp
    80089167To specify an argument use the syntax SOME_OPTION = VALUE for example
    8009 SO_SNDBUF = 8192\. Note that you must not have any spaces before or after the = sign\.
     9168\FCSO_SNDBUF = 8192\F[]\&. Note that you must not have any spaces before or after the = sign\&.
    80109169.sp
    80119170If you are on a local network then a sensible option might be:
    80129171.sp
    8013 socket options = IPTOS_LOWDELAY
     9172\FCsocket options = IPTOS_LOWDELAY\F[]
    80149173.sp
    80159174If you have a local network then you could try:
    80169175.sp
    8017 socket options = IPTOS_LOWDELAY TCP_NODELAY
    8018 .sp
    8019 If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\.
    8020 .sp
    8021 Note that several of the options may cause your Samba server to fail completely\. Use these options with caution!
    8022 .sp
    8023 Default:
    8024 \fI\fIsocket options\fR\fR\fI = \fR\fITCP_NODELAY\fR\fI \fR
    8025 .sp
    8026 Example:
    8027 \fI\fIsocket options\fR\fR\fI = \fR\fIIPTOS_LOWDELAY\fR\fI \fR
     9176\FCsocket options = IPTOS_LOWDELAY TCP_NODELAY\F[]
     9177.sp
     9178If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\&.
     9179.sp
     9180Note that several of the options may cause your Samba server to fail completely\&. Use these options with caution!
     9181.sp
     9182Default:
     9183\fI\fIsocket options\fR\fR\fI = \fR\fI\FCTCP_NODELAY\F[]\fR\fI \fR
     9184.sp
     9185Example:
     9186\fI\fIsocket options\fR\fR\fI = \fR\fI\FCIPTOS_LOWDELAY\F[]\fR\fI \fR
    80289187.RE
    80299188
    80309189stat cache (G)
     9190.\" stat cache
    80319191.PP
    80329192.RS 4
    80339193This parameter determines if
    80349194\fBsmbd\fR(8)
    8035 will use a cache in order to speed up case insensitive name mappings\. You should never need to change this parameter\.
    8036 .sp
    8037 Default:
    8038 \fI\fIstat cache\fR\fR\fI = \fR\fIyes\fR\fI \fR
     9195will use a cache in order to speed up case insensitive name mappings\&. You should never need to change this parameter\&.
     9196.sp
     9197Default:
     9198\fI\fIstat cache\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    80399199.RE
    80409200
    80419201store dos attributes (S)
     9202.\" store dos attributes
    80429203.PP
    80439204.RS 4
    80449205If 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
    8045 \fImap hidden\fR
     9206\m[blue]\fBmap hidden\fR\m[]
    80469207and
    8047 \fImap readonly\fR)\. 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
    8048 \fImap hidden\fR,
    8049 \fImap system\fR,
    8050 \fImap archive\fR
     9208\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
     9209\m[blue]\fBmap hidden\fR\m[],
     9210\m[blue]\fBmap system\fR\m[],
     9211\m[blue]\fBmap archive\fR\m[]
    80519212and
    8052 \fImap readonly\fR
    8053 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\.
    8054 .sp
    8055 Default:
    8056 \fI\fIstore dos attributes\fR\fR\fI = \fR\fIno\fR\fI \fR
     9213\m[blue]\fBmap readonly\fR\m[]
     9214must 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\&.
     9215.sp
     9216Default:
     9217\fI\fIstore dos attributes\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    80579218.RE
    80589219
    80599220strict allocate (S)
    8060 .PP
    8061 .RS 4
    8062 This is a boolean that controls the handling of disk space allocation in the server\. When this is set to
     9221.\" strict allocate
     9222.PP
     9223.RS 4
     9224This is a boolean that controls the handling of disk space allocation in the server\&. When this is set to
    80639225\fByes\fR
    8064 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\.
     9226the 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\&.
    80659227.sp
    80669228When strict allocate is
    80679229\fBno\fR
    8068 the server does sparse disk block allocation when a file is extended\.
     9230the server does sparse disk block allocation when a file is extended\&.
    80699231.sp
    80709232Setting this to
    80719233\fByes\fR
    8072 can help Samba return out of quota messages on systems that are restricting the disk quota of users\.
    8073 .sp
    8074 Default:
    8075 \fI\fIstrict allocate\fR\fR\fI = \fR\fIno\fR\fI \fR
     9234can help Samba return out of quota messages on systems that are restricting the disk quota of users\&.
     9235.sp
     9236Default:
     9237\fI\fIstrict allocate\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    80769238.RE
    80779239
    80789240strict locking (S)
    8079 .PP
    8080 .RS 4
    8081 This is an enumerated type that controls the handling of file locking in the server\. When this is set to
    8082 \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\.
    8083 .sp
    8084 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 inproved performance\.
    8085 .sp
    8086 When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\.
    8087 .sp
    8088 Well\-behaved clients always ask for lock checks when it is important\. So in the vast majority of cases,
    8089 strict locking = Auto
     9241.\" strict locking
     9242.PP
     9243.RS 4
     9244This is an enumerated type that controls the handling of file locking in the server\&. When this is set to
     9245\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\&.
     9246.sp
     9247When 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 inproved performance\&.
     9248.sp
     9249When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\&.
     9250.sp
     9251Well\-behaved clients always ask for lock checks when it is important\&. So in the vast majority of cases,
     9252\FCstrict locking = Auto\F[]
    80909253or
    8091 strict locking = no
    8092 is acceptable\.
    8093 .sp
    8094 Default:
    8095 \fI\fIstrict locking\fR\fR\fI = \fR\fIAuto\fR\fI \fR
     9254\FCstrict locking = no\F[]
     9255is acceptable\&.
     9256.sp
     9257Default:
     9258\fI\fIstrict locking\fR\fR\fI = \fR\fI\FCAuto\F[]\fR\fI \fR
    80969259.RE
    80979260
    80989261strict sync (S)
    8099 .PP
    8100 .RS 4
    8101 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
     9262.\" strict sync
     9263.PP
     9264.RS 4
     9265Many 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
    81029266\fBno\fR
    81039267(the default) means that
    81049268\fBsmbd\fR(8)
    8105 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\.
    8106 .sp
    8107 Default:
    8108 \fI\fIstrict sync\fR\fR\fI = \fR\fIno\fR\fI \fR
     9269ignores 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\&.
     9270.sp
     9271Default:
     9272\fI\fIstrict sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    81099273.RE
    81109274
    81119275svcctl list (G)
    8112 .PP
    8113 .RS 4
    8114 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\.
     9276.\" svcctl list
     9277.PP
     9278.RS 4
     9279This 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\&.
    81159280.sp
    81169281The administrator must create a directory name
    8117 \fIsvcctl\fR
     9282\FCsvcctl\F[]
    81189283in Samba\'s $(libdir) and create symbolic links to the init scripts in
    8119 \fI/etc/init\.d/\fR\. The name of the links must match the names given as part of the
    8120 \fIsvcctl list\fR\.
    8121 .sp
    8122 Default:
    8123 \fI\fIsvcctl list\fR\fR\fI = \fR\fI\fR\fI \fR
    8124 .sp
    8125 Example:
    8126 \fI\fIsvcctl list\fR\fR\fI = \fR\fIcups postfix portmap httpd\fR\fI \fR
     9284\FC/etc/init\&.d/\F[]\&. The name of the links must match the names given as part of the
     9285\fIsvcctl list\fR\&.
     9286.sp
     9287Default:
     9288\fI\fIsvcctl list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     9289.sp
     9290Example:
     9291\fI\fIsvcctl list\fR\fR\fI = \fR\fI\FCcups postfix portmap httpd\F[]\fR\fI \fR
    81279292.RE
    81289293
    81299294sync always (S)
    8130 .PP
    8131 .RS 4
    8132 This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\. If this is
     9295.\" sync always
     9296.PP
     9297.RS 4
     9298This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\&. If this is
    81339299\fBno\fR
    8134 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
     9300then 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
    81359301\fByes\fR
    81369302then every write will be followed by a
    8137 fsync()
    8138 call to ensure the data is written to disk\. Note that the
     9303\FCfsync() \F[]
     9304call to ensure the data is written to disk\&. Note that the
    81399305\fIstrict sync\fR
    81409306parameter must be set to
    81419307\fByes\fR
    8142 in order for this parameter to have any affect\.
    8143 .sp
    8144 Default:
    8145 \fI\fIsync always\fR\fR\fI = \fR\fIno\fR\fI \fR
     9308in order for this parameter to have any affect\&.
     9309.sp
     9310Default:
     9311\fI\fIsync always\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    81469312.RE
    81479313
    81489314syslog only (G)
    8149 .PP
    8150 .RS 4
    8151 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
     9315.\" syslog only
     9316.PP
     9317.RS 4
     9318If 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
    81529319\fIsyslog only\fR
    8153 is enabled\.
    8154 .sp
    8155 Default:
    8156 \fI\fIsyslog only\fR\fR\fI = \fR\fIno\fR\fI \fR
     9320is enabled\&.
     9321.sp
     9322Default:
     9323\fI\fIsyslog only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    81579324.RE
    81589325
    81599326syslog (G)
    8160 .PP
    8161 .RS 4
    8162 This parameter maps how Samba debug messages are logged onto the system syslog logging levels\. Samba debug level zero maps onto syslog
     9327.\" syslog
     9328.PP
     9329.RS 4
     9330This parameter maps how Samba debug messages are logged onto the system syslog logging levels\&. Samba debug level zero maps onto syslog
    81639331\fBLOG_ERR\fR, debug level one maps onto
    81649332\fBLOG_WARNING\fR, debug level two maps onto
    8165 \fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\. All higher levels are mapped to
    8166 \fBLOG_DEBUG\fR\.
    8167 .sp
    8168 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
     9333\fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\&. All higher levels are mapped to
     9334\fBLOG_DEBUG\fR\&.
     9335.sp
     9336This 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
    81699337\fIsyslog only\fR
    8170 is enabled\.
    8171 .sp
    8172 Default:
    8173 \fI\fIsyslog\fR\fR\fI = \fR\fI1\fR\fI \fR
     9338is enabled\&.
     9339.sp
     9340Default:
     9341\fI\fIsyslog\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
    81749342.RE
    81759343
    81769344template homedir (G)
     9345.\" template homedir
    81779346.PP
    81789347.RS 4
    81799348When filling out the user information for a Windows NT user, the
    81809349\fBwinbindd\fR(8)
    8181 daemon uses this parameter to fill in the home directory for that user\. If the string
     9350daemon uses this parameter to fill in the home directory for that user\&. If the string
    81829351\fI%D\fR
    8183 is present it is substituted with the user\'s Windows NT domain name\. If the string
     9352is present it is substituted with the user\'s Windows NT domain name\&. If the string
    81849353\fI%U\fR
    8185 is present it is substituted with the user\'s Windows NT user name\.
    8186 .sp
    8187 Default:
    8188 \fI\fItemplate homedir\fR\fR\fI = \fR\fI/home/%D/%U\fR\fI \fR
     9354is present it is substituted with the user\'s Windows NT user name\&.
     9355.sp
     9356Default:
     9357\fI\fItemplate homedir\fR\fR\fI = \fR\fI\FC/home/%D/%U\F[]\fR\fI \fR
    81899358.RE
    81909359
    81919360template shell (G)
     9361.\" template shell
    81929362.PP
    81939363.RS 4
    81949364When filling out the user information for a Windows NT user, the
    81959365\fBwinbindd\fR(8)
    8196 daemon uses this parameter to fill in the login shell for that user\.
     9366daemon uses this parameter to fill in the login shell for that user\&.
    81979367.sp
    81989368\fINo default\fR
     
    82009370
    82019371time offset (G)
    8202 .PP
    8203 .RS 4
    8204 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\.
    8205 .sp
    8206 Default:
    8207 \fI\fItime offset\fR\fR\fI = \fR\fI0\fR\fI \fR
    8208 .sp
    8209 Example:
    8210 \fI\fItime offset\fR\fR\fI = \fR\fI60\fR\fI \fR
     9372.\" time offset
     9373.PP
     9374.RS 4
     9375This 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\&.
     9376.sp
     9377Default:
     9378\fI\fItime offset\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     9379.sp
     9380Example:
     9381\fI\fItime offset\fR\fR\fI = \fR\fI\FC60\F[]\fR\fI \fR
    82119382.RE
    82129383
    82139384time server (G)
     9385.\" time server
    82149386.PP
    82159387.RS 4
    82169388This parameter determines if
    82179389\fBnmbd\fR(8)
    8218 advertises itself as a time server to Windows clients\.
    8219 .sp
    8220 Default:
    8221 \fI\fItime server\fR\fR\fI = \fR\fIno\fR\fI \fR
     9390advertises itself as a time server to Windows clients\&.
     9391.sp
     9392Default:
     9393\fI\fItime server\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    82229394.RE
    82239395
    82249396unix charset (G)
    8225 .PP
    8226 .RS 4
    8227 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\.
    8228 .sp
    8229 This is also the charset Samba will use when specifying arguments to scripts that it invokes\.
    8230 .sp
    8231 Default:
    8232 \fI\fIunix charset\fR\fR\fI = \fR\fIUTF8\fR\fI \fR
    8233 .sp
    8234 Example:
    8235 \fI\fIunix charset\fR\fR\fI = \fR\fIASCII\fR\fI \fR
     9397.\" unix charset
     9398.PP
     9399.RS 4
     9400Specifies 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\&.
     9401.sp
     9402This is also the charset Samba will use when specifying arguments to scripts that it invokes\&.
     9403.sp
     9404Default:
     9405\fI\fIunix charset\fR\fR\fI = \fR\fI\FCUTF8\F[]\fR\fI \fR
     9406.sp
     9407Example:
     9408\fI\fIunix charset\fR\fR\fI = \fR\fI\FCASCII\F[]\fR\fI \fR
    82369409.RE
    82379410
    82389411unix extensions (G)
    8239 .PP
    8240 .RS 4
    8241 This boolean parameter controls whether Samba implments 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\.
    8242 .sp
    8243 Default:
    8244 \fI\fIunix extensions\fR\fR\fI = \fR\fIyes\fR\fI \fR
     9412.\" unix extensions
     9413.PP
     9414.RS 4
     9415This boolean parameter controls whether Samba implments 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\&.
     9416.sp
     9417Default:
     9418\fI\fIunix extensions\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    82459419.RE
    82469420
    82479421unix password sync (G)
    8248 .PP
    8249 .RS 4
    8250 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
     9422.\" unix password sync
     9423.PP
     9424.RS 4
     9425This 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
    82519426\fByes\fR
    82529427the program specified in the
     
    82549429parameter is called
    82559430\fIAS ROOT\fR
    8256 \- 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)\.
    8257 .sp
    8258 Default:
    8259 \fI\fIunix password sync\fR\fR\fI = \fR\fIno\fR\fI \fR
     9431\- 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)\&.
     9432.sp
     9433Default:
     9434\fI\fIunix password sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    82609435.RE
    82619436
    82629437update encrypted (G)
    8263 .PP
    8264 .RS 4
    8265 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 atabase) 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
    8266 \fBno\fR\.
     9438.\" update encrypted
     9439.PP
     9440.RS 4
     9441This 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 atabase) 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
     9442\fBno\fR\&.
    82679443.sp
    82689444In order for this parameter to be operative the
    8269 \fIencrypt passwords\fR
     9445\m[blue]\fBencrypt passwords\fR\m[]
    82709446parameter must be set to
    8271 \fBno\fR\. The default value of
    8272 \fIencrypt passwords = Yes\fR\. Note: This must be set to
     9447\fBno\fR\&. The default value of
     9448\m[blue]\fBencrypt passwords = Yes\fR\m[]\&. Note: This must be set to
    82739449\fBno\fR
    82749450for this
    8275 \fIupdate encrypted\fR
    8276 to work\.
     9451\m[blue]\fBupdate encrypted\fR\m[]
     9452to work\&.
    82779453.sp
    82789454Note that even when this parameter is set a user authenticating to
    8279 smbd
    8280 must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords\.
    8281 .sp
    8282 Default:
    8283 \fI\fIupdate encrypted\fR\fR\fI = \fR\fIno\fR\fI \fR
     9455\FCsmbd\F[]
     9456must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords\&.
     9457.sp
     9458Default:
     9459\fI\fIupdate encrypted\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    82849460.RE
    82859461
    82869462use client driver (S)
    8287 .PP
    8288 .RS 4
    8289 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
    8290 disable spoolss = yes\.
    8291 .sp
    8292 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)\.
    8293 .sp
    8294 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\.
    8295 \fIThis parameter MUST not be able enabled on a print share which has valid print driver installed on the Samba server\.\fR
    8296 .sp
    8297 Default:
    8298 \fI\fIuse client driver\fR\fR\fI = \fR\fIno\fR\fI \fR
     9463.\" use client driver
     9464.PP
     9465.RS 4
     9466This 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
     9467\FCdisable spoolss = yes\F[]\&.
     9468.sp
     9469The 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)\&.
     9470.sp
     9471If 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\&.
     9472\fIThis parameter MUST not be able enabled on a print share which has valid print driver installed on the Samba server\&.\fR
     9473.sp
     9474Default:
     9475\fI\fIuse client driver\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    82999476.RE
    83009477
    83019478use kerberos keytab (G)
     9479.\" use kerberos keytab
    83029480.PP
    83039481.RS 4
     
    83059483\fBhost/FQDN\fR
    83069484and
    8307 \fBcifs/FQDN\fR\.
     9485\fBcifs/FQDN\fR\&.
    83089486.sp
    83099487When you are using the heimdal Kerberos libraries, you must also specify the following in
    8310 \fI/etc/krb5\.conf\fR:
    8311 .sp
    8312 .RS 4
     9488\FC/etc/krb5\&.conf\F[]:
     9489.sp
     9490.if n \{\
     9491.RS 4
     9492.\}
     9493.fam C
     9494.ps -1
    83139495.nf
     9496.if t \{\
     9497.sp -1
     9498.\}
     9499.BB lightgray adjust-for-leading-newline
     9500.sp -1
     9501
    83149502[libdefaults]
    8315 default_keytab_name = FILE:/etc/krb5\.keytab
     9503default_keytab_name = FILE:/etc/krb5\&.keytab
     9504.EB lightgray adjust-for-leading-newline
     9505.if t \{\
     9506.sp 1
     9507.\}
    83169508.fi
    8317 .RE
    8318 .sp
    8319 .sp
    8320 Default:
    8321 \fI\fIuse kerberos keytab\fR\fR\fI = \fR\fIFalse\fR\fI \fR
     9509.fam
     9510.ps +1
     9511.if n \{\
     9512.RE
     9513.\}
     9514.sp
     9515Default:
     9516\fI\fIuse kerberos keytab\fR\fR\fI = \fR\fI\FCFalse\F[]\fR\fI \fR
    83229517.RE
    83239518
    83249519use mmap (G)
    8325 .PP
    8326 .RS 4
    8327 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
     9520.\" use mmap
     9521.PP
     9522.RS 4
     9523This 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
    83289524\fBno\fR
    8329 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\.
    8330 .sp
    8331 Default:
    8332 \fI\fIuse mmap\fR\fR\fI = \fR\fIyes\fR\fI \fR
     9525by 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\&.
     9526.sp
     9527Default:
     9528\fI\fIuse mmap\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    83339529.RE
    83349530
    83359531username level (G)
    8336 .PP
    8337 .RS 4
    8338 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\.
    8339 .sp
    8340 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
    8341 \fBAstrangeUser \fR\.
    8342 .sp
    8343 This parameter is needed only on UNIX systems that have case sensitive usernames\.
    8344 .sp
    8345 Default:
    8346 \fI\fIusername level\fR\fR\fI = \fR\fI0\fR\fI \fR
    8347 .sp
    8348 Example:
    8349 \fI\fIusername level\fR\fR\fI = \fR\fI5\fR\fI \fR
     9532.\" username level
     9533.PP
     9534.RS 4
     9535This 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\&.
     9536.sp
     9537If 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
     9538\fBAstrangeUser \fR\&.
     9539.sp
     9540This parameter is needed only on UNIX systems that have case sensitive usernames\&.
     9541.sp
     9542Default:
     9543\fI\fIusername level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     9544.sp
     9545Example:
     9546\fI\fIusername level\fR\fR\fI = \fR\fI\FC5\F[]\fR\fI \fR
    83509547.RE
    83519548
    83529549username map script (G)
     9550.\" username map script
    83539551.PP
    83549552.RS 4
    83559553This script is a mutually exclusive alternative to the
    8356 \fIusername map\fR
    8357 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\.
    8358 .sp
    8359 Default:
    8360 \fI\fIusername map script\fR\fR\fI = \fR\fI\fR\fI \fR
    8361 .sp
    8362 Example:
    8363 \fI\fIusername map script\fR\fR\fI = \fR\fI/etc/samba/scripts/mapusers\.sh\fR\fI \fR
     9554\m[blue]\fBusername map\fR\m[]
     9555parameter\&. 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\&.
     9556.sp
     9557Default:
     9558\fI\fIusername map script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     9559.sp
     9560Example:
     9561\fI\fIusername map script\fR\fR\fI = \fR\fI\FC/etc/samba/scripts/mapusers\&.sh\F[]\fR\fI \fR
    83649562.RE
    83659563
    83669564username map (G)
    8367 .PP
    8368 .RS 4
    8369 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\.
    8370 .sp
    8371 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 =
    8372 DOMAIN\efoo)\.
    8373 .sp
    8374 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\.
    8375 .sp
    8376 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\.
    8377 .sp
    8378 If any line begins with a \'#\' or a \';\' then it is ignored\.
    8379 .sp
    8380 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\.
     9565.\" username map
     9566.PP
     9567.RS 4
     9568This 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\&.
     9569.sp
     9570Please 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 =
     9571\FCDOMAIN\efoo\F[])\&.
     9572.sp
     9573The 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\&.
     9574.sp
     9575The 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\&.
     9576.sp
     9577If any line begins with a \'#\' or a \';\' then it is ignored\&.
     9578.sp
     9579If 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\&.
    83819580.sp
    83829581For example to map from the name
     
    83889587you would use:
    83899588.sp
    8390 .RS 4
     9589.if n \{\
     9590.RS 4
     9591.\}
     9592.fam C
     9593.ps -1
    83919594.nf
    8392 root = admin administrator
     9595.if t \{\
     9596.sp -1
     9597.\}
     9598.BB lightgray adjust-for-leading-newline
     9599.sp -1
     9600
     9601\FCroot = admin administrator\F[]
     9602.EB lightgray adjust-for-leading-newline
     9603.if t \{\
     9604.sp 1
     9605.\}
    83939606.fi
    8394 .RE
     9607.fam
     9608.ps +1
     9609.if n \{\
     9610.RE
     9611.\}
    83959612.sp
    83969613Or to map anyone in the UNIX group
     
    84009617you would use:
    84019618.sp
    8402 .RS 4
     9619.if n \{\
     9620.RS 4
     9621.\}
     9622.fam C
     9623.ps -1
    84039624.nf
    8404 sys = @system
     9625.if t \{\
     9626.sp -1
     9627.\}
     9628.BB lightgray adjust-for-leading-newline
     9629.sp -1
     9630
     9631\FCsys = @system\F[]
     9632.EB lightgray adjust-for-leading-newline
     9633.if t \{\
     9634.sp 1
     9635.\}
    84059636.fi
    8406 .RE
    8407 .sp
    8408 .sp
    8409 You can have as many mappings as you like in a username map file\.
     9637.fam
     9638.ps +1
     9639.if n \{\
     9640.RE
     9641.\}
     9642.sp
     9643You can have as many mappings as you like in a username map file\&.
    84109644.sp
    84119645If your system supports the NIS NETGROUP option then the netgroup database is checked before the
    8412 \fI/etc/group \fR
    8413 database for matching groups\.
    8414 .sp
    8415 You can map Windows usernames that have spaces in them by using double quotes around the name\. For example:
    8416 .sp
    8417 .RS 4
     9646\FC/etc/group \F[]
     9647database for matching groups\&.
     9648.sp
     9649You can map Windows usernames that have spaces in them by using double quotes around the name\&. For example:
     9650.sp
     9651.if n \{\
     9652.RS 4
     9653.\}
     9654.fam C
     9655.ps -1
    84189656.nf
    8419 tridge = "Andrew Tridgell"
     9657.if t \{\
     9658.sp -1
     9659.\}
     9660.BB lightgray adjust-for-leading-newline
     9661.sp -1
     9662
     9663\FCtridge = "Andrew Tridgell"\F[]
     9664.EB lightgray adjust-for-leading-newline
     9665.if t \{\
     9666.sp 1
     9667.\}
    84209668.fi
    8421 .RE
    8422 .sp
    8423 would map the windows username "Andrew Tridgell" to the unix username "tridge"\.
    8424 .sp
    8425 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:
    8426 .sp
    8427 .RS 4
     9669.fam
     9670.ps +1
     9671.if n \{\
     9672.RE
     9673.\}
     9674.sp
     9675would map the windows username "Andrew Tridgell" to the unix username "tridge"\&.
     9676.sp
     9677The 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:
     9678.sp
     9679.if n \{\
     9680.RS 4
     9681.\}
     9682.fam C
     9683.ps -1
    84289684.nf
     9685.if t \{\
     9686.sp -1
     9687.\}
     9688.BB lightgray adjust-for-leading-newline
     9689.sp -1
     9690
    84299691!sys = mary fred
    84309692guest = *
     9693.EB lightgray adjust-for-leading-newline
     9694.if t \{\
     9695.sp 1
     9696.\}
    84319697.fi
    8432 .RE
    8433 .sp
    8434 .sp
    8435 Note that the remapping is applied to all occurrences of usernames\. Thus if you connect to \e\eserver\efred and
     9698.fam
     9699.ps +1
     9700.if n \{\
     9701.RE
     9702.\}
     9703.sp
     9704Note that the remapping is applied to all occurrences of usernames\&. Thus if you connect to \e\eserver\efred and
    84369705\fBfred\fR
    84379706is remapped to
     
    84409709\fBmary\fR
    84419710not
    8442 \fBfred\fR\. The only exception to this is the username passed to the
    8443 \fIpassword server\fR
    8444 (if you have one)\. The password server will receive whatever username the client supplies without modification\.
    8445 .sp
    8446 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\.
    8447 .sp
    8448 Samba versions prior to 3\.0\.8 would only support reading the fully qualified username (e\.g\.:
    8449 DOMAIN\euser) 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\.
    8450 .sp
    8451 The following functionality is obeyed in version 3\.0\.8 and later:
    8452 .sp
    8453 When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\.
    8454 .sp
    8455 When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\.e\.
    8456 DOMAIN\euser) only after the user has been successfully authenticated\.
     9711\fBfred\fR\&. The only exception to this is the username passed to the
     9712\m[blue]\fBpassword server\fR\m[]
     9713(if you have one)\&. The password server will receive whatever username the client supplies without modification\&.
     9714.sp
     9715Also 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\&.
     9716.sp
     9717Samba versions prior to 3\&.0\&.8 would only support reading the fully qualified username (e\&.g\&.:
     9718\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\&.
     9719.sp
     9720The following functionality is obeyed in version 3\&.0\&.8 and later:
     9721.sp
     9722When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\&.
     9723.sp
     9724When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\&.e\&.
     9725\FCDOMAIN\euser\F[]) only after the user has been successfully authenticated\&.
    84579726.sp
    84589727An example of use is:
    84599728.sp
    8460 .RS 4
     9729.if n \{\
     9730.RS 4
     9731.\}
     9732.fam C
     9733.ps -1
    84619734.nf
    8462 username map = /usr/local/samba/lib/users\.map
     9735.if t \{\
     9736.sp -1
     9737.\}
     9738.BB lightgray adjust-for-leading-newline
     9739.sp -1
     9740
     9741username map = /usr/local/samba/lib/users\&.map
     9742.EB lightgray adjust-for-leading-newline
     9743.if t \{\
     9744.sp 1
     9745.\}
    84639746.fi
    8464 .RE
    8465 .sp
    8466 .sp
    8467 Default:
    8468 \fI\fIusername map\fR\fR\fI = \fR\fI # no username map\fR\fI \fR
     9747.fam
     9748.ps +1
     9749.if n \{\
     9750.RE
     9751.\}
     9752.sp
     9753Default:
     9754\fI\fIusername map\fR\fR\fI = \fR\fI\FC # no username map\F[]\fR\fI \fR
    84699755.RE
    84709756
    84719757user
     9758.\" user
    84729759.PP
    84739760.RS 4
    84749761This parameter is a synonym for
    8475 username\.
     9762username\&.
    84769763.RE
    84779764
    84789765users
     9766.\" users
    84799767.PP
    84809768.RS 4
    84819769This parameter is a synonym for
    8482 username\.
     9770username\&.
    84839771.RE
    84849772
    84859773username (S)
    8486 .PP
    8487 .RS 4
    8488 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)\.
     9774.\" username
     9775.PP
     9776.RS 4
     9777Multiple 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)\&.
    84899778.sp
    84909779The
    84919780\fIusername\fR
    8492 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\.
     9781line 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\&.
    84939782.sp
    84949783The
     
    84969785line 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
    84979786\fIusername\fR
    8498 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\.
    8499 .sp
    8500 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\.
     9787line 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\&.
     9788.sp
     9789Samba 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\&.
    85019790.sp
    85029791To restrict a service to a particular set of users you can use the
    8503 \fIvalid users\fR
    8504 parameter\.
    8505 .sp
    8506 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\.
    8507 .sp
    8508 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\.
    8509 .sp
    8510 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\.
    8511 .sp
    8512 Note that searching though a groups database can take quite some time, and some clients may time out during the search\.
     9792\m[blue]\fBvalid users\fR\m[]
     9793parameter\&.
     9794.sp
     9795If 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\&.
     9796.sp
     9797If 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\&.
     9798.sp
     9799If 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\&.
     9800.sp
     9801Note that searching though a groups database can take quite some time, and some clients may time out during the search\&.
    85139802.sp
    85149803See the section
    85159804NOTE ABOUT USERNAME/PASSWORD VALIDATION
    8516 for more information on how this parameter determines access to the services\.
    8517 .sp
    8518 Default:
    8519 \fI\fIusername\fR\fR\fI = \fR\fI # The guest account if a guest service, else <empty string>\.\fR\fI \fR
    8520 .sp
    8521 Example:
    8522 \fI\fIusername\fR\fR\fI = \fR\fIfred, mary, jack, jane, @users, @pcgroup\fR\fI \fR
     9805for more information on how this parameter determines access to the services\&.
     9806.sp
     9807Default:
     9808\fI\fIusername\fR\fR\fI = \fR\fI\FC # The guest account if a guest service, else <empty string>\&.\F[]\fR\fI \fR
     9809.sp
     9810Example:
     9811\fI\fIusername\fR\fR\fI = \fR\fI\FCfred, mary, jack, jane, @users, @pcgroup\F[]\fR\fI \fR
    85239812.RE
    85249813
    85259814usershare allow guests (G)
    8526 .PP
    8527 .RS 4
    8528 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
     9815.\" usershare allow guests
     9816.PP
     9817.RS 4
     9818This 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
    85299819\fIguest ok = yes\fR
    8530 in a share definition\. Due to the security sensitive nature of this the default is set to off\.
    8531 .sp
    8532 Default:
    8533 \fI\fIusershare allow guests\fR\fR\fI = \fR\fIno\fR\fI \fR
     9820in a share definition\&. Due to the security sensitive nature of this the default is set to off\&.
     9821.sp
     9822Default:
     9823\fI\fIusershare allow guests\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    85349824.RE
    85359825
    85369826usershare max shares (G)
    8537 .PP
    8538 .RS 4
    8539 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\.
    8540 .sp
    8541 Default:
    8542 \fI\fIusershare max shares\fR\fR\fI = \fR\fI0\fR\fI \fR
     9827.\" usershare max shares
     9828.PP
     9829.RS 4
     9830This 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\&.
     9831.sp
     9832Default:
     9833\fI\fIusershare max shares\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    85439834.RE
    85449835
    85459836usershare owner only (G)
    8546 .PP
    8547 .RS 4
    8548 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\.
    8549 .sp
    8550 Default:
    8551 \fI\fIusershare owner only\fR\fR\fI = \fR\fITrue\fR\fI \fR
     9837.\" usershare owner only
     9838.PP
     9839.RS 4
     9840This 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\&.
     9841.sp
     9842Default:
     9843\fI\fIusershare owner only\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
    85529844.RE
    85539845
    85549846usershare path (G)
    8555 .PP
    8556 .RS 4
    8557 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\.
    8558 .sp
    8559 For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\.
    8560 .sp
    8561 
    8562 .sp
    8563 .RS 4
     9847.\" usershare path
     9848.PP
     9849.RS 4
     9850This 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\&.
     9851.sp
     9852For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\&.
     9853.sp
     9854
     9855.sp
     9856.if n \{\
     9857.RS 4
     9858.\}
     9859.fam C
     9860.ps -1
    85649861.nf
     9862.if t \{\
     9863.sp -1
     9864.\}
     9865.BB lightgray adjust-for-leading-newline
     9866.sp -1
     9867
    85659868        ls \-ld /usr/local/samba/lib/usershares/
    85669869        drwxrwx\-\-T  2 root power_users 4096 2006\-05\-05 12:27 /usr/local/samba/lib/usershares/
    85679870       
     9871.EB lightgray adjust-for-leading-newline
     9872.if t \{\
     9873.sp 1
     9874.\}
    85689875.fi
    8569 .RE
    8570 .sp
    8571 .sp
    8572 In this case, only members of the group "power_users" can create user defined shares\.
    8573 .sp
    8574 Default:
    8575 \fI\fIusershare path\fR\fR\fI = \fR\fINULL\fR\fI \fR
     9876.fam
     9877.ps +1
     9878.if n \{\
     9879.RE
     9880.\}
     9881.sp
     9882In this case, only members of the group "power_users" can create user defined shares\&.
     9883.sp
     9884Default:
     9885\fI\fIusershare path\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
    85769886.RE
    85779887
    85789888usershare prefix allow list (G)
    8579 .PP
    8580 .RS 4
    8581 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 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\.
    8582 .sp
    8583 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\.
    8584 .sp
    8585 Default:
    8586 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fINULL\fR\fI \fR
    8587 .sp
    8588 Example:
    8589 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI/home /data /space\fR\fI \fR
     9889.\" usershare prefix allow list
     9890.PP
     9891.RS 4
     9892This parameter specifies a list of absolute pathnames the root of which are allowed to be exported by user defined share definitions\&. If the pathname 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\&.
     9893.sp
     9894If 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\&.
     9895.sp
     9896Default:
     9897\fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
     9898.sp
     9899Example:
     9900\fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\FC/home /data /space\F[]\fR\fI \fR
    85909901.RE
    85919902
    85929903usershare prefix deny list (G)
    8593 .PP
    8594 .RS 4
    8595 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\.
    8596 .sp
    8597 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\.
    8598 .sp
    8599 Default:
    8600 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fINULL\fR\fI \fR
    8601 .sp
    8602 Example:
    8603 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI/etc /dev /private\fR\fI \fR
     9904.\" usershare prefix deny list
     9905.PP
     9906.RS 4
     9907This 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\&.
     9908.sp
     9909If 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\&.
     9910.sp
     9911Default:
     9912\fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
     9913.sp
     9914Example:
     9915\fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\FC/etc /dev /private\F[]\fR\fI \fR
    86049916.RE
    86059917
    86069918usershare template share (G)
    8607 .PP
    8608 .RS 4
    8609 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\.
    8610 .sp
    8611 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\.
    8612 .sp
    8613 Default:
    8614 \fI\fIusershare template share\fR\fR\fI = \fR\fINULL\fR\fI \fR
    8615 .sp
    8616 Example:
    8617 \fI\fIusershare template share\fR\fR\fI = \fR\fItemplate_share\fR\fI \fR
     9919.\" usershare template share
     9920.PP
     9921.RS 4
     9922User 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\&.
     9923.sp
     9924The 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\&.
     9925.sp
     9926Default:
     9927\fI\fIusershare template share\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
     9928.sp
     9929Example:
     9930\fI\fIusershare template share\fR\fR\fI = \fR\fI\FCtemplate_share\F[]\fR\fI \fR
    86189931.RE
    86199932
    86209933use sendfile (S)
     9934.\" use sendfile
    86219935.PP
    86229936.RS 4
     
    86249938\fByes\fR, and the
    86259939\fBsendfile()\fR
    8626 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)\.
    8627 .sp
    8628 Default:
    8629 \fI\fIuse sendfile\fR\fR\fI = \fR\fIfalse\fR\fI \fR
     9940system 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)\&.
     9941.sp
     9942Default:
     9943\fI\fIuse sendfile\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
    86309944.RE
    86319945
    86329946use spnego (G)
    8633 .PP
    8634 .RS 4
    8635 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\.
    8636 .sp
    8637 Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled\.
    8638 .sp
    8639 Default:
    8640 \fI\fIuse spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR
     9947.\" use spnego
     9948.PP
     9949.RS 4
     9950This 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\&.
     9951.sp
     9952Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled\&.
     9953.sp
     9954Default:
     9955\fI\fIuse spnego\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    86419956.RE
    86429957
    86439958utmp directory (G)
     9959.\" utmp directory
    86449960.PP
    86459961.RS 4
    86469962This parameter is only available if Samba has been configured and compiled with the option
    8647 \-\-with\-utmp\. 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
    8648 \fI/var/run/utmp\fR
    8649 on Linux)\.
    8650 .sp
    8651 Default:
    8652 \fI\fIutmp directory\fR\fR\fI = \fR\fI # Determined automatically\fR\fI \fR
    8653 .sp
    8654 Example:
    8655 \fI\fIutmp directory\fR\fR\fI = \fR\fI/var/run/utmp\fR\fI \fR
     9963\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
     9964\FC/var/run/utmp\F[]
     9965on Linux)\&.
     9966.sp
     9967Default:
     9968\fI\fIutmp directory\fR\fR\fI = \fR\fI\FC # Determined automatically\F[]\fR\fI \fR
     9969.sp
     9970Example:
     9971\fI\fIutmp directory\fR\fR\fI = \fR\fI\FC/var/run/utmp\F[]\fR\fI \fR
    86569972.RE
    86579973
    86589974utmp (G)
     9975.\" utmp
    86599976.PP
    86609977.RS 4
    86619978This boolean parameter is only available if Samba has been configured and compiled with the option
    8662 \-\-with\-utmp\. If set to
     9979\FC\-\-with\-utmp\F[]\&. If set to
    86639980\fByes\fR
    8664 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\.
    8665 .sp
    8666 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\.
    8667 .sp
    8668 Default:
    8669 \fI\fIutmp\fR\fR\fI = \fR\fIno\fR\fI \fR
     9981then 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\&.
     9982.sp
     9983Due 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\&.
     9984.sp
     9985Default:
     9986\fI\fIutmp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    86709987.RE
    86719988
    86729989valid users (S)
    8673 .PP
    8674 .RS 4
    8675 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
     9990.\" valid users
     9991.PP
     9992.RS 4
     9993This 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
    86769994\fIinvalid users\fR
    8677 parameter\.
    8678 .sp
    8679 If this is empty (the default) then any user can login\. If a username is in both this list and the
     9995parameter\&.
     9996.sp
     9997If this is empty (the default) then any user can login\&. If a username is in both this list and the
    86809998\fIinvalid users\fR
    8681 list then access is denied for that user\.
     9999list then access is denied for that user\&.
    868210000.sp
    868310001The current servicename is substituted for
    8684 \fI%S\fR\. This is useful in the [homes] section\.
    8685 .sp
    8686 Default:
    8687 \fI\fIvalid users\fR\fR\fI = \fR\fI # No valid users list (anyone can login) \fR\fI \fR
    8688 .sp
    8689 Example:
    8690 \fI\fIvalid users\fR\fR\fI = \fR\fIgreg, @pcusers\fR\fI \fR
     10002\fI%S\fR\&. This is useful in the [homes] section\&.
     10003.sp
     10004Default:
     10005\fI\fIvalid users\fR\fR\fI = \fR\fI\FC # No valid users list (anyone can login) \F[]\fR\fI \fR
     10006.sp
     10007Example:
     10008\fI\fIvalid users\fR\fR\fI = \fR\fI\FCgreg, @pcusers\F[]\fR\fI \fR
    869110009.RE
    869210010
    869310011\-valid (S)
    8694 .PP
    8695 .RS 4
    8696 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\.
    8697 .sp
    8698 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\.
    8699 .sp
    8700 Default:
    8701 \fI\fI\-valid\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10012.\" -valid
     10013.PP
     10014.RS 4
     10015This 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\&.
     10016.sp
     10017This 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\&.
     10018.sp
     10019Default:
     10020\fI\fI\-valid\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    870210021.RE
    870310022
    870410023veto files (S)
    8705 .PP
    8706 .RS 4
    8707 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\.
     10024.\" veto files
     10025.PP
     10026.RS 4
     10027This 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\&.
    870810028.sp
    870910029Each entry must be a unix path, not a DOS path and must
    871010030\fInot\fR
    8711 include the unix directory separator \'/\'\.
     10031include the unix directory separator \'/\'\&.
    871210032.sp
    871310033Note that the
    8714 \fIcase sensitive\fR
    8715 option is applicable in vetoing files\.
    8716 .sp
    8717 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
     10034\m[blue]\fBcase sensitive\fR\m[]
     10035option is applicable in vetoing files\&.
     10036.sp
     10037One 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
    871810038\fIfail\fR
    871910039unless you also set the
    8720 \fIdelete veto files\fR
     10040\m[blue]\fBdelete veto files\fR\m[]
    872110041parameter to
    8722 \fIyes\fR\.
    8723 .sp
    8724 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\.
     10042\fIyes\fR\&.
     10043.sp
     10044Setting 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\&.
    872510045.sp
    872610046Examples of use include:
    872710047.sp
    8728 .RS 4
     10048.if n \{\
     10049.RS 4
     10050.\}
     10051.fam C
     10052.ps -1
    872910053.nf
     10054.if t \{\
     10055.sp -1
     10056.\}
     10057.BB lightgray adjust-for-leading-newline
     10058.sp -1
     10059
    873010060; Veto any files containing the word Security,
    8731 ; any ending in \.tmp, and any directory containing the
    8732 ; word root\.
    8733 veto files = /*Security*/*\.tmp/*root*/
     10061; any ending in \&.tmp, and any directory containing the
     10062; word root\&.
     10063veto files = /*Security*/*\&.tmp/*root*/
    873410064
    873510065; Veto the Apple specific files that a NetAtalk server
    8736 ; creates\.
    8737 veto files = /\.AppleDouble/\.bin/\.AppleDesktop/Network Trash Folder/
     10066; creates\&.
     10067veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
     10068.EB lightgray adjust-for-leading-newline
     10069.if t \{\
     10070.sp 1
     10071.\}
    873810072.fi
    8739 .RE
    8740 .sp
    8741 .sp
    8742 Default:
    8743 \fI\fIveto files\fR\fR\fI = \fR\fINo files or directories are vetoed\.\fR\fI \fR
     10073.fam
     10074.ps +1
     10075.if n \{\
     10076.RE
     10077.\}
     10078.sp
     10079Default:
     10080\fI\fIveto files\fR\fR\fI = \fR\fI\FCNo files or directories are vetoed\&.\F[]\fR\fI \fR
    874410081.RE
    874510082
    874610083veto oplock files (S)
     10084.\" veto oplock files
    874710085.PP
    874810086.RS 4
    874910087This parameter is only valid when the
    8750 \fIoplocks\fR
    8751 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
    8752 \fIveto files\fR
    8753 parameter\.
    8754 .sp
    8755 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
    8756 \fI\.SEM\fR\. 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\.
     10088\m[blue]\fBoplocks\fR\m[]
     10089parameter 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
     10090\m[blue]\fBveto files\fR\m[]
     10091parameter\&.
     10092.sp
     10093You 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
     10094\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\&.
    875710095.sp
    875810096An example of use is:
    875910097.sp
    8760 .RS 4
     10098.if n \{\
     10099.RS 4
     10100.\}
     10101.fam C
     10102.ps -1
    876110103.nf
    8762 veto oplock files = /\.*SEM/
     10104.if t \{\
     10105.sp -1
     10106.\}
     10107.BB lightgray adjust-for-leading-newline
     10108.sp -1
     10109
     10110veto oplock files = /\&.*SEM/
     10111.EB lightgray adjust-for-leading-newline
     10112.if t \{\
     10113.sp 1
     10114.\}
    876310115.fi
    8764 .RE
    8765 .sp
    8766 .sp
    8767 Default:
    8768 \fI\fIveto oplock files\fR\fR\fI = \fR\fI # No files are vetoed for oplock grants\fR\fI \fR
     10116.fam
     10117.ps +1
     10118.if n \{\
     10119.RE
     10120.\}
     10121.sp
     10122Default:
     10123\fI\fIveto oplock files\fR\fR\fI = \fR\fI\FC # No files are vetoed for oplock grants\F[]\fR\fI \fR
    876910124.RE
    877010125
    877110126vfs object
     10127.\" vfs object
    877210128.PP
    877310129.RS 4
    877410130This parameter is a synonym for
    8775 vfs objects\.
     10131vfs objects\&.
    877610132.RE
    877710133
    877810134vfs objects (S)
    8779 .PP
    8780 .RS 4
    8781 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\.
    8782 .sp
    8783 Default:
    8784 \fI\fIvfs objects\fR\fR\fI = \fR\fI\fR\fI \fR
    8785 .sp
    8786 Example:
    8787 \fI\fIvfs objects\fR\fR\fI = \fR\fIextd_audit recycle\fR\fI \fR
     10135.\" vfs objects
     10136.PP
     10137.RS 4
     10138This 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\&.
     10139.sp
     10140Default:
     10141\fI\fIvfs objects\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     10142.sp
     10143Example:
     10144\fI\fIvfs objects\fR\fR\fI = \fR\fI\FCextd_audit recycle\F[]\fR\fI \fR
    878810145.RE
    878910146
    879010147volume (S)
    8791 .PP
    8792 .RS 4
    8793 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\.
    8794 .sp
    8795 Default:
    8796 \fI\fIvolume\fR\fR\fI = \fR\fI # the name of the share\fR\fI \fR
     10148.\" volume
     10149.PP
     10150.RS 4
     10151This allows you to override the volume label returned for a share\&. Useful for CDROMs with installation programs that insist on a particular volume label\&.
     10152.sp
     10153Default:
     10154\fI\fIvolume\fR\fR\fI = \fR\fI\FC # the name of the share\F[]\fR\fI \fR
    879710155.RE
    879810156
    879910157wide links (S)
    8800 .PP
    8801 .RS 4
    8802 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\.
    8803 .sp
    8804 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\.
    8805 .sp
    8806 Default:
    8807 \fI\fIwide links\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10158.\" wide links
     10159.PP
     10160.RS 4
     10161This 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\&.
     10162.sp
     10163Note 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\&.
     10164.sp
     10165Default:
     10166\fI\fIwide links\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    880810167.RE
    880910168
    881010169winbind cache time (G)
     10170.\" winbind cache time
    881110171.PP
    881210172.RS 4
    881310173This parameter specifies the number of seconds the
    881410174\fBwinbindd\fR(8)
    8815 daemon will cache user and group information before querying a Windows NT server again\.
     10175daemon will cache user and group information before querying a Windows NT server again\&.
    881610176.sp
    881710177This does not apply to authentication requests, these are always evaluated in real time unless the
    8818 \fIwinbind offline logon\fR
    8819 option has been enabled\.
    8820 .sp
    8821 Default:
    8822 \fI\fIwinbind cache time\fR\fR\fI = \fR\fI300\fR\fI \fR
     10178\m[blue]\fBwinbind offline logon\fR\m[]
     10179option has been enabled\&.
     10180.sp
     10181Default:
     10182\fI\fIwinbind cache time\fR\fR\fI = \fR\fI\FC300\F[]\fR\fI \fR
    882310183.RE
    882410184
    882510185winbind enum groups (G)
     10186.\" winbind enum groups
    882610187.PP
    882710188.RS 4
     
    882910190\fBwinbindd\fR(8)
    883010191it may be necessary to suppress the enumeration of groups through the
    8831 setgrent(),
    8832 getgrent()
     10192\FCsetgrent()\F[],
     10193\FCgetgrent()\F[]
    883310194and
    8834 endgrent()
    8835 group of system calls\. If the
     10195\FCendgrent()\F[]
     10196group of system calls\&. If the
    883610197\fIwinbind enum groups\fR
    883710198parameter is
    883810199\fBno\fR, calls to the
    8839 getgrent()
    8840 system call will not return any data\.
    8841 .sp
     10200\FCgetgrent()\F[]
     10201system call will not return any data\&.
     10202.if n \{\
     10203.sp
     10204.\}
     10205.RS 4
     10206.BM yellow
    884210207.it 1 an-trap
    884310208.nr an-no-space-flag 1
    884410209.nr an-break-flag 1
    884510210.br
    8846 Warning
    8847 Turning off group enumeration may cause some programs to behave oddly\.
    8848 
    8849 Default:
    8850 \fI\fIwinbind enum groups\fR\fR\fI = \fR\fIno\fR\fI \fR
     10211.ps +1
     10212\fBWarning\fR
     10213.ps -1
     10214.br
     10215Turning off group enumeration may cause some programs to behave oddly\&.
     10216.sp .5v
     10217.EM yellow
     10218.RE
     10219Default:
     10220\fI\fIwinbind enum groups\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    885110221.RE
    885210222
    885310223winbind enum users (G)
     10224.\" winbind enum users
    885410225.PP
    885510226.RS 4
     
    885710228\fBwinbindd\fR(8)
    885810229it may be necessary to suppress the enumeration of users through the
    8859 setpwent(),
    8860 getpwent()
     10230\FCsetpwent()\F[],
     10231\FCgetpwent()\F[]
    886110232and
    8862 endpwent()
    8863 group of system calls\. If the
     10233\FCendpwent()\F[]
     10234group of system calls\&. If the
    886410235\fIwinbind enum users\fR
    886510236parameter is
    886610237\fBno\fR, calls to the
    8867 getpwent
    8868 system call will not return any data\.
    8869 .sp
     10238\FCgetpwent\F[]
     10239system call will not return any data\&.
     10240.if n \{\
     10241.sp
     10242.\}
     10243.RS 4
     10244.BM yellow
    887010245.it 1 an-trap
    887110246.nr an-no-space-flag 1
    887210247.nr an-break-flag 1
    887310248.br
    8874 Warning
    8875 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\.
    8876 
    8877 Default:
    8878 \fI\fIwinbind enum users\fR\fR\fI = \fR\fIno\fR\fI \fR
     10249.ps +1
     10250\fBWarning\fR
     10251.ps -1
     10252.br
     10253Turning 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\&.
     10254.sp .5v
     10255.EM yellow
     10256.RE
     10257Default:
     10258\fI\fIwinbind enum users\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    887910259.RE
    888010260
    888110261winbind nested groups (G)
    8882 .PP
    8883 .RS 4
    8884 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\.
    8885 .sp
    8886 Default:
    8887 \fI\fIwinbind nested groups\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10262.\" winbind nested groups
     10263.PP
     10264.RS 4
     10265If 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\&.
     10266.sp
     10267Default:
     10268\fI\fIwinbind nested groups\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    888810269.RE
    888910270
    889010271winbind normalize names (G)
    8891 .PP
    8892 .RS 4
    8893 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\. Do not enable this option if the underscore character is used in account names within your domain
    8894 .sp
    8895 Default:
    8896 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIno\fR\fI \fR
    8897 .sp
    8898 Example:
    8899 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10272.\" winbind normalize names
     10273.PP
     10274.RS 4
     10275This 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\&. Do not enable this option if the underscore character is used in account names within your domain
     10276.sp
     10277Default:
     10278\fI\fIwinbind normalize names\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
     10279.sp
     10280Example:
     10281\fI\fIwinbind normalize names\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    890010282.RE
    890110283
    890210284winbind nss info (G)
    8903 .PP
    8904 .RS 4
    8905 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:
     10285.\" winbind nss info
     10286.PP
     10287.RS 4
     10288This 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:
    890610289.sp
    890710290.RS 4
     
    892910312.\}
    893010313\fI<sfu | rfc2307 >\fR
    8931 \- 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
     10314\- 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
    893210315\fIidmap backend\fR
    893310316= ad or
    893410317\fIidmap config DOMAIN:backend\fR
    8935 = ad as well\.
    8936 .sp
    8937 .RE
    8938 .sp
    8939 Default:
    8940 \fI\fIwinbind nss info\fR\fR\fI = \fR\fItemplate\fR\fI \fR
    8941 .sp
    8942 Example:
    8943 \fI\fIwinbind nss info\fR\fR\fI = \fR\fItemplate sfu\fR\fI \fR
     10318= ad as well\&.
     10319.sp
     10320.RE
     10321.sp
     10322Default:
     10323\fI\fIwinbind nss info\fR\fR\fI = \fR\fI\FCtemplate\F[]\fR\fI \fR
     10324.sp
     10325Example:
     10326\fI\fIwinbind nss info\fR\fR\fI = \fR\fI\FCtemplate sfu\F[]\fR\fI \fR
    894410327.RE
    894510328
    894610329winbind offline logon (G)
     10330.\" winbind offline logon
    894710331.PP
    894810332.RS 4
    894910333This parameter is designed to control whether Winbind should allow to login with the
    895010334\fIpam_winbind\fR
    8951 module using Cached Credentials\. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\.
    8952 .sp
    8953 Default:
    8954 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fIfalse\fR\fI \fR
    8955 .sp
    8956 Example:
    8957 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fItrue\fR\fI \fR
     10335module using Cached Credentials\&. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\&.
     10336.sp
     10337Default:
     10338\fI\fIwinbind offline logon\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
     10339.sp
     10340Example:
     10341\fI\fIwinbind offline logon\fR\fR\fI = \fR\fI\FCtrue\F[]\fR\fI \fR
    895810342.RE
    895910343
    896010344winbind refresh tickets (G)
     10345.\" winbind refresh tickets
    896110346.PP
    896210347.RS 4
    896310348This parameter is designed to control whether Winbind should refresh Kerberos Tickets retrieved using the
    896410349\fIpam_winbind\fR
    8965 module\.
    8966 .sp
    8967 Default:
    8968 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fIfalse\fR\fI \fR
    8969 .sp
    8970 Example:
    8971 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fItrue\fR\fI \fR
     10350module\&.
     10351.sp
     10352Default:
     10353\fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
     10354.sp
     10355Example:
     10356\fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fI\FCtrue\F[]\fR\fI \fR
    897210357.RE
    897310358
    897410359winbind separator (G)
     10360.\" winbind separator
    897510361.PP
    897610362.RS 4
    897710363This parameter allows an admin to define the character used when listing a username of the form of
    8978 \fIDOMAIN \fR\e\fIuser\fR\. This parameter is only applicable when using the
    8979 \fIpam_winbind\.so\fR
     10364\fIDOMAIN \fR\e\fIuser\fR\&. This parameter is only applicable when using the
     10365\FCpam_winbind\&.so\F[]
    898010366and
    8981 \fInss_winbind\.so\fR
    8982 modules for UNIX services\.
    8983 .sp
    8984 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\.
    8985 .sp
    8986 Default:
    8987 \fI\fIwinbind separator\fR\fR\fI = \fR\fI\'\e\'\fR\fI \fR
    8988 .sp
    8989 Example:
    8990 \fI\fIwinbind separator\fR\fR\fI = \fR\fI+\fR\fI \fR
     10367\FCnss_winbind\&.so\F[]
     10368modules for UNIX services\&.
     10369.sp
     10370Please 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\&.
     10371.sp
     10372Default:
     10373\fI\fIwinbind separator\fR\fR\fI = \fR\fI\FC\'\e\'\F[]\fR\fI \fR
     10374.sp
     10375Example:
     10376\fI\fIwinbind separator\fR\fR\fI = \fR\fI\FC+\F[]\fR\fI \fR
    899110377.RE
    899210378
    899310379winbind trusted domains only (G)
    8994 .PP
    8995 .RS 4
    8996 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
    8997 DOMAIN\euser1
    8998 would be mapped to the account user1 in /etc/passwd instead of allocating a new uid for him or her\.
    8999 .sp
    9000 This parameter is now deprecated in favor of the newer idmap_nss backend\. Refer to the
    9001 \fIidmap domains\fR
    9002 smb\.conf option and the
     10380.\" winbind trusted domains only
     10381.PP
     10382.RS 4
     10383This 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
     10384\FCDOMAIN\euser1\F[]
     10385would be mapped to the account user1 in /etc/passwd instead of allocating a new uid for him or her\&.
     10386.sp
     10387This parameter is now deprecated in favor of the newer idmap_nss backend\&. Refer to the
     10388\m[blue]\fBidmap domains\fR\m[]
     10389smb\&.conf option and the
    900310390\fBidmap_nss\fR(8)
    9004 man page for more information\.
    9005 .sp
    9006 Default:
    9007 \fI\fIwinbind trusted domains only\fR\fR\fI = \fR\fIno\fR\fI \fR
     10391man page for more information\&.
     10392.sp
     10393Default:
     10394\fI\fIwinbind trusted domains only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    900810395.RE
    900910396
    901010397winbind use default domain (G)
     10398.\" winbind use default domain
    901110399.PP
    901210400.RS 4
    901310401This parameter specifies whether the
    901410402\fBwinbindd\fR(8)
    9015 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\.
    9016 .sp
    9017 Default:
    9018 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIno\fR\fI \fR
    9019 .sp
    9020 Example:
    9021 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10403daemon 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\&.
     10404.sp
     10405Default:
     10406\fI\fIwinbind use default domain\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
     10407.sp
     10408Example:
     10409\fI\fIwinbind use default domain\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    902210410.RE
    902310411
    902410412wins hook (G)
    9025 .PP
    9026 .RS 4
    9027 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\.
     10413.\" wins hook
     10414.PP
     10415.RS 4
     10416When 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\&.
    902810417.sp
    902910418The wins hook parameter specifies the name of a script or executable that will be called as follows:
    903010419.sp
    9031 wins_hook operation name nametype ttl IP_list
    9032 .sp
    9033 .RS 4
    9034 .ie n \{\
    9035 \h'-04'\(bu\h'+03'\c
    9036 .\}
    9037 .el \{\
    9038 .sp -1
    9039 .IP \(bu 2.3
    9040 .\}
    9041 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\.
    9042 .RE
    9043 .sp
    9044 .RS 4
    9045 .ie n \{\
    9046 \h'-04'\(bu\h'+03'\c
    9047 .\}
    9048 .el \{\
    9049 .sp -1
    9050 .IP \(bu 2.3
    9051 .\}
    9052 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\.
    9053 .RE
    9054 .sp
    9055 .RS 4
    9056 .ie n \{\
    9057 \h'-04'\(bu\h'+03'\c
    9058 .\}
    9059 .el \{\
    9060 .sp -1
    9061 .IP \(bu 2.3
    9062 .\}
    9063 The third argument is the NetBIOS name type as a 2 digit hexadecimal number\.
    9064 .RE
    9065 .sp
    9066 .RS 4
    9067 .ie n \{\
    9068 \h'-04'\(bu\h'+03'\c
    9069 .\}
    9070 .el \{\
    9071 .sp -1
    9072 .IP \(bu 2.3
    9073 .\}
    9074 The fourth argument is the TTL (time to live) for the name in seconds\.
    9075 .RE
    9076 .sp
    9077 .RS 4
    9078 .ie n \{\
    9079 \h'-04'\(bu\h'+03'\c
    9080 .\}
    9081 .el \{\
    9082 .sp -1
    9083 .IP \(bu 2.3
    9084 .\}
    9085 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\.
     10420\FCwins_hook operation name nametype ttl IP_list\F[]
     10421.sp
     10422.RS 4
     10423.ie n \{\
     10424\h'-04'\(bu\h'+03'\c
     10425.\}
     10426.el \{\
     10427.sp -1
     10428.IP \(bu 2.3
     10429.\}
     10430The 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\&.
     10431.RE
     10432.sp
     10433.RS 4
     10434.ie n \{\
     10435\h'-04'\(bu\h'+03'\c
     10436.\}
     10437.el \{\
     10438.sp -1
     10439.IP \(bu 2.3
     10440.\}
     10441The 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\&.
     10442.RE
     10443.sp
     10444.RS 4
     10445.ie n \{\
     10446\h'-04'\(bu\h'+03'\c
     10447.\}
     10448.el \{\
     10449.sp -1
     10450.IP \(bu 2.3
     10451.\}
     10452The third argument is the NetBIOS name type as a 2 digit hexadecimal number\&.
     10453.RE
     10454.sp
     10455.RS 4
     10456.ie n \{\
     10457\h'-04'\(bu\h'+03'\c
     10458.\}
     10459.el \{\
     10460.sp -1
     10461.IP \(bu 2.3
     10462.\}
     10463The fourth argument is the TTL (time to live) for the name in seconds\&.
     10464.RE
     10465.sp
     10466.RS 4
     10467.ie n \{\
     10468\h'-04'\(bu\h'+03'\c
     10469.\}
     10470.el \{\
     10471.sp -1
     10472.IP \(bu 2.3
     10473.\}
     10474The fifth and subsequent arguments are the IP addresses currently registered for that name\&. If this list is empty then the name should be deleted\&.
    908610475.sp
    908710476.RE
    908810477An example script that calls the BIND dynamic DNS update program
    9089 nsupdate
    9090 is provided in the examples directory of the Samba source code\.
     10478\FCnsupdate\F[]
     10479is provided in the examples directory of the Samba source code\&.
    909110480.sp
    909210481\fINo default\fR
     
    909410483
    909510484wins proxy (G)
     10485.\" wins proxy
    909610486.PP
    909710487.RS 4
    909810488This is a boolean that controls if
    909910489\fBnmbd\fR(8)
    9100 will respond to broadcast name queries on behalf of other hosts\. You may need to set this to
     10490will respond to broadcast name queries on behalf of other hosts\&. You may need to set this to
    910110491\fByes\fR
    9102 for some older clients\.
    9103 .sp
    9104 Default:
    9105 \fI\fIwins proxy\fR\fR\fI = \fR\fIno\fR\fI \fR
     10492for some older clients\&.
     10493.sp
     10494Default:
     10495\fI\fIwins proxy\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    910610496.RE
    910710497
    910810498wins server (G)
     10499.\" wins server
    910910500.PP
    911010501.RS 4
    911110502This specifies the IP address (or DNS name: IP address for preference) of the WINS server that
    911210503\fBnmbd\fR(8)
    9113 should register with\. If you have a WINS server on your network then you should set this to the WINS server\'s IP\.
    9114 .sp
    9115 You should point this at your WINS server if you have a multi\-subnetted network\.
    9116 .sp
    9117 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\.
    9118 .sp
     10504should register with\&. If you have a WINS server on your network then you should set this to the WINS server\'s IP\&.
     10505.sp
     10506You should point this at your WINS server if you have a multi\-subnetted network\&.
     10507.sp
     10508If 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\&.
     10509.if n \{\
     10510.sp
     10511.\}
     10512.RS 4
     10513.BM yellow
    911910514.it 1 an-trap
    912010515.nr an-no-space-flag 1
    912110516.nr an-break-flag 1
    912210517.br
    9123 Note
    9124 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\.
    9125 
    9126 See the chapter in the Samba3\-HOWTO on Network Browsing\.
    9127 .sp
    9128 Default:
    9129 \fI\fIwins server\fR\fR\fI = \fR\fI\fR\fI \fR
    9130 .sp
    9131 Example:
    9132 \fI\fIwins server\fR\fR\fI = \fR\fImary: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\.\fR\fI \fR
    9133 .sp
    9134 Example:
    9135 \fI\fIwins server\fR\fR\fI = \fR\fI192\.9\.200\.1 192\.168\.2\.61\fR\fI \fR
     10518.ps +1
     10519\fBNote\fR
     10520.ps -1
     10521.br
     10522You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross\-subnet browsing to work correctly\&.
     10523.sp .5v
     10524.EM yellow
     10525.RE
     10526See the chapter in the Samba3\-HOWTO on Network Browsing\&.
     10527.sp
     10528Default:
     10529\fI\fIwins server\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     10530.sp
     10531Example:
     10532\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
     10533.sp
     10534Example:
     10535\fI\fIwins server\fR\fR\fI = \fR\fI\FC192\&.9\&.200\&.1 192\&.168\&.2\&.61\F[]\fR\fI \fR
    913610536.RE
    913710537
    913810538wins support (G)
     10539.\" wins support
    913910540.PP
    914010541.RS 4
    914110542This boolean controls if the
    914210543\fBnmbd\fR(8)
    9143 process in Samba will act as a WINS server\. You should not set this to
     10544process in Samba will act as a WINS server\&. You should not set this to
    914410545\fByes\fR
    914510546unless you have a multi\-subnetted network and you wish a particular
    9146 nmbd
    9147 to be your WINS server\. Note that you should
     10547\FCnmbd\F[]
     10548to be your WINS server\&. Note that you should
    914810549\fINEVER\fR
    914910550set this to
    915010551\fByes\fR
    9151 on more than one machine in your network\.
    9152 .sp
    9153 Default:
    9154 \fI\fIwins support\fR\fR\fI = \fR\fIno\fR\fI \fR
     10552on more than one machine in your network\&.
     10553.sp
     10554Default:
     10555\fI\fIwins support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    915510556.RE
    915610557
    915710558workgroup (G)
    9158 .PP
    9159 .RS 4
    9160 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
    9161 \fIsecurity = domain\fR
    9162 setting\.
    9163 .sp
    9164 Default:
    9165 \fI\fIworkgroup\fR\fR\fI = \fR\fIWORKGROUP\fR\fI \fR
    9166 .sp
    9167 Example:
    9168 \fI\fIworkgroup\fR\fR\fI = \fR\fIMYGROUP\fR\fI \fR
     10559.\" workgroup
     10560.PP
     10561.RS 4
     10562This 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
     10563\m[blue]\fBsecurity = domain\fR\m[]
     10564setting\&.
     10565.sp
     10566Default:
     10567\fI\fIworkgroup\fR\fR\fI = \fR\fI\FCWORKGROUP\F[]\fR\fI \fR
     10568.sp
     10569Example:
     10570\fI\fIworkgroup\fR\fR\fI = \fR\fI\FCMYGROUP\F[]\fR\fI \fR
    916910571.RE
    917010572
    917110573writable
     10574.\" writable
    917210575.PP
    917310576.RS 4
    917410577This parameter is a synonym for
    9175 writeable\.
     10578writeable\&.
    917610579.RE
    917710580
    917810581writeable (S)
     10582.\" writeable
    917910583.PP
    918010584.RS 4
    918110585Inverted synonym for
    9182 \fIread only\fR\.
    9183 .sp
    9184 \fINo default\fR
     10586\m[blue]\fBread only\fR\m[]\&.
     10587.sp
     10588Default:
     10589\fI\fIwriteable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    918510590.RE
    918610591
    918710592write cache size (S)
     10593.\" write cache size
    918810594.PP
    918910595.RS 4
    919010596If this integer parameter is set to non\-zero value, Samba will create an in\-memory cache for each oplocked file (it does
    919110597\fInot\fR
    9192 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\.
    9193 .sp
    9194 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\.
    9195 .sp
    9196 The integer parameter specifies the size of this cache (per oplocked file) in bytes\.
    9197 .sp
    9198 Default:
    9199 \fI\fIwrite cache size\fR\fR\fI = \fR\fI0\fR\fI \fR
    9200 .sp
    9201 Example:
    9202 \fI\fIwrite cache size\fR\fR\fI = \fR\fI262144 # for a 256k cache size per file\fR\fI \fR
     10598do 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\&.
     10599.sp
     10600This 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\&.
     10601.sp
     10602The integer parameter specifies the size of this cache (per oplocked file) in bytes\&.
     10603.sp
     10604Default:
     10605\fI\fIwrite cache size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     10606.sp
     10607Example:
     10608\fI\fIwrite cache size\fR\fR\fI = \fR\fI\FC262144 # for a 256k cache size per file\F[]\fR\fI \fR
    920310609.RE
    920410610
    920510611write list (S)
    9206 .PP
    9207 .RS 4
    9208 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
    9209 \fIread only\fR
    9210 option is set to\. The list can include group names using the @group syntax\.
    9211 .sp
    9212 Note that if a user is in both the read list and the write list then they will be given write access\.
     10612.\" write list
     10613.PP
     10614.RS 4
     10615This 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
     10616\m[blue]\fBread only\fR\m[]
     10617option is set to\&. The list can include group names using the @group syntax\&.
     10618.sp
     10619Note that if a user is in both the read list and the write list then they will be given write access\&.
    921310620.sp
    921410621By design, this parameter will not work with the
    9215 \fIsecurity = share\fR
    9216 in Samba 3\.0\.
    9217 .sp
    9218 Default:
    9219 \fI\fIwrite list\fR\fR\fI = \fR\fI\fR\fI \fR
    9220 .sp
    9221 Example:
    9222 \fI\fIwrite list\fR\fR\fI = \fR\fIadmin, root, @staff\fR\fI \fR
     10622\m[blue]\fBsecurity = share\fR\m[]
     10623in Samba 3\&.0\&.
     10624.sp
     10625Default:
     10626\fI\fIwrite list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     10627.sp
     10628Example:
     10629\fI\fIwrite list\fR\fR\fI = \fR\fI\FCadmin, root, @staff\F[]\fR\fI \fR
    922310630.RE
    922410631
    922510632write raw (G)
    9226 .PP
    9227 .RS 4
    9228 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\.
    9229 .sp
    9230 Default:
    9231 \fI\fIwrite raw\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10633.\" write raw
     10634.PP
     10635.RS 4
     10636This 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\&.
     10637.sp
     10638Default:
     10639\fI\fIwrite raw\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    923210640.RE
    923310641
    923410642wtmp directory (G)
     10643.\" wtmp directory
    923510644.PP
    923610645.RS 4
    923710646This parameter is only available if Samba has been configured and compiled with the option
    9238 \-\-with\-utmp\. 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\.
     10647\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\&.
    923910648.sp
    924010649By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually
    9241 \fI/var/run/wtmp\fR
    9242 on Linux)\.
    9243 .sp
    9244 Default:
    9245 \fI\fIwtmp directory\fR\fR\fI = \fR\fI\fR\fI \fR
    9246 .sp
    9247 Example:
    9248 \fI\fIwtmp directory\fR\fR\fI = \fR\fI/var/log/wtmp\fR\fI \fR
     10650\FC/var/run/wtmp\F[]
     10651on Linux)\&.
     10652.sp
     10653Default:
     10654\fI\fIwtmp directory\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     10655.sp
     10656Example:
     10657\fI\fIwtmp directory\fR\fR\fI = \fR\fI\FC/var/log/wtmp\F[]\fR\fI \fR
    924910658.RE
    925010659.SH "WARNINGS"
    925110660.PP
    9252 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\.
    9253 .PP
    9254 On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\.
     10661Although 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\&.
     10662.PP
     10663On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\&.
    925510664\fBsmbd\fR(8)
    9256 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\.
     10665has 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\&.
    925710666.PP
    925810667Use of the
    9259 [homes]
     10668\FC[homes]\F[]
    926010669and
    9261 [printers]
    9262 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\.
     10670\FC[printers]\F[]
     10671special 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\&.
    926310672.SH "VERSION"
    926410673.PP
    9265 This man page is correct for version 3\.0 of the Samba suite\.
     10674This man page is correct for version 3\&.0 of the Samba suite\&.
    926610675.SH "SEE ALSO"
    926710676.PP
     
    927510684\fBnmblookup\fR(1),
    927610685\fBtestparm\fR(1),
    9277 \fBtestprns\fR(1)\.
     10686\fBtestprns\fR(1)\&.
    927810687.SH "AUTHOR"
    927910688.PP
    9280 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\.
    9281 .PP
    9282 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
    9283 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\.
     10689The 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\&.
     10690.PP
     10691The 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
     10692ftp://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\&.
Note: See TracChangeset for help on using the changeset viewer.