Ignore:
Timestamp:
May 27, 2009, 9:08:03 AM (16 years ago)
Author:
Herwig Bauernfeind
Message:

Update 3.2 branch to 3.2.8 docs

File:
1 edited

Legend:

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

    r229 r231  
    11.\"     Title: smb.conf
    2 .\"    Author:
    3 .\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
    4 .\"      Date: 12/19/2008
     2.\"    Author: [see the "AUTHOR" section]
     3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
     4.\"      Date: 02/03/2009
    55.\"    Manual: File Formats and Conventions
    66.\"    Source: Samba 3.2
     7.\"  Language: English
    78.\"
    8 .TH "SMB\.CONF" "5" "12/19/2008" "Samba 3\.2" "File Formats and Conventions"
     9.TH "SMB\&.CONF" "5" "02/03/2009" "Samba 3\&.2" "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, 1/0 or true/false\. Case is not significant in boolean values, but is preserved in string values\. Some items such as create masks are numeric\.
     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, 1/0 or true/false\&. Case is not significant in boolean values, but is preserved in string values\&. Some items such as create masks are numeric\&.
    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 "REGISTRY-BASED CONFIGURATION"
    580950.PP
    581 Starting with Samba version 3\.2\.0, the capability to store Samba configuration in the registry is available\. The configuration is stored in the registry key
    582 \fIHKLM\eSoftware\eSamba\esmbconf\fR\. There are two levels of registry configuration:
    583 .sp
    584 .RS 4
    585 \h'-04' 1.\h'+02'Share definitions stored in registry are used\. This is triggered by setting the global parameter
     951Starting with Samba version 3\&.2\&.0, the capability to store Samba configuration in the registry is available\&. The configuration is stored in the registry key
     952\fI\FCHKLM\eSoftware\eSamba\esmbconf\F[]\fR\&. There are two levels of registry configuration:
     953.sp
     954.RS 4
     955.ie n \{\
     956\h'-04' 1.\h'+01'\c
     957.\}
     958.el \{\
     959.sp -1
     960.IP "  1." 4.2
     961.\}
     962Share definitions stored in registry are used\&. This is triggered by setting the global parameter
    586963\fIregistry shares\fR
    587964to
    588965\(lqyes\(rq
    589966in
    590 \fIsmb\.conf\fR\.
     967\fIsmb\&.conf\fR\&.
    591968.sp
    592969The registry shares are loaded not at startup but on demand at runtime by
    593 \fIsmbd\fR\. Shares defined in
    594 \fIsmb\.conf\fR
    595 take priority over shares of the same name defined in registry\.
    596 .RE
    597 .sp
    598 .RS 4
    599 \h'-04' 2.\h'+02'Global
    600 \fIsmb\.conf\fR
    601 options stored in registry are used\. This can be activated in two different ways:
     970\fIsmbd\fR\&. Shares defined in
     971\fIsmb\&.conf\fR
     972take priority over shares of the same name defined in registry\&.
     973.RE
     974.sp
     975.RS 4
     976.ie n \{\
     977\h'-04' 2.\h'+01'\c
     978.\}
     979.el \{\
     980.sp -1
     981.IP "  2." 4.2
     982.\}
     983Global
     984\fIsmb\&.conf\fR
     985options stored in registry are used\&. This can be activated in two different ways:
    602986.sp
    603987Firstly, a registry only configuration is triggered by setting
    604 \fIconfig backend = registry\fR
     988\m[blue]\fBconfig backend = registry\fR\m[]
    605989in the [global] section of
    606 \fIsmb\.conf\fR\. This resets everything that has been read from config files to this point and reads the content of the global configuration section from the registry\. This is the recommended method of using registry based configuration\.
     990\fIsmb\&.conf\fR\&. This resets everything that has been read from config files to this point and reads the content of the global configuration section from the registry\&. This is the recommended method of using registry based configuration\&.
    607991.sp
    608992Secondly, a mixed configuration can be activated by a special new meaning of the parameter
    609 \fIinclude = registry\fR
     993\m[blue]\fBinclude = registry\fR\m[]
    610994in the [global] section of
    611 \fIsmb\.conf\fR\. This reads the global options from registry with the same priorities as for an include of a text file\. This may be especially useful in cases where an initial configuration is needed to access the registry\.
    612 .sp
    613 Activation of global registry options automatically activates registry shares\. So in the registry only case, shares are loaded on demand only\.
     995\fIsmb\&.conf\fR\&. This reads the global options from registry with the same priorities as for an include of a text file\&. This may be especially useful in cases where an initial configuration is needed to access the registry\&.
     996.sp
     997Activation of global registry options automatically activates registry shares\&. So in the registry only case, shares are loaded on demand only\&.
    614998.RE
    615999.sp
     
    6221006inside the registry configuration has been disabled: Especially by changing the
    6231007\fIlock directory\fR
    624 inside the registry configuration, one would create a broken setup where the daemons do not see the configuration they loaded once it is active\.
     1008inside the registry configuration, one would create a broken setup where the daemons do not see the configuration they loaded once it is active\&.
    6251009.PP
    6261010The registry configuration can be accessed with tools like
     
    6291013\fInet (rpc) registry\fR
    6301014in the key
    631 \fIHKLM\eSoftware\eSamba\esmbconf\fR\. More conveniently, the
     1015\fI\FCHKLM\eSoftware\eSamba\esmbconf\F[]\fR\&. More conveniently, the
    6321016\fIconf\fR
    6331017subcommand of the
    6341018\fBnet\fR(8)
    635 utility offers a dedicated interface to read and write the registry based configuration locally, i\.e\. directly accessing the database file, circumventing the server\.
     1019utility offers a dedicated interface to read and write the registry based configuration locally, i\&.e\&. directly accessing the database file, circumventing the server\&.
    6361020.SH "EXPLANATION OF EACH PARAMETER"
    6371021
    6381022
    6391023abort shutdown script (G)
     1024.\" abort shutdown script
    6401025.PP
    6411026.RS 4
     
    6431028\fBsmbd\fR(8)
    6441029that should stop a shutdown procedure issued by the
    645 \fIshutdown script\fR\.
     1030\m[blue]\fBshutdown script\fR\m[]\&.
    6461031.sp
    6471032If the connected user posseses the
    648 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user\.
    649 .sp
    650 Default:
    651 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI""\fR\fI \fR
    652 .sp
    653 Example:
    654 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI/sbin/shutdown \-c\fR\fI \fR
     1033\fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user\&.
     1034.sp
     1035Default:
     1036\fI\fIabort shutdown script\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
     1037.sp
     1038Example:
     1039\fI\fIabort shutdown script\fR\fR\fI = \fR\fI\FC/sbin/shutdown \-c\F[]\fR\fI \fR
    6551040.RE
    6561041
    6571042acl check permissions (S)
     1043.\" acl check permissions
    6581044.PP
    6591045.RS 4
    6601046This boolean parameter controls what
    661 \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\.
    662 .sp
    663 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\.
    664 .sp
    665 Default:
    666 \fI\fIacl check permissions\fR\fR\fI = \fR\fITrue\fR\fI \fR
    667 .RE
    668 
    669 acl compatibility (S)
    670 .PP
    671 .RS 4
    672 This parameter specifies what OS ACL semantics should be compatible with\. Possible values are
     1047\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\&.
     1048.sp
     1049If 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\&.
     1050.sp
     1051Default:
     1052\fI\fIacl check permissions\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
     1053.RE
     1054
     1055acl compatibility (G)
     1056.\" acl compatibility
     1057.PP
     1058.RS 4
     1059This parameter specifies what OS ACL semantics should be compatible with\&. Possible values are
    6731060\fIwinnt\fR
    6741061for Windows NT 4,
    6751062\fIwin2k\fR
    6761063for Windows 2000 and above and
    677 \fIauto\fR\. If you specify
    678 \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\.
    679 .sp
    680 Default:
    681 \fI\fIacl compatibility\fR\fR\fI = \fR\fIAuto\fR\fI \fR
    682 .sp
    683 Example:
    684 \fI\fIacl compatibility\fR\fR\fI = \fR\fIwin2k\fR\fI \fR
     1064\fIauto\fR\&. If you specify
     1065\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\&.
     1066.sp
     1067Default:
     1068\fI\fIacl compatibility\fR\fR\fI = \fR\fI\FCAuto\F[]\fR\fI \fR
     1069.sp
     1070Example:
     1071\fI\fIacl compatibility\fR\fR\fI = \fR\fI\FCwin2k\F[]\fR\fI \fR
    6851072.RE
    6861073
    6871074acl group control (S)
    688 .PP
    689 .RS 4
    690 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
     1075.\" acl group control
     1076.PP
     1077.RS 4
     1078In 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
    6911079\fIprimary group owner\fR
    692 of a file or directory to modify the permissions and ACLs on that file\.
    693 .sp
    694 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\.
    695 .sp
    696 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\.
     1080of a file or directory to modify the permissions and ACLs on that file\&.
     1081.sp
     1082On 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\&.
     1083.sp
     1084This 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\&.
    6971085.sp
    6981086This parameter is best used with the
    699 \fIinherit owner\fR
     1087\m[blue]\fBinherit owner\fR\m[]
    7001088option and also on on a share containing directories with the UNIX
    7011089\fIsetgid bit\fR
    702 set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory\.
    703 .sp
    704 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
     1090set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory\&.
     1091.sp
     1092This 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
    7051093\fIdos filemode\fR
    706 option\.
    707 .sp
    708 Default:
    709 \fI\fIacl group control\fR\fR\fI = \fR\fIno\fR\fI \fR
     1094option\&.
     1095.sp
     1096Default:
     1097\fI\fIacl group control\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    7101098.RE
    7111099
    7121100acl map full control (S)
     1101.\" acl map full control
    7131102.PP
    7141103.RS 4
    7151104This boolean parameter controls whether
    716 \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\.
    717 .sp
    718 Default:
    719 \fI\fIacl map full control\fR\fR\fI = \fR\fITrue\fR\fI \fR
     1105\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\&.
     1106.sp
     1107Default:
     1108\fI\fIacl map full control\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
    7201109.RE
    7211110
    7221111add group script (G)
     1112.\" add group script
    7231113.PP
    7241114.RS 4
     
    7271117by
    7281118\fBsmbd\fR(8)
    729 when a new group is requested\. It will expand any
     1119when a new group is requested\&. It will expand any
    7301120\fI%g\fR
    731 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\.
    732 .sp
    733 Default:
    734 \fI\fIadd group script\fR\fR\fI = \fR\fI\fR\fI \fR
    735 .sp
    736 Example:
    737 \fI\fIadd group script\fR\fR\fI = \fR\fI/usr/sbin/groupadd %g\fR\fI \fR
     1121to 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\&.
     1122.sp
     1123Default:
     1124\fI\fIadd group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1125.sp
     1126Example:
     1127\fI\fIadd group script\fR\fR\fI = \fR\fI\FC/usr/sbin/groupadd %g\F[]\fR\fI \fR
    7381128.RE
    7391129
    7401130add machine script (G)
     1131.\" add machine script
    7411132.PP
    7421133.RS 4
    7431134This is the full pathname to a script that will be run by
    7441135\fBsmbd\fR(8)
    745 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\.
     1136when a machine is added to Samba\'s domain and a Unix account matching the machine\'s name appended with a "$" does not already exist\&.
    7461137.sp
    7471138This option is very similar to the
    748 \fIadd user script\fR, and likewise uses the %u substitution for the account name\. Do not use the %m substitution\.
    749 .sp
    750 Default:
    751 \fI\fIadd machine script\fR\fR\fI = \fR\fI\fR\fI \fR
    752 .sp
    753 Example:
    754 \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
     1139\m[blue]\fBadd user script\fR\m[], and likewise uses the %u substitution for the account name\&. Do not use the %m substitution\&.
     1140.sp
     1141Default:
     1142\fI\fIadd machine script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1143.sp
     1144Example:
     1145\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
    7551146.RE
    7561147
    7571148add port command (G)
    758 .PP
    759 .RS 4
    760 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:
     1149.\" add port command
     1150.PP
     1151.RS 4
     1152Samba 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:
    7611153.sp
    7621154.RS 4
     
    7821174.sp
    7831175.RE
    784 The deviceURI is in the for of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>\.
    785 .sp
    786 Default:
    787 \fI\fIadd port command\fR\fR\fI = \fR\fI\fR\fI \fR
    788 .sp
    789 Example:
    790 \fI\fIadd port command\fR\fR\fI = \fR\fI/etc/samba/scripts/addport\.sh\fR\fI \fR
     1176The deviceURI is in the for of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>\&.
     1177.sp
     1178Default:
     1179\fI\fIadd port command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1180.sp
     1181Example:
     1182\fI\fIadd port command\fR\fR\fI = \fR\fI\FC/etc/samba/scripts/addport\&.sh\F[]\fR\fI \fR
    7911183.RE
    7921184
    7931185addprinter command (G)
    794 .PP
    795 .RS 4
    796 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\.
    797 .sp
    798 For a Samba host this means that the printer must be physically added to the underlying printing system\. The
     1186.\" addprinter command
     1187.PP
     1188.RS 4
     1189With 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\&.
     1190.sp
     1191For a Samba host this means that the printer must be physically added to the underlying printing system\&. The
    7991192\fIaddprinter command\fR
    8001193defines 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
    801 \fIsmb\.conf\fR
     1194\FCsmb\&.conf\F[]
    8021195file in order that it can be shared by
    803 \fBsmbd\fR(8)\.
     1196\fBsmbd\fR(8)\&.
    8041197.sp
    8051198The
     
    8731266.sp
    8741267.RE
    875 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\.
     1268All 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\&.
    8761269.sp
    8771270Once the
    8781271\fIaddprinter command\fR
    8791272has been executed,
    880 smbd
     1273\FCsmbd\F[]
    8811274will reparse the
    882 \fI smb\.conf\fR
    883 to determine if the share defined by the APW exists\. If the sharename is still invalid, then
    884 smbd
    885 will return an ACCESS_DENIED error to the client\.
     1275\FC smb\&.conf\F[]
     1276to determine if the share defined by the APW exists\&. If the sharename is still invalid, then
     1277\FCsmbd \F[]
     1278will return an ACCESS_DENIED error to the client\&.
    8861279.sp
    8871280The
    8881281\fIaddprinter command\fR
    889 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\.
    890 .sp
    891 Default:
    892 \fI\fIaddprinter command\fR\fR\fI = \fR\fI\fR\fI \fR
    893 .sp
    894 Example:
    895 \fI\fIaddprinter command\fR\fR\fI = \fR\fI/usr/bin/addprinter\fR\fI \fR
     1282program 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\&.
     1283.sp
     1284Default:
     1285\fI\fIaddprinter command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1286.sp
     1287Example:
     1288\fI\fIaddprinter command\fR\fR\fI = \fR\fI\FC/usr/bin/addprinter\F[]\fR\fI \fR
    8961289.RE
    8971290
    8981291add share command (G)
    899 .PP
    900 .RS 4
    901 Samba 2\.2\.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\.0 Server Manager\. The
     1292.\" add share command
     1293.PP
     1294.RS 4
     1295Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
    9021296\fIadd share command\fR
    9031297is used to define an external program or script which will add a new service definition to
    904 \fIsmb\.conf\fR\. In order to successfully execute the
     1298\FCsmb\&.conf\F[]\&.
     1299.sp
     1300In order to successfully execute the
    9051301\fIadd share command\fR,
    906 smbd
    907 requires that the administrator be connected using a root account (i\.e\. uid == 0)\.
    908 .sp
    909 If the connected account has
    910 SeDiskOperatorPrivilege, scripts defined in
    911 \fIchange share\fR
    912 parameter are executed as root\.
     1302\FCsmbd\F[]
     1303requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
     1304\FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
     1305\fIadd share command\fR
     1306parameter are executed as root\&.
    9131307.sp
    9141308When executed,
    915 smbd
     1309\FCsmbd\F[]
    9161310will automatically invoke the
    9171311\fIadd share command\fR
    918 with five parameters\.
     1312with five parameters\&.
    9191313.sp
    9201314.RS 4
     
    9281322\fIconfigFile\fR
    9291323\- the location of the global
    930 \fIsmb\.conf\fR
    931 file\.
     1324\FCsmb\&.conf\F[]
     1325file\&.
    9321326.RE
    9331327.sp
     
    9411335.\}
    9421336\fIshareName\fR
    943 \- the name of the new share\.
     1337\- the name of the new share\&.
    9441338.RE
    9451339.sp
     
    9531347.\}
    9541348\fIpathName\fR
    955 \- path to an **existing** directory on disk\.
     1349\- path to an **existing** directory on disk\&.
    9561350.RE
    9571351.sp
     
    9651359.\}
    9661360\fIcomment\fR
    967 \- comment string to associate with the new share\.
     1361\- comment string to associate with the new share\&.
    9681362.RE
    9691363.sp
     
    9771371.\}
    9781372\fImax connections\fR
    979 Number of maximum simultaneous connections to this share\.
    980 .sp
    981 .RE
    982 This parameter is only used for add file shares\. To add printer shares, see the
    983 \fIaddprinter command\fR\.
    984 .sp
    985 Default:
    986 \fI\fIadd share command\fR\fR\fI = \fR\fI\fR\fI \fR
    987 .sp
    988 Example:
    989 \fI\fIadd share command\fR\fR\fI = \fR\fI/usr/local/bin/addshare\fR\fI \fR
     1373Number of maximum simultaneous connections to this share\&.
     1374.sp
     1375.RE
     1376This parameter is only used to add file shares\&. To add printer shares, see the
     1377\m[blue]\fBaddprinter command\fR\m[]\&.
     1378.sp
     1379Default:
     1380\fI\fIadd share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1381.sp
     1382Example:
     1383\fI\fIadd share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/addshare\F[]\fR\fI \fR
    9901384.RE
    9911385
    9921386add user script (G)
     1387.\" add user script
    9931388.PP
    9941389.RS 4
     
    9971392by
    9981393\fBsmbd\fR(8)
    999 under special circumstances described below\.
    1000 .sp
    1001 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
     1394under special circumstances described below\&.
     1395.sp
     1396Normally, 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
    10021397\fION DEMAND\fR
    1003 when a user accesses the Samba server\.
     1398when a user accesses the Samba server\&.
    10041399.sp
    10051400In order to use this option,
     
    10081403\fINOT\fR
    10091404be set to
    1010 \fIsecurity = share\fR
     1405\m[blue]\fBsecurity = share\fR\m[]
    10111406and
    1012 \fIadd user script\fR
     1407\m[blue]\fBadd user script\fR\m[]
    10131408must be set to a full pathname for a script that will create a UNIX user given one argument of
    1014 \fI%u\fR, which expands into the UNIX user name to create\.
     1409\fI%u\fR, which expands into the UNIX user name to create\&.
    10151410.sp
    10161411When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time,
    10171412\fBsmbd\fR(8)
    10181413contacts the
    1019 \fIpassword server\fR
    1020 and attempts to authenticate the given user with the given password\. If the authentication succeeds then
    1021 smbd
    1022 attempts to find a UNIX user in the UNIX password database to map the Windows user into\. If this lookup fails, and
    1023 \fIadd user script\fR
     1414\m[blue]\fBpassword server\fR\m[]
     1415and attempts to authenticate the given user with the given password\&. If the authentication succeeds then
     1416\FCsmbd\F[]
     1417attempts to find a UNIX user in the UNIX password database to map the Windows user into\&. If this lookup fails, and
     1418\m[blue]\fBadd user script\fR\m[]
    10241419is set then
    1025 smbd
     1420\FCsmbd\F[]
    10261421will call the specified script
    10271422\fIAS ROOT\fR, expanding any
    10281423\fI%u\fR
    1029 argument to be the user name to create\.
     1424argument to be the user name to create\&.
    10301425.sp
    10311426If this script successfully creates the user then
    1032 smbd
    1033 will continue on as though the UNIX user already existed\. In this way, UNIX users are dynamically created to match existing Windows NT accounts\.
     1427\FCsmbd\F[]
     1428will continue on as though the UNIX user already existed\&. In this way, UNIX users are dynamically created to match existing Windows NT accounts\&.
    10341429.sp
    10351430See also
    1036 \fIsecurity\fR,
    1037 \fIpassword server\fR,
    1038 \fIdelete user script\fR\.
    1039 .sp
    1040 Default:
    1041 \fI\fIadd user script\fR\fR\fI = \fR\fI\fR\fI \fR
    1042 .sp
    1043 Example:
    1044 \fI\fIadd user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/add_user %u\fR\fI \fR
     1431\m[blue]\fBsecurity\fR\m[],
     1432\m[blue]\fBpassword server\fR\m[],
     1433\m[blue]\fBdelete user script\fR\m[]\&.
     1434.sp
     1435Default:
     1436\fI\fIadd user script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1437.sp
     1438Example:
     1439\fI\fIadd user script\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/add_user %u\F[]\fR\fI \fR
    10451440.RE
    10461441
    10471442add user to group script (G)
    1048 .PP
    1049 .RS 4
    1050 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
     1443.\" add user to group script
     1444.PP
     1445.RS 4
     1446Full 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
    10511447\fBsmbd\fR(8)
    1052 \fIAS ROOT\fR\. Any
     1448\fIAS ROOT\fR\&. Any
    10531449\fI%g\fR
    10541450will be replaced with the group name and any
    10551451\fI%u\fR
    1056 will be replaced with the user name\.
     1452will be replaced with the user name\&.
    10571453.sp
    10581454Note that the
    1059 adduser
    1060 command used in the example below does not support the used syntax on all systems\.
    1061 .sp
    1062 Default:
    1063 \fI\fIadd user to group script\fR\fR\fI = \fR\fI\fR\fI \fR
    1064 .sp
    1065 Example:
    1066 \fI\fIadd user to group script\fR\fR\fI = \fR\fI/usr/sbin/adduser %u %g\fR\fI \fR
     1455\FCadduser\F[]
     1456command used in the example below does not support the used syntax on all systems\&.
     1457.sp
     1458Default:
     1459\fI\fIadd user to group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1460.sp
     1461Example:
     1462\fI\fIadd user to group script\fR\fR\fI = \fR\fI\FC/usr/sbin/adduser %u %g\F[]\fR\fI \fR
    10671463.RE
    10681464
    10691465administrative share (S)
     1466.\" administrative share
    10701467.PP
    10711468.RS 4
    10721469If this parameter is set to
    10731470\fByes\fR
    1074 for a share, then the share will be an administrative share\. The Administrative Shares are the default network shares created by all Windows NT\-based operating systems\. These are shares like C$, D$ or ADMIN$\. The type of these shares is STYPE_DISKTREE_HIDDEN\.
     1471for a share, then the share will be an administrative share\&. The Administrative Shares are the default network shares created by all Windows NT\-based operating systems\&. These are shares like C$, D$ or ADMIN$\&. The type of these shares is STYPE_DISKTREE_HIDDEN\&.
    10751472.sp
    10761473See the section below on
    1077 \fIsecurity\fR
    1078 for more information about this option\.
    1079 .sp
    1080 Default:
    1081 \fI\fIadministrative share\fR\fR\fI = \fR\fIno\fR\fI \fR
     1474\m[blue]\fBsecurity\fR\m[]
     1475for more information about this option\&.
     1476.sp
     1477Default:
     1478\fI\fIadministrative share\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    10821479.RE
    10831480
    10841481admin users (S)
    1085 .PP
    1086 .RS 4
    1087 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)\.
    1088 .sp
    1089 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\.
     1482.\" admin users
     1483.PP
     1484.RS 4
     1485This 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)\&.
     1486.sp
     1487You 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\&.
    10901488.sp
    10911489This parameter will not work with the
    1092 \fIsecurity = share\fR
    1093 in Samba 3\.0\. This is by design\.
    1094 .sp
    1095 Default:
    1096 \fI\fIadmin users\fR\fR\fI = \fR\fI\fR\fI \fR
    1097 .sp
    1098 Example:
    1099 \fI\fIadmin users\fR\fR\fI = \fR\fIjason\fR\fI \fR
     1490\m[blue]\fBsecurity = share\fR\m[]
     1491in Samba 3\&.0\&. This is by design\&.
     1492.sp
     1493Default:
     1494\fI\fIadmin users\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1495.sp
     1496Example:
     1497\fI\fIadmin users\fR\fR\fI = \fR\fI\FCjason\F[]\fR\fI \fR
    11001498.RE
    11011499
    11021500afs share (S)
    1103 .PP
    1104 .RS 4
    1105 This parameter controls whether special AFS features are enabled for this share\. If enabled, it assumes that the directory exported via the
     1501.\" afs share
     1502.PP
     1503.RS 4
     1504This parameter controls whether special AFS features are enabled for this share\&. If enabled, it assumes that the directory exported via the
    11061505\fIpath\fR
    1107 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\.
    1108 .sp
    1109 Default:
    1110 \fI\fIafs share\fR\fR\fI = \fR\fIno\fR\fI \fR
     1506parameter 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\&.
     1507.sp
     1508Default:
     1509\fI\fIafs share\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    11111510.RE
    11121511
    11131512afs username map (G)
    1114 .PP
    1115 .RS 4
    1116 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\.
    1117 .sp
    1118 The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token\.
    1119 .sp
    1120 Default:
    1121 \fI\fIafs username map\fR\fR\fI = \fR\fI\fR\fI \fR
    1122 .sp
    1123 Example:
    1124 \fI\fIafs username map\fR\fR\fI = \fR\fI%u@afs\.samba\.org\fR\fI \fR
     1513.\" afs username map
     1514.PP
     1515.RS 4
     1516If 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\&.
     1517.sp
     1518The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token\&.
     1519.sp
     1520Default:
     1521\fI\fIafs username map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1522.sp
     1523Example:
     1524\fI\fIafs username map\fR\fR\fI = \fR\fI\FC%u@afs\&.samba\&.org\F[]\fR\fI \fR
    11251525.RE
    11261526
    11271527aio read size (S)
    1128 .PP
    1129 .RS 4
    1130 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\.
    1131 .sp
    1132 Current implementation of asynchronous I/O in Samba 3\.0 does support only up to 10 outstanding asynchronous requests, read and write combined\.
     1528.\" aio read size
     1529.PP
     1530.RS 4
     1531If 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\&.
     1532.sp
     1533Current implementation of asynchronous I/O in Samba 3\&.0 does support only up to 10 outstanding asynchronous requests, read and write combined\&.
    11331534.sp
    11341535Related command:
    1135 \fIwrite cache size\fR
     1536\m[blue]\fBwrite cache size\fR\m[]
    11361537.sp
    11371538Related command:
    1138 \fIaio write size\fR
    1139 .sp
    1140 Default:
    1141 \fI\fIaio read size\fR\fR\fI = \fR\fI0\fR\fI \fR
    1142 .sp
    1143 Example:
    1144 \fI\fIaio read size\fR\fR\fI = \fR\fI16384 # Use asynchronous I/O for reads bigger than 16KB request size\fR\fI \fR
     1539\m[blue]\fBaio write size\fR\m[]
     1540.sp
     1541Default:
     1542\fI\fIaio read size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     1543.sp
     1544Example:
     1545\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
    11451546.RE
    11461547
    11471548aio write size (S)
    1148 .PP
    1149 .RS 4
    1150 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\.
    1151 .sp
    1152 Current implementation of asynchronous I/O in Samba 3\.0 does support only up to 10 outstanding asynchronous requests, read and write combined\.
     1549.\" aio write size
     1550.PP
     1551.RS 4
     1552If 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\&.
     1553.sp
     1554Current implementation of asynchronous I/O in Samba 3\&.0 does support only up to 10 outstanding asynchronous requests, read and write combined\&.
    11531555.sp
    11541556Related command:
    1155 \fIwrite cache size\fR
     1557\m[blue]\fBwrite cache size\fR\m[]
    11561558.sp
    11571559Related command:
    1158 \fIaio read size\fR
    1159 .sp
    1160 Default:
    1161 \fI\fIaio write size\fR\fR\fI = \fR\fI0\fR\fI \fR
    1162 .sp
    1163 Example:
    1164 \fI\fIaio write size\fR\fR\fI = \fR\fI16384 # Use asynchronous I/O for writes bigger than 16KB request size\fR\fI \fR
     1560\m[blue]\fBaio read size\fR\m[]
     1561.sp
     1562Default:
     1563\fI\fIaio write size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     1564.sp
     1565Example:
     1566\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
    11651567.RE
    11661568
    11671569algorithmic rid base (G)
    1168 .PP
    1169 .RS 4
    1170 This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers\.
    1171 .sp
    1172 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\.
    1173 .sp
    1174 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\.
    1175 .sp
    1176 Default:
    1177 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI1000\fR\fI \fR
    1178 .sp
    1179 Example:
    1180 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI100000\fR\fI \fR
     1570.\" algorithmic rid base
     1571.PP
     1572.RS 4
     1573This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers\&.
     1574.sp
     1575Setting 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\&.
     1576.sp
     1577All 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\&.
     1578.sp
     1579Default:
     1580\fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
     1581.sp
     1582Example:
     1583\fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI\FC100000\F[]\fR\fI \fR
    11811584.RE
    11821585
    11831586allocation roundup size (S)
    1184 .PP
    1185 .RS 4
    1186 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\.
    1187 .sp
    1188 The integer parameter specifies the roundup size in bytes\.
    1189 .sp
    1190 Default:
    1191 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI1048576\fR\fI \fR
    1192 .sp
    1193 Example:
    1194 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI0 # (to disable roundups)\fR\fI \fR
     1587.\" allocation roundup size
     1588.PP
     1589.RS 4
     1590This 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\&.
     1591.sp
     1592The integer parameter specifies the roundup size in bytes\&.
     1593.sp
     1594Default:
     1595\fI\fIallocation roundup size\fR\fR\fI = \fR\fI\FC1048576\F[]\fR\fI \fR
     1596.sp
     1597Example:
     1598\fI\fIallocation roundup size\fR\fR\fI = \fR\fI\FC0 # (to disable roundups)\F[]\fR\fI \fR
    11951599.RE
    11961600
    11971601allow trusted domains (G)
     1602.\" allow trusted domains
    11981603.PP
    11991604.RS 4
    12001605This option only takes effect when the
    1201 \fIsecurity\fR
     1606\m[blue]\fBsecurity\fR\m[]
    12021607option is set to
    12031608\fBserver\fR,
    12041609\fBdomain\fR
    12051610or
    1206 \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\.
    1207 .sp
    1208 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\.
    1209 .sp
    1210 Default:
    1211 \fI\fIallow trusted domains\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1611\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\&.
     1612.sp
     1613This 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\&.
     1614.sp
     1615Default:
     1616\fI\fIallow trusted domains\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    12121617.RE
    12131618
    12141619announce as (G)
     1620.\" announce as
    12151621.PP
    12161622.RS 4
    12171623This specifies what type of server
    12181624\fBnmbd\fR(8)
    1219 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\.
    1220 .sp
    1221 Default:
    1222 \fI\fIannounce as\fR\fR\fI = \fR\fINT Server\fR\fI \fR
    1223 .sp
    1224 Example:
    1225 \fI\fIannounce as\fR\fR\fI = \fR\fIWin95\fR\fI \fR
     1625will 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\&.
     1626.sp
     1627Default:
     1628\fI\fIannounce as\fR\fR\fI = \fR\fI\FCNT Server\F[]\fR\fI \fR
     1629.sp
     1630Example:
     1631\fI\fIannounce as\fR\fR\fI = \fR\fI\FCWin95\F[]\fR\fI \fR
    12261632.RE
    12271633
    12281634announce version (G)
    1229 .PP
    1230 .RS 4
    1231 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\.
    1232 .sp
    1233 Default:
    1234 \fI\fIannounce version\fR\fR\fI = \fR\fI4\.9\fR\fI \fR
    1235 .sp
    1236 Example:
    1237 \fI\fIannounce version\fR\fR\fI = \fR\fI2\.0\fR\fI \fR
     1635.\" announce version
     1636.PP
     1637.RS 4
     1638This 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\&.
     1639.sp
     1640Default:
     1641\fI\fIannounce version\fR\fR\fI = \fR\fI\FC4\&.9\F[]\fR\fI \fR
     1642.sp
     1643Example:
     1644\fI\fIannounce version\fR\fR\fI = \fR\fI\FC2\&.0\F[]\fR\fI \fR
    12381645.RE
    12391646
    12401647auth methods (G)
     1648.\" auth methods
    12411649.PP
    12421650.RS 4
    12431651This option allows the administrator to chose what authentication methods
    1244 smbd
    1245 will use when authenticating a user\. This option defaults to sensible values based on
    1246 \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\.
    1247 .sp
    1248 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\.
     1652\FCsmbd\F[]
     1653will use when authenticating a user\&. This option defaults to sensible values based on
     1654\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\&.
     1655.sp
     1656Each 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\&.
    12491657.sp
    12501658Possible options include
     
    12581666(pre\-winbindd method of authentication for remote domain users; deprecated in favour of winbind method),
    12591667\fBtrustdomain\fR
    1260 (authenticate trusted users by contacting the remote DC directly from smbd; deprecated in favour of winbind method)\.
    1261 .sp
    1262 Default:
    1263 \fI\fIauth methods\fR\fR\fI = \fR\fI\fR\fI \fR
    1264 .sp
    1265 Example:
    1266 \fI\fIauth methods\fR\fR\fI = \fR\fIguest sam winbind\fR\fI \fR
     1668(authenticate trusted users by contacting the remote DC directly from smbd; deprecated in favour of winbind method)\&.
     1669.sp
     1670Default:
     1671\fI\fIauth methods\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1672.sp
     1673Example:
     1674\fI\fIauth methods\fR\fR\fI = \fR\fI\FCguest sam winbind\F[]\fR\fI \fR
    12671675.RE
    12681676
    12691677available (S)
    1270 .PP
    1271 .RS 4
    1272 This parameter lets you "turn off" a service\. If
     1678.\" available
     1679.PP
     1680.RS 4
     1681This parameter lets you "turn off" a service\&. If
    12731682\fIavailable = no\fR, then
    12741683\fIALL\fR
    1275 attempts to connect to the service will fail\. Such failures are logged\.
    1276 .sp
    1277 Default:
    1278 \fI\fIavailable\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1684attempts to connect to the service will fail\&. Such failures are logged\&.
     1685.sp
     1686Default:
     1687\fI\fIavailable\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    12791688.RE
    12801689
    12811690bind interfaces only (G)
    1282 .PP
    1283 .RS 4
    1284 This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\. It affects file service
     1691.\" bind interfaces only
     1692.PP
     1693.RS 4
     1694This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\&. It affects file service
    12851695\fBsmbd\fR(8)
    12861696and name service
    12871697\fBnmbd\fR(8)
    1288 in a slightly different ways\.
     1698in a slightly different ways\&.
    12891699.sp
    12901700For name service it causes
    1291 nmbd
     1701\FCnmbd\F[]
    12921702to bind to ports 137 and 138 on the interfaces listed in the
    1293 \fIinterfaces\fR
    1294 parameter\.
    1295 nmbd
    1296 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
    1297 nmbd
    1298 will service name requests on all of these sockets\. If
    1299 \fIbind interfaces only\fR
     1703\m[blue]\fBinterfaces\fR\m[]
     1704parameter\&.
     1705\FCnmbd\F[]
     1706also 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
     1707\FCnmbd\F[]
     1708will service name requests on all of these sockets\&. If
     1709\m[blue]\fBbind interfaces only\fR\m[]
    13001710is set then
    1301 nmbd
     1711\FCnmbd\F[]
    13021712will 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
    1303 \fIinterfaces\fR
    1304 parameter list\. As unicast packets are received on the other sockets it allows
    1305 nmbd
     1713\m[blue]\fBinterfaces\fR\m[]
     1714parameter list\&. As unicast packets are received on the other sockets it allows
     1715\FCnmbd\F[]
    13061716to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the
    1307 \fIinterfaces\fR
    1308 list\. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
    1309 nmbd\.
     1717\m[blue]\fBinterfaces\fR\m[]
     1718list\&. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
     1719\FCnmbd\F[]\&.
    13101720.sp
    13111721For file service it causes
    13121722\fBsmbd\fR(8)
    13131723to bind only to the interface list given in the
    1314 \fIinterfaces\fR
    1315 parameter\. This restricts the networks that
    1316 smbd
    1317 will serve, to packets coming in on those interfaces\. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non\-broadcast network interfaces as it will not cope with non\-permanent interfaces\.
     1724\m[blue]\fBinterfaces\fR\m[]
     1725parameter\&. This restricts the networks that
     1726\FCsmbd\F[]
     1727will serve, to packets coming in on those interfaces\&. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non\-broadcast network interfaces as it will not cope with non\-permanent interfaces\&.
    13181728.sp
    13191729If
    1320 \fIbind interfaces only\fR
     1730\m[blue]\fBbind interfaces only\fR\m[]
    13211731is set and the network address
    1322 \fI127\.0\.0\.1\fR
     1732\fI127\&.0\&.0\&.1\fR
    13231733is not added to the
    1324 \fIinterfaces\fR
     1734\m[blue]\fBinterfaces\fR\m[]
    13251735parameter list
    13261736\fBsmbpasswd\fR(8)
    13271737and
    13281738\fBswat\fR(8)
    1329 may not work as expected due to the reasons covered below\.
     1739may not work as expected due to the reasons covered below\&.
    13301740.sp
    13311741To change a users SMB password, the
    1332 smbpasswd
     1742\FCsmbpasswd\F[]
    13331743by default connects to the
    1334 \fIlocalhost \- 127\.0\.0\.1\fR
    1335 address as an SMB client to issue the password change request\. If
    1336 \fIbind interfaces only\fR
     1744\fIlocalhost \- 127\&.0\&.0\&.1\fR
     1745address as an SMB client to issue the password change request\&. If
     1746\m[blue]\fBbind interfaces only\fR\m[]
    13371747is set then unless the network address
    1338 \fI127\.0\.0\.1\fR
     1748\fI127\&.0\&.0\&.1\fR
    13391749is added to the
    1340 \fIinterfaces\fR
     1750\m[blue]\fBinterfaces\fR\m[]
    13411751parameter list then
    1342 smbpasswd
    1343 will fail to connect in it\'s default mode\.
    1344 smbpasswd
     1752\FC smbpasswd\F[]
     1753will fail to connect in it\'s default mode\&.
     1754\FCsmbpasswd\F[]
    13451755can be forced to use the primary IP interface of the local host by using its
    13461756\fBsmbpasswd\fR(8)
     
    13481758parameter, with
    13491759\fIremote machine\fR
    1350 set to the IP name of the primary interface of the local host\.
     1760set to the IP name of the primary interface of the local host\&.
    13511761.sp
    13521762The
    1353 swat
     1763\FCswat\F[]
    13541764status page tries to connect with
    1355 smbd
     1765\FCsmbd\F[]
    13561766and
    1357 nmbd
     1767\FCnmbd\F[]
    13581768at the address
    1359 \fI127\.0\.0\.1\fR
    1360 to determine if they are running\. Not adding
    1361 \fI127\.0\.0\.1\fR
     1769\fI127\&.0\&.0\&.1\fR
     1770to determine if they are running\&. Not adding
     1771\fI127\&.0\&.0\&.1\fR
    13621772will cause
    1363 smbd
     1773\FC smbd\F[]
    13641774and
    1365 nmbd
    1366 to always show "not running" even if they really are\. This can prevent
    1367 swat
     1775\FCnmbd\F[]
     1776to always show "not running" even if they really are\&. This can prevent
     1777\FC swat\F[]
    13681778from starting/stopping/restarting
    1369 smbd
     1779\FCsmbd\F[]
    13701780and
    1371 nmbd\.
    1372 .sp
    1373 Default:
    1374 \fI\fIbind interfaces only\fR\fR\fI = \fR\fIno\fR\fI \fR
     1781\FCnmbd\F[]\&.
     1782.sp
     1783Default:
     1784\fI\fIbind interfaces only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    13751785.RE
    13761786
    13771787blocking locks (S)
     1788.\" blocking locks
    13781789.PP
    13791790.RS 4
    13801791This parameter controls the behavior of
    13811792\fBsmbd\fR(8)
    1382 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\.
    1383 .sp
    1384 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\.
     1793when 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\&.
     1794.sp
     1795If 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\&.
    13851796.sp
    13861797If this parameter is set to
    1387 \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\.
    1388 .sp
    1389 Default:
    1390 \fI\fIblocking locks\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1798\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\&.
     1799.sp
     1800Default:
     1801\fI\fIblocking locks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    13911802.RE
    13921803
    13931804block size (S)
     1805.\" block size
    13941806.PP
    13951807.RS 4
    13961808This parameter controls the behavior of
    13971809\fBsmbd\fR(8)
    1398 when reporting disk free sizes\. By default, this reports a disk block size of 1024 bytes\.
    1399 .sp
    1400 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\.
    1401 .sp
    1402 Changing this option does not change the disk free reporting size, just the block size unit reported to the client\.
    1403 .sp
    1404 Default:
    1405 \fI\fIblock size\fR\fR\fI = \fR\fI1024\fR\fI \fR
    1406 .sp
    1407 Example:
    1408 \fI\fIblock size\fR\fR\fI = \fR\fI4096\fR\fI \fR
     1810when reporting disk free sizes\&. By default, this reports a disk block size of 1024 bytes\&.
     1811.sp
     1812Changing 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\&.
     1813.sp
     1814Changing this option does not change the disk free reporting size, just the block size unit reported to the client\&.
     1815.sp
     1816Default:
     1817\fI\fIblock size\fR\fR\fI = \fR\fI\FC1024\F[]\fR\fI \fR
     1818.sp
     1819Example:
     1820\fI\fIblock size\fR\fR\fI = \fR\fI\FC4096\F[]\fR\fI \fR
    14091821.RE
    14101822
    14111823browsable
     1824.\" browsable
    14121825.PP
    14131826.RS 4
    14141827This parameter is a synonym for
    1415 browseable\.
     1828browseable\&.
    14161829.RE
    14171830
    14181831browseable (S)
    1419 .PP
    1420 .RS 4
    1421 This controls whether this share is seen in the list of available shares in a net view and in the browse list\.
    1422 .sp
    1423 Default:
    1424 \fI\fIbrowseable\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1832.\" browseable
     1833.PP
     1834.RS 4
     1835This controls whether this share is seen in the list of available shares in a net view and in the browse list\&.
     1836.sp
     1837Default:
     1838\fI\fIbrowseable\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    14251839.RE
    14261840
    14271841browse list (G)
     1842.\" browse list
    14281843.PP
    14291844.RS 4
     
    14311846\fBsmbd\fR(8)
    14321847will serve a browse list to a client doing a
    1433 NetServerEnum
    1434 call\. Normally set to
    1435 \fByes\fR\. You should never need to change this\.
    1436 .sp
    1437 Default:
    1438 \fI\fIbrowse list\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1848\FCNetServerEnum\F[]
     1849call\&. Normally set to
     1850\fByes\fR\&. You should never need to change this\&.
     1851.sp
     1852Default:
     1853\fI\fIbrowse list\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    14391854.RE
    14401855
    14411856casesignames
     1857.\" casesignames
    14421858.PP
    14431859.RS 4
    14441860This parameter is a synonym for
    1445 case sensitive\.
     1861case sensitive\&.
    14461862.RE
    14471863
    14481864case sensitive (S)
     1865.\" case sensitive
    14491866.PP
    14501867.RS 4
    14511868See the discussion in the section
    1452 \fIname mangling\fR\.
    1453 .sp
    1454 Default:
    1455 \fI\fIcase sensitive\fR\fR\fI = \fR\fIno\fR\fI \fR
     1869\m[blue]\fBname mangling\fR\m[]\&.
     1870.sp
     1871Default:
     1872\fI\fIcase sensitive\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    14561873.RE
    14571874
    14581875change notify (S)
    1459 .PP
    1460 .RS 4
    1461 This parameter specifies whether Samba should reply to a client\'s file change notify requests\.
     1876.\" change notify
     1877.PP
     1878.RS 4
     1879This parameter specifies whether Samba should reply to a client\'s file change notify requests\&.
    14621880.sp
    14631881You should never need to change this parameter
    14641882.sp
    14651883Default:
    1466 \fI\fIchange notify\fR\fR\fI = \fR\fIyes\fR\fI \fR
     1884\fI\fIchange notify\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    14671885.RE
    14681886
    14691887change share command (G)
    1470 .PP
    1471 .RS 4
    1472 Samba 2\.2\.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\.0 Server Manager\. The
     1888.\" change share command
     1889.PP
     1890.RS 4
     1891Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
    14731892\fIchange share command\fR
    14741893is used to define an external program or script which will modify an existing service definition in
    1475 \fIsmb\.conf\fR\. In order to successfully execute the
     1894\FCsmb\&.conf\F[]\&.
     1895.sp
     1896In order to successfully execute the
    14761897\fIchange share command\fR,
    1477 smbd
    1478 requires that the administrator be connected using a root account (i\.e\. uid == 0)\.
    1479 .sp
    1480 If the connected account has
    1481 SeDiskOperatorPrivilege, scripts defined in
    1482 \fIchange share\fR
    1483 parameter are executed as root\.
     1898\FCsmbd\F[]
     1899requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
     1900\FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
     1901\fIchange share command\fR
     1902parameter are executed as root\&.
    14841903.sp
    14851904When executed,
    1486 smbd
     1905\FCsmbd\F[]
    14871906will automatically invoke the
    14881907\fIchange share command\fR
    1489 with five parameters\.
     1908with five parameters\&.
    14901909.sp
    14911910.RS 4
     
    14991918\fIconfigFile\fR
    15001919\- the location of the global
    1501 \fIsmb\.conf\fR
    1502 file\.
     1920\FCsmb\&.conf\F[]
     1921file\&.
    15031922.RE
    15041923.sp
     
    15121931.\}
    15131932\fIshareName\fR
    1514 \- the name of the new share\.
     1933\- the name of the new share\&.
    15151934.RE
    15161935.sp
     
    15241943.\}
    15251944\fIpathName\fR
    1526 \- path to an **existing** directory on disk\.
     1945\- path to an **existing** directory on disk\&.
    15271946.RE
    15281947.sp
     
    15361955.\}
    15371956\fIcomment\fR
    1538 \- comment string to associate with the new share\.
     1957\- comment string to associate with the new share\&.
    15391958.RE
    15401959.sp
     
    15481967.\}
    15491968\fImax connections\fR
    1550 Number of maximum simultaneous connections to this share\.
    1551 .sp
    1552 .RE
    1553 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\.
    1554 .sp
    1555 Default:
    1556 \fI\fIchange share command\fR\fR\fI = \fR\fI\fR\fI \fR
    1557 .sp
    1558 Example:
    1559 \fI\fIchange share command\fR\fR\fI = \fR\fI/usr/local/bin/addshare\fR\fI \fR
     1969Number of maximum simultaneous connections to this share\&.
     1970.sp
     1971.RE
     1972This 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\&.
     1973.sp
     1974Default:
     1975\fI\fIchange share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     1976.sp
     1977Example:
     1978\fI\fIchange share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/changeshare\F[]\fR\fI \fR
    15601979.RE
    15611980
    15621981check password script (G)
    1563 .PP
    1564 .RS 4
    1565 The name of a program that can be used to check password complexity\. The password is sent to the program\'s standard input\.
    1566 .sp
    1567 The program must return 0 on a good password, or any other value if the password is bad\. In case the password is considered weak (the program does not return 0) the user will be notified and the password change will fail\.
     1982.\" check password script
     1983.PP
     1984.RS 4
     1985The name of a program that can be used to check password complexity\&. The password is sent to the program\'s standard input\&.
     1986.sp
     1987The program must return 0 on a good password, or any other value if the password is bad\&. In case the password is considered weak (the program does not return 0) the user will be notified and the password change will fail\&.
    15681988.sp
    15691989Note: In the example directory is a sample program called
    1570 crackcheck
    1571 that uses cracklib to check the password quality\.
    1572 .sp
    1573 Default:
    1574 \fI\fIcheck password script\fR\fR\fI = \fR\fIDisabled\fR\fI \fR
    1575 .sp
    1576 Example:
    1577 \fI\fIcheck password script\fR\fR\fI = \fR\fIcheck password script = /usr/local/sbin/crackcheck\fR\fI \fR
     1990\FCcrackcheck\F[]
     1991that uses cracklib to check the password quality\&.
     1992.sp
     1993Default:
     1994\fI\fIcheck password script\fR\fR\fI = \fR\fI\FCDisabled\F[]\fR\fI \fR
     1995.sp
     1996Example:
     1997\fI\fIcheck password script\fR\fR\fI = \fR\fI\FCcheck password script = /usr/local/sbin/crackcheck\F[]\fR\fI \fR
    15781998.RE
    15791999
    15802000client lanman auth (G)
     2001.\" client lanman auth
    15812002.PP
    15822003.RS 4
    15832004This parameter determines whether or not
    15842005\fBsmbclient\fR(8)
    1585 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\.
    1586 .sp
    1587 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\.
     2006and 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\&.
     2007.sp
     2008The 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\&.
    15882009.sp
    15892010Disabling this option will also disable the
    1590 client plaintext auth
     2011\FCclient plaintext auth\F[]
    15912012option
    15922013.sp
    15932014Likewise, if the
    1594 client ntlmv2 auth
    1595 parameter is enabled, then only NTLMv2 logins will be attempted\.
    1596 .sp
    1597 Default:
    1598 \fI\fIclient lanman auth\fR\fR\fI = \fR\fIno\fR\fI \fR
     2015\FCclient ntlmv2 auth\F[]
     2016parameter is enabled, then only NTLMv2 logins will be attempted\&.
     2017.sp
     2018Default:
     2019\fI\fIclient lanman auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    15992020.RE
    16002021
    16012022client ldap sasl wrapping (G)
     2023.\" client ldap sasl wrapping
    16022024.PP
    16032025.RS 4
    16042026The
    1605 \fIclient ldap sasl wrapping\fR
    1606 defines whether ldap traffic will be signed or signed and encrypted (sealed)\. Possible values are
     2027\m[blue]\fBclient ldap sasl wrapping\fR\m[]
     2028defines whether ldap traffic will be signed or signed and encrypted (sealed)\&. Possible values are
    16072029\fIplain\fR,
    16082030\fIsign\fR
    16092031and
    1610 \fIseal\fR\.
     2032\fIseal\fR\&.
    16112033.sp
    16122034The values
     
    16142036and
    16152037\fIseal\fR
    1616 are only available if Samba has been compiled against a modern OpenLDAP version (2\.3\.x or higher)\.
    1617 .sp
    1618 This option is needed in the case of Domain Controllers enforcing the usage of signed LDAP connections (e\.g\. Windows 2000 SP3 or higher)\. LDAP sign and seal can be controlled with the registry key "HKLM\eSystem\eCurrentControlSet\eServices\e
    1619 NTDS\eParameters\eLDAPServerIntegrity" on the Windows server side\.
    1620 .sp
    1621 Depending on the used KRB5 library (MIT and older Heimdal versions) it is possible that the message "integrity only" is not supported\. In this case,
     2038are only available if Samba has been compiled against a modern OpenLDAP version (2\&.3\&.x or higher)\&.
     2039.sp
     2040This option is needed in the case of Domain Controllers enforcing the usage of signed LDAP connections (e\&.g\&. Windows 2000 SP3 or higher)\&. LDAP sign and seal can be controlled with the registry key "\FCHKLM\eSystem\eCurrentControlSet\eServices\e\F[]
     2041\FCNTDS\eParameters\eLDAPServerIntegrity\F[]" on the Windows server side\&.
     2042.sp
     2043Depending on the used KRB5 library (MIT and older Heimdal versions) it is possible that the message "integrity only" is not supported\&. In this case,
    16222044\fIsign\fR
    16232045is just an alias for
    1624 \fIseal\fR\.
     2046\fIseal\fR\&.
    16252047.sp
    16262048The default value is
    16272049\fIplain\fR
    1628 which is not irritable to KRB5 clock skew errors\. That implies synchronizing the time with the KDC in the case of using
     2050which is not irritable to KRB5 clock skew errors\&. That implies synchronizing the time with the KDC in the case of using
    16292051\fIsign\fR
    16302052or
    1631 \fIseal\fR\.
    1632 .sp
    1633 Default:
    1634 \fI\fIclient ldap sasl wrapping\fR\fR\fI = \fR\fIplain\fR\fI \fR
     2053\fIseal\fR\&.
     2054.sp
     2055Default:
     2056\fI\fIclient ldap sasl wrapping\fR\fR\fI = \fR\fI\FCplain\F[]\fR\fI \fR
    16352057.RE
    16362058
    16372059client ntlmv2 auth (G)
     2060.\" client ntlmv2 auth
    16382061.PP
    16392062.RS 4
    16402063This parameter determines whether or not
    16412064\fBsmbclient\fR(8)
    1642 will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\.
    1643 .sp
    1644 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\.
     2065will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\&.
     2066.sp
     2067If 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\&.
    16452068.sp
    16462069Similarly, if enabled, NTLMv1,
    1647 client lanman auth
     2070\FCclient lanman auth\F[]
    16482071and
    1649 client plaintext auth
    1650 authentication will be disabled\. This also disables share\-level authentication\.
     2072\FCclient plaintext auth\F[]
     2073authentication will be disabled\&. This also disables share\-level authentication\&.
    16512074.sp
    16522075If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of
    1653 client lanman auth\.
    1654 .sp
    1655 Note that some sites (particularly those following \'best practice\' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM\.
    1656 .sp
    1657 Default:
    1658 \fI\fIclient ntlmv2 auth\fR\fR\fI = \fR\fIno\fR\fI \fR
     2076\FCclient lanman auth\F[]\&.
     2077.sp
     2078Note that some sites (particularly those following \'best practice\' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM\&.
     2079.sp
     2080Default:
     2081\fI\fIclient ntlmv2 auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    16592082.RE
    16602083
    16612084client plaintext auth (G)
    1662 .PP
    1663 .RS 4
    1664 Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\.
    1665 .sp
    1666 Default:
    1667 \fI\fIclient plaintext auth\fR\fR\fI = \fR\fIno\fR\fI \fR
     2085.\" client plaintext auth
     2086.PP
     2087.RS 4
     2088Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\&.
     2089.sp
     2090Default:
     2091\fI\fIclient plaintext auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    16682092.RE
    16692093
    16702094client schannel (G)
    1671 .PP
    1672 .RS 4
    1673 This controls whether the client offers or even demands the use of the netlogon schannel\.
    1674 \fIclient schannel = no\fR
     2095.\" client schannel
     2096.PP
     2097.RS 4
     2098This controls whether the client offers or even demands the use of the netlogon schannel\&.
     2099\m[blue]\fBclient schannel = no\fR\m[]
    16752100does not offer the schannel,
    1676 \fIclient schannel = auto\fR
     2101\m[blue]\fBclient schannel = auto\fR\m[]
    16772102offers the schannel but does not enforce it, and
    1678 \fIclient schannel = yes\fR
    1679 denies access if the server is not able to speak netlogon schannel\.
    1680 .sp
    1681 Default:
    1682 \fI\fIclient schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR
    1683 .sp
    1684 Example:
    1685 \fI\fIclient schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2103\m[blue]\fBclient schannel = yes\fR\m[]
     2104denies access if the server is not able to speak netlogon schannel\&.
     2105.sp
     2106Default:
     2107\fI\fIclient schannel\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
     2108.sp
     2109Example:
     2110\fI\fIclient schannel\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    16862111.RE
    16872112
    16882113client signing (G)
    1689 .PP
    1690 .RS 4
    1691 This controls whether the client offers or requires the server it talks to to use SMB signing\. Possible values are
     2114.\" client signing
     2115.PP
     2116.RS 4
     2117This controls whether the client offers or requires the server it talks to to use SMB signing\&. Possible values are
    16922118\fIauto\fR,
    16932119\fImandatory\fR
    16942120and
    1695 \fIdisabled\fR\.
    1696 .sp
    1697 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\.
    1698 .sp
    1699 Default:
    1700 \fI\fIclient signing\fR\fR\fI = \fR\fIauto\fR\fI \fR
     2121\fIdisabled\fR\&.
     2122.sp
     2123When 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\&.
     2124.sp
     2125Default:
     2126\fI\fIclient signing\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
    17012127.RE
    17022128
    17032129client use spnego (G)
    1704 .PP
    1705 .RS 4
    1706 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\.
    1707 .sp
    1708 Default:
    1709 \fI\fIclient use spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2130.\" client use spnego
     2131.PP
     2132.RS 4
     2133This 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\&.
     2134.sp
     2135Default:
     2136\fI\fIclient use spnego\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    17102137.RE
    17112138
    17122139cluster addresses (G)
    1713 .PP
    1714 .RS 4
    1715 With this parameter you can add additional addresses nmbd will register with a WINS server\. These addresses are not necessarily present on all nodes simultaneously, but they will be registered with the WINS server so that clients can contact any of the nodes\.
    1716 .sp
    1717 Default:
    1718 \fI\fIcluster addresses\fR\fR\fI = \fR\fI\fR\fI \fR
    1719 .sp
    1720 Example:
    1721 \fI\fIcluster addresses\fR\fR\fI = \fR\fI10\.0\.0\.1 10\.0\.0\.2 10\.0\.0\.3\fR\fI \fR
     2140.\" cluster addresses
     2141.PP
     2142.RS 4
     2143With this parameter you can add additional addresses nmbd will register with a WINS server\&. These addresses are not necessarily present on all nodes simultaneously, but they will be registered with the WINS server so that clients can contact any of the nodes\&.
     2144.sp
     2145Default:
     2146\fI\fIcluster addresses\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2147.sp
     2148Example:
     2149\fI\fIcluster addresses\fR\fR\fI = \fR\fI\FC10\&.0\&.0\&.1 10\&.0\&.0\&.2 10\&.0\&.0\&.3\F[]\fR\fI \fR
    17222150.RE
    17232151
    17242152clustering (G)
    1725 .PP
    1726 .RS 4
    1727 This parameter specifies whether Samba should contact ctdb for accessing its tdb files and use ctdb as a backend for its messaging backend\.
     2153.\" clustering
     2154.PP
     2155.RS 4
     2156This parameter specifies whether Samba should contact ctdb for accessing its tdb files and use ctdb as a backend for its messaging backend\&.
    17282157.sp
    17292158Set this parameter to
    1730 yes
    1731 only if you have a cluster setup with ctdb running\.
    1732 .sp
    1733 Default:
    1734 \fI\fIclustering\fR\fR\fI = \fR\fIno\fR\fI \fR
     2159\FCyes\F[]
     2160only if you have a cluster setup with ctdb running\&.
     2161.sp
     2162Default:
     2163\fI\fIclustering\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    17352164.RE
    17362165
    17372166comment (S)
     2167.\" comment
    17382168.PP
    17392169.RS 4
    17402170This 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
    1741 net view
    1742 to list what shares are available\.
     2171\FCnet view\F[]
     2172to list what shares are available\&.
    17432173.sp
    17442174If you want to set the string that is displayed next to the machine name then see the
    1745 \fIserver string\fR
    1746 parameter\.
    1747 .sp
    1748 Default:
    1749 \fI\fIcomment\fR\fR\fI = \fR\fI # No comment\fR\fI \fR
    1750 .sp
    1751 Example:
    1752 \fI\fIcomment\fR\fR\fI = \fR\fIFred\'s Files\fR\fI \fR
     2175\m[blue]\fBserver string\fR\m[]
     2176parameter\&.
     2177.sp
     2178Default:
     2179\fI\fIcomment\fR\fR\fI = \fR\fI\FC # No comment\F[]\fR\fI \fR
     2180.sp
     2181Example:
     2182\fI\fIcomment\fR\fR\fI = \fR\fI\FCFred\'s Files\F[]\fR\fI \fR
    17532183.RE
    17542184
    17552185config backend (G)
    1756 .PP
    1757 .RS 4
    1758 This controls the backend for storing the configuration\. Possible values are
     2186.\" config backend
     2187.PP
     2188.RS 4
     2189This controls the backend for storing the configuration\&. Possible values are
    17592190\fIfile\fR
    17602191(the default) and
    1761 \fIregistry\fR\. When
    1762 \fIconfig backend = registry\fR
     2192\fIregistry\fR\&. When
     2193\m[blue]\fBconfig backend = registry\fR\m[]
    17632194is encountered while loading
    1764 \fIsmb\.conf\fR, the configuration read so far is dropped and the global options are read from registry instead\. So this triggers a registry only configuration\. Share definitions are not read immediately but instead
     2195\fIsmb\&.conf\fR, the configuration read so far is dropped and the global options are read from registry instead\&. So this triggers a registry only configuration\&. Share definitions are not read immediately but instead
    17652196\fIregistry shares\fR
    17662197is set to
    1767 \fIyes\fR\.
    1768 .sp
    1769 Note: This option can not be set inside the registry configuration itself\.
    1770 .sp
    1771 Default:
    1772 \fI\fIconfig backend\fR\fR\fI = \fR\fIfile\fR\fI \fR
    1773 .sp
    1774 Example:
    1775 \fI\fIconfig backend\fR\fR\fI = \fR\fIregistry\fR\fI \fR
     2198\fIyes\fR\&.
     2199.sp
     2200Note: This option can not be set inside the registry configuration itself\&.
     2201.sp
     2202Default:
     2203\fI\fIconfig backend\fR\fR\fI = \fR\fI\FCfile\F[]\fR\fI \fR
     2204.sp
     2205Example:
     2206\fI\fIconfig backend\fR\fR\fI = \fR\fI\FCregistry\F[]\fR\fI \fR
    17762207.RE
    17772208
    17782209config file (G)
     2210.\" config file
    17792211.PP
    17802212.RS 4
    17812213This allows you to override the config file to use, instead of the default (usually
    1782 \fIsmb\.conf\fR)\. There is a chicken and egg problem here as this option is set in the config file!
    1783 .sp
    1784 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\.
    1785 .sp
    1786 This option takes the usual substitutions, which can be very useful\.
    1787 .sp
    1788 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)\.
     2214\FCsmb\&.conf\F[])\&. There is a chicken and egg problem here as this option is set in the config file!
     2215.sp
     2216For 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\&.
     2217.sp
     2218This option takes the usual substitutions, which can be very useful\&.
     2219.sp
     2220If 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)\&.
    17892221.sp
    17902222\fINo default\fR
    17912223.sp
    17922224Example:
    1793 \fI\fIconfig file\fR\fR\fI = \fR\fI/usr/local/samba/lib/smb\.conf\.%m\fR\fI \fR
     2225\fI\fIconfig file\fR\fR\fI = \fR\fI\FC/usr/local/samba/lib/smb\&.conf\&.%m\F[]\fR\fI \fR
    17942226.RE
    17952227
    17962228copy (S)
    1797 .PP
    1798 .RS 4
    1799 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\.
    1800 .sp
    1801 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\.
    1802 .sp
    1803 Default:
    1804 \fI\fIcopy\fR\fR\fI = \fR\fI\fR\fI \fR
    1805 .sp
    1806 Example:
    1807 \fI\fIcopy\fR\fR\fI = \fR\fIotherservice\fR\fI \fR
     2229.\" copy
     2230.PP
     2231.RS 4
     2232This 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\&.
     2233.sp
     2234This 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\&.
     2235.sp
     2236Default:
     2237\fI\fIcopy\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2238.sp
     2239Example:
     2240\fI\fIcopy\fR\fR\fI = \fR\fI\FCotherservice\F[]\fR\fI \fR
    18082241.RE
    18092242
    18102243create mode
     2244.\" create mode
    18112245.PP
    18122246.RS 4
    18132247This parameter is a synonym for
    1814 create mask\.
     2248create mask\&.
    18152249.RE
    18162250
    18172251create mask (S)
    1818 .PP
    1819 .RS 4
    1820 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
     2252.\" create mask
     2253.PP
     2254.RS 4
     2255When 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
    18212256\fInot\fR
    1822 set here will be removed from the modes set on a file when it is created\.
     2257set here will be removed from the modes set on a file when it is created\&.
    18232258.sp
    18242259The default value of this parameter removes the
    1825 group
     2260\FCgroup\F[]
    18262261and
    1827 other
    1828 write and execute bits from the UNIX modes\.
     2262\FCother\F[]
     2263write and execute bits from the UNIX modes\&.
    18292264.sp
    18302265Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the
    1831 \fIforce create mode\fR
    1832 parameter which is set to 000 by default\.
    1833 .sp
    1834 This parameter does not affect directory masks\. See the parameter
    1835 \fIdirectory mask\fR
    1836 for details\.
    1837 .sp
    1838 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
    1839 \fIsecurity mask\fR\.
    1840 .sp
    1841 Default:
    1842 \fI\fIcreate mask\fR\fR\fI = \fR\fI0744\fR\fI \fR
    1843 .sp
    1844 Example:
    1845 \fI\fIcreate mask\fR\fR\fI = \fR\fI0775\fR\fI \fR
     2266\m[blue]\fBforce create mode\fR\m[]
     2267parameter which is set to 000 by default\&.
     2268.sp
     2269This parameter does not affect directory masks\&. See the parameter
     2270\m[blue]\fBdirectory mask\fR\m[]
     2271for details\&.
     2272.sp
     2273Note 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
     2274\m[blue]\fBsecurity mask\fR\m[]\&.
     2275.sp
     2276Default:
     2277\fI\fIcreate mask\fR\fR\fI = \fR\fI\FC0744\F[]\fR\fI \fR
     2278.sp
     2279Example:
     2280\fI\fIcreate mask\fR\fR\fI = \fR\fI\FC0775\F[]\fR\fI \fR
    18462281.RE
    18472282
    18482283csc policy (S)
     2284.\" csc policy
    18492285.PP
    18502286.RS 4
    18512287This stands for
    1852 \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\.
    1853 .sp
    1854 These values correspond to those used on Windows servers\.
     2288\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\&.
     2289.sp
     2290These values correspond to those used on Windows servers\&.
    18552291.sp
    18562292For example, shares containing roaming profiles can have offline caching disabled using
    1857 \fIcsc policy = disable\fR\.
    1858 .sp
    1859 Default:
    1860 \fI\fIcsc policy\fR\fR\fI = \fR\fImanual\fR\fI \fR
    1861 .sp
    1862 Example:
    1863 \fI\fIcsc policy\fR\fR\fI = \fR\fIprograms\fR\fI \fR
     2293\m[blue]\fBcsc policy = disable\fR\m[]\&.
     2294.sp
     2295Default:
     2296\fI\fIcsc policy\fR\fR\fI = \fR\fI\FCmanual\F[]\fR\fI \fR
     2297.sp
     2298Example:
     2299\fI\fIcsc policy\fR\fR\fI = \fR\fI\FCprograms\F[]\fR\fI \fR
    18642300.RE
    18652301
    18662302ctdbd socket (G)
     2303.\" ctdbd socket
    18672304.PP
    18682305.RS 4
    18692306If you set
    1870 clustering=yes, you need to tell Samba where ctdbd listens on its unix domain socket\. The default path as of ctdb 1\.0 is /tmp/ctdb\.socket which you have to explicitly set for Samba in smb\.conf\.
    1871 .sp
    1872 Default:
    1873 \fI\fIctdbd socket\fR\fR\fI = \fR\fI\fR\fI \fR
    1874 .sp
    1875 Example:
    1876 \fI\fIctdbd socket\fR\fR\fI = \fR\fI/tmp/ctdb\.socket\fR\fI \fR
     2307\FCclustering=yes\F[], you need to tell Samba where ctdbd listens on its unix domain socket\&. The default path as of ctdb 1\&.0 is /tmp/ctdb\&.socket which you have to explicitly set for Samba in smb\&.conf\&.
     2308.sp
     2309Default:
     2310\fI\fIctdbd socket\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2311.sp
     2312Example:
     2313\fI\fIctdbd socket\fR\fR\fI = \fR\fI\FC/tmp/ctdb\&.socket\F[]\fR\fI \fR
    18772314.RE
    18782315
    18792316cups options (S)
     2317.\" cups options
    18802318.PP
    18812319.RS 4
    18822320This parameter is only applicable if
    1883 \fIprinting\fR
     2321\m[blue]\fBprinting\fR\m[]
    18842322is set to
    1885 \fBcups\fR\. Its value is a free form string of options passed directly to the cups library\.
    1886 .sp
    1887 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\.
     2323\fBcups\fR\&. Its value is a free form string of options passed directly to the cups library\&.
     2324.sp
     2325You 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\&.
    18882326.sp
    18892327You should set this parameter to
    18902328\fBraw\fR
    18912329if your CUPS server
    1892 \fIerror_log\fR
    1893 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
    1894 \fI/etc/cups/mime\.{convs,types}\fR\.
    1895 .sp
    1896 Default:
    1897 \fI\fIcups options\fR\fR\fI = \fR\fI""\fR\fI \fR
    1898 .sp
    1899 Example:
    1900 \fI\fIcups options\fR\fR\fI = \fR\fI"raw media=a4"\fR\fI \fR
     2330\FCerror_log\F[]
     2331file 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
     2332\FC/etc/cups/mime\&.{convs,types}\F[]\&.
     2333.sp
     2334Default:
     2335\fI\fIcups options\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
     2336.sp
     2337Example:
     2338\fI\fIcups options\fR\fR\fI = \fR\fI\FC"raw media=a4"\F[]\fR\fI \fR
    19012339.RE
    19022340
    19032341cups server (G)
     2342.\" cups server
    19042343.PP
    19052344.RS 4
    19062345This parameter is only applicable if
    1907 \fIprinting\fR
     2346\m[blue]\fBprinting\fR\m[]
    19082347is set to
    1909 \fBcups\fR\.
     2348\fBcups\fR\&.
    19102349.sp
    19112350If set, this option overrides the ServerName option in the CUPS
    1912 \fIclient\.conf\fR\. This is necessary if you have virtual samba servers that connect to different CUPS daemons\.
    1913 .sp
    1914 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\.
    1915 .sp
    1916 Default:
    1917 \fI\fIcups server\fR\fR\fI = \fR\fI""\fR\fI \fR
    1918 .sp
    1919 Example:
    1920 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver\fR\fI \fR
    1921 .sp
    1922 Example:
    1923 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver:1631\fR\fI \fR
     2351\FCclient\&.conf\F[]\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
     2352.sp
     2353Optionally, 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\&.
     2354.sp
     2355Default:
     2356\fI\fIcups server\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
     2357.sp
     2358Example:
     2359\fI\fIcups server\fR\fR\fI = \fR\fI\FCmycupsserver\F[]\fR\fI \fR
     2360.sp
     2361Example:
     2362\fI\fIcups server\fR\fR\fI = \fR\fI\FCmycupsserver:1631\F[]\fR\fI \fR
    19242363.RE
    19252364
    19262365deadtime (G)
    1927 .PP
    1928 .RS 4
    1929 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\.
    1930 .sp
    1931 This is useful to stop a server\'s resources being exhausted by a large number of inactive connections\.
    1932 .sp
    1933 Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\.
    1934 .sp
    1935 Using this parameter with a timeout of a few minutes is recommended for most systems\.
    1936 .sp
    1937 A deadtime of zero indicates that no auto\-disconnection should be performed\.
    1938 .sp
    1939 Default:
    1940 \fI\fIdeadtime\fR\fR\fI = \fR\fI0\fR\fI \fR
    1941 .sp
    1942 Example:
    1943 \fI\fIdeadtime\fR\fR\fI = \fR\fI15\fR\fI \fR
     2366.\" deadtime
     2367.PP
     2368.RS 4
     2369The 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\&.
     2370.sp
     2371This is useful to stop a server\'s resources being exhausted by a large number of inactive connections\&.
     2372.sp
     2373Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\&.
     2374.sp
     2375Using this parameter with a timeout of a few minutes is recommended for most systems\&.
     2376.sp
     2377A deadtime of zero indicates that no auto\-disconnection should be performed\&.
     2378.sp
     2379Default:
     2380\fI\fIdeadtime\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     2381.sp
     2382Example:
     2383\fI\fIdeadtime\fR\fR\fI = \fR\fI\FC15\F[]\fR\fI \fR
    19442384.RE
    19452385
    19462386debug class (G)
    1947 .PP
    1948 .RS 4
    1949 With this boolean parameter enabled, the debug class (DBGC_CLASS) will be displayed in the debug header\.
     2387.\" debug class
     2388.PP
     2389.RS 4
     2390With this boolean parameter enabled, the debug class (DBGC_CLASS) will be displayed in the debug header\&.
    19502391.sp
    19512392For more information about currently available debug classes, see section about
    1952 \fIlog level\fR\.
    1953 .sp
    1954 Default:
    1955 \fI\fIdebug class\fR\fR\fI = \fR\fIno\fR\fI \fR
     2393\m[blue]\fBlog level\fR\m[]\&.
     2394.sp
     2395Default:
     2396\fI\fIdebug class\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    19562397.RE
    19572398
    19582399debug hires timestamp (G)
    1959 .PP
    1960 .RS 4
    1961 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\.
     2400.\" debug hires timestamp
     2401.PP
     2402.RS 4
     2403Sometimes 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\&.
    19622404.sp
    19632405Note that the parameter
    1964 \fIdebug timestamp\fR
    1965 must be on for this to have an effect\.
    1966 .sp
    1967 Default:
    1968 \fI\fIdebug hires timestamp\fR\fR\fI = \fR\fIno\fR\fI \fR
     2406\m[blue]\fBdebug timestamp\fR\m[]
     2407must be on for this to have an effect\&.
     2408.sp
     2409Default:
     2410\fI\fIdebug hires timestamp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    19692411.RE
    19702412
    19712413debug pid (G)
     2414.\" debug pid
    19722415.PP
    19732416.RS 4
    19742417When using only one log file for more then one forked
    1975 \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\.
     2418\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\&.
    19762419.sp
    19772420Note that the parameter
    1978 \fIdebug timestamp\fR
    1979 must be on for this to have an effect\.
    1980 .sp
    1981 Default:
    1982 \fI\fIdebug pid\fR\fR\fI = \fR\fIno\fR\fI \fR
     2421\m[blue]\fBdebug timestamp\fR\m[]
     2422must be on for this to have an effect\&.
     2423.sp
     2424Default:
     2425\fI\fIdebug pid\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    19832426.RE
    19842427
    19852428debug prefix timestamp (G)
     2429.\" debug prefix timestamp
    19862430.PP
    19872431.RS 4
    19882432With this option enabled, the timestamp message header is prefixed to the debug message without the filename and function information that is included with the
    1989 \fIdebug timestamp\fR
    1990 parameter\. This gives timestamps to the messages without adding an additional line\.
     2433\m[blue]\fBdebug timestamp\fR\m[]
     2434parameter\&. This gives timestamps to the messages without adding an additional line\&.
    19912435.sp
    19922436Note that this parameter overrides the
    1993 \fIdebug timestamp\fR
    1994 parameter\.
    1995 .sp
    1996 Default:
    1997 \fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fIno\fR\fI \fR
     2437\m[blue]\fBdebug timestamp\fR\m[]
     2438parameter\&.
     2439.sp
     2440Default:
     2441\fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    19982442.RE
    19992443
    20002444timestamp logs
     2445.\" timestamp logs
    20012446.PP
    20022447.RS 4
    20032448This parameter is a synonym for
    2004 debug timestamp\.
     2449debug timestamp\&.
    20052450.RE
    20062451
    20072452debug timestamp (G)
    2008 .PP
    2009 .RS 4
    2010 Samba debug log messages are timestamped by default\. If you are running at a high
    2011 \fIdebug level\fR
    2012 these timestamps can be distracting\. This boolean parameter allows timestamping to be turned off\.
    2013 .sp
    2014 Default:
    2015 \fI\fIdebug timestamp\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2453.\" debug timestamp
     2454.PP
     2455.RS 4
     2456Samba debug log messages are timestamped by default\&. If you are running at a high
     2457\m[blue]\fBdebug level\fR\m[]
     2458these timestamps can be distracting\&. This boolean parameter allows timestamping to be turned off\&.
     2459.sp
     2460Default:
     2461\fI\fIdebug timestamp\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    20162462.RE
    20172463
    20182464debug uid (G)
    2019 .PP
    2020 .RS 4
    2021 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\.
     2465.\" debug uid
     2466.PP
     2467.RS 4
     2468Samba 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\&.
    20222469.sp
    20232470Note that the parameter
    2024 \fIdebug timestamp\fR
    2025 must be on for this to have an effect\.
    2026 .sp
    2027 Default:
    2028 \fI\fIdebug uid\fR\fR\fI = \fR\fIno\fR\fI \fR
     2471\m[blue]\fBdebug timestamp\fR\m[]
     2472must be on for this to have an effect\&.
     2473.sp
     2474Default:
     2475\fI\fIdebug uid\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    20292476.RE
    20302477
    20312478default case (S)
     2479.\" default case
    20322480.PP
    20332481.RS 4
    20342482See the section on
    2035 \fIname mangling\fR\. Also note the
    2036 \fIshort preserve case\fR
    2037 parameter\.
    2038 .sp
    2039 Default:
    2040 \fI\fIdefault case\fR\fR\fI = \fR\fIlower\fR\fI \fR
     2483\m[blue]\fBname mangling\fR\m[]\&. Also note the
     2484\m[blue]\fBshort preserve case\fR\m[]
     2485parameter\&.
     2486.sp
     2487Default:
     2488\fI\fIdefault case\fR\fR\fI = \fR\fI\FClower\F[]\fR\fI \fR
    20412489.RE
    20422490
    20432491default devmode (S)
     2492.\" default devmode
    20442493.PP
    20452494.RS 4
    20462495This parameter is only applicable to
    2047 \fIprintable\fR
    2048 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\.
    2049 .sp
    2050 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)\.
    2051 .sp
    2052 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
    2053 default devmode = yes
    2054 will instruct smbd to generate a default one\.
     2496\m[blue]\fBprintable\fR\m[]
     2497services\&. 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\&.
     2498.sp
     2499Most 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)\&.
     2500.sp
     2501This 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
     2502\FCdefault devmode = yes\F[]
     2503will instruct smbd to generate a default one\&.
    20552504.sp
    20562505For more information on Windows NT/2k printing and Device Modes, see the
    2057 MSDN documentation\.
    2058 .sp
    2059 Default:
    2060 \fI\fIdefault devmode\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2506MSDN documentation\&.
     2507.sp
     2508Default:
     2509\fI\fIdefault devmode\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    20612510.RE
    20622511
    20632512default
     2513.\" default
    20642514.PP
    20652515.RS 4
    20662516This parameter is a synonym for
    2067 default service\.
     2517default service\&.
    20682518.RE
    20692519
    20702520default service (G)
    2071 .PP
    2072 .RS 4
    2073 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
     2521.\" default service
     2522.PP
     2523.RS 4
     2524This 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
    20742525\fINOT\fR
    2075 given in the parameter value (see example below)\.
    2076 .sp
    2077 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\.
     2526given in the parameter value (see example below)\&.
     2527.sp
     2528There is no default value for this parameter\&. If this parameter is not given, attempting to connect to a nonexistent service results in an error\&.
    20782529.sp
    20792530Typically the default service would be a
    2080 \fIguest ok\fR,
    2081 \fIread\-only\fR
    2082 service\.
     2531\m[blue]\fBguest ok\fR\m[],
     2532\m[blue]\fBread\-only\fR\m[]
     2533service\&.
    20832534.sp
    20842535Also 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
    20852536\fI%S\fR
    2086 to make a wildcard service\.
    2087 .sp
    2088 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\.
    2089 .sp
    2090 Default:
    2091 \fI\fIdefault service\fR\fR\fI = \fR\fI\fR\fI \fR
    2092 .sp
    2093 Example:
    2094 \fI\fIdefault service\fR\fR\fI = \fR\fIpub\fR\fI \fR
     2537to make a wildcard service\&.
     2538.sp
     2539Note 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\&.
     2540.sp
     2541Default:
     2542\fI\fIdefault service\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2543.sp
     2544Example:
     2545\fI\fIdefault service\fR\fR\fI = \fR\fI\FCpub\F[]\fR\fI \fR
    20952546.RE
    20962547
    20972548defer sharing violations (G)
    2098 .PP
    2099 .RS 4
    2100 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\.
    2101 .sp
    2102 UNIX by default does not have this behaviour\.
    2103 .sp
    2104 There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\.
    2105 .sp
    2106 Default:
    2107 \fI\fIdefer sharing violations\fR\fR\fI = \fR\fITrue\fR\fI \fR
     2549.\" defer sharing violations
     2550.PP
     2551.RS 4
     2552Windows 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\&.
     2553.sp
     2554UNIX by default does not have this behaviour\&.
     2555.sp
     2556There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\&.
     2557.sp
     2558Default:
     2559\fI\fIdefer sharing violations\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
    21082560.RE
    21092561
    21102562delete group script (G)
     2563.\" delete group script
    21112564.PP
    21122565.RS 4
     
    21142567\fIAS ROOT\fR
    21152568\fBsmbd\fR(8)
    2116 when a group is requested to be deleted\. It will expand any
     2569when a group is requested to be deleted\&. It will expand any
    21172570\fI%g\fR
    2118 to the group name passed\. This script is only useful for installations using the Windows NT domain administration tools\.
    2119 .sp
    2120 Default:
    2121 \fI\fIdelete group script\fR\fR\fI = \fR\fI\fR\fI \fR
     2571to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&.
     2572.sp
     2573Default:
     2574\fI\fIdelete group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    21222575.RE
    21232576
    21242577deleteprinter command (G)
    2125 .PP
    2126 .RS 4
    2127 With the introduction of MS\-RPC based printer support for Windows NT/2000 clients in Samba 2\.2, it is now possible to delete a printer at run time by issuing the DeletePrinter() RPC call\.
    2128 .sp
    2129 For a Samba host this means that the printer must be physically deleted from the underlying printing system\. The
    2130 \fIdeleteprinter command\fR
     2578.\" deleteprinter command
     2579.PP
     2580.RS 4
     2581With the introduction of MS\-RPC based printer support for Windows NT/2000 clients in Samba 2\&.2, it is now possible to delete a printer at run time by issuing the DeletePrinter() RPC call\&.
     2582.sp
     2583For a Samba host this means that the printer must be physically deleted from the underlying printing system\&. The
     2584\m[blue]\fBdeleteprinter command\fR\m[]
    21312585defines a script to be run which will perform the necessary operations for removing the printer from the print system and from
    2132 \fIsmb\.conf\fR\.
     2586\FCsmb\&.conf\F[]\&.
    21332587.sp
    21342588The
    2135 \fIdeleteprinter command\fR
     2589\m[blue]\fBdeleteprinter command\fR\m[]
    21362590is automatically called with only one parameter:
    2137 \fIprinter name\fR\.
     2591\m[blue]\fBprinter name\fR\m[]\&.
    21382592.sp
    21392593Once the
    2140 \fIdeleteprinter command\fR
     2594\m[blue]\fBdeleteprinter command\fR\m[]
    21412595has been executed,
    2142 smbd
     2596\FCsmbd\F[]
    21432597will reparse the
    2144 \fI smb\.conf\fR
    2145 to check that the associated printer no longer exists\. If the sharename is still valid, then
    2146 smbd
    2147 will return an ACCESS_DENIED error to the client\.
    2148 .sp
    2149 Default:
    2150 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\fR\fI \fR
    2151 .sp
    2152 Example:
    2153 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI/usr/bin/removeprinter\fR\fI \fR
     2598\FC smb\&.conf\F[]
     2599to check that the associated printer no longer exists\&. If the sharename is still valid, then
     2600\FCsmbd \F[]
     2601will return an ACCESS_DENIED error to the client\&.
     2602.sp
     2603Default:
     2604\fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2605.sp
     2606Example:
     2607\fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\FC/usr/bin/removeprinter\F[]\fR\fI \fR
    21542608.RE
    21552609
    21562610delete readonly (S)
    2157 .PP
    2158 .RS 4
    2159 This parameter allows readonly files to be deleted\. This is not normal DOS semantics, but is allowed by UNIX\.
    2160 .sp
    2161 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\.
    2162 .sp
    2163 Default:
    2164 \fI\fIdelete readonly\fR\fR\fI = \fR\fIno\fR\fI \fR
     2611.\" delete readonly
     2612.PP
     2613.RS 4
     2614This parameter allows readonly files to be deleted\&. This is not normal DOS semantics, but is allowed by UNIX\&.
     2615.sp
     2616This 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\&.
     2617.sp
     2618Default:
     2619\fI\fIdelete readonly\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    21652620.RE
    21662621
    21672622delete share command (G)
    2168 .PP
    2169 .RS 4
    2170 Samba 2\.2\.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\.0 Server Manager\. The
     2623.\" delete share command
     2624.PP
     2625.RS 4
     2626Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
    21712627\fIdelete share command\fR
    21722628is used to define an external program or script which will remove an existing service definition from
    2173 \fIsmb\.conf\fR\. In order to successfully execute the
     2629\FCsmb\&.conf\F[]\&.
     2630.sp
     2631In order to successfully execute the
    21742632\fIdelete share command\fR,
    2175 smbd
    2176 requires that the administrator be connected using a root account (i\.e\. uid == 0)\.
    2177 .sp
    2178 If the connected account has
    2179 SeDiskOperatorPrivilege, scripts defined in
    2180 \fIchange share\fR
    2181 parameter are executed as root\.
     2633\FCsmbd\F[]
     2634requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
     2635\FCSeDiskOperatorPrivilege\F[]\&. Scripts defined in the
     2636\fIdelete share command\fR
     2637parameter are executed as root\&.
    21822638.sp
    21832639When executed,
    2184 smbd
     2640\FCsmbd\F[]
    21852641will automatically invoke the
    21862642\fIdelete share command\fR
    2187 with two parameters\.
     2643with two parameters\&.
    21882644.sp
    21892645.RS 4
     
    21972653\fIconfigFile\fR
    21982654\- the location of the global
    2199 \fIsmb\.conf\fR
    2200 file\.
     2655\FCsmb\&.conf\F[]
     2656file\&.
    22012657.RE
    22022658.sp
     
    22102666.\}
    22112667\fIshareName\fR
    2212 \- the name of the existing service\.
    2213 .sp
    2214 .RE
    2215 This parameter is only used to remove file shares\. To delete printer shares, see the
    2216 \fIdeleteprinter command\fR\.
    2217 .sp
    2218 Default:
    2219 \fI\fIdelete share command\fR\fR\fI = \fR\fI\fR\fI \fR
    2220 .sp
    2221 Example:
    2222 \fI\fIdelete share command\fR\fR\fI = \fR\fI/usr/local/bin/delshare\fR\fI \fR
     2668\- the name of the existing service\&.
     2669.sp
     2670.RE
     2671This parameter is only used to remove file shares\&. To delete printer shares, see the
     2672\m[blue]\fBdeleteprinter command\fR\m[]\&.
     2673.sp
     2674Default:
     2675\fI\fIdelete share command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2676.sp
     2677Example:
     2678\fI\fIdelete share command\fR\fR\fI = \fR\fI\FC/usr/local/bin/delshare\F[]\fR\fI \fR
    22232679.RE
    22242680
    22252681delete user from group script (G)
    2226 .PP
    2227 .RS 4
    2228 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
     2682.\" delete user from group script
     2683.PP
     2684.RS 4
     2685Full 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
    22292686\fBsmbd\fR(8)
    2230 \fIAS ROOT\fR\. Any
     2687\fIAS ROOT\fR\&. Any
    22312688\fI%g\fR
    22322689will be replaced with the group name and any
    22332690\fI%u\fR
    2234 will be replaced with the user name\.
    2235 .sp
    2236 Default:
    2237 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI\fR\fI \fR
    2238 .sp
    2239 Example:
    2240 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI/usr/sbin/deluser %u %g\fR\fI \fR
     2691will be replaced with the user name\&.
     2692.sp
     2693Default:
     2694\fI\fIdelete user from group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2695.sp
     2696Example:
     2697\fI\fIdelete user from group script\fR\fR\fI = \fR\fI\FC/usr/sbin/deluser %u %g\F[]\fR\fI \fR
    22412698.RE
    22422699
    22432700delete user script (G)
     2701.\" delete user script
    22442702.PP
    22452703.RS 4
    22462704This is the full pathname to a script that will be run by
    22472705\fBsmbd\fR(8)
    2248 when managing users with remote RPC (NT) tools\.
     2706when managing users with remote RPC (NT) tools\&.
    22492707.sp
    22502708This script is called when a remote client removes a user from the server, normally using \'User Manager for Domains\' or
    2251 rpcclient\.
    2252 .sp
    2253 This script should delete the given UNIX username\.
    2254 .sp
    2255 Default:
    2256 \fI\fIdelete user script\fR\fR\fI = \fR\fI\fR\fI \fR
    2257 .sp
    2258 Example:
    2259 \fI\fIdelete user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/del_user %u\fR\fI \fR
     2709\FCrpcclient\F[]\&.
     2710.sp
     2711This script should delete the given UNIX username\&.
     2712.sp
     2713Default:
     2714\fI\fIdelete user script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     2715.sp
     2716Example:
     2717\fI\fIdelete user script\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/del_user %u\F[]\fR\fI \fR
    22602718.RE
    22612719
    22622720delete veto files (S)
     2721.\" delete veto files
    22632722.PP
    22642723.RS 4
    22652724This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories (see the
    2266 \fIveto files\fR
    2267 option)\. If this option is set to
     2725\m[blue]\fBveto files\fR\m[]
     2726option)\&. If this option is set to
    22682727\fBno\fR
    2269 (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\.
     2728(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\&.
    22702729.sp
    22712730If this option is set to
    2272 \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\.
    2273 \fI\.AppleDouble\fR)
     2731\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\&.
     2732\FC\&.AppleDouble\F[])
    22742733.sp
    22752734Setting
    2276 \fIdelete veto files = yes\fR
    2277 allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\.
    2278 .sp
    2279 Default:
    2280 \fI\fIdelete veto files\fR\fR\fI = \fR\fIno\fR\fI \fR
     2735\m[blue]\fBdelete veto files = yes\fR\m[]
     2736allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\&.
     2737.sp
     2738Default:
     2739\fI\fIdelete veto files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    22812740.RE
    22822741
    22832742dfree cache time (S)
     2743.\" dfree cache time
    22842744.PP
    22852745.RS 4
    22862746The
    22872747\fIdfree cache time\fR
    2288 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\.
    2289 .sp
    2290 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
    2291 \fIdfree command\fR
    2292 scripts increasing the load\.
    2293 .sp
    2294 By default this parameter is zero, meaning no caching will be done\.
     2748should 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\&.
     2749.sp
     2750This 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
     2751\m[blue]\fBdfree command\fR\m[]
     2752scripts increasing the load\&.
     2753.sp
     2754By default this parameter is zero, meaning no caching will be done\&.
    22952755.sp
    22962756\fINo default\fR
    22972757.sp
    22982758Example:
    2299 \fI\fIdfree cache time\fR\fR\fI = \fR\fIdfree cache time = 60\fR\fI \fR
     2759\fI\fIdfree cache time\fR\fR\fI = \fR\fI\FCdfree cache time = 60\F[]\fR\fI \fR
    23002760.RE
    23012761
    23022762dfree command (S)
     2763.\" dfree command
    23032764.PP
    23042765.RS 4
    23052766The
    23062767\fIdfree command\fR
    2307 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\.
    2308 .sp
    2309 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\.
    2310 .sp
    2311 In Samba version 3\.0\.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter
    2312 \fIdfree cache time\fR
    2313 was added to allow the output of this script to be cached for systems under heavy load\.
    2314 .sp
    2315 The external program will be passed a single parameter indicating a directory in the filesystem being queried\. This will typically consist of the string
    2316 \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\.
     2768setting 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\&.
     2769.sp
     2770This 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\&.
     2771.sp
     2772In Samba version 3\&.0\&.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter
     2773\m[blue]\fBdfree cache time\fR\m[]
     2774was added to allow the output of this script to be cached for systems under heavy load\&.
     2775.sp
     2776The external program will be passed a single parameter indicating a directory in the filesystem being queried\&. This will typically consist of the string
     2777\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\&.
    23172778.sp
    23182779Note: Your script should
     
    23222783Where the script dfree (which must be made executable) could be:
    23232784.sp
    2324 .RS 4
     2785.if n \{\
     2786.RS 4
     2787.\}
     2788.fam C
     2789.ps -1
    23252790.nf
     2791.BB lightgray
    23262792 
    23272793#!/bin/sh
    23282794df $1 | tail \-1 | awk \'{print $(NF\-4),$(NF\-2)}\'
     2795.EB lightgray
    23292796.fi
    2330 .RE
     2797.fam
     2798.ps +1
     2799.if n \{\
     2800.RE
     2801.\}
    23312802.sp
    23322803or perhaps (on Sys V based systems):
    23332804.sp
    2334 .RS 4
     2805.if n \{\
     2806.RS 4
     2807.\}
     2808.fam C
     2809.ps -1
    23352810.nf
     2811.BB lightgray
    23362812 
    23372813#!/bin/sh
    23382814/usr/bin/df \-k $1 | tail \-1 | awk \'{print $3" "$5}\'
     2815.EB lightgray
    23392816.fi
    2340 .RE
    2341 .sp
    2342 Note that you may have to replace the command names with full path names on some systems\.
    2343 .sp
    2344 By default internal routines for determining the disk capacity and remaining space will be used\.
     2817.fam
     2818.ps +1
     2819.if n \{\
     2820.RE
     2821.\}
     2822.sp
     2823Note that you may have to replace the command names with full path names on some systems\&.
     2824.sp
     2825By default internal routines for determining the disk capacity and remaining space will be used\&.
    23452826.sp
    23462827\fINo default\fR
    23472828.sp
    23482829Example:
    2349 \fI\fIdfree command\fR\fR\fI = \fR\fI/usr/local/samba/bin/dfree\fR\fI \fR
     2830\fI\fIdfree command\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/dfree\F[]\fR\fI \fR
    23502831.RE
    23512832
    23522833directory mode
     2834.\" directory mode
    23532835.PP
    23542836.RS 4
    23552837This parameter is a synonym for
    2356 directory mask\.
     2838directory mask\&.
    23572839.RE
    23582840
    23592841directory mask (S)
    2360 .PP
    2361 .RS 4
    2362 This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\.
    2363 .sp
    2364 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
     2842.\" directory mask
     2843.PP
     2844.RS 4
     2845This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\&.
     2846.sp
     2847When 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
    23652848\fInot\fR
    2366 set here will be removed from the modes set on a directory when it is created\.
    2367 .sp
    2368 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\.
     2849set here will be removed from the modes set on a directory when it is created\&.
     2850.sp
     2851The 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\&.
    23692852.sp
    23702853Following this Samba will bit\-wise \'OR\' the UNIX mode created from this parameter with the value of the
    2371 \fIforce directory mode\fR
    2372 parameter\. This parameter is set to 000 by default (i\.e\. no extra mode bits are added)\.
    2373 .sp
    2374 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
    2375 \fIdirectory security mask\fR\.
    2376 .sp
    2377 Default:
    2378 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0755\fR\fI \fR
    2379 .sp
    2380 Example:
    2381 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0775\fR\fI \fR
     2854\m[blue]\fBforce directory mode\fR\m[]
     2855parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode bits are added)\&.
     2856.sp
     2857Note 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
     2858\m[blue]\fBdirectory security mask\fR\m[]\&.
     2859.sp
     2860Default:
     2861\fI\fIdirectory mask\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
     2862.sp
     2863Example:
     2864\fI\fIdirectory mask\fR\fR\fI = \fR\fI\FC0775\F[]\fR\fI \fR
    23822865.RE
    23832866
    23842867directory security mask (S)
    2385 .PP
    2386 .RS 4
    2387 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\.
    2388 .sp
    2389 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
    2390 \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\.
    2391 .sp
    2392 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\.
    2393 .sp
    2394 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\.
     2868.\" directory security mask
     2869.PP
     2870.RS 4
     2871This 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\&.
     2872.sp
     2873This 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
     2874\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\&.
     2875.sp
     2876Essentially, 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\&.
     2877.sp
     2878If 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\&.
    23952879.sp
    23962880\fINote\fR
    2397 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
    2398 \fB0777\fR\.
    2399 .sp
    2400 Default:
    2401 \fI\fIdirectory security mask\fR\fR\fI = \fR\fI0777\fR\fI \fR
    2402 .sp
    2403 Example:
    2404 \fI\fIdirectory security mask\fR\fR\fI = \fR\fI0700\fR\fI \fR
     2881that 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
     2882\fB0777\fR\&.
     2883.sp
     2884Default:
     2885\fI\fIdirectory security mask\fR\fR\fI = \fR\fI\FC0777\F[]\fR\fI \fR
     2886.sp
     2887Example:
     2888\fI\fIdirectory security mask\fR\fR\fI = \fR\fI\FC0700\F[]\fR\fI \fR
    24052889.RE
    24062890
    24072891disable netbios (G)
    2408 .PP
    2409 .RS 4
    2410 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\.
    2411 .sp
     2892.\" disable netbios
     2893.PP
     2894.RS 4
     2895Enabling 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\&.
     2896.if n \{\
     2897.sp
     2898.\}
     2899.RS 4
     2900.BM yellow
    24122901.it 1 an-trap
    24132902.nr an-no-space-flag 1
    24142903.nr an-break-flag 1
    24152904.br
    2416 Note
    2417 Clients that only support netbios won\'t be able to see your samba server when netbios support is disabled\.
    2418 
    2419 Default:
    2420 \fI\fIdisable netbios\fR\fR\fI = \fR\fIno\fR\fI \fR
     2905.ps +1
     2906\fBNote\fR
     2907.ps -1
     2908.br
     2909Clients that only support netbios won\'t be able to see your samba server when netbios support is disabled\&.
     2910.sp .5v
     2911.EM yellow
     2912.RE
     2913Default:
     2914\fI\fIdisable netbios\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    24212915.RE
    24222916
    24232917disable spoolss (G)
    2424 .PP
    2425 .RS 4
    2426 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\.
    2427 \fIBe very careful about enabling this parameter\.\fR
    2428 .sp
    2429 Default:
    2430 \fI\fIdisable spoolss\fR\fR\fI = \fR\fIno\fR\fI \fR
     2918.\" disable spoolss
     2919.PP
     2920.RS 4
     2921Enabling 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\&.
     2922\fIBe very careful about enabling this parameter\&.\fR
     2923.sp
     2924Default:
     2925\fI\fIdisable spoolss\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    24312926.RE
    24322927
    24332928display charset (G)
    2434 .PP
    2435 .RS 4
    2436 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
    2437 \fIunix charset\fR\.
    2438 .sp
    2439 Default:
    2440 \fI\fIdisplay charset\fR\fR\fI = \fR\fI"LOCALE" or "ASCII" (depending on the system)\fR\fI \fR
    2441 .sp
    2442 Example:
    2443 \fI\fIdisplay charset\fR\fR\fI = \fR\fIUTF8\fR\fI \fR
     2929.\" display charset
     2930.PP
     2931.RS 4
     2932Specifies 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
     2933\m[blue]\fBunix charset\fR\m[]\&.
     2934.sp
     2935Default:
     2936\fI\fIdisplay charset\fR\fR\fI = \fR\fI\FC"LOCALE" or "ASCII" (depending on the system)\F[]\fR\fI \fR
     2937.sp
     2938Example:
     2939\fI\fIdisplay charset\fR\fR\fI = \fR\fI\FCUTF8\F[]\fR\fI \fR
    24442940.RE
    24452941
    24462942dmapi support (S)
    2447 .PP
    2448 .RS 4
    2449 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\.
    2450 .sp
    2451 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\.
    2452 .sp
    2453 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\.
    2454 .sp
    2455 .sp
    2456 Default:
    2457 \fI\fIdmapi support\fR\fR\fI = \fR\fIno\fR\fI \fR
     2943.\" dmapi support
     2944.PP
     2945.RS 4
     2946This 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\&.
     2947.sp
     2948Note 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\&.
     2949.sp
     2950This 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\&.
     2951.sp
     2952Default:
     2953\fI\fIdmapi support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    24582954.RE
    24592955
    24602956dns proxy (G)
     2957.\" dns proxy
    24612958.PP
    24622959.RS 4
    24632960Specifies that
    24642961\fBnmbd\fR(8)
    2465 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\.
    2466 .sp
    2467 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\.
    2468 .sp
    2469 nmbd
    2470 spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\.
    2471 .sp
    2472 Default:
    2473 \fI\fIdns proxy\fR\fR\fI = \fR\fIyes\fR\fI \fR
     2962when 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\&.
     2963.sp
     2964Note 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\&.
     2965.sp
     2966\FCnmbd\F[]
     2967spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\&.
     2968.sp
     2969Default:
     2970\fI\fIdns proxy\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    24742971.RE
    24752972
    24762973domain logons (G)
     2974.\" domain logons
    24772975.PP
    24782976.RS 4
    24792977If set to
    24802978\fByes\fR, the Samba server will provide the netlogon service for Windows 9X network logons for the
    2481 \fIworkgroup\fR
    2482 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\.
    2483 .sp
    2484 Default:
    2485 \fI\fIdomain logons\fR\fR\fI = \fR\fIno\fR\fI \fR
     2979\m[blue]\fBworkgroup\fR\m[]
     2980it 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\&.
     2981.sp
     2982Default:
     2983\fI\fIdomain logons\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    24862984.RE
    24872985
    24882986domain master (G)
     2987.\" domain master
    24892988.PP
    24902989.RS 4
    24912990Tell
    24922991\fBsmbd\fR(8)
    2493 to enable WAN\-wide browse list collation\. Setting this option causes
    2494 nmbd
     2992to enable WAN\-wide browse list collation\&. Setting this option causes
     2993\FCnmbd\F[]
    24952994to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given
    2496 \fIworkgroup\fR\. Local master browsers in the same
    2497 \fIworkgroup\fR
     2995\m[blue]\fBworkgroup\fR\m[]\&. Local master browsers in the same
     2996\m[blue]\fBworkgroup\fR\m[]
    24982997on broadcast\-isolated subnets will give this
    2499 nmbd
     2998\FCnmbd\F[]
    25002999their local browse lists, and then ask
    25013000\fBsmbd\fR(8)
    2502 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\.
     3001for 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\&.
    25033002.sp
    25043003Note that Windows NT Primary Domain Controllers expect to be able to claim this
    2505 \fIworkgroup\fR
     3004\m[blue]\fBworkgroup\fR\m[]
    25063005specific special NetBIOS name that identifies them as domain master browsers for that
    2507 \fIworkgroup\fR
    2508 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
    2509 nmbd
     3006\m[blue]\fBworkgroup\fR\m[]
     3007by 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
     3008\FCnmbd\F[]
    25103009claims the special name for a
    2511 \fIworkgroup\fR
    2512 before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\.
     3010\m[blue]\fBworkgroup\fR\m[]
     3011before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\&.
    25133012.sp
    25143013If
    2515 \fIdomain logons = yes\fR, then the default behavior is to enable the
    2516 \fIdomain master\fR
    2517 parameter\. If
    2518 \fIdomain logons\fR
     3014\m[blue]\fBdomain logons = yes\fR\m[], then the default behavior is to enable the
     3015\m[blue]\fBdomain master\fR\m[]
     3016parameter\&. If
     3017\m[blue]\fBdomain logons\fR\m[]
    25193018is not enabled (the default setting), then neither will
    2520 \fIdomain master\fR
    2521 be enabled by default\.
     3019\m[blue]\fBdomain master\fR\m[]
     3020be enabled by default\&.
    25223021.sp
    25233022When
    2524 \fIdomain logons = Yes\fR
    2525 the default setting for this parameter is Yes, with the result that Samba will be a PDC\. If
    2526 \fIdomain master = No\fR, Samba will function as a BDC\. In general, this parameter should be set to \'No\' only on a BDC\.
    2527 .sp
    2528 Default:
    2529 \fI\fIdomain master\fR\fR\fI = \fR\fIauto\fR\fI \fR
     3023\m[blue]\fBdomain logons = Yes\fR\m[]
     3024the default setting for this parameter is Yes, with the result that Samba will be a PDC\&. If
     3025\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\&.
     3026.sp
     3027Default:
     3028\fI\fIdomain master\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
    25303029.RE
    25313030
    25323031dont descend (S)
    2533 .PP
    2534 .RS 4
    2535 There are certain directories on some systems (e\.g\., the
    2536 \fI/proc\fR
    2537 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\.
    2538 .sp
    2539 Note that Samba can be very fussy about the exact format of the "dont descend" entries\. For example you may need
    2540 \fI \./proc\fR
     3032.\" dont descend
     3033.PP
     3034.RS 4
     3035There are certain directories on some systems (e\&.g\&., the
     3036\FC/proc\F[]
     3037tree 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\&.
     3038.sp
     3039Note that Samba can be very fussy about the exact format of the "dont descend" entries\&. For example you may need
     3040\FC \&./proc\F[]
    25413041instead of just
    2542 \fI/proc\fR\. Experimentation is the best policy :\-)
    2543 .sp
    2544 Default:
    2545 \fI\fIdont descend\fR\fR\fI = \fR\fI\fR\fI \fR
    2546 .sp
    2547 Example:
    2548 \fI\fIdont descend\fR\fR\fI = \fR\fI/proc,/dev\fR\fI \fR
     3042\FC/proc\F[]\&. Experimentation is the best policy :\-)
     3043.sp
     3044Default:
     3045\fI\fIdont descend\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3046.sp
     3047Example:
     3048\fI\fIdont descend\fR\fR\fI = \fR\fI\FC/proc,/dev\F[]\fR\fI \fR
    25493049.RE
    25503050
    25513051dos charset (G)
    2552 .PP
    2553 .RS 4
    2554 DOS SMB clients assume the server has the same charset as they do\. This option specifies which charset Samba should talk to DOS clients\.
    2555 .sp
    2556 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
     3052.\" dos charset
     3053.PP
     3054.RS 4
     3055DOS SMB clients assume the server has the same charset as they do\&. This option specifies which charset Samba should talk to DOS clients\&.
     3056.sp
     3057The 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
    25573058\fBtestparm\fR(1)
    2558 to check the default on your system\.
     3059to check the default on your system\&.
    25593060.sp
    25603061\fINo default\fR
     
    25623063
    25633064dos filemode (S)
    2564 .PP
    2565 .RS 4
    2566 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\.
    2567 .sp
    2568 Default:
    2569 \fI\fIdos filemode\fR\fR\fI = \fR\fIno\fR\fI \fR
     3065.\" dos filemode
     3066.PP
     3067.RS 4
     3068The 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\&.
     3069.sp
     3070Default:
     3071\fI\fIdos filemode\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    25703072.RE
    25713073
    25723074dos filetime resolution (S)
    2573 .PP
    2574 .RS 4
    2575 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
    2576 \fBsmbd\fR(8)\.
    2577 .sp
    2578 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\.
    2579 .sp
    2580 Default:
    2581 \fI\fIdos filetime resolution\fR\fR\fI = \fR\fIno\fR\fI \fR
     3075.\" dos filetime resolution
     3076.PP
     3077.RS 4
     3078Under 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
     3079\fBsmbd\fR(8)\&.
     3080.sp
     3081This 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\&.
     3082.sp
     3083Default:
     3084\fI\fIdos filetime resolution\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    25823085.RE
    25833086
    25843087dos filetimes (S)
    2585 .PP
    2586 .RS 4
    2587 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
    2588 smbd
    2589 is acting on behalf of is not the file owner\. Setting this option to
     3088.\" dos filetimes
     3089.PP
     3090.RS 4
     3091Under 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
     3092\FCsmbd\F[]
     3093is acting on behalf of is not the file owner\&. Setting this option to
    25903094\fB yes\fR
    25913095allows DOS semantics and
    25923096\fBsmbd\fR(8)
    2593 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\.
    2594 .sp
    2595 Default:
    2596 \fI\fIdos filetimes\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3097will 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\&.
     3098.sp
     3099Default:
     3100\fI\fIdos filetimes\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    25973101.RE
    25983102
    25993103ea support (S)
     3104.\" ea support
    26003105.PP
    26013106.RS 4
    26023107This boolean parameter controls whether
    26033108\fBsmbd\fR(8)
    2604 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\.
    2605 .sp
    2606 Default:
    2607 \fI\fIea support\fR\fR\fI = \fR\fIno\fR\fI \fR
     3109will 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\&.
     3110.sp
     3111Default:
     3112\fI\fIea support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    26083113.RE
    26093114
    26103115enable asu support (G)
    2611 .PP
    2612 .RS 4
    2613 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\.
    2614 .sp
    2615 Default:
    2616 \fI\fIenable asu support\fR\fR\fI = \fR\fIno\fR\fI \fR
     3116.\" enable asu support
     3117.PP
     3118.RS 4
     3119Hosts 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\&.
     3120.sp
     3121Default:
     3122\fI\fIenable asu support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    26173123.RE
    26183124
    26193125enable privileges (G)
     3126.\" enable privileges
    26203127.PP
    26213128.RS 4
    26223129This parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either
    2623 net rpc rights
    2624 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\.
    2625 .sp
    2626 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\.
    2627 .sp
    2628 Please read the extended description provided in the Samba HOWTO documentation\.
    2629 .sp
    2630 Default:
    2631 \fI\fIenable privileges\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3130\FCnet rpc rights\F[]
     3131or 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\&.
     3132.sp
     3133An 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\&.
     3134.sp
     3135Please read the extended description provided in the Samba HOWTO documentation\&.
     3136.sp
     3137Default:
     3138\fI\fIenable privileges\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    26323139.RE
    26333140
    26343141encrypt passwords (G)
    2635 .PP
    2636 .RS 4
    2637 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\.
    2638 .sp
    2639 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\.
    2640 .sp
    2641 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\.
     3142.\" encrypt passwords
     3143.PP
     3144.RS 4
     3145This 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\&.
     3146.sp
     3147MS 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\&.
     3148.sp
     3149The 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\&.
    26423150.sp
    26433151In order for encrypted passwords to work correctly
     
    26483156\fBsmbpasswd\fR(8)
    26493157program for information on how to set up and maintain this file), or set the
    2650 \fIsecurity = [server|domain|ads]\fR
     3158\m[blue]\fBsecurity = [server|domain|ads]\fR\m[]
    26513159parameter which causes
    2652 smbd
    2653 to authenticate against another server\.
    2654 .sp
    2655 Default:
    2656 \fI\fIencrypt passwords\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3160\FCsmbd\F[]
     3161to authenticate against another server\&.
     3162.sp
     3163Default:
     3164\fI\fIencrypt passwords\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    26573165.RE
    26583166
    26593167enhanced browsing (G)
    2660 .PP
    2661 .RS 4
    2662 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\.
    2663 .sp
    2664 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\.
    2665 .sp
    2666 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\.
    2667 .sp
    2668 In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\.
    2669 .sp
    2670 Default:
    2671 \fI\fIenhanced browsing\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3168.\" enhanced browsing
     3169.PP
     3170.RS 4
     3171This 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\&.
     3172.sp
     3173The 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\&.
     3174.sp
     3175You 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\&.
     3176.sp
     3177In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\&.
     3178.sp
     3179Default:
     3180\fI\fIenhanced browsing\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    26723181.RE
    26733182
    26743183enumports command (G)
    2675 .PP
    2676 .RS 4
    2677 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
     3184.\" enumports command
     3185.PP
     3186.RS 4
     3187The 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[]
    26783188does not use a port name for anything) other than the default
    26793189\fB"Samba Printer Port"\fR, you can define
    26803190\fIenumports command\fR
    2681 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\.
    2682 .sp
    2683 Default:
    2684 \fI\fIenumports command\fR\fR\fI = \fR\fI\fR\fI \fR
    2685 .sp
    2686 Example:
    2687 \fI\fIenumports command\fR\fR\fI = \fR\fI/usr/bin/listports\fR\fI \fR
     3191to 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\&.
     3192.sp
     3193Default:
     3194\fI\fIenumports command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3195.sp
     3196Example:
     3197\fI\fIenumports command\fR\fR\fI = \fR\fI\FC/usr/bin/listports\F[]\fR\fI \fR
    26883198.RE
    26893199
    26903200eventlog list (G)
    2691 .PP
    2692 .RS 4
    2693 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
    2694 \fI$(lockdir)/eventlog\fR\.
     3201.\" eventlog list
     3202.PP
     3203.RS 4
     3204This 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
     3205\FC$(lockdir)/eventlog\F[]\&.
    26953206.sp
    26963207The administrator must use an external process to parse the normal Unix logs such as
    2697 \fI/var/log/messages\fR
    2698 and write then entries to the eventlog tdb files\. Refer to the eventlogadm(8) utility for how to write eventlog entries\.
    2699 .sp
    2700 Default:
    2701 \fI\fIeventlog list\fR\fR\fI = \fR\fI\fR\fI \fR
    2702 .sp
    2703 Example:
    2704 \fI\fIeventlog list\fR\fR\fI = \fR\fISecurity Application Syslog Apache\fR\fI \fR
     3208\FC/var/log/messages\F[]
     3209and write then entries to the eventlog tdb files\&. Refer to the eventlogadm(8) utility for how to write eventlog entries\&.
     3210.sp
     3211Default:
     3212\fI\fIeventlog list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3213.sp
     3214Example:
     3215\fI\fIeventlog list\fR\fR\fI = \fR\fI\FCSecurity Application Syslog Apache\F[]\fR\fI \fR
    27053216.RE
    27063217
    27073218fake directory create times (S)
    2708 .PP
    2709 .RS 4
    2710 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\.
    2711 .sp
    2712 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\.
    2713 .sp
    2714 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\.
    2715 .sp
    2716 Default:
    2717 \fI\fIfake directory create times\fR\fR\fI = \fR\fIno\fR\fI \fR
     3219.\" fake directory create times
     3220.PP
     3221.RS 4
     3222NTFS 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\&.
     3223.sp
     3224This 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\&.
     3225.sp
     3226However, 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\&.
     3227.sp
     3228Default:
     3229\fI\fIfake directory create times\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    27183230.RE
    27193231
    27203232fake oplocks (S)
    2721 .PP
    2722 .RS 4
    2723 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\.
     3233.\" fake oplocks
     3234.PP
     3235.RS 4
     3236Oplocks 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\&.
    27243237.sp
    27253238When you set
    2726 fake oplocks = yes,
     3239\FCfake oplocks = yes\F[],
    27273240\fBsmbd\fR(8)
    2728 will always grant oplock requests no matter how many clients are using the file\.
     3241will always grant oplock requests no matter how many clients are using the file\&.
    27293242.sp
    27303243It is generally much better to use the real
    2731 \fIoplocks\fR
    2732 support rather than this parameter\.
    2733 .sp
    2734 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!
    2735 .sp
    2736 Default:
    2737 \fI\fIfake oplocks\fR\fR\fI = \fR\fIno\fR\fI \fR
     3244\m[blue]\fBoplocks\fR\m[]
     3245support rather than this parameter\&.
     3246.sp
     3247If 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!
     3248.sp
     3249Default:
     3250\fI\fIfake oplocks\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    27383251.RE
    27393252
    27403253follow symlinks (S)
     3254.\" follow symlinks
    27413255.PP
    27423256.RS 4
    27433257This parameter allows the Samba administrator to stop
    27443258\fBsmbd\fR(8)
    2745 from following symbolic links in a particular share\. Setting this parameter to
     3259from following symbolic links in a particular share\&. Setting this parameter to
    27463260\fBno\fR
    2747 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
    2748 \fI/etc/passwd\fR
    2749 in their home directory for instance\. However it will slow filename lookups down slightly\.
    2750 .sp
    2751 This option is enabled (i\.e\.
    2752 smbd
    2753 will follow symbolic links) by default\.
    2754 .sp
    2755 Default:
    2756 \fI\fIfollow symlinks\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3261prevents 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
     3262\FC/etc/passwd\F[]
     3263in their home directory for instance\&. However it will slow filename lookups down slightly\&.
     3264.sp
     3265This option is enabled (i\&.e\&.
     3266\FCsmbd\F[]
     3267will follow symbolic links) by default\&.
     3268.sp
     3269Default:
     3270\fI\fIfollow symlinks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    27573271.RE
    27583272
    27593273force create mode (S)
     3274.\" force create mode
    27603275.PP
    27613276.RS 4
    27623277This parameter specifies a set of UNIX mode bit permissions that will
    27633278\fIalways\fR
    2764 be set on a file created by Samba\. This is done by bitwise \'OR\'ing these bits onto the mode bits of a file that is being created\. The default for this parameter is (in octal) 000\. The modes in this parameter are bitwise \'OR\'ed onto the file mode after the mask set in the
     3279be set on a file created by Samba\&. This is done by bitwise \'OR\'ing these bits onto the mode bits of a file that is being created\&. The default for this parameter is (in octal) 000\&. The modes in this parameter are bitwise \'OR\'ed onto the file mode after the mask set in the
    27653280\fIcreate mask\fR
    2766 parameter is applied\.
    2767 .sp
    2768 The example below would force all newly created files to have read and execute permissions set for \'group\' and \'other\' as well as the read/write/execute bits set for the \'user\'\.
    2769 .sp
    2770 Default:
    2771 \fI\fIforce create mode\fR\fR\fI = \fR\fI000\fR\fI \fR
    2772 .sp
    2773 Example:
    2774 \fI\fIforce create mode\fR\fR\fI = \fR\fI0755\fR\fI \fR
     3281parameter is applied\&.
     3282.sp
     3283The example below would force all newly created files to have read and execute permissions set for \'group\' and \'other\' as well as the read/write/execute bits set for the \'user\'\&.
     3284.sp
     3285Default:
     3286\fI\fIforce create mode\fR\fR\fI = \fR\fI\FC000\F[]\fR\fI \fR
     3287.sp
     3288Example:
     3289\fI\fIforce create mode\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
    27753290.RE
    27763291
    27773292force directory mode (S)
     3293.\" force directory mode
    27783294.PP
    27793295.RS 4
    27803296This parameter specifies a set of UNIX mode bit permissions that will
    27813297\fIalways\fR
    2782 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
     3298be 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
    27833299\fIdirectory mask\fR
    2784 is applied\.
    2785 .sp
    2786 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\'\.
    2787 .sp
    2788 Default:
    2789 \fI\fIforce directory mode\fR\fR\fI = \fR\fI000\fR\fI \fR
    2790 .sp
    2791 Example:
    2792 \fI\fIforce directory mode\fR\fR\fI = \fR\fI0755\fR\fI \fR
     3300is applied\&.
     3301.sp
     3302The 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\'\&.
     3303.sp
     3304Default:
     3305\fI\fIforce directory mode\fR\fR\fI = \fR\fI\FC000\F[]\fR\fI \fR
     3306.sp
     3307Example:
     3308\fI\fIforce directory mode\fR\fR\fI = \fR\fI\FC0755\F[]\fR\fI \fR
    27933309.RE
    27943310
    27953311force directory security mode (S)
    2796 .PP
    2797 .RS 4
    2798 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\.
    2799 .sp
    2800 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
    2801 \fIdirectory security mask\fR, which works in a similar manner to this one, but uses a logical AND instead of an OR\.
    2802 .sp
    2803 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)\.
    2804 .sp
    2805 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\.
    2806 .sp
     3312.\" force directory security mode
     3313.PP
     3314.RS 4
     3315This 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\&.
     3316.sp
     3317This 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
     3318\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\&.
     3319.sp
     3320Essentially, 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)\&.
     3321.sp
     3322If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world permissions on a directory without restrictions\&.
     3323.if n \{\
     3324.sp
     3325.\}
     3326.RS 4
     3327.BM yellow
    28073328.it 1 an-trap
    28083329.nr an-no-space-flag 1
    28093330.nr an-break-flag 1
    28103331.br
    2811 Note
    2812 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\.
    2813 
    2814 Default:
    2815 \fI\fIforce directory security mode\fR\fR\fI = \fR\fI0\fR\fI \fR
    2816 .sp
    2817 Example:
    2818 \fI\fIforce directory security mode\fR\fR\fI = \fR\fI700\fR\fI \fR
     3332.ps +1
     3333\fBNote\fR
     3334.ps -1
     3335.br
     3336Users 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\&.
     3337.sp .5v
     3338.EM yellow
     3339.RE
     3340Default:
     3341\fI\fIforce directory security mode\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     3342.sp
     3343Example:
     3344\fI\fIforce directory security mode\fR\fR\fI = \fR\fI\FC700\F[]\fR\fI \fR
    28193345.RE
    28203346
    28213347group
     3348.\" group
    28223349.PP
    28233350.RS 4
    28243351This parameter is a synonym for
    2825 force group\.
     3352force group\&.
    28263353.RE
    28273354
    28283355force group (S)
    2829 .PP
    2830 .RS 4
    2831 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\.
    2832 .sp
    2833 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
    2834 \fIforce group = +sys\fR
    2835 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\.
     3356.\" force group
     3357.PP
     3358.RS 4
     3359This 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\&.
     3360.sp
     3361In 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
     3362\FCforce group = +sys\F[]
     3363means 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\&.
    28363364.sp
    28373365If the
    2838 \fIforce user\fR
     3366\m[blue]\fBforce user\fR\m[]
    28393367parameter is also set the group specified in
    28403368\fIforce group\fR
    28413369will override the primary group set in
    2842 \fIforce user\fR\.
    2843 .sp
    2844 Default:
    2845 \fI\fIforce group\fR\fR\fI = \fR\fI\fR\fI \fR
    2846 .sp
    2847 Example:
    2848 \fI\fIforce group\fR\fR\fI = \fR\fIagroup\fR\fI \fR
     3370\fIforce user\fR\&.
     3371.sp
     3372Default:
     3373\fI\fIforce group\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3374.sp
     3375Example:
     3376\fI\fIforce group\fR\fR\fI = \fR\fI\FCagroup\F[]\fR\fI \fR
    28493377.RE
    28503378
    28513379force printername (S)
     3380.\" force printername
    28523381.PP
    28533382.RS 4
    28543383When printing from Windows NT (or later), each printer in
    2855 \fIsmb\.conf\fR
    2856 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
     3384\FCsmb\&.conf\F[]
     3385has 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
    28573386\fIprinter name\fR
    2858 option)\.
    2859 .sp
    2860 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
    2861 \fIforce printername = yes\fR\.
    2862 .sp
    2863 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\.
    2864 .sp
    2865 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\.
    2866 .sp
    2867 Default:
    2868 \fI\fIforce printername\fR\fR\fI = \fR\fIno\fR\fI \fR
     3387option)\&.
     3388.sp
     3389When 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
     3390\fIforce printername = yes\fR\&.
     3391.sp
     3392Be 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\&.
     3393.sp
     3394It 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\&.
     3395.sp
     3396Default:
     3397\fI\fIforce printername\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    28693398.RE
    28703399
    28713400force security mode (S)
    2872 .PP
    2873 .RS 4
    2874 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\.
    2875 .sp
    2876 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
    2877 \fIsecurity mask\fR, which works similar like this one but uses logical AND instead of OR\.
    2878 .sp
    2879 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\.
    2880 .sp
    2881 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\.
     3401.\" force security mode
     3402.PP
     3403.RS 4
     3404This 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\&.
     3405.sp
     3406This 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
     3407\m[blue]\fBsecurity mask\fR\m[], which works similar like this one but uses logical AND instead of OR\&.
     3408.sp
     3409Essentially, 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\&.
     3410.sp
     3411If 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\&.
    28823412.sp
    28833413\fI Note\fR
    2884 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\.
    2885 .sp
    2886 Default:
    2887 \fI\fIforce security mode\fR\fR\fI = \fR\fI0\fR\fI \fR
    2888 .sp
    2889 Example:
    2890 \fI\fIforce security mode\fR\fR\fI = \fR\fI700\fR\fI \fR
     3414that 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\&.
     3415.sp
     3416Default:
     3417\fI\fIforce security mode\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     3418.sp
     3419Example:
     3420\fI\fIforce security mode\fR\fR\fI = \fR\fI\FC700\F[]\fR\fI \fR
    28913421.RE
    28923422
    28933423force unknown acl user (S)
    2894 .PP
    2895 .RS 4
    2896 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\.
    2897 .sp
    2898 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\.
    2899 .sp
    2900 Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\.
    2901 .sp
    2902 Default:
    2903 \fI\fIforce unknown acl user\fR\fR\fI = \fR\fIno\fR\fI \fR
     3424.\" force unknown acl user
     3425.PP
     3426.RS 4
     3427If 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\&.
     3428.sp
     3429This 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\&.
     3430.sp
     3431Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\&.
     3432.sp
     3433Default:
     3434\fI\fIforce unknown acl user\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    29043435.RE
    29053436
    29063437force user (S)
    2907 .PP
    2908 .RS 4
    2909 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\.
    2910 .sp
    2911 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\.
    2912 .sp
    2913 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)\.
    2914 .sp
    2915 Default:
    2916 \fI\fIforce user\fR\fR\fI = \fR\fI\fR\fI \fR
    2917 .sp
    2918 Example:
    2919 \fI\fIforce user\fR\fR\fI = \fR\fIauser\fR\fI \fR
     3438.\" force user
     3439.PP
     3440.RS 4
     3441This 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\&.
     3442.sp
     3443This 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\&.
     3444.sp
     3445In 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)\&.
     3446.sp
     3447Default:
     3448\fI\fIforce user\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3449.sp
     3450Example:
     3451\fI\fIforce user\fR\fR\fI = \fR\fI\FCauser\F[]\fR\fI \fR
    29203452.RE
    29213453
    29223454fstype (S)
     3455.\" fstype
    29233456.PP
    29243457.RS 4
    29253458This parameter allows the administrator to configure the string that specifies the type of filesystem a share is using that is reported by
    29263459\fBsmbd\fR(8)
    2927 when a client queries the filesystem type for a share\. The default type is
     3460when a client queries the filesystem type for a share\&. The default type is
    29283461\fBNTFS\fR
    29293462for compatibility with Windows NT but this can be changed to other strings such as
     
    29313464or
    29323465\fBFAT\fR
    2933 if required\.
    2934 .sp
    2935 Default:
    2936 \fI\fIfstype\fR\fR\fI = \fR\fINTFS\fR\fI \fR
    2937 .sp
    2938 Example:
    2939 \fI\fIfstype\fR\fR\fI = \fR\fISamba\fR\fI \fR
     3466if required\&.
     3467.sp
     3468Default:
     3469\fI\fIfstype\fR\fR\fI = \fR\fI\FCNTFS\F[]\fR\fI \fR
     3470.sp
     3471Example:
     3472\fI\fIfstype\fR\fR\fI = \fR\fI\FCSamba\F[]\fR\fI \fR
    29403473.RE
    29413474
    29423475get quota command (G)
     3476.\" get quota command
    29433477.PP
    29443478.RS 4
    29453479The
    2946 get quota command
    2947 should only be used whenever there is no operating system API available from the OS that samba can use\.
     3480\FCget quota command\F[]
     3481should only be used whenever there is no operating system API available from the OS that samba can use\&.
    29483482.sp
    29493483This option is only available you have compiled Samba with the
    2950 \-\-with\-sys\-quotas
     3484\FC\-\-with\-sys\-quotas\F[]
    29513485option or on Linux with
    2952 \-\-with\-quotas
    2953 and a working quota api was found in the system\.
    2954 .sp
    2955 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\.
     3486\FC\-\-with\-quotas\F[]
     3487and a working quota api was found in the system\&.
     3488.sp
     3489This 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\&.
    29563490.sp
    29573491Such a script should take 3 arguments:
     
    30363570.sp
    30373571.RE
    3038 This script should print one line as output with spaces between the arguments\. The arguments are:
     3572This script should print one line as output with spaces between the arguments\&. The arguments are:
    30393573.sp
    30403574.RS 4
     
    31273661.RE
    31283662Default:
    3129 \fI\fIget quota command\fR\fR\fI = \fR\fI\fR\fI \fR
    3130 .sp
    3131 Example:
    3132 \fI\fIget quota command\fR\fR\fI = \fR\fI/usr/local/sbin/query_quota\fR\fI \fR
     3663\fI\fIget quota command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3664.sp
     3665Example:
     3666\fI\fIget quota command\fR\fR\fI = \fR\fI\FC/usr/local/sbin/query_quota\F[]\fR\fI \fR
    31333667.RE
    31343668
    31353669getwd cache (G)
    3136 .PP
    3137 .RS 4
    3138 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
    3139 \fIwide smbconfoptions\fR
     3670.\" getwd cache
     3671.PP
     3672.RS 4
     3673This 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
     3674\m[blue]\fBwide smbconfoptions\fR\m[]
    31403675parameter is set to
    3141 \fBno\fR\.
    3142 .sp
    3143 Default:
    3144 \fI\fIgetwd cache\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3676\fBno\fR\&.
     3677.sp
     3678Default:
     3679\fI\fIgetwd cache\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    31453680.RE
    31463681
    31473682guest account (G)
     3683.\" guest account
    31483684.PP
    31493685.RS 4
    31503686This is a username which will be used for access to services which are specified as
    3151 \fIguest ok\fR
    3152 (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\.
    3153 .sp
    3154 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
    3155 su \-
     3687\m[blue]\fBguest ok\fR\m[]
     3688(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\&.
     3689.sp
     3690On 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
     3691\FCsu \-\F[]
    31563692command) and trying to print using the system print command such as
    3157 lpr(1)
     3693\FClpr(1)\F[]
    31583694or
    3159 lp(1)\.
    3160 .sp
    3161 This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation\.
    3162 .sp
    3163 Default:
    3164 \fI\fIguest account\fR\fR\fI = \fR\fInobody # default can be changed at compile\-time\fR\fI \fR
    3165 .sp
    3166 Example:
    3167 \fI\fIguest account\fR\fR\fI = \fR\fIftp\fR\fI \fR
     3695\FC lp(1)\F[]\&.
     3696.sp
     3697This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation\&.
     3698.sp
     3699Default:
     3700\fI\fIguest account\fR\fR\fI = \fR\fI\FCnobody # default can be changed at compile\-time\F[]\fR\fI \fR
     3701.sp
     3702Example:
     3703\fI\fIguest account\fR\fR\fI = \fR\fI\FCftp\F[]\fR\fI \fR
    31683704.RE
    31693705
    31703706public
     3707.\" public
    31713708.PP
    31723709.RS 4
    31733710This parameter is a synonym for
    3174 guest ok\.
     3711guest ok\&.
    31753712.RE
    31763713
    31773714guest ok (S)
     3715.\" guest ok
    31783716.PP
    31793717.RS 4
    31803718If this parameter is
    31813719\fByes\fR
    3182 for a service, then no password is required to connect to the service\. Privileges will be those of the
    3183 \fIguest account\fR\.
     3720for a service, then no password is required to connect to the service\&. Privileges will be those of the
     3721\m[blue]\fBguest account\fR\m[]\&.
    31843722.sp
    31853723This paramater nullifies the benifits of setting
    3186 \fIrestrict anonymous = 2\fR
     3724\m[blue]\fBrestrict anonymous = 2\fR\m[]
    31873725.sp
    31883726See the section below on
    3189 \fIsecurity\fR
    3190 for more information about this option\.
    3191 .sp
    3192 Default:
    3193 \fI\fIguest ok\fR\fR\fI = \fR\fIno\fR\fI \fR
     3727\m[blue]\fBsecurity\fR\m[]
     3728for more information about this option\&.
     3729.sp
     3730Default:
     3731\fI\fIguest ok\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    31943732.RE
    31953733
    31963734only guest
     3735.\" only guest
    31973736.PP
    31983737.RS 4
    31993738This parameter is a synonym for
    3200 guest only\.
     3739guest only\&.
    32013740.RE
    32023741
    32033742guest only (S)
     3743.\" guest only
    32043744.PP
    32053745.RS 4
    32063746If this parameter is
    32073747\fByes\fR
    3208 for a service, then only guest connections to the service are permitted\. This parameter will have no effect if
    3209 \fIguest ok\fR
    3210 is not set for the service\.
     3748for a service, then only guest connections to the service are permitted\&. This parameter will have no effect if
     3749\m[blue]\fBguest ok\fR\m[]
     3750is not set for the service\&.
    32113751.sp
    32123752See the section below on
    3213 \fIsecurity\fR
    3214 for more information about this option\.
    3215 .sp
    3216 Default:
    3217 \fI\fIguest only\fR\fR\fI = \fR\fIno\fR\fI \fR
     3753\m[blue]\fBsecurity\fR\m[]
     3754for more information about this option\&.
     3755.sp
     3756Default:
     3757\fI\fIguest only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    32183758.RE
    32193759
    32203760hide dot files (S)
    3221 .PP
    3222 .RS 4
    3223 This is a boolean parameter that controls whether files starting with a dot appear as hidden files\.
    3224 .sp
    3225 Default:
    3226 \fI\fIhide dot files\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3761.\" hide dot files
     3762.PP
     3763.RS 4
     3764This is a boolean parameter that controls whether files starting with a dot appear as hidden files\&.
     3765.sp
     3766Default:
     3767\fI\fIhide dot files\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    32273768.RE
    32283769
    32293770hide files (S)
    3230 .PP
    3231 .RS 4
    3232 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\.
    3233 .sp
    3234 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\.
    3235 .sp
    3236 Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator \'/\'\.
    3237 .sp
    3238 Note that the case sensitivity option is applicable in hiding files\.
    3239 .sp
    3240 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\.
     3771.\" hide files
     3772.PP
     3773.RS 4
     3774This 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\&.
     3775.sp
     3776Each 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\&.
     3777.sp
     3778Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator \'/\'\&.
     3779.sp
     3780Note that the case sensitivity option is applicable in hiding files\&.
     3781.sp
     3782Setting 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\&.
    32413783.sp
    32423784The example shown above is based on files that the Macintosh SMB client (DAVE) available from
    32433785Thursby
    3244 creates for internal use, and also still hides all files beginning with a dot\.
     3786creates for internal use, and also still hides all files beginning with a dot\&.
    32453787.sp
    32463788An example of us of this parameter is:
    32473789.sp
    3248 .RS 4
     3790.if n \{\
     3791.RS 4
     3792.\}
     3793.fam C
     3794.ps -1
    32493795.nf
    3250 hide files = /\.*/DesktopFolderDB/TrashFor%m/resource\.frk/
     3796.if t \{\
     3797.sp -1
     3798.\}
     3799.BB lightgray adjust-for-leading-newline
     3800.sp -1
     3801
     3802hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/
     3803.EB lightgray adjust-for-leading-newline
     3804.if t \{\
     3805.sp 1
     3806.\}
    32513807.fi
    3252 .RE
    3253 .sp
    3254 .sp
    3255 Default:
    3256 \fI\fIhide files\fR\fR\fI = \fR\fI # no file are hidden\fR\fI \fR
     3808.fam
     3809.ps +1
     3810.if n \{\
     3811.RE
     3812.\}
     3813.sp
     3814Default:
     3815\fI\fIhide files\fR\fR\fI = \fR\fI\FC # no file are hidden\F[]\fR\fI \fR
    32573816.RE
    32583817
    32593818hide special files (S)
    3260 .PP
    3261 .RS 4
    3262 This parameter prevents clients from seeing special files such as sockets, devices and fifo\'s in directory listings\.
    3263 .sp
    3264 Default:
    3265 \fI\fIhide special files\fR\fR\fI = \fR\fIno\fR\fI \fR
     3819.\" hide special files
     3820.PP
     3821.RS 4
     3822This parameter prevents clients from seeing special files such as sockets, devices and fifo\'s in directory listings\&.
     3823.sp
     3824Default:
     3825\fI\fIhide special files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    32663826.RE
    32673827
    32683828hide unreadable (S)
    3269 .PP
    3270 .RS 4
    3271 This parameter prevents clients from seeing the existance of files that cannot be read\. Defaults to off\.
    3272 .sp
    3273 Default:
    3274 \fI\fIhide unreadable\fR\fR\fI = \fR\fIno\fR\fI \fR
     3829.\" hide unreadable
     3830.PP
     3831.RS 4
     3832This parameter prevents clients from seeing the existance of files that cannot be read\&. Defaults to off\&.
     3833.sp
     3834Default:
     3835\fI\fIhide unreadable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    32753836.RE
    32763837
    32773838hide unwriteable files (S)
    3278 .PP
    3279 .RS 4
    3280 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\.
    3281 .sp
    3282 Default:
    3283 \fI\fIhide unwriteable files\fR\fR\fI = \fR\fIno\fR\fI \fR
     3839.\" hide unwriteable files
     3840.PP
     3841.RS 4
     3842This 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\&.
     3843.sp
     3844Default:
     3845\fI\fIhide unwriteable files\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    32843846.RE
    32853847
    32863848homedir map (G)
     3849.\" homedir map
    32873850.PP
    32883851.RS 4
    32893852If
    3290 \fInis homedir\fR
     3853\m[blue]\fBnis homedir\fR\m[]
    32913854is
    32923855\fByes\fR, and
     
    32943857is also acting as a Win95/98
    32953858\fIlogon server\fR
    3296 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:
    3297 .sp
    3298 .RS 4
     3859then 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:
     3860.sp
     3861.if n \{\
     3862.RS 4
     3863.\}
     3864.fam C
     3865.ps -1
    32993866.nf
    3300 username server:/some/file/system
     3867.if t \{\
     3868.sp -1
     3869.\}
     3870.BB lightgray adjust-for-leading-newline
     3871.sp -1
     3872
     3873\FCusername server:/some/file/system\F[]
     3874.EB lightgray adjust-for-leading-newline
     3875.if t \{\
     3876.sp 1
     3877.\}
    33013878.fi
    3302 .RE
    3303 .sp
    3304 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\.
    3305 .sp
     3879.fam
     3880.ps +1
     3881.if n \{\
     3882.RE
     3883.\}
     3884.sp
     3885and 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\&.
     3886.if n \{\
     3887.sp
     3888.\}
     3889.RS 4
     3890.BM yellow
    33063891.it 1 an-trap
    33073892.nr an-no-space-flag 1
    33083893.nr an-break-flag 1
    33093894.br
    3310 Note
    3311 A working NIS client is required on the system for this option to work\.
    3312 
    3313 Default:
    3314 \fI\fIhomedir map\fR\fR\fI = \fR\fI\fR\fI \fR
    3315 .sp
    3316 Example:
    3317 \fI\fIhomedir map\fR\fR\fI = \fR\fIamd\.homedir\fR\fI \fR
     3895.ps +1
     3896\fBNote\fR
     3897.ps -1
     3898.br
     3899A working NIS client is required on the system for this option to work\&.
     3900.sp .5v
     3901.EM yellow
     3902.RE
     3903Default:
     3904\fI\fIhomedir map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     3905.sp
     3906Example:
     3907\fI\fIhomedir map\fR\fR\fI = \fR\fI\FCamd\&.homedir\F[]\fR\fI \fR
    33183908.RE
    33193909
    33203910host msdfs (G)
     3911.\" host msdfs
    33213912.PP
    33223913.RS 4
    33233914If set to
    3324 \fByes\fR, Samba will act as a Dfs server, and allow Dfs\-aware clients to browse Dfs trees hosted on the server\.
     3915\fByes\fR, Samba will act as a Dfs server, and allow Dfs\-aware clients to browse Dfs trees hosted on the server\&.
    33253916.sp
    33263917See also the
    3327 \fImsdfs root\fR
    3328 share level parameter\. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\.
    3329 .sp
    3330 Default:
    3331 \fI\fIhost msdfs\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3918\m[blue]\fBmsdfs root\fR\m[]
     3919share level parameter\&. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\&.
     3920.sp
     3921Default:
     3922\fI\fIhost msdfs\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    33323923.RE
    33333924
    33343925hostname lookups (G)
    3335 .PP
    3336 .RS 4
    3337 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
    3338 hosts deny
     3926.\" hostname lookups
     3927.PP
     3928.RS 4
     3929Specifies 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
     3930\FChosts deny\F[]
    33393931and
    3340 hosts allow\.
    3341 .sp
    3342 Default:
    3343 \fI\fIhostname lookups\fR\fR\fI = \fR\fIno\fR\fI \fR
    3344 .sp
    3345 Example:
    3346 \fI\fIhostname lookups\fR\fR\fI = \fR\fIyes\fR\fI \fR
     3932\FChosts allow\F[]\&.
     3933.sp
     3934Default:
     3935\fI\fIhostname lookups\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
     3936.sp
     3937Example:
     3938\fI\fIhostname lookups\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    33473939.RE
    33483940
    33493941allow hosts
     3942.\" allow hosts
    33503943.PP
    33513944.RS 4
    33523945This parameter is a synonym for
    3353 hosts allow\.
     3946hosts allow\&.
    33543947.RE
    33553948
    33563949hosts allow (S)
     3950.\" hosts allow
    33573951.PP
    33583952.RS 4
    33593953A synonym for this parameter is
    3360 \fIallow hosts\fR\.
    3361 .sp
    3362 This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\.
    3363 .sp
    3364 If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\.
    3365 .sp
    3366 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
    3367 allow hosts = 150\.203\.5\.\. The full syntax of the list is described in the man page
    3368 \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\.
    3369 .sp
    3370 Note that the localhost address 127\.0\.0\.1 will always be allowed access unless specifically denied by a
    3371 \fIhosts deny\fR
    3372 option\.
    3373 .sp
    3374 You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\. The
     3954\m[blue]\fBallow hosts\fR\m[]\&.
     3955.sp
     3956This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\&.
     3957.sp
     3958If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\&.
     3959.sp
     3960You 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
     3961\FCallow hosts = 150\&.203\&.5\&.\F[]\&. The full syntax of the list is described in the man page
     3962\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\&.
     3963.sp
     3964Note that the localhost address 127\&.0\&.0\&.1 will always be allowed access unless specifically denied by a
     3965\m[blue]\fBhosts deny\fR\m[]
     3966option\&.
     3967.sp
     3968You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\&. The
    33753969\fIEXCEPT\fR
    3376 keyword can also be used to limit a wildcard list\. The following examples may provide some help:
    3377 .sp
    3378 Example 1: allow all IPs in 150\.203\.*\.*; except one
    3379 .sp
    3380 hosts allow = 150\.203\. EXCEPT 150\.203\.6\.66
     3970keyword can also be used to limit a wildcard list\&. The following examples may provide some help:
     3971.sp
     3972Example 1: allow all IPs in 150\&.203\&.*\&.*; except one
     3973.sp
     3974\FChosts allow = 150\&.203\&. EXCEPT 150\&.203\&.6\&.66\F[]
    33813975.sp
    33823976Example 2: allow hosts that match the given network/netmask
    33833977.sp
    3384 hosts allow = 150\.203\.15\.0/255\.255\.255\.0
     3978\FChosts allow = 150\&.203\&.15\&.0/255\&.255\&.255\&.0\F[]
    33853979.sp
    33863980Example 3: allow a couple of hosts
    33873981.sp
    3388 hosts allow = lapland, arvidsjaur
     3982\FChosts allow = lapland, arvidsjaur\F[]
    33893983.sp
    33903984Example 4: allow only hosts in NIS netgroup "foonet", but deny access from one particular host
    33913985.sp
    3392 hosts allow = @foonet
    3393 .sp
    3394 hosts deny = pirate
    3395 .sp
     3986\FChosts allow = @foonet\F[]
     3987.sp
     3988\FChosts deny = pirate\F[]
     3989.if n \{\
     3990.sp
     3991.\}
     3992.RS 4
     3993.BM yellow
    33963994.it 1 an-trap
    33973995.nr an-no-space-flag 1
    33983996.nr an-break-flag 1
    33993997.br
    3400 Note
    3401 Note that access still requires suitable user\-level passwords\.
    3402 
     3998.ps +1
     3999\fBNote\fR
     4000.ps -1
     4001.br
     4002Note that access still requires suitable user\-level passwords\&.
     4003.sp .5v
     4004.EM yellow
     4005.RE
    34034006See
    34044007\fBtestparm\fR(1)
    3405 for a way of testing your host access to see if it does what you expect\.
    3406 .sp
    3407 Default:
    3408 \fI\fIhosts allow\fR\fR\fI = \fR\fI # none (i\.e\., all hosts permitted access)\fR\fI \fR
    3409 .sp
    3410 Example:
    3411 \fI\fIhosts allow\fR\fR\fI = \fR\fI150\.203\.5\. myhost\.mynet\.edu\.au\fR\fI \fR
     4008for a way of testing your host access to see if it does what you expect\&.
     4009.sp
     4010Default:
     4011\fI\fIhosts allow\fR\fR\fI = \fR\fI\FC # none (i\&.e\&., all hosts permitted access)\F[]\fR\fI \fR
     4012.sp
     4013Example:
     4014\fI\fIhosts allow\fR\fR\fI = \fR\fI\FC150\&.203\&.5\&. myhost\&.mynet\&.edu\&.au\F[]\fR\fI \fR
    34124015.RE
    34134016
    34144017deny hosts
     4018.\" deny hosts
    34154019.PP
    34164020.RS 4
    34174021This parameter is a synonym for
    3418 hosts deny\.
     4022hosts deny\&.
    34194023.RE
    34204024
    34214025hosts deny (S)
     4026.\" hosts deny
    34224027.PP
    34234028.RS 4
     
    34264031\- hosts listed here are
    34274032\fINOT\fR
    3428 permitted access to services unless the specific services have their own lists to override this one\. Where the lists conflict, the
     4033permitted access to services unless the specific services have their own lists to override this one\&. Where the lists conflict, the
    34294034\fIallow\fR
    3430 list takes precedence\.
     4035list takes precedence\&.
    34314036.sp
    34324037In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask
    3433 0\.0\.0\.0/0) and then explicitly specify to the
    3434 \fIhosts allow = hosts allow\fR
    3435 parameter those hosts that should be permitted access\.
    3436 .sp
    3437 Default:
    3438 \fI\fIhosts deny\fR\fR\fI = \fR\fI # none (i\.e\., no hosts specifically excluded)\fR\fI \fR
    3439 .sp
    3440 Example:
    3441 \fI\fIhosts deny\fR\fR\fI = \fR\fI150\.203\.4\. badhost\.mynet\.edu\.au\fR\fI \fR
     4038\FC0\&.0\&.0\&.0/0\F[]) and then explicitly specify to the
     4039\m[blue]\fBhosts allow = hosts allow\fR\m[]
     4040parameter those hosts that should be permitted access\&.
     4041.sp
     4042Default:
     4043\fI\fIhosts deny\fR\fR\fI = \fR\fI\FC # none (i\&.e\&., no hosts specifically excluded)\F[]\fR\fI \fR
     4044.sp
     4045Example:
     4046\fI\fIhosts deny\fR\fR\fI = \fR\fI\FC150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\F[]\fR\fI \fR
    34424047.RE
    34434048
    34444049idmap alloc backend (G)
    3445 .PP
    3446 .RS 4
    3447 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
    3448 \fIidmap domains\fR
    3449 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\.
     4050.\" idmap alloc backend
     4051.PP
     4052.RS 4
     4053The 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
     4054\m[blue]\fBidmap domains\fR\m[]
     4055parameter 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\&.
    34504056.sp
    34514057Also refer to the
    3452 \fIidmap alloc config\fR
    3453 option\.
     4058\m[blue]\fBidmap alloc config\fR\m[]
     4059option\&.
    34544060.sp
    34554061\fINo default\fR
    34564062.sp
    34574063Example:
    3458 \fI\fIidmap alloc backend\fR\fR\fI = \fR\fItdb\fR\fI \fR
     4064\fI\fIidmap alloc backend\fR\fR\fI = \fR\fI\FCtdb\F[]\fR\fI \fR
    34594065.RE
    34604066
    34614067idmap alloc config (G)
     4068.\" idmap alloc config
    34624069.PP
    34634070.RS 4
    34644071The idmap alloc config prefix provides a means of managing settings for the backend defined by the
    3465 \fIidmap alloc backend\fR
    3466 parameter\. Refer to the man page for each idmap plugin regarding specific configuration details\.
     4072\m[blue]\fBidmap alloc backend\fR\m[]
     4073parameter\&. Refer to the man page for each idmap plugin regarding specific configuration details\&.
    34674074.sp
    34684075\fINo default\fR
     
    34704077
    34714078idmap backend (G)
    3472 .PP
    3473 .RS 4
    3474 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
    3475 \fIidmap domains\fR
    3476 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\.
    3477 .sp
    3478 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))\.
    3479 .sp
    3480 Default:
    3481 \fI\fIidmap backend\fR\fR\fI = \fR\fItdb\fR\fI \fR
     4079.\" idmap backend
     4080.PP
     4081.RS 4
     4082The 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
     4083\m[blue]\fBidmap domains\fR\m[]
     4084parameter\&. 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\&.
     4085.sp
     4086Examples 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))\&.
     4087.sp
     4088Default:
     4089\fI\fIidmap backend\fR\fR\fI = \fR\fI\FCtdb\F[]\fR\fI \fR
    34824090.RE
    34834091
    34844092idmap cache time (G)
    3485 .PP
    3486 .RS 4
    3487 This parameter specifies the number of seconds that Winbind\'s idmap interface will cache positive SID/uid/gid query results\.
    3488 .sp
    3489 Default:
    3490 \fI\fIidmap cache time\fR\fR\fI = \fR\fI900\fR\fI \fR
     4093.\" idmap cache time
     4094.PP
     4095.RS 4
     4096This parameter specifies the number of seconds that Winbind\'s idmap interface will cache positive SID/uid/gid query results\&.
     4097.sp
     4098Default:
     4099\fI\fIidmap cache time\fR\fR\fI = \fR\fI\FC900\F[]\fR\fI \fR
    34914100.RE
    34924101
    34934102idmap config (G)
     4103.\" idmap config
    34944104.PP
    34954105.RS 4
    34964106The idmap config prefix provides a means of managing each domain defined by the
    3497 \fIidmap domains\fR
    3498 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:
     4107\m[blue]\fBidmap domains\fR\m[]
     4108option 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:
    34994109.PP
    35004110backend = backend_name
    35014111.RS 4
    3502 Specifies the name of the idmap plugin to use as the SID/uid/gid backend for this domain\.
     4112Specifies the name of the idmap plugin to use as the SID/uid/gid backend for this domain\&.
    35034113.RE
    35044114.PP
    35054115default = [yes|no]
    35064116.RS 4
    3507 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)\.
     4117The 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)\&.
    35084118.RE
    35094119.PP
     
    35114121.RS 4
    35124122Mark the domain as readonly which means that no attempts to allocate a uid or gid (by the
    3513 \fIidmap alloc backend\fR) for any user or group in that domain will be attempted\.
     4123\m[blue]\fBidmap alloc backend\fR\m[]) for any user or group in that domain will be attempted\&.
    35144124.RE
    35154125.sp
     
    35184128for the CORP domain and the
    35194129\fBidmap_tdb\fR(8)
    3520 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\.
    3521 .sp
    3522 .RS 4
     4130backend 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\&.
     4131.sp
     4132.if n \{\
     4133.RS 4
     4134.\}
     4135.fam C
     4136.ps -1
    35234137.nf
     4138.if t \{\
     4139.sp -1
     4140.\}
     4141.BB lightgray adjust-for-leading-newline
     4142.sp -1
     4143
    35244144        idmap domains = CORP TRUSTEDDOMAINS
    35254145
     
    35314151        idmap config TRUSTEDDOMAINS:range   = 1000 \- 9999
    35324152       
     4153.EB lightgray adjust-for-leading-newline
     4154.if t \{\
     4155.sp 1
     4156.\}
    35334157.fi
    3534 .RE
     4158.fam
     4159.ps +1
     4160.if n \{\
     4161.RE
     4162.\}
     4163.sp
    35354164\fINo default\fR
    35364165.RE
    35374166
    35384167idmap domains (G)
    3539 .PP
    3540 .RS 4
    3541 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
    3542 \fIidmap backend\fR
    3543 option\.
    3544 .sp
    3545 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\.
     4168.\" idmap domains
     4169.PP
     4170.RS 4
     4171The 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
     4172\m[blue]\fBidmap backend\fR\m[]
     4173option\&.
     4174.sp
     4175Values 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\&.
    35464176.sp
    35474177Refer to the
    3548 \fIidmap config\fR
    3549 for details about managing the SID/uid/gid backend for each domain\.
     4178\m[blue]\fBidmap config\fR\m[]
     4179for details about managing the SID/uid/gid backend for each domain\&.
    35504180.sp
    35514181\fINo default\fR
    35524182.sp
    35534183Example:
    3554 \fI\fIidmap domains\fR\fR\fI = \fR\fIdefault AD CORP\fR\fI \fR
     4184\fI\fIidmap domains\fR\fR\fI = \fR\fI\FCdefault AD CORP\F[]\fR\fI \fR
    35554185.RE
    35564186
    35574187winbind gid
     4188.\" winbind gid
    35584189.PP
    35594190.RS 4
    35604191This parameter is a synonym for
    3561 idmap gid\.
     4192idmap gid\&.
    35624193.RE
    35634194
    35644195idmap gid (G)
    3565 .PP
    3566 .RS 4
    3567 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\.
     4196.\" idmap gid
     4197.PP
     4198.RS 4
     4199The 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\&.
    35684200.sp
    35694201See also the
    3570 \fIidmap backend\fR,
    3571 \fIidmap domains\fR, and
    3572 \fIidmap config\fR
    3573 options\.
    3574 .sp
    3575 Default:
    3576 \fI\fIidmap gid\fR\fR\fI = \fR\fI\fR\fI \fR
    3577 .sp
    3578 Example:
    3579 \fI\fIidmap gid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR
     4202\m[blue]\fBidmap backend\fR\m[],
     4203\m[blue]\fBidmap domains\fR\m[], and
     4204\m[blue]\fBidmap config\fR\m[]
     4205options\&.
     4206.sp
     4207Default:
     4208\fI\fIidmap gid\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4209.sp
     4210Example:
     4211\fI\fIidmap gid\fR\fR\fI = \fR\fI\FC10000\-20000\F[]\fR\fI \fR
    35804212.RE
    35814213
    35824214idmap negative cache time (G)
    3583 .PP
    3584 .RS 4
    3585 This parameter specifies the number of seconds that Winbind\'s idmap interface will cache negative SID/uid/gid query results\.
    3586 .sp
    3587 Default:
    3588 \fI\fIidmap negative cache time\fR\fR\fI = \fR\fI120\fR\fI \fR
     4215.\" idmap negative cache time
     4216.PP
     4217.RS 4
     4218This parameter specifies the number of seconds that Winbind\'s idmap interface will cache negative SID/uid/gid query results\&.
     4219.sp
     4220Default:
     4221\fI\fIidmap negative cache time\fR\fR\fI = \fR\fI\FC120\F[]\fR\fI \fR
    35894222.RE
    35904223
    35914224winbind uid
     4225.\" winbind uid
    35924226.PP
    35934227.RS 4
    35944228This parameter is a synonym for
    3595 idmap uid\.
     4229idmap uid\&.
    35964230.RE
    35974231
    35984232idmap uid (G)
    3599 .PP
    3600 .RS 4
    3601 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\.
     4233.\" idmap uid
     4234.PP
     4235.RS 4
     4236The 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\&.
    36024237.sp
    36034238See also the
    3604 \fIidmap backend\fR,
    3605 \fIidmap domains\fR, and
    3606 \fIidmap config\fR
    3607 options\.
    3608 .sp
    3609 Default:
    3610 \fI\fIidmap uid\fR\fR\fI = \fR\fI\fR\fI \fR
    3611 .sp
    3612 Example:
    3613 \fI\fIidmap uid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR
     4239\m[blue]\fBidmap backend\fR\m[],
     4240\m[blue]\fBidmap domains\fR\m[], and
     4241\m[blue]\fBidmap config\fR\m[]
     4242options\&.
     4243.sp
     4244Default:
     4245\fI\fIidmap uid\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4246.sp
     4247Example:
     4248\fI\fIidmap uid\fR\fR\fI = \fR\fI\FC10000\-20000\F[]\fR\fI \fR
    36144249.RE
    36154250
    36164251include (G)
    3617 .PP
    3618 .RS 4
    3619 This allows you to include one config file inside another\. The file is included literally, as though typed in place\.
     4252.\" include
     4253.PP
     4254.RS 4
     4255This allows you to include one config file inside another\&. The file is included literally, as though typed in place\&.
    36204256.sp
    36214257It takes the standard substitutions, except
     
    36234259\fI%P\fR
    36244260and
    3625 \fI%S\fR\.
     4261\fI%S\fR\&.
    36264262.sp
    36274263The parameter
     
    36314267include a file named
    36324268\fIregistry\fR
    3633 from the current working directory, but instead reads the global configuration options from the registry\. See the section on registry\-based configuration for details\. Note that this option automatically activates registry shares\.
    3634 .sp
    3635 Default:
    3636 \fI\fIinclude\fR\fR\fI = \fR\fI\fR\fI \fR
    3637 .sp
    3638 Example:
    3639 \fI\fIinclude\fR\fR\fI = \fR\fI/usr/local/samba/lib/admin_smb\.conf\fR\fI \fR
     4269from the current working directory, but instead reads the global configuration options from the registry\&. See the section on registry\-based configuration for details\&. Note that this option automatically activates registry shares\&.
     4270.sp
     4271Default:
     4272\fI\fIinclude\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4273.sp
     4274Example:
     4275\fI\fIinclude\fR\fR\fI = \fR\fI\FC/usr/local/samba/lib/admin_smb\&.conf\F[]\fR\fI \fR
    36404276.RE
    36414277
    36424278inherit acls (S)
    3643 .PP
    3644 .RS 4
    3645 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\.
    3646 .sp
    3647 Default:
    3648 \fI\fIinherit acls\fR\fR\fI = \fR\fIno\fR\fI \fR
     4279.\" inherit acls
     4280.PP
     4281.RS 4
     4282This 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\&.
     4283.sp
     4284Default:
     4285\fI\fIinherit acls\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    36494286.RE
    36504287
    36514288inherit owner (S)
    3652 .PP
    3653 .RS 4
    3654 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\.
    3655 .sp
    3656 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\.
    3657 .sp
    3658 Default:
    3659 \fI\fIinherit owner\fR\fR\fI = \fR\fIno\fR\fI \fR
     4289.\" inherit owner
     4290.PP
     4291.RS 4
     4292The 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\&.
     4293.sp
     4294Common 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\&.
     4295.sp
     4296Default:
     4297\fI\fIinherit owner\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    36604298.RE
    36614299
    36624300inherit permissions (S)
     4301.\" inherit permissions
    36634302.PP
    36644303.RS 4
    36654304The permissions on new files and directories are normally governed by
    3666 \fIcreate mask\fR,
    3667 \fIdirectory mask\fR,
    3668 \fIforce create mode\fR
     4305\m[blue]\fBcreate mask\fR\m[],
     4306\m[blue]\fBdirectory mask\fR\m[],
     4307\m[blue]\fBforce create mode\fR\m[]
    36694308and
    3670 \fIforce directory mode\fR
    3671 but the boolean inherit permissions parameter overrides this\.
    3672 .sp
    3673 New directories inherit the mode of the parent directory, including bits such as setgid\.
    3674 .sp
    3675 New files inherit their read/write bits from the parent directory\. Their execute bits continue to be determined by
    3676 \fImap archive\fR,
    3677 \fImap hidden\fR
     4309\m[blue]\fBforce directory mode\fR\m[]
     4310but the boolean inherit permissions parameter overrides this\&.
     4311.sp
     4312New directories inherit the mode of the parent directory, including bits such as setgid\&.
     4313.sp
     4314New files inherit their read/write bits from the parent directory\&. Their execute bits continue to be determined by
     4315\m[blue]\fBmap archive\fR\m[],
     4316\m[blue]\fBmap hidden\fR\m[]
    36784317and
    3679 \fImap system\fR
    3680 as usual\.
     4318\m[blue]\fBmap system\fR\m[]
     4319as usual\&.
    36814320.sp
    36824321Note that the setuid bit is
    36834322\fInever\fR
    3684 set via inheritance (the code explicitly prohibits this)\.
    3685 .sp
    3686 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\.
    3687 .sp
    3688 Default:
    3689 \fI\fIinherit permissions\fR\fR\fI = \fR\fIno\fR\fI \fR
     4323set via inheritance (the code explicitly prohibits this)\&.
     4324.sp
     4325This 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\&.
     4326.sp
     4327Default:
     4328\fI\fIinherit permissions\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    36904329.RE
    36914330
    36924331interfaces (G)
    3693 .PP
    3694 .RS 4
    3695 This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other NetBIOS over TCP/IP (NBT) traffic\. By default Samba will query the kernel for the list of all active interfaces and use any interfaces except 127\.0\.0\.1 that are broadcast capable\.
    3696 .sp
    3697 The option takes a list of interface strings\. Each string can be in any of the following forms:
    3698 .sp
    3699 .RS 4
    3700 .ie n \{\
    3701 \h'-04'\(bu\h'+03'\c
    3702 .\}
    3703 .el \{\
    3704 .sp -1
    3705 .IP \(bu 2.3
    3706 .\}
    3707 a network interface name (such as eth0)\. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth"
    3708 .RE
    3709 .sp
    3710 .RS 4
    3711 .ie n \{\
    3712 \h'-04'\(bu\h'+03'\c
    3713 .\}
    3714 .el \{\
    3715 .sp -1
    3716 .IP \(bu 2.3
    3717 .\}
    3718 an IP address\. In this case the netmask is determined from the list of interfaces obtained from the kernel
    3719 .RE
    3720 .sp
    3721 .RS 4
    3722 .ie n \{\
    3723 \h'-04'\(bu\h'+03'\c
    3724 .\}
    3725 .el \{\
    3726 .sp -1
    3727 .IP \(bu 2.3
    3728 .\}
    3729 an IP/mask pair\.
    3730 .RE
    3731 .sp
    3732 .RS 4
    3733 .ie n \{\
    3734 \h'-04'\(bu\h'+03'\c
    3735 .\}
    3736 .el \{\
    3737 .sp -1
    3738 .IP \(bu 2.3
    3739 .\}
    3740 a broadcast/mask pair\.
    3741 .sp
    3742 .RE
    3743 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\.
    3744 .sp
    3745 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\.
    3746 .sp
    3747 By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\.0\.0\.1)\.
    3748 .sp
    3749 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\.
    3750 .sp
    3751 Default:
    3752 \fI\fIinterfaces\fR\fR\fI = \fR\fI\fR\fI \fR
    3753 .sp
    3754 Example:
    3755 \fI\fIinterfaces\fR\fR\fI = \fR\fIeth0 192\.168\.2\.10/24 192\.168\.3\.10/255\.255\.255\.0\fR\fI \fR
     4332.\" interfaces
     4333.PP
     4334.RS 4
     4335This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other NetBIOS over TCP/IP (NBT) traffic\&. By default Samba will query the kernel for the list of all active interfaces and use any interfaces except 127\&.0\&.0\&.1 that are broadcast capable\&.
     4336.sp
     4337The option takes a list of interface strings\&. Each string can be in any of the following forms:
     4338.sp
     4339.RS 4
     4340.ie n \{\
     4341\h'-04'\(bu\h'+03'\c
     4342.\}
     4343.el \{\
     4344.sp -1
     4345.IP \(bu 2.3
     4346.\}
     4347a network interface name (such as eth0)\&. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth"
     4348.RE
     4349.sp
     4350.RS 4
     4351.ie n \{\
     4352\h'-04'\(bu\h'+03'\c
     4353.\}
     4354.el \{\
     4355.sp -1
     4356.IP \(bu 2.3
     4357.\}
     4358an IP address\&. In this case the netmask is determined from the list of interfaces obtained from the kernel
     4359.RE
     4360.sp
     4361.RS 4
     4362.ie n \{\
     4363\h'-04'\(bu\h'+03'\c
     4364.\}
     4365.el \{\
     4366.sp -1
     4367.IP \(bu 2.3
     4368.\}
     4369an IP/mask pair\&.
     4370.RE
     4371.sp
     4372.RS 4
     4373.ie n \{\
     4374\h'-04'\(bu\h'+03'\c
     4375.\}
     4376.el \{\
     4377.sp -1
     4378.IP \(bu 2.3
     4379.\}
     4380a broadcast/mask pair\&.
     4381.sp
     4382.RE
     4383The "mask" parameters can either be a bit length (such as 24 for a C class network) or a full netmask in dotted decimal form\&.
     4384.sp
     4385The "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\&.
     4386.sp
     4387By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\&.0\&.0\&.1)\&.
     4388.sp
     4389The 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\&.
     4390.sp
     4391Default:
     4392\fI\fIinterfaces\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4393.sp
     4394Example:
     4395\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
    37564396.RE
    37574397
    37584398invalid users (S)
    3759 .PP
    3760 .RS 4
    3761 This is a list of users that should not be allowed to login to this service\. This is really a
     4399.\" invalid users
     4400.PP
     4401.RS 4
     4402This is a list of users that should not be allowed to login to this service\&. This is really a
    37624403\fIparanoid\fR
    3763 check to absolutely ensure an improper setting does not breach your security\.
    3764 .sp
    3765 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\.
    3766 .sp
    3767 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
     4404check to absolutely ensure an improper setting does not breach your security\&.
     4405.sp
     4406A 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\&.
     4407.sp
     4408A 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
    37684409\fI+&group\fR
    37694410means check the UNIX group database, followed by the NIS netgroup database, and the value
    37704411\fI&+group\fR
    3771 means check the NIS netgroup database, followed by the UNIX group database (the same as the \'@\' prefix)\.
     4412means check the NIS netgroup database, followed by the UNIX group database (the same as the \'@\' prefix)\&.
    37724413.sp
    37734414The current servicename is substituted for
    3774 \fI%S\fR\. This is useful in the [homes] section\.
    3775 .sp
    3776 Default:
    3777 \fI\fIinvalid users\fR\fR\fI = \fR\fI # no invalid users\fR\fI \fR
    3778 .sp
    3779 Example:
    3780 \fI\fIinvalid users\fR\fR\fI = \fR\fIroot fred admin @wheel\fR\fI \fR
     4415\fI%S\fR\&. This is useful in the [homes] section\&.
     4416.sp
     4417Default:
     4418\fI\fIinvalid users\fR\fR\fI = \fR\fI\FC # no invalid users\F[]\fR\fI \fR
     4419.sp
     4420Example:
     4421\fI\fIinvalid users\fR\fR\fI = \fR\fI\FCroot fred admin @wheel\F[]\fR\fI \fR
    37814422.RE
    37824423
    37834424iprint server (G)
     4425.\" iprint server
    37844426.PP
    37854427.RS 4
    37864428This parameter is only applicable if
    3787 \fIprinting\fR
     4429\m[blue]\fBprinting\fR\m[]
    37884430is set to
    3789 \fBiprint\fR\.
     4431\fBiprint\fR\&.
    37904432.sp
    37914433If set, this option overrides the ServerName option in the CUPS
    3792 \fIclient\.conf\fR\. This is necessary if you have virtual samba servers that connect to different CUPS daemons\.
    3793 .sp
    3794 Default:
    3795 \fI\fIiprint server\fR\fR\fI = \fR\fI""\fR\fI \fR
    3796 .sp
    3797 Example:
    3798 \fI\fIiprint server\fR\fR\fI = \fR\fIMYCUPSSERVER\fR\fI \fR
     4434\FCclient\&.conf\F[]\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
     4435.sp
     4436Default:
     4437\fI\fIiprint server\fR\fR\fI = \fR\fI\FC""\F[]\fR\fI \fR
     4438.sp
     4439Example:
     4440\fI\fIiprint server\fR\fR\fI = \fR\fI\FCMYCUPSSERVER\F[]\fR\fI \fR
    37994441.RE
    38004442
    38014443keepalive (G)
     4444.\" keepalive
    38024445.PP
    38034446.RS 4
    38044447The value of the parameter (an integer) represents the number of seconds between
    38054448\fIkeepalive\fR
    3806 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\.
    3807 .sp
    3808 Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\. (see
    3809 \fIsocket options\fR)\. Basically you should only use this option if you strike difficulties\.
    3810 .sp
    3811 Default:
    3812 \fI\fIkeepalive\fR\fR\fI = \fR\fI300\fR\fI \fR
    3813 .sp
    3814 Example:
    3815 \fI\fIkeepalive\fR\fR\fI = \fR\fI600\fR\fI \fR
     4449packets\&. 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\&.
     4450.sp
     4451Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\&. (see
     4452\m[blue]\fBsocket options\fR\m[])\&. Basically you should only use this option if you strike difficulties\&.
     4453.sp
     4454Default:
     4455\fI\fIkeepalive\fR\fR\fI = \fR\fI\FC300\F[]\fR\fI \fR
     4456.sp
     4457Example:
     4458\fI\fIkeepalive\fR\fR\fI = \fR\fI\FC600\F[]\fR\fI \fR
    38164459.RE
    38174460
    38184461kernel change notify (S)
    3819 .PP
    3820 .RS 4
    3821 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\.
    3822 .sp
    3823 This parameter is only used when your kernel supports change notification to user programs using the inotify interface\.
    3824 .sp
    3825 Default:
    3826 \fI\fIkernel change notify\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4462.\" kernel change notify
     4463.PP
     4464.RS 4
     4465This 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\&.
     4466.sp
     4467This parameter is only used when your kernel supports change notification to user programs using the inotify interface\&.
     4468.sp
     4469Default:
     4470\fI\fIkernel change notify\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    38274471.RE
    38284472
    38294473kernel oplocks (G)
     4474.\" kernel oplocks
    38304475.PP
    38314476.RS 4
    38324477For UNIXes that support kernel based
    3833 \fIoplocks\fR
    3834 (currently only IRIX and the Linux 2\.4 kernel), this parameter allows the use of them to be turned on or off\.
     4478\m[blue]\fBoplocks\fR\m[]
     4479(currently only IRIX and the Linux 2\&.4 kernel), this parameter allows the use of them to be turned on or off\&.
    38354480.sp
    38364481Kernel oplocks support allows Samba
     
    38384483to be broken whenever a local UNIX process or NFS operation accesses a file that
    38394484\fBsmbd\fR(8)
    3840 has oplocked\. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a
     4485has oplocked\&. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a
    38414486\fIvery\fR
    3842 cool feature :\-)\.
     4487cool feature :\-)\&.
    38434488.sp
    38444489This parameter defaults to
    3845 \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\.
    3846 .sp
    3847 Default:
    3848 \fI\fIkernel oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4490\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\&.
     4491.sp
     4492Default:
     4493\fI\fIkernel oplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    38494494.RE
    38504495
    38514496lanman auth (G)
     4497.\" lanman auth
    38524498.PP
    38534499.RS 4
    38544500This parameter determines whether or not
    38554501\fBsmbd\fR(8)
    3856 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\.
    3857 .sp
    3858 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\.
     4502will 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\&.
     4503.sp
     4504The 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\&.
    38594505.sp
    38604506Unlike the
    3861 encrypt passwords
    3862 option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\. See the
    3863 client lanman auth
     4507\FCencrypt passwords\F[]
     4508option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\&. See the
     4509\FCclient lanman auth\F[]
    38644510to disable this for Samba\'s clients (such as smbclient)
    38654511.sp
    38664512If this option, and
    3867 ntlm auth
    3868 are both disabled, then only NTLMv2 logins will be permited\. Not all clients support NTLMv2, and most will require special configuration to use it\.
    3869 .sp
    3870 Default:
    3871 \fI\fIlanman auth\fR\fR\fI = \fR\fIno\fR\fI \fR
     4513\FCntlm auth\F[]
     4514are both disabled, then only NTLMv2 logins will be permited\&. Not all clients support NTLMv2, and most will require special configuration to use it\&.
     4515.sp
     4516Default:
     4517\fI\fIlanman auth\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    38724518.RE
    38734519
    38744520large readwrite (G)
     4521.\" large readwrite
    38754522.PP
    38764523.RS 4
    38774524This parameter determines whether or not
    38784525\fBsmbd\fR(8)
    3879 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\.
    3880 .sp
    3881 Default:
    3882 \fI\fIlarge readwrite\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4526supports 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\&.
     4527.sp
     4528Default:
     4529\fI\fIlarge readwrite\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    38834530.RE
    38844531
    38854532ldap admin dn (G)
     4533.\" ldap admin dn
    38864534.PP
    38874535.RS 4
    38884536The
    3889 \fIldap admin dn\fR
    3890 defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information\. The
    3891 \fIldap admin dn\fR
     4537\m[blue]\fBldap admin dn\fR\m[]
     4538defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account information\&. The
     4539\m[blue]\fBldap admin dn\fR\m[]
    38924540is used in conjunction with the admin dn password stored in the
    3893 \fIprivate/secrets\.tdb\fR
    3894 file\. See the
     4541\FCprivate/secrets\&.tdb\F[]
     4542file\&. See the
    38954543\fBsmbpasswd\fR(8)
    3896 man page for more information on how to accomplish this\.
     4544man page for more information on how to accomplish this\&.
    38974545.sp
    38984546The
    3899 \fIldap admin dn\fR
    3900 requires a fully specified DN\. The
    3901 \fIldap suffix\fR
     4547\m[blue]\fBldap admin dn\fR\m[]
     4548requires a fully specified DN\&. The
     4549\m[blue]\fBldap suffix\fR\m[]
    39024550is not appended to the
    3903 \fIldap admin dn\fR\.
     4551\m[blue]\fBldap admin dn\fR\m[]\&.
    39044552.sp
    39054553\fINo default\fR
     
    39074555
    39084556ldap connection timeout (G)
    3909 .PP
    3910 .RS 4
    3911 This parameter tells the LDAP library calls which timeout in seconds they should honor during initial connection establishments to LDAP servers\. It is very useful in failover scenarios in particular\. If one or more LDAP servers are not reachable at all, we do not have to wait until TCP timeouts are over\. This feature must be supported by your LDAP library\.
     4557.\" ldap connection timeout
     4558.PP
     4559.RS 4
     4560This parameter tells the LDAP library calls which timeout in seconds they should honor during initial connection establishments to LDAP servers\&. It is very useful in failover scenarios in particular\&. If one or more LDAP servers are not reachable at all, we do not have to wait until TCP timeouts are over\&. This feature must be supported by your LDAP library\&.
    39124561.sp
    39134562This parameter is different from
    3914 \fIldap timeout\fR
    3915 which affects operations on LDAP servers using an existing connection and not establishing an initial connection\.
    3916 .sp
    3917 Default:
    3918 \fI\fIldap connection timeout\fR\fR\fI = \fR\fI2\fR\fI \fR
     4563\m[blue]\fBldap timeout\fR\m[]
     4564which affects operations on LDAP servers using an existing connection and not establishing an initial connection\&.
     4565.sp
     4566Default:
     4567\fI\fIldap connection timeout\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
    39194568.RE
    39204569
    39214570ldap debug level (G)
    3922 .PP
    3923 .RS 4
    3924 This parameter controls the debug level of the LDAP library calls\. In the case of OpenLDAP, it is the same bit\-field as understood by the server and documented in the
     4571.\" ldap debug level
     4572.PP
     4573.RS 4
     4574This parameter controls the debug level of the LDAP library calls\&. In the case of OpenLDAP, it is the same bit\-field as understood by the server and documented in the
    39254575\fBslapd.conf\fR(5)
    3926 manpage\. A typical useful value will be
     4576manpage\&. A typical useful value will be
    39274577\fI1\fR
    3928 for tracing function calls\.
    3929 .sp
    3930 The debug ouput from the LDAP libraries appears with the prefix [LDAP] in Samba\'s logging output\. The level at which LDAP logging is printed is controlled by the parameter
    3931 \fIldap debug threshold\fR\.
    3932 .sp
    3933 Default:
    3934 \fI\fIldap debug level\fR\fR\fI = \fR\fI0\fR\fI \fR
    3935 .sp
    3936 Example:
    3937 \fI\fIldap debug level\fR\fR\fI = \fR\fI1\fR\fI \fR
     4578for tracing function calls\&.
     4579.sp
     4580The debug ouput from the LDAP libraries appears with the prefix [LDAP] in Samba\'s logging output\&. The level at which LDAP logging is printed is controlled by the parameter
     4581\fIldap debug threshold\fR\&.
     4582.sp
     4583Default:
     4584\fI\fIldap debug level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     4585.sp
     4586Example:
     4587\fI\fIldap debug level\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
    39384588.RE
    39394589
    39404590ldap debug threshold (G)
    3941 .PP
    3942 .RS 4
    3943 This parameter controls the Samba debug level at which the ldap library debug output is printed in the Samba logs\. See the description of
     4591.\" ldap debug threshold
     4592.PP
     4593.RS 4
     4594This parameter controls the Samba debug level at which the ldap library debug output is printed in the Samba logs\&. See the description of
    39444595\fIldap debug level\fR
    3945 for details\.
    3946 .sp
    3947 Default:
    3948 \fI\fIldap debug threshold\fR\fR\fI = \fR\fI10\fR\fI \fR
    3949 .sp
    3950 Example:
    3951 \fI\fIldap debug threshold\fR\fR\fI = \fR\fI5\fR\fI \fR
     4596for details\&.
     4597.sp
     4598Default:
     4599\fI\fIldap debug threshold\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
     4600.sp
     4601Example:
     4602\fI\fIldap debug threshold\fR\fR\fI = \fR\fI\FC5\F[]\fR\fI \fR
    39524603.RE
    39534604
    39544605ldap delete dn (G)
    3955 .PP
    3956 .RS 4
    3957 This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\.
    3958 .sp
    3959 Default:
    3960 \fI\fIldap delete dn\fR\fR\fI = \fR\fIno\fR\fI \fR
     4606.\" ldap delete dn
     4607.PP
     4608.RS 4
     4609This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\&.
     4610.sp
     4611Default:
     4612\fI\fIldap delete dn\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    39614613.RE
    39624614
    39634615ldap group suffix (G)
    3964 .PP
    3965 .RS 4
    3966 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
    3967 \fIldap suffix\fR
    3968 will be used instead\. The suffix string is pre\-pended to the
    3969 \fIldap suffix\fR
    3970 string so use a partial DN\.
    3971 .sp
    3972 Default:
    3973 \fI\fIldap group suffix\fR\fR\fI = \fR\fI\fR\fI \fR
    3974 .sp
    3975 Example:
    3976 \fI\fIldap group suffix\fR\fR\fI = \fR\fIou=Groups\fR\fI \fR
     4616.\" ldap group suffix
     4617.PP
     4618.RS 4
     4619This 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
     4620\m[blue]\fBldap suffix\fR\m[]
     4621will be used instead\&. The suffix string is pre\-pended to the
     4622\m[blue]\fBldap suffix\fR\m[]
     4623string so use a partial DN\&.
     4624.sp
     4625Default:
     4626\fI\fIldap group suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4627.sp
     4628Example:
     4629\fI\fIldap group suffix\fR\fR\fI = \fR\fI\FCou=Groups\F[]\fR\fI \fR
    39774630.RE
    39784631
    39794632ldap idmap suffix (G)
    3980 .PP
    3981 .RS 4
    3982 This parameters specifies the suffix that is used when storing idmap mappings\. If this parameter is unset, the value of
    3983 \fIldap suffix\fR
    3984 will be used instead\. The suffix string is pre\-pended to the
    3985 \fIldap suffix\fR
    3986 string so use a partial DN\.
    3987 .sp
    3988 Default:
    3989 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\fR\fI \fR
    3990 .sp
    3991 Example:
    3992 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fIou=Idmap\fR\fI \fR
     4633.\" ldap idmap suffix
     4634.PP
     4635.RS 4
     4636This parameters specifies the suffix that is used when storing idmap mappings\&. If this parameter is unset, the value of
     4637\m[blue]\fBldap suffix\fR\m[]
     4638will be used instead\&. The suffix string is pre\-pended to the
     4639\m[blue]\fBldap suffix\fR\m[]
     4640string so use a partial DN\&.
     4641.sp
     4642Default:
     4643\fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4644.sp
     4645Example:
     4646\fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\FCou=Idmap\F[]\fR\fI \fR
    39934647.RE
    39944648
    39954649ldap machine suffix (G)
    3996 .PP
    3997 .RS 4
    3998 It specifies where machines should be added to the ldap tree\. If this parameter is unset, the value of
    3999 \fIldap suffix\fR
    4000 will be used instead\. The suffix string is pre\-pended to the
    4001 \fIldap suffix\fR
    4002 string so use a partial DN\.
    4003 .sp
    4004 Default:
    4005 \fI\fIldap machine suffix\fR\fR\fI = \fR\fI\fR\fI \fR
    4006 .sp
    4007 Example:
    4008 \fI\fIldap machine suffix\fR\fR\fI = \fR\fIou=Computers\fR\fI \fR
     4650.\" ldap machine suffix
     4651.PP
     4652.RS 4
     4653It specifies where machines should be added to the ldap tree\&. If this parameter is unset, the value of
     4654\m[blue]\fBldap suffix\fR\m[]
     4655will be used instead\&. The suffix string is pre\-pended to the
     4656\m[blue]\fBldap suffix\fR\m[]
     4657string so use a partial DN\&.
     4658.sp
     4659Default:
     4660\fI\fIldap machine suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4661.sp
     4662Example:
     4663\fI\fIldap machine suffix\fR\fR\fI = \fR\fI\FCou=Computers\F[]\fR\fI \fR
    40094664.RE
    40104665
    40114666ldap passwd sync (G)
    4012 .PP
    4013 .RS 4
    4014 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\.
     4667.\" ldap passwd sync
     4668.PP
     4669.RS 4
     4670This 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\&.
    40154671.sp
    40164672The
    4017 \fIldap passwd sync\fR
     4673\m[blue]\fBldap passwd sync\fR\m[]
    40184674can be set to one of three values:
    40194675.sp
     
    40274683.\}
    40284684\fIYes\fR
    4029 = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\.
     4685= Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\&.
    40304686.RE
    40314687.sp
     
    40394695.\}
    40404696\fINo\fR
    4041 = Update NT and LM passwords and update the pwdLastSet time\.
     4697= Update NT and LM passwords and update the pwdLastSet time\&.
    40424698.RE
    40434699.sp
     
    40514707.\}
    40524708\fIOnly\fR
    4053 = Only update the LDAP password and let the LDAP server do the rest\.
    4054 .sp
    4055 .RE
    4056 Default:
    4057 \fI\fIldap passwd sync\fR\fR\fI = \fR\fIno\fR\fI \fR
     4709= Only update the LDAP password and let the LDAP server do the rest\&.
     4710.sp
     4711.RE
     4712Default:
     4713\fI\fIldap passwd sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    40584714.RE
    40594715
    40604716ldap replication sleep (G)
    4061 .PP
    4062 .RS 4
    4063 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\.
    4064 .sp
    4065 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\.
    4066 .sp
    4067 The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\.
    4068 .sp
    4069 Default:
    4070 \fI\fIldap replication sleep\fR\fR\fI = \fR\fI1000\fR\fI \fR
     4717.\" ldap replication sleep
     4718.PP
     4719.RS 4
     4720When 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\&.
     4721.sp
     4722This 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\&.
     4723.sp
     4724The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\&.
     4725.sp
     4726Default:
     4727\fI\fIldap replication sleep\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
    40714728.RE
    40724729
    40734730ldapsam:editposix (G)
    4074 .PP
    4075 .RS 4
    4076 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\.
    4077 .sp
    4078 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
    4079 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
    4080 \fIldapsam:trusted = yes\fR
     4731.\" ldapsam:editposix
     4732.PP
     4733.RS 4
     4734Editposix 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\&.
     4735.sp
     4736To 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
     4737\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
     4738\m[blue]\fBldapsam:trusted = yes\fR\m[]
    40814739option is usually sufficient to use
    4082 \fIldapsam:editposix = yes\fR
    4083 as well\.
     4740\m[blue]\fBldapsam:editposix = yes\fR\m[]
     4741as well\&.
    40844742.sp
    40854743An example configuration can be the following:
    40864744.sp
    4087 .RS 4
     4745.if n \{\
     4746.RS 4
     4747.\}
     4748.fam C
     4749.ps -1
    40884750.nf
     4751.if t \{\
     4752.sp -1
     4753.\}
     4754.BB lightgray adjust-for-leading-newline
     4755.sp -1
     4756
    40894757        encrypt passwords = true
    40904758        passdb backend = ldapsam
     
    41064774        idmap gid = 5000\-50000
    41074775       
     4776.EB lightgray adjust-for-leading-newline
     4777.if t \{\
     4778.sp 1
     4779.\}
    41084780.fi
    4109 .RE
     4781.fam
     4782.ps +1
     4783.if n \{\
     4784.RE
     4785.\}
    41104786.sp
    41114787This configuration assumes a directory layout like described in the following ldif:
    41124788.sp
    4113 .RS 4
     4789.if n \{\
     4790.RS 4
     4791.\}
     4792.fam C
     4793.ps -1
    41144794.nf
     4795.if t \{\
     4796.sp -1
     4797.\}
     4798.BB lightgray adjust-for-leading-newline
     4799.sp -1
     4800
    41154801        dn: dc=samba,dc=org
    41164802        objectClass: top
    41174803        objectClass: dcObject
    41184804        objectClass: organization
    4119         o: samba\.org
     4805        o: samba\&.org
    41204806        dc: samba
    41214807
     
    41474833        ou: computers
    41484834       
     4835.EB lightgray adjust-for-leading-newline
     4836.if t \{\
     4837.sp 1
     4838.\}
    41494839.fi
    4150 .RE
    4151 .sp
    4152 .sp
    4153 Default:
    4154 \fI\fIldapsam:editposix\fR\fR\fI = \fR\fIno\fR\fI \fR
     4840.fam
     4841.ps +1
     4842.if n \{\
     4843.RE
     4844.\}
     4845.sp
     4846Default:
     4847\fI\fIldapsam:editposix\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    41554848.RE
    41564849
    41574850ldapsam:trusted (G)
    4158 .PP
    4159 .RS 4
    4160 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\.
     4851.\" ldapsam:trusted
     4852.PP
     4853.RS 4
     4854By 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\&.
    41614855.sp
    41624856To make Samba scale well in large environments, the
    4163 \fIldapsam:trusted = yes\fR
    4164 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,
    4165 \fIldapsam:trusted = yes\fR
    4166 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\.
    4167 .sp
    4168 Default:
    4169 \fI\fIldapsam:trusted\fR\fR\fI = \fR\fIno\fR\fI \fR
     4857\m[blue]\fBldapsam:trusted = yes\fR\m[]
     4858option 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,
     4859\m[blue]\fBldapsam:trusted = yes\fR\m[]
     4860can 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\&.
     4861.sp
     4862Default:
     4863\fI\fIldapsam:trusted\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    41704864.RE
    41714865
    41724866ldap ssl (G)
     4867.\" ldap ssl
    41734868.PP
    41744869.RS 4
     
    41764871\fINOT\fR
    41774872related to Samba\'s previous SSL support which was enabled by specifying the
    4178 \-\-with\-ssl
     4873\FC\-\-with\-ssl\F[]
    41794874option to the
    4180 \fIconfigure\fR
    4181 script\.
     4875\FCconfigure\F[]
     4876script\&.
     4877.sp
     4878LDAP connections should be secured where possible\&. This may be done setting either this parameter to
     4879\fIStart_tls\fR
     4880or by specifying
     4881\fIldaps://\fR
     4882in the URL argument of
     4883\m[blue]\fBpassdb backend\fR\m[]\&.
    41824884.sp
    41834885The
    4184 \fIldap ssl\fR
    4185 can be set to one of three values:
     4886\m[blue]\fBldap ssl\fR\m[]
     4887can be set to one of two values:
    41864888.sp
    41874889.RS 4
     
    41944896.\}
    41954897\fIOff\fR
    4196 = Never use SSL when querying the directory\.
     4898= Never use SSL when querying the directory\&.
    41974899.RE
    41984900.sp
     
    42064908.\}
    42074909\fIStart_tls\fR
    4208 = Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\.
    4209 .RE
    4210 .sp
    4211 .RS 4
    4212 .ie n \{\
    4213 \h'-04'\(bu\h'+03'\c
    4214 .\}
    4215 .el \{\
    4216 .sp -1
    4217 .IP \(bu 2.3
    4218 .\}
    4219 \fIOn\fR
    4220 = Use SSL on the ldaps port when contacting the
    4221 \fIldap server\fR\. Only available when the backwards\-compatiblity
    4222 \-\-with\-ldapsam
    4223 option is specified to configure\. See
    4224 \fIpassdb backend\fR
    4225 \.
    4226                 .sp
    4227 .RE
    4228 Default:
    4229 \fI\fIldap ssl\fR\fR\fI = \fR\fIstart_tls\fR\fI \fR
     4910= Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\&.
     4911.sp
     4912.RE
     4913Default:
     4914\fI\fIldap ssl\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    42304915.RE
    42314916
    42324917ldap suffix (G)
    4233 .PP
    4234 .RS 4
    4235 Specifies the base for all ldap suffixes and for storing the sambaDomain object\.
     4918.\" ldap suffix
     4919.PP
     4920.RS 4
     4921Specifies the base for all ldap suffixes and for storing the sambaDomain object\&.
    42364922.sp
    42374923The ldap suffix will be appended to the values specified for the
    4238 \fIldap user suffix\fR,
    4239 \fIldap group suffix\fR,
    4240 \fIldap machine suffix\fR, and the
    4241 \fIldap idmap suffix\fR\. Each of these should be given only a DN relative to the
    4242 \fIldap suffix\fR\.
    4243 .sp
    4244 Default:
    4245 \fI\fIldap suffix\fR\fR\fI = \fR\fI\fR\fI \fR
    4246 .sp
    4247 Example:
    4248 \fI\fIldap suffix\fR\fR\fI = \fR\fIdc=samba,dc=org\fR\fI \fR
     4924\m[blue]\fBldap user suffix\fR\m[],
     4925\m[blue]\fBldap group suffix\fR\m[],
     4926\m[blue]\fBldap machine suffix\fR\m[], and the
     4927\m[blue]\fBldap idmap suffix\fR\m[]\&. Each of these should be given only a DN relative to the
     4928\m[blue]\fBldap suffix\fR\m[]\&.
     4929.sp
     4930Default:
     4931\fI\fIldap suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4932.sp
     4933Example:
     4934\fI\fIldap suffix\fR\fR\fI = \fR\fI\FCdc=samba,dc=org\F[]\fR\fI \fR
    42494935.RE
    42504936
    42514937ldap timeout (G)
    4252 .PP
    4253 .RS 4
    4254 When Samba connects to an ldap server that server may 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\.
    4255 .sp
    4256 Default:
    4257 \fI\fIldap timeout\fR\fR\fI = \fR\fI15\fR\fI \fR
     4938.\" ldap timeout
     4939.PP
     4940.RS 4
     4941This parameter defines the number of seconds that Samba should use as timeout for LDAP operations\&.
     4942.sp
     4943Default:
     4944\fI\fIldap timeout\fR\fR\fI = \fR\fI\FC15\F[]\fR\fI \fR
    42584945.RE
    42594946
    42604947ldap user suffix (G)
    4261 .PP
    4262 .RS 4
    4263 This parameter specifies where users are added to the tree\. If this parameter is unset, the value of
    4264 \fIldap suffix\fR
    4265 will be used instead\. The suffix string is pre\-pended to the
    4266 \fIldap suffix\fR
    4267 string so use a partial DN\.
    4268 .sp
    4269 Default:
    4270 \fI\fIldap user suffix\fR\fR\fI = \fR\fI\fR\fI \fR
    4271 .sp
    4272 Example:
    4273 \fI\fIldap user suffix\fR\fR\fI = \fR\fIou=people\fR\fI \fR
     4948.\" ldap user suffix
     4949.PP
     4950.RS 4
     4951This parameter specifies where users are added to the tree\&. If this parameter is unset, the value of
     4952\m[blue]\fBldap suffix\fR\m[]
     4953will be used instead\&. The suffix string is pre\-pended to the
     4954\m[blue]\fBldap suffix\fR\m[]
     4955string so use a partial DN\&.
     4956.sp
     4957Default:
     4958\fI\fIldap user suffix\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     4959.sp
     4960Example:
     4961\fI\fIldap user suffix\fR\fR\fI = \fR\fI\FCou=people\F[]\fR\fI \fR
    42744962.RE
    42754963
    42764964level2 oplocks (S)
    4277 .PP
    4278 .RS 4
    4279 This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\.
    4280 .sp
    4281 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)\.
    4282 .sp
    4283 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\.
    4284 .sp
    4285 It is recommended that this parameter be turned on to speed access to shared executables\.
    4286 .sp
    4287 For more discussions on level2 oplocks see the CIFS spec\.
     4965.\" level2 oplocks
     4966.PP
     4967.RS 4
     4968This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\&.
     4969.sp
     4970Level2, 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)\&.
     4971.sp
     4972Once 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\&.
     4973.sp
     4974It is recommended that this parameter be turned on to speed access to shared executables\&.
     4975.sp
     4976For more discussions on level2 oplocks see the CIFS spec\&.
    42884977.sp
    42894978Currently, if
    4290 \fIkernel oplocks\fR
     4979\m[blue]\fBkernel oplocks\fR\m[]
    42914980are supported then level2 oplocks are not granted (even if this parameter is set to
    4292 \fByes\fR)\. Note also, the
    4293 \fIoplocks\fR
     4981\fByes\fR)\&. Note also, the
     4982\m[blue]\fBoplocks\fR\m[]
    42944983parameter must be set to
    42954984\fByes\fR
    4296 on this share in order for this parameter to have any effect\.
    4297 .sp
    4298 Default:
    4299 \fI\fIlevel2 oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
     4985on this share in order for this parameter to have any effect\&.
     4986.sp
     4987Default:
     4988\fI\fIlevel2 oplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    43004989.RE
    43014990
    43024991lm announce (G)
     4992.\" lm announce
    43034993.PP
    43044994.RS 4
    43054995This parameter determines if
    43064996\fBnmbd\fR(8)
    4307 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,
     4997will 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,
    43084998\fByes\fR,
    43094999\fBno\fR, or
    4310 \fBauto\fR\. The default is
    4311 \fBauto\fR\. If set to
     5000\fBauto\fR\&. The default is
     5001\fBauto\fR\&. If set to
    43125002\fBno\fR
    4313 Samba will never produce these broadcasts\. If set to
     5003Samba will never produce these broadcasts\&. If set to
    43145004\fByes\fR
    43155005Samba will produce Lanman announce broadcasts at a frequency set by the parameter
    4316 \fIlm interval\fR\. If set to
     5006\m[blue]\fBlm interval\fR\m[]\&. If set to
    43175007\fBauto\fR
    4318 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
    4319 \fIlm interval\fR\.
    4320 .sp
    4321 Default:
    4322 \fI\fIlm announce\fR\fR\fI = \fR\fIauto\fR\fI \fR
    4323 .sp
    4324 Example:
    4325 \fI\fIlm announce\fR\fR\fI = \fR\fIyes\fR\fI \fR
     5008Samba 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
     5009\m[blue]\fBlm interval\fR\m[]\&.
     5010.sp
     5011Default:
     5012\fI\fIlm announce\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
     5013.sp
     5014Example:
     5015\fI\fIlm announce\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    43265016.RE
    43275017
    43285018lm interval (G)
     5019.\" lm interval
    43295020.PP
    43305021.RS 4
    43315022If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the
    4332 \fIlm announce\fR
    4333 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
    4334 \fIlm announce\fR
    4335 parameter\.
    4336 .sp
    4337 Default:
    4338 \fI\fIlm interval\fR\fR\fI = \fR\fI60\fR\fI \fR
    4339 .sp
    4340 Example:
    4341 \fI\fIlm interval\fR\fR\fI = \fR\fI120\fR\fI \fR
     5023\m[blue]\fBlm announce\fR\m[]
     5024parameter) 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
     5025\m[blue]\fBlm announce\fR\m[]
     5026parameter\&.
     5027.sp
     5028Default:
     5029\fI\fIlm interval\fR\fR\fI = \fR\fI\FC60\F[]\fR\fI \fR
     5030.sp
     5031Example:
     5032\fI\fIlm interval\fR\fR\fI = \fR\fI\FC120\F[]\fR\fI \fR
    43425033.RE
    43435034
    43445035load printers (G)
    4345 .PP
    4346 .RS 4
    4347 A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\. See the
    4348 \fIprinters\fR
    4349 section for more details\.
    4350 .sp
    4351 Default:
    4352 \fI\fIload printers\fR\fR\fI = \fR\fIyes\fR\fI \fR
     5036.\" load printers
     5037.PP
     5038.RS 4
     5039A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\&. See the
     5040\m[blue]\fBprinters\fR\m[]
     5041section for more details\&.
     5042.sp
     5043Default:
     5044\fI\fIload printers\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    43535045.RE
    43545046
    43555047local master (G)
     5048.\" local master
    43565049.PP
    43575050.RS 4
    43585051This option allows
    43595052\fBnmbd\fR(8)
    4360 to try and become a local master browser on a subnet\. If set to
     5053to try and become a local master browser on a subnet\&. If set to
    43615054\fBno\fR
    43625055then
    4363 nmbd
    4364 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
    4365 \fByes\fR\. Setting this value to
     5056\FC nmbd\F[]
     5057will 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
     5058\fByes\fR\&. Setting this value to
    43665059\fByes\fR
    43675060doesn\'t mean that Samba will
    43685061\fIbecome\fR
    43695062the local master browser on a subnet, just that
    4370 nmbd
     5063\FCnmbd\F[]
    43715064will
    43725065\fIparticipate\fR
    4373 in elections for local master browser\.
     5066in elections for local master browser\&.
    43745067.sp
    43755068Setting this value to
    43765069\fBno\fR
    43775070will cause
    4378 nmbd
     5071\FCnmbd\F[]
    43795072\fInever\fR
    4380 to become a local master browser\.
    4381 .sp
    4382 Default:
    4383 \fI\fIlocal master\fR\fR\fI = \fR\fIyes\fR\fI \fR
     5073to become a local master browser\&.
     5074.sp
     5075Default:
     5076\fI\fIlocal master\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    43845077.RE
    43855078
    43865079lock dir
     5080.\" lock dir
    43875081.PP
    43885082.RS 4
    43895083This parameter is a synonym for
    4390 lock directory\.
     5084lock directory\&.
    43915085.RE
    43925086
    43935087lock directory (G)
    4394 .PP
    4395 .RS 4
    4396 This option specifies the directory where lock files will be placed\. The lock files are used to implement the
    4397 \fImax connections\fR
    4398 option\.
    4399 .sp
    4400 Note: This option can not be set inside registry configurations\.
    4401 .sp
    4402 Default:
    4403 \fI\fIlock directory\fR\fR\fI = \fR\fI${prefix}/var/locks\fR\fI \fR
    4404 .sp
    4405 Example:
    4406 \fI\fIlock directory\fR\fR\fI = \fR\fI/var/run/samba/locks\fR\fI \fR
     5088.\" lock directory
     5089.PP
     5090.RS 4
     5091This option specifies the directory where lock files will be placed\&. The lock files are used to implement the
     5092\m[blue]\fBmax connections\fR\m[]
     5093option\&.
     5094.sp
     5095Note: This option can not be set inside registry configurations\&.
     5096.sp
     5097Default:
     5098\fI\fIlock directory\fR\fR\fI = \fR\fI\FC${prefix}/var/locks\F[]\fR\fI \fR
     5099.sp
     5100Example:
     5101\fI\fIlock directory\fR\fR\fI = \fR\fI\FC/var/run/samba/locks\F[]\fR\fI \fR
    44075102.RE
    44085103
    44095104locking (S)
    4410 .PP
    4411 .RS 4
    4412 This controls whether or not locking will be performed by the server in response to lock requests from the client\.
     5105.\" locking
     5106.PP
     5107.RS 4
     5108This controls whether or not locking will be performed by the server in response to lock requests from the client\&.
    44135109.sp
    44145110If
    4415 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\.
     5111\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\&.
    44165112.sp
    44175113If
    4418 locking = yes, real locking will be performed by the server\.
     5114\FClocking = yes\F[], real locking will be performed by the server\&.
    44195115.sp
    44205116This option
     
    44245120not need locking (such as CDROM drives), although setting this parameter of
    44255121\fBno\fR
    4426 is not really recommended even in this case\.
    4427 .sp
    4428 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\.
     5122is not really recommended even in this case\&.
     5123.sp
     5124Be 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\&.
    44295125.sp
    44305126\fINo default\fR
     
    44325128
    44335129lock spin count (G)
    4434 .PP
    4435 .RS 4
    4436 This parameter has been made inoperative in Samba 3\.0\.24\. The functionality it contolled is now controlled by the parameter
    4437 \fIlock spin time\fR\.
    4438 .sp
    4439 Default:
    4440 \fI\fIlock spin count\fR\fR\fI = \fR\fI0\fR\fI \fR
     5130.\" lock spin count
     5131.PP
     5132.RS 4
     5133This parameter has been made inoperative in Samba 3\&.0\&.24\&. The functionality it contolled is now controlled by the parameter
     5134\m[blue]\fBlock spin time\fR\m[]\&.
     5135.sp
     5136Default:
     5137\fI\fIlock spin count\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    44415138.RE
    44425139
    44435140lock spin time (G)
    4444 .PP
    4445 .RS 4
    4446 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
    4447 \fIlock spin count\fR
    4448 parameter is no longer used in Samba 3\.0\.24\. You should not need to change the value of this parameter\.
    4449 .sp
    4450 Default:
    4451 \fI\fIlock spin time\fR\fR\fI = \fR\fI200\fR\fI \fR
     5141.\" lock spin time
     5142.PP
     5143.RS 4
     5144The 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
     5145\m[blue]\fBlock spin count\fR\m[]
     5146parameter is no longer used in Samba 3\&.0\&.24\&. You should not need to change the value of this parameter\&.
     5147.sp
     5148Default:
     5149\fI\fIlock spin time\fR\fR\fI = \fR\fI\FC200\F[]\fR\fI \fR
    44525150.RE
    44535151
    44545152log file (G)
    4455 .PP
    4456 .RS 4
    4457 This option allows you to override the name of the Samba log file (also known as the debug file)\.
    4458 .sp
    4459 This option takes the standard substitutions, allowing you to have separate log files for each user or machine\.
     5153.\" log file
     5154.PP
     5155.RS 4
     5156This option allows you to override the name of the Samba log file (also known as the debug file)\&.
     5157.sp
     5158This option takes the standard substitutions, allowing you to have separate log files for each user or machine\&.
    44605159.sp
    44615160\fINo default\fR
    44625161.sp
    44635162Example:
    4464 \fI\fIlog file\fR\fR\fI = \fR\fI/usr/local/samba/var/log\.%m\fR\fI \fR
     5163\fI\fIlog file\fR\fR\fI = \fR\fI\FC/usr/local/samba/var/log\&.%m\F[]\fR\fI \fR
    44655164.RE
    44665165
    44675166debuglevel
     5167.\" debuglevel
    44685168.PP
    44695169.RS 4
    44705170This parameter is a synonym for
    4471 log level\.
     5171log level\&.
    44725172.RE
    44735173
    44745174log level (G)
     5175.\" log level
    44755176.PP
    44765177.RS 4
    44775178The value of the parameter (a astring) allows the debug level (logging level) to be specified in the
    4478 \fIsmb\.conf\fR
    4479 file\.
    4480 .sp
    4481 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:
     5179\FCsmb\&.conf\F[]
     5180file\&.
     5181.sp
     5182This 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:
    44825183.sp
    44835184.RS 4
     
    47025403.RE
    47035404Default:
    4704 \fI\fIlog level\fR\fR\fI = \fR\fI0\fR\fI \fR
    4705 .sp
    4706 Example:
    4707 \fI\fIlog level\fR\fR\fI = \fR\fI3 passdb:5 auth:10 winbind:2\fR\fI \fR
     5405\fI\fIlog level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     5406.sp
     5407Example:
     5408\fI\fIlog level\fR\fR\fI = \fR\fI\FC3 passdb:5 auth:10 winbind:2\F[]\fR\fI \fR
    47085409.RE
    47095410
    47105411logon drive (G)
     5412.\" logon drive
    47115413.PP
    47125414.RS 4
    47135415This parameter specifies the local path to which the home directory will be connected (see
    4714 \fIlogon home\fR) and is only used by NT Workstations\.
    4715 .sp
    4716 Note that this option is only useful if Samba is set up as a logon server\.
    4717 .sp
    4718 Default:
    4719 \fI\fIlogon drive\fR\fR\fI = \fR\fI\fR\fI \fR
    4720 .sp
    4721 Example:
    4722 \fI\fIlogon drive\fR\fR\fI = \fR\fIh:\fR\fI \fR
     5416\m[blue]\fBlogon home\fR\m[]) and is only used by NT Workstations\&.
     5417.sp
     5418Note that this option is only useful if Samba is set up as a logon server\&.
     5419.sp
     5420Default:
     5421\fI\fIlogon drive\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     5422.sp
     5423Example:
     5424\fI\fIlogon drive\fR\fR\fI = \fR\fI\FCh:\F[]\fR\fI \fR
    47235425.RE
    47245426
    47255427logon home (G)
    4726 .PP
    4727 .RS 4
    4728 This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\. It allows you to do
    4729 .sp
    4730 
    4731 C:\e>\fBNET USE H: /HOME\fR
    4732 .sp
    4733 from a command prompt, for example\.
    4734 .sp
    4735 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\.
    4736 .sp
    4737 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:
    4738 .sp
    4739 
    4740 logon home = \e\e%N\e%U\eprofile
    4741 .sp
    4742 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
    4743 net use /home
    4744 but use the whole string when dealing with profiles\.
     5428.\" logon home
     5429.PP
     5430.RS 4
     5431This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\&. It allows you to do
     5432.sp
     5433
     5434\FCC:\e>\F[]\fBNET USE H: /HOME\fR
     5435.sp
     5436from a command prompt, for example\&.
     5437.sp
     5438This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
     5439.sp
     5440This 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:
     5441.sp
     5442
     5443\FClogon home = \e\e%N\e%U\eprofile\F[]
     5444.sp
     5445This 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
     5446\FCnet use /home\F[]
     5447but use the whole string when dealing with profiles\&.
    47455448.sp
    47465449Note that in prior versions of Samba, the
    4747 \fIlogon path\fR
     5450\m[blue]\fBlogon path\fR\m[]
    47485451was returned rather than
    4749 \fIlogon home\fR\. This broke
    4750 net use /home
    4751 but allowed profiles outside the home directory\. The current implementation is correct, and can be used for profiles if you use the above trick\.
     5452\fIlogon home\fR\&. This broke
     5453\FCnet use /home\F[]
     5454but allowed profiles outside the home directory\&. The current implementation is correct, and can be used for profiles if you use the above trick\&.
    47525455.sp
    47535456Disable this feature by setting
    4754 \fIlogon home = ""\fR
    4755 \- using the empty string\.
    4756 .sp
    4757 This option is only useful if Samba is set up as a logon server\.
    4758 .sp
    4759 Default:
    4760 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\e%N\e%U\fR\fI \fR
    4761 .sp
    4762 Example:
    4763 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\eremote_smb_server\e%U\fR\fI \fR
     5457\m[blue]\fBlogon home = ""\fR\m[]
     5458\- using the empty string\&.
     5459.sp
     5460This option is only useful if Samba is set up as a logon server\&.
     5461.sp
     5462Default:
     5463\fI\fIlogon home\fR\fR\fI = \fR\fI\FC\e\e%N\e%U\F[]\fR\fI \fR
     5464.sp
     5465Example:
     5466\fI\fIlogon home\fR\fR\fI = \fR\fI\FC\e\eremote_smb_server\e%U\F[]\fR\fI \fR
    47645467.RE
    47655468
    47665469logon path (G)
    4767 .PP
    4768 .RS 4
    4769 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
    4770 \fIlogon home\fR
    4771 parameter\.
    4772 .sp
    4773 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",
    4774 \fIdesktop\fR,
    4775 \fIstart menu\fR,
    4776 \fInetwork neighborhood\fR,
    4777 \fIprograms\fR
    4778 and other folders, and their contents, are loaded and displayed on your Windows NT client\.
    4779 .sp
    4780 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
    4781 \fIMAN\fRdatory profile)\.
    4782 .sp
    4783 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)\.
    4784 .sp
    4785 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\.
    4786 .sp
     5470.\" logon path
     5471.PP
     5472.RS 4
     5473This 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
     5474\m[blue]\fBlogon home\fR\m[]
     5475parameter\&.
     5476.sp
     5477This 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",
     5478\FCdesktop\F[],
     5479\FCstart menu\F[],
     5480\FCnetwork neighborhood\F[],
     5481\FCprograms\F[]
     5482and other folders, and their contents, are loaded and displayed on your Windows NT client\&.
     5483.sp
     5484The 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
     5485\fIMAN\fRdatory profile)\&.
     5486.sp
     5487Windows 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)\&.
     5488.sp
     5489This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
     5490.if n \{\
     5491.sp
     5492.\}
     5493.RS 4
     5494.BM yellow
    47875495.it 1 an-trap
    47885496.nr an-no-space-flag 1
    47895497.nr an-break-flag 1
    47905498.br
    4791 Warning
    4792 Do not quote the value\. Setting this as
     5499.ps +1
     5500\fBWarning\fR
     5501.ps -1
     5502.br
     5503Do not quote the value\&. Setting this as
    47935504\(lq\e\e%N\eprofile\e%U\(rq
    4794 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)\.
    4795 
    4796 Note that this option is only useful if Samba is set up as a domain controller\.
    4797 .sp
    4798 Disable the use of roaming profiles by setting the value of this parameter to the empty string\. For example,
    4799 \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\.
     5505will 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)\&.
     5506.sp .5v
     5507.EM yellow
     5508.RE
     5509Note that this option is only useful if Samba is set up as a domain controller\&.
     5510.sp
     5511Disable the use of roaming profiles by setting the value of this parameter to the empty string\&. For example,
     5512\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\&.
    48005513.sp
    48015514An example of use is:
    48025515.sp
    4803 .RS 4
     5516.if n \{\
     5517.RS 4
     5518.\}
     5519.fam C
     5520.ps -1
    48045521.nf
     5522.if t \{\
     5523.sp -1
     5524.\}
     5525.BB lightgray adjust-for-leading-newline
     5526.sp -1
     5527
    48055528logon path = \e\ePROFILESERVER\ePROFILE\e%U
     5529.EB lightgray adjust-for-leading-newline
     5530.if t \{\
     5531.sp 1
     5532.\}
    48065533.fi
    4807 .RE
    4808 .sp
    4809 .sp
    4810 Default:
    4811 \fI\fIlogon path\fR\fR\fI = \fR\fI\e\e%N\e%U\eprofile\fR\fI \fR
     5534.fam
     5535.ps +1
     5536.if n \{\
     5537.RE
     5538.\}
     5539.sp
     5540Default:
     5541\fI\fIlogon path\fR\fR\fI = \fR\fI\FC\e\e%N\e%U\eprofile\F[]\fR\fI \fR
    48125542.RE
    48135543
    48145544logon script (G)
    4815 .PP
    4816 .RS 4
    4817 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\.
     5545.\" logon script
     5546.PP
     5547.RS 4
     5548This 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\&.
    48185549.sp
    48195550The script must be a relative path to the
    48205551\fI[netlogon]\fR
    4821 service\. If the [netlogon] service specifies a
    4822 \fIpath\fR
     5552service\&. If the [netlogon] service specifies a
     5553\m[blue]\fBpath\fR\m[]
    48235554of
    4824 \fI/usr/local/samba/netlogon\fR, and
    4825 \fIlogon script = STARTUP\.BAT\fR, then the file that will be downloaded is:
    4826 .sp
    4827 .RS 4
     5555\FC/usr/local/samba/netlogon\F[], and
     5556\m[blue]\fBlogon script = STARTUP\&.BAT\fR\m[], then the file that will be downloaded is:
     5557.sp
     5558.if n \{\
     5559.RS 4
     5560.\}
     5561.fam C
     5562.ps -1
    48285563.nf
    4829         /usr/local/samba/netlogon/STARTUP\.BAT
     5564.if t \{\
     5565.sp -1
     5566.\}
     5567.BB lightgray adjust-for-leading-newline
     5568.sp -1
     5569
     5570        /usr/local/samba/netlogon/STARTUP\&.BAT
     5571.EB lightgray adjust-for-leading-newline
     5572.if t \{\
     5573.sp 1
     5574.\}
    48305575.fi
    4831 .RE
    4832 .sp
    4833 .sp
    4834 The contents of the batch file are entirely your choice\. A suggested command would be to add
    4835 NET TIME \e\eSERVER /SET /YES, to force every machine to synchronize clocks with the same time server\. Another use would be to add
    4836 NET USE U: \e\eSERVER\eUTILS
     5576.fam
     5577.ps +1
     5578.if n \{\
     5579.RE
     5580.\}
     5581.sp
     5582The contents of the batch file are entirely your choice\&. A suggested command would be to add
     5583\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
     5584\FCNET USE U: \e\eSERVER\eUTILS\F[]
    48375585for commonly used utilities, or
    48385586.sp
    4839 .RS 4
     5587.if n \{\
     5588.RS 4
     5589.\}
     5590.fam C
     5591.ps -1
    48405592.nf
     5593.if t \{\
     5594.sp -1
     5595.\}
     5596.BB lightgray adjust-for-leading-newline
     5597.sp -1
     5598
    48415599\fBNET USE Q: \e\eSERVER\eISO9001_QA\fR
     5600.EB lightgray adjust-for-leading-newline
     5601.if t \{\
     5602.sp 1
     5603.\}
    48425604.fi
    4843 .RE
    4844 .sp
    4845 for example\.
    4846 .sp
    4847 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\.
    4848 .sp
    4849 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\.
    4850 .sp
    4851 This option is only useful if Samba is set up as a logon server\.
    4852 .sp
    4853 Default:
    4854 \fI\fIlogon script\fR\fR\fI = \fR\fI\fR\fI \fR
    4855 .sp
    4856 Example:
    4857 \fI\fIlogon script\fR\fR\fI = \fR\fIscripts\e%U\.bat\fR\fI \fR
     5605.fam
     5606.ps +1
     5607.if n \{\
     5608.RE
     5609.\}
     5610.sp
     5611for example\&.
     5612.sp
     5613Note 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\&.
     5614.sp
     5615This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
     5616.sp
     5617This option is only useful if Samba is set up as a logon server\&.
     5618.sp
     5619Default:
     5620\fI\fIlogon script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     5621.sp
     5622Example:
     5623\fI\fIlogon script\fR\fR\fI = \fR\fI\FCscripts\e%U\&.bat\F[]\fR\fI \fR
    48585624.RE
    48595625
    48605626lppause command (S)
    4861 .PP
    4862 .RS 4
    4863 This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\.
    4864 .sp
    4865 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\.
     5627.\" lppause command
     5628.PP
     5629.RS 4
     5630This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\&.
     5631.sp
     5632This 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\&.
    48665633.sp
    48675634If a
    48685635\fI%p\fR
    4869 is given then the printer name is put in its place\. A
     5636is given then the printer name is put in its place\&. A
    48705637\fI%j\fR
    4871 is replaced with the job number (an integer)\. On HPUX (see
     5638is replaced with the job number (an integer)\&. On HPUX (see
    48725639\fIprinting=hpux \fR), if the
    48735640\fI\-p%p\fR
    4874 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\.
    4875 .sp
    4876 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\.
    4877 .sp
    4878 Default:
    4879 \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
    4880 .sp
    4881 Example:
    4882 \fI\fIlppause command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p0\fR\fI \fR
     5641option 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\&.
     5642.sp
     5643Note that it is good practice to include the absolute path in the lppause command as the PATH may not be available to the server\&.
     5644.sp
     5645Default:
     5646\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
     5647.sp
     5648Example:
     5649\fI\fIlppause command\fR\fR\fI = \fR\fI\FC/usr/bin/lpalt %p\-%j \-p0\F[]\fR\fI \fR
    48835650.RE
    48845651
    48855652lpq cache time (G)
     5653.\" lpq cache time
    48865654.PP
    48875655.RS 4
    48885656This controls how long lpq info will be cached for to prevent the
    4889 lpq
    4890 command being called too often\. A separate cache is kept for each variation of the
    4891 lpq
     5657\FClpq\F[]
     5658command being called too often\&. A separate cache is kept for each variation of the
     5659\FC lpq\F[]
    48925660command used by the system, so if you use different
    4893 lpq
    4894 commands for different users then they won\'t share cache information\.
     5661\FClpq\F[]
     5662commands for different users then they won\'t share cache information\&.
    48955663.sp
    48965664The cache files are stored in
    4897 \fI/tmp/lpq\.xxxx\fR
     5665\FC/tmp/lpq\&.xxxx\F[]
    48985666where xxxx is a hash of the
    4899 lpq
    4900 command in use\.
     5667\FClpq\F[]
     5668command in use\&.
    49015669.sp
    49025670The default is 30 seconds, meaning that the cached results of a previous identical
    4903 lpq
    4904 command will be used if the cached data is less than 30 seconds old\. A large value may be advisable if your
    4905 lpq
    4906 command is very slow\.
    4907 .sp
    4908 A value of 0 will disable caching completely\.
    4909 .sp
    4910 Default:
    4911 \fI\fIlpq cache time\fR\fR\fI = \fR\fI30\fR\fI \fR
    4912 .sp
    4913 Example:
    4914 \fI\fIlpq cache time\fR\fR\fI = \fR\fI10\fR\fI \fR
     5671\FClpq\F[]
     5672command will be used if the cached data is less than 30 seconds old\&. A large value may be advisable if your
     5673\FClpq\F[]
     5674command is very slow\&.
     5675.sp
     5676A value of 0 will disable caching completely\&.
     5677.sp
     5678Default:
     5679\fI\fIlpq cache time\fR\fR\fI = \fR\fI\FC30\F[]\fR\fI \fR
     5680.sp
     5681Example:
     5682\fI\fIlpq cache time\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
    49155683.RE
    49165684
    49175685lpq command (S)
     5686.\" lpq command
    49185687.PP
    49195688.RS 4
    49205689This parameter specifies the command to be executed on the server host in order to obtain
    4921 lpq\-style printer status information\.
    4922 .sp
    4923 This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\.
    4924 .sp
    4925 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
     5690\FClpq \F[]\-style printer status information\&.
     5691.sp
     5692This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\&.
     5693.sp
     5694Currently 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
    49265695\fIprinting =\fR
    4927 option\.
    4928 .sp
    4929 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\.
     5696option\&.
     5697.sp
     5698Some 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\&.
    49305699.sp
    49315700If a
    49325701\fI%p\fR
    4933 is given then the printer name is put in its place\. Otherwise it is placed at the end of the command\.
     5702is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
    49345703.sp
    49355704Note that it is good practice to include the absolute path in the
     
    49375706as the
    49385707\fB$PATH \fR
    4939 may not be available to the server\. When compiled with the CUPS libraries, no
     5708may not be available to the server\&. When compiled with the CUPS libraries, no
    49405709\fIlpq command\fR
    4941 is needed because smbd will make a library call to obtain the print queue listing\.
    4942 .sp
    4943 Default:
    4944 \fI\fIlpq command\fR\fR\fI = \fR\fI\fR\fI \fR
    4945 .sp
    4946 Example:
    4947 \fI\fIlpq command\fR\fR\fI = \fR\fI/usr/bin/lpq \-P%p\fR\fI \fR
     5710is needed because smbd will make a library call to obtain the print queue listing\&.
     5711.sp
     5712Default:
     5713\fI\fIlpq command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     5714.sp
     5715Example:
     5716\fI\fIlpq command\fR\fR\fI = \fR\fI\FC/usr/bin/lpq \-P%p\F[]\fR\fI \fR
    49485717.RE
    49495718
    49505719lpresume command (S)
    4951 .PP
    4952 .RS 4
    4953 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\.
    4954 .sp
    4955 This command should be a program or script which takes a printer name and job number to resume the print job\. See also the
    4956 \fIlppause command\fR
    4957 parameter\.
     5720.\" lpresume command
     5721.PP
     5722.RS 4
     5723This parameter specifies the command to be executed on the server host in order to restart or continue printing or spooling a specific print job\&.
     5724.sp
     5725This command should be a program or script which takes a printer name and job number to resume the print job\&. See also the
     5726\m[blue]\fBlppause command\fR\m[]
     5727parameter\&.
    49585728.sp
    49595729If a
    49605730\fI%p\fR
    4961 is given then the printer name is put in its place\. A
     5731is given then the printer name is put in its place\&. A
    49625732\fI%j\fR
    4963 is replaced with the job number (an integer)\.
     5733is replaced with the job number (an integer)\&.
    49645734.sp
    49655735Note that it is good practice to include the absolute path in the
    49665736\fIlpresume command\fR
    4967 as the PATH may not be available to the server\.
     5737as the PATH may not be available to the server\&.
    49685738.sp
    49695739See also the
    4970 \fIprinting\fR
    4971 parameter\.
     5740\m[blue]\fBprinting\fR\m[]
     5741parameter\&.
    49725742.sp
    49735743Default: Currently no default value is given to this string, unless the value of the
     
    49765746\fBSYSV\fR, in which case the default is:
    49775747.sp
    4978 lp \-i %p\-%j \-H resume
     5748\FClp \-i %p\-%j \-H resume\F[]
    49795749.sp
    49805750or if the value of the
     
    49835753\fBSOFTQ\fR, then the default is:
    49845754.sp
    4985 qstat \-s \-j%j \-r
     5755\FCqstat \-s \-j%j \-r\F[]
    49865756.sp
    49875757\fINo default\fR
    49885758.sp
    49895759Example:
    4990 \fI\fIlpresume command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p2\fR\fI \fR
     5760\fI\fIlpresume command\fR\fR\fI = \fR\fI\FC/usr/bin/lpalt %p\-%j \-p2\F[]\fR\fI \fR
    49915761.RE
    49925762
    49935763lprm command (S)
    4994 .PP
    4995 .RS 4
    4996 This parameter specifies the command to be executed on the server host in order to delete a print job\.
    4997 .sp
    4998 This command should be a program or script which takes a printer name and job number, and deletes the print job\.
     5764.\" lprm command
     5765.PP
     5766.RS 4
     5767This parameter specifies the command to be executed on the server host in order to delete a print job\&.
     5768.sp
     5769This command should be a program or script which takes a printer name and job number, and deletes the print job\&.
    49995770.sp
    50005771If a
    50015772\fI%p\fR
    5002 is given then the printer name is put in its place\. A
     5773is given then the printer name is put in its place\&. A
    50035774\fI%j\fR
    5004 is replaced with the job number (an integer)\.
     5775is replaced with the job number (an integer)\&.
    50055776.sp
    50065777Note that it is good practice to include the absolute path in the
    50075778\fIlprm command\fR
    5008 as the PATH may not be available to the server\.
     5779as the PATH may not be available to the server\&.
    50095780.sp
    50105781Examples of use are:
    50115782.sp
    5012 .RS 4
     5783.if n \{\
     5784.RS 4
     5785.\}
     5786.fam C
     5787.ps -1
    50135788.nf
     5789.if t \{\
     5790.sp -1
     5791.\}
     5792.BB lightgray adjust-for-leading-newline
     5793.sp -1
     5794
    50145795lprm command = /usr/bin/lprm \-P%p %j
    50155796
     
    50175798
    50185799lprm command = /usr/bin/cancel %p\-%j
     5800.EB lightgray adjust-for-leading-newline
     5801.if t \{\
     5802.sp 1
     5803.\}
    50195804.fi
    5020 .RE
    5021 .sp
    5022 .sp
    5023 Default:
    5024 \fI\fIlprm command\fR\fR\fI = \fR\fI determined by printing parameter\fR\fI \fR
     5805.fam
     5806.ps +1
     5807.if n \{\
     5808.RE
     5809.\}
     5810.sp
     5811Default:
     5812\fI\fIlprm command\fR\fR\fI = \fR\fI\FC determined by printing parameter\F[]\fR\fI \fR
    50255813.RE
    50265814
    50275815machine password timeout (G)
     5816.\" machine password timeout
    50285817.PP
    50295818.RS 4
    50305819If a Samba server is a member of a Windows NT Domain (see the
    5031 \fIsecurity = domain\fR
     5820\m[blue]\fBsecurity = domain\fR\m[]
    50325821parameter) then periodically a running smbd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called
    5033 \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\.
     5822\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\&.
    50345823.sp
    50355824See also
    50365825\fBsmbpasswd\fR(8), and the
    5037 \fIsecurity = domain\fR
    5038 parameter\.
    5039 .sp
    5040 Default:
    5041 \fI\fImachine password timeout\fR\fR\fI = \fR\fI604800\fR\fI \fR
     5826\m[blue]\fBsecurity = domain\fR\m[]
     5827parameter\&.
     5828.sp
     5829Default:
     5830\fI\fImachine password timeout\fR\fR\fI = \fR\fI\FC604800\F[]\fR\fI \fR
    50425831.RE
    50435832
    50445833magic output (S)
     5834.\" magic output
    50455835.PP
    50465836.RS 4
    50475837This parameter specifies the name of a file which will contain output created by a magic script (see the
    5048 \fImagic script\fR
    5049 parameter below)\.
    5050 .sp
     5838\m[blue]\fBmagic script\fR\m[]
     5839parameter below)\&.
     5840.if n \{\
     5841.sp
     5842.\}
     5843.RS 4
     5844.BM yellow
    50515845.it 1 an-trap
    50525846.nr an-no-space-flag 1
    50535847.nr an-break-flag 1
    50545848.br
    5055 Warning
     5849.ps +1
     5850\fBWarning\fR
     5851.ps -1
     5852.br
    50565853If two clients use the same
    50575854\fImagic script \fR
    5058 in the same directory the output file content is undefined\.
    5059 
    5060 Default:
    5061 \fI\fImagic output\fR\fR\fI = \fR\fI<magic script name>\.out\fR\fI \fR
    5062 .sp
    5063 Example:
    5064 \fI\fImagic output\fR\fR\fI = \fR\fImyfile\.txt\fR\fI \fR
     5855in the same directory the output file content is undefined\&.
     5856.sp .5v
     5857.EM yellow
     5858.RE
     5859Default:
     5860\fI\fImagic output\fR\fR\fI = \fR\fI\FC<magic script name>\&.out\F[]\fR\fI \fR
     5861.sp
     5862Example:
     5863\fI\fImagic output\fR\fR\fI = \fR\fI\FCmyfile\&.txt\F[]\fR\fI \fR
    50655864.RE
    50665865
    50675866magic script (S)
    5068 .PP
    5069 .RS 4
    5070 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\.
    5071 .sp
    5072 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\.
     5867.\" magic script
     5868.PP
     5869.RS 4
     5870This 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\&.
     5871.sp
     5872Scripts 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\&.
    50735873.sp
    50745874If the script generates output, output will be sent to the file specified by the
    5075 \fImagic output\fR
    5076 parameter (see above)\.
    5077 .sp
    5078 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
     5875\m[blue]\fBmagic output\fR\m[]
     5876parameter (see above)\&.
     5877.sp
     5878Note 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
    50795879\fIas is\fR
    5080 on the host, which for some hosts and some shells will require filtering at the DOS end\.
     5880on the host, which for some hosts and some shells will require filtering at the DOS end\&.
    50815881.sp
    50825882Magic scripts are
     
    50845884and should
    50855885\fINOT\fR
    5086 be relied upon\.
    5087 .sp
    5088 Default:
    5089 \fI\fImagic script\fR\fR\fI = \fR\fI\fR\fI \fR
    5090 .sp
    5091 Example:
    5092 \fI\fImagic script\fR\fR\fI = \fR\fIuser\.csh\fR\fI \fR
     5886be relied upon\&.
     5887.sp
     5888Default:
     5889\fI\fImagic script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     5890.sp
     5891Example:
     5892\fI\fImagic script\fR\fR\fI = \fR\fI\FCuser\&.csh\F[]\fR\fI \fR
    50935893.RE
    50945894
    50955895mangled names (S)
    5096 .PP
    5097 .RS 4
    5098 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\.
     5896.\" mangled names
     5897.PP
     5898.RS 4
     5899This 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\&.
    50995900.sp
    51005901See the section on
    5101 \fIname mangling\fR
    5102 for details on how to control the mangling process\.
     5902\m[blue]\fBname mangling\fR\m[]
     5903for details on how to control the mangling process\&.
    51035904.sp
    51045905If mangling is used then the mangling algorithm is as follows:
     
    51125913.IP \(bu 2.3
    51135914.\}
    5114 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\.
    5115 .RE
    5116 .sp
    5117 .RS 4
    5118 .ie n \{\
    5119 \h'-04'\(bu\h'+03'\c
    5120 .\}
    5121 .el \{\
    5122 .sp -1
    5123 .IP \(bu 2.3
    5124 .\}
    5125 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\.
     5915The 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\&.
     5916.RE
     5917.sp
     5918.RS 4
     5919.ie n \{\
     5920\h'-04'\(bu\h'+03'\c
     5921.\}
     5922.el \{\
     5923.sp -1
     5924.IP \(bu 2.3
     5925.\}
     5926A 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\&.
    51265927.sp
    51275928Note that the character to use may be specified using the
    5128 \fImangling char\fR
    5129 option, if you don\'t like \'~\'\.
    5130 .RE
    5131 .sp
    5132 .RS 4
    5133 .ie n \{\
    5134 \h'-04'\(bu\h'+03'\c
    5135 .\}
    5136 .el \{\
    5137 .sp -1
    5138 .IP \(bu 2.3
    5139 .\}
    5140 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)\.
    5141 .sp
    5142 .RE
    5143 The two\-digit hash value consists of upper case alphanumeric characters\.
    5144 .sp
    5145 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\.
    5146 .sp
    5147 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\.
    5148 .sp
    5149 Default:
    5150 \fI\fImangled names\fR\fR\fI = \fR\fIyes\fR\fI \fR
     5929\m[blue]\fBmangling char\fR\m[]
     5930option, if you don\'t like \'~\'\&.
     5931.RE
     5932.sp
     5933.RS 4
     5934.ie n \{\
     5935\h'-04'\(bu\h'+03'\c
     5936.\}
     5937.el \{\
     5938.sp -1
     5939.IP \(bu 2.3
     5940.\}
     5941Files 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)\&.
     5942.sp
     5943.RE
     5944The two\-digit hash value consists of upper case alphanumeric characters\&.
     5945.sp
     5946This 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\&.
     5947.sp
     5948The 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\&.
     5949.sp
     5950Default:
     5951\fI\fImangled names\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    51515952.RE
    51525953
    51535954mangle prefix (G)
    5154 .PP
    5155 .RS 4
    5156 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\.
    5157 .sp
    5158 mangle prefix is effective only when mangling method is hash2\.
    5159 .sp
    5160 Default:
    5161 \fI\fImangle prefix\fR\fR\fI = \fR\fI1\fR\fI \fR
    5162 .sp
    5163 Example:
    5164 \fI\fImangle prefix\fR\fR\fI = \fR\fI4\fR\fI \fR
     5955.\" mangle prefix
     5956.PP
     5957.RS 4
     5958controls 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\&.
     5959.sp
     5960mangle prefix is effective only when mangling method is hash2\&.
     5961.sp
     5962Default:
     5963\fI\fImangle prefix\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
     5964.sp
     5965Example:
     5966\fI\fImangle prefix\fR\fR\fI = \fR\fI\FC4\F[]\fR\fI \fR
    51655967.RE
    51665968
    51675969mangling char (S)
     5970.\" mangling char
    51685971.PP
    51695972.RS 4
     
    51715974\fImagic\fR
    51725975character in
    5173 \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\.
    5174 .sp
    5175 Default:
    5176 \fI\fImangling char\fR\fR\fI = \fR\fI~\fR\fI \fR
    5177 .sp
    5178 Example:
    5179 \fI\fImangling char\fR\fR\fI = \fR\fI^\fR\fI \fR
     5976\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\&.
     5977.sp
     5978Default:
     5979\fI\fImangling char\fR\fR\fI = \fR\fI\FC~\F[]\fR\fI \fR
     5980.sp
     5981Example:
     5982\fI\fImangling char\fR\fR\fI = \fR\fI\FC^\F[]\fR\fI \fR
    51805983.RE
    51815984
    51825985mangling method (G)
    5183 .PP
    5184 .RS 4
    5185 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\.
    5186 .sp
    5187 Default:
    5188 \fI\fImangling method\fR\fR\fI = \fR\fIhash2\fR\fI \fR
    5189 .sp
    5190 Example:
    5191 \fI\fImangling method\fR\fR\fI = \fR\fIhash\fR\fI \fR
     5986.\" mangling method
     5987.PP
     5988.RS 4
     5989controls 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\&.
     5990.sp
     5991Default:
     5992\fI\fImangling method\fR\fR\fI = \fR\fI\FChash2\F[]\fR\fI \fR
     5993.sp
     5994Example:
     5995\fI\fImangling method\fR\fR\fI = \fR\fI\FChash\F[]\fR\fI \fR
    51925996.RE
    51935997
    51945998map acl inherit (S)
     5999.\" map acl inherit
    51956000.PP
    51966001.RS 4
    51976002This boolean parameter controls whether
    51986003\fBsmbd\fR(8)
    5199 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\.
    5200 .sp
    5201 Default:
    5202 \fI\fImap acl inherit\fR\fR\fI = \fR\fIno\fR\fI \fR
     6004will 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\&.
     6005.sp
     6006Default:
     6007\fI\fImap acl inherit\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    52036008.RE
    52046009
    52056010map archive (S)
    5206 .PP
    5207 .RS 4
    5208 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\.\.\.
     6011.\" map archive
     6012.PP
     6013.RS 4
     6014This 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\&.\&.\&.
    52096015.sp
    52106016Note that this requires the
    5211 \fIcreate mask\fR
    5212 parameter to be set such that owner execute bit is not masked out (i\.e\. it must include 100)\. See the parameter
    5213 \fIcreate mask\fR
    5214 for details\.
    5215 .sp
    5216 Default:
    5217 \fI\fImap archive\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6017\m[blue]\fBcreate mask\fR\m[]
     6018parameter to be set such that owner execute bit is not masked out (i\&.e\&. it must include 100)\&. See the parameter
     6019\m[blue]\fBcreate mask\fR\m[]
     6020for details\&.
     6021.sp
     6022Default:
     6023\fI\fImap archive\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    52186024.RE
    52196025
    52206026map hidden (S)
    5221 .PP
    5222 .RS 4
    5223 This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\.
     6027.\" map hidden
     6028.PP
     6029.RS 4
     6030This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\&.
    52246031.sp
    52256032Note that this requires the
    5226 \fIcreate mask\fR
    5227 to be set such that the world execute bit is not masked out (i\.e\. it must include 001)\. See the parameter
    5228 \fIcreate mask\fR
    5229 for details\.
     6033\m[blue]\fBcreate mask\fR\m[]
     6034to be set such that the world execute bit is not masked out (i\&.e\&. it must include 001)\&. See the parameter
     6035\m[blue]\fBcreate mask\fR\m[]
     6036for details\&.
    52306037.sp
    52316038\fINo default\fR
     
    52336040
    52346041map read only (S)
    5235 .PP
    5236 .RS 4
    5237 This controls how the DOS read only attribute should be mapped from a UNIX filesystem\.
     6042.\" map read only
     6043.PP
     6044.RS 4
     6045This controls how the DOS read only attribute should be mapped from a UNIX filesystem\&.
    52386046.sp
    52396047This parameter can take three different values, which tell
    52406048\fBsmbd\fR(8)
    52416049how to display the read only attribute on files, where either
    5242 \fIstore dos attributes\fR
     6050\m[blue]\fBstore dos attributes\fR\m[]
    52436051is set to
    5244 \fBNo\fR, or no extended attribute is present\. If
    5245 \fIstore dos attributes\fR
     6052\fBNo\fR, or no extended attribute is present\&. If
     6053\m[blue]\fBstore dos attributes\fR\m[]
    52466054is set to
    52476055\fByes\fR
    52486056then this parameter is
    5249 \fIignored\fR\. This is a new parameter introduced in Samba version 3\.0\.21\.
     6057\fIignored\fR\&. This is a new parameter introduced in Samba version 3\&.0\&.21\&.
    52506058.sp
    52516059The three settings are :
     
    52616069
    52626070\fBYes\fR
    5263 \- The read only DOS attribute is mapped to the inverse of the user or owner write bit in the unix permission mode set\. If the owner write bit is not set, the read only attribute is reported as being set on the file\. If the read only DOS attribute is set, Samba sets the owner, group and others write bits to zero\. Write bits set in an ACL are ignored by Samba\. If the read only DOS attribute is unset, Samba simply sets the write bit of the owner to one\.
     6071\- The read only DOS attribute is mapped to the inverse of the user or owner write bit in the unix permission mode set\&. If the owner write bit is not set, the read only attribute is reported as being set on the file\&. If the read only DOS attribute is set, Samba sets the owner, group and others write bits to zero\&. Write bits set in an ACL are ignored by Samba\&. If the read only DOS attribute is unset, Samba simply sets the write bit of the owner to one\&.
    52646072.RE
    52656073.sp
     
    52766084\- The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by
    52776085\fBsmbd\fR(8)
    5278 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\.
     6086by 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\&.
    52796087.RE
    52806088.sp
     
    52906098\fBNo\fR
    52916099\- The read only DOS attribute is unaffected by permissions, and can only be set by the
    5292 \fIstore dos attributes\fR
    5293 method\. This may be useful for exporting mounted CDs\.
    5294 .sp
    5295 .RE
    5296 Default:
    5297 \fI\fImap read only\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6100\m[blue]\fBstore dos attributes\fR\m[]
     6101method\&. This may be useful for exporting mounted CDs\&.
     6102.sp
     6103.RE
     6104Default:
     6105\fI\fImap read only\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    52986106.RE
    52996107
    53006108map system (S)
    5301 .PP
    5302 .RS 4
    5303 This controls whether DOS style system files should be mapped to the UNIX group execute bit\.
     6109.\" map system
     6110.PP
     6111.RS 4
     6112This controls whether DOS style system files should be mapped to the UNIX group execute bit\&.
    53046113.sp
    53056114Note that this requires the
    5306 \fIcreate mask\fR
    5307 to be set such that the group execute bit is not masked out (i\.e\. it must include 010)\. See the parameter
    5308 \fIcreate mask\fR
    5309 for details\.
    5310 .sp
    5311 Default:
    5312 \fI\fImap system\fR\fR\fI = \fR\fIno\fR\fI \fR
     6115\m[blue]\fBcreate mask\fR\m[]
     6116to be set such that the group execute bit is not masked out (i\&.e\&. it must include 010)\&. See the parameter
     6117\m[blue]\fBcreate mask\fR\m[]
     6118for details\&.
     6119.sp
     6120Default:
     6121\fI\fImap system\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    53136122.RE
    53146123
    53156124map to guest (G)
     6125.\" map to guest
    53166126.PP
    53176127.RS 4
    53186128This parameter is only useful in
    5319 \fISECURITY = security\fR
     6129\m[blue]\fBSECURITY = security\fR\m[]
    53206130modes other than
    53216131\fIsecurity = share\fR
    53226132and
    53236133\fIsecurity = server\fR
    5324 \- i\.e\.
     6134\- i\&.e\&.
    53256135\fBuser\fR, and
    5326 \fBdomain\fR\.
     6136\fBdomain\fR\&.
    53276137.sp
    53286138This parameter can take four different values, which tell
    53296139\fBsmbd\fR(8)
    5330 what to do with user login requests that don\'t match a valid UNIX user in some way\.
     6140what to do with user login requests that don\'t match a valid UNIX user in some way\&.
    53316141.sp
    53326142The four settings are :
     
    53416151.\}
    53426152\fBNever\fR
    5343 \- Means user login requests with an invalid password are rejected\. This is the default\.
     6153\- Means user login requests with an invalid password are rejected\&. This is the default\&.
    53446154.RE
    53456155.sp
     
    53546164\fBBad User\fR
    53556165\- 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
    5356 \fIguest account\fR\.
     6166\m[blue]\fBguest account\fR\m[]\&.
    53576167.RE
    53586168.sp
     
    53676177\fBBad Password\fR
    53686178\- Means user logins with an invalid password are treated as a guest login and mapped into the
    5369 \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
     6179\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
    53706180\fIhate\fR
    53716181you if you set the
    53726182\fImap to guest\fR
    5373 parameter this way :\-)\.
     6183parameter this way :\-)\&.
    53746184.RE
    53756185.sp
     
    53836193.\}
    53846194\fBBad Uid\fR
    5385 \- 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\.
     6195\- 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\&.
    53866196.sp
    53876197.RE
    53886198Note that this parameter is needed to set up "Guest" share services when using
    53896199\fIsecurity\fR
    5390 modes other than share and server\. This is because in these modes the name of the resource being requested is
     6200modes other than share and server\&. This is because in these modes the name of the resource being requested is
    53916201\fInot\fR
    5392 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
     6202sent 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
    53936203\fIsecurity = server\fR
    5394 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\.
     6204as 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\&.
    53956205.sp
    53966206For people familiar with the older Samba releases, this parameter maps to the old compile\-time setting of the
    53976207\fB GUEST_SESSSETUP\fR
    5398 value in local\.h\.
    5399 .sp
    5400 Default:
    5401 \fI\fImap to guest\fR\fR\fI = \fR\fINever\fR\fI \fR
    5402 .sp
    5403 Example:
    5404 \fI\fImap to guest\fR\fR\fI = \fR\fIBad User\fR\fI \fR
     6208value in local\&.h\&.
     6209.sp
     6210Default:
     6211\fI\fImap to guest\fR\fR\fI = \fR\fI\FCNever\F[]\fR\fI \fR
     6212.sp
     6213Example:
     6214\fI\fImap to guest\fR\fR\fI = \fR\fI\FCBad User\F[]\fR\fI \fR
    54056215.RE
    54066216
    54076217max connections (S)
    5408 .PP
    5409 .RS 4
    5410 This option allows the number of simultaneous connections to a service to be limited\. If
     6218.\" max connections
     6219.PP
     6220.RS 4
     6221This option allows the number of simultaneous connections to a service to be limited\&. If
    54116222\fImax connections\fR
    5412 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\.
    5413 .sp
    5414 Record lock files are used to implement this feature\. The lock files will be stored in the directory specified by the
    5415 \fIlock directory\fR
    5416 option\.
    5417 .sp
    5418 Default:
    5419 \fI\fImax connections\fR\fR\fI = \fR\fI0\fR\fI \fR
    5420 .sp
    5421 Example:
    5422 \fI\fImax connections\fR\fR\fI = \fR\fI10\fR\fI \fR
     6223is 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\&.
     6224.sp
     6225Record lock files are used to implement this feature\&. The lock files will be stored in the directory specified by the
     6226\m[blue]\fBlock directory\fR\m[]
     6227option\&.
     6228.sp
     6229Default:
     6230\fI\fImax connections\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     6231.sp
     6232Example:
     6233\fI\fImax connections\fR\fR\fI = \fR\fI\FC10\F[]\fR\fI \fR
    54236234.RE
    54246235
    54256236max disk size (G)
    5426 .PP
    5427 .RS 4
    5428 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\.
    5429 .sp
    5430 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
    5431 \fImax disk size\fR\.
    5432 .sp
    5433 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\.
     6237.\" max disk size
     6238.PP
     6239.RS 4
     6240This 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\&.
     6241.sp
     6242Note 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
     6243\fImax disk size\fR\&.
     6244.sp
     6245This 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\&.
    54346246.sp
    54356247A
    54366248\fImax disk size\fR
    5437 of 0 means no limit\.
    5438 .sp
    5439 Default:
    5440 \fI\fImax disk size\fR\fR\fI = \fR\fI0\fR\fI \fR
    5441 .sp
    5442 Example:
    5443 \fI\fImax disk size\fR\fR\fI = \fR\fI1000\fR\fI \fR
     6249of 0 means no limit\&.
     6250.sp
     6251Default:
     6252\fI\fImax disk size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     6253.sp
     6254Example:
     6255\fI\fImax disk size\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
    54446256.RE
    54456257
    54466258max log size (G)
    5447 .PP
    5448 .RS 4
    5449 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
    5450 \fI\.old\fR
    5451 extension\.
    5452 .sp
    5453 A size of 0 means no limit\.
    5454 .sp
    5455 Default:
    5456 \fI\fImax log size\fR\fR\fI = \fR\fI5000\fR\fI \fR
    5457 .sp
    5458 Example:
    5459 \fI\fImax log size\fR\fR\fI = \fR\fI1000\fR\fI \fR
     6259.\" max log size
     6260.PP
     6261.RS 4
     6262This 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
     6263\FC\&.old\F[]
     6264extension\&.
     6265.sp
     6266A size of 0 means no limit\&.
     6267.sp
     6268Default:
     6269\fI\fImax log size\fR\fR\fI = \fR\fI\FC5000\F[]\fR\fI \fR
     6270.sp
     6271Example:
     6272\fI\fImax log size\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
    54606273.RE
    54616274
    54626275max mux (G)
    5463 .PP
    5464 .RS 4
    5465 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\.
    5466 .sp
    5467 Default:
    5468 \fI\fImax mux\fR\fR\fI = \fR\fI50\fR\fI \fR
     6276.\" max mux
     6277.PP
     6278.RS 4
     6279This 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\&.
     6280.sp
     6281Default:
     6282\fI\fImax mux\fR\fR\fI = \fR\fI\FC50\F[]\fR\fI \fR
    54696283.RE
    54706284
    54716285max open files (G)
     6286.\" max open files
    54726287.PP
    54736288.RS 4
    54746289This parameter limits the maximum number of open files that one
    54756290\fBsmbd\fR(8)
    5476 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\.
    5477 .sp
    5478 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\.
    5479 .sp
    5480 Default:
    5481 \fI\fImax open files\fR\fR\fI = \fR\fI10000\fR\fI \fR
     6291file 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\&.
     6292.sp
     6293The 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\&.
     6294.sp
     6295Default:
     6296\fI\fImax open files\fR\fR\fI = \fR\fI\FC10000\F[]\fR\fI \fR
    54826297.RE
    54836298
    54846299max print jobs (S)
    5485 .PP
    5486 .RS 4
    5487 This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\. If this number is exceeded,
     6300.\" max print jobs
     6301.PP
     6302.RS 4
     6303This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\&. If this number is exceeded,
    54886304\fBsmbd\fR(8)
    5489 will remote "Out of Space" to the client\.
    5490 .sp
    5491 Default:
    5492 \fI\fImax print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR
    5493 .sp
    5494 Example:
    5495 \fI\fImax print jobs\fR\fR\fI = \fR\fI5000\fR\fI \fR
     6305will remote "Out of Space" to the client\&.
     6306.sp
     6307Default:
     6308\fI\fImax print jobs\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
     6309.sp
     6310Example:
     6311\fI\fImax print jobs\fR\fR\fI = \fR\fI\FC5000\F[]\fR\fI \fR
    54966312.RE
    54976313
    54986314protocol
     6315.\" protocol
    54996316.PP
    55006317.RS 4
    55016318This parameter is a synonym for
    5502 max protocol\.
     6319max protocol\&.
    55036320.RE
    55046321
    55056322max protocol (G)
    5506 .PP
    5507 .RS 4
    5508 The value of the parameter (a string) is the highest protocol level that will be supported by the server\.
     6323.\" max protocol
     6324.PP
     6325.RS 4
     6326The value of the parameter (a string) is the highest protocol level that will be supported by the server\&.
    55096327.sp
    55106328Possible values are :
     
    55186336.IP \(bu 2.3
    55196337.\}
    5520 \fBCORE\fR: Earliest version\. No concept of user names\.
    5521 .RE
    5522 .sp
    5523 .RS 4
    5524 .ie n \{\
    5525 \h'-04'\(bu\h'+03'\c
    5526 .\}
    5527 .el \{\
    5528 .sp -1
    5529 .IP \(bu 2.3
    5530 .\}
    5531 \fBCOREPLUS\fR: Slight improvements on CORE for efficiency\.
     6338\fBCORE\fR: Earliest version\&. No concept of user names\&.
     6339.RE
     6340.sp
     6341.RS 4
     6342.ie n \{\
     6343\h'-04'\(bu\h'+03'\c
     6344.\}
     6345.el \{\
     6346.sp -1
     6347.IP \(bu 2.3
     6348.\}
     6349\fBCOREPLUS\fR: Slight improvements on CORE for efficiency\&.
    55326350.RE
    55336351.sp
     
    55426360\fBLANMAN1\fR: First
    55436361\fI modern\fR
    5544 version of the protocol\. Long filename support\.
    5545 .RE
    5546 .sp
    5547 .RS 4
    5548 .ie n \{\
    5549 \h'-04'\(bu\h'+03'\c
    5550 .\}
    5551 .el \{\
    5552 .sp -1
    5553 .IP \(bu 2.3
    5554 .\}
    5555 \fBLANMAN2\fR: Updates to Lanman1 protocol\.
    5556 .RE
    5557 .sp
    5558 .RS 4
    5559 .ie n \{\
    5560 \h'-04'\(bu\h'+03'\c
    5561 .\}
    5562 .el \{\
    5563 .sp -1
    5564 .IP \(bu 2.3
    5565 .\}
    5566 \fBNT1\fR: Current up to date version of the protocol\. Used by Windows NT\. Known as CIFS\.
    5567 .sp
    5568 .RE
    5569 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\.
    5570 .sp
    5571 Default:
    5572 \fI\fImax protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR
    5573 .sp
    5574 Example:
    5575 \fI\fImax protocol\fR\fR\fI = \fR\fILANMAN1\fR\fI \fR
     6362version of the protocol\&. Long filename support\&.
     6363.RE
     6364.sp
     6365.RS 4
     6366.ie n \{\
     6367\h'-04'\(bu\h'+03'\c
     6368.\}
     6369.el \{\
     6370.sp -1
     6371.IP \(bu 2.3
     6372.\}
     6373\fBLANMAN2\fR: Updates to Lanman1 protocol\&.
     6374.RE
     6375.sp
     6376.RS 4
     6377.ie n \{\
     6378\h'-04'\(bu\h'+03'\c
     6379.\}
     6380.el \{\
     6381.sp -1
     6382.IP \(bu 2.3
     6383.\}
     6384\fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.
     6385.sp
     6386.RE
     6387Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
     6388.sp
     6389Default:
     6390\fI\fImax protocol\fR\fR\fI = \fR\fI\FCNT1\F[]\fR\fI \fR
     6391.sp
     6392Example:
     6393\fI\fImax protocol\fR\fR\fI = \fR\fI\FCLANMAN1\F[]\fR\fI \fR
    55766394.RE
    55776395
    55786396max reported print jobs (S)
    5579 .PP
    5580 .RS 4
    5581 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\.
    5582 .sp
    5583 Default:
    5584 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI0\fR\fI \fR
    5585 .sp
    5586 Example:
    5587 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR
     6397.\" max reported print jobs
     6398.PP
     6399.RS 4
     6400This 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\&.
     6401.sp
     6402Default:
     6403\fI\fImax reported print jobs\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     6404.sp
     6405Example:
     6406\fI\fImax reported print jobs\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
    55886407.RE
    55896408
    55906409max smbd processes (G)
     6410.\" max smbd processes
    55916411.PP
    55926412.RS 4
    55936413This parameter limits the maximum number of
    55946414\fBsmbd\fR(8)
    5595 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
     6415processes 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
    55966416\fBsmbd\fR(8)
    5597 associated with him or her to handle connections to all shares from a given host\.
    5598 .sp
    5599 Default:
    5600 \fI\fImax smbd processes\fR\fR\fI = \fR\fI0\fR\fI \fR
    5601 .sp
    5602 Example:
    5603 \fI\fImax smbd processes\fR\fR\fI = \fR\fI1000\fR\fI \fR
     6417associated with him or her to handle connections to all shares from a given host\&.
     6418.sp
     6419Default:
     6420\fI\fImax smbd processes\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     6421.sp
     6422Example:
     6423\fI\fImax smbd processes\fR\fR\fI = \fR\fI\FC1000\F[]\fR\fI \fR
    56046424.RE
    56056425
    56066426max stat cache size (G)
     6427.\" max stat cache size
    56076428.PP
    56086429.RS 4
    56096430This parameter limits the size in memory of any
    56106431\fIstat cache\fR
    5611 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\.
    5612 .sp
    5613 Default:
    5614 \fI\fImax stat cache size\fR\fR\fI = \fR\fI256\fR\fI \fR
    5615 .sp
    5616 Example:
    5617 \fI\fImax stat cache size\fR\fR\fI = \fR\fI100\fR\fI \fR
     6432being 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\&.
     6433.sp
     6434Default:
     6435\fI\fImax stat cache size\fR\fR\fI = \fR\fI\FC256\F[]\fR\fI \fR
     6436.sp
     6437Example:
     6438\fI\fImax stat cache size\fR\fR\fI = \fR\fI\FC100\F[]\fR\fI \fR
    56186439.RE
    56196440
    56206441max ttl (G)
     6442.\" max ttl
    56216443.PP
    56226444.RS 4
     
    56246446\fBnmbd\fR(8)
    56256447what the default \'time to live\' of NetBIOS names should be (in seconds) when
    5626 nmbd
    5627 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\.
    5628 .sp
    5629 Default:
    5630 \fI\fImax ttl\fR\fR\fI = \fR\fI259200\fR\fI \fR
     6448\FCnmbd\F[]
     6449is 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\&.
     6450.sp
     6451Default:
     6452\fI\fImax ttl\fR\fR\fI = \fR\fI\FC259200\F[]\fR\fI \fR
    56316453.RE
    56326454
    56336455max wins ttl (G)
     6456.\" max wins ttl
    56346457.PP
    56356458.RS 4
    56366459This option tells
    56376460\fBsmbd\fR(8)
    5638 when acting as a WINS server (\fIwins support = yes\fR) what the maximum \'time to live\' of NetBIOS names that
    5639 nmbd
    5640 will grant will be (in seconds)\. You should never need to change this parameter\. The default is 6 days (518400 seconds)\.
    5641 .sp
    5642 Default:
    5643 \fI\fImax wins ttl\fR\fR\fI = \fR\fI518400\fR\fI \fR
     6461when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the maximum \'time to live\' of NetBIOS names that
     6462\FCnmbd\F[]
     6463will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 days (518400 seconds)\&.
     6464.sp
     6465Default:
     6466\fI\fImax wins ttl\fR\fR\fI = \fR\fI\FC518400\F[]\fR\fI \fR
    56446467.RE
    56456468
    56466469max xmit (G)
    5647 .PP
    5648 .RS 4
    5649 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\.
    5650 .sp
    5651 Default:
    5652 \fI\fImax xmit\fR\fR\fI = \fR\fI16644\fR\fI \fR
    5653 .sp
    5654 Example:
    5655 \fI\fImax xmit\fR\fR\fI = \fR\fI8192\fR\fI \fR
     6470.\" max xmit
     6471.PP
     6472.RS 4
     6473This 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\&.
     6474.sp
     6475Default:
     6476\fI\fImax xmit\fR\fR\fI = \fR\fI\FC16644\F[]\fR\fI \fR
     6477.sp
     6478Example:
     6479\fI\fImax xmit\fR\fR\fI = \fR\fI\FC8192\F[]\fR\fI \fR
    56566480.RE
    56576481
    56586482message command (G)
    5659 .PP
    5660 .RS 4
    5661 This specifies what command to run when the server receives a WinPopup style message\.
    5662 .sp
    5663 This would normally be a command that would deliver the message somehow\. How this is to be done is up to your imagination\.
     6483.\" message command
     6484.PP
     6485.RS 4
     6486This specifies what command to run when the server receives a WinPopup style message\&.
     6487.sp
     6488This would normally be a command that would deliver the message somehow\&. How this is to be done is up to your imagination\&.
    56646489.sp
    56656490An example is:
    56666491.sp
    5667 .RS 4
     6492.if n \{\
     6493.RS 4
     6494.\}
     6495.fam C
     6496.ps -1
    56686497.nf
    5669 message command = csh \-c \'xedit %s;rm %s\' &
     6498.if t \{\
     6499.sp -1
     6500.\}
     6501.BB lightgray adjust-for-leading-newline
     6502.sp -1
     6503
     6504\FCmessage command = csh \-c \'xedit %s;rm %s\' &\F[]
     6505.EB lightgray adjust-for-leading-newline
     6506.if t \{\
     6507.sp 1
     6508.\}
    56706509.fi
    5671 .RE
    5672 .sp
     6510.fam
     6511.ps +1
     6512.if n \{\
     6513.RE
     6514.\}
    56736515.sp
    56746516This delivers the message using
    5675 xedit, then removes it afterwards\.
    5676 \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)\.
    5677 .sp
    5678 All messages are delivered as the global guest user\. The command takes the standard substitutions, although
     6517\FCxedit\F[], then removes it afterwards\&.
     6518\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)\&.
     6519.sp
     6520All messages are delivered as the global guest user\&. The command takes the standard substitutions, although
    56796521\fI %u\fR
    56806522won\'t work (\fI%U\fR
    5681 may be better in this case)\.
    5682 .sp
    5683 Apart from the standard substitutions, some additional ones apply\. In particular:
     6523may be better in this case)\&.
     6524.sp
     6525Apart from the standard substitutions, some additional ones apply\&. In particular:
    56846526.sp
    56856527.RS 4
     
    56926534.\}
    56936535\fI%s\fR
    5694 = the filename containing the message\.
     6536= the filename containing the message\&.
    56956537.RE
    56966538.sp
     
    57046546.\}
    57056547\fI%t\fR
    5706 = the destination that the message was sent to (probably the server name)\.
     6548= the destination that the message was sent to (probably the server name)\&.
    57076549.RE
    57086550.sp
     
    57166558.\}
    57176559\fI%f\fR
    5718 = who the message is from\.
    5719 .sp
    5720 .RE
    5721 You could make this command send mail, or whatever else takes your fancy\. Please let us know of any really interesting ideas you have\.
     6560= who the message is from\&.
     6561.sp
     6562.RE
     6563You could make this command send mail, or whatever else takes your fancy\&. Please let us know of any really interesting ideas you have\&.
    57226564.sp
    57236565Here\'s a way of sending the messages as mail to root:
    57246566.sp
    5725 .RS 4
     6567.if n \{\
     6568.RS 4
     6569.\}
     6570.fam C
     6571.ps -1
    57266572.nf
    5727 message command = /bin/mail \-s \'message from %f on %m\' root < %s; rm %s
     6573.if t \{\
     6574.sp -1
     6575.\}
     6576.BB lightgray adjust-for-leading-newline
     6577.sp -1
     6578
     6579\FCmessage command = /bin/mail \-s \'message from %f on %m\' root < %s; rm %s\F[]
     6580.EB lightgray adjust-for-leading-newline
     6581.if t \{\
     6582.sp 1
     6583.\}
    57286584.fi
    5729 .RE
    5730 .sp
    5731 .sp
    5732 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\.
     6585.fam
     6586.ps +1
     6587.if n \{\
     6588.RE
     6589.\}
     6590.sp
     6591If 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\&.
    57336592.sp
    57346593If you want to silently delete it then try:
    57356594.sp
    5736 .RS 4
     6595.if n \{\
     6596.RS 4
     6597.\}
     6598.fam C
     6599.ps -1
    57376600.nf
    5738 message command = rm %s
     6601.if t \{\
     6602.sp -1
     6603.\}
     6604.BB lightgray adjust-for-leading-newline
     6605.sp -1
     6606
     6607\FCmessage command = rm %s\F[]
     6608.EB lightgray adjust-for-leading-newline
     6609.if t \{\
     6610.sp 1
     6611.\}
    57396612.fi
    5740 .RE
    5741 .sp
    5742 .sp
    5743 Default:
    5744 \fI\fImessage command\fR\fR\fI = \fR\fI\fR\fI \fR
    5745 .sp
    5746 Example:
    5747 \fI\fImessage command\fR\fR\fI = \fR\fIcsh \-c \'xedit %s; rm %s\' &\fR\fI \fR
     6613.fam
     6614.ps +1
     6615.if n \{\
     6616.RE
     6617.\}
     6618.sp
     6619Default:
     6620\fI\fImessage command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     6621.sp
     6622Example:
     6623\fI\fImessage command\fR\fR\fI = \fR\fI\FCcsh \-c \'xedit %s; rm %s\' &\F[]\fR\fI \fR
    57486624.RE
    57496625
    57506626min print space (S)
    5751 .PP
    5752 .RS 4
    5753 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\.
    5754 .sp
    5755 Default:
    5756 \fI\fImin print space\fR\fR\fI = \fR\fI0\fR\fI \fR
    5757 .sp
    5758 Example:
    5759 \fI\fImin print space\fR\fR\fI = \fR\fI2000\fR\fI \fR
     6627.\" min print space
     6628.PP
     6629.RS 4
     6630This 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\&.
     6631.sp
     6632Default:
     6633\fI\fImin print space\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     6634.sp
     6635Example:
     6636\fI\fImin print space\fR\fR\fI = \fR\fI\FC2000\F[]\fR\fI \fR
    57606637.RE
    57616638
    57626639min protocol (G)
    5763 .PP
    5764 .RS 4
    5765 The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support\. Please refer to the
    5766 \fImax protocol\fR
    5767 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
    5768 \fIsource/smbd/negprot\.c\fR
    5769 for a listing of known protocol dialects supported by clients\.
     6640.\" min protocol
     6641.PP
     6642.RS 4
     6643The value of the parameter (a string) is the lowest SMB protocol dialect than Samba will support\&. Please refer to the
     6644\m[blue]\fBmax protocol\fR\m[]
     6645parameter 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
     6646\FCsource/smbd/negprot\&.c\F[]
     6647for a listing of known protocol dialects supported by clients\&.
    57706648.sp
    57716649If you are viewing this parameter as a security measure, you should also refer to the
    5772 \fIlanman auth\fR
    5773 parameter\. Otherwise, you should never need to change this parameter\.
    5774 .sp
    5775 Default:
    5776 \fI\fImin protocol\fR\fR\fI = \fR\fICORE\fR\fI \fR
    5777 .sp
    5778 Example:
    5779 \fI\fImin protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR
     6650\m[blue]\fBlanman auth\fR\m[]
     6651parameter\&. Otherwise, you should never need to change this parameter\&.
     6652.sp
     6653Default:
     6654\fI\fImin protocol\fR\fR\fI = \fR\fI\FCCORE\F[]\fR\fI \fR
     6655.sp
     6656Example:
     6657\fI\fImin protocol\fR\fR\fI = \fR\fI\FCNT1\F[]\fR\fI \fR
    57806658.RE
    57816659
    57826660min receivefile size (G)
     6661.\" min receivefile size
    57836662.PP
    57846663.RS 4
    57856664This option changes the behavior of
    57866665\fBsmbd\fR(8)
    5787 when processing SMBwriteX calls\. Any incoming SMBwriteX call on a non\-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will be passed to any underlying kernel recvfile or splice system call (if there is no such call Samba will emulate in user space)\. This allows zero\-copy writes directly from network socket buffers into the filesystem buffer cache, if available\. It may improve performance but user testing is recommended\. If set to zero Samba processes SMBwriteX calls in the normal way\. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be nonzero\. The maximum value is 128k\. Values greater than 128k will be silently set to 128k\.
    5788 .sp
    5789 Note this option will have NO EFFECT if set on a SMB signed connection\.
    5790 .sp
    5791 The default is zero, which diables this option\.
    5792 .sp
    5793 Default:
    5794 \fI\fImin receivefile size\fR\fR\fI = \fR\fI0\fR\fI \fR
     6666when processing SMBwriteX calls\&. Any incoming SMBwriteX call on a non\-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will be passed to any underlying kernel recvfile or splice system call (if there is no such call Samba will emulate in user space)\&. This allows zero\-copy writes directly from network socket buffers into the filesystem buffer cache, if available\&. It may improve performance but user testing is recommended\&. If set to zero Samba processes SMBwriteX calls in the normal way\&. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be nonzero\&. The maximum value is 128k\&. Values greater than 128k will be silently set to 128k\&.
     6667.sp
     6668Note this option will have NO EFFECT if set on a SMB signed connection\&.
     6669.sp
     6670The default is zero, which diables this option\&.
     6671.sp
     6672Default:
     6673\fI\fImin receivefile size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    57956674.RE
    57966675
    57976676min wins ttl (G)
     6677.\" min wins ttl
    57986678.PP
    57996679.RS 4
    58006680This option tells
    58016681\fBnmbd\fR(8)
    5802 when acting as a WINS server (\fIwins support = yes\fR) what the minimum \'time to live\' of NetBIOS names that
    5803 nmbd
    5804 will grant will be (in seconds)\. You should never need to change this parameter\. The default is 6 hours (21600 seconds)\.
    5805 .sp
    5806 Default:
    5807 \fI\fImin wins ttl\fR\fR\fI = \fR\fI21600\fR\fI \fR
     6682when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the minimum \'time to live\' of NetBIOS names that
     6683\FCnmbd\F[]
     6684will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 hours (21600 seconds)\&.
     6685.sp
     6686Default:
     6687\fI\fImin wins ttl\fR\fR\fI = \fR\fI\FC21600\F[]\fR\fI \fR
    58086688.RE
    58096689
    58106690msdfs proxy (S)
    5811 .PP
    5812 .RS 4
    5813 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\.
    5814 .sp
    5815 Only Dfs roots can act as proxy shares\. Take a look at the
    5816 \fImsdfs root\fR
     6691.\" msdfs proxy
     6692.PP
     6693.RS 4
     6694This 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\&.
     6695.sp
     6696Only Dfs roots can act as proxy shares\&. Take a look at the
     6697\m[blue]\fBmsdfs root\fR\m[]
    58176698and
    5818 \fIhost msdfs\fR
    5819 options to find out how to set up a Dfs root share\.
     6699\m[blue]\fBhost msdfs\fR\m[]
     6700options to find out how to set up a Dfs root share\&.
    58206701.sp
    58216702\fINo default\fR
    58226703.sp
    58236704Example:
    5824 \fI\fImsdfs proxy\fR\fR\fI = \fR\fI\eotherserver\esomeshare\fR\fI \fR
     6705\fI\fImsdfs proxy\fR\fR\fI = \fR\fI\FC\eotherserver\esomeshare\F[]\fR\fI \fR
    58256706.RE
    58266707
    58276708msdfs root (S)
     6709.\" msdfs root
    58286710.PP
    58296711.RS 4
    58306712If set to
    5831 \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
    5832 \fImsdfs:serverA\e\eshareA,serverB\e\eshareB\fR
    5833 and so on\. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\.
    5834 .sp
    5835 Default:
    5836 \fI\fImsdfs root\fR\fR\fI = \fR\fIno\fR\fI \fR
     6713\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
     6714\FCmsdfs:serverA\e\eshareA,serverB\e\eshareB\F[]
     6715and so on\&. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\&.
     6716.sp
     6717Default:
     6718\fI\fImsdfs root\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    58376719.RE
    58386720
    58396721name cache timeout (G)
    5840 .PP
    5841 .RS 4
    5842 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\.
    5843 .sp
    5844 Default:
    5845 \fI\fIname cache timeout\fR\fR\fI = \fR\fI660\fR\fI \fR
    5846 .sp
    5847 Example:
    5848 \fI\fIname cache timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
     6722.\" name cache timeout
     6723.PP
     6724.RS 4
     6725Specifies 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\&.
     6726.sp
     6727Default:
     6728\fI\fIname cache timeout\fR\fR\fI = \fR\fI\FC660\F[]\fR\fI \fR
     6729.sp
     6730Example:
     6731\fI\fIname cache timeout\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    58496732.RE
    58506733
    58516734name resolve order (G)
    5852 .PP
    5853 .RS 4
    5854 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\.
    5855 .sp
    5856 The options are: "lmhosts", "host", "wins" and "bcast"\. They cause names to be resolved as follows:
     6735.\" name resolve order
     6736.PP
     6737.RS 4
     6738This 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\&.
     6739.sp
     6740The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows:
    58576741.sp
    58586742.RS 4
     
    58666750
    58676751\fBlmhosts\fR
    5868 : 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\.
     6752: 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\&.
    58696753.RE
    58706754.sp
     
    58806764\fBhost\fR
    58816765: Do a standard host name to IP address resolution, using the system
    5882 \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
    5883 \fI/etc/nsswitch\.conf\fR
    5884 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\.
     6766\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
     6767\FC/etc/nsswitch\&.conf\F[]
     6768file\&. 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\&.
    58856769.RE
    58866770.sp
     
    58956779\fBwins\fR
    58966780: Query a name with the IP address listed in the
    5897 \fIWINSSERVER\fR
    5898 parameter\. If no WINS server has been specified this method will be ignored\.
     6781\m[blue]\fBWINSSERVER\fR\m[]
     6782parameter\&. If no WINS server has been specified this method will be ignored\&.
    58996783.RE
    59006784.sp
     
    59096793\fBbcast\fR
    59106794: Do a broadcast on each of the known local interfaces listed in the
    5911 \fIinterfaces\fR
    5912 parameter\. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\.
    5913 .sp
    5914 .RE
    5915 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\.
    5916 .sp
    5917 When Samba is functioning in ADS security mode (security = ads) it is advised to use following settings for
     6795\m[blue]\fBinterfaces\fR\m[]
     6796parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.
     6797.sp
     6798.RE
     6799The example below will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup\&.
     6800.sp
     6801When Samba is functioning in ADS security mode (\FCsecurity = ads\F[]) it is advised to use following settings for
    59186802\fIname resolve order\fR:
    59196803.sp
    5920 name resolve order = wins bcast
    5921 .sp
    5922 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\.
    5923 .sp
    5924 Default:
    5925 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts host wins bcast\fR\fI \fR
    5926 .sp
    5927 Example:
    5928 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts bcast host\fR\fI \fR
     6804\FCname resolve order = wins bcast\F[]
     6805.sp
     6806DC 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\&.
     6807.sp
     6808Default:
     6809\fI\fIname resolve order\fR\fR\fI = \fR\fI\FClmhosts host wins bcast\F[]\fR\fI \fR
     6810.sp
     6811Example:
     6812\fI\fIname resolve order\fR\fR\fI = \fR\fI\FClmhosts bcast host\F[]\fR\fI \fR
    59296813.RE
    59306814
    59316815netbios aliases (G)
    5932 .PP
    5933 .RS 4
    5934 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\.
    5935 .sp
    5936 Default:
    5937 \fI\fInetbios aliases\fR\fR\fI = \fR\fI # empty string (no additional names)\fR\fI \fR
    5938 .sp
    5939 Example:
    5940 \fI\fInetbios aliases\fR\fR\fI = \fR\fITEST TEST1 TEST2\fR\fI \fR
     6816.\" netbios aliases
     6817.PP
     6818.RS 4
     6819This 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\&.
     6820.sp
     6821Default:
     6822\fI\fInetbios aliases\fR\fR\fI = \fR\fI\FC # empty string (no additional names)\F[]\fR\fI \fR
     6823.sp
     6824Example:
     6825\fI\fInetbios aliases\fR\fR\fI = \fR\fI\FCTEST TEST1 TEST2\F[]\fR\fI \fR
    59416826.RE
    59426827
    59436828netbios name (G)
    5944 .PP
    5945 .RS 4
    5946 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\.
     6829.\" netbios name
     6830.PP
     6831.RS 4
     6832This 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\&.
    59476833.sp
    59486834There 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
    5949 PIPE\. To avoid this problem, do not name your Samba\-3 server
    5950 PIPE\.
    5951 .sp
    5952 Default:
    5953 \fI\fInetbios name\fR\fR\fI = \fR\fI # machine DNS name\fR\fI \fR
    5954 .sp
    5955 Example:
    5956 \fI\fInetbios name\fR\fR\fI = \fR\fIMYNAME\fR\fI \fR
     6835\FCPIPE\F[]\&. To avoid this problem, do not name your Samba\-3 server
     6836\FCPIPE\F[]\&.
     6837.sp
     6838Default:
     6839\fI\fInetbios name\fR\fR\fI = \fR\fI\FC # machine DNS name\F[]\fR\fI \fR
     6840.sp
     6841Example:
     6842\fI\fInetbios name\fR\fR\fI = \fR\fI\FCMYNAME\F[]\fR\fI \fR
    59576843.RE
    59586844
    59596845netbios scope (G)
    5960 .PP
    5961 .RS 4
    5962 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\.
    5963 .sp
    5964 Default:
    5965 \fI\fInetbios scope\fR\fR\fI = \fR\fI\fR\fI \fR
     6846.\" netbios scope
     6847.PP
     6848.RS 4
     6849This sets the NetBIOS scope that Samba will operate under\&. This should not be set unless every machine on your LAN also sets this value\&.
     6850.sp
     6851Default:
     6852\fI\fInetbios scope\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    59666853.RE
    59676854
    59686855nis homedir (G)
    5969 .PP
    5970 .RS 4
    5971 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\.
    5972 .sp
    5973 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\.
    5974 .sp
    5975 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
    5976 \fIhomedir map\fR
    5977 and return the server listed there\.
    5978 .sp
    5979 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\.
    5980 .sp
    5981 Default:
    5982 \fI\fInis homedir\fR\fR\fI = \fR\fIno\fR\fI \fR
     6856.\" nis homedir
     6857.PP
     6858.RS 4
     6859Get 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\&.
     6860.sp
     6861When 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\&.
     6862.sp
     6863This 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
     6864\m[blue]\fBhomedir map\fR\m[]
     6865and return the server listed there\&.
     6866.sp
     6867Note 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\&.
     6868.sp
     6869Default:
     6870\fI\fInis homedir\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    59836871.RE
    59846872
    59856873nt acl support (S)
     6874.\" nt acl support
    59866875.PP
    59876876.RS 4
    59886877This boolean parameter controls whether
    59896878\fBsmbd\fR(8)
    5990 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\.
    5991 .sp
    5992 Default:
    5993 \fI\fInt acl support\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6879will 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\&.
     6880.sp
     6881Default:
     6882\fI\fInt acl support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    59946883.RE
    59956884
    59966885ntlm auth (G)
     6886.\" ntlm auth
    59976887.PP
    59986888.RS 4
    59996889This parameter determines whether or not
    60006890\fBsmbd\fR(8)
    6001 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\.
     6891will 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\&.
    60026892.sp
    60036893If this option, and
    6004 lanman auth
    6005 are both disabled, then only NTLMv2 logins will be permited\. Not all clients support NTLMv2, and most will require special configuration to use it\.
    6006 .sp
    6007 Default:
    6008 \fI\fIntlm auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6894\FClanman auth\F[]
     6895are both disabled, then only NTLMv2 logins will be permited\&. Not all clients support NTLMv2, and most will require special configuration to use it\&.
     6896.sp
     6897Default:
     6898\fI\fIntlm auth\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    60096899.RE
    60106900
    60116901nt pipe support (G)
     6902.\" nt pipe support
    60126903.PP
    60136904.RS 4
     
    60166907will allow Windows NT clients to connect to the NT SMB specific
    60176908\fBIPC$\fR
    6018 pipes\. This is a developer debugging option and can be left alone\.
    6019 .sp
    6020 Default:
    6021 \fI\fInt pipe support\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6909pipes\&. This is a developer debugging option and can be left alone\&.
     6910.sp
     6911Default:
     6912\fI\fInt pipe support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    60226913.RE
    60236914
    60246915nt status support (G)
     6916.\" nt status support
    60256917.PP
    60266918.RS 4
    60276919This boolean parameter controls whether
    60286920\fBsmbd\fR(8)
    6029 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
     6921will 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
    60306922\fBno\fR
    6031 then Samba offers exactly the same DOS error codes that versions prior to Samba 2\.2\.3 reported\.
    6032 .sp
    6033 You should not need to ever disable this parameter\.
    6034 .sp
    6035 Default:
    6036 \fI\fInt status support\fR\fR\fI = \fR\fIyes\fR\fI \fR
     6923then Samba offers exactly the same DOS error codes that versions prior to Samba 2\&.2\&.3 reported\&.
     6924.sp
     6925You should not need to ever disable this parameter\&.
     6926.sp
     6927Default:
     6928\fI\fInt status support\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    60376929.RE
    60386930
    60396931null passwords (G)
    6040 .PP
    6041 .RS 4
    6042 Allow or disallow client access to accounts that have null passwords\.
     6932.\" null passwords
     6933.PP
     6934.RS 4
     6935Allow or disallow client access to accounts that have null passwords\&.
    60436936.sp
    60446937See also
    6045 \fBsmbpasswd\fR(5)\.
    6046 .sp
    6047 Default:
    6048 \fI\fInull passwords\fR\fR\fI = \fR\fIno\fR\fI \fR
     6938\fBsmbpasswd\fR(5)\&.
     6939.sp
     6940Default:
     6941\fI\fInull passwords\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    60496942.RE
    60506943
    60516944obey pam restrictions (G)
    6052 .PP
    6053 .RS 4
    6054 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
    6055 \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\.
    6056 .sp
    6057 Default:
    6058 \fI\fIobey pam restrictions\fR\fR\fI = \fR\fIno\fR\fI \fR
     6945.\" obey pam restrictions
     6946.PP
     6947.RS 4
     6948When 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
     6949\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\&.
     6950.sp
     6951Default:
     6952\fI\fIobey pam restrictions\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    60596953.RE
    60606954
    60616955only user (S)
     6956.\" only user
    60626957.PP
    60636958.RS 4
    60646959This is a boolean option that controls whether connections with usernames not in the
    60656960\fIuser\fR
    6066 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
     6961list 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
    60676962\fIuser\fR
    60686963list and is only really useful in
    6069 \fIsecurity = share\fR
    6070 level security\.
    6071 .sp
    6072 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
    6073 user = %S
     6964\m[blue]\fBsecurity = share\fR\m[]
     6965level security\&.
     6966.sp
     6967Note 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
     6968\FCuser = %S\F[]
    60746969which means your
    60756970\fIuser\fR
    6076 list will be just the service name, which for home directories is the name of the user\.
    6077 .sp
    6078 Default:
    6079 \fI\fIonly user\fR\fR\fI = \fR\fIno\fR\fI \fR
     6971list will be just the service name, which for home directories is the name of the user\&.
     6972.sp
     6973Default:
     6974\fI\fIonly user\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    60806975.RE
    60816976
    60826977oplock break wait time (G)
    6083 .PP
    6084 .RS 4
    6085 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\.
    6086 .sp
     6978.\" oplock break wait time
     6979.PP
     6980.RS 4
     6981This 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\&.
     6982.if n \{\
     6983.sp
     6984.\}
     6985.RS 4
     6986.BM yellow
    60876987.it 1 an-trap
    60886988.nr an-no-space-flag 1
    60896989.nr an-break-flag 1
    60906990.br
    6091 Warning
    6092 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\.
    6093 
    6094 Default:
    6095 \fI\fIoplock break wait time\fR\fR\fI = \fR\fI0\fR\fI \fR
     6991.ps +1
     6992\fBWarning\fR
     6993.ps -1
     6994.br
     6995DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
     6996.sp .5v
     6997.EM yellow
     6998.RE
     6999Default:
     7000\fI\fIoplock break wait time\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    60967001.RE
    60977002
    60987003oplock contention limit (S)
     7004.\" oplock contention limit
    60997005.PP
    61007006.RS 4
     
    61037009advanced
    61047010\fBsmbd\fR(8)
    6105 tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file\.
     7011tuning option to improve the efficiency of the granting of oplocks under multiple client contention for the same file\&.
    61067012.sp
    61077013In brief it specifies a number, which causes
    6108 \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
    6109 smbd
    6110 to behave in a similar way to Windows NT\.
    6111 .sp
     7014\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
     7015\FCsmbd\F[]
     7016to behave in a similar way to Windows NT\&.
     7017.if n \{\
     7018.sp
     7019.\}
     7020.RS 4
     7021.BM yellow
    61127022.it 1 an-trap
    61137023.nr an-no-space-flag 1
    61147024.nr an-break-flag 1
    61157025.br
    6116 Warning
    6117 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\.
    6118 
    6119 Default:
    6120 \fI\fIoplock contention limit\fR\fR\fI = \fR\fI2\fR\fI \fR
     7026.ps +1
     7027\fBWarning\fR
     7028.ps -1
     7029.br
     7030DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
     7031.sp .5v
     7032.EM yellow
     7033.RE
     7034Default:
     7035\fI\fIoplock contention limit\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
    61217036.RE
    61227037
    61237038oplocks (S)
     7039.\" oplocks
    61247040.PP
    61257041.RS 4
    61267042This boolean option tells
    6127 smbd
    6128 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
    6129 \fISpeed\.txt\fR
     7043\FCsmbd\F[]
     7044whether 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
     7045\FCSpeed\&.txt\F[]
    61307046in the Samba
    6131 \fIdocs/\fR
    6132 directory\.
    6133 .sp
    6134 Oplocks may be selectively turned off on certain files with a share\. See the
    6135 \fIveto oplock files\fR
    6136 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
    6137 \fIkernel oplocks\fR
    6138 parameter for details\.
    6139 .sp
    6140 Default:
    6141 \fI\fIoplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
     7047\FCdocs/\F[]
     7048directory\&.
     7049.sp
     7050Oplocks may be selectively turned off on certain files with a share\&. See the
     7051\m[blue]\fBveto oplock files\fR\m[]
     7052parameter\&. 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
     7053\m[blue]\fBkernel oplocks\fR\m[]
     7054parameter for details\&.
     7055.sp
     7056Default:
     7057\fI\fIoplocks\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    61427058.RE
    61437059
    61447060os2 driver map (G)
    6145 .PP
    6146 .RS 4
    6147 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:
    6148 .sp
    6149 <nt driver name> = <os2 driver name>\.<device name>
     7061.\" os2 driver map
     7062.PP
     7063.RS 4
     7064The 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:
     7065.sp
     7066<nt driver name> = <os2 driver name>\&.<device name>
    61507067.sp
    61517068For example, a valid entry using the HP LaserJet 5 printer driver would appear as
    6152 HP LaserJet 5L = LASERJET\.HP LaserJet 5L\.
    6153 .sp
    6154 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\.
    6155 .sp
    6156 Default:
    6157 \fI\fIos2 driver map\fR\fR\fI = \fR\fI\fR\fI \fR
     7069\FCHP LaserJet 5L = LASERJET\&.HP LaserJet 5L\F[]\&.
     7070.sp
     7071The 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\&.
     7072.sp
     7073Default:
     7074\fI\fIos2 driver map\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    61587075.RE
    61597076
    61607077os level (G)
    6161 .PP
    6162 .RS 4
    6163 This integer value controls what level Samba advertises itself as for browse elections\. The value of this parameter determines whether
     7078.\" os level
     7079.PP
     7080.RS 4
     7081This integer value controls what level Samba advertises itself as for browse elections\&. The value of this parameter determines whether
    61647082\fBnmbd\fR(8)
    61657083has a chance of becoming a local master browser for the
    6166 \fIworkgroup\fR
    6167 in the local broadcast area\.
     7084\m[blue]\fBworkgroup\fR\m[]
     7085in the local broadcast area\&.
    61687086.sp
    61697087\fI Note:\fR
    6170 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\.
     7088By 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\&.
    61717089\fINote:\fR
    6172 The maximum value for this parameter is 255\. If you use higher values, counting will start at 0!
    6173 .sp
    6174 Default:
    6175 \fI\fIos level\fR\fR\fI = \fR\fI20\fR\fI \fR
    6176 .sp
    6177 Example:
    6178 \fI\fIos level\fR\fR\fI = \fR\fI65\fR\fI \fR
     7090The maximum value for this parameter is 255\&. If you use higher values, counting will start at 0!
     7091.sp
     7092Default:
     7093\fI\fIos level\fR\fR\fI = \fR\fI\FC20\F[]\fR\fI \fR
     7094.sp
     7095Example:
     7096\fI\fIos level\fR\fR\fI = \fR\fI\FC65\F[]\fR\fI \fR
    61797097.RE
    61807098
    61817099pam password change (G)
    6182 .PP
    6183 .RS 4
    6184 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
    6185 \fIpasswd program\fR\. It should be possible to enable this without changing your
    6186 \fIpasswd chat\fR
    6187 parameter for most setups\.
    6188 .sp
    6189 Default:
    6190 \fI\fIpam password change\fR\fR\fI = \fR\fIno\fR\fI \fR
     7100.\" pam password change
     7101.PP
     7102.RS 4
     7103With 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
     7104\m[blue]\fBpasswd program\fR\m[]\&. It should be possible to enable this without changing your
     7105\m[blue]\fBpasswd chat\fR\m[]
     7106parameter for most setups\&.
     7107.sp
     7108Default:
     7109\fI\fIpam password change\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    61917110.RE
    61927111
    61937112panic action (G)
     7113.\" panic action
    61947114.PP
    61957115.RS 4
     
    61987118or
    61997119\fBnmbd\fR(8)
    6200 crashes\. This is usually used to draw attention to the fact that a problem occurred\.
    6201 .sp
    6202 Default:
    6203 \fI\fIpanic action\fR\fR\fI = \fR\fI\fR\fI \fR
    6204 .sp
    6205 Example:
    6206 \fI\fIpanic action\fR\fR\fI = \fR\fI"/bin/sleep 90000"\fR\fI \fR
     7120crashes\&. This is usually used to draw attention to the fact that a problem occurred\&.
     7121.sp
     7122Default:
     7123\fI\fIpanic action\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7124.sp
     7125Example:
     7126\fI\fIpanic action\fR\fR\fI = \fR\fI\FC"/bin/sleep 90000"\F[]\fR\fI \fR
    62077127.RE
    62087128
    62097129paranoid server security (G)
    6210 .PP
    6211 .RS 4
    6212 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\.
    6213 .sp
    6214 Disabling this option prevents Samba from making this check, which involves deliberatly attempting a bad logon to the remote server\.
    6215 .sp
    6216 Default:
    6217 \fI\fIparanoid server security\fR\fR\fI = \fR\fIyes\fR\fI \fR
     7130.\" paranoid server security
     7131.PP
     7132.RS 4
     7133Some 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\&.
     7134.sp
     7135Disabling this option prevents Samba from making this check, which involves deliberatly attempting a bad logon to the remote server\&.
     7136.sp
     7137Default:
     7138\fI\fIparanoid server security\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    62187139.RE
    62197140
    62207141passdb backend (G)
    6221 .PP
    6222 .RS 4
    6223 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\.
    6224 .sp
    6225 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\.
     7142.\" passdb backend
     7143.PP
     7144.RS 4
     7145This 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\&.
     7146.sp
     7147The 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\&.
    62267148.sp
    62277149Available backends can include:
     
    62357157.IP \(bu 2.3
    62367158.\}
    6237 smbpasswd
    6238 \- The default smbpasswd backend\. Takes a path to the smbpasswd file as an optional argument\.
    6239 .RE
    6240 .sp
    6241 .RS 4
    6242 .ie n \{\
    6243 \h'-04'\(bu\h'+03'\c
    6244 .\}
    6245 .el \{\
    6246 .sp -1
    6247 .IP \(bu 2.3
    6248 .\}
    6249 tdbsam
    6250 \- The TDB based password storage backend\. Takes a path to the TDB as an optional argument (defaults to passdb\.tdb in the
    6251 \fIprivate dir\fR
    6252 directory\.
    6253 .RE
    6254 .sp
    6255 .RS 4
    6256 .ie n \{\
    6257 \h'-04'\(bu\h'+03'\c
    6258 .\}
    6259 .el \{\
    6260 .sp -1
    6261 .IP \(bu 2.3
    6262 .\}
    6263 ldapsam
    6264 \- The LDAP based passdb backend\. Takes an LDAP URL as an optional argument (defaults to
    6265 ldap://localhost)
    6266 .sp
    6267 LDAP connections should be secured where possible\. This may be done using either Start\-TLS (see
    6268 \fIldap ssl\fR) or by specifying
     7159\FCsmbpasswd\F[]
     7160\- The default smbpasswd backend\&. Takes a path to the smbpasswd file as an optional argument\&.
     7161.RE
     7162.sp
     7163.RS 4
     7164.ie n \{\
     7165\h'-04'\(bu\h'+03'\c
     7166.\}
     7167.el \{\
     7168.sp -1
     7169.IP \(bu 2.3
     7170.\}
     7171\FCtdbsam\F[]
     7172\- The TDB based password storage backend\&. Takes a path to the TDB as an optional argument (defaults to passdb\&.tdb in the
     7173\m[blue]\fBprivate dir\fR\m[]
     7174directory\&.
     7175.RE
     7176.sp
     7177.RS 4
     7178.ie n \{\
     7179\h'-04'\(bu\h'+03'\c
     7180.\}
     7181.el \{\
     7182.sp -1
     7183.IP \(bu 2.3
     7184.\}
     7185\FCldapsam\F[]
     7186\- The LDAP based passdb backend\&. Takes an LDAP URL as an optional argument (defaults to
     7187\FCldap://localhost\F[])
     7188.sp
     7189LDAP connections should be secured where possible\&. This may be done using either Start\-TLS (see
     7190\m[blue]\fBldap ssl\fR\m[]) or by specifying
    62697191\fIldaps://\fR
    6270 in the URL argument\.
    6271 .sp
    6272 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\.
     7192in the URL argument\&.
     7193.sp
     7194Multiple 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\&.
    62737195.sp
    62747196.RE
     
    62767198        Examples of use are:
    62777199.sp
    6278 .RS 4
     7200.if n \{\
     7201.RS 4
     7202.\}
     7203.fam C
     7204.ps -1
    62797205.nf
    6280 passdb backend = tdbsam:/etc/samba/private/passdb\.tdb
     7206.if t \{\
     7207.sp -1
     7208.\}
     7209.BB lightgray adjust-for-leading-newline
     7210.sp -1
     7211
     7212passdb backend = tdbsam:/etc/samba/private/passdb\&.tdb
    62817213
    62827214or multi server LDAP URL with OpenLDAP library:
    62837215
    6284 passdb backend = ldapsam:"ldap://ldap\-1\.example\.com ldap://ldap\-2\.example\.com"
     7216passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap://ldap\-2\&.example\&.com"
    62857217
    62867218or multi server LDAP URL with Netscape based LDAP library:
    62877219
    6288 passdb backend = ldapsam:"ldap://ldap\-1\.example\.com ldap\-2\.example\.com"
     7220passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap\-2\&.example\&.com"
     7221.EB lightgray adjust-for-leading-newline
     7222.if t \{\
     7223.sp 1
     7224.\}
    62897225.fi
    6290 .RE
    6291 Default:
    6292 \fI\fIpassdb backend\fR\fR\fI = \fR\fIsmbpasswd\fR\fI \fR
     7226.fam
     7227.ps +1
     7228.if n \{\
     7229.RE
     7230.\}
     7231.sp
     7232Default:
     7233\fI\fIpassdb backend\fR\fR\fI = \fR\fI\FCsmbpasswd\F[]\fR\fI \fR
    62937234.RE
    62947235
    62957236passdb expand explicit (G)
    6296 .PP
    6297 .RS 4
    6298 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\.
    6299 .sp
    6300 Default:
    6301 \fI\fIpassdb expand explicit\fR\fR\fI = \fR\fIno\fR\fI \fR
     7237.\" passdb expand explicit
     7238.PP
     7239.RS 4
     7240This 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\&.
     7241.sp
     7242Default:
     7243\fI\fIpassdb expand explicit\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    63027244.RE
    63037245
    63047246passwd chat debug (G)
     7247.\" passwd chat debug
    63057248.PP
    63067249.RS 4
    63077250This boolean specifies if the passwd chat script parameter is run in
    63087251\fIdebug\fR
    6309 mode\. In this mode the strings passed to and received from the passwd chat are printed in the
     7252mode\&. In this mode the strings passed to and received from the passwd chat are printed in the
    63107253\fBsmbd\fR(8)
    63117254log with a
    6312 \fIdebug level\fR
    6313 of 100\. This is a dangerous option as it will allow plaintext passwords to be seen in the
    6314 smbd
    6315 log\. It is available to help Samba admins debug their
     7255\m[blue]\fBdebug level\fR\m[]
     7256of 100\&. This is a dangerous option as it will allow plaintext passwords to be seen in the
     7257\FCsmbd\F[]
     7258log\&. It is available to help Samba admins debug their
    63167259\fIpasswd chat\fR
    63177260scripts when calling the
    63187261\fIpasswd program\fR
    6319 and should be turned off after this has been done\. This option has no effect if the
    6320 \fIpam password change\fR
    6321 parameter is set\. This parameter is off by default\.
    6322 .sp
    6323 Default:
    6324 \fI\fIpasswd chat debug\fR\fR\fI = \fR\fIno\fR\fI \fR
     7262and should be turned off after this has been done\&. This option has no effect if the
     7263\m[blue]\fBpam password change\fR\m[]
     7264parameter is set\&. This parameter is off by default\&.
     7265.sp
     7266Default:
     7267\fI\fIpasswd chat debug\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    63257268.RE
    63267269
    63277270passwd chat timeout (G)
    6328 .PP
    6329 .RS 4
    6330 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\.
    6331 .sp
    6332 Default:
    6333 \fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI2\fR\fI \fR
     7271.\" passwd chat timeout
     7272.PP
     7273.RS 4
     7274This 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\&.
     7275.sp
     7276Default:
     7277\fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI\FC2\F[]\fR\fI \fR
    63347278.RE
    63357279
    63367280passwd chat (G)
     7281.\" passwd chat
    63377282.PP
    63387283.RS 4
     
    63417286conversation that takes places between
    63427287\fBsmbd\fR(8)
    6343 and the local password changing program to change the user\'s password\. The string describes a sequence of response\-receive pairs that
     7288and the local password changing program to change the user\'s password\&. The string describes a sequence of response\-receive pairs that
    63447289\fBsmbd\fR(8)
    63457290uses to determine what to send to the
    6346 \fIpasswd program\fR
    6347 and what to expect back\. If the expected output is not received then the password is not changed\.
    6348 .sp
    6349 This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc)\.
     7291\m[blue]\fBpasswd program\fR\m[]
     7292and what to expect back\&. If the expected output is not received then the password is not changed\&.
     7293.sp
     7294This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc)\&.
    63507295.sp
    63517296Note that this parameter only is used if the
    6352 \fIunix password sync\fR
     7297\m[blue]\fBunix password sync\fR\m[]
    63537298parameter is set to
    6354 \fByes\fR\. This sequence is then called
     7299\fByes\fR\&. This sequence is then called
    63557300\fIAS ROOT\fR
    6356 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
    6357 \fIpasswd program\fR
    6358 must be executed on the NIS master\.
     7301when 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
     7302\m[blue]\fBpasswd program\fR\m[]
     7303must be executed on the NIS master\&.
    63597304.sp
    63607305The string can contain the macro
    63617306\fI%n\fR
    6362 which is substituted for the new password\. The old passsword (\fI%o\fR) is only available when
    6363 \fIencrypt passwords\fR
    6364 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\.
    6365 .sp
    6366 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\.
     7307which is substituted for the new password\&. The old passsword (\fI%o\fR) is only available when
     7308\m[blue]\fBencrypt passwords\fR\m[]
     7309has 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\&.
     7310.sp
     7311If 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\&.
    63677312.sp
    63687313If the
    6369 \fIpam password change\fR
     7314\m[blue]\fBpam password change\fR\m[]
    63707315parameter is set to
    6371 \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\.
    6372 .sp
    6373 Default:
    6374 \fI\fIpasswd chat\fR\fR\fI = \fR\fI*new*password* %n\en*new*password* %n\en *changed*\fR\fI \fR
    6375 .sp
    6376 Example:
    6377 \fI\fIpasswd chat\fR\fR\fI = \fR\fI"*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"\fR\fI \fR
     7316\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\&.
     7317.sp
     7318Default:
     7319\fI\fIpasswd chat\fR\fR\fI = \fR\fI\FC*new*password* %n\en*new*password* %n\en *changed*\F[]\fR\fI \fR
     7320.sp
     7321Example:
     7322\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
    63787323.RE
    63797324
    63807325passwd program (G)
    6381 .PP
    6382 .RS 4
    6383 The name of a program that can be used to set UNIX user passwords\. Any occurrences of
     7326.\" passwd program
     7327.PP
     7328.RS 4
     7329The name of a program that can be used to set UNIX user passwords\&. Any occurrences of
    63847330\fI%u\fR
    6385 will be replaced with the user name\. The user name is checked for existence before calling the password changing program\.
     7331will be replaced with the user name\&. The user name is checked for existence before calling the password changing program\&.
    63867332.sp
    63877333Also note that many passwd programs insist in
    63887334\fIreasonable \fR
    6389 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\.
     7335passwords, 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\&.
    63907336.sp
    63917337\fINote\fR
     
    63967342then this program is called
    63977343\fIAS ROOT\fR
    6398 before the SMB password in the smbpasswd file is changed\. If this UNIX password change fails, then
    6399 smbd
    6400 will fail to change the SMB password also (this is by design)\.
     7344before the SMB password in the smbpasswd file is changed\&. If this UNIX password change fails, then
     7345\FCsmbd\F[]
     7346will fail to change the SMB password also (this is by design)\&.
    64017347.sp
    64027348If the
     
    64067352for
    64077353\fIALL\fR
    6408 programs called, and must be examined for security implications\. Note that by default
     7354programs called, and must be examined for security implications\&. Note that by default
    64097355\fIunix password sync\fR
    64107356is set to
    6411 \fBno\fR\.
    6412 .sp
    6413 Default:
    6414 \fI\fIpasswd program\fR\fR\fI = \fR\fI\fR\fI \fR
    6415 .sp
    6416 Example:
    6417 \fI\fIpasswd program\fR\fR\fI = \fR\fI/bin/passwd %u\fR\fI \fR
     7357\fBno\fR\&.
     7358.sp
     7359Default:
     7360\fI\fIpasswd program\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7361.sp
     7362Example:
     7363\fI\fIpasswd program\fR\fR\fI = \fR\fI\FC/bin/passwd %u\F[]\fR\fI \fR
    64187364.RE
    64197365
    64207366password level (G)
    6421 .PP
    6422 .RS 4
    6423 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\.
    6424 .sp
    6425 This parameter defines the maximum number of characters that may be upper case in passwords\.
    6426 .sp
    6427 For example, say the password given was "FRED"\. If
     7367.\" password level
     7368.PP
     7369.RS 4
     7370Some 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\&.
     7371.sp
     7372This parameter defines the maximum number of characters that may be upper case in passwords\&.
     7373.sp
     7374For example, say the password given was "FRED"\&. If
    64287375\fI password level\fR
    64297376is set to 1, the following combinations would be tried if "FRED" failed:
     
    64357382was set to 2, the following combinations would also be tried:
    64367383.sp
    6437 "FRed", "FrEd", "FreD", "fREd", "fReD", "frED", \.\.
    6438 .sp
    6439 And so on\.
    6440 .sp
    6441 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\.
    6442 .sp
    6443 A value of zero will cause only two attempts to be made \- the password as is and the password in all\-lower case\.
    6444 .sp
    6445 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
    6446 \fIencrypt passwords = No\fR\.
    6447 .sp
    6448 Default:
    6449 \fI\fIpassword level\fR\fR\fI = \fR\fI0\fR\fI \fR
    6450 .sp
    6451 Example:
    6452 \fI\fIpassword level\fR\fR\fI = \fR\fI4\fR\fI \fR
     7384"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", \&.\&.
     7385.sp
     7386And so on\&.
     7387.sp
     7388The 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\&.
     7389.sp
     7390A value of zero will cause only two attempts to be made \- the password as is and the password in all\-lower case\&.
     7391.sp
     7392This 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
     7393\m[blue]\fBencrypt passwords = No\fR\m[]\&.
     7394.sp
     7395Default:
     7396\fI\fIpassword level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     7397.sp
     7398Example:
     7399\fI\fIpassword level\fR\fR\fI = \fR\fI\FC4\F[]\fR\fI \fR
    64537400.RE
    64547401
    64557402password server (G)
     7403.\" password server
    64567404.PP
    64577405.RS 4
    64587406By specifying the name of another SMB server or Active Directory domain controller with this option, and using
    6459 security = [ads|domain|server]
    6460 it is possible to get Samba to to do all its username/password validation using a specific remote server\.
    6461 .sp
    6462 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\.
     7407\FCsecurity = [ads|domain|server]\F[]
     7408it is possible to get Samba to to do all its username/password validation using a specific remote server\&.
     7409.sp
     7410This 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\&.
    64637411.sp
    64647412If parameter is a name, it is looked up using the parameter
    6465 \fIname resolve order\fR
    6466 and so may resolved by any method and order described in that parameter\.
    6467 .sp
    6468 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\.
    6469 .sp
     7413\m[blue]\fBname resolve order\fR\m[]
     7414and so may resolved by any method and order described in that parameter\&.
     7415.sp
     7416The 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\&.
     7417.if n \{\
     7418.sp
     7419.\}
     7420.RS 4
     7421.BM yellow
    64707422.it 1 an-trap
    64717423.nr an-no-space-flag 1
    64727424.nr an-break-flag 1
    64737425.br
    6474 Note
    6475 Using a password server means your UNIX box (running Samba) is only as secure as your password server\.
    6476 \fIDO NOT CHOOSE A PASSWORD SERVER THAT YOU DON\'T COMPLETELY TRUST\fR\.
    6477 
    6478 Never point a Samba server at itself for password serving\. This will cause a loop and could lock up your Samba server!
     7426.ps +1
     7427\fBNote\fR
     7428.ps -1
     7429.br
     7430Using a password server means your UNIX box (running Samba) is only as secure as your password server\&.
     7431\fIDO NOT CHOOSE A PASSWORD SERVER THAT YOU DON\'T COMPLETELY TRUST\fR\&.
     7432.sp .5v
     7433.EM yellow
     7434.RE
     7435Never point a Samba server at itself for password serving\&. This will cause a loop and could lock up your Samba server!
    64797436.sp
    64807437The name of the password server takes the standard substitutions, but probably the only useful one is
    6481 \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!
     7438\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!
    64827439.sp
    64837440If the
     
    64867443\fBdomain\fR
    64877444or
    6488 \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
    6489 security = domain
     7445\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
     7446\FC security = domain\F[]
    64907447is that if you list several hosts in the
    64917448\fIpassword server\fR
    64927449option then
    6493 smbd
    6494 will try each in turn till it finds one that responds\. This is useful in case your primary server goes down\.
     7450\FCsmbd \F[]
     7451will try each in turn till it finds one that responds\&. This is useful in case your primary server goes down\&.
    64957452.sp
    64967453If the
     
    64987455option 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
    64997456\fBWORKGROUP<1C>\fR
    6500 and then contacting each server returned in the list of IP addresses from the name resolution source\.
    6501 .sp
    6502 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\.
     7457and then contacting each server returned in the list of IP addresses from the name resolution source\&.
     7458.sp
     7459If 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\&.
    65037460.sp
    65047461If the
     
    65067463parameter is set to
    65077464\fBserver\fR, then there are different restrictions that
    6508 security = domain
     7465\FCsecurity = domain\F[]
    65097466doesn\'t suffer from:
    65107467.sp
     
    65207477\fIpassword server\fR
    65217478parameter, however if an
    6522 smbd
     7479\FCsmbd\F[]
    65237480makes a connection to a password server, and then the password server fails, no more users will be able to be authenticated from this
    6524 smbd\. This is a restriction of the SMB/CIFS protocol when in
    6525 security = server
    6526 mode and cannot be fixed in Samba\.
     7481\FCsmbd\F[]\&. This is a restriction of the SMB/CIFS protocol when in
     7482\FCsecurity = server \F[]
     7483mode and cannot be fixed in Samba\&.
    65277484.RE
    65287485.sp
     
    65367493.\}
    65377494If 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
    6538 security = server
    6539 mode the network logon will appear to come from there rather than from the users workstation\.
    6540 .sp
    6541 .RE
    6542 Default:
    6543 \fI\fIpassword server\fR\fR\fI = \fR\fI*\fR\fI \fR
    6544 .sp
    6545 Example:
    6546 \fI\fIpassword server\fR\fR\fI = \fR\fINT\-PDC, NT\-BDC1, NT\-BDC2, *\fR\fI \fR
    6547 .sp
    6548 Example:
    6549 \fI\fIpassword server\fR\fR\fI = \fR\fIwindc\.mydomain\.com:389 192\.168\.1\.101 *\fR\fI \fR
     7495\FC security = server\F[]
     7496mode the network logon will appear to come from there rather than from the users workstation\&.
     7497.sp
     7498.RE
     7499Default:
     7500\fI\fIpassword server\fR\fR\fI = \fR\fI\FC*\F[]\fR\fI \fR
     7501.sp
     7502Example:
     7503\fI\fIpassword server\fR\fR\fI = \fR\fI\FCNT\-PDC, NT\-BDC1, NT\-BDC2, *\F[]\fR\fI \fR
     7504.sp
     7505Example:
     7506\fI\fIpassword server\fR\fR\fI = \fR\fI\FCwindc\&.mydomain\&.com:389 192\&.168\&.1\&.101 *\F[]\fR\fI \fR
    65507507.RE
    65517508
    65527509directory
     7510.\" directory
    65537511.PP
    65547512.RS 4
    65557513This parameter is a synonym for
    6556 path\.
     7514path\&.
    65577515.RE
    65587516
    65597517path (S)
    6560 .PP
    6561 .RS 4
    6562 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\.
    6563 .sp
    6564 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\.
     7518.\" path
     7519.PP
     7520.RS 4
     7521This 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\&.
     7522.sp
     7523For 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\&.
    65657524.sp
    65667525Any occurrences of
    65677526\fI%u\fR
    6568 in the path will be replaced with the UNIX username that the client is using on this connection\. Any occurrences of
     7527in the path will be replaced with the UNIX username that the client is using on this connection\&. Any occurrences of
    65697528\fI%m\fR
    6570 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\.
     7529will 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\&.
    65717530.sp
    65727531Note that this path will be based on
    6573 \fIroot dir\fR
    6574 if one was specified\.
    6575 .sp
    6576 Default:
    6577 \fI\fIpath\fR\fR\fI = \fR\fI\fR\fI \fR
    6578 .sp
    6579 Example:
    6580 \fI\fIpath\fR\fR\fI = \fR\fI/home/fred\fR\fI \fR
     7532\m[blue]\fBroot dir\fR\m[]
     7533if one was specified\&.
     7534.sp
     7535Default:
     7536\fI\fIpath\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7537.sp
     7538Example:
     7539\fI\fIpath\fR\fR\fI = \fR\fI\FC/home/fred\F[]\fR\fI \fR
    65817540.RE
    65827541
    65837542pid directory (G)
    6584 .PP
    6585 .RS 4
    6586 This option specifies the directory where pid files will be placed\.
    6587 .sp
    6588 Default:
    6589 \fI\fIpid directory\fR\fR\fI = \fR\fI${prefix}/var/locks\fR\fI \fR
    6590 .sp
    6591 Example:
    6592 \fI\fIpid directory\fR\fR\fI = \fR\fIpid directory = /var/run/\fR\fI \fR
     7543.\" pid directory
     7544.PP
     7545.RS 4
     7546This option specifies the directory where pid files will be placed\&.
     7547.sp
     7548Default:
     7549\fI\fIpid directory\fR\fR\fI = \fR\fI\FC${prefix}/var/locks\F[]\fR\fI \fR
     7550.sp
     7551Example:
     7552\fI\fIpid directory\fR\fR\fI = \fR\fI\FCpid directory = /var/run/\F[]\fR\fI \fR
    65937553.RE
    65947554
    65957555posix locking (S)
     7556.\" posix locking
    65967557.PP
    65977558.RS 4
    65987559The
    65997560\fBsmbd\fR(8)
    6600 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\.
    6601 .sp
    6602 Default:
    6603 \fI\fIposix locking\fR\fR\fI = \fR\fIyes\fR\fI \fR
     7561daemon 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\&.
     7562.sp
     7563Default:
     7564\fI\fIposix locking\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    66047565.RE
    66057566
    66067567postexec (S)
    6607 .PP
    6608 .RS 4
    6609 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\.
     7568.\" postexec
     7569.PP
     7570.RS 4
     7571This 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\&.
    66107572.sp
    66117573An interesting example may be to unmount server resources:
    66127574.sp
    6613 postexec = /etc/umount /cdrom
    6614 .sp
    6615 Default:
    6616 \fI\fIpostexec\fR\fR\fI = \fR\fI\fR\fI \fR
    6617 .sp
    6618 Example:
    6619 \fI\fIpostexec\fR\fR\fI = \fR\fIecho \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log\fR\fI \fR
     7575\FCpostexec = /etc/umount /cdrom\F[]
     7576.sp
     7577Default:
     7578\fI\fIpostexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7579.sp
     7580Example:
     7581\fI\fIpostexec\fR\fR\fI = \fR\fI\FCecho \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log\F[]\fR\fI \fR
    66207582.RE
    66217583
    66227584preexec close (S)
     7585.\" preexec close
    66237586.PP
    66247587.RS 4
    66257588This boolean option controls whether a non\-zero return code from
    6626 \fIpreexec\fR
    6627 should close the service being connected to\.
    6628 .sp
    6629 Default:
    6630 \fI\fIpreexec close\fR\fR\fI = \fR\fIno\fR\fI \fR
     7589\m[blue]\fBpreexec\fR\m[]
     7590should close the service being connected to\&.
     7591.sp
     7592Default:
     7593\fI\fIpreexec close\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    66317594.RE
    66327595
    66337596exec
     7597.\" exec
    66347598.PP
    66357599.RS 4
    66367600This parameter is a synonym for
    6637 preexec\.
     7601preexec\&.
    66387602.RE
    66397603
    66407604preexec (S)
    6641 .PP
    6642 .RS 4
    6643 This option specifies a command to be run whenever the service is connected to\. It takes the usual substitutions\.
    6644 .sp
    6645 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:
    6646 .sp
    6647 
    6648 preexec = csh \-c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient \-M %m \-I %I\' &
     7605.\" preexec
     7606.PP
     7607.RS 4
     7608This option specifies a command to be run whenever the service is connected to\&. It takes the usual substitutions\&.
     7609.sp
     7610An 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:
     7611.sp
     7612
     7613\FCpreexec = csh \-c \'echo \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient \-M %m \-I %I\' & \F[]
    66497614.sp
    66507615Of course, this could get annoying after a while :\-)
    66517616.sp
    66527617See also
    6653 \fIpreexec close\fR
     7618\m[blue]\fBpreexec close\fR\m[]
    66547619and
    6655 \fIpostexec\fR\.
    6656 .sp
    6657 Default:
    6658 \fI\fIpreexec\fR\fR\fI = \fR\fI\fR\fI \fR
    6659 .sp
    6660 Example:
    6661 \fI\fIpreexec\fR\fR\fI = \fR\fIecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fR\fI \fR
     7620\m[blue]\fBpostexec\fR\m[]\&.
     7621.sp
     7622Default:
     7623\fI\fIpreexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7624.sp
     7625Example:
     7626\fI\fIpreexec\fR\fR\fI = \fR\fI\FCecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\F[]\fR\fI \fR
    66627627.RE
    66637628
    66647629prefered master
     7630.\" prefered master
    66657631.PP
    66667632.RS 4
    66677633This parameter is a synonym for
    6668 preferred master\.
     7634preferred master\&.
    66697635.RE
    66707636
    66717637preferred master (G)
     7638.\" preferred master
    66727639.PP
    66737640.RS 4
    66747641This boolean parameter controls if
    66757642\fBnmbd\fR(8)
    6676 is a preferred master browser for its workgroup\.
     7643is a preferred master browser for its workgroup\&.
    66777644.sp
    66787645If this is set to
    66797646\fByes\fR, on startup,
    6680 nmbd
    6681 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
    6682 \fIdomain master = yes\fR, so that
    6683 nmbd
    6684 can guarantee becoming a domain master\.
    6685 .sp
    6686 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\.
    6687 .sp
    6688 Default:
    6689 \fI\fIpreferred master\fR\fR\fI = \fR\fIauto\fR\fI \fR
     7647\FCnmbd\F[]
     7648will 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
     7649\m[blue]\fBdomain master = yes\fR\m[], so that
     7650\FCnmbd\F[]
     7651can guarantee becoming a domain master\&.
     7652.sp
     7653Use 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\&.
     7654.sp
     7655Default:
     7656\fI\fIpreferred master\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
    66907657.RE
    66917658
    66927659preload modules (G)
    6693 .PP
    6694 .RS 4
    6695 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\.
    6696 .sp
    6697 Default:
    6698 \fI\fIpreload modules\fR\fR\fI = \fR\fI\fR\fI \fR
    6699 .sp
    6700 Example:
    6701 \fI\fIpreload modules\fR\fR\fI = \fR\fI/usr/lib/samba/passdb/mysql\.so\fR\fI \fR
     7660.\" preload modules
     7661.PP
     7662.RS 4
     7663This 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\&.
     7664.sp
     7665Default:
     7666\fI\fIpreload modules\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7667.sp
     7668Example:
     7669\fI\fIpreload modules\fR\fR\fI = \fR\fI\FC/usr/lib/samba/passdb/mysql\&.so\F[]\fR\fI \fR
    67027670.RE
    67037671
    67047672auto services
     7673.\" auto services
    67057674.PP
    67067675.RS 4
    67077676This parameter is a synonym for
    6708 preload\.
     7677preload\&.
    67097678.RE
    67107679
    67117680preload (G)
    6712 .PP
    6713 .RS 4
    6714 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\.
     7681.\" preload
     7682.PP
     7683.RS 4
     7684This 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\&.
    67157685.sp
    67167686Note that if you just want all printers in your printcap file loaded then the
    6717 \fIload printers\fR
    6718 option is easier\.
    6719 .sp
    6720 Default:
    6721 \fI\fIpreload\fR\fR\fI = \fR\fI\fR\fI \fR
    6722 .sp
    6723 Example:
    6724 \fI\fIpreload\fR\fR\fI = \fR\fIfred lp colorlp\fR\fI \fR
     7687\m[blue]\fBload printers\fR\m[]
     7688option is easier\&.
     7689.sp
     7690Default:
     7691\fI\fIpreload\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7692.sp
     7693Example:
     7694\fI\fIpreload\fR\fR\fI = \fR\fI\FCfred lp colorlp\F[]\fR\fI \fR
    67257695.RE
    67267696
    67277697preserve case (S)
     7698.\" preserve case
    67287699.PP
    67297700.RS 4
    67307701This controls if new filenames are created with the case that the client passes, or if they are forced to be the
    6731 \fIdefault case\fR\.
     7702\m[blue]\fBdefault case\fR\m[]\&.
    67327703.sp
    67337704See the section on
    67347705NAME MANGLING
    6735 for a fuller discussion\.
    6736 .sp
    6737 Default:
    6738 \fI\fIpreserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR
     7706for a fuller discussion\&.
     7707.sp
     7708Default:
     7709\fI\fIpreserve case\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    67397710.RE
    67407711
    67417712print ok
     7713.\" print ok
    67427714.PP
    67437715.RS 4
    67447716This parameter is a synonym for
    6745 printable\.
     7717printable\&.
    67467718.RE
    67477719
    67487720printable (S)
     7721.\" printable
    67497722.PP
    67507723.RS 4
    67517724If this parameter is
    6752 \fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\.
    6753 .sp
    6754 Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\. The
    6755 \fIread only\fR
    6756 parameter controls only non\-printing access to the resource\.
    6757 .sp
    6758 Default:
    6759 \fI\fIprintable\fR\fR\fI = \fR\fIno\fR\fI \fR
     7725\fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\&.
     7726.sp
     7727Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\&. The
     7728\m[blue]\fBread only\fR\m[]
     7729parameter controls only non\-printing access to the resource\&.
     7730.sp
     7731Default:
     7732\fI\fIprintable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    67607733.RE
    67617734
    67627735printcap cache time (G)
    6763 .PP
    6764 .RS 4
    6765 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\.
    6766 .sp
    6767 Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\.
    6768 .sp
    6769 Default:
    6770 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI750\fR\fI \fR
    6771 .sp
    6772 Example:
    6773 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI600\fR\fI \fR
     7736.\" printcap cache time
     7737.PP
     7738.RS 4
     7739This 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\&.
     7740.sp
     7741Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\&.
     7742.sp
     7743Default:
     7744\fI\fIprintcap cache time\fR\fR\fI = \fR\fI\FC750\F[]\fR\fI \fR
     7745.sp
     7746Example:
     7747\fI\fIprintcap cache time\fR\fR\fI = \fR\fI\FC600\F[]\fR\fI \fR
    67747748.RE
    67757749
    67767750printcap
     7751.\" printcap
    67777752.PP
    67787753.RS 4
    67797754This parameter is a synonym for
    6780 printcap name\.
     7755printcap name\&.
    67817756.RE
    67827757
    67837758printcap name (G)
     7759.\" printcap name
    67847760.PP
    67857761.RS 4
    67867762This parameter may be used to override the compiled\-in default printcap name used by the server (usually
    6787 \fI /etc/printcap\fR)\. See the discussion of the
     7763\FC /etc/printcap\F[])\&. See the discussion of the
    67887764[printers]
    6789 section above for reasons why you might want to do this\.
     7765section above for reasons why you might want to do this\&.
    67907766.sp
    67917767To use the CUPS printing interface set
    6792 printcap name = cups\. This should be supplemented by an addtional setting
    6793 \fIprinting = cups\fR
    6794 in the [global] section\.
    6795 printcap name = cups
    6796 will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\.
     7768\FCprintcap name = cups \F[]\&. This should be supplemented by an addtional setting
     7769\m[blue]\fBprinting = cups\fR\m[]
     7770in the [global] section\&.
     7771\FCprintcap name = cups\F[]
     7772will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\&.
    67977773.sp
    67987774On System V systems that use
    6799 lpstat
     7775\FClpstat\F[]
    68007776to list available printers you can use
    6801 printcap name = lpstat
    6802 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
     7777\FCprintcap name = lpstat \F[]
     7778to 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
    68037779\fI printcap name\fR
    68047780is set to
    6805 lpstat
     7781\FClpstat\F[]
    68067782on these systems then Samba will launch
    6807 lpstat \-v
    6808 and attempt to parse the output to obtain a printer list\.
     7783\FClpstat \-v\F[]
     7784and attempt to parse the output to obtain a printer list\&.
    68097785.sp
    68107786A minimal printcap file would look something like this:
    68117787.sp
    6812 .RS 4
     7788.if n \{\
     7789.RS 4
     7790.\}
     7791.fam C
     7792.ps -1
    68137793.nf
     7794.if t \{\
     7795.sp -1
     7796.\}
     7797.BB lightgray adjust-for-leading-newline
     7798.sp -1
     7799
    68147800print1|My Printer 1
    68157801print2|My Printer 2
     
    68177803print4|My Printer 4
    68187804print5|My Printer 5
     7805.EB lightgray adjust-for-leading-newline
     7806.if t \{\
     7807.sp 1
     7808.\}
    68197809.fi
    6820 .RE
    6821 .sp
    6822 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\.
    6823 .sp
     7810.fam
     7811.ps +1
     7812.if n \{\
     7813.RE
     7814.\}
     7815.sp
     7816where 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\&.
     7817.if n \{\
     7818.sp
     7819.\}
     7820.RS 4
     7821.BM yellow
    68247822.it 1 an-trap
    68257823.nr an-no-space-flag 1
    68267824.nr an-break-flag 1
    68277825.br
    6828 Note
     7826.ps +1
     7827\fBNote\fR
     7828.ps -1
     7829.br
    68297830Under AIX the default printcap name is
    6830 \fI/etc/qconfig\fR\. Samba will assume the file is in AIX
    6831 \fIqconfig\fR
     7831\FC/etc/qconfig\F[]\&. Samba will assume the file is in AIX
     7832\FCqconfig\F[]
    68327833format if the string
    6833 \fIqconfig\fR
    6834 appears in the printcap filename\.
    6835 
    6836 Default:
    6837 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/printcap\fR\fI \fR
    6838 .sp
    6839 Example:
    6840 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/myprintcap\fR\fI \fR
     7834\FCqconfig\F[]
     7835appears in the printcap filename\&.
     7836.sp .5v
     7837.EM yellow
     7838.RE
     7839Default:
     7840\fI\fIprintcap name\fR\fR\fI = \fR\fI\FC/etc/printcap\F[]\fR\fI \fR
     7841.sp
     7842Example:
     7843\fI\fIprintcap name\fR\fR\fI = \fR\fI\FC/etc/myprintcap\F[]\fR\fI \fR
    68417844.RE
    68427845
    68437846print command (S)
     7847.\" print command
    68447848.PP
    68457849.RS 4
    68467850After a print job has finished spooling to a service, this command will be used via a
    6847 system()
    6848 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\.
    6849 .sp
    6850 The print command is simply a text string\. It will be used verbatim after macro substitutions have been made:
     7851\FCsystem()\F[]
     7852call 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\&.
     7853.sp
     7854The print command is simply a text string\&. It will be used verbatim after macro substitutions have been made:
    68517855.sp
    68527856%s, %f \- the path to the spool file name
     
    68547858%p \- the appropriate printer name
    68557859.sp
    6856 %J \- the job name as transmitted by the client\.
    6857 .sp
    6858 %c \- The number of printed pages of the spooled job (if known)\.
     7860%J \- the job name as transmitted by the client\&.
     7861.sp
     7862%c \- The number of printed pages of the spooled job (if known)\&.
    68597863.sp
    68607864%z \- the size of the spooled print job (in bytes)
     
    68687872\- the
    68697873\fI%p\fR
    6870 is optional\. At the time a job is submitted, if no printer name is supplied the
     7874is optional\&. At the time a job is submitted, if no printer name is supplied the
    68717875\fI%p \fR
    6872 will be silently removed from the printer command\.
    6873 .sp
    6874 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\.
    6875 .sp
    6876 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\.
     7876will be silently removed from the printer command\&.
     7877.sp
     7878If 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\&.
     7879.sp
     7880If 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\&.
    68777881.sp
    68787882Note that printing may fail on some UNIXes from the
    68797883\fBnobody\fR
    6880 account\. If this happens then create an alternative guest account that can print and set the
    6881 \fIguest account\fR
    6882 in the [global] section\.
    6883 .sp
    6884 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\.
    6885 .sp
    6886 print command = echo Printing %s >> /tmp/print\.log; lpr \-P %p %s; rm %s
    6887 .sp
    6888 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
    6889 \fIprinting\fR
    6890 parameter\.
     7884account\&. If this happens then create an alternative guest account that can print and set the
     7885\m[blue]\fBguest account\fR\m[]
     7886in the [global] section\&.
     7887.sp
     7888You 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\&.
     7889.sp
     7890\FCprint command = echo Printing %s >> /tmp/print\&.log; lpr \-P %p %s; rm %s\F[]
     7891.sp
     7892You 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
     7893\m[blue]\fBprinting\fR\m[]
     7894parameter\&.
    68917895.sp
    68927896Default: For
    6893 printing = BSD, AIX, QNX, LPRNG or PLP :
    6894 .sp
    6895 print command = lpr \-r \-P%p %s
     7897\FCprinting = BSD, AIX, QNX, LPRNG or PLP :\F[]
     7898.sp
     7899\FCprint command = lpr \-r \-P%p %s\F[]
    68967900.sp
    68977901For
    6898 printing = SYSV or HPUX :
    6899 .sp
    6900 print command = lp \-c \-d%p %s; rm %s
     7902\FCprinting = SYSV or HPUX :\F[]
     7903.sp
     7904\FCprint command = lp \-c \-d%p %s; rm %s\F[]
    69017905.sp
    69027906For
    6903 printing = SOFTQ :
    6904 .sp
    6905 print command = lp \-d%p \-s %s; rm %s
     7907\FCprinting = SOFTQ :\F[]
     7908.sp
     7909\FCprint command = lp \-d%p \-s %s; rm %s\F[]
    69067910.sp
    69077911For printing = CUPS : If SAMBA is compiled against libcups, then
    6908 \fIprintcap = cups\fR
    6909 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
    6910 lp \-c \-d%p \-oraw; rm %s\. With
    6911 printing = cups, and if SAMBA is compiled against libcups, any manually set print command will be ignored\.
     7912\m[blue]\fBprintcap = cups\fR\m[]
     7913uses 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
     7914\FClp \-c \-d%p \-oraw; rm %s\F[]\&. With
     7915\FCprinting = cups\F[], and if SAMBA is compiled against libcups, any manually set print command will be ignored\&.
    69127916.sp
    69137917\fINo default\fR
    69147918.sp
    69157919Example:
    6916 \fI\fIprint command\fR\fR\fI = \fR\fI/usr/local/samba/bin/myprintscript %p %s\fR\fI \fR
     7920\fI\fIprint command\fR\fR\fI = \fR\fI\FC/usr/local/samba/bin/myprintscript %p %s\F[]\fR\fI \fR
    69177921.RE
    69187922
    69197923printer admin (S)
    6920 .PP
    6921 .RS 4
    6922 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\.
    6923 .sp
    6924 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\.
    6925 .sp
    6926 Default:
    6927 \fI\fIprinter admin\fR\fR\fI = \fR\fI\fR\fI \fR
    6928 .sp
    6929 Example:
    6930 \fI\fIprinter admin\fR\fR\fI = \fR\fIadmin, @staff\fR\fI \fR
     7924.\" printer admin
     7925.PP
     7926.RS 4
     7927This 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\&.
     7928.sp
     7929This parameter has been marked deprecated in favor of using the SePrintOperatorPrivilege and individual print security descriptors\&. It will be removed in a future release\&.
     7930.sp
     7931Default:
     7932\fI\fIprinter admin\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     7933.sp
     7934Example:
     7935\fI\fIprinter admin\fR\fR\fI = \fR\fI\FCadmin, @staff\F[]\fR\fI \fR
    69317936.RE
    69327937
    69337938printer
     7939.\" printer
    69347940.PP
    69357941.RS 4
    69367942This parameter is a synonym for
    6937 printer name\.
     7943printer name\&.
    69387944.RE
    69397945
    69407946printer name (S)
    6941 .PP
    6942 .RS 4
    6943 This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\.
    6944 .sp
    6945 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\.
     7947.\" printer name
     7948.PP
     7949.RS 4
     7950This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\&.
     7951.sp
     7952If 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\&.
    69467953.sp
    69477954The default value of the
    6948 \fIprinter name\fR
     7955\m[blue]\fBprinter name\fR\m[]
    69497956may be
    6950 lp
    6951 on many systems\.
    6952 .sp
    6953 Default:
    6954 \fI\fIprinter name\fR\fR\fI = \fR\fInone\fR\fI \fR
    6955 .sp
    6956 Example:
    6957 \fI\fIprinter name\fR\fR\fI = \fR\fIlaserwriter\fR\fI \fR
     7957\FClp\F[]
     7958on many systems\&.
     7959.sp
     7960Default:
     7961\fI\fIprinter name\fR\fR\fI = \fR\fI\FCnone\F[]\fR\fI \fR
     7962.sp
     7963Example:
     7964\fI\fIprinter name\fR\fR\fI = \fR\fI\FClaserwriter\F[]\fR\fI \fR
    69587965.RE
    69597966
    69607967printing (S)
    6961 .PP
    6962 .RS 4
    6963 This parameters controls how printer status information is interpreted on your system\. It also affects the default values for the
     7968.\" printing
     7969.PP
     7970.RS 4
     7971This parameters controls how printer status information is interpreted on your system\&. It also affects the default values for the
    69647972\fIprint command\fR,
    69657973\fIlpq command\fR,
     
    69677975\fIlpresume command\fR, and
    69687976\fIlprm command\fR
    6969 if specified in the [global] section\.
    6970 .sp
    6971 Currently nine printing styles are supported\. They are
     7977if specified in the [global] section\&.
     7978.sp
     7979Currently nine printing styles are supported\&. They are
    69727980\fBBSD\fR,
    69737981\fBAIX\fR,
     
    69787986\fBQNX\fR,
    69797987\fBSOFTQ\fR, and
    6980 \fBCUPS\fR\.
     7988\fBCUPS\fR\&.
    69817989.sp
    69827990To see what the defaults are for the other print commands when using the various options use the
    69837991\fBtestparm\fR(1)
    6984 program\.
    6985 .sp
    6986 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
     7992program\&.
     7993.sp
     7994This 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
    69877995\fIprinting\fR
    6988 option since it will reset the printing commands to default values\.
     7996option since it will reset the printing commands to default values\&.
    69897997.sp
    69907998See also the discussion in the
    69917999[printers]
    6992 section\.
    6993 .sp
    6994 \fINo default\fR
     8000section\&.
     8001.sp
     8002Default:
     8003\fI\fIprinting\fR\fR\fI = \fR\fI\FCDepends on the operating system, see \FCtestparm \-v\&.\F[]\F[]\fR\fI \fR
    69958004.RE
    69968005
    69978006printjob username (S)
    6998 .PP
    6999 .RS 4
    7000 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\.
    7001 .sp
    7002 Default:
    7003 \fI\fIprintjob username\fR\fR\fI = \fR\fI%U\fR\fI \fR
    7004 .sp
    7005 Example:
    7006 \fI\fIprintjob username\fR\fR\fI = \fR\fI%D\e%U\fR\fI \fR
     8007.\" printjob username
     8008.PP
     8009.RS 4
     8010This 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\&.
     8011.sp
     8012Default:
     8013\fI\fIprintjob username\fR\fR\fI = \fR\fI\FC%U\F[]\fR\fI \fR
     8014.sp
     8015Example:
     8016\fI\fIprintjob username\fR\fR\fI = \fR\fI\FC%D\e%U\F[]\fR\fI \fR
    70078017.RE
    70088018
    70098019private dir (G)
     8020.\" private dir
    70108021.PP
    70118022.RS 4
    70128023This parameters defines the directory smbd will use for storing such files as
    7013 \fIsmbpasswd\fR
     8024\FCsmbpasswd\F[]
    70148025and
    7015 \fIsecrets\.tdb\fR\.
    7016 .sp
    7017 Default:
    7018 \fI\fIprivate dir\fR\fR\fI = \fR\fI${prefix}/private\fR\fI \fR
     8026\FCsecrets\&.tdb\F[]\&.
     8027.sp
     8028Default:
     8029\fI\fIprivate dir\fR\fR\fI = \fR\fI\FC${prefix}/private\F[]\fR\fI \fR
    70198030.RE
    70208031
    70218032profile acls (S)
    7022 .PP
    7023 .RS 4
    7024 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\.
    7025 .sp
    7026 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\.
    7027 .sp
    7028 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\.
    7029 .sp
    7030 Default:
    7031 \fI\fIprofile acls\fR\fR\fI = \fR\fIno\fR\fI \fR
     8033.\" profile acls
     8034.PP
     8035.RS 4
     8036This 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\&.
     8037.sp
     8038When 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\&.
     8039.sp
     8040Note 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\&.
     8041.sp
     8042Default:
     8043\fI\fIprofile acls\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    70328044.RE
    70338045
    70348046queuepause command (S)
    7035 .PP
    7036 .RS 4
    7037 This parameter specifies the command to be executed on the server host in order to pause the printer queue\.
    7038 .sp
    7039 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\.
    7040 .sp
    7041 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\.
     8047.\" queuepause command
     8048.PP
     8049.RS 4
     8050This parameter specifies the command to be executed on the server host in order to pause the printer queue\&.
     8051.sp
     8052This 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\&.
     8053.sp
     8054This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
    70428055.sp
    70438056If a
    70448057\fI%p\fR
    7045 is given then the printer name is put in its place\. Otherwise it is placed at the end of the command\.
    7046 .sp
    7047 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\.
     8058is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
     8059.sp
     8060Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
    70488061.sp
    70498062\fINo default\fR
    70508063.sp
    70518064Example:
    7052 \fI\fIqueuepause command\fR\fR\fI = \fR\fIdisable %p\fR\fI \fR
     8065\fI\fIqueuepause command\fR\fR\fI = \fR\fI\FCdisable %p\F[]\fR\fI \fR
    70538066.RE
    70548067
    70558068queueresume command (S)
    7056 .PP
    7057 .RS 4
    7058 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)\.
    7059 .sp
    7060 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\.
    7061 .sp
    7062 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\.
     8069.\" queueresume command
     8070.PP
     8071.RS 4
     8072This 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[])\&.
     8073.sp
     8074This 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\&.
     8075.sp
     8076This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
    70638077.sp
    70648078If a
    70658079\fI%p\fR
    7066 is given then the printer name is put in its place\. Otherwise it is placed at the end of the command\.
    7067 .sp
    7068 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\.
    7069 .sp
    7070 Default:
    7071 \fI\fIqueueresume command\fR\fR\fI = \fR\fI\fR\fI \fR
    7072 .sp
    7073 Example:
    7074 \fI\fIqueueresume command\fR\fR\fI = \fR\fIenable %p\fR\fI \fR
     8080is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
     8081.sp
     8082Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
     8083.sp
     8084Default:
     8085\fI\fIqueueresume command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     8086.sp
     8087Example:
     8088\fI\fIqueueresume command\fR\fR\fI = \fR\fI\FCenable %p\F[]\fR\fI \fR
    70758089.RE
    70768090
    70778091read list (S)
    7078 .PP
    7079 .RS 4
    7080 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
    7081 \fIread only\fR
    7082 option is set to\. The list can include group names using the syntax described in the
    7083 \fIinvalid users\fR
    7084 parameter\.
     8092.\" read list
     8093.PP
     8094.RS 4
     8095This 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
     8096\m[blue]\fBread only\fR\m[]
     8097option is set to\&. The list can include group names using the syntax described in the
     8098\m[blue]\fBinvalid users\fR\m[]
     8099parameter\&.
    70858100.sp
    70868101This parameter will not work with the
    7087 \fIsecurity = share\fR
    7088 in Samba 3\.0\. This is by design\.
    7089 .sp
    7090 Default:
    7091 \fI\fIread list\fR\fR\fI = \fR\fI\fR\fI \fR
    7092 .sp
    7093 Example:
    7094 \fI\fIread list\fR\fR\fI = \fR\fImary, @students\fR\fI \fR
     8102\m[blue]\fBsecurity = share\fR\m[]
     8103in Samba 3\&.0\&. This is by design\&.
     8104.sp
     8105Default:
     8106\fI\fIread list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     8107.sp
     8108Example:
     8109\fI\fIread list\fR\fR\fI = \fR\fI\FCmary, @students\F[]\fR\fI \fR
    70958110.RE
    70968111
    70978112read only (S)
     8113.\" read only
    70988114.PP
    70998115.RS 4
    71008116An inverted synonym is
    7101 \fIwriteable\fR\.
     8117\m[blue]\fBwriteable\fR\m[]\&.
    71028118.sp
    71038119If this parameter is
    7104 \fByes\fR, then users of a service may not create or modify files in the service\'s directory\.
    7105 .sp
    7106 Note that a printable service (printable = yes) will
     8120\fByes\fR, then users of a service may not create or modify files in the service\'s directory\&.
     8121.sp
     8122Note that a printable service (\FCprintable = yes\F[]) will
    71078123\fIALWAYS\fR
    7108 allow writing to the directory (user privileges permitting), but only via spooling operations\.
    7109 .sp
    7110 Default:
    7111 \fI\fIread only\fR\fR\fI = \fR\fIyes\fR\fI \fR
     8124allow writing to the directory (user privileges permitting), but only via spooling operations\&.
     8125.sp
     8126Default:
     8127\fI\fIread only\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    71128128.RE
    71138129
    71148130read raw (G)
    7115 .PP
    7116 .RS 4
    7117 This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients\.
    7118 .sp
    7119 If enabled, raw reads allow reads of 65535 bytes in one packet\. This typically provides a major performance benefit\.
    7120 .sp
    7121 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\.
    7122 .sp
    7123 In general this parameter should be viewed as a system tuning tool and left severely alone\.
    7124 .sp
    7125 Default:
    7126 \fI\fIread raw\fR\fR\fI = \fR\fIyes\fR\fI \fR
     8131.\" read raw
     8132.PP
     8133.RS 4
     8134This parameter controls whether or not the server will support the raw read SMB requests when transferring data to clients\&.
     8135.sp
     8136If enabled, raw reads allow reads of 65535 bytes in one packet\&. This typically provides a major performance benefit\&.
     8137.sp
     8138However, 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\&.
     8139.sp
     8140In general this parameter should be viewed as a system tuning tool and left severely alone\&.
     8141.sp
     8142Default:
     8143\fI\fIread raw\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    71278144.RE
    71288145
    71298146realm (G)
    7130 .PP
    7131 .RS 4
    7132 This option specifies the kerberos realm to use\. The realm is used as the ADS equivalent of the NT4
    7133 domain\. It is usually set to the DNS name of the kerberos server\.
    7134 .sp
    7135 Default:
    7136 \fI\fIrealm\fR\fR\fI = \fR\fI\fR\fI \fR
    7137 .sp
    7138 Example:
    7139 \fI\fIrealm\fR\fR\fI = \fR\fImysambabox\.mycompany\.com\fR\fI \fR
     8147.\" realm
     8148.PP
     8149.RS 4
     8150This option specifies the kerberos realm to use\&. The realm is used as the ADS equivalent of the NT4
     8151\FCdomain\F[]\&. It is usually set to the DNS name of the kerberos server\&.
     8152.sp
     8153Default:
     8154\fI\fIrealm\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     8155.sp
     8156Example:
     8157\fI\fIrealm\fR\fR\fI = \fR\fI\FCmysambabox\&.mycompany\&.com\F[]\fR\fI \fR
    71408158.RE
    71418159
    71428160registry shares (G)
    7143 .PP
    7144 .RS 4
    7145 This turns on or off support for share definitions read from registry\. Shares defined in
    7146 \fIsmb\.conf\fR
    7147 take precedence over shares with the same name defined in registry\. See the section on registry\-based configuration for details\.
     8161.\" registry shares
     8162.PP
     8163.RS 4
     8164This turns on or off support for share definitions read from registry\&. Shares defined in
     8165\fIsmb\&.conf\fR
     8166take precedence over shares with the same name defined in registry\&. See the section on registry\-based configuration for details\&.
    71488167.sp
    71498168Note that this parameter defaults to
     
    71538172\fIconfig backend\fR
    71548173is set to
    7155 \fIregistry\fR\.
    7156 .sp
    7157 Default:
    7158 \fI\fIregistry shares\fR\fR\fI = \fR\fIno\fR\fI \fR
    7159 .sp
    7160 Example:
    7161 \fI\fIregistry shares\fR\fR\fI = \fR\fIyes\fR\fI \fR
     8174\fIregistry\fR\&.
     8175.sp
     8176Default:
     8177\fI\fIregistry shares\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
     8178.sp
     8179Example:
     8180\fI\fIregistry shares\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    71628181.RE
    71638182
    71648183remote announce (G)
     8184.\" remote announce
    71658185.PP
    71668186.RS 4
    71678187This option allows you to setup
    7168 \fBnmbd\fR(8)to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name\.
    7169 .sp
    7170 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\.
     8188\fBnmbd\fR(8)to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name\&.
     8189.sp
     8190This 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\&.
    71718191.sp
    71728192For example:
    71738193.sp
    7174 .RS 4
     8194.if n \{\
     8195.RS 4
     8196.\}
     8197.fam C
     8198.ps -1
    71758199.nf
    7176 remote announce = 192\.168\.2\.255/SERVERS 192\.168\.4\.255/STAFF
     8200.if t \{\
     8201.sp -1
     8202.\}
     8203.BB lightgray adjust-for-leading-newline
     8204.sp -1
     8205
     8206\FCremote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF\F[]
     8207.EB lightgray adjust-for-leading-newline
     8208.if t \{\
     8209.sp 1
     8210.\}
    71778211.fi
    7178 .RE
     8212.fam
     8213.ps +1
     8214.if n \{\
     8215.RE
     8216.\}
    71798217.sp
    71808218the above line would cause
    7181 nmbd
    7182 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
    7183 \fIworkgroup\fR
    7184 parameter is used instead\.
    7185 .sp
    7186 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\.
    7187 .sp
    7188 See the chapter on Network Browsing in the Samba\-HOWTO book\.
    7189 .sp
    7190 Default:
    7191 \fI\fIremote announce\fR\fR\fI = \fR\fI\fR\fI \fR
     8219\FCnmbd\F[]
     8220to 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
     8221\m[blue]\fBworkgroup\fR\m[]
     8222parameter is used instead\&.
     8223.sp
     8224The 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\&.
     8225.sp
     8226See the chapter on Network Browsing in the Samba\-HOWTO book\&.
     8227.sp
     8228Default:
     8229\fI\fIremote announce\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    71928230.RE
    71938231
    71948232remote browse sync (G)
     8233.\" remote browse sync
    71958234.PP
    71968235.RS 4
    71978236This option allows you to setup
    71988237\fBnmbd\fR(8)
    7199 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\.
    7200 .sp
    7201 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\.
     8238to 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\&.
     8239.sp
     8240This 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\&.
    72028241.sp
    72038242For example:
    72048243.sp
    7205 .RS 4
     8244.if n \{\
     8245.RS 4
     8246.\}
     8247.fam C
     8248.ps -1
    72068249.nf
    7207 \fIremote browse sync = 192\.168\.2\.255 192\.168\.4\.255\fR
     8250.if t \{\
     8251.sp -1
     8252.\}
     8253.BB lightgray adjust-for-leading-newline
     8254.sp -1
     8255
     8256\fIremote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fR
     8257.EB lightgray adjust-for-leading-newline
     8258.if t \{\
     8259.sp 1
     8260.\}
    72088261.fi
    7209 .RE
     8262.fam
     8263.ps +1
     8264.if n \{\
     8265.RE
     8266.\}
    72108267.sp
    72118268the above line would cause
    7212 nmbd
    7213 to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server\.
    7214 .sp
    7215 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\.
     8269\FCnmbd\F[]
     8270to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server\&.
     8271.sp
     8272The 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\&.
    72168273.sp
    72178274The
    7218 \fIremote browse sync\fR
    7219 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\.
    7220 .sp
    7221 Default:
    7222 \fI\fIremote browse sync\fR\fR\fI = \fR\fI\fR\fI \fR
     8275\m[blue]\fBremote browse sync\fR\m[]
     8276may 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\&.
     8277.sp
     8278Default:
     8279\fI\fIremote browse sync\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    72238280.RE
    72248281
    72258282rename user script (G)
     8283.\" rename user script
    72268284.PP
    72278285.RS 4
    72288286This is the full pathname to a script that will be run as root by
    72298287\fBsmbd\fR(8)
    7230 under special circumstances described below\.
    7231 .sp
    7232 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,
    7233 %uold
     8288under special circumstances described below\&.
     8289.sp
     8290When 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,
     8291\FC%uold\F[]
    72348292and
    7235 %unew, will be substituted with the old and new usernames, respectively\. The script should return 0 upon successful completion, and nonzero otherwise\.
    7236 .sp
     8293\FC%unew\F[], will be substituted with the old and new usernames, respectively\&. The script should return 0 upon successful completion, and nonzero otherwise\&.
     8294.if n \{\
     8295.sp
     8296.\}
     8297.RS 4
     8298.BM yellow
    72378299.it 1 an-trap
    72388300.nr an-no-space-flag 1
    72398301.nr an-break-flag 1
    72408302.br
    7241 Note
    7242 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\.
    7243 
    7244 Default:
    7245 \fI\fIrename user script\fR\fR\fI = \fR\fIno\fR\fI \fR
     8303.ps +1
     8304\fBNote\fR
     8305.ps -1
     8306.br
     8307The 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\&.
     8308.sp .5v
     8309.EM yellow
     8310.RE
     8311Default:
     8312\fI\fIrename user script\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    72468313.RE
    72478314
    72488315reset on zero vc (G)
    7249 .PP
    7250 .RS 4
    7251 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\.
    7252 .sp
    7253 Default:
    7254 \fI\fIreset on zero vc\fR\fR\fI = \fR\fIno\fR\fI \fR
     8316.\" reset on zero vc
     8317.PP
     8318.RS 4
     8319This 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\&.
     8320.sp
     8321Default:
     8322\fI\fIreset on zero vc\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    72558323.RE
    72568324
    72578325restrict anonymous (G)
    7258 .PP
    7259 .RS 4
    7260 The setting of this parameter determines whether user and group list information is returned for an anonymous connection\. and mirrors the effects of the
    7261 .sp
    7262 .RS 4
     8326.\" restrict anonymous
     8327.PP
     8328.RS 4
     8329The setting of this parameter determines whether user and group list information is returned for an anonymous connection\&. and mirrors the effects of the
     8330.sp
     8331.if n \{\
     8332.RS 4
     8333.\}
     8334.fam C
     8335.ps -1
    72638336.nf
     8337.if t \{\
     8338.sp -1
     8339.\}
     8340.BB lightgray adjust-for-leading-newline
     8341.sp -1
     8342
    72648343HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\e
    72658344           Control\eLSA\eRestrictAnonymous
     8345.EB lightgray adjust-for-leading-newline
     8346.if t \{\
     8347.sp 1
     8348.\}
    72668349.fi
    7267 .RE
    7268 .sp
    7269 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\.
    7270 .sp
    7271 The security advantage of using restrict anonymous = 1 is dubious, as user and group list information can be obtained using other means\.
    7272 .sp
     8350.fam
     8351.ps +1
     8352.if n \{\
     8353.RE
     8354.\}
     8355.sp
     8356registry 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\&.
     8357.sp
     8358The security advantage of using restrict anonymous = 1 is dubious, as user and group list information can be obtained using other means\&.
     8359.if n \{\
     8360.sp
     8361.\}
     8362.RS 4
     8363.BM yellow
    72738364.it 1 an-trap
    72748365.nr an-no-space-flag 1
    72758366.nr an-break-flag 1
    72768367.br
    7277 Note
     8368.ps +1
     8369\fBNote\fR
     8370.ps -1
     8371.br
    72788372The security advantage of using restrict anonymous = 2 is removed by setting
    7279 \fIguest ok = yes\fR
    7280 on any share\.
    7281 
    7282 Default:
    7283 \fI\fIrestrict anonymous\fR\fR\fI = \fR\fI0\fR\fI \fR
     8373\m[blue]\fBguest ok = yes\fR\m[]
     8374on any share\&.
     8375.sp .5v
     8376.EM yellow
     8377.RE
     8378Default:
     8379\fI\fIrestrict anonymous\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    72848380.RE
    72858381
    72868382root
     8383.\" root
    72878384.PP
    72888385.RS 4
    72898386This parameter is a synonym for
    7290 root directory\.
     8387root directory\&.
    72918388.RE
    72928389
    72938390root dir
     8391.\" root dir
    72948392.PP
    72958393.RS 4
    72968394This parameter is a synonym for
    7297 root directory\.
     8395root directory\&.
    72988396.RE
    72998397
    73008398root directory (G)
     8399.\" root directory
    73018400.PP
    73028401.RS 4
    73038402The server will
    7304 chroot()
    7305 (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
    7306 \fIwide smbconfoptions\fR
    7307 parameter)\.
     8403\FCchroot()\F[]
     8404(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
     8405\m[blue]\fBwide smbconfoptions\fR\m[]
     8406parameter)\&.
    73088407.sp
    73098408Adding a
    73108409\fIroot directory\fR
    7311 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
     8410entry 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
    73128411\fIroot directory\fR
    73138412option,
    73148413\fIincluding\fR
    7315 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
     8414some 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
    73168415\fIroot directory\fR
    7317 tree\. In particular you will need to mirror
    7318 \fI/etc/passwd\fR
    7319 (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\.
    7320 .sp
    7321 Default:
    7322 \fI\fIroot directory\fR\fR\fI = \fR\fI/\fR\fI \fR
    7323 .sp
    7324 Example:
    7325 \fI\fIroot directory\fR\fR\fI = \fR\fI/homes/smb\fR\fI \fR
     8416tree\&. In particular you will need to mirror
     8417\FC/etc/passwd\F[]
     8418(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\&.
     8419.sp
     8420Default:
     8421\fI\fIroot directory\fR\fR\fI = \fR\fI\FC/\F[]\fR\fI \fR
     8422.sp
     8423Example:
     8424\fI\fIroot directory\fR\fR\fI = \fR\fI\FC/homes/smb\F[]\fR\fI \fR
    73268425.RE
    73278426
    73288427root postexec (S)
     8428.\" root postexec
    73298429.PP
    73308430.RS 4
    73318431This is the same as the
    73328432\fIpostexec\fR
    7333 parameter except that the command is run as root\. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed\.
    7334 .sp
    7335 Default:
    7336 \fI\fIroot postexec\fR\fR\fI = \fR\fI\fR\fI \fR
     8433parameter except that the command is run as root\&. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed\&.
     8434.sp
     8435Default:
     8436\fI\fIroot postexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    73378437.RE
    73388438
    73398439root preexec close (S)
     8440.\" root preexec close
    73408441.PP
    73418442.RS 4
    73428443This is the same as the
    73438444\fIpreexec close \fR
    7344 parameter except that the command is run as root\.
    7345 .sp
    7346 Default:
    7347 \fI\fIroot preexec close\fR\fR\fI = \fR\fIno\fR\fI \fR
     8445parameter except that the command is run as root\&.
     8446.sp
     8447Default:
     8448\fI\fIroot preexec close\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    73488449.RE
    73498450
    73508451root preexec (S)
     8452.\" root preexec
    73518453.PP
    73528454.RS 4
    73538455This is the same as the
    73548456\fIpreexec\fR
    7355 parameter except that the command is run as root\. This is useful for mounting filesystems (such as CDROMs) when a connection is opened\.
    7356 .sp
    7357 Default:
    7358 \fI\fIroot preexec\fR\fR\fI = \fR\fI\fR\fI \fR
     8457parameter except that the command is run as root\&. This is useful for mounting filesystems (such as CDROMs) when a connection is opened\&.
     8458.sp
     8459Default:
     8460\fI\fIroot preexec\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
    73598461.RE
    73608462
    73618463security mask (S)
    7362 .PP
    7363 .RS 4
    7364 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\.
    7365 .sp
    7366 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
    7367 \fIforce security mode\fR, which works in a manner similar to this one but uses a logical OR instead of an AND\.
    7368 .sp
    7369 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\.
    7370 .sp
    7371 If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file\.
     8464.\" security mask
     8465.PP
     8466.RS 4
     8467This 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\&.
     8468.sp
     8469This 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
     8470\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\&.
     8471.sp
     8472Essentially, 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\&.
     8473.sp
     8474If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file\&.
    73728475.sp
    73738476\fI Note\fR
    7374 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
    7375 \fB0777\fR\.
    7376 .sp
    7377 Default:
    7378 \fI\fIsecurity mask\fR\fR\fI = \fR\fI0777\fR\fI \fR
    7379 .sp
    7380 Example:
    7381 \fI\fIsecurity mask\fR\fR\fI = \fR\fI0770\fR\fI \fR
     8477that 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
     8478\fB0777\fR\&.
     8479.sp
     8480Default:
     8481\fI\fIsecurity mask\fR\fR\fI = \fR\fI\FC0777\F[]\fR\fI \fR
     8482.sp
     8483Example:
     8484\fI\fIsecurity mask\fR\fR\fI = \fR\fI\FC0770\F[]\fR\fI \fR
    73828485.RE
    73838486
    73848487security (G)
     8488.\" security
    73858489.PP
    73868490.RS 4
    73878491This option affects how clients respond to Samba and is one of the most important settings in the
    7388 \fI smb\.conf\fR
    7389 file\.
     8492\FC smb\&.conf\F[]
     8493file\&.
    73908494.sp
    73918495The option sets the "security mode bit" in replies to protocol negotiations with
    73928496\fBsmbd\fR(8)
    7393 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\.
     8497to 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\&.
    73948498.sp
    73958499The default is
    7396 security = user, as this is the most common setting needed when talking to Windows 98 and Windows NT\.
     8500\FCsecurity = user\F[], as this is the most common setting needed when talking to Windows 98 and Windows NT\&.
    73978501.sp
    73988502The alternatives are
    7399 security = share,
    7400 security = server
     8503\FCsecurity = share\F[],
     8504\FCsecurity = server\F[]
    74018505or
    7402 security = domain\.
    7403 .sp
    7404 In versions of Samba prior to 2\.0\.0, the default was
    7405 security = share
    7406 mainly because that was the only option at one stage\.
    7407 .sp
    7408 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\.
     8506\FCsecurity = domain \F[]\&.
     8507.sp
     8508In versions of Samba prior to 2\&.0\&.0, the default was
     8509\FCsecurity = share\F[]
     8510mainly because that was the only option at one stage\&.
     8511.sp
     8512There 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\&.
    74098513.sp
    74108514If your PCs use usernames that are the same as their usernames on the UNIX machine then you will want to use
    7411 security = user\. If you mostly use usernames that don\'t exist on the UNIX box then use
    7412 security = share\.
     8515\FCsecurity = user\F[]\&. If you mostly use usernames that don\'t exist on the UNIX box then use
     8516\FCsecurity = share\F[]\&.
    74138517.sp
    74148518You should also use
    7415 security = share
    7416 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
    7417 security = user, see the
    7418 \fImap to guest\fRparameter for details\.
     8519\FCsecurity = share\F[]
     8520if 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
     8521\FCsecurity = user\F[], see the
     8522\m[blue]\fBmap to guest\fR\m[]parameter for details\&.
    74198523.sp
    74208524It is possible to use
    7421 smbd
     8525\FCsmbd\F[]
    74228526in a
    74238527\fI hybrid mode\fR
    74248528where it is offers both user and share level security under different
    7425 \fINetBIOS aliases\fR\.
    7426 .sp
    7427 The different settings will now be explained\.
     8529\m[blue]\fBNetBIOS aliases\fR\m[]\&.
     8530.sp
     8531The different settings will now be explained\&.
    74288532.sp
    74298533\fISECURITY = SHARE\fR
    74308534.sp
    74318535When 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
    7432 security = share
    7433 server)\. Instead, the clients send authentication information (passwords) on a per\-share basis, at the time they attempt to connect to that share\.
     8536\FCsecurity = share \F[]
     8537server)\&. Instead, the clients send authentication information (passwords) on a per\-share basis, at the time they attempt to connect to that share\&.
    74348538.sp
    74358539Note that
    7436 smbd
     8540\FCsmbd\F[]
    74378541\fIALWAYS\fR
    74388542uses a valid UNIX user to act on behalf of the client, even in
    7439 security = share
    7440 level security\.
     8543\FCsecurity = share\F[]
     8544level security\&.
    74418545.sp
    74428546As clients are not required to send a username to the server in share level security,
    7443 smbd
    7444 uses several techniques to determine the correct UNIX user to use on behalf of the client\.
     8547\FCsmbd\F[]
     8548uses several techniques to determine the correct UNIX user to use on behalf of the client\&.
    74458549.sp
    74468550A list of possible UNIX usernames to match with the given client password is constructed using the following methods :
     
    74548558.IP \(bu 2.3
    74558559.\}
     8560If the
     8561\m[blue]\fBguest only\fR\m[]
     8562parameter is set, then all the other stages are missed and only the
     8563\m[blue]\fBguest account\fR\m[]
     8564username is checked\&.
     8565.RE
     8566.sp
     8567.RS 4
     8568.ie n \{\
     8569\h'-04'\(bu\h'+03'\c
     8570.\}
     8571.el \{\
     8572.sp -1
     8573.IP \(bu 2.3
     8574.\}
     8575Is a username is sent with the share connection request, then this username (after mapping \- see
     8576\m[blue]\fBusername map\fR\m[]), is added as a potential username\&.
     8577.RE
     8578.sp
     8579.RS 4
     8580.ie n \{\
     8581\h'-04'\(bu\h'+03'\c
     8582.\}
     8583.el \{\
     8584.sp -1
     8585.IP \(bu 2.3
     8586.\}
     8587If the client did a previous
     8588\fIlogon \fR
     8589request (the SessionSetup SMB call) then the username sent in this SMB will be added as a potential username\&.
     8590.RE
     8591.sp
     8592.RS 4
     8593.ie n \{\
     8594\h'-04'\(bu\h'+03'\c
     8595.\}
     8596.el \{\
     8597.sp -1
     8598.IP \(bu 2.3
     8599.\}
     8600The name of the service the client requested is added as a potential username\&.
     8601.RE
     8602.sp
     8603.RS 4
     8604.ie n \{\
     8605\h'-04'\(bu\h'+03'\c
     8606.\}
     8607.el \{\
     8608.sp -1
     8609.IP \(bu 2.3
     8610.\}
     8611The NetBIOS name of the client is added to the list as a potential username\&.
     8612.RE
     8613.sp
     8614.RS 4
     8615.ie n \{\
     8616\h'-04'\(bu\h'+03'\c
     8617.\}
     8618.el \{\
     8619.sp -1
     8620.IP \(bu 2.3
     8621.\}
     8622Any users on the
     8623\m[blue]\fBuser\fR\m[]
     8624list are added as potential usernames\&.
     8625.sp
     8626.RE
    74568627If the
    74578628\fIguest only\fR
    7458 parameter is set, then all the other stages are missed and only the
    7459 \fIguest account\fR
    7460 username is checked\.
    7461 .RE
    7462 .sp
    7463 .RS 4
    7464 .ie n \{\
    7465 \h'-04'\(bu\h'+03'\c
    7466 .\}
    7467 .el \{\
    7468 .sp -1
    7469 .IP \(bu 2.3
    7470 .\}
    7471 Is a username is sent with the share connection request, then this username (after mapping \- see
    7472 \fIusername map\fR), is added as a potential username\.
    7473 .RE
    7474 .sp
    7475 .RS 4
    7476 .ie n \{\
    7477 \h'-04'\(bu\h'+03'\c
    7478 .\}
    7479 .el \{\
    7480 .sp -1
    7481 .IP \(bu 2.3
    7482 .\}
    7483 If the client did a previous
    7484 \fIlogon \fR
    7485 request (the SessionSetup SMB call) then the username sent in this SMB will be added as a potential username\.
    7486 .RE
    7487 .sp
    7488 .RS 4
    7489 .ie n \{\
    7490 \h'-04'\(bu\h'+03'\c
    7491 .\}
    7492 .el \{\
    7493 .sp -1
    7494 .IP \(bu 2.3
    7495 .\}
    7496 The name of the service the client requested is added as a potential username\.
    7497 .RE
    7498 .sp
    7499 .RS 4
    7500 .ie n \{\
    7501 \h'-04'\(bu\h'+03'\c
    7502 .\}
    7503 .el \{\
    7504 .sp -1
    7505 .IP \(bu 2.3
    7506 .\}
    7507 The NetBIOS name of the client is added to the list as a potential username\.
    7508 .RE
    7509 .sp
    7510 .RS 4
    7511 .ie n \{\
    7512 \h'-04'\(bu\h'+03'\c
    7513 .\}
    7514 .el \{\
    7515 .sp -1
    7516 .IP \(bu 2.3
    7517 .\}
    7518 Any users on the
    7519 \fIuser\fR
    7520 list are added as potential usernames\.
    7521 .sp
    7522 .RE
    7523 If the
    7524 \fIguest only\fR
    7525 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\.
     8629parameter 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\&.
    75268630.sp
    75278631If the
    75288632\fIguest only\fR
    75298633parameter is set, or no username can be determined then if the share is marked as available to the
    7530 \fIguest account\fR, then this guest user will be used, otherwise access is denied\.
     8634\fIguest account\fR, then this guest user will be used, otherwise access is denied\&.
    75318635.sp
    75328636Note that it can be
    75338637\fIvery\fR
    7534 confusing in share\-level security as to which UNIX username will eventually be used in granting access\.
     8638confusing in share\-level security as to which UNIX username will eventually be used in granting access\&.
    75358639.sp
    75368640See also the section
    7537 NOTE ABOUT USERNAME/PASSWORD VALIDATION\.
     8641NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
    75388642.sp
    75398643\fISECURITY = USER\fR
    75408644.sp
    7541 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
    7542 \fIusername map\fR
    7543 parameter)\. Encrypted passwords (see the
    7544 \fIencrypted passwords\fR
    7545 parameter) can also be used in this security mode\. Parameters such as
    7546 \fIuser\fR
     8645This 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
     8646\m[blue]\fBusername map\fR\m[]
     8647parameter)\&. Encrypted passwords (see the
     8648\m[blue]\fBencrypted passwords\fR\m[]
     8649parameter) can also be used in this security mode\&. Parameters such as
     8650\m[blue]\fBuser\fR\m[]
    75478651and
    7548 \fIguest only\fR
    7549 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\.
     8652\m[blue]\fBguest only\fR\m[]
     8653if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated\&.
    75508654.sp
    75518655\fINote\fR
    75528656that the name of the resource being requested is
    75538657\fInot\fR
    7554 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
    7555 \fIguest account\fR\. See the
    7556 \fImap to guest\fR
    7557 parameter for details on doing this\.
     8658sent 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
     8659\m[blue]\fBguest account\fR\m[]\&. See the
     8660\m[blue]\fBmap to guest\fR\m[]
     8661parameter for details on doing this\&.
    75588662.sp
    75598663See also the section
    7560 NOTE ABOUT USERNAME/PASSWORD VALIDATION\.
     8664NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
    75618665.sp
    75628666\fISECURITY = DOMAIN\fR
     
    75648668This mode will only work correctly if
    75658669\fBnet\fR(8)
    7566 has been used to add this machine into a Windows NT Domain\. It expects the
    7567 \fIencrypted passwords\fR
     8670has been used to add this machine into a Windows NT Domain\&. It expects the
     8671\m[blue]\fBencrypted passwords\fR\m[]
    75688672parameter to be set to
    7569 \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\.
     8673\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\&.
    75708674.sp
    75718675\fINote\fR
    7572 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\.
     8676that 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\&.
    75738677.sp
    75748678\fINote\fR
    75758679that from the client\'s point of view
    7576 security = domain
     8680\FCsecurity = domain\F[]
    75778681is the same as
    7578 security = user\. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\.
     8682\FCsecurity = user\F[]\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
    75798683.sp
    75808684\fINote\fR
    75818685that the name of the resource being requested is
    75828686\fInot\fR
    7583 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
    7584 \fIguest account\fR\. See the
    7585 \fImap to guest\fR
    7586 parameter for details on doing this\.
     8687sent 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
     8688\m[blue]\fBguest account\fR\m[]\&. See the
     8689\m[blue]\fBmap to guest\fR\m[]
     8690parameter for details on doing this\&.
    75878691.sp
    75888692See also the section
    7589 NOTE ABOUT USERNAME/PASSWORD VALIDATION\.
     8693NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
    75908694.sp
    75918695See also the
    7592 \fIpassword server\fR
     8696\m[blue]\fBpassword server\fR\m[]
    75938697parameter and the
    7594 \fIencrypted passwords\fR
    7595 parameter\.
     8698\m[blue]\fBencrypted passwords\fR\m[]
     8699parameter\&.
    75968700.sp
    75978701\fISECURITY = SERVER\fR
    75988702.sp
    7599 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
    7600 security = user\. It expects the
    7601 \fIencrypted passwords\fR
     8703In 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
     8704\FCsecurity = user\F[]\&. It expects the
     8705\m[blue]\fBencrypted passwords\fR\m[]
    76028706parameter to be set to
    7603 \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
    7604 \fIsmbpasswd\fR
    7605 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\.
    7606 .sp
     8707\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
     8708\FCsmbpasswd\F[]
     8709file to check users against\&. See the chapter about the User Database in the Samba HOWTO Collection for details on how to set this up\&.
     8710.if n \{\
     8711.sp
     8712.\}
     8713.RS 4
     8714.BM yellow
    76078715.it 1 an-trap
    76088716.nr an-no-space-flag 1
    76098717.nr an-break-flag 1
    76108718.br
    7611 Note
    7612 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)\.
    7613 .sp
     8719.ps +1
     8720\fBNote\fR
     8721.ps -1
     8722.br
     8723This 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)\&.
     8724.sp .5v
     8725.EM yellow
     8726.RE
     8727.if n \{\
     8728.sp
     8729.\}
     8730.RS 4
     8731.BM yellow
    76148732.it 1 an-trap
    76158733.nr an-no-space-flag 1
    76168734.nr an-break-flag 1
    76178735.br
    7618 Note
     8736.ps +1
     8737\fBNote\fR
     8738.ps -1
     8739.br
    76198740From the client\'s point of view
    7620 security = server
     8741\FCsecurity = server\F[]
    76218742is the same as
    7622 security = user\. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\.
    7623 
     8743\FCsecurity = user\F[]\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
     8744.sp .5v
     8745.EM yellow
     8746.RE
    76248747\fINote\fR
    76258748that the name of the resource being requested is
    76268749\fInot\fR
    7627 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
    7628 \fIguest account\fR\. See the
    7629 \fImap to guest\fR
    7630 parameter for details on doing this\.
     8750sent 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
     8751\m[blue]\fBguest account\fR\m[]\&. See the
     8752\m[blue]\fBmap to guest\fR\m[]
     8753parameter for details on doing this\&.
    76318754.sp
    76328755See also the section
    7633 NOTE ABOUT USERNAME/PASSWORD VALIDATION\.
     8756NOTE ABOUT USERNAME/PASSWORD VALIDATION\&.
    76348757.sp
    76358758See also the
    7636 \fIpassword server\fR
     8759\m[blue]\fBpassword server\fR\m[]
    76378760parameter and the
    7638 \fIencrypted passwords\fR
    7639 parameter\.
     8761\m[blue]\fBencrypted passwords\fR\m[]
     8762parameter\&.
    76408763.sp
    76418764\fISECURITY = ADS\fR
    76428765.sp
    7643 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\.
    7644 .sp
    7645 Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\.
    7646 .sp
    7647 Read the chapter about Domain Membership in the HOWTO for details\.
    7648 .sp
    7649 Default:
    7650 \fI\fIsecurity\fR\fR\fI = \fR\fIUSER\fR\fI \fR
    7651 .sp
    7652 Example:
    7653 \fI\fIsecurity\fR\fR\fI = \fR\fIDOMAIN\fR\fI \fR
     8766In 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\&.
     8767.sp
     8768Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\&.
     8769.sp
     8770Read the chapter about Domain Membership in the HOWTO for details\&.
     8771.sp
     8772Default:
     8773\fI\fIsecurity\fR\fR\fI = \fR\fI\FCUSER\F[]\fR\fI \fR
     8774.sp
     8775Example:
     8776\fI\fIsecurity\fR\fR\fI = \fR\fI\FCDOMAIN\F[]\fR\fI \fR
    76548777.RE
    76558778
    76568779server schannel (G)
    7657 .PP
    7658 .RS 4
    7659 This controls whether the server offers or even demands the use of the netlogon schannel\.
    7660 \fIserver schannel = no\fR
     8780.\" server schannel
     8781.PP
     8782.RS 4
     8783This controls whether the server offers or even demands the use of the netlogon schannel\&.
     8784\m[blue]\fBserver schannel = no\fR\m[]
    76618785does not offer the schannel,
    7662 \fIserver schannel = auto\fR
     8786\m[blue]\fBserver schannel = auto\fR\m[]
    76638787offers the schannel but does not enforce it, and
    7664 \fIserver schannel = yes\fR
    7665 denies access if the client is not able to speak netlogon schannel\. This is only the case for Windows NT4 before SP4\.
     8788\m[blue]\fBserver schannel = yes\fR\m[]
     8789denies access if the client is not able to speak netlogon schannel\&. This is only the case for Windows NT4 before SP4\&.
    76668790.sp
    76678791Please note that with this set to
    7668 no
     8792\FCno\F[]
    76698793you will have to apply the WindowsXP
    7670 \fIWinXP_SignOrSeal\.reg\fR
    7671 registry patch found in the docs/registry subdirectory of the Samba distribution tarball\.
    7672 .sp
    7673 Default:
    7674 \fI\fIserver schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR
    7675 .sp
    7676 Example:
    7677 \fI\fIserver schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
     8794\FCWinXP_SignOrSeal\&.reg\F[]
     8795registry patch found in the docs/registry subdirectory of the Samba distribution tarball\&.
     8796.sp
     8797Default:
     8798\fI\fIserver schannel\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
     8799.sp
     8800Example:
     8801\fI\fIserver schannel\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    76788802.RE
    76798803
    76808804server signing (G)
    7681 .PP
    7682 .RS 4
    7683 This controls whether the server offers or requires the client it talks to to use SMB signing\. Possible values are
     8805.\" server signing
     8806.PP
     8807.RS 4
     8808This controls whether the server offers or requires the client it talks to to use SMB signing\&. Possible values are
    76848809\fIauto\fR,
    76858810\fImandatory\fR
    76868811and
    7687 \fIdisabled\fR\.
    7688 .sp
    7689 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\.
    7690 .sp
    7691 Default:
    7692 \fI\fIserver signing\fR\fR\fI = \fR\fIDisabled\fR\fI \fR
     8812\fIdisabled\fR\&.
     8813.sp
     8814When 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\&.
     8815.sp
     8816Default:
     8817\fI\fIserver signing\fR\fR\fI = \fR\fI\FCDisabled\F[]\fR\fI \fR
    76938818.RE
    76948819
    76958820server string (G)
     8821.\" server string
    76968822.PP
    76978823.RS 4
    76988824This controls what string will show up in the printer comment box in print manager and next to the IPC connection in
    7699 net view\. It can be any string that you wish to show to your users\.
    7700 .sp
    7701 It also sets what will appear in browse lists next to the machine name\.
     8825\FCnet view\F[]\&. It can be any string that you wish to show to your users\&.
     8826.sp
     8827It also sets what will appear in browse lists next to the machine name\&.
    77028828.sp
    77038829A
    77048830\fI%v\fR
    7705 will be replaced with the Samba version number\.
     8831will be replaced with the Samba version number\&.
    77068832.sp
    77078833A
    77088834\fI%h\fR
    7709 will be replaced with the hostname\.
    7710 .sp
    7711 Default:
    7712 \fI\fIserver string\fR\fR\fI = \fR\fISamba %v\fR\fI \fR
    7713 .sp
    7714 Example:
    7715 \fI\fIserver string\fR\fR\fI = \fR\fIUniversity of GNUs Samba Server\fR\fI \fR
     8835will be replaced with the hostname\&.
     8836.sp
     8837Default:
     8838\fI\fIserver string\fR\fR\fI = \fR\fI\FCSamba %v\F[]\fR\fI \fR
     8839.sp
     8840Example:
     8841\fI\fIserver string\fR\fR\fI = \fR\fI\FCUniversity of GNUs Samba Server\F[]\fR\fI \fR
    77168842.RE
    77178843
    77188844set directory (S)
     8845.\" set directory
    77198846.PP
    77208847.RS 4
    77218848If
    7722 set directory = no, then users of the service may not use the setdir command to change directory\.
     8849\FCset directory = no\F[], then users of the service may not use the setdir command to change directory\&.
    77238850.sp
    77248851The
    7725 setdir
    7726 command is only implemented in the Digital Pathworks client\. See the Pathworks documentation for details\.
    7727 .sp
    7728 Default:
    7729 \fI\fIset directory\fR\fR\fI = \fR\fIno\fR\fI \fR
     8852\FCsetdir\F[]
     8853command is only implemented in the Digital Pathworks client\&. See the Pathworks documentation for details\&.
     8854.sp
     8855Default:
     8856\fI\fIset directory\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    77308857.RE
    77318858
    77328859set primary group script (G)
    7733 .PP
    7734 .RS 4
    7735 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
    7736 net rpc vampire\.
     8860.\" set primary group script
     8861.PP
     8862.RS 4
     8863Thanks 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
     8864\FCnet rpc vampire\F[]\&.
    77378865\fI%u\fR
    7738 will be replaced with the user whose primary group is to be set\.
     8866will be replaced with the user whose primary group is to be set\&.
    77398867\fI%g\fR
    7740 will be replaced with the group to set\.
    7741 .sp
    7742 Default:
    7743 \fI\fIset primary group script\fR\fR\fI = \fR\fI\fR\fI \fR
    7744 .sp
    7745 Example:
    7746 \fI\fIset primary group script\fR\fR\fI = \fR\fI/usr/sbin/usermod \-g \'%g\' \'%u\'\fR\fI \fR
     8868will be replaced with the group to set\&.
     8869.sp
     8870Default:
     8871\fI\fIset primary group script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     8872.sp
     8873Example:
     8874\fI\fIset primary group script\fR\fR\fI = \fR\fI\FC/usr/sbin/usermod \-g \'%g\' \'%u\'\F[]\fR\fI \fR
    77478875.RE
    77488876
    77498877set quota command (G)
     8878.\" set quota command
    77508879.PP
    77518880.RS 4
    77528881The
    7753 set quota command
    7754 should only be used whenever there is no operating system API available from the OS that samba can use\.
     8882\FCset quota command\F[]
     8883should only be used whenever there is no operating system API available from the OS that samba can use\&.
    77558884.sp
    77568885This option is only available if Samba was configured with the argument
    7757 \-\-with\-sys\-quotas
     8886\FC\-\-with\-sys\-quotas\F[]
    77588887or on linux when
    7759 \./configure \-\-with\-quotas
    7760 was used and a working quota api was found in the system\. Most packages are configured with these options already\.
    7761 .sp
    7762 This parameter should specify the path to a script that can set quota for the specified arguments\.
     8888\FC\&./configure \-\-with\-quotas\F[]
     8889was used and a working quota api was found in the system\&. Most packages are configured with these options already\&.
     8890.sp
     8891This parameter should specify the path to a script that can set quota for the specified arguments\&.
    77638892.sp
    77648893The specified script should take the following arguments:
     
    78979026.sp
    78989027.RE
    7899 The script should output at least one line of data on success\. And nothing on failure\.
    7900 .sp
    7901 Default:
    7902 \fI\fIset quota command\fR\fR\fI = \fR\fI\fR\fI \fR
    7903 .sp
    7904 Example:
    7905 \fI\fIset quota command\fR\fR\fI = \fR\fI/usr/local/sbin/set_quota\fR\fI \fR
     9028The script should output at least one line of data on success\&. And nothing on failure\&.
     9029.sp
     9030Default:
     9031\fI\fIset quota command\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     9032.sp
     9033Example:
     9034\fI\fIset quota command\fR\fR\fI = \fR\fI\FC/usr/local/sbin/set_quota\F[]\fR\fI \fR
    79069035.RE
    79079036
    79089037share modes (S)
     9038.\" share modes
    79099039.PP
    79109040.RS 4
    79119041This enables or disables the honoring of the
    79129042\fIshare modes\fR
    7913 during a file open\. These modes are used by clients to gain exclusive read or write access to a file\.
    7914 .sp
    7915 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)\.
     9043during a file open\&. These modes are used by clients to gain exclusive read or write access to a file\&.
     9044.sp
     9045These 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)\&.
    79169046.sp
    79179047The share modes that are enabled by this option are
     
    79229052\fBDENY_NONE\fR
    79239053and
    7924 \fBDENY_FCB\fR\.
    7925 .sp
    7926 This option gives full share compatibility and enabled by default\.
     9054\fBDENY_FCB\fR\&.
     9055.sp
     9056This option gives full share compatibility and enabled by default\&.
    79279057.sp
    79289058You should
    79299059\fINEVER\fR
    7930 turn this parameter off as many Windows applications will break if you do so\.
    7931 .sp
    7932 Default:
    7933 \fI\fIshare modes\fR\fR\fI = \fR\fIyes\fR\fI \fR
     9060turn this parameter off as many Windows applications will break if you do so\&.
     9061.sp
     9062Default:
     9063\fI\fIshare modes\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    79349064.RE
    79359065
    79369066short preserve case (S)
    7937 .PP
    7938 .RS 4
    7939 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
    7940 \fIdefault case\fR\. This option can be use with
    7941 \fIpreserve case = yes\fR
    7942 to permit long filenames to retain their case, while short names are lowered\.
     9067.\" short preserve case
     9068.PP
     9069.RS 4
     9070This 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
     9071\m[blue]\fBdefault case\fR\m[]\&. This option can be use with
     9072\m[blue]\fBpreserve case = yes\fR\m[]
     9073to permit long filenames to retain their case, while short names are lowered\&.
    79439074.sp
    79449075See the section on
    7945 NAME MANGLING\.
    7946 .sp
    7947 Default:
    7948 \fI\fIshort preserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR
     9076NAME MANGLING\&.
     9077.sp
     9078Default:
     9079\fI\fIshort preserve case\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    79499080.RE
    79509081
    79519082show add printer wizard (G)
    7952 .PP
    7953 .RS 4
    7954 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\.
    7955 .sp
    7956 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
     9083.\" show add printer wizard
     9084.PP
     9085.RS 4
     9086With 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\&.
     9087.sp
     9088Under 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
    79579089\fIprinter admin\fR
    7958 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\.
     9090group), 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\&.
    79599091.sp
    79609092Disabling the
    79619093\fIshow add printer wizard\fR
    7962 parameter will always cause the OpenPrinterEx() on the server to fail\. Thus the APW icon will never be displayed\.
    7963 .sp
     9094parameter will always cause the OpenPrinterEx() on the server to fail\&. Thus the APW icon will never be displayed\&.
     9095.if n \{\
     9096.sp
     9097.\}
     9098.RS 4
     9099.BM yellow
    79649100.it 1 an-trap
    79659101.nr an-no-space-flag 1
    79669102.nr an-break-flag 1
    79679103.br
    7968 Note
    7969 This does not prevent the same user from having administrative privilege on an individual printer\.
    7970 
    7971 Default:
    7972 \fI\fIshow add printer wizard\fR\fR\fI = \fR\fIyes\fR\fI \fR
     9104.ps +1
     9105\fBNote\fR
     9106.ps -1
     9107.br
     9108This does not prevent the same user from having administrative privilege on an individual printer\&.
     9109.sp .5v
     9110.EM yellow
     9111.RE
     9112Default:
     9113\fI\fIshow add printer wizard\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    79739114.RE
    79749115
    79759116shutdown script (G)
     9117.\" shutdown script
    79769118.PP
    79779119.RS 4
    79789120This a full path name to a script called by
    79799121\fBsmbd\fR(8)
    7980 that should start a shutdown procedure\.
     9122that should start a shutdown procedure\&.
    79819123.sp
    79829124If the connected user posseses the
    7983 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user\.
     9125\fBSeRemoteShutdownPrivilege\fR, right, this command will be run as user\&.
    79849126.sp
    79859127The %z %t %r %f variables are expanded as follows:
     
    79949136.\}
    79959137\fI%z\fR
    7996 will be substituted with the shutdown message sent to the server\.
     9138will be substituted with the shutdown message sent to the server\&.
    79979139.RE
    79989140.sp
     
    80069148.\}
    80079149\fI%t\fR
    8008 will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\.
     9150will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\&.
    80099151.RE
    80109152.sp
     
    80199161\fI%r\fR
    80209162will be substituted with the switch
    8021 \fI\-r\fR\. It means reboot after shutdown for NT\.
     9163\fI\-r\fR\&. It means reboot after shutdown for NT\&.
    80229164.RE
    80239165.sp
     
    80329174\fI%f\fR
    80339175will be substituted with the switch
    8034 \fI\-f\fR\. It means force the shutdown even if applications do not respond for NT\.
     9176\fI\-f\fR\&. It means force the shutdown even if applications do not respond for NT\&.
    80359177.sp
    80369178.RE
    80379179Shutdown script example:
    80389180.sp
    8039 .RS 4
     9181.if n \{\
     9182.RS 4
     9183.\}
     9184.fam C
     9185.ps -1
    80409186.nf
     9187.if t \{\
     9188.sp -1
     9189.\}
     9190.BB lightgray adjust-for-leading-newline
     9191.sp -1
     9192
    80419193#!/bin/bash
    80429194               
     
    80469198
    80479199/sbin/shutdown $3 $4 +$time $1 &
     9200.EB lightgray adjust-for-leading-newline
     9201.if t \{\
     9202.sp 1
     9203.\}
    80489204.fi
    8049 .RE
    8050 .sp
    8051 Shutdown does not return so we need to launch it in background\.
    8052 .sp
    8053 Default:
    8054 \fI\fIshutdown script\fR\fR\fI = \fR\fI\fR\fI \fR
    8055 .sp
    8056 Example:
    8057 \fI\fIshutdown script\fR\fR\fI = \fR\fI/usr/local/samba/sbin/shutdown %m %t %r %f\fR\fI \fR
     9205.fam
     9206.ps +1
     9207.if n \{\
     9208.RE
     9209.\}
     9210.sp
     9211Shutdown does not return so we need to launch it in background\&.
     9212.sp
     9213Default:
     9214\fI\fIshutdown script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     9215.sp
     9216Example:
     9217\fI\fIshutdown script\fR\fR\fI = \fR\fI\FC/usr/local/samba/sbin/shutdown %m %t %r %f\F[]\fR\fI \fR
    80589218.RE
    80599219
    80609220smb encrypt (S)
    8061 .PP
    8062 .RS 4
    8063 This is a new feature introduced with Samba 3\.2 and above\. It is an extension to the SMB/CIFS protocol negotiated as part of the UNIX extensions\. SMB encryption uses the GSSAPI (SSPI on Windows) ability to encrypt and sign every request/response in a SMB protocol stream\. When enabled it provides a secure method of SMB/CIFS communication, similar to an ssh protected session, but using SMB/CIFS authentication to negotiate encryption and signing keys\. Currently this is only supported by Samba 3\.2 smbclient, and hopefully soon Linux CIFSFS and MacOS/X clients\. Windows clients do not support this feature\.
    8064 .sp
    8065 This controls whether the server offers or requires the client it talks to to use SMB encryption\. Possible values are
     9221.\" smb encrypt
     9222.PP
     9223.RS 4
     9224This is a new feature introduced with Samba 3\&.2 and above\&. It is an extension to the SMB/CIFS protocol negotiated as part of the UNIX extensions\&. SMB encryption uses the GSSAPI (SSPI on Windows) ability to encrypt and sign every request/response in a SMB protocol stream\&. When enabled it provides a secure method of SMB/CIFS communication, similar to an ssh protected session, but using SMB/CIFS authentication to negotiate encryption and signing keys\&. Currently this is only supported by Samba 3\&.2 smbclient, and hopefully soon Linux CIFSFS and MacOS/X clients\&. Windows clients do not support this feature\&.
     9225.sp
     9226This controls whether the server offers or requires the client it talks to to use SMB encryption\&. Possible values are
    80669227\fIauto\fR,
    80679228\fImandatory\fR
    80689229and
    8069 \fIdisabled\fR\. This may be set on a per\-share basis, but clients may chose to encrypt the entire session, not just traffic to a specific share\. If this is set to mandatory then all traffic to a share
     9230\fIdisabled\fR\&. This may be set on a per\-share basis, but clients may chose to encrypt the entire session, not just traffic to a specific share\&. If this is set to mandatory then all traffic to a share
    80709231\fImust\fR
    8071 must be encrypted once the connection has been made to the share\. The server would return "access denied" to all non\-encrypted requests on such a share\. Selecting encrypted traffic reduces throughput as smaller packet sizes must be used (no huge UNIX style read/writes allowed) as well as the overhead of encrypting and signing all the data\.
     9232must be encrypted once the connection has been made to the share\&. The server would return "access denied" to all non\-encrypted requests on such a share\&. Selecting encrypted traffic reduces throughput as smaller packet sizes must be used (no huge UNIX style read/writes allowed) as well as the overhead of encrypting and signing all the data\&.
    80729233.sp
    80739234If SMB encryption is selected, Windows style SMB signing (see the
    8074 \fIserver signing\fR
    8075 option) is no longer necessary, as the GSSAPI flags use select both signing and sealing of the data\.
    8076 .sp
    8077 When set to auto, SMB encryption is offered, but not enforced\. When set to mandatory, SMB encryption is required and if set to disabled, SMB encryption can not be negotiated\.
    8078 .sp
    8079 Default:
    8080 \fI\fIsmb encrypt\fR\fR\fI = \fR\fIauto\fR\fI \fR
     9235\m[blue]\fBserver signing\fR\m[]
     9236option) is no longer necessary, as the GSSAPI flags use select both signing and sealing of the data\&.
     9237.sp
     9238When set to auto, SMB encryption is offered, but not enforced\&. When set to mandatory, SMB encryption is required and if set to disabled, SMB encryption can not be negotiated\&.
     9239.sp
     9240Default:
     9241\fI\fIsmb encrypt\fR\fR\fI = \fR\fI\FCauto\F[]\fR\fI \fR
    80819242.RE
    80829243
    80839244smb passwd file (G)
    8084 .PP
    8085 .RS 4
    8086 This option sets the path to the encrypted smbpasswd file\. By default the path to the smbpasswd file is compiled into Samba\.
     9245.\" smb passwd file
     9246.PP
     9247.RS 4
     9248This option sets the path to the encrypted smbpasswd file\&. By default the path to the smbpasswd file is compiled into Samba\&.
    80879249.sp
    80889250An example of use is:
    80899251.sp
    8090 .RS 4
     9252.if n \{\
     9253.RS 4
     9254.\}
     9255.fam C
     9256.ps -1
    80919257.nf
     9258.if t \{\
     9259.sp -1
     9260.\}
     9261.BB lightgray adjust-for-leading-newline
     9262.sp -1
     9263
    80929264smb passwd file = /etc/samba/smbpasswd
     9265.EB lightgray adjust-for-leading-newline
     9266.if t \{\
     9267.sp 1
     9268.\}
    80939269.fi
    8094 .RE
    8095 .sp
    8096 .sp
    8097 Default:
    8098 \fI\fIsmb passwd file\fR\fR\fI = \fR\fI${prefix}/private/smbpasswd\fR\fI \fR
     9270.fam
     9271.ps +1
     9272.if n \{\
     9273.RE
     9274.\}
     9275.sp
     9276Default:
     9277\fI\fIsmb passwd file\fR\fR\fI = \fR\fI\FC${prefix}/private/smbpasswd\F[]\fR\fI \fR
    80999278.RE
    81009279
    81019280smb ports (G)
    8102 .PP
    8103 .RS 4
    8104 Specifies which ports the server should listen on for SMB traffic\.
    8105 .sp
    8106 Default:
    8107 \fI\fIsmb ports\fR\fR\fI = \fR\fI445 139\fR\fI \fR
     9281.\" smb ports
     9282.PP
     9283.RS 4
     9284Specifies which ports the server should listen on for SMB traffic\&.
     9285.sp
     9286Default:
     9287\fI\fIsmb ports\fR\fR\fI = \fR\fI\FC445 139\F[]\fR\fI \fR
    81089288.RE
    81099289
    81109290socket address (G)
    8111 .PP
    8112 .RS 4
    8113 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\.
    8114 .sp
    8115 By default Samba will accept connections on any address\.
    8116 .sp
    8117 Default:
    8118 \fI\fIsocket address\fR\fR\fI = \fR\fI\fR\fI \fR
    8119 .sp
    8120 Example:
    8121 \fI\fIsocket address\fR\fR\fI = \fR\fI192\.168\.2\.20\fR\fI \fR
     9291.\" socket address
     9292.PP
     9293.RS 4
     9294This 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\&.
     9295.sp
     9296Setting this option should never be necessary on usual Samba servers running only one nmbd\&.
     9297.sp
     9298By default Samba will accept connections on any address\&.
     9299.sp
     9300Default:
     9301\fI\fIsocket address\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     9302.sp
     9303Example:
     9304\fI\fIsocket address\fR\fR\fI = \fR\fI\FC192\&.168\&.2\&.20\F[]\fR\fI \fR
    81229305.RE
    81239306
    81249307socket options (G)
    8125 .PP
    8126 .RS 4
    8127 This option allows you to set socket options to be used when talking with the client\.
    8128 .sp
    8129 Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\.
    8130 .sp
    8131 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
    8132 man setsockopt
    8133 will help)\.
    8134 .sp
    8135 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
    8136 samba\-technical@samba\.org\.
    8137 .sp
    8138 Any of the supported socket options may be combined in any way you like, as long as your OS allows it\.
     9308.\" socket options
     9309.PP
     9310.RS 4
     9311This option allows you to set socket options to be used when talking with the client\&.
     9312.sp
     9313Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\&.
     9314.sp
     9315This 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
     9316\FCman setsockopt\F[]
     9317will help)\&.
     9318.sp
     9319You 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
     9320samba\-technical@samba\&.org\&.
     9321.sp
     9322Any of the supported socket options may be combined in any way you like, as long as your OS allows it\&.
    81399323.sp
    81409324This is the list of socket options currently settable using this option:
     
    82529436Those marked with a
    82539437\fI\'*\'\fR
    8254 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\.
     9438take 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\&.
    82559439.sp
    82569440To specify an argument use the syntax SOME_OPTION = VALUE for example
    8257 SO_SNDBUF = 8192\. Note that you must not have any spaces before or after the = sign\.
     9441\FCSO_SNDBUF = 8192\F[]\&. Note that you must not have any spaces before or after the = sign\&.
    82589442.sp
    82599443If you are on a local network then a sensible option might be:
    82609444.sp
    8261 socket options = IPTOS_LOWDELAY
     9445\FCsocket options = IPTOS_LOWDELAY\F[]
    82629446.sp
    82639447If you have a local network then you could try:
    82649448.sp
    8265 socket options = IPTOS_LOWDELAY TCP_NODELAY
    8266 .sp
    8267 If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\.
    8268 .sp
    8269 Note that several of the options may cause your Samba server to fail completely\. Use these options with caution!
    8270 .sp
    8271 Default:
    8272 \fI\fIsocket options\fR\fR\fI = \fR\fITCP_NODELAY\fR\fI \fR
    8273 .sp
    8274 Example:
    8275 \fI\fIsocket options\fR\fR\fI = \fR\fIIPTOS_LOWDELAY\fR\fI \fR
     9449\FCsocket options = IPTOS_LOWDELAY TCP_NODELAY\F[]
     9450.sp
     9451If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\&.
     9452.sp
     9453Note that several of the options may cause your Samba server to fail completely\&. Use these options with caution!
     9454.sp
     9455Default:
     9456\fI\fIsocket options\fR\fR\fI = \fR\fI\FCTCP_NODELAY\F[]\fR\fI \fR
     9457.sp
     9458Example:
     9459\fI\fIsocket options\fR\fR\fI = \fR\fI\FCIPTOS_LOWDELAY\F[]\fR\fI \fR
    82769460.RE
    82779461
    82789462stat cache (G)
     9463.\" stat cache
    82799464.PP
    82809465.RS 4
    82819466This parameter determines if
    82829467\fBsmbd\fR(8)
    8283 will use a cache in order to speed up case insensitive name mappings\. You should never need to change this parameter\.
    8284 .sp
    8285 Default:
    8286 \fI\fIstat cache\fR\fR\fI = \fR\fIyes\fR\fI \fR
     9468will use a cache in order to speed up case insensitive name mappings\&. You should never need to change this parameter\&.
     9469.sp
     9470Default:
     9471\fI\fIstat cache\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    82879472.RE
    82889473
    82899474store dos attributes (S)
     9475.\" store dos attributes
    82909476.PP
    82919477.RS 4
    82929478If 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
    8293 \fImap hidden\fR
     9479\m[blue]\fBmap hidden\fR\m[]
    82949480and
    8295 \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
    8296 \fImap hidden\fR,
    8297 \fImap system\fR,
    8298 \fImap archive\fR
     9481\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
     9482\m[blue]\fBmap hidden\fR\m[],
     9483\m[blue]\fBmap system\fR\m[],
     9484\m[blue]\fBmap archive\fR\m[]
    82999485and
    8300 \fImap readonly\fR
    8301 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\.
    8302 .sp
    8303 Default:
    8304 \fI\fIstore dos attributes\fR\fR\fI = \fR\fIno\fR\fI \fR
     9486\m[blue]\fBmap readonly\fR\m[]
     9487must 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\&.
     9488.sp
     9489Default:
     9490\fI\fIstore dos attributes\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    83059491.RE
    83069492
    83079493strict allocate (S)
    8308 .PP
    8309 .RS 4
    8310 This is a boolean that controls the handling of disk space allocation in the server\. When this is set to
     9494.\" strict allocate
     9495.PP
     9496.RS 4
     9497This is a boolean that controls the handling of disk space allocation in the server\&. When this is set to
    83119498\fByes\fR
    8312 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\.
     9499the 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\&.
    83139500.sp
    83149501When strict allocate is
    83159502\fBno\fR
    8316 the server does sparse disk block allocation when a file is extended\.
     9503the server does sparse disk block allocation when a file is extended\&.
    83179504.sp
    83189505Setting this to
    83199506\fByes\fR
    8320 can help Samba return out of quota messages on systems that are restricting the disk quota of users\.
    8321 .sp
    8322 Default:
    8323 \fI\fIstrict allocate\fR\fR\fI = \fR\fIno\fR\fI \fR
     9507can help Samba return out of quota messages on systems that are restricting the disk quota of users\&.
     9508.sp
     9509Default:
     9510\fI\fIstrict allocate\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    83249511.RE
    83259512
    83269513strict locking (S)
    8327 .PP
    8328 .RS 4
    8329 This is an enumerated type that controls the handling of file locking in the server\. When this is set to
    8330 \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\.
    8331 .sp
    8332 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\.
    8333 .sp
    8334 When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\.
    8335 .sp
    8336 Well\-behaved clients always ask for lock checks when it is important\. So in the vast majority of cases,
    8337 strict locking = Auto
     9514.\" strict locking
     9515.PP
     9516.RS 4
     9517This is an enumerated type that controls the handling of file locking in the server\&. When this is set to
     9518\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\&.
     9519.sp
     9520When 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\&.
     9521.sp
     9522When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\&.
     9523.sp
     9524Well\-behaved clients always ask for lock checks when it is important\&. So in the vast majority of cases,
     9525\FCstrict locking = Auto\F[]
    83389526or
    8339 strict locking = no
    8340 is acceptable\.
    8341 .sp
    8342 Default:
    8343 \fI\fIstrict locking\fR\fR\fI = \fR\fIAuto\fR\fI \fR
     9527\FCstrict locking = no\F[]
     9528is acceptable\&.
     9529.sp
     9530Default:
     9531\fI\fIstrict locking\fR\fR\fI = \fR\fI\FCAuto\F[]\fR\fI \fR
    83449532.RE
    83459533
    83469534strict sync (S)
    8347 .PP
    8348 .RS 4
    8349 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
     9535.\" strict sync
     9536.PP
     9537.RS 4
     9538Many 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
    83509539\fBno\fR
    83519540(the default) means that
    83529541\fBsmbd\fR(8)
    8353 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\.
    8354 .sp
    8355 Default:
    8356 \fI\fIstrict sync\fR\fR\fI = \fR\fIno\fR\fI \fR
     9542ignores 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\&.
     9543.sp
     9544Default:
     9545\fI\fIstrict sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    83579546.RE
    83589547
    83599548svcctl list (G)
    8360 .PP
    8361 .RS 4
    8362 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\.
     9549.\" svcctl list
     9550.PP
     9551.RS 4
     9552This 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\&.
    83639553.sp
    83649554The administrator must create a directory name
    8365 \fIsvcctl\fR
     9555\FCsvcctl\F[]
    83669556in Samba\'s $(libdir) and create symbolic links to the init scripts in
    8367 \fI/etc/init\.d/\fR\. The name of the links must match the names given as part of the
    8368 \fIsvcctl list\fR\.
    8369 .sp
    8370 Default:
    8371 \fI\fIsvcctl list\fR\fR\fI = \fR\fI\fR\fI \fR
    8372 .sp
    8373 Example:
    8374 \fI\fIsvcctl list\fR\fR\fI = \fR\fIcups postfix portmap httpd\fR\fI \fR
     9557\FC/etc/init\&.d/\F[]\&. The name of the links must match the names given as part of the
     9558\fIsvcctl list\fR\&.
     9559.sp
     9560Default:
     9561\fI\fIsvcctl list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     9562.sp
     9563Example:
     9564\fI\fIsvcctl list\fR\fR\fI = \fR\fI\FCcups postfix portmap httpd\F[]\fR\fI \fR
    83759565.RE
    83769566
    83779567sync always (S)
    8378 .PP
    8379 .RS 4
    8380 This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\. If this is
     9568.\" sync always
     9569.PP
     9570.RS 4
     9571This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\&. If this is
    83819572\fBno\fR
    8382 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
     9573then 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
    83839574\fByes\fR
    83849575then every write will be followed by a
    8385 fsync()
    8386 call to ensure the data is written to disk\. Note that the
     9576\FCfsync() \F[]
     9577call to ensure the data is written to disk\&. Note that the
    83879578\fIstrict sync\fR
    83889579parameter must be set to
    83899580\fByes\fR
    8390 in order for this parameter to have any affect\.
    8391 .sp
    8392 Default:
    8393 \fI\fIsync always\fR\fR\fI = \fR\fIno\fR\fI \fR
     9581in order for this parameter to have any affect\&.
     9582.sp
     9583Default:
     9584\fI\fIsync always\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    83949585.RE
    83959586
    83969587syslog only (G)
    8397 .PP
    8398 .RS 4
    8399 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
     9588.\" syslog only
     9589.PP
     9590.RS 4
     9591If 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
    84009592\fIsyslog only\fR
    8401 is enabled\.
    8402 .sp
    8403 Default:
    8404 \fI\fIsyslog only\fR\fR\fI = \fR\fIno\fR\fI \fR
     9593is enabled\&.
     9594.sp
     9595Default:
     9596\fI\fIsyslog only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    84059597.RE
    84069598
    84079599syslog (G)
    8408 .PP
    8409 .RS 4
    8410 This parameter maps how Samba debug messages are logged onto the system syslog logging levels\. Samba debug level zero maps onto syslog
     9600.\" syslog
     9601.PP
     9602.RS 4
     9603This parameter maps how Samba debug messages are logged onto the system syslog logging levels\&. Samba debug level zero maps onto syslog
    84119604\fBLOG_ERR\fR, debug level one maps onto
    84129605\fBLOG_WARNING\fR, debug level two maps onto
    8413 \fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\. All higher levels are mapped to
    8414 \fBLOG_DEBUG\fR\.
    8415 .sp
    8416 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
     9606\fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\&. All higher levels are mapped to
     9607\fBLOG_DEBUG\fR\&.
     9608.sp
     9609This 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
    84179610\fIsyslog only\fR
    8418 is enabled\.
    8419 .sp
    8420 Default:
    8421 \fI\fIsyslog\fR\fR\fI = \fR\fI1\fR\fI \fR
     9611is enabled\&.
     9612.sp
     9613Default:
     9614\fI\fIsyslog\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
    84229615.RE
    84239616
    84249617template homedir (G)
     9618.\" template homedir
    84259619.PP
    84269620.RS 4
    84279621When filling out the user information for a Windows NT user, the
    84289622\fBwinbindd\fR(8)
    8429 daemon uses this parameter to fill in the home directory for that user\. If the string
     9623daemon uses this parameter to fill in the home directory for that user\&. If the string
    84309624\fI%D\fR
    8431 is present it is substituted with the user\'s Windows NT domain name\. If the string
     9625is present it is substituted with the user\'s Windows NT domain name\&. If the string
    84329626\fI%U\fR
    8433 is present it is substituted with the user\'s Windows NT user name\.
    8434 .sp
    8435 Default:
    8436 \fI\fItemplate homedir\fR\fR\fI = \fR\fI/home/%D/%U\fR\fI \fR
     9627is present it is substituted with the user\'s Windows NT user name\&.
     9628.sp
     9629Default:
     9630\fI\fItemplate homedir\fR\fR\fI = \fR\fI\FC/home/%D/%U\F[]\fR\fI \fR
    84379631.RE
    84389632
    84399633template shell (G)
     9634.\" template shell
    84409635.PP
    84419636.RS 4
    84429637When filling out the user information for a Windows NT user, the
    84439638\fBwinbindd\fR(8)
    8444 daemon uses this parameter to fill in the login shell for that user\.
     9639daemon uses this parameter to fill in the login shell for that user\&.
    84459640.sp
    84469641\fINo default\fR
     
    84489643
    84499644time offset (G)
    8450 .PP
    8451 .RS 4
    8452 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\.
    8453 .sp
    8454 Default:
    8455 \fI\fItime offset\fR\fR\fI = \fR\fI0\fR\fI \fR
    8456 .sp
    8457 Example:
    8458 \fI\fItime offset\fR\fR\fI = \fR\fI60\fR\fI \fR
     9645.\" time offset
     9646.PP
     9647.RS 4
     9648This 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\&.
     9649.sp
     9650Default:
     9651\fI\fItime offset\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     9652.sp
     9653Example:
     9654\fI\fItime offset\fR\fR\fI = \fR\fI\FC60\F[]\fR\fI \fR
    84599655.RE
    84609656
    84619657time server (G)
     9658.\" time server
    84629659.PP
    84639660.RS 4
    84649661This parameter determines if
    84659662\fBnmbd\fR(8)
    8466 advertises itself as a time server to Windows clients\.
    8467 .sp
    8468 Default:
    8469 \fI\fItime server\fR\fR\fI = \fR\fIno\fR\fI \fR
     9663advertises itself as a time server to Windows clients\&.
     9664.sp
     9665Default:
     9666\fI\fItime server\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    84709667.RE
    84719668
    84729669unix charset (G)
    8473 .PP
    8474 .RS 4
    8475 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\.
    8476 .sp
    8477 This is also the charset Samba will use when specifying arguments to scripts that it invokes\.
    8478 .sp
    8479 Default:
    8480 \fI\fIunix charset\fR\fR\fI = \fR\fIUTF8\fR\fI \fR
    8481 .sp
    8482 Example:
    8483 \fI\fIunix charset\fR\fR\fI = \fR\fIASCII\fR\fI \fR
     9670.\" unix charset
     9671.PP
     9672.RS 4
     9673Specifies 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\&.
     9674.sp
     9675This is also the charset Samba will use when specifying arguments to scripts that it invokes\&.
     9676.sp
     9677Default:
     9678\fI\fIunix charset\fR\fR\fI = \fR\fI\FCUTF8\F[]\fR\fI \fR
     9679.sp
     9680Example:
     9681\fI\fIunix charset\fR\fR\fI = \fR\fI\FCASCII\F[]\fR\fI \fR
    84849682.RE
    84859683
    84869684unix extensions (G)
    8487 .PP
    8488 .RS 4
    8489 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\.
    8490 .sp
    8491 Default:
    8492 \fI\fIunix extensions\fR\fR\fI = \fR\fIyes\fR\fI \fR
     9685.\" unix extensions
     9686.PP
     9687.RS 4
     9688This 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\&.
     9689.sp
     9690Default:
     9691\fI\fIunix extensions\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    84939692.RE
    84949693
    84959694unix password sync (G)
    8496 .PP
    8497 .RS 4
    8498 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
     9695.\" unix password sync
     9696.PP
     9697.RS 4
     9698This 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
    84999699\fByes\fR
    85009700the program specified in the
     
    85029702parameter is called
    85039703\fIAS ROOT\fR
    8504 \- 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)\.
    8505 .sp
    8506 Default:
    8507 \fI\fIunix password sync\fR\fR\fI = \fR\fIno\fR\fI \fR
     9704\- 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)\&.
     9705.sp
     9706Default:
     9707\fI\fIunix password sync\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    85089708.RE
    85099709
    85109710update encrypted (G)
    8511 .PP
    8512 .RS 4
    8513 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
    8514 \fBno\fR\.
     9711.\" update encrypted
     9712.PP
     9713.RS 4
     9714This 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
     9715\fBno\fR\&.
    85159716.sp
    85169717In order for this parameter to be operative the
    8517 \fIencrypt passwords\fR
     9718\m[blue]\fBencrypt passwords\fR\m[]
    85189719parameter must be set to
    8519 \fBno\fR\. The default value of
    8520 \fIencrypt passwords = Yes\fR\. Note: This must be set to
     9720\fBno\fR\&. The default value of
     9721\m[blue]\fBencrypt passwords = Yes\fR\m[]\&. Note: This must be set to
    85219722\fBno\fR
    85229723for this
    8523 \fIupdate encrypted\fR
    8524 to work\.
     9724\m[blue]\fBupdate encrypted\fR\m[]
     9725to work\&.
    85259726.sp
    85269727Note that even when this parameter is set a user authenticating to
    8527 smbd
    8528 must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords\.
    8529 .sp
    8530 Default:
    8531 \fI\fIupdate encrypted\fR\fR\fI = \fR\fIno\fR\fI \fR
     9728\FCsmbd\F[]
     9729must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords\&.
     9730.sp
     9731Default:
     9732\fI\fIupdate encrypted\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    85329733.RE
    85339734
    85349735use client driver (S)
    8535 .PP
    8536 .RS 4
    8537 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
    8538 disable spoolss = yes\.
    8539 .sp
    8540 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)\.
    8541 .sp
    8542 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\.
    8543 \fIThis parameter MUST not be able enabled on a print share which has valid print driver installed on the Samba server\.\fR
    8544 .sp
    8545 Default:
    8546 \fI\fIuse client driver\fR\fR\fI = \fR\fIno\fR\fI \fR
     9736.\" use client driver
     9737.PP
     9738.RS 4
     9739This 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
     9740\FCdisable spoolss = yes\F[]\&.
     9741.sp
     9742The 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)\&.
     9743.sp
     9744If 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\&.
     9745\fIThis parameter MUST not be able enabled on a print share which has valid print driver installed on the Samba server\&.\fR
     9746.sp
     9747Default:
     9748\fI\fIuse client driver\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    85479749.RE
    85489750
    85499751use kerberos keytab (G)
     9752.\" use kerberos keytab
    85509753.PP
    85519754.RS 4
     
    85539756\fBhost/FQDN\fR
    85549757and
    8555 \fBcifs/FQDN\fR\.
     9758\fBcifs/FQDN\fR\&.
    85569759.sp
    85579760When you are using the heimdal Kerberos libraries, you must also specify the following in
    8558 \fI/etc/krb5\.conf\fR:
    8559 .sp
    8560 .RS 4
     9761\FC/etc/krb5\&.conf\F[]:
     9762.sp
     9763.if n \{\
     9764.RS 4
     9765.\}
     9766.fam C
     9767.ps -1
    85619768.nf
     9769.if t \{\
     9770.sp -1
     9771.\}
     9772.BB lightgray adjust-for-leading-newline
     9773.sp -1
     9774
    85629775[libdefaults]
    8563 default_keytab_name = FILE:/etc/krb5\.keytab
     9776default_keytab_name = FILE:/etc/krb5\&.keytab
     9777.EB lightgray adjust-for-leading-newline
     9778.if t \{\
     9779.sp 1
     9780.\}
    85649781.fi
    8565 .RE
    8566 .sp
    8567 .sp
    8568 Default:
    8569 \fI\fIuse kerberos keytab\fR\fR\fI = \fR\fIFalse\fR\fI \fR
     9782.fam
     9783.ps +1
     9784.if n \{\
     9785.RE
     9786.\}
     9787.sp
     9788Default:
     9789\fI\fIuse kerberos keytab\fR\fR\fI = \fR\fI\FCFalse\F[]\fR\fI \fR
    85709790.RE
    85719791
    85729792use mmap (G)
    8573 .PP
    8574 .RS 4
    8575 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
     9793.\" use mmap
     9794.PP
     9795.RS 4
     9796This 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
    85769797\fBno\fR
    8577 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\.
    8578 .sp
    8579 Default:
    8580 \fI\fIuse mmap\fR\fR\fI = \fR\fIyes\fR\fI \fR
     9798by 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\&.
     9799.sp
     9800Default:
     9801\fI\fIuse mmap\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    85819802.RE
    85829803
    85839804username level (G)
    8584 .PP
    8585 .RS 4
    8586 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\.
    8587 .sp
    8588 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
    8589 \fBAstrangeUser \fR\.
    8590 .sp
    8591 This parameter is needed only on UNIX systems that have case sensitive usernames\.
    8592 .sp
    8593 Default:
    8594 \fI\fIusername level\fR\fR\fI = \fR\fI0\fR\fI \fR
    8595 .sp
    8596 Example:
    8597 \fI\fIusername level\fR\fR\fI = \fR\fI5\fR\fI \fR
     9805.\" username level
     9806.PP
     9807.RS 4
     9808This 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\&.
     9809.sp
     9810If 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
     9811\fBAstrangeUser \fR\&.
     9812.sp
     9813This parameter is needed only on UNIX systems that have case sensitive usernames\&.
     9814.sp
     9815Default:
     9816\fI\fIusername level\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     9817.sp
     9818Example:
     9819\fI\fIusername level\fR\fR\fI = \fR\fI\FC5\F[]\fR\fI \fR
    85989820.RE
    85999821
    86009822username map script (G)
     9823.\" username map script
    86019824.PP
    86029825.RS 4
    86039826This script is a mutually exclusive alternative to the
    8604 \fIusername map\fR
    8605 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\.
    8606 .sp
    8607 Default:
    8608 \fI\fIusername map script\fR\fR\fI = \fR\fI\fR\fI \fR
    8609 .sp
    8610 Example:
    8611 \fI\fIusername map script\fR\fR\fI = \fR\fI/etc/samba/scripts/mapusers\.sh\fR\fI \fR
     9827\m[blue]\fBusername map\fR\m[]
     9828parameter\&. 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\&.
     9829.sp
     9830Default:
     9831\fI\fIusername map script\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     9832.sp
     9833Example:
     9834\fI\fIusername map script\fR\fR\fI = \fR\fI\FC/etc/samba/scripts/mapusers\&.sh\F[]\fR\fI \fR
    86129835.RE
    86139836
    86149837username map (G)
    8615 .PP
    8616 .RS 4
    8617 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\.
    8618 .sp
    8619 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 =
    8620 DOMAIN\efoo)\.
    8621 .sp
    8622 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\.
    8623 .sp
    8624 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\.
    8625 .sp
    8626 If any line begins with a \'#\' or a \';\' then it is ignored\.
    8627 .sp
    8628 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\.
     9838.\" username map
     9839.PP
     9840.RS 4
     9841This 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\&.
     9842.sp
     9843Please 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 =
     9844\FCDOMAIN\efoo\F[])\&.
     9845.sp
     9846The 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\&.
     9847.sp
     9848The 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\&.
     9849.sp
     9850If any line begins with a \'#\' or a \';\' then it is ignored\&.
     9851.sp
     9852If 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\&.
    86299853.sp
    86309854For example to map from the name
     
    86369860you would use:
    86379861.sp
    8638 .RS 4
     9862.if n \{\
     9863.RS 4
     9864.\}
     9865.fam C
     9866.ps -1
    86399867.nf
    8640 root = admin administrator
     9868.if t \{\
     9869.sp -1
     9870.\}
     9871.BB lightgray adjust-for-leading-newline
     9872.sp -1
     9873
     9874\FCroot = admin administrator\F[]
     9875.EB lightgray adjust-for-leading-newline
     9876.if t \{\
     9877.sp 1
     9878.\}
    86419879.fi
    8642 .RE
     9880.fam
     9881.ps +1
     9882.if n \{\
     9883.RE
     9884.\}
    86439885.sp
    86449886Or to map anyone in the UNIX group
     
    86489890you would use:
    86499891.sp
    8650 .RS 4
     9892.if n \{\
     9893.RS 4
     9894.\}
     9895.fam C
     9896.ps -1
    86519897.nf
    8652 sys = @system
     9898.if t \{\
     9899.sp -1
     9900.\}
     9901.BB lightgray adjust-for-leading-newline
     9902.sp -1
     9903
     9904\FCsys = @system\F[]
     9905.EB lightgray adjust-for-leading-newline
     9906.if t \{\
     9907.sp 1
     9908.\}
    86539909.fi
    8654 .RE
    8655 .sp
    8656 .sp
    8657 You can have as many mappings as you like in a username map file\.
     9910.fam
     9911.ps +1
     9912.if n \{\
     9913.RE
     9914.\}
     9915.sp
     9916You can have as many mappings as you like in a username map file\&.
    86589917.sp
    86599918If your system supports the NIS NETGROUP option then the netgroup database is checked before the
    8660 \fI/etc/group \fR
    8661 database for matching groups\.
    8662 .sp
    8663 You can map Windows usernames that have spaces in them by using double quotes around the name\. For example:
    8664 .sp
    8665 .RS 4
     9919\FC/etc/group \F[]
     9920database for matching groups\&.
     9921.sp
     9922You can map Windows usernames that have spaces in them by using double quotes around the name\&. For example:
     9923.sp
     9924.if n \{\
     9925.RS 4
     9926.\}
     9927.fam C
     9928.ps -1
    86669929.nf
    8667 tridge = "Andrew Tridgell"
     9930.if t \{\
     9931.sp -1
     9932.\}
     9933.BB lightgray adjust-for-leading-newline
     9934.sp -1
     9935
     9936\FCtridge = "Andrew Tridgell"\F[]
     9937.EB lightgray adjust-for-leading-newline
     9938.if t \{\
     9939.sp 1
     9940.\}
    86689941.fi
    8669 .RE
    8670 .sp
    8671 would map the windows username "Andrew Tridgell" to the unix username "tridge"\.
    8672 .sp
    8673 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:
    8674 .sp
    8675 .RS 4
     9942.fam
     9943.ps +1
     9944.if n \{\
     9945.RE
     9946.\}
     9947.sp
     9948would map the windows username "Andrew Tridgell" to the unix username "tridge"\&.
     9949.sp
     9950The 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:
     9951.sp
     9952.if n \{\
     9953.RS 4
     9954.\}
     9955.fam C
     9956.ps -1
    86769957.nf
     9958.if t \{\
     9959.sp -1
     9960.\}
     9961.BB lightgray adjust-for-leading-newline
     9962.sp -1
     9963
    86779964!sys = mary fred
    86789965guest = *
     9966.EB lightgray adjust-for-leading-newline
     9967.if t \{\
     9968.sp 1
     9969.\}
    86799970.fi
    8680 .RE
    8681 .sp
    8682 .sp
    8683 Note that the remapping is applied to all occurrences of usernames\. Thus if you connect to \e\eserver\efred and
     9971.fam
     9972.ps +1
     9973.if n \{\
     9974.RE
     9975.\}
     9976.sp
     9977Note that the remapping is applied to all occurrences of usernames\&. Thus if you connect to \e\eserver\efred and
    86849978\fBfred\fR
    86859979is remapped to
     
    86889982\fBmary\fR
    86899983not
    8690 \fBfred\fR\. The only exception to this is the username passed to the
    8691 \fIpassword server\fR
    8692 (if you have one)\. The password server will receive whatever username the client supplies without modification\.
    8693 .sp
    8694 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\.
    8695 .sp
    8696 Samba versions prior to 3\.0\.8 would only support reading the fully qualified username (e\.g\.:
    8697 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\.
    8698 .sp
    8699 The following functionality is obeyed in version 3\.0\.8 and later:
    8700 .sp
    8701 When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\.
    8702 .sp
    8703 When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\.e\.
    8704 DOMAIN\euser) only after the user has been successfully authenticated\.
     9984\fBfred\fR\&. The only exception to this is the username passed to the
     9985\m[blue]\fBpassword server\fR\m[]
     9986(if you have one)\&. The password server will receive whatever username the client supplies without modification\&.
     9987.sp
     9988Also 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\&.
     9989.sp
     9990Samba versions prior to 3\&.0\&.8 would only support reading the fully qualified username (e\&.g\&.:
     9991\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\&.
     9992.sp
     9993The following functionality is obeyed in version 3\&.0\&.8 and later:
     9994.sp
     9995When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\&.
     9996.sp
     9997When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\&.e\&.
     9998\FCDOMAIN\euser\F[]) only after the user has been successfully authenticated\&.
    87059999.sp
    870610000An example of use is:
    870710001.sp
    8708 .RS 4
     10002.if n \{\
     10003.RS 4
     10004.\}
     10005.fam C
     10006.ps -1
    870910007.nf
    8710 username map = /usr/local/samba/lib/users\.map
     10008.if t \{\
     10009.sp -1
     10010.\}
     10011.BB lightgray adjust-for-leading-newline
     10012.sp -1
     10013
     10014username map = /usr/local/samba/lib/users\&.map
     10015.EB lightgray adjust-for-leading-newline
     10016.if t \{\
     10017.sp 1
     10018.\}
    871110019.fi
    8712 .RE
    8713 .sp
    8714 .sp
    8715 Default:
    8716 \fI\fIusername map\fR\fR\fI = \fR\fI # no username map\fR\fI \fR
     10020.fam
     10021.ps +1
     10022.if n \{\
     10023.RE
     10024.\}
     10025.sp
     10026Default:
     10027\fI\fIusername map\fR\fR\fI = \fR\fI\FC # no username map\F[]\fR\fI \fR
    871710028.RE
    871810029
    871910030user
     10031.\" user
    872010032.PP
    872110033.RS 4
    872210034This parameter is a synonym for
    8723 username\.
     10035username\&.
    872410036.RE
    872510037
    872610038users
     10039.\" users
    872710040.PP
    872810041.RS 4
    872910042This parameter is a synonym for
    8730 username\.
     10043username\&.
    873110044.RE
    873210045
    873310046username (S)
    8734 .PP
    8735 .RS 4
    8736 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)\.
     10047.\" username
     10048.PP
     10049.RS 4
     10050Multiple 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)\&.
    873710051.sp
    873810052The
    873910053\fIusername\fR
    8740 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\.
     10054line 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\&.
    874110055.sp
    874210056The
     
    874410058line 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
    874510059\fIusername\fR
    8746 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\.
    8747 .sp
    8748 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\.
     10060line 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\&.
     10061.sp
     10062Samba 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\&.
    874910063.sp
    875010064To restrict a service to a particular set of users you can use the
    8751 \fIvalid users\fR
    8752 parameter\.
    8753 .sp
    8754 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\.
    8755 .sp
    8756 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\.
    8757 .sp
    8758 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\.
    8759 .sp
    8760 Note that searching though a groups database can take quite some time, and some clients may time out during the search\.
     10065\m[blue]\fBvalid users\fR\m[]
     10066parameter\&.
     10067.sp
     10068If 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\&.
     10069.sp
     10070If 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\&.
     10071.sp
     10072If 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\&.
     10073.sp
     10074Note that searching though a groups database can take quite some time, and some clients may time out during the search\&.
    876110075.sp
    876210076See the section
    876310077NOTE ABOUT USERNAME/PASSWORD VALIDATION
    8764 for more information on how this parameter determines access to the services\.
    8765 .sp
    8766 Default:
    8767 \fI\fIusername\fR\fR\fI = \fR\fI # The guest account if a guest service, else <empty string>\.\fR\fI \fR
    8768 .sp
    8769 Example:
    8770 \fI\fIusername\fR\fR\fI = \fR\fIfred, mary, jack, jane, @users, @pcgroup\fR\fI \fR
     10078for more information on how this parameter determines access to the services\&.
     10079.sp
     10080Default:
     10081\fI\fIusername\fR\fR\fI = \fR\fI\FC # The guest account if a guest service, else <empty string>\&.\F[]\fR\fI \fR
     10082.sp
     10083Example:
     10084\fI\fIusername\fR\fR\fI = \fR\fI\FCfred, mary, jack, jane, @users, @pcgroup\F[]\fR\fI \fR
    877110085.RE
    877210086
    877310087usershare allow guests (G)
    8774 .PP
    8775 .RS 4
    8776 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
     10088.\" usershare allow guests
     10089.PP
     10090.RS 4
     10091This 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
    877710092\fIguest ok = yes\fR
    8778 in a share definition\. Due to the security sensitive nature of this the default is set to off\.
    8779 .sp
    8780 Default:
    8781 \fI\fIusershare allow guests\fR\fR\fI = \fR\fIno\fR\fI \fR
     10093in a share definition\&. Due to the security sensitive nature of this the default is set to off\&.
     10094.sp
     10095Default:
     10096\fI\fIusershare allow guests\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    878210097.RE
    878310098
    878410099usershare max shares (G)
    8785 .PP
    8786 .RS 4
    8787 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\.
    8788 .sp
    8789 Default:
    8790 \fI\fIusershare max shares\fR\fR\fI = \fR\fI0\fR\fI \fR
     10100.\" usershare max shares
     10101.PP
     10102.RS 4
     10103This 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\&.
     10104.sp
     10105Default:
     10106\fI\fIusershare max shares\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
    879110107.RE
    879210108
    879310109usershare owner only (G)
    8794 .PP
    8795 .RS 4
    8796 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\.
    8797 .sp
    8798 Default:
    8799 \fI\fIusershare owner only\fR\fR\fI = \fR\fITrue\fR\fI \fR
     10110.\" usershare owner only
     10111.PP
     10112.RS 4
     10113This 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\&.
     10114.sp
     10115Default:
     10116\fI\fIusershare owner only\fR\fR\fI = \fR\fI\FCTrue\F[]\fR\fI \fR
    880010117.RE
    880110118
    880210119usershare path (G)
    8803 .PP
    8804 .RS 4
    8805 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\.
    8806 .sp
    8807 For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\.
    8808 .sp
    8809 
    8810 .sp
    8811 .RS 4
     10120.\" usershare path
     10121.PP
     10122.RS 4
     10123This 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\&.
     10124.sp
     10125For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\&.
     10126.sp
     10127
     10128.sp
     10129.if n \{\
     10130.RS 4
     10131.\}
     10132.fam C
     10133.ps -1
    881210134.nf
     10135.if t \{\
     10136.sp -1
     10137.\}
     10138.BB lightgray adjust-for-leading-newline
     10139.sp -1
     10140
    881310141        ls \-ld /usr/local/samba/lib/usershares/
    881410142        drwxrwx\-\-T  2 root power_users 4096 2006\-05\-05 12:27 /usr/local/samba/lib/usershares/
    881510143       
     10144.EB lightgray adjust-for-leading-newline
     10145.if t \{\
     10146.sp 1
     10147.\}
    881610148.fi
    8817 .RE
    8818 .sp
    8819 .sp
    8820 In this case, only members of the group "power_users" can create user defined shares\.
    8821 .sp
    8822 Default:
    8823 \fI\fIusershare path\fR\fR\fI = \fR\fINULL\fR\fI \fR
     10149.fam
     10150.ps +1
     10151.if n \{\
     10152.RE
     10153.\}
     10154.sp
     10155In this case, only members of the group "power_users" can create user defined shares\&.
     10156.sp
     10157Default:
     10158\fI\fIusershare path\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
    882410159.RE
    882510160
    882610161usershare prefix allow list (G)
    8827 .PP
    8828 .RS 4
    8829 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\.
    8830 .sp
    8831 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\.
    8832 .sp
    8833 Default:
    8834 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fINULL\fR\fI \fR
    8835 .sp
    8836 Example:
    8837 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI/home /data /space\fR\fI \fR
     10162.\" usershare prefix allow list
     10163.PP
     10164.RS 4
     10165This 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\&.
     10166.sp
     10167If 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\&.
     10168.sp
     10169Default:
     10170\fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
     10171.sp
     10172Example:
     10173\fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\FC/home /data /space\F[]\fR\fI \fR
    883810174.RE
    883910175
    884010176usershare prefix deny list (G)
    8841 .PP
    8842 .RS 4
    8843 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\.
    8844 .sp
    8845 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\.
    8846 .sp
    8847 Default:
    8848 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fINULL\fR\fI \fR
    8849 .sp
    8850 Example:
    8851 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI/etc /dev /private\fR\fI \fR
     10177.\" usershare prefix deny list
     10178.PP
     10179.RS 4
     10180This 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\&.
     10181.sp
     10182If 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\&.
     10183.sp
     10184Default:
     10185\fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
     10186.sp
     10187Example:
     10188\fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\FC/etc /dev /private\F[]\fR\fI \fR
    885210189.RE
    885310190
    885410191usershare template share (G)
    8855 .PP
    8856 .RS 4
    8857 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\.
    8858 .sp
    8859 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\.
    8860 .sp
    8861 Default:
    8862 \fI\fIusershare template share\fR\fR\fI = \fR\fINULL\fR\fI \fR
    8863 .sp
    8864 Example:
    8865 \fI\fIusershare template share\fR\fR\fI = \fR\fItemplate_share\fR\fI \fR
     10192.\" usershare template share
     10193.PP
     10194.RS 4
     10195User 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\&.
     10196.sp
     10197The 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\&.
     10198.sp
     10199Default:
     10200\fI\fIusershare template share\fR\fR\fI = \fR\fI\FCNULL\F[]\fR\fI \fR
     10201.sp
     10202Example:
     10203\fI\fIusershare template share\fR\fR\fI = \fR\fI\FCtemplate_share\F[]\fR\fI \fR
    886610204.RE
    886710205
    886810206use sendfile (S)
     10207.\" use sendfile
    886910208.PP
    887010209.RS 4
     
    887210211\fByes\fR, and the
    887310212\fBsendfile()\fR
    8874 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)\.
    8875 .sp
    8876 Default:
    8877 \fI\fIuse sendfile\fR\fR\fI = \fR\fIfalse\fR\fI \fR
     10213system 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)\&.
     10214.sp
     10215Default:
     10216\fI\fIuse sendfile\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
    887810217.RE
    887910218
    888010219use spnego (G)
    8881 .PP
    8882 .RS 4
    8883 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\.
    8884 .sp
    8885 Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled\.
    8886 .sp
    8887 Default:
    8888 \fI\fIuse spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10220.\" use spnego
     10221.PP
     10222.RS 4
     10223This 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\&.
     10224.sp
     10225Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled\&.
     10226.sp
     10227Default:
     10228\fI\fIuse spnego\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    888910229.RE
    889010230
    889110231utmp directory (G)
     10232.\" utmp directory
    889210233.PP
    889310234.RS 4
    889410235This parameter is only available if Samba has been configured and compiled with the option
    8895 \-\-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
    8896 \fI/var/run/utmp\fR
    8897 on Linux)\.
    8898 .sp
    8899 Default:
    8900 \fI\fIutmp directory\fR\fR\fI = \fR\fI # Determined automatically\fR\fI \fR
    8901 .sp
    8902 Example:
    8903 \fI\fIutmp directory\fR\fR\fI = \fR\fI/var/run/utmp\fR\fI \fR
     10236\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
     10237\FC/var/run/utmp\F[]
     10238on Linux)\&.
     10239.sp
     10240Default:
     10241\fI\fIutmp directory\fR\fR\fI = \fR\fI\FC # Determined automatically\F[]\fR\fI \fR
     10242.sp
     10243Example:
     10244\fI\fIutmp directory\fR\fR\fI = \fR\fI\FC/var/run/utmp\F[]\fR\fI \fR
    890410245.RE
    890510246
    890610247utmp (G)
     10248.\" utmp
    890710249.PP
    890810250.RS 4
    890910251This boolean parameter is only available if Samba has been configured and compiled with the option
    8910 \-\-with\-utmp\. If set to
     10252\FC\-\-with\-utmp\F[]\&. If set to
    891110253\fByes\fR
    8912 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\.
    8913 .sp
    8914 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\.
    8915 .sp
    8916 Default:
    8917 \fI\fIutmp\fR\fR\fI = \fR\fIno\fR\fI \fR
     10254then 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\&.
     10255.sp
     10256Due 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\&.
     10257.sp
     10258Default:
     10259\fI\fIutmp\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    891810260.RE
    891910261
    892010262valid users (S)
    8921 .PP
    8922 .RS 4
    8923 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
     10263.\" valid users
     10264.PP
     10265.RS 4
     10266This 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
    892410267\fIinvalid users\fR
    8925 parameter\.
    8926 .sp
    8927 If this is empty (the default) then any user can login\. If a username is in both this list and the
     10268parameter\&.
     10269.sp
     10270If this is empty (the default) then any user can login\&. If a username is in both this list and the
    892810271\fIinvalid users\fR
    8929 list then access is denied for that user\.
     10272list then access is denied for that user\&.
    893010273.sp
    893110274The current servicename is substituted for
    8932 \fI%S\fR\. This is useful in the [homes] section\.
    8933 .sp
    8934 Default:
    8935 \fI\fIvalid users\fR\fR\fI = \fR\fI # No valid users list (anyone can login) \fR\fI \fR
    8936 .sp
    8937 Example:
    8938 \fI\fIvalid users\fR\fR\fI = \fR\fIgreg, @pcusers\fR\fI \fR
     10275\fI%S\fR\&. This is useful in the [homes] section\&.
     10276.sp
     10277Default:
     10278\fI\fIvalid users\fR\fR\fI = \fR\fI\FC # No valid users list (anyone can login) \F[]\fR\fI \fR
     10279.sp
     10280Example:
     10281\fI\fIvalid users\fR\fR\fI = \fR\fI\FCgreg, @pcusers\F[]\fR\fI \fR
    893910282.RE
    894010283
    894110284\-valid (S)
    8942 .PP
    8943 .RS 4
    8944 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\.
    8945 .sp
    8946 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\.
    8947 .sp
    8948 Default:
    8949 \fI\fI\-valid\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10285.\" -valid
     10286.PP
     10287.RS 4
     10288This 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\&.
     10289.sp
     10290This 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\&.
     10291.sp
     10292Default:
     10293\fI\fI\-valid\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    895010294.RE
    895110295
    895210296veto files (S)
    8953 .PP
    8954 .RS 4
    8955 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\.
     10297.\" veto files
     10298.PP
     10299.RS 4
     10300This 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\&.
    895610301.sp
    895710302Each entry must be a unix path, not a DOS path and must
    895810303\fInot\fR
    8959 include the unix directory separator \'/\'\.
     10304include the unix directory separator \'/\'\&.
    896010305.sp
    896110306Note that the
    8962 \fIcase sensitive\fR
    8963 option is applicable in vetoing files\.
    8964 .sp
    8965 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
     10307\m[blue]\fBcase sensitive\fR\m[]
     10308option is applicable in vetoing files\&.
     10309.sp
     10310One 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
    896610311\fIfail\fR
    896710312unless you also set the
    8968 \fIdelete veto files\fR
     10313\m[blue]\fBdelete veto files\fR\m[]
    896910314parameter to
    8970 \fIyes\fR\.
    8971 .sp
    8972 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\.
     10315\fIyes\fR\&.
     10316.sp
     10317Setting 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\&.
    897310318.sp
    897410319Examples of use include:
    897510320.sp
    8976 .RS 4
     10321.if n \{\
     10322.RS 4
     10323.\}
     10324.fam C
     10325.ps -1
    897710326.nf
     10327.if t \{\
     10328.sp -1
     10329.\}
     10330.BB lightgray adjust-for-leading-newline
     10331.sp -1
     10332
    897810333; Veto any files containing the word Security,
    8979 ; any ending in \.tmp, and any directory containing the
    8980 ; word root\.
    8981 veto files = /*Security*/*\.tmp/*root*/
     10334; any ending in \&.tmp, and any directory containing the
     10335; word root\&.
     10336veto files = /*Security*/*\&.tmp/*root*/
    898210337
    898310338; Veto the Apple specific files that a NetAtalk server
    8984 ; creates\.
    8985 veto files = /\.AppleDouble/\.bin/\.AppleDesktop/Network Trash Folder/
     10339; creates\&.
     10340veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
     10341.EB lightgray adjust-for-leading-newline
     10342.if t \{\
     10343.sp 1
     10344.\}
    898610345.fi
    8987 .RE
    8988 .sp
    8989 .sp
    8990 Default:
    8991 \fI\fIveto files\fR\fR\fI = \fR\fINo files or directories are vetoed\.\fR\fI \fR
     10346.fam
     10347.ps +1
     10348.if n \{\
     10349.RE
     10350.\}
     10351.sp
     10352Default:
     10353\fI\fIveto files\fR\fR\fI = \fR\fI\FCNo files or directories are vetoed\&.\F[]\fR\fI \fR
    899210354.RE
    899310355
    899410356veto oplock files (S)
     10357.\" veto oplock files
    899510358.PP
    899610359.RS 4
    899710360This parameter is only valid when the
    8998 \fIoplocks\fR
    8999 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
    9000 \fIveto files\fR
    9001 parameter\.
    9002 .sp
    9003 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
    9004 \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\.
     10361\m[blue]\fBoplocks\fR\m[]
     10362parameter 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
     10363\m[blue]\fBveto files\fR\m[]
     10364parameter\&.
     10365.sp
     10366You 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
     10367\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\&.
    900510368.sp
    900610369An example of use is:
    900710370.sp
    9008 .RS 4
     10371.if n \{\
     10372.RS 4
     10373.\}
     10374.fam C
     10375.ps -1
    900910376.nf
    9010 veto oplock files = /\.*SEM/
     10377.if t \{\
     10378.sp -1
     10379.\}
     10380.BB lightgray adjust-for-leading-newline
     10381.sp -1
     10382
     10383veto oplock files = /\&.*SEM/
     10384.EB lightgray adjust-for-leading-newline
     10385.if t \{\
     10386.sp 1
     10387.\}
    901110388.fi
    9012 .RE
    9013 .sp
    9014 .sp
    9015 Default:
    9016 \fI\fIveto oplock files\fR\fR\fI = \fR\fI # No files are vetoed for oplock grants\fR\fI \fR
     10389.fam
     10390.ps +1
     10391.if n \{\
     10392.RE
     10393.\}
     10394.sp
     10395Default:
     10396\fI\fIveto oplock files\fR\fR\fI = \fR\fI\FC # No files are vetoed for oplock grants\F[]\fR\fI \fR
    901710397.RE
    901810398
    901910399vfs object
     10400.\" vfs object
    902010401.PP
    902110402.RS 4
    902210403This parameter is a synonym for
    9023 vfs objects\.
     10404vfs objects\&.
    902410405.RE
    902510406
    902610407vfs objects (S)
    9027 .PP
    9028 .RS 4
    9029 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\.
    9030 .sp
    9031 Default:
    9032 \fI\fIvfs objects\fR\fR\fI = \fR\fI\fR\fI \fR
    9033 .sp
    9034 Example:
    9035 \fI\fIvfs objects\fR\fR\fI = \fR\fIextd_audit recycle\fR\fI \fR
     10408.\" vfs objects
     10409.PP
     10410.RS 4
     10411This 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\&.
     10412.sp
     10413Default:
     10414\fI\fIvfs objects\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     10415.sp
     10416Example:
     10417\fI\fIvfs objects\fR\fR\fI = \fR\fI\FCextd_audit recycle\F[]\fR\fI \fR
    903610418.RE
    903710419
    903810420volume (S)
    9039 .PP
    9040 .RS 4
    9041 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\.
    9042 .sp
    9043 Default:
    9044 \fI\fIvolume\fR\fR\fI = \fR\fI # the name of the share\fR\fI \fR
     10421.\" volume
     10422.PP
     10423.RS 4
     10424This allows you to override the volume label returned for a share\&. Useful for CDROMs with installation programs that insist on a particular volume label\&.
     10425.sp
     10426Default:
     10427\fI\fIvolume\fR\fR\fI = \fR\fI\FC # the name of the share\F[]\fR\fI \fR
    904510428.RE
    904610429
    904710430wide links (S)
    9048 .PP
    9049 .RS 4
    9050 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\.
    9051 .sp
    9052 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\.
    9053 .sp
    9054 Default:
    9055 \fI\fIwide links\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10431.\" wide links
     10432.PP
     10433.RS 4
     10434This 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\&.
     10435.sp
     10436Note 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\&.
     10437.sp
     10438Default:
     10439\fI\fIwide links\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    905610440.RE
    905710441
    905810442winbind cache time (G)
     10443.\" winbind cache time
    905910444.PP
    906010445.RS 4
    906110446This parameter specifies the number of seconds the
    906210447\fBwinbindd\fR(8)
    9063 daemon will cache user and group information before querying a Windows NT server again\.
     10448daemon will cache user and group information before querying a Windows NT server again\&.
    906410449.sp
    906510450This does not apply to authentication requests, these are always evaluated in real time unless the
    9066 \fIwinbind offline logon\fR
    9067 option has been enabled\.
    9068 .sp
    9069 Default:
    9070 \fI\fIwinbind cache time\fR\fR\fI = \fR\fI300\fR\fI \fR
     10451\m[blue]\fBwinbind offline logon\fR\m[]
     10452option has been enabled\&.
     10453.sp
     10454Default:
     10455\fI\fIwinbind cache time\fR\fR\fI = \fR\fI\FC300\F[]\fR\fI \fR
    907110456.RE
    907210457
    907310458winbind enum groups (G)
     10459.\" winbind enum groups
    907410460.PP
    907510461.RS 4
     
    907710463\fBwinbindd\fR(8)
    907810464it may be necessary to suppress the enumeration of groups through the
    9079 setgrent(),
    9080 getgrent()
     10465\FCsetgrent()\F[],
     10466\FCgetgrent()\F[]
    908110467and
    9082 endgrent()
    9083 group of system calls\. If the
     10468\FCendgrent()\F[]
     10469group of system calls\&. If the
    908410470\fIwinbind enum groups\fR
    908510471parameter is
    908610472\fBno\fR, calls to the
    9087 getgrent()
    9088 system call will not return any data\.
    9089 .sp
     10473\FCgetgrent()\F[]
     10474system call will not return any data\&.
     10475.if n \{\
     10476.sp
     10477.\}
     10478.RS 4
     10479.BM yellow
    909010480.it 1 an-trap
    909110481.nr an-no-space-flag 1
    909210482.nr an-break-flag 1
    909310483.br
    9094 Warning
    9095 Turning off group enumeration may cause some programs to behave oddly\.
    9096 
    9097 Default:
    9098 \fI\fIwinbind enum groups\fR\fR\fI = \fR\fIno\fR\fI \fR
     10484.ps +1
     10485\fBWarning\fR
     10486.ps -1
     10487.br
     10488Turning off group enumeration may cause some programs to behave oddly\&.
     10489.sp .5v
     10490.EM yellow
     10491.RE
     10492Default:
     10493\fI\fIwinbind enum groups\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    909910494.RE
    910010495
    910110496winbind enum users (G)
     10497.\" winbind enum users
    910210498.PP
    910310499.RS 4
     
    910510501\fBwinbindd\fR(8)
    910610502it may be necessary to suppress the enumeration of users through the
    9107 setpwent(),
    9108 getpwent()
     10503\FCsetpwent()\F[],
     10504\FCgetpwent()\F[]
    910910505and
    9110 endpwent()
    9111 group of system calls\. If the
     10506\FCendpwent()\F[]
     10507group of system calls\&. If the
    911210508\fIwinbind enum users\fR
    911310509parameter is
    911410510\fBno\fR, calls to the
    9115 getpwent
    9116 system call will not return any data\.
    9117 .sp
     10511\FCgetpwent\F[]
     10512system call will not return any data\&.
     10513.if n \{\
     10514.sp
     10515.\}
     10516.RS 4
     10517.BM yellow
    911810518.it 1 an-trap
    911910519.nr an-no-space-flag 1
    912010520.nr an-break-flag 1
    912110521.br
    9122 Warning
    9123 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\.
    9124 
    9125 Default:
    9126 \fI\fIwinbind enum users\fR\fR\fI = \fR\fIno\fR\fI \fR
     10522.ps +1
     10523\fBWarning\fR
     10524.ps -1
     10525.br
     10526Turning 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\&.
     10527.sp .5v
     10528.EM yellow
     10529.RE
     10530Default:
     10531\fI\fIwinbind enum users\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    912710532.RE
    912810533
    912910534winbind expand groups (G)
    9130 .PP
    9131 .RS 4
    9132 This option controls the maximum depth that winbindd will traverse when flattening nested group memberships of Windows domain groups\. This is different from the
    9133 \fIwinbind nested groups\fR
    9134 option which implements the Windows NT4 model of local group nesting\. The "winbind expand groups" parameter specifically applies to the membership of domain groups\.
    9135 .sp
    9136 Be aware that a high value for this parameter can result in system slowdown as the main parent winbindd daemon must perform the group unrolling and will be unable to answer incoming NSS or authentication requests during this time\.
    9137 .sp
    9138 Default:
    9139 \fI\fIwinbind expand groups\fR\fR\fI = \fR\fI1\fR\fI \fR
     10535.\" winbind expand groups
     10536.PP
     10537.RS 4
     10538This option controls the maximum depth that winbindd will traverse when flattening nested group memberships of Windows domain groups\&. This is different from the
     10539\m[blue]\fBwinbind nested groups\fR\m[]
     10540option which implements the Windows NT4 model of local group nesting\&. The "winbind expand groups" parameter specifically applies to the membership of domain groups\&.
     10541.sp
     10542Be aware that a high value for this parameter can result in system slowdown as the main parent winbindd daemon must perform the group unrolling and will be unable to answer incoming NSS or authentication requests during this time\&.
     10543.sp
     10544Default:
     10545\fI\fIwinbind expand groups\fR\fR\fI = \fR\fI\FC1\F[]\fR\fI \fR
    914010546.RE
    914110547
    914210548winbind nested groups (G)
    9143 .PP
    9144 .RS 4
    9145 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\.
    9146 .sp
    9147 Default:
    9148 \fI\fIwinbind nested groups\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10549.\" winbind nested groups
     10550.PP
     10551.RS 4
     10552If 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\&.
     10553.sp
     10554Default:
     10555\fI\fIwinbind nested groups\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    914910556.RE
    915010557
    915110558winbind normalize names (G)
    9152 .PP
    9153 .RS 4
    9154 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
    9155 .sp
    9156 Default:
    9157 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIno\fR\fI \fR
    9158 .sp
    9159 Example:
    9160 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10559.\" winbind normalize names
     10560.PP
     10561.RS 4
     10562This 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
     10563.sp
     10564Default:
     10565\fI\fIwinbind normalize names\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
     10566.sp
     10567Example:
     10568\fI\fIwinbind normalize names\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    916110569.RE
    916210570
    916310571winbind nss info (G)
    9164 .PP
    9165 .RS 4
    9166 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:
     10572.\" winbind nss info
     10573.PP
     10574.RS 4
     10575This 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:
    916710576.sp
    916810577.RS 4
     
    919010599.\}
    919110600\fI<sfu | rfc2307 >\fR
    9192 \- 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
     10601\- 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
    919310602\fIidmap backend\fR
    919410603= ad or
    919510604\fIidmap config DOMAIN:backend\fR
    9196 = ad as well\.
    9197 .sp
    9198 .RE
    9199 .sp
    9200 Default:
    9201 \fI\fIwinbind nss info\fR\fR\fI = \fR\fItemplate\fR\fI \fR
    9202 .sp
    9203 Example:
    9204 \fI\fIwinbind nss info\fR\fR\fI = \fR\fItemplate sfu\fR\fI \fR
     10605= ad as well\&.
     10606.sp
     10607.RE
     10608.sp
     10609Default:
     10610\fI\fIwinbind nss info\fR\fR\fI = \fR\fI\FCtemplate\F[]\fR\fI \fR
     10611.sp
     10612Example:
     10613\fI\fIwinbind nss info\fR\fR\fI = \fR\fI\FCtemplate sfu\F[]\fR\fI \fR
    920510614.RE
    920610615
    920710616winbind offline logon (G)
     10617.\" winbind offline logon
    920810618.PP
    920910619.RS 4
    921010620This parameter is designed to control whether Winbind should allow to login with the
    921110621\fIpam_winbind\fR
    9212 module using Cached Credentials\. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\.
    9213 .sp
    9214 Default:
    9215 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fIfalse\fR\fI \fR
    9216 .sp
    9217 Example:
    9218 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fItrue\fR\fI \fR
     10622module using Cached Credentials\&. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\&.
     10623.sp
     10624Default:
     10625\fI\fIwinbind offline logon\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
     10626.sp
     10627Example:
     10628\fI\fIwinbind offline logon\fR\fR\fI = \fR\fI\FCtrue\F[]\fR\fI \fR
    921910629.RE
    922010630
    922110631winbind refresh tickets (G)
     10632.\" winbind refresh tickets
    922210633.PP
    922310634.RS 4
    922410635This parameter is designed to control whether Winbind should refresh Kerberos Tickets retrieved using the
    922510636\fIpam_winbind\fR
    9226 module\.
    9227 .sp
    9228 Default:
    9229 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fIfalse\fR\fI \fR
    9230 .sp
    9231 Example:
    9232 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fItrue\fR\fI \fR
     10637module\&.
     10638.sp
     10639Default:
     10640\fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fI\FCfalse\F[]\fR\fI \fR
     10641.sp
     10642Example:
     10643\fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fI\FCtrue\F[]\fR\fI \fR
    923310644.RE
    923410645
    923510646winbind rpc only (G)
     10647.\" winbind rpc only
    923610648.PP
    923710649.RS 4
    923810650Setting this parameter to
    9239 yes
    9240 forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers\.
    9241 .sp
    9242 Default:
    9243 \fI\fIwinbind rpc only\fR\fR\fI = \fR\fIno\fR\fI \fR
     10651\FCyes\F[]
     10652forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers\&.
     10653.sp
     10654Default:
     10655\fI\fIwinbind rpc only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    924410656.RE
    924510657
    924610658winbind separator (G)
     10659.\" winbind separator
    924710660.PP
    924810661.RS 4
    924910662This parameter allows an admin to define the character used when listing a username of the form of
    9250 \fIDOMAIN \fR\e\fIuser\fR\. This parameter is only applicable when using the
    9251 \fIpam_winbind\.so\fR
     10663\fIDOMAIN \fR\e\fIuser\fR\&. This parameter is only applicable when using the
     10664\FCpam_winbind\&.so\F[]
    925210665and
    9253 \fInss_winbind\.so\fR
    9254 modules for UNIX services\.
    9255 .sp
    9256 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\.
    9257 .sp
    9258 Default:
    9259 \fI\fIwinbind separator\fR\fR\fI = \fR\fI\'\e\'\fR\fI \fR
    9260 .sp
    9261 Example:
    9262 \fI\fIwinbind separator\fR\fR\fI = \fR\fI+\fR\fI \fR
     10666\FCnss_winbind\&.so\F[]
     10667modules for UNIX services\&.
     10668.sp
     10669Please 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\&.
     10670.sp
     10671Default:
     10672\fI\fIwinbind separator\fR\fR\fI = \fR\fI\FC\'\e\'\F[]\fR\fI \fR
     10673.sp
     10674Example:
     10675\fI\fIwinbind separator\fR\fR\fI = \fR\fI\FC+\F[]\fR\fI \fR
    926310676.RE
    926410677
    926510678winbind trusted domains only (G)
    9266 .PP
    9267 .RS 4
    9268 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
    9269 DOMAIN\euser1
    9270 would be mapped to the account user1 in /etc/passwd instead of allocating a new uid for him or her\.
    9271 .sp
    9272 This parameter is now deprecated in favor of the newer idmap_nss backend\. Refer to the
    9273 \fIidmap domains\fR
    9274 smb\.conf option and the
     10679.\" winbind trusted domains only
     10680.PP
     10681.RS 4
     10682This 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
     10683\FCDOMAIN\euser1\F[]
     10684would be mapped to the account user1 in /etc/passwd instead of allocating a new uid for him or her\&.
     10685.sp
     10686This parameter is now deprecated in favor of the newer idmap_nss backend\&. Refer to the
     10687\m[blue]\fBidmap domains\fR\m[]
     10688smb\&.conf option and the
    927510689\fBidmap_nss\fR(8)
    9276 man page for more information\.
    9277 .sp
    9278 Default:
    9279 \fI\fIwinbind trusted domains only\fR\fR\fI = \fR\fIno\fR\fI \fR
     10690man page for more information\&.
     10691.sp
     10692Default:
     10693\fI\fIwinbind trusted domains only\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    928010694.RE
    928110695
    928210696winbind use default domain (G)
     10697.\" winbind use default domain
    928310698.PP
    928410699.RS 4
    928510700This parameter specifies whether the
    928610701\fBwinbindd\fR(8)
    9287 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\.
    9288 .sp
    9289 Default:
    9290 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIno\fR\fI \fR
    9291 .sp
    9292 Example:
    9293 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10702daemon 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\&.
     10703.sp
     10704Default:
     10705\fI\fIwinbind use default domain\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
     10706.sp
     10707Example:
     10708\fI\fIwinbind use default domain\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    929410709.RE
    929510710
    929610711wins hook (G)
    9297 .PP
    9298 .RS 4
    9299 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\.
     10712.\" wins hook
     10713.PP
     10714.RS 4
     10715When 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\&.
    930010716.sp
    930110717The wins hook parameter specifies the name of a script or executable that will be called as follows:
    930210718.sp
    9303 wins_hook operation name nametype ttl IP_list
    9304 .sp
    9305 .RS 4
    9306 .ie n \{\
    9307 \h'-04'\(bu\h'+03'\c
    9308 .\}
    9309 .el \{\
    9310 .sp -1
    9311 .IP \(bu 2.3
    9312 .\}
    9313 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\.
    9314 .RE
    9315 .sp
    9316 .RS 4
    9317 .ie n \{\
    9318 \h'-04'\(bu\h'+03'\c
    9319 .\}
    9320 .el \{\
    9321 .sp -1
    9322 .IP \(bu 2.3
    9323 .\}
    9324 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\.
    9325 .RE
    9326 .sp
    9327 .RS 4
    9328 .ie n \{\
    9329 \h'-04'\(bu\h'+03'\c
    9330 .\}
    9331 .el \{\
    9332 .sp -1
    9333 .IP \(bu 2.3
    9334 .\}
    9335 The third argument is the NetBIOS name type as a 2 digit hexadecimal number\.
    9336 .RE
    9337 .sp
    9338 .RS 4
    9339 .ie n \{\
    9340 \h'-04'\(bu\h'+03'\c
    9341 .\}
    9342 .el \{\
    9343 .sp -1
    9344 .IP \(bu 2.3
    9345 .\}
    9346 The fourth argument is the TTL (time to live) for the name in seconds\.
    9347 .RE
    9348 .sp
    9349 .RS 4
    9350 .ie n \{\
    9351 \h'-04'\(bu\h'+03'\c
    9352 .\}
    9353 .el \{\
    9354 .sp -1
    9355 .IP \(bu 2.3
    9356 .\}
    9357 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\.
     10719\FCwins_hook operation name nametype ttl IP_list\F[]
     10720.sp
     10721.RS 4
     10722.ie n \{\
     10723\h'-04'\(bu\h'+03'\c
     10724.\}
     10725.el \{\
     10726.sp -1
     10727.IP \(bu 2.3
     10728.\}
     10729The 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\&.
     10730.RE
     10731.sp
     10732.RS 4
     10733.ie n \{\
     10734\h'-04'\(bu\h'+03'\c
     10735.\}
     10736.el \{\
     10737.sp -1
     10738.IP \(bu 2.3
     10739.\}
     10740The 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\&.
     10741.RE
     10742.sp
     10743.RS 4
     10744.ie n \{\
     10745\h'-04'\(bu\h'+03'\c
     10746.\}
     10747.el \{\
     10748.sp -1
     10749.IP \(bu 2.3
     10750.\}
     10751The third argument is the NetBIOS name type as a 2 digit hexadecimal number\&.
     10752.RE
     10753.sp
     10754.RS 4
     10755.ie n \{\
     10756\h'-04'\(bu\h'+03'\c
     10757.\}
     10758.el \{\
     10759.sp -1
     10760.IP \(bu 2.3
     10761.\}
     10762The fourth argument is the TTL (time to live) for the name in seconds\&.
     10763.RE
     10764.sp
     10765.RS 4
     10766.ie n \{\
     10767\h'-04'\(bu\h'+03'\c
     10768.\}
     10769.el \{\
     10770.sp -1
     10771.IP \(bu 2.3
     10772.\}
     10773The fifth and subsequent arguments are the IP addresses currently registered for that name\&. If this list is empty then the name should be deleted\&.
    935810774.sp
    935910775.RE
    936010776An example script that calls the BIND dynamic DNS update program
    9361 nsupdate
    9362 is provided in the examples directory of the Samba source code\.
     10777\FCnsupdate\F[]
     10778is provided in the examples directory of the Samba source code\&.
    936310779.sp
    936410780\fINo default\fR
     
    936610782
    936710783wins proxy (G)
     10784.\" wins proxy
    936810785.PP
    936910786.RS 4
    937010787This is a boolean that controls if
    937110788\fBnmbd\fR(8)
    9372 will respond to broadcast name queries on behalf of other hosts\. You may need to set this to
     10789will respond to broadcast name queries on behalf of other hosts\&. You may need to set this to
    937310790\fByes\fR
    9374 for some older clients\.
    9375 .sp
    9376 Default:
    9377 \fI\fIwins proxy\fR\fR\fI = \fR\fIno\fR\fI \fR
     10791for some older clients\&.
     10792.sp
     10793Default:
     10794\fI\fIwins proxy\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    937810795.RE
    937910796
    938010797wins server (G)
     10798.\" wins server
    938110799.PP
    938210800.RS 4
    938310801This specifies the IP address (or DNS name: IP address for preference) of the WINS server that
    938410802\fBnmbd\fR(8)
    9385 should register with\. If you have a WINS server on your network then you should set this to the WINS server\'s IP\.
    9386 .sp
    9387 You should point this at your WINS server if you have a multi\-subnetted network\.
    9388 .sp
    9389 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\.
    9390 .sp
     10803should register with\&. If you have a WINS server on your network then you should set this to the WINS server\'s IP\&.
     10804.sp
     10805You should point this at your WINS server if you have a multi\-subnetted network\&.
     10806.sp
     10807If 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\&.
     10808.if n \{\
     10809.sp
     10810.\}
     10811.RS 4
     10812.BM yellow
    939110813.it 1 an-trap
    939210814.nr an-no-space-flag 1
    939310815.nr an-break-flag 1
    939410816.br
    9395 Note
    9396 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\.
    9397 
    9398 See the chapter in the Samba3\-HOWTO on Network Browsing\.
    9399 .sp
    9400 Default:
    9401 \fI\fIwins server\fR\fR\fI = \fR\fI\fR\fI \fR
    9402 .sp
    9403 Example:
    9404 \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
    9405 .sp
    9406 Example:
    9407 \fI\fIwins server\fR\fR\fI = \fR\fI192\.9\.200\.1 192\.168\.2\.61\fR\fI \fR
     10817.ps +1
     10818\fBNote\fR
     10819.ps -1
     10820.br
     10821You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross\-subnet browsing to work correctly\&.
     10822.sp .5v
     10823.EM yellow
     10824.RE
     10825See the chapter in the Samba3\-HOWTO on Network Browsing\&.
     10826.sp
     10827Default:
     10828\fI\fIwins server\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     10829.sp
     10830Example:
     10831\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
     10832.sp
     10833Example:
     10834\fI\fIwins server\fR\fR\fI = \fR\fI\FC192\&.9\&.200\&.1 192\&.168\&.2\&.61\F[]\fR\fI \fR
    940810835.RE
    940910836
    941010837wins support (G)
     10838.\" wins support
    941110839.PP
    941210840.RS 4
    941310841This boolean controls if the
    941410842\fBnmbd\fR(8)
    9415 process in Samba will act as a WINS server\. You should not set this to
     10843process in Samba will act as a WINS server\&. You should not set this to
    941610844\fByes\fR
    941710845unless you have a multi\-subnetted network and you wish a particular
    9418 nmbd
    9419 to be your WINS server\. Note that you should
     10846\FCnmbd\F[]
     10847to be your WINS server\&. Note that you should
    942010848\fINEVER\fR
    942110849set this to
    942210850\fByes\fR
    9423 on more than one machine in your network\.
    9424 .sp
    9425 Default:
    9426 \fI\fIwins support\fR\fR\fI = \fR\fIno\fR\fI \fR
     10851on more than one machine in your network\&.
     10852.sp
     10853Default:
     10854\fI\fIwins support\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    942710855.RE
    942810856
    942910857workgroup (G)
    9430 .PP
    9431 .RS 4
    9432 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
    9433 \fIsecurity = domain\fR
    9434 setting\.
    9435 .sp
    9436 Default:
    9437 \fI\fIworkgroup\fR\fR\fI = \fR\fIWORKGROUP\fR\fI \fR
    9438 .sp
    9439 Example:
    9440 \fI\fIworkgroup\fR\fR\fI = \fR\fIMYGROUP\fR\fI \fR
     10858.\" workgroup
     10859.PP
     10860.RS 4
     10861This 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
     10862\m[blue]\fBsecurity = domain\fR\m[]
     10863setting\&.
     10864.sp
     10865Default:
     10866\fI\fIworkgroup\fR\fR\fI = \fR\fI\FCWORKGROUP\F[]\fR\fI \fR
     10867.sp
     10868Example:
     10869\fI\fIworkgroup\fR\fR\fI = \fR\fI\FCMYGROUP\F[]\fR\fI \fR
    944110870.RE
    944210871
    944310872writable
     10873.\" writable
    944410874.PP
    944510875.RS 4
    944610876This parameter is a synonym for
    9447 writeable\.
     10877writeable\&.
    944810878.RE
    944910879
    945010880writeable (S)
     10881.\" writeable
    945110882.PP
    945210883.RS 4
    945310884Inverted synonym for
    9454 \fIread only\fR\.
    9455 .sp
    9456 Default:
    9457 \fI\fIwriteable\fR\fR\fI = \fR\fIno\fR\fI \fR
     10885\m[blue]\fBread only\fR\m[]\&.
     10886.sp
     10887Default:
     10888\fI\fIwriteable\fR\fR\fI = \fR\fI\FCno\F[]\fR\fI \fR
    945810889.RE
    945910890
    946010891write cache size (S)
     10892.\" write cache size
    946110893.PP
    946210894.RS 4
    946310895If this integer parameter is set to non\-zero value, Samba will create an in\-memory cache for each oplocked file (it does
    946410896\fInot\fR
    9465 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\.
    9466 .sp
    9467 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\.
    9468 .sp
    9469 The integer parameter specifies the size of this cache (per oplocked file) in bytes\.
    9470 .sp
    9471 Default:
    9472 \fI\fIwrite cache size\fR\fR\fI = \fR\fI0\fR\fI \fR
    9473 .sp
    9474 Example:
    9475 \fI\fIwrite cache size\fR\fR\fI = \fR\fI262144 # for a 256k cache size per file\fR\fI \fR
     10897do 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\&.
     10898.sp
     10899This 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\&.
     10900.sp
     10901The integer parameter specifies the size of this cache (per oplocked file) in bytes\&.
     10902.sp
     10903Default:
     10904\fI\fIwrite cache size\fR\fR\fI = \fR\fI\FC0\F[]\fR\fI \fR
     10905.sp
     10906Example:
     10907\fI\fIwrite cache size\fR\fR\fI = \fR\fI\FC262144 # for a 256k cache size per file\F[]\fR\fI \fR
    947610908.RE
    947710909
    947810910write list (S)
    9479 .PP
    9480 .RS 4
    9481 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
    9482 \fIread only\fR
    9483 option is set to\. The list can include group names using the @group syntax\.
    9484 .sp
    9485 Note that if a user is in both the read list and the write list then they will be given write access\.
     10911.\" write list
     10912.PP
     10913.RS 4
     10914This 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
     10915\m[blue]\fBread only\fR\m[]
     10916option is set to\&. The list can include group names using the @group syntax\&.
     10917.sp
     10918Note that if a user is in both the read list and the write list then they will be given write access\&.
    948610919.sp
    948710920By design, this parameter will not work with the
    9488 \fIsecurity = share\fR
    9489 in Samba 3\.0\.
    9490 .sp
    9491 Default:
    9492 \fI\fIwrite list\fR\fR\fI = \fR\fI\fR\fI \fR
    9493 .sp
    9494 Example:
    9495 \fI\fIwrite list\fR\fR\fI = \fR\fIadmin, root, @staff\fR\fI \fR
     10921\m[blue]\fBsecurity = share\fR\m[]
     10922in Samba 3\&.0\&.
     10923.sp
     10924Default:
     10925\fI\fIwrite list\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     10926.sp
     10927Example:
     10928\fI\fIwrite list\fR\fR\fI = \fR\fI\FCadmin, root, @staff\F[]\fR\fI \fR
    949610929.RE
    949710930
    949810931write raw (G)
    9499 .PP
    9500 .RS 4
    9501 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\.
    9502 .sp
    9503 Default:
    9504 \fI\fIwrite raw\fR\fR\fI = \fR\fIyes\fR\fI \fR
     10932.\" write raw
     10933.PP
     10934.RS 4
     10935This 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\&.
     10936.sp
     10937Default:
     10938\fI\fIwrite raw\fR\fR\fI = \fR\fI\FCyes\F[]\fR\fI \fR
    950510939.RE
    950610940
    950710941wtmp directory (G)
     10942.\" wtmp directory
    950810943.PP
    950910944.RS 4
    951010945This parameter is only available if Samba has been configured and compiled with the option
    9511 \-\-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\.
     10946\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\&.
    951210947.sp
    951310948By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually
    9514 \fI/var/run/wtmp\fR
    9515 on Linux)\.
    9516 .sp
    9517 Default:
    9518 \fI\fIwtmp directory\fR\fR\fI = \fR\fI\fR\fI \fR
    9519 .sp
    9520 Example:
    9521 \fI\fIwtmp directory\fR\fR\fI = \fR\fI/var/log/wtmp\fR\fI \fR
     10949\FC/var/run/wtmp\F[]
     10950on Linux)\&.
     10951.sp
     10952Default:
     10953\fI\fIwtmp directory\fR\fR\fI = \fR\fI\FC\F[]\fR\fI \fR
     10954.sp
     10955Example:
     10956\fI\fIwtmp directory\fR\fR\fI = \fR\fI\FC/var/log/wtmp\F[]\fR\fI \fR
    952210957.RE
    952310958.SH "WARNINGS"
    952410959.PP
    9525 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\.
    9526 .PP
    9527 On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\.
     10960Although 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\&.
     10961.PP
     10962On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\&.
    952810963\fBsmbd\fR(8)
    9529 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\.
     10964has 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\&.
    953010965.PP
    953110966Use of the
    9532 [homes]
     10967\FC[homes]\F[]
    953310968and
    9534 [printers]
    9535 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\.
     10969\FC[printers]\F[]
     10970special 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\&.
    953610971.SH "VERSION"
    953710972.PP
    9538 This man page is correct for version 3 of the Samba suite\.
     10973This man page is correct for version 3 of the Samba suite\&.
    953910974.SH "SEE ALSO"
    954010975.PP
     
    954810983\fBnmblookup\fR(1),
    954910984\fBtestparm\fR(1),
    9550 \fBtestprns\fR(1)\.
     10985\fBtestprns\fR(1)\&.
    955110986.SH "AUTHOR"
    955210987.PP
    9553 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\.
    9554 .PP
    9555 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
    9556 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\.
     10988The 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\&.
     10989.PP
     10990The 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
     10991ftp://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.