Ignore:
Timestamp:
Jul 2, 2011, 4:01:14 PM (14 years ago)
Author:
Herwig Bauernfeind
Message:

Samba 3.5: Update vendor to version 3.5.9

File:
1 edited

Legend:

Unmodified
Added
Removed
  • vendor/current/docs/manpages/smb.conf.5

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